activeadmin-rails 1.7.0

data/spec/unit/views/components/table_for_spec.rb

@@ -0,0 +1,441 @@
+require 'rails_helper'
+
+RSpec.describe ActiveAdmin::Views::TableFor do
+  describe "creating with the dsl" do
+
+    let(:collection) do
+      [
+        Post.new(title: "First Post", starred: true),
+        Post.new(title: "Second Post"),
+        Post.new(title: "Third Post", starred: false)
+      ]
+    end
+
+    let(:assigns){ { collection: collection } }
+    let(:helpers){ mock_action_view }
+
+    context "when creating a column using symbol argument" do
+      let(:table) do
+        render_component assigns, helpers do
+          table_for(collection, :title)
+        end
+      end
+
+      it "should create a table header based on the symbol" do
+        expect(table.find_by_tag("th").first.content).to eq "Title"
+      end
+
+      it "should create a table row for each element in the collection" do
+        expect(table.find_by_tag("tr").size).to eq 4 # 1 for head, 3 for rows
+      end
+
+      ["First Post", "Second Post", "Third Post"].each_with_index do |content, index|
+        it "should create a cell with #{content}" do
+          expect(table.find_by_tag("td")[index].content).to eq content
+        end
+      end
+    end
+
+    context "when creating many columns using symbol arguments" do
+      let(:table) do
+        render_component assigns, helpers do
+          table_for(collection, :title, :created_at)
+        end
+      end
+
+      it "should create a table header based on the symbol" do
+        expect(table.find_by_tag("th").first.content).to eq "Title"
+        expect(table.find_by_tag("th").last.content).to eq "Created At"
+      end
+
+      it "should add a class to each table header based on the col name" do
+        expect(table.find_by_tag("th").first.class_list.to_a.join(' ')).to eq "col col-title"
+        expect(table.find_by_tag("th").last.class_list.to_a.join(' ')).to eq "col col-created_at"
+      end
+
+      it "should create a table row for each element in the collection" do
+        expect(table.find_by_tag("tr").size).to eq 4 # 1 for head, 3 for rows
+      end
+
+      it "should create a cell for each column" do
+        expect(table.find_by_tag("td").size).to eq 6
+      end
+
+      it "should add a class for each cell based on the col name" do
+        expect(table.find_by_tag("td").first.class_list.to_a.join(' ')).to eq "col col-title"
+        expect(table.find_by_tag("td").last.class_list.to_a.join(' ')).to eq "col col-created_at"
+      end
+    end
+
+    context "when creating a column using symbol arguments and another using block" do
+      let(:table) do
+        render_component assigns, helpers do
+          table_for(collection, :title) do
+            column :created_at
+          end
+        end
+      end
+
+      it "should create a table header based on the symbol" do
+        expect(table.find_by_tag("th").first.content).to eq "Title"
+        expect(table.find_by_tag("th").last.content).to eq "Created At"
+      end
+
+      it "should add a class to each table header based on the col name" do
+        expect(table.find_by_tag("th").first.class_list.to_a.join(' ')).to eq "col col-title"
+        expect(table.find_by_tag("th").last.class_list.to_a.join(' ')).to eq "col col-created_at"
+      end
+
+      it "should create a table row for each element in the collection" do
+        expect(table.find_by_tag("tr").size).to eq 4 # 1 for head, 3 for rows
+      end
+
+      it "should create a cell for each column" do
+        expect(table.find_by_tag("td").size).to eq 6
+      end
+
+      it "should add a class for each cell based on the col name" do
+        expect(table.find_by_tag("td").first.class_list.to_a.join(' ')).to eq "col col-title"
+        expect(table.find_by_tag("td").last.class_list.to_a.join(' ')).to eq "col col-created_at"
+      end
+    end
+
+    context "when creating a column with a symbol" do
+      let(:table) do
+        render_component assigns, helpers do
+          table_for(collection) do
+            column :title
+          end
+        end
+      end
+
+      it "should create a table header based on the symbol" do
+        expect(table.find_by_tag("th").first.content).to eq "Title"
+      end
+
+      it "should create a table row for each element in the collection" do
+        expect(table.find_by_tag("tr").size).to eq 4 # 1 for head, 3 for rows
+      end
+
+      ["First Post", "Second Post", "Third Post"].each_with_index do |content, index|
+        it "should create a cell with #{content}" do
+          expect(table.find_by_tag("td")[index].content).to eq content
+        end
+      end
+    end
+
+    context "when creating many columns with symbols" do
+      let(:table) do
+        render_component assigns, helpers do
+          table_for(collection) do
+            column :title
+            column :created_at
+          end
+        end
+      end
+
+      it "should create a table header based on the symbol" do
+        expect(table.find_by_tag("th").first.content).to eq "Title"
+        expect(table.find_by_tag("th").last.content).to eq "Created At"
+      end
+
+      it "should add a class to each table header based on the col name" do
+        expect(table.find_by_tag("th").first.class_list.to_a.join(' ')).to eq "col col-title"
+        expect(table.find_by_tag("th").last.class_list.to_a.join(' ')).to eq "col col-created_at"
+      end
+
+      it "should create a table row for each element in the collection" do
+        expect(table.find_by_tag("tr").size).to eq 4 # 1 for head, 3 for rows
+      end
+
+      it "should create a cell for each column" do
+        expect(table.find_by_tag("td").size).to eq 6
+      end
+
+      it "should add a class for each cell based on the col name" do
+        expect(table.find_by_tag("td").first.class_list.to_a.join(' ')).to eq "col col-title"
+        expect(table.find_by_tag("td").last.class_list.to_a.join(' ')).to eq "col col-created_at"
+      end
+    end
+
+    context "when creating a column with block content" do
+      let(:table) do
+        render_component assigns, helpers do
+          table_for(collection) do
+            column :title do |post|
+              span(post.title)
+            end
+          end
+        end
+      end
+
+      it "should add a class to each table header based on the col name" do
+        expect(table.find_by_tag("th").first.class_list).to include("col-title")
+      end
+
+      [ "<span>First Post</span>",
+        "<span>Second Post</span>",
+        "<span>Third Post</span>"
+      ].each_with_index do |content, index|
+        it "should create a cell with #{content}" do
+          expect(table.find_by_tag("td")[index].content.strip).to eq content
+        end
+      end
+    end
+
+    context "when creating a column with multiple block content" do
+      let(:table) do
+        render_component assigns, helpers do
+          table_for(collection) do
+            column :title do |post|
+              span(post.title)
+              span(post.title)
+            end
+          end
+        end
+      end
+
+      3.times do |index|
+        it "should create a cell with multiple elements in row #{index}" do
+          expect(table.find_by_tag("td")[index].find_by_tag("span").size).to eq 2
+        end
+      end
+    end
+
+    context "when creating many columns with symbols, blocks and strings" do
+      let(:table) do
+        render_component assigns, helpers do
+          table_for(collection) do
+            column "My Custom Title", :title
+            column :created_at, class: "datetime"
+          end
+        end
+      end
+
+      it "should add a class to each header based on class option or the col name" do
+        expect(table.find_by_tag("th").first.class_list.to_a.join(' ')).to eq "col col-my_custom_title"
+        expect(table.find_by_tag("th").last.class_list.to_a.join(' ')).to eq "col datetime"
+      end
+
+      it "should add a class to each cell based on class option or the col name" do
+        expect(table.find_by_tag("td").first.class_list.to_a.join(' ')).to eq "col col-my_custom_title"
+        expect(table.find_by_tag("td").last.class_list.to_a.join(' ')).to eq "col datetime"
+      end
+    end
+
+    context "when using a single record instead of a collection" do
+      let(:table) do
+        render_component nil, helpers do
+          table_for Post.new do
+            column :title
+          end
+        end
+      end
+
+      it "should render" do
+        expect(table.find_by_tag("th").first.content).to eq "Title"
+      end
+    end
+
+    context "when using a single Hash" do
+      let(:table) do
+        render_component nil, helpers do
+          table_for foo: 1, bar: 2 do
+            column :foo
+            column :bar
+          end
+        end
+      end
+
+      it "should render" do
+        expect(table.find_by_tag("th")[0].content).to eq "Foo"
+        expect(table.find_by_tag("th")[1].content).to eq "Bar"
+        expect(table.find_by_tag("td")[0].content).to eq "1"
+        expect(table.find_by_tag("td")[1].content).to eq "2"
+      end
+    end
+
+    context "when using an Array of Hashes" do
+      let(:table) do
+        render_component nil, helpers do
+          table_for [{foo: 1}, {foo: 2}] do
+            column :foo
+          end
+        end
+      end
+
+      it "should render" do
+        expect(table.find_by_tag("th")[0].content).to eq "Foo"
+        expect(table.find_by_tag("td")[0].content).to eq "1"
+        expect(table.find_by_tag("td")[1].content).to eq "2"
+      end
+    end
+
+    context "when record attribute is boolean" do
+      let(:table) do
+        render_component assigns, helpers do
+          table_for(collection) do
+            column :starred
+          end
+        end
+      end
+
+      it "should render boolean attribute within status tag" do
+        expect(table.find_by_tag("span").first.class_list.to_a.join(' ')).to eq "status_tag yes"
+        expect(table.find_by_tag("span").first.content).to eq "Yes"
+        expect(table.find_by_tag("span").last.class_list.to_a.join(' ')).to eq "status_tag no"
+        expect(table.find_by_tag("span").last.content).to eq "No"
+      end
+    end
+
+    context 'when row_class' do
+      let(:table) do
+        render_component assigns, helpers do
+          table_for(collection, row_class: -> e { 'starred' if e.starred }) do
+            column :starred
+          end
+        end
+      end
+
+      it 'should render boolean attribute within status tag' do
+        trs = table.find_by_tag('tr')
+        expect(trs.size).to eq 4
+        expect(trs.first.class_list.to_a.join(' ')).to eq ''
+        expect(trs.second.class_list.to_a.join(' ')).to eq 'odd starred'
+        expect(trs.third.class_list.to_a.join(' ')).to eq 'even'
+        expect(trs.fourth.class_list.to_a.join(' ')).to eq 'odd'
+      end
+    end
+
+    context "when i18n option is specified" do
+      around do |example|
+        with_translation(activerecord: { attributes: { post: { title: "Name" } } }) do
+          example.call
+        end
+      end
+
+      let(:table) do
+        render_component assigns, helpers do
+          table_for(collection, i18n: Post) do
+            column :title
+          end
+        end
+      end
+
+      it "should use localized column key" do
+        expect(table.find_by_tag("th").first.content).to eq "Name"
+      end
+    end
+
+    context "when i18n option is not specified" do
+      around do |example|
+        with_translation(activerecord: { attributes: { post: { title: "Name" } } }) do
+          example.call
+        end
+      end
+
+      let(:collection) do
+        Post.create([
+          { title: "First Post", starred: true },
+          { title: "Second Post" },
+        ])
+        Post.where(starred: true)
+      end
+
+      let(:table) do
+        render_component assigns, helpers do
+          table_for(collection) do
+            column :title
+          end
+        end
+      end
+
+      it "should predict localized key based on AR collection klass" do
+        expect(table.find_by_tag("th").first.content).to eq "Name"
+      end
+    end
+  end
+
+  describe "column sorting" do
+    def build_column(*args, &block)
+      ActiveAdmin::Views::TableFor::Column.new(*args, &block)
+    end
+
+    subject { table_column }
+
+    context "when default" do
+      let(:table_column){ build_column(:username) }
+      it { is_expected.to be_sortable }
+
+      describe '#sort_key' do
+        subject { super().sort_key }
+        it{ is_expected.to eq("username") }
+      end
+    end
+
+    context "when a block given with no sort key" do
+      let(:table_column){ build_column("Username"){ } }
+      it { is_expected.to be_sortable }
+
+      describe '#sort_key' do
+        subject { super().sort_key }
+        it { is_expected.to eq("Username") }
+      end
+    end
+
+    context "when a block given with a sort key" do
+      let(:table_column){ build_column("Username", sortable: :username){ } }
+      it { is_expected.to be_sortable }
+
+      describe '#sort_key' do
+        subject { super().sort_key }
+        it{ is_expected.to eq("username") }
+      end
+    end
+
+    context 'when a block given with virtual attribute and no sort key' do
+      let(:table_column) { build_column(:virtual, nil, Post) { } }
+      it { is_expected.not_to be_sortable }
+    end
+
+    context 'when symbol given as a data column should be sortable' do
+      let(:table_column){ build_column('Username column', :username) }
+      it { is_expected.to be_sortable }
+
+      describe '#sort_key' do
+        subject { super().sort_key }
+        it { is_expected.to eq 'username' }
+      end
+    end
+
+    context 'when sortable: true with a symbol and string' do
+      let(:table_column){ build_column('Username column', :username, sortable: true) }
+      it { is_expected.to be_sortable }
+
+      describe '#sort_key' do
+        subject { super().sort_key }
+        it { is_expected.to eq 'username' }
+      end
+    end
+
+    context "when sortable: false with a symbol" do
+      let(:table_column){ build_column(:username, sortable: false) }
+      it { is_expected.not_to be_sortable }
+    end
+
+    context "when sortable: false with a symbol and string" do
+      let(:table_column){ build_column("Username", :username, sortable: false) }
+      it { is_expected.not_to be_sortable }
+    end
+
+    context "when :sortable column is an association" do
+      let(:table_column){ build_column("Category", :category, Post) }
+      it { is_expected.not_to be_sortable }
+    end
+
+    context 'when :sortable column is an association and block given' do
+      let(:table_column){ build_column('Category', :category, Post) { } }
+      it { is_expected.not_to be_sortable }
+    end
+  end
+end

data/spec/unit/views/components/tabs_spec.rb

@@ -0,0 +1,99 @@
+require 'rails_helper'
+
+RSpec.describe ActiveAdmin::Views::Tabs do
+  describe "creating with the dsl" do
+    context "when creating tabs with a symbol" do
+      before do
+        allow(I18n).to receive(:t).with("i18n.transliterate.rule".to_sym, anything).and_call_original
+        expect(I18n).to receive(:t).at_least(:once).with(:tab_key).and_return "テスト"
+      end
+
+      let(:tabs) do
+        render_component do
+          tabs do
+            tab :overview
+            tab I18n.t(:tab_key), id: :something_unique, html_options: { class: :some_css_class }
+          end
+        end
+      end
+
+      let(:subject) { Capybara.string(tabs.to_s) }
+
+      it "should create a tab navigation bar based on the symbol" do
+        expect(subject).to have_content('Overview')
+      end
+
+      it "should have tab with id based on symbol" do
+        expect(subject).to have_selector('div#overview')
+      end
+
+      it "should have link with fragment based on symbol" do
+        expect(subject).to have_selector('a[href="#overview"]')
+      end
+
+      it "should handle translation" do
+        expect(subject).to have_content('テスト')
+      end
+
+      it "should have tab with id based on options" do
+        expect(subject).to have_selector('div#something_unique')
+      end
+
+      it "should have link with fragment based on options" do
+        expect(subject).to have_selector('a[href="#something_unique"]')
+      end
+
+      it "should have li with specific css class" do
+        expect(subject).to have_selector('li.some_css_class')
+      end
+
+    end
+
+    context "when creating a tab with a block" do
+      let(:tabs) do
+        render_component do
+          tabs do
+            tab :overview do
+              span 'tab 1'
+            end
+          end
+        end
+      end
+
+      it "should create a tab navigation bar based on the symbol" do
+        expect(tabs.find_by_tag('li').first.content).to include("Overview")
+      end
+
+      it "should create a tab with a span inside of it" do
+        expect(tabs.find_by_tag('span').first.content).to eq('tab 1')
+      end
+    end
+
+    context "when creating a tab with non-transliteratable string" do
+      let(:tabs) do
+        render_component do
+          tabs do
+            tab '🤗' do
+              'content'
+            end
+          end
+        end
+      end
+
+      let(:subject) { Capybara.string(tabs.to_s) }
+
+      it "should create a tab navigation bar based on the string" do
+        expect(subject).to have_content('🤗')
+      end
+
+      it "should have tab with id based on URL-encoded string" do
+        tab_content = subject.find('.tabs .tab-content div', text: 'content')
+        expect(tab_content['id']).to eq(CGI.escape('🤗'))
+      end
+
+      it "should have link with fragment based on URL-encoded string" do
+        expect(subject).to have_link('🤗', href: "##{CGI.escape('🤗')}")
+      end
+    end
+  end
+end

