admino 0.0.10 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fe0d128c8350787165c4d23c7e9615df3475b4a9
-  data.tar.gz: 7e5bf3ecf69f2f45152ac342d8effbbdff5bb41f
+  metadata.gz: b0d55f8a3f155b631729a250ce1ff8eafdf443aa
+  data.tar.gz: f02070346455841d8466fdb67cd3f40d65ffe96c
 SHA512:
-  metadata.gz: 2ed53f3c1ad99454097045f3662f92db7766cdaf24cba9f78165fb3a784ec58c9a733f2d4ec62cbeb5303f7c5672c94fc30f7a70fa36c7ced3d99e1748246ded
-  data.tar.gz: ae0e7e38ac6fa22b2e1ed394b2ccc2fd2ac198b204a5ec7362033716bf671408eb5d828e703a9bc26306fdda224f4b7901ab7cce2c135d8faad504a010325e54
+  metadata.gz: bf0d27b8b835de7f2e10fe16cadbc3301e9771f76a40ccee7ef4e4234259210a0d8589cdac9fa1783edc964cbe0d14aab6d30bb34a746b657bb3f9f3c7d84115
+  data.tar.gz: 85b3cab3ac2fd27d265ac11d547ae85383e273d66f59879d23e89e09c8fc66d068d99e36dea1d20601eafc44ad487666988d9f8eca6cbc12917bd867d4179d8f

data/README.md

@@ -26,6 +26,10 @@ If a particular controller or view needs something different from the standard C
 
 So what about Admino? Well, it complements the above-mentioned gems, giving you the the missing ~10%: a fast way to generate administrative index views.
 
