Merge pull request #22 from af83/3479-refactor-table_builder-helper

3479 refactor table builder helper

8 files changed, 440 insertions, 4 deletions

diff --git a/spec/factories/chouette_2_factories.rb b/spec/factories/chouette_2_factories.rb
index e8eba13e6..a8e80702d 100644
--- a/spec/factories/chouette_2_factories.rb
+++ b/spec/factories/chouette_2_factories.rb
@@ -1,3 +1,4 @@
+# TODO: Move these factories into their own files so all factory definitions are consistent
 FactoryGirl.define do
 
   factory :organisation do
diff --git a/spec/features/referentials_permissions_spec.rb b/spec/features/referentials_permissions_spec.rb
index 0216eeeb0..c37dff5b9 100644
--- a/spec/features/referentials_permissions_spec.rb
+++ b/spec/features/referentials_permissions_spec.rb
@@ -31,7 +31,7 @@ describe "Referentials", :type => :feature do
         end
         it 'shows the delete button' do
           expected_href = referential_path(referential)
-          expect( page ).to have_css(%{a[href=#{expected_href.inspect}] span}, text: destroy_link_text)
+          expect( page ).to have_css(%{a[href=#{expected_href.inspect}]}, text: destroy_link_text)
         end
       end
 
diff --git a/spec/helpers/table_builder_helper/column_spec.rb b/spec/helpers/table_builder_helper/column_spec.rb
new file mode 100644
index 000000000..0f27703b2
--- /dev/null
+++ b/spec/helpers/table_builder_helper/column_spec.rb
@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe TableBuilderHelper::Column do
+  describe "#header_label" do
+    it "returns the column @name if present" do
+      expect(
+        TableBuilderHelper::Column.new(
+          name: 'ID Codif',
+          attribute: nil
+        ).header_label
+      ).to eq('ID Codif')
+    end
+
+    it "returns the I18n translation of @key if @name not present" do
+      expect(
+        TableBuilderHelper::Column.new(
+          key: :phone,
+          attribute: 'phone'
+        ).header_label(Chouette::Company)
+      ).to eq('Numéro de téléphone')
+    end
+  end
+end
diff --git a/spec/helpers/table_builder_helper/custom_links_spec.rb b/spec/helpers/table_builder_helper/custom_links_spec.rb
new file mode 100644
index 000000000..b64e97527
--- /dev/null
+++ b/spec/helpers/table_builder_helper/custom_links_spec.rb
@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe TableBuilderHelper::CustomLinks do
+  describe "#actions_after_policy_check" do
+    it "includes :show" do
+      referential = build_stubbed(:referential)
+      user_context = UserContext.new(
+        build_stubbed(
+          :user,
+          organisation: referential.organisation,
+          permissions: [
+            'boiv:read-offer'
+          ]
+        ),
+        referential: referential
+      )
+
+      expect(
+        TableBuilderHelper::CustomLinks.new(
+          referential,
+          user_context,
+          [:show]
+        ).actions_after_policy_check
+      ).to eq([:show])
+    end
+  end
+end
diff --git a/spec/helpers/table_builder_helper_spec.rb b/spec/helpers/table_builder_helper_spec.rb
new file mode 100644
index 000000000..32a6a3bfd
--- /dev/null
+++ b/spec/helpers/table_builder_helper_spec.rb
@@ -0,0 +1,372 @@
+require 'spec_helper'
+require 'htmlbeautifier'
+
+module TableBuilderHelper
+  include Pundit
+end
+
+describe TableBuilderHelper, type: :helper do
+  describe "#table_builder_2" do
+    it "builds a table" do
+      referential = build_stubbed(:referential)
+      workbench = referential.workbench
+
+      user_context = UserContext.new(
+        build_stubbed(
+          :user,
+          organisation: referential.organisation,
+          permissions: [
+            'referentials.create',
+            'referentials.edit',
+            'referentials.destroy'
+          ]
+        ),
+        referential: referential
+      )
+      allow(helper).to receive(:current_user).and_return(user_context)
+
+      referentials = [referential]
+
+      allow(referentials).to receive(:model).and_return(Referential)
+
+      allow(helper).to receive(:params).and_return({
+        controller: 'workbenches',
+        action: 'show',
+        id: referentials[0].workbench.id
+      })
+
+      referentials = ModelDecorator.decorate(
+        referentials,
+        with: ReferentialDecorator
+      )
+
+      expected = <<-HTML
+<table class="table has-filter has-search">
+    <thead>
+        <tr>
+            <th>
+                <div class="checkbox"><input type="checkbox" name="0" id="0" value="all" /><label for="0"></label></div>
+            </th>
+            <th><a href="/workbenches/#{workbench.id}?direction=desc&amp;sort=name">Nom<span class="orderers"><span class="fa fa-sort-asc active"></span><span class="fa fa-sort-desc "></span></span></a></th>
+            <th><a href="/workbenches/#{workbench.id}?direction=desc&amp;sort=status">Etat<span class="orderers"><span class="fa fa-sort-asc active"></span><span class="fa fa-sort-desc "></span></span></a></th>
+            <th><a href="/workbenches/#{workbench.id}?direction=desc&amp;sort=organisation">Organisation<span class="orderers"><span class="fa fa-sort-asc active"></span><span class="fa fa-sort-desc "></span></span></a></th>
+            <th><a href="/workbenches/#{workbench.id}?direction=desc&amp;sort=validity_period">Période de validité englobante<span class="orderers"><span class="fa fa-sort-asc active"></span><span class="fa fa-sort-desc "></span></span></a></th>
+            <th><a href="/workbenches/#{workbench.id}?direction=desc&amp;sort=lines">Lignes<span class="orderers"><span class="fa fa-sort-asc active"></span><span class="fa fa-sort-desc "></span></span></a></th>
+            <th><a href="/workbenches/#{workbench.id}?direction=desc&amp;sort=created_at">Créé le<span class="orderers"><span class="fa fa-sort-asc active"></span><span class="fa fa-sort-desc "></span></span></a></th>
+            <th><a href="/workbenches/#{workbench.id}?direction=desc&amp;sort=updated_at">Edité le<span class="orderers"><span class="fa fa-sort-asc active"></span><span class="fa fa-sort-desc "></span></span></a></th>
+            <th><a href="/workbenches/#{workbench.id}?direction=desc&amp;sort=published_at">Intégré le<span class="orderers"><span class="fa fa-sort-asc active"></span><span class="fa fa-sort-desc "></span></span></a></th>
+            <th></th>
+        </tr>
+    </thead>
+    <tbody>
+        <tr>
+            <td>
+                <div class="checkbox"><input type="checkbox" name="#{referential.id}" id="#{referential.id}" value="#{referential.id}" /><label for="#{referential.id}"></label></div>
+            </td>
+            <td title="Voir"><a href="/referentials/#{referential.id}">#{referential.name}</a></td>
+            <td>
+                <div class='td-block'><span class='sb sb-lg sb-preparing'></span><span>En préparation</span></div>
+            </td>
+            <td>#{referential.organisation.name}</td>
+            <td>-</td>
+            <td>#{referential.lines.count}</td>
+            <td>#{I18n.localize(referential.created_at, format: :short)}</td>
+            <td>#{I18n.localize(referential.updated_at, format: :short)}</td>
+            <td></td>
+            <td class="actions">
+                <div class="btn-group">
+                    <div class="btn dropdown-toggle" data-toggle="dropdown"><span class="fa fa-cog"></span></div>
+                    <ul class="dropdown-menu">
+                        <li><a href="/referentials/#{referential.id}">Consulter</a></li>
+                        <li><a href="/referentials/#{referential.id}/edit">Editer</a></li>
+                        <li><a href="/referentials/#{referential.id}/time_tables">Calendriers</a></li>
+                        <li><a href="/referentials/new?from=#{referential.id}">Dupliquer</a></li>
+                        <li><a rel="nofollow" data-method="put" href="/referentials/#{referential.id}/archive">Conserver</a></li>
+                        <li class="delete-action"><a data-confirm="Etes vous sûr de vouloir supprimer ce jeu de données ?" rel="nofollow" data-method="delete" href="/referentials/#{referential.id}"><span class="fa fa-trash"></span>Supprimer</a></li>
+                    </ul>
+                </div>
+            </td>
+        </tr>
+    </tbody>
+</table>
+      HTML
+
+      html_str = helper.table_builder_2(
+        referentials,
+        [
+          TableBuilderHelper::Column.new(
+            key: :name,
+            attribute: 'name'
+          ),
+          TableBuilderHelper::Column.new(
+            key: :status,
+            attribute: Proc.new do |w|
+              if w.archived?
+                ("<div class='td-block'><span class='fa fa-archive'></span><span>Conservé</span></div>").html_safe
+              else
+                ("<div class='td-block'><span class='sb sb-lg sb-preparing'></span><span>En préparation</span></div>").html_safe
+              end
+            end
+          ),
+          TableBuilderHelper::Column.new(
+            key: :organisation,
+            attribute: Proc.new {|w| w.organisation.name}
+          ),
+          TableBuilderHelper::Column.new(
+            key: :validity_period,
+            attribute: Proc.new do |w|
+              if w.validity_period.nil?
+                '-'
+              else
+                t(
+                  'validity_range',
+                  debut: l(w.try(:validity_period).try(:begin), format: :short),
+                  end: l(w.try(:validity_period).try(:end), format: :short)
+                )
+              end
+            end
+          ),
+          TableBuilderHelper::Column.new(
+            key: :lines,
+            attribute: Proc.new {|w| w.lines.count}
+          ),
+          TableBuilderHelper::Column.new(
+            key: :created_at,
+            attribute: Proc.new {|w| l(w.created_at, format: :short)}
+          ),
+          TableBuilderHelper::Column.new(
+            key: :updated_at,
+            attribute: Proc.new {|w| l(w.updated_at, format: :short)}
+          ),
+          TableBuilderHelper::Column.new(
+            key: :published_at,
+            attribute: ''
+          )
+        ],
+        selectable: true,
+        links: [:show, :edit],
+        cls: 'table has-filter has-search'
+      )
+
+      beautified_html = HtmlBeautifier.beautify(html_str, indent: '    ')
+
+      expect(beautified_html).to eq(expected.chomp)
+    end
+
+    it "can set a column as non-sortable" do
+      company = build_stubbed(:company)
+      line_referential = build_stubbed(
+        :line_referential,
+        companies: [company]
+      )
+      referential = build_stubbed(
+        :referential,
+        line_referential: line_referential
+      )
+
+      user_context = UserContext.new(
+        build_stubbed(
+          :user,
+          organisation: referential.organisation,
+          permissions: [
+            'referentials.create',
+            'referentials.edit',
+            'referentials.destroy'
+          ]
+        ),
+        referential: referential
+      )
+      allow(helper).to receive(:current_user).and_return(user_context)
+      allow(TableBuilderHelper::URL).to receive(:current_referential)
+        .and_return(referential)
+
+      companies = [company]
+
+      allow(companies).to receive(:model).and_return(Chouette::Company)
+
+      allow(helper).to receive(:params).and_return({
+        controller: 'referential_companies',
+        action: 'index',
+        referential_id: referential.id
+      })
+
+      companies = ModelDecorator.decorate(
+        companies,
+        with: CompanyDecorator
+      )
+
+      expected = <<-HTML
+<table class="table has-search">
+    <thead>
+        <tr>
+            <th>ID Codif</th>
+            <th><a href="/referentials/#{referential.id}/companies?direction=desc&amp;sort=name">Nom<span class="orderers"><span class="fa fa-sort-asc active"></span><span class="fa fa-sort-desc "></span></span></a></th>
+            <th><a href="/referentials/#{referential.id}/companies?direction=desc&amp;sort=phone">Numéro de téléphone<span class="orderers"><span class="fa fa-sort-asc active"></span><span class="fa fa-sort-desc "></span></span></a></th>
+            <th><a href="/referentials/#{referential.id}/companies?direction=desc&amp;sort=email">Email<span class="orderers"><span class="fa fa-sort-asc active"></span><span class="fa fa-sort-desc "></span></span></a></th>
+            <th><a href="/referentials/#{referential.id}/companies?direction=desc&amp;sort=url">Page web associée<span class="orderers"><span class="fa fa-sort-asc active"></span><span class="fa fa-sort-desc "></span></span></a></th>
+            <th></th>
+        </tr>
+    </thead>
+    <tbody>
+        <tr>
+            <td>#{company.objectid.local_id}</td>
+            <td title="Voir"><a href="/referentials/#{referential.id}/companies/#{company.id}">#{company.name}</a></td>
+            <td></td>
+            <td></td>
+            <td></td>
+            <td class="actions">
+                <div class="btn-group">
+                    <div class="btn dropdown-toggle" data-toggle="dropdown"><span class="fa fa-cog"></span></div>
+                    <ul class="dropdown-menu">
+                        <li><a href="/referentials/#{referential.id}/companies/#{company.id}">Consulter</a></li>
+                    </ul>
+                </div>
+            </td>
+        </tr>
+    </tbody>
+</table>
+      HTML
+
+      html_str = helper.table_builder_2(
+        companies,
+        [
+          TableBuilderHelper::Column.new(
+            name: 'ID Codif',
+            attribute: Proc.new { |n| n.try(:objectid).try(:local_id) },
+            sortable: false
+          ),
+          TableBuilderHelper::Column.new(
+            key: :name,
+            attribute: 'name'
+          ),
+          TableBuilderHelper::Column.new(
+            key: :phone,
+            attribute: 'phone'
+          ),
+          TableBuilderHelper::Column.new(
+            key: :email,
+            attribute: 'email'
+          ),
+          TableBuilderHelper::Column.new(
+            key: :url,
+            attribute: 'url'
+          ),
+        ],
+        links: [:show, :edit, :delete],
+        cls: 'table has-search'
+      )
+
+      beautified_html = HtmlBeautifier.beautify(html_str, indent: '    ')
+
+      expect(beautified_html).to eq(expected.chomp)
+    end
+
+    it "can set all columns as non-sortable" do
+      company = build_stubbed(:company)
+      line_referential = build_stubbed(
+        :line_referential,
+        companies: [company]
+      )
+      referential = build_stubbed(
+        :referential,
+        line_referential: line_referential
+      )
+
+      user_context = UserContext.new(
+        build_stubbed(
+          :user,
+          organisation: referential.organisation,
+          permissions: [
+            'referentials.create',
+            'referentials.edit',
+            'referentials.destroy'
+          ]
+        ),
+        referential: referential
+      )
+      allow(helper).to receive(:current_user).and_return(user_context)
+      allow(TableBuilderHelper::URL).to receive(:current_referential)
+        .and_return(referential)
+
+      companies = [company]
+
+      allow(companies).to receive(:model).and_return(Chouette::Company)
+
+      allow(helper).to receive(:params).and_return({
+        controller: 'referential_companies',
+        action: 'index',
+        referential_id: referential.id
+      })
+
+      companies = ModelDecorator.decorate(
+        companies,
+        with: CompanyDecorator
+      )
+
+      expected = <<-HTML
+<table class="table has-search">
+    <thead>
+        <tr>
+            <th>ID Codif</th>
+            <th>Nom</th>
+            <th>Numéro de téléphone</th>
+            <th>Email</th>
+            <th>Page web associée</th>
+            <th></th>
+        </tr>
+    </thead>
+    <tbody>
+        <tr>
+            <td>#{company.objectid.local_id}</td>
+            <td title="Voir"><a href="/referentials/#{referential.id}/companies/#{company.id}">#{company.name}</a></td>
+            <td></td>
+            <td></td>
+            <td></td>
+            <td class="actions">
+                <div class="btn-group">
+                    <div class="btn dropdown-toggle" data-toggle="dropdown"><span class="fa fa-cog"></span></div>
+                    <ul class="dropdown-menu">
+                        <li><a href="/referentials/#{referential.id}/companies/#{company.id}">Consulter</a></li>
+                    </ul>
+                </div>
+            </td>
+        </tr>
+    </tbody>
+</table>
+      HTML
+
+      html_str = helper.table_builder_2(
+        companies,
+        [
+          TableBuilderHelper::Column.new(
+            name: 'ID Codif',
+            attribute: Proc.new { |n| n.try(:objectid).try(:local_id) }
+          ),
+          TableBuilderHelper::Column.new(
+            key: :name,
+            attribute: 'name'
+          ),
+          TableBuilderHelper::Column.new(
+            key: :phone,
+            attribute: 'phone'
+          ),
+          TableBuilderHelper::Column.new(
+            key: :email,
+            attribute: 'email'
+          ),
+          TableBuilderHelper::Column.new(
+            key: :url,
+            attribute: 'url'
+          ),
+        ],
+        sortable: false,
+        links: [:show, :edit, :delete],
+        cls: 'table has-search'
+      )
+
+      beautified_html = HtmlBeautifier.beautify(html_str, indent: '    ')
+
+      expect(beautified_html).to eq(expected.chomp)
+    end
+  end
+end
diff --git a/spec/support/pundit/policies.rb b/spec/support/pundit/policies.rb
index e18309226..56433b2ee 100644
--- a/spec/support/pundit/policies.rb
+++ b/spec/support/pundit/policies.rb
@@ -9,7 +9,7 @@ module Support
       end
 
       def create_user_context(user:, referential:)
-        OpenStruct.new(user: user, context: {referential: referential})
+        UserContext.new(user, referential: referential)
       end
 
       def add_permissions(*permissions, for_user:)
diff --git a/spec/views/lines/show.html.erb_spec.rb b/spec/views/lines/show.html.erb_spec.rb
index 3a9efa0ce..7bc120f1a 100644
--- a/spec/views/lines/show.html.erb_spec.rb
+++ b/spec/views/lines/show.html.erb_spec.rb
@@ -3,7 +3,13 @@ require 'spec_helper'
 describe "/lines/show", :type => :view do
 
   assign_referential
-  let!(:line) { assign :line, create(:line) }
+  let!(:line) do
+    line = create(:line)
+    assign :line, line.decorate(context: {
+      line_referential: line.line_referential,
+      current_organisation: referential.organisation
+    })
+  end
   let!(:line_referential) { assign :line_referential, line.line_referential }
   let!(:routes) { assign :routes, Array.new(2) { create(:route, :line => line) }.paginate }
   let!(:map) { assign(:map, double(:to_html => '<div id="map"/>'.html_safe)) }
diff --git a/spec/views/time_tables/show.html.erb_spec.rb b/spec/views/time_tables/show.html.erb_spec.rb
index f429f9dec..edfb3f3cc 100644
--- a/spec/views/time_tables/show.html.erb_spec.rb
+++ b/spec/views/time_tables/show.html.erb_spec.rb
@@ -3,7 +3,14 @@ require 'spec_helper'
 describe "/time_tables/show", :type => :view do
 
   assign_referential
-  let!(:time_table) { assign(:time_table, create(:time_table)) }
+  let!(:time_table) do
+    assign(
+      :time_table,
+      create(:time_table).decorate(context: {
+        referential: referential
+      })
+    )
+  end
   let!(:year) { assign(:year, Date.today.cwyear) }
   let!(:time_table_combination) {assign(:time_table_combination, TimeTableCombination.new)}