data/spec/unit/views/index_as_blog_spec.rb

@@ -0,0 +1,76 @@
+require 'rails_helper'
+
+include ActiveAdmin
+RSpec.describe ActiveAdmin::Views::IndexAsBlog do
+  subject { described_class.new }
+
+  describe '#build' do
+    let(:page_presenter) { double('page_presenter', block: nil) }
+    let(:collection) { double('collection') }
+
+    before do
+      expect(subject).to receive('build_posts')
+      expect(subject).to receive('add_class').with('index')
+    end
+
+    context 'when page_presenter has no block' do
+      before do
+        subject.build(page_presenter, collection)
+      end
+
+      it do
+        expect(subject.instance_variable_get(:@page_presenter))
+          .to eq(page_presenter)
+        expect(subject.instance_variable_get(:@collection)).to eq(collection)
+      end
+    end
+
+    context 'when page_presenter has block' do
+      let(:block) { Proc.new { double('proc_method') } }
+
+      before do
+        allow(page_presenter).to receive(:block).and_return(block)
+        allow(subject).to receive('instance_exec')
+        subject.build(page_presenter, collection)
+      end
+
+      it do
+        expect(subject).to have_received('instance_exec')
+      end
+    end
+  end
+
+  %w(title body).each do |method|
+    describe "#{method}" do
+      context 'when block given' do
+        let(:block_result) { double('block_result') }
+
+        it "should use the block to set the #{method}" do
+          expect(
+            subject.public_send("#{method}") do
+              block_result
+            end.yield
+          ).to eq(block_result)
+        end
+      end
+
+      context 'when no block and method given' do
+        let(:method) { double('method') }
+
+        it "should use method to set the #{method}" do
+          expect(subject.public_send("#{method}", method)).to eq(method)
+        end
+      end
+
+      context 'when no block and no method given' do
+        it 'should be nil' do
+          expect(subject.public_send("#{method}")).to eq(nil)
+        end
+      end
+    end
+  end
+
+  describe '.index_name' do
+    it { expect(described_class.index_name).to eq('blog') }
+  end
+end

data/tasks/docs.rake

@@ -0,0 +1,64 @@
+require 'yard'
+require 'yard/rake/yardoc_task'
+
+namespace :docs do
+
+  YARD::Rake::YardocTask.new do |t|
+    t.files = ['lib/**/*.rb']
+    t.options = ['--no-output']
+  end
+
+  def jekyll_redirect_string(filename)
+    <<-EOD.strip_heredoc
+      ---
+      redirect_from: /docs/3-index-pages/#{filename}
+      ---
+
+    EOD
+  end
+
+  def filename_from_module(mod)
+    mod.name.to_s.underscore.tr('_', '-')
+  end
+
+  def write_docstrings_to(path, mods)
+    mods.each do |mod|
+      filename = filename_from_module(mod)
+
+      File.open("#{path}/#{filename}.md", 'w+') do |f|
+        f << jekyll_redirect_string("#{filename}.html") + mod.docstring + "\n"
+      end
+    end
+  end
+
+  def docs_syncronized?
+    # Do not print diff and yield whether exit code was zero
+    sh('git diff --quiet docs/3-index-pages') do |outcome, _|
+      return if outcome
+
+      # Output diff before raising error
+      sh('git diff docs/3-index-pages')
+
+      raise <<-MSG.strip_heredoc
+        The docs/3-index-pages directory is out of sync.
+        Run rake generate_cops_documentation and commit the results.
+      MSG
+    end
+  end
+
+  desc "Update docs in the docs folder"
+  task build: :yard do
+    require 'yard'
+    require 'active_support/all'
+
+    YARD::Registry.load!
+    views = YARD::Registry.at("ActiveAdmin::Views")
+
+    # Index Types
+    index_types = views.children.select{|obj| obj.name.to_s =~ /^IndexAs/ }
+    write_docstrings_to "docs/3-index-pages", index_types
+
+    docs_syncronized? if ENV["CI"]
+  end
+
+end

data/tasks/lint.rake

@@ -0,0 +1,21 @@
+desc "Lints ActiveAdmin code base"
+task lint: ["lint:rubocop", "lint:mdl"]
+
+namespace :lint do
+  require "rubocop/rake_task"
+  desc "Checks ruby code style with RuboCop"
+  RuboCop::RakeTask.new
+
+  desc "Checks markdown code style with Markdownlint"
+  task :mdl do
+    puts "Running mdl..."
+
+    targets = [
+      *Dir.glob("docs/**/*.md"),
+      "CONTRIBUTING.md",
+      ".github/ISSUE_TEMPLATE.md"
+    ]
+
+    abort unless system("mdl", *targets)
+  end
+end