admino 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8452d6a30488e570a6db66b94321de492c261337
-  data.tar.gz: d45d064082c74e72675f15c85b0a1c2fbf1c2771
+  metadata.gz: e06d7c035647ac161360ae08222d2b06b1abca0b
+  data.tar.gz: f223ee1b778e59436a7a61ae13b34e59710ea612
 SHA512:
-  metadata.gz: 264b1621f826d1b0dd33020edb46e16b1228d5c788b2029315b524fd9f33e1e972e330968410e6518f0e6e89a1c0221e8faa55acef880b0b857338941e9c2f2f
-  data.tar.gz: 22ed8914aa029593876190c46ac5991155026e5bdbd4ef393ed2ec828db2e6e37d10365981347042e1704780959194aef68c291aa719d344bcae2399ae38394a
+  metadata.gz: 50f41c99c286533749958ead22766d0a06458eb20d0a17e1b74101c6376ea3e631515bb5cd91a00b99e287e64c2f5f7ce9d70b523c79e250ac2e1db1bd500c65
+  data.tar.gz: 007a6a7a9e3dc548e6bdcbab58ff960f5eb9c74013443e4d57b5c92d09eced051bd8b4684850715031e5539f1f40b3be2be62e274ff025d43d23ecd9d03f8951

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# v0.0.9
+
+* Allow `include_empty_scope` option in filter groups
+
+  ```
+    filter_by :status, [:foo, :bar], include_empty_scope: true
+  ```
+
 # v0.0.8
 
 * Support a symbol column label. It will use human attribute name:

data/lib/admino/query/configuration.rb

@@ -20,10 +20,19 @@ module Admino
       class FilterGroup
         attr_reader :name
         attr_reader :scopes
+        attr_reader :options
+
+        def initialize(name, scopes, options = {})
+          options.symbolize_keys!
+          options.assert_valid_keys(:include_empty_scope)
 
-        def initialize(name, scopes)
           @name = name.to_sym
           @scopes = scopes.map(&:to_sym)
+          @options = options
+        end
+
+        def include_empty_scope?
+          @options.fetch(:include_empty_scope) { false }
         end
       end
 
@@ -64,8 +73,8 @@ module Admino
         end
       end
 
-      def add_filter_group(name, scopes)
-        FilterGroup.new(name, scopes).tap do |filter_group|
+      def add_filter_group(name, scopes, options = {})
+        FilterGroup.new(name, scopes, options).tap do |filter_group|
           self.filter_groups << filter_group
         end
       end

data/lib/admino/query/dsl.rb

@@ -13,8 +13,8 @@ module Admino
         end
       end
 
-      def filter_by(name, scopes)
-        config.add_filter_group(name, scopes)
+      def filter_by(name, scopes, options = {})
+        config.add_filter_group(name, scopes, options)
       end
 
       def sorting(*args)

data/lib/admino/query/filter_group.rb

@@ -15,7 +15,7 @@ module Admino
       end
 
       def augment_scope(scope)
-        if active_scope
+        if active_scope && active_scope != :empty
           scope.send(active_scope)
         else
           scope
@@ -35,7 +35,8 @@ module Admino
       end
 
       def value
-        params.fetch(:query, {}).fetch(param_name, nil)
+        default_value = config.include_empty_scope? ? :empty : nil
+        params.fetch(:query, {}).fetch(param_name, default_value)
       end
 
       def param_name
@@ -43,7 +44,11 @@ module Admino
       end
 
       def scopes
-        config.scopes
+        @scopes ||= config.scopes.dup.tap do |scopes|
+          if config.include_empty_scope?
+            scopes.unshift :empty
+          end
+        end
       end
 
       def i18n_key

data/lib/admino/version.rb

@@ -1,4 +1,4 @@
 module Admino
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 end
 

data/spec/admino/query/dsl_spec.rb

@@ -16,6 +16,7 @@ module Admino
         filter_group = config.filter_groups.first
         expect(filter_group.name).to eq :bar
         expect(filter_group.scopes).to eq [:one, :two]
+        expect(filter_group.include_empty_scope?).to be_true
       end
 
       it 'allows #sortings declaration' do

data/spec/admino/query/filter_group_spec.rb

@@ -14,6 +14,14 @@ module Admino
           it 'returns nil' do
             expect(filter_group.active_scope).to be_nil
           end
+
+          context 'if include_empty_scope is true' do
+            let(:config) { Configuration::FilterGroup.new(:foo, [:bar], include_empty_scope: true) }
+
+            it 'returns the :empty scope' do
+              expect(filter_group.active_scope).to eq :empty
+            end
+          end
         end
 
         context 'with an invalid value' do
@@ -22,6 +30,14 @@ module Admino
           it 'returns nil' do
             expect(filter_group.active_scope).to be_nil
           end
+
+          context 'if include_empty_scope is true' do
+            let(:config) { Configuration::FilterGroup.new(:foo, [:bar], include_empty_scope: true) }
+
+            it 'returns nil' do
+              expect(filter_group.active_scope).to be_nil
+            end
+          end
         end
 
         context 'with a valid value' do
@@ -49,6 +65,14 @@ module Admino
           it 'returns the original scope' do
             expect(result).to eq scope
           end
+
+          context 'if include_empty_scope is true' do
+            let(:config) { Configuration::FilterGroup.new(:foo, [:bar], include_empty_scope: true) }
+
+            it 'returns the original scope' do
+              expect(result).to eq scope
+            end
+          end
         end
       end
 
@@ -59,6 +83,19 @@ module Admino
           expect(filter_group.is_scope_active?('bar')).to be_true
         end
       end
+
+      describe '#scopes' do
+        subject { filter_group.scopes }
+
+        context 'if include_empty_scope is true' do
+          let(:config) { Configuration::FilterGroup.new(:foo, [:bar], include_empty_scope: true) }
+          it { should eq [:empty, :bar] }
+        end
+
+        context 'else' do
+          it { should eq [:bar] }
+        end
+      end
     end
   end
 end

data/spec/spec_helper.rb

@@ -35,7 +35,7 @@ class TestQuery < Admino::Query::Base
   search_field :foo
   search_field :starting_from, coerce: :to_date
 
-  filter_by :bar, [:one, :two]
+  filter_by :bar, [:one, :two], include_empty_scope: true
 
   sorting :by_title, :by_date,
           default_scope: :by_title,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: admino
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Stefano Verna
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-27 00:00:00.000000000 Z
+date: 2014-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: showcase
@@ -249,4 +249,3 @@ test_files:
 - spec/admino/table/resource_row_spec.rb
 - spec/admino/table/row_spec.rb
 - spec/spec_helper.rb
-has_rdoc: