activeadmin-rb 1.4.0

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

@@ -0,0 +1,39 @@
+require 'rails_helper'
+
+RSpec.describe ActiveAdmin::Views::UnsupportedBrowser do
+  let(:helpers){ mock_action_view }
+  let(:namespace) { double :namespace, unsupported_browser_matcher: /MSIE [1-8]\.0/ }
+  let(:component) { double :unsupported_browser_component }
+  let(:base) { ActiveAdmin::Views::Pages::Base.new }
+
+  def build_panel
+    render_arbre_component({}, helpers) do
+      insert_tag ActiveAdmin::Views::UnsupportedBrowser
+    end
+  end
+
+  it "should render the panel" do
+    expect(I18n).to receive(:t).and_return("headline", "recommendation" , "turn_off_compatibility_view")
+    expect(build_panel.content.gsub(/\s+/, "")).to eq "<h1>headline</h1><p>recommendation</p><p>turn_off_compatibility_view</p>"
+  end
+
+  describe "ActiveAdmin::Views::Pages::Base behavior" do
+    context "when the reqex match" do
+      it "should build the unsupported browser panel" do
+        expect(base).to receive(:active_admin_namespace).and_return(namespace)
+        expect(base).to receive_message_chain(:controller, :request, :user_agent).and_return("Mozilla/5.0 (compatible; MSIE 7.0; Windows NT 6.2; Trident/6.0)")
+        expect(base).to receive(:unsupported_browser)
+        base.send(:build_unsupported_browser)
+      end
+    end
+
+    context "when the regex not match" do
+      it "should not build the unsupported browser panel" do
+        expect(base).to receive(:active_admin_namespace).and_return(namespace)
+        expect(base).to receive_message_chain(:controller, :request, :user_agent).and_return("Mozilla/5.0 (compatible; MSIE 10.0; Windows NT 6.2; Trident/6.0)")
+        expect(base).to receive(:unsupported_browser).never
+        base.send(:build_unsupported_browser)
+      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/spec/unit/views/pages/base_spec.rb

@@ -0,0 +1,14 @@
+require 'rails_helper'
+
+RSpec.describe ActiveAdmin::Views::Pages::Base do
+  class NewPage < ActiveAdmin::Views::Pages::Base
+  end
+
+  it "defines a default title" do
+    expect(NewPage.new.title).to eq 'NewPage'
+  end
+
+  it "defines default main content" do
+    expect(NewPage.new.main_content).to eq 'Please implement NewPage#main_content to display content.'
+  end
+end

data/spec/unit/views/pages/form_spec.rb

@@ -0,0 +1,54 @@
+require 'rails_helper'
+
+RSpec.describe ActiveAdmin::Views::Pages::Form do
+  describe "#title" do
+    let!(:application){ ActiveAdmin::Application.new }
+    let(:namespace){ ActiveAdmin::Namespace.new(application, "Admin") }
+    let!(:http_params){ { controller: "UsersController", action: "edit" } }
+    let!(:params) { ActionController::Parameters.new(http_params) }
+
+    let(:helpers) do
+      helpers = mock_action_view
+      allow(helpers).to receive(:active_admin_config).and_return(namespace.register(Post))
+      allow(helpers).to receive(:params).and_return(params)
+      helpers
+    end
+
+    let(:arbre_context) do
+      OpenStruct.new(params: params, helpers: helpers, assigns: {})
+    end
+
+    context "when :title is set" do
+      it "should show the set page title" do
+
+        page = ActiveAdmin::Views::Pages::Form.new(arbre_context)
+        expect(page).to receive(:resource)
+        expect(page).to receive(:form_presenter).twice.and_return({ title: "My Page Title" })
+        expect(page.title).to eq "My Page Title"
+      end
+    end
+
+    context "when page_title is assigned" do
+      it "should show the set page title" do
+        arbre_context.assigns[:page_title] = "My Page Title"
+        page = ActiveAdmin::Views::Pages::Form.new(arbre_context)
+        expect(page.title).to eq "My Page Title"
+      end
+    end
+
+    context "when page_title is not assigned" do
+      {
+        "new" => "New Post",
+        "create" => "New Post",
+        "edit" => "Edit Post",
+        "update" => "Edit Post"
+      }.each do |action, title|
+        it "should show the correct I18n text on the #{action} action" do
+          params[:action] = action
+          page = ActiveAdmin::Views::Pages::Form.new(arbre_context)
+          expect(page.title).to eq title
+        end
+      end
+    end
+  end
+end

data/spec/unit/views/pages/index_spec.rb

@@ -0,0 +1,60 @@
+require 'rails_helper'
+
+RSpec.describe ActiveAdmin::Views::Pages::Index do
+  describe "#title" do
+    let!(:application){ ActiveAdmin::Application.new }
+    let(:namespace){ ActiveAdmin::Namespace.new(application, "Admin") }
+    let!(:params){ ActionController::Parameters.new(controller: "UsersController", action: "edit") }
+    let(:helpers) do
+      helpers = mock_action_view
+      allow(helpers).to receive(:active_admin_config).and_return(namespace.register(Post))
+      allow(helpers).to receive(:params).and_return(params)
+      helpers
+    end
+
+    let(:arbre_context) do
+      OpenStruct.new(params: params, helpers: helpers, assigns: {})
+    end
+
+    context "when config[:title] is assigned" do
+      context "with a Proc" do
+        it "should return the value of the assigned Proc" do
+          page = ActiveAdmin::Views::Pages::Index.new(arbre_context)
+          allow(page).to receive(:config).and_return(title: ->{ "My Page Title" })
+          expect(page.title).to eq "My Page Title"
+        end
+      end
+
+      context "with a String" do
+        it "should return the assigned String" do
+          page = ActiveAdmin::Views::Pages::Index.new(arbre_context)
+          allow(page).to receive(:config).and_return(title: ->{ "My Page Title" })
+          expect(page.title).to eq "My Page Title"
+        end
+      end
+
+      context "with a Integer" do
+        it "should return the Integer" do
+          page = ActiveAdmin::Views::Pages::Index.new(arbre_context)
+          allow(page).to receive(:config).and_return(title: 1)
+          expect(page.title).to eq 1
+        end
+      end
+    end
+
+    context "when page_title is assigned" do
+      it "should return the set page title" do
+        arbre_context.assigns[:page_title] = "My Page Title"
+        page = ActiveAdmin::Views::Pages::Index.new(arbre_context)
+        expect(page.title).to eq "My Page Title"
+      end
+    end
+
+    context "when page_title is not assigned" do
+      it "should return the correct I18n text" do
+        page = ActiveAdmin::Views::Pages::Index.new(arbre_context)
+        expect(page.title).to eq "Posts"
+      end
+    end
+  end
+end

data/spec/unit/views/pages/layout_spec.rb

@@ -0,0 +1,59 @@
+require 'rails_helper'
+
+RSpec.describe ActiveAdmin::Views::Pages::Layout do
+
+  let(:assigns){ {} }
+  let(:helpers) do
+    helpers = mock_action_view
+
+    { active_admin_application:   active_admin_application,
+      active_admin_config:        double('Config', action_items?: nil, breadcrumb: nil, sidebar_sections?: nil),
+      active_admin_namespace:     active_admin_namespace,
+      csrf_meta_tag:              '',
+      current_active_admin_user:  nil,
+      current_active_admin_user?: false,
+      current_menu:               double('Menu', items: []),
+      params:                     {controller: 'UsersController', action: 'edit'},
+      env:                        {}
+    }.each do |method, returns|
+      allow(helpers).to receive(method).and_return returns
+    end
+
+    helpers
+  end
+
+  let(:active_admin_namespace){ ActiveAdmin::Namespace.new(ActiveAdmin::Application.new, :myspace) }
+  let(:active_admin_application){ ActiveAdmin.application }
+  let(:view_factory) { ActiveAdmin::ViewFactory.new }
+
+  let(:layout) do
+    render_arbre_component assigns, helpers do
+      insert_tag ActiveAdmin::Views::Pages::Layout
+    end
+  end
+
+  it "should be the @page_title if assigned in the controller" do
+    assigns[:page_title] = "My Page Title"
+
+    expect(layout.title).to eq "My Page Title"
+  end
+
+  it "should be the default translation" do
+    helpers.params[:action] = "edit"
+
+    expect(layout.title).to eq "Edit"
+  end
+
+  describe "the body" do
+
+    it "should have class 'active_admin'" do
+      expect(layout.build.class_list).to include 'active_admin'
+    end
+
+    it "should have namespace class" do
+      expect(layout.build.class_list).to include "#{active_admin_namespace.name}_namespace"
+    end
+
+  end
+
+end

data/spec/unit/views/pages/show_spec.rb

@@ -0,0 +1,32 @@
+require 'rails_helper'
+
+RSpec.describe ActiveAdmin::Views::Pages::Show do
+
+  describe "the resource" do
+    let(:helpers) { double resource: resource }
+    let(:arbre_context) { Arbre::Context.new({}, helpers) }
+    subject(:page) { ActiveAdmin::Views::Pages::Show.new(arbre_context) }
+
+    context 'when the resource does not respond to #decorator' do
+      let(:resource) { 'Test Resource' }
+
+      it "normally returns the resource" do
+        expect(page.resource).to eq 'Test Resource'
+      end
+    end
+
+    context 'when you pass a block to main content' do
+      let(:block) { lambda { } }
+      let(:resource) { double('resource') }
+
+      before { allow(page).to receive(:active_admin_config).and_return(double(comments?: false, resource_columns: [:field]))}
+
+      it 'appends it to the output' do
+        expect(page).to receive(:attributes_table).with(:field).and_yield
+        page.default_main_content(&block)
+      end
+    end
+
+  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

data/tasks/local.rake

@@ -0,0 +1,25 @@
+desc 'Runs a command agains the local sample application'
+task :local do
+  Rake::Task['setup'].invoke(false,
+                             '.test-rails-apps',
+                             'rails_template_with_data')
+
+  app_folder = ".test-rails-apps/rails-#{Rails::VERSION::STRING}"
+
+  # Discard the "local" argument (name of the task)
+  argv = ARGV[1..-1]
+
+  # If it's a rails command, or we're using Rails 5, auto add the rails script
+  rails_commands = %w(generate console server db dbconsole g c s runner)
+
+  if Rails::VERSION::MAJOR >= 5 || rails_commands.include?(argv[0])
+    argv.unshift('rails')
+  end
+
+  command = ['bundle', 'exec', *argv].join(' ')
+  env = { 'BUNDLE_GEMFILE' => ENV['BUNDLE_GEMFILE'] }
+
+  Dir.chdir(app_folder) do
+    Bundler.with_clean_env { Kernel.exec(env, command) }
+  end
+end