+## Demo
+
+To better illustrate how to create a 100%-custom, super-DRY administrative interface using Admino and the  aforementioned gems, we prepared a [repo with a sample Rails project](https://github.com/cantierecreativo/admino-example) you can take a look. The app is browsable at [http://admino-example.herokuapp.com](http://admino-example.herokuapp.com), and features a Bootstrap 3 theme.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -86,6 +90,7 @@ class TasksQuery < Admino::Query::Base
   search_field :title_matches
 end
 ```
+
 The `#scope` method will check the presence of the `params[:query][:title_matches]` key. If it finds it, it will augment the query with a named scope called `:title_matches`, expected to be found within the `Task` model. The scope needs to accept an argument.
 
 ```ruby
@@ -102,6 +107,15 @@ TaskQuery.new.scope.count # => 2
 TaskQuery.new(query: { title_matches: 'ASAP' }).scope.count # => 1
 ```
 
+You can provide a default value with the `default` option:
+
+```ruby
+class TasksQuery < Admino::Query::Base
+  # ...
+  search_field :title_matches, default: 'TODO'
+end
+```
+
 #### `filter_by`
 
 ```ruby
@@ -129,6 +143,17 @@ TaskQuery.new(query: { status: 'pending' }).scope.count # => 1
 TaskQuery.new(query: { status: 'foobar' }).scope.count # => 3
 ```
 
+You can include a "reset" scope with the `include_empty_scope` option, and provide a default scope with the `default` option:
+
+```ruby
+class TasksQuery < Admino::Query::Base
+  # ...
+  filter_by :time, [:last_month, :last_week],
+            include_empty_scope: true,
+            default: :last_week
+end
+```
+
 #### `sorting`
 
 ```ruby
@@ -485,7 +510,7 @@ class CustomTablePresenter < Admino::Table::Presenter
     { class: 'table-class' }
   end
 
-  def tbody_tr_html_options(resource_index)
+  def tbody_tr_html_options(resource, index)
     { class: 'tr-class' }
   end
 

data/lib/admino/query/configuration.rb

@@ -3,16 +3,26 @@ module Admino
     class Configuration
       class SearchField
         attr_reader :name
-        attr_reader :coerce_to
+        attr_reader :options
 
         def initialize(name, options = {})
           options.symbolize_keys!
-          options.assert_valid_keys(:coerce)
+          options.assert_valid_keys(
+            :coerce,
+            :default
+          )
 
           @name = name.to_sym
+          @options = options
+        end
+
+        def default_value
+          options[:default]
+        end
 
-          if coerce_to = options[:coerce]
-            @coerce_to = coerce_to.to_sym
+        def coerce_to
+          if options[:coerce]
+            options[:coerce].to_sym
           end
         end
       end
@@ -24,7 +34,10 @@ module Admino
 
         def initialize(name, scopes, options = {})
           options.symbolize_keys!
-          options.assert_valid_keys(:include_empty_scope)
+          options.assert_valid_keys(
+            :include_empty_scope,
+            :default
+          )
 
           @name = name.to_sym
           @scopes = scopes.map(&:to_sym)
@@ -34,6 +47,12 @@ module Admino
         def include_empty_scope?
           @options.fetch(:include_empty_scope) { false }
         end
+
+        def default_scope
+          if options[:default]
+            options[:default].to_sym
+          end
+        end
       end
 
       class Sorting

data/lib/admino/query/filter_group.rb

@@ -23,8 +23,8 @@ module Admino
       end
 
       def active_scope
-        if value && scopes.include?(value.to_sym)
-          value.to_sym
+        if value && scopes.include?(value)
+          value
         else
           nil
         end
@@ -35,8 +35,22 @@ module Admino
       end
 
       def value
-        default_value = config.include_empty_scope? ? :empty : nil
-        params.fetch(:query, {}).fetch(param_name, default_value)
+        value = params.fetch(:query, {}).fetch(param_name, default_value)
+        if value
+          value.to_sym
+        else
+          nil
+        end
+      end
+
+      def default_value
+        if config.default_scope
+          config.default_scope
+        elsif config.include_empty_scope?
+          :empty
+        else
+          nil
+        end
       end
 
       def param_name

data/lib/admino/query/search_field.rb

@@ -23,16 +23,17 @@ module Admino
 
       def value
         value = params.fetch(:query, {}).fetch(param_name, nil)
+
         if config.coerce_to
-          begin
-            coercer = Coercible::Coercer.new
-            coercer[value.class].send(config.coerce_to, value)
-          rescue Coercible::UnsupportedCoercion
-            nil
-          end
-        else
-          value
+          value = begin
+                    coercer = Coercible::Coercer.new
+                    coercer[value.class].send(config.coerce_to, value)
+                  rescue Coercible::UnsupportedCoercion
+                    nil
+                  end
         end
+
+        value || config.default_value
       end
 
       def present?

data/lib/admino/version.rb

@@ -1,4 +1,4 @@
 module Admino
-  VERSION = "0.0.10"
+  VERSION = "0.0.11"
 end
 

data/spec/admino/query/base_spec.rb

@@ -107,15 +107,19 @@ module Admino
           end
         end
 
-        context 'with a set of search_fields and filter_groups' do
+        context 'with a set of search_fields, filter_groups and sortings' do
           let(:search_field_config) { config.add_search_field(:search_field) }
           let(:filter_group_config) { config.add_filter_group(:filter_group, [:one, :two]) }
+          let(:sorting_config) { config.add_sorting_scopes([:title, :year]) }
+
           let(:scope_chained_with_search_field) { double('scope 1') }
-          let(:final_chain) { double('scope 2') }
+          let(:scope_chained_with_group_filter) { double('scope 2') }
+          let(:final_chain) { double('scope 3') }
 
           before do
             search_field_config
             filter_group_config
+            sorting_config
             query
 
             query.search_field_by_name(:search_field).
@@ -126,6 +130,10 @@ module Admino
             query.filter_group_by_name(:filter_group).
               stub(:augment_scope).
               with(scope_chained_with_search_field).
+              and_return(scope_chained_with_group_filter)
+
+            query.sorting.stub(:augment_scope).
+              with(scope_chained_with_group_filter).
               and_return(final_chain)
           end
 

data/spec/admino/query/filter_group_spec.rb

@@ -4,7 +4,10 @@ module Admino
   module Query
     describe FilterGroup do
       subject(:filter_group) { FilterGroup.new(config, params) }
-      let(:config) { Configuration::FilterGroup.new(:foo, [:bar]) }
+      let(:config) do
+        Configuration::FilterGroup.new(:foo, [:bar, :other], options)
+      end
+      let(:options) { {} }
       let(:params) { {} }
 
       describe '#active_scope' do
@@ -16,7 +19,34 @@ module Admino
           end
 
           context 'if include_empty_scope is true' do
-            let(:config) { Configuration::FilterGroup.new(:foo, [:bar], include_empty_scope: true) }
+            let(:options) { { include_empty_scope: true } }
+
+            it 'returns the :empty scope' do
+              expect(filter_group.active_scope).to eq :empty
+            end
+
+            context 'if default scope is set' do
+              let(:config) do
+                Configuration::FilterGroup.new(
+                  :foo,
+                  [:bar],
+                  include_empty_scope: true,
+                  default: :bar
+                )
+              end
+
+              it 'returns it' do
+                expect(filter_group.active_scope).to eq :bar
+              end
+            end
+          end
+        end
+
+        context 'with "empty" param' do
+          let(:params) { { 'query' => { 'foo' => 'empty' } } }
+
+          context 'if include_empty_scope is true' do
+            let(:options) { { include_empty_scope: true, default: :bar } }
 
             it 'returns the :empty scope' do
               expect(filter_group.active_scope).to eq :empty
@@ -32,7 +62,7 @@ module Admino
           end
 
           context 'if include_empty_scope is true' do
-            let(:config) { Configuration::FilterGroup.new(:foo, [:bar], include_empty_scope: true) }
+            let(:options) { { include_empty_scope: true, default: :bar } }
 
             it 'returns nil' do
               expect(filter_group.active_scope).to be_nil
@@ -67,7 +97,7 @@ module Admino
           end
 
           context 'if include_empty_scope is true' do
-            let(:config) { Configuration::FilterGroup.new(:foo, [:bar], include_empty_scope: true) }
+            let(:options) { { include_empty_scope: true } }
 
             it 'returns the original scope' do
               expect(result).to eq scope
@@ -88,12 +118,13 @@ module Admino
         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] }
+          let(:options) { { include_empty_scope: true } }
+
+          it { should eq [:empty, :bar, :other] }
         end
 
         context 'else' do
-          it { should eq [:bar] }
+          it { should eq [:bar, :other] }
         end
       end
     end

data/spec/admino/query/search_field_spec.rb

@@ -20,6 +20,16 @@ module Admino
           it 'returns nil' do
             expect(search_field.value).to be_nil
           end
+
+          context 'with a default value' do
+            let(:config) {
+              Configuration::SearchField.new(:foo, default: 'foo')
+            }
+
+            it 'returns it' do
+              expect(search_field.value).to eq 'foo'
+            end
+          end
         end
 
         context 'with coertion' do

data/spec/spec_helper.rb

@@ -32,10 +32,12 @@ class ScopeMock
 end
 
 class TestQuery < Admino::Query::Base
-  search_field :foo
+  search_field :foo, default: 'bar'
   search_field :starting_from, coerce: :to_date
 
-  filter_by :bar, [:one, :two], include_empty_scope: true
+  filter_by :bar, [:one, :two],
+            include_empty_scope: true,
+            default: :two
 
   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.10
+  version: 0.0.11
 platform: ruby
 authors:
 - Stefano Verna
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-31 00:00:00.000000000 Z
+date: 2014-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: showcase
@@ -249,3 +249,4 @@ test_files:
 - spec/admino/table/resource_row_spec.rb
 - spec/admino/table/row_spec.rb
 - spec/spec_helper.rb
+has_rdoc: