yousty-activeadmin 1.0.0.pre

data/spec/unit/filters/filter_form_builder_spec.rb

@@ -0,0 +1,423 @@
+require 'spec_helper'
+
+class Post
+  ransacker :custom_searcher do
+    # nothing to see here
+  end
+end
+
+describe ActiveAdmin::Filters::ViewHelper do
+
+  # Setup an ActionView::Base object which can be used for
+  # generating the form for.
+  let(:helpers) do
+    view = action_view
+    def view.collection_path
+      "/posts"
+    end
+
+    def view.protect_against_forgery?
+      false
+    end
+
+    def view.a_helper_method
+      "A Helper Method"
+    end
+
+    view
+  end
+
+  def render_filter(search, filters)
+    render_arbre_component({filter_args: [search, filters]}, helpers) do
+      text_node active_admin_filters_form_for *assigns[:filter_args]
+    end
+  end
+
+  def filter(name, options = {})
+    render_filter scope, name => options
+  end
+
+  let(:scope) { Post.search }
+
+  describe "the form in general" do
+    let(:body) { filter :title }
+
+    it "should generate a form which submits via get" do
+      body.should have_tag("form", :attributes => { :method => 'get', :class => 'filter_form' })
+    end
+
+    it "should generate a filter button" do
+      body.should have_tag("input", :attributes => { :type => "submit",
+                                                        :value => "Filter" })
+    end
+
+    it "should only generate the form once" do
+      body.to_s.scan(/q\[title_contains\]/).size.should == 1
+    end
+
+    it "should generate a clear filters link" do
+      body.should have_tag("a", "Clear Filters", :attributes => { :class => "clear_filters_btn" })
+    end
+  end
+
+  describe "string attribute" do
+    let(:body) { filter :title }
+
+    it "should generate a select option for starts with" do
+      body.should have_tag("option", "Starts with", :attributes => { :value => 'title_starts_with' })
+    end
+
+    it "should generate a select option for ends with" do
+      body.should have_tag("option", "Ends with", :attributes => { :value => 'title_ends_with' })
+    end
+
+    it "should generate a select option for contains" do
+      body.should have_tag("option", "Contains", :attributes => { :value => 'title_contains' })
+    end
+
+    it "should generate a text field for input" do
+      body.should have_tag("input", :attributes => { :name => 'q[title_contains]' })
+    end
+    
+    it "should have a proper label" do
+      body.should have_tag('label', 'Title')
+    end
+
+    it "should translate the label for text field" do
+      begin
+        I18n.backend.store_translations(:en, :activerecord => { :attributes => { :post => { :title => "Name" } } })
+        body.should have_tag('label', 'Name')
+      ensure
+        I18n.backend.reload!
+      end
+    end
+
+    it "should select the option which is currently being filtered"
+
+  end
+
+  describe "string attribute with sub filters" do
+    let(:body) { filter :title_contains }
+    
+    it "should generate a search field for a string attribute with query contains" do
+      body.should have_tag("input", :attributes => { :name => "q[title_contains]"})
+      body.should have_tag('label', 'Title contains')
+    end
+
+    it "should NOT generate a select option for contains" do
+      body.should_not have_tag("option", "Contains", :attributes => { :value => 'title_contains' })
+    end
+
+    context "using starts_with and as" do
+      let(:body) { filter :title_starts_with }
+
+      it "should generate a search field for a string attribute with query starts_with" do
+        body.should have_tag("input", :attributes => { :name => "q[title_starts_with]" })
+      end
+    end
+
+    context "using ends_with and as" do
+      let(:body) { filter :title_ends_with }
+
+      it "should generate a search field for a string attribute with query ends_with" do
+        body.should have_tag("input", :attributes => { :name => "q[title_ends_with]" })
+      end
+    end
+    
+    context "using contains and NO AS defined" do
+      let(:body) { filter :title_contains }
+
+      it "should generate a search field for a string attribute with query contains" do
+        body.should have_tag("input", :attributes => { :name => "q[title_contains]" })
+      end
+    end
+  end
+  
+  describe "text attribute" do
+    let(:body) { filter :body }
+
+    it "should generate a search field for a text attribute" do
+      body.should have_tag("input", :attributes => { :name => "q[body_contains]"})
+    end
+
+    it "should have a proper label" do
+      body.should have_tag('label', 'Body')
+    end
+  end
+
+  describe "string attribute, as a select" do
+    let(:body) { filter :title, as: :select }
+    let(:builder) { ActiveAdmin::Inputs::FilterSelectInput }
+
+    context "when loading collection from DB" do
+      it "should use pluck for efficiency" do
+        builder.any_instance.should_receive(:pluck_column) { [] }
+        body
+      end
+
+      it "should remove original ordering to prevent PostgreSQL error" do
+        scope.object.klass.should_receive(:reorder).with('title asc') {
+          m = double uniq: double(pluck: ['A Title'])
+          m.uniq.should_receive(:pluck).with :title
+          m
+        }
+        body
+      end
+    end
+  end
+
+  describe "datetime attribute" do
+    let(:body) { filter :created_at }
+
+    it "should generate a date greater than" do
+      body.should have_tag("input", :attributes => { :name => "q[created_at_gteq]", :class => "datepicker"})
+    end
+    it "should generate a seperator" do
+      body.should have_tag("span", :attributes => { :class => "seperator"})
+    end
+    it "should generate a date less than" do
+      body.should have_tag("input", :attributes => { :name => "q[created_at_lteq]", :class => "datepicker"})
+    end
+  end
+
+  describe "integer attribute" do
+    let(:body) { filter :id }
+
+    it "should generate a select option for equal to" do
+      body.should have_tag("option", "Equals", :attributes => { :value => 'id_equals' })
+    end
+    it "should generate a select option for greater than" do
+      body.should have_tag("option", "Greater than")
+    end
+    it "should generate a select option for less than" do
+      body.should have_tag("option", "Less than")
+    end
+    it "should generate a text field for input" do
+      body.should have_tag("input", :attributes => { :name => 'q[id_equals]' })
+    end
+    it "should select the option which is currently being filtered"
+  end
+
+  describe "boolean attribute" do
+    context "boolean datatypes" do
+      let(:body) { filter :starred }
+
+      it "should create a check box for equals to" do
+        body.should have_tag("input", :attributes => {
+                                            :name => "q[starred_eq]",
+                                            :type => "checkbox" })
+      end
+
+      it "should translate the label for boolean field" do
+        begin
+          I18n.backend.store_translations(:en, :activerecord => { :attributes => { :post => { :starred => "Faved" } } })
+          body.should have_tag('label', 'Faved')
+        ensure
+          I18n.backend.reload!
+        end
+      end
+    end
+
+    context "non-boolean data types" do
+      let(:body) { filter :title_present, :as => :boolean }
+
+      it "should create a check box for equals to" do
+        body.should have_tag("input", :attributes => {
+                                            :name => "q[title_present]",
+                                            :type => "checkbox" })
+      end
+    end
+  end
+
+  describe "belongs_to" do
+    before do
+      @john = User.create :first_name => "John", :last_name => "Doe", :username => "john_doe"
+      @jane = User.create :first_name => "Jane", :last_name => "Doe", :username => "jane_doe"
+    end
+
+    context "when given as the _id attribute name" do
+      let(:body) { filter :author_id }
+
+      it "should generate a numeric filter" do
+        body.should have_tag 'label', 'Author' # really this should be Author ID :/
+        body.should have_tag 'option', :attributes => { :value => 'author_id_less_than' }
+        body.should have_tag 'input',  :attributes => { :id => 'q_author_id', :name => 'q[author_id_equals]'}
+      end
+    end
+
+    context "when given as the name of the relationship" do
+      let(:body) { filter :author }
+
+      it "should generate a select" do
+        body.should have_tag "select",             :attributes => { :name => "q[author_id_eq]" }
+      end
+      it "should set the default text to 'Any'" do
+        body.should have_tag "option", "Any",      :attributes => { :value => "" }
+      end
+      it "should create an option for each related object" do
+        body.should have_tag "option", "John Doe", :attributes => { :value => @john.id }
+        body.should have_tag "option", "Jane Doe", :attributes => { :value => @jane.id }
+      end
+
+      context "with a proc" do
+        let :body do
+          filter :title, :as => :select, :collection => proc{ ['Title One', 'Title Two'] }
+        end
+
+        it "should use call the proc as the collection" do
+          body.should have_tag("option", "Title One")
+          body.should have_tag("option", "Title Two")
+        end
+
+        it "should render the collection in the context of the view" do
+          body = filter(:title, :as => :select, :collection => proc{[a_helper_method]})
+          body.should have_tag("option", "A Helper Method")
+        end
+      end
+    end
+
+    context "as check boxes" do
+      let(:body) { filter :author, :as => :check_boxes }
+
+      it "should create a check box for each related object" do
+        body.should have_tag("input", :attributes => {
+                                            :name => "q[author_id_in][]",
+                                            :type => "checkbox",
+                                            :value => @john.id })
+        body.should have_tag("input", :attributes => {
+                                            :name => "q[author_id_in][]",
+                                            :type => "checkbox",
+                                            :value => @jane.id })
+      end
+    end
+
+    context "when polymorphic relationship" do
+      let(:scope) { ActiveAdmin::Comment.search }
+      it "should raise an error if a collection isn't provided" do
+        expect { filter :resource }.to raise_error \
+          Formtastic::PolymorphicInputWithoutCollectionError
+      end
+    end
+  end # belongs to
+
+  describe "has_and_belongs_to_many" do
+    pending "add HABTM models so this can be tested"
+  end
+
+  describe "has_many :through" do
+    # Setup an ActionView::Base object which can be used for
+    # generating the form for.
+    let(:helpers) do
+      view = action_view
+      def view.collection_path
+        "/categories"
+      end
+
+      def view.protect_against_forgery?
+        false
+      end
+
+      def view.a_helper_method
+        "A Helper Method"
+      end
+
+      view
+    end
+    let(:scope) { Category.search }
+
+    let!(:john) { User.create :first_name => "John", :last_name => "Doe", :username => "john_doe" }
+    let!(:jane) { User.create :first_name => "Jane", :last_name => "Doe", :username => "jane_doe" }
+
+    context "when given as the name of the relationship" do
+      let(:body) { filter :authors }
+
+      it "should generate a select" do
+        body.should have_tag 'select', :attributes => { :name => "q[posts_author_id_eq]" }
+      end
+
+      it "should set the default text to 'Any'" do
+        body.should have_tag "option", "Any", :attributes => { :value => "" }
+      end
+
+      it "should create an option for each related object" do
+        body.should have_tag "option", "John Doe", :attributes => { :value => john.id }
+        body.should have_tag "option", "Jane Doe", :attributes => { :value => jane.id }
+      end
+    end
+
+    context "as check boxes" do
+      let(:body) { filter :authors, :as => :check_boxes }
+
+      it "should create a check box for each related object" do
+        body.should have_tag("input", :attributes => {
+                                            :name => "q[posts_author_id_in][]",
+                                            :type => "checkbox",
+                                            :value => john.id })
+        body.should have_tag("input", :attributes => {
+                                            :name => "q[posts_author_id_in][]",
+                                            :type => "checkbox",
+                                            :value => jane.id })
+      end
+    end
+  end
+
+  describe "conditional display" do
+    context "with :if block" do
+      it "should be displayed if true" do
+        body = filter :body,   if: proc{true}
+        body.should     have_tag "input", attributes: {name: "q[body_contains]"}
+      end
+
+      it "should NOT be displayed if false" do
+        body = filter :author, if: proc{false}
+        body.should_not have_tag "input", attributes: {name: "q[author_id_eq]"}
+      end
+    end
+
+    context "with :unless block" do
+      it "should be displayed if false" do
+        body = filter :created_at, unless: proc{false}
+        body.should     have_tag "input", attributes: {name: "q[created_at_gteq]"}
+      end
+
+      it "should NOT be displayed if true" do
+        body = filter :updated_at, unless: proc{true}
+        body.should_not have_tag "input", attributes: {name: "q[updated_at_gteq]"}
+      end
+    end
+  end
+
+  describe "custom search methods" do
+
+    it "should work as select" do
+      body = filter :custom_searcher, as: :select, collection: ['foo']
+      body.should have_tag "select", attributes: { name: "q[custom_searcher]" }
+    end
+
+    it "should work as string" do
+      body = filter :custom_searcher, as: :string
+      body.should have_tag "input", attributes: { name: "q[custom_searcher]" }
+    end
+  end
+
+  describe "blank option" do
+    context "for a select filter" do
+      it "should be there by default" do
+        filter(:author).should have_tag "option", "Any"
+      end
+      it "should be able to be disabled" do
+        filter(:author, include_blank: false).should_not have_tag "option", "Any"
+      end
+    end
+
+    context "for a multi-select filter" do
+      it "should not be there by default" do
+        filter(:author, multiple: true).should_not have_tag "option", "Any"
+      end
+      it "should be able to be enabled" do
+        filter(:author, multiple: true, include_blank: true).should have_tag "option", "Any"
+      end
+    end
+  end
+
+end

data/spec/unit/filters/resource_spec.rb

@@ -0,0 +1,119 @@
+require 'spec_helper'
+
+describe ActiveAdmin::Filters::ResourceExtension do
+
+  let(:resource) do
+    namespace = ActiveAdmin::Namespace.new(ActiveAdmin::Application.new, :admin)
+    namespace.register(Post)
+  end
+
+  it "should return the defaults if no filters are set" do
+    resource.filters.keys.sort.should == [
+      :author, :body, :category, :created_at, :published_at, :starred, :title, :updated_at
+    ]
+  end
+
+  it "should not have defaults when filters are disabled on the resource" do
+    resource.filters = false
+    resource.filters.should be_empty
+  end
+
+  it "should not have defaults when the filters are disabled on the namespace" do
+    resource.namespace.filters = false
+    resource.filters.should be_empty
+  end
+
+  it "should not have defaults when the filters are disabled on the application" do
+    resource.namespace.application.filters = false
+    resource.filters.should be_empty
+  end
+
+  describe "removing a filter" do
+    it "should work" do
+      resource.filters.keys.should include :author
+      resource.remove_filter :author
+      resource.filters.keys.should_not include :author
+    end
+
+    it "should work as a string" do
+      resource.filters.keys.should include :author
+      resource.remove_filter 'author'
+      resource.filters.keys.should_not include :author
+    end
+
+    it "should be lazy" do
+      resource.should_not_receive :default_filters # this hits the DB
+      resource.remove_filter :author
+    end
+
+    it "should not prevent the default filters from being added" do
+      resource.remove_filter :author
+      resource.filters.should_not be_empty
+    end
+
+    it "should raise an exception when filters are disabled" do
+      resource.filters = false
+      expect{ resource.remove_filter :author }.to raise_error ActiveAdmin::Filters::Disabled
+    end
+  end
+
+  describe "adding a filter" do
+    it "should work" do
+      resource.add_filter :title
+      resource.filters.should eq title: {}
+    end
+
+    it "should work as a string" do
+      resource.add_filter 'title'
+      resource.filters.should eq title: {}
+    end
+
+    it "should work with specified options" do
+      resource.add_filter :title, as: :string
+      resource.filters.should eq title: {as: :string}
+    end
+
+    it "should override an existing filter" do
+      resource.add_filter :title, one: :two
+      resource.add_filter :title, three: :four
+
+      resource.filters.should eq title: {three: :four}
+    end
+
+    it "should keep specified options" do
+      resource.add_filter :title, one: :two
+
+      resource.filters.each do |attribute, opts|
+        opts.delete(:one)
+      end
+
+      resource.filters.should eq title: {one: :two}
+    end
+
+    it "should preserve default filters" do
+      resource.preserve_default_filters!
+      resource.add_filter :count, as: :string
+
+      resource.filters.keys.sort.should == [
+        :author, :body, :category, :count, :created_at, :published_at, :starred, :title, :updated_at
+      ]
+    end
+
+    it "should raise an exception when filters are disabled" do
+      resource.filters = false
+      expect{ resource.add_filter :title }.to raise_error ActiveAdmin::Filters::Disabled
+    end
+  end
+
+  it "should reset filters" do
+    resource.add_filter :title
+    resource.filters.size.should == 1
+    resource.reset_filters!
+    resource.filters.size.should > 1
+  end
+
+  it "should add a sidebar section for the filters" do
+    resource.sidebar_sections.first.name.should == :filters
+  end
+
+end