admino 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 032bc2648fb523ba0875508da85247a62ed9951a
-  data.tar.gz: df81ccdbf54f9add70815106f98c7416b87e4e30
+  metadata.gz: e26dee36252bba0db083897fc29ced0358ab2046
+  data.tar.gz: 0efed84c06512abd26698ea33479d7ed1a7b4746
 SHA512:
-  metadata.gz: c0e0faf1887177e8e1d98e872956707499ce89f203df38c8e66cc4a8dc562c03bd5d686ef2cd3c2fb462a75d5372565d52a23bc7363c17ef48024996d4c163d6
-  data.tar.gz: b8881de3c6cecc14a8e91d80d887f7fd9a7bbf208c855875f36b51372857643079dc2fec608d5f0c1f4f861a7a371dd94cfc51c99aae02df2003df35fe4d53fd
+  metadata.gz: f036deab369232c67daf274146a06d1173a82ec26f77d444faf2e4bf66d550adce7224a6f0fe92d486b4eba44b5b9880a8fd216dd39309d3182178d083c69d19
+  data.tar.gz: 1342bbb40cea481a7e4459f74381746a64f6d12c54809a87aad7315fd247d602c5f60ce74bb2ab1fef9aca5ec1e68c51733f62a26aeeea659255fb769478a317

data/CHANGELOG.md

@@ -1,4 +1,12 @@
-# v0.0.2
+# v0.0.4
+
+* Rename Group into FilterGroup
+* Rename FilterGroup#available_scopes into #scopes
+* Rename Sorting#available_scopes into #scopes
+* Removed nil scope in FilterGroup
+* Clicking on an active filter scope link will deactivate it
+
+# v0.0.3
 
 * Fixed bug in SortingPresenter with default scope
 

data/CONTRIBUTING.md

@@ -0,0 +1,40 @@
+# Contributing
+
+We love pull requests. Here's a quick guide:
+
+1. Fork the repo.
+2. Run the tests. We only take pull requests with passing tests, and it's great
+   to know that you have a clean slate: `bundle && rake`
+3. Add a test for your change. Only refactoring and documentation changes
+   require no new tests. If you are adding functionality or fixing a bug, we need
+   a test!
+4. Make the test pass.
+5. Make sure your changes adhere to the [thoughtbot Style
+   Guide](https://github.com/thoughtbot/guides/tree/master/style)
+6. Push to your fork and submit a pull request.
+7. At this point you're waiting on us. We like to at least comment on, if not
+   accept, pull requests within three business days (and, typically, one business
+   day). [We may suggest some changes or improvements or
+   alternatives](https://github.com/thoughtbot/guides/tree/master/code-review).
+
+## Increase your chances of getting merged
+
+Some things that will increase the chance that your pull request is accepted,
+taken straight from the Ruby on Rails guide:
+
+* Use Rails idioms and helpers
+* Include tests that fail without your code, and pass with it
+* Update the documentation: that surrounding your change, examples elsewhere,
+  guides, and whatever else is affected by your contribution
+* Syntax:
+    * Two spaces, no tabs.
+    * No trailing whitespace. Blank lines should not have any space.
+    * Make sure your [source files end with newline
+      characters](http://stackoverflow.com/questions/729692/why-should-files-end-with-a-newline#answer-729725).
+    * Prefer `&&`/`||`  over `and`/`or`.
+    * `MyClass.my_method(my_arg)` not `my_method( my_arg )` or
+      `my_method my_arg`.
+    * `a = b` and not `a=b`.
+    * Follow the conventions you see used in the source already.
+* And in case we didn't emphasize it enough: *We love tests!*
+

data/README.md

@@ -1,9 +1,30 @@
 # Admino
 
+[![Gem Version](https://badge.fury.io/rb/admino.png)](http://badge.fury.io/rb/admino)
 [![Build Status](https://travis-ci.org/cantierecreativo/admino.png?branch=v0.0.1)](https://travis-ci.org/cantierecreativo/admino)
 [![Coverage Status](https://coveralls.io/repos/cantierecreativo/admino/badge.png?branch=master)](https://coveralls.io/r/cantierecreativo/admino?branch=master)
+[![Code Climate](https://codeclimate.com/github/cantierecreativo/admino.png)](https://codeclimate.com/github/cantierecreativo/admino)
 
-TODO: Write a gem description
+A minimal, object-oriented solution to generate Rails administrative index views. Through query objects and presenters, it features a customizable table generator and search forms with filtering/sorting.
+
+## The philosophy behind it
+
+The Rails ecosystem has many [full-fledged solutions to generate administrative interfaces](https://www.ruby-toolbox.com/categories/rails_admin_interfaces).
+
+Although these tools are very handy to bootstrap a project quickly, they all obey the [80%-20% rule](http://en.wikipedia.org/wiki/Pareto_principle) and tend to be very invasive, often mixing up different concerns on a single responsibility level, thus making tests unbelievably difficult to setup and write.
+
+A time comes when these all-encompassing tools get in the way. And that will be the moment where all the cumulated saved time will be wasted to solve a single, trivial problem with ugly workarounds and [epic facepalms](http://i.imgur.com/ghKDGyv.jpg).
+
+So yes, if you're starting a small, short-lived project, go ahead with them, it will be fine! If you're building something that's more valuable or is meant to last longer, there are better alternatives.
+
+### A modular approach to the problem
+
+The great thing is that you don't need to write a lot of code to get a more maintainable and modular administrative area. 
+Gems like [Inherited Resources](https://github.com/josevalim/inherited_resources) and [Simple Form](https://github.com/plataformatec/simple_form), combined with [Rails 3.1+ template-inheritance](http://railscasts.com/episodes/269-template-inheritance) already give you ~90% of the time-saving features and the same super-DRY, declarative code that administrative interfaces offer, but with a far more relaxed contract.
+
+If a particular controller or view needs something different from the standard CRUD/REST treatment, you can just avoid using those gems in that specific context, and fall back to standard Rails code. No workarounds, no facepalms. It seems easy, right? It is.
+
+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.
 
 ## Installation
 
@@ -15,19 +36,185 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+## Admino::Query::Base
+
+A subclass of `Admino::Query::Base` represents a [Query object](http://martinfowler.com/eaaCatalog/queryObject.html), that is, an object responsible for returning a result set (ie. an `ActiveRecord::Relation`) based on business rules (ie. action params).
+
+Given a `Task` model with the following scopes:
+
+```ruby
+class Task < ActiveRecord::Base
+  scope :text_matches, ->(text) { where(...) }
+
+  scope :completed, -> { where(completed: true) }
+  scope :pending, -> { where(completed: false) }
+
+  scope :by_due_date, ->(direction) { order(due_date: direction) }
+  scope :by_title, ->(direction) { order(title: direction) }
+end
+```
+
+The following `TasksQuery` class can be created:
+
+```ruby
+class TasksQuery < Admino::Query::Base
+  starting_scope { ProjectTask.all }
+
+  field :text_matches
+  filter_by :status, [:completed, :pending]
+  sorting :by_due_date, :by_title
+end
+```
+
+Every query object can declare:
+
+* a **starting scope**, that is, the scope that will start the filtering/ordering chain;
+* a set of **search fields**, which represent model scopes that require an input to filter the result set;
+* a set of **filtering groups**, each of which is composed by a set of scopes that take no argument;
+* a set of **sorting scopes** that take a sigle argument (`:asc` or `:desc`) and thus are able to order the result set in both directions;
+
+Each query object instance gets initialized with a hash of params. The `#scope` method will then perform the chaining of the scopes based on the given params, returning the final result set:
+
+```ruby
+params = {
+  query: {
+    text_matches: 'ASAP'
+  },
+  status: 'pending',
+  sorting: 'by_title',
+  sort_order: 'desc'
+}
+
+tasks = TasksQuery.new(params).scope
+```
+
+As you may have guessed, query objects can be great companions to index controller actions:
+
+```ruby
+class ProjectTasksController < ApplicationController
+  def index
+    @query = TasksQuery.new(params)
+    @project_tasks = @query.scope
+  end
+end
+```
+
+But that's not all.
+
+### Presenting search form and filters to the user
+
+Admino also offers a [Showcase presenter](https://github.com/stefanoverna/showcase) that makes it really easy to generate search forms and filtering links:
+
+```erb
+<%# instanciate the the query object presenter %>
+<% query = present(@query) %>
+
+<%# generate the search form %>
+<%= query.form do |q| %>
+  <p>
+    <%= q.label :text_matches %>
+    <%= q.text_field :text_matches %>
+  </p>
+  <p>
+    <%= q.submit %>
+  </p>
+<% end %>
+
+<%# generate the filtering links %>
+<% query.filter_groups.each do |filter_group| %>
+  <h6><%= filter_group.name %></h6>
+  <ul>
+    <% filter_group.scopes.each do |scope| %>
+      <li>
+        <%= filter_group.scope_link(scope) %>
+      <li>
+    <% end %>
+  </ul>
+<% end %>
+```
+
+The great thing is that the search form gets automatically filled in with the last input the user submitted, and a CSS class `is-active` gets added to the currently active filter scopes.
+
+If a particular filter has been clicked and is now active, it is possible to deactivate it by clicking it again.
+
+### Simple Form support
+
+The presenter also offers a `#simple_form` method to make it work with [Simple Form](https://github.com/plataformatec/simple_form) out of the box.
+
+### I18n
+
+To localize the search form labels, as well as the group filter names and scope links, please refer to the following YAML file:
+
+```yaml
+en:
+  query:
+    attributes:
+      tasks_query:
+        text_matches: 'Contains text'
+    filter_groups:
+      tasks_query:
+        status:
+          name: 'Filter by status'
+          scopes:
+            completed: 'Completed'
+            pending: 'Pending'
+```
+
+### Output customisation
+
+The query object and its presenter implement a number of additional methods and optional arguments that allow a great amount of flexibility: please refer to the tests to see all the possibile customisations available.
+
+#### Overwriting the starting scope
+
+Suppose you have to filter the tasks based on the `@current_user` work group. You can easily provide an alternative starting scope from the controller passing it as an argument to the `#scope` method:
+
+```ruby
+def index
+  @query = TasksQuery.new(params)
+  @project_tasks = @query.scope(@current_user.team.tasks)
+end
+```
+
+### Default sortings
+
+#### Coertions
+
+Admino can perform automatic coertions from a param string input to the type needed by the model named scope:
+
+```ruby
+class TasksQuery < Admino::Query::Base
+  # ...
+  field :due_date_from, coerce: :to_date
+  field :due_date_to, coerce: :to_date
+end
+```
+The following coertions are available:
+
+* `:to_boolean`
+* `:to_constant`
+* `:to_date`
+* `:to_datetime`
+* `:to_decimal`
+* `:to_float`
+* `:to_integer`
+* `:to_symbol`
+* `:to_time`
+
+If a specific coercion cannot be performed with the provided input, the scope won't be chained.
+
+Please see the [`Coercible::Coercer::String`](https://github.com/solnic/coercible/blob/master/lib/coercible/coercer/string.rb) class for details.
 
-    $ gem install admino
+### Ending the scope chain
 
-## Usage
+It's very common ie. to paginate the result set. `Admino::Query::Base` DSL makes it easy to append any scope to the end of the chain:
 
-TODO: Write usage instructions here
+```ruby
+class TasksQuery < Admino::Query::Base
+  ending_scope { |q| page(q.params[:page]) }
+end
+```
 
-## Contributing
+## Admino::Table::Presenter
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+WIP
 

data/TODO.md

@@ -0,0 +1,4 @@
+* Allow validations of input in Query::Base objects
+* Support Rails date_select and datetime_select params
+* Prepare a demo
+

data/lib/admino/query.rb

@@ -2,8 +2,8 @@ require 'admino/query/base'
 require 'admino/query/base_presenter'
 require 'admino/query/configuration'
 require 'admino/query/field'
-require 'admino/query/group'
-require 'admino/query/group_presenter'
+require 'admino/query/filter_group'
+require 'admino/query/filter_group_presenter'
 require 'admino/query/sorting'
 require 'admino/query/sorting_presenter'
 

data/lib/admino/query/base.rb

@@ -13,7 +13,7 @@ module Admino
       extend Dsl
 
       attr_reader :params
-      attr_reader :groups
+      attr_reader :filter_groups
       attr_reader :fields
       attr_reader :sorting
 
@@ -25,7 +25,7 @@ module Admino
         @params = ActiveSupport::HashWithIndifferentAccess.new(params)
         @config = config
 
-        init_groups
+        init_filter_groups
         init_fields
         init_sorting
       end
@@ -39,7 +39,7 @@ module Admino
 
         scope_builder = starting_scope
 
-        scope_augmenters = fields + groups
+        scope_augmenters = fields + filter_groups
         scope_augmenters << sorting if sorting
 
         scope_augmenters.each do |field|
@@ -61,12 +61,12 @@ module Admino
         @config || self.class.config
       end
 
-      def groups
-        @groups.values
+      def filter_groups
+        @filter_groups.values
       end
 
-      def group_by_name(name)
-        @groups[name]
+      def filter_group_by_name(name)
+        @filter_groups[name]
       end
 
       def fields
@@ -79,11 +79,11 @@ module Admino
 
       private
 
-      def init_groups
-        @groups = {}
+      def init_filter_groups
+        @filter_groups = {}
         i18n_key = self.class.model_name.i18n_key
-        config.groups.each do |config|
-          @groups[config.name] = Group.new(config, params, i18n_key)
+        config.filter_groups.each do |config|
+          @filter_groups[config.name] = FilterGroup.new(config, params, i18n_key)
         end
       end
 

data/lib/admino/query/base_presenter.rb

@@ -3,7 +3,7 @@ require 'showcase'
 module Admino
   module Query
     class BasePresenter < Showcase::Presenter
-      presents_collection :groups
+      presents_collection :filter_groups
       presents :sorting
 
       def form(options = {}, &block)

data/lib/admino/query/configuration.rb

@@ -17,7 +17,7 @@ module Admino
         end
       end
 
-      class Group
+      class FilterGroup
         attr_reader :name
         attr_reader :scopes
 
@@ -48,14 +48,14 @@ module Admino
       end
 
       attr_reader :fields
-      attr_reader :groups
+      attr_reader :filter_groups
       attr_reader :sorting
       attr_accessor :starting_scope_callable
       attr_accessor :ending_scope_callable
 
       def initialize
         @fields = []
-        @groups = []
+        @filter_groups = []
       end
 
       def add_field(name, options = {})
@@ -64,9 +64,9 @@ module Admino
         end
       end
 
-      def add_group(name, scopes)
-        Group.new(name, scopes).tap do |group|
-          self.groups << group
+      def add_filter_group(name, scopes)
+        FilterGroup.new(name, scopes).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 group(name, scopes)
-        config.add_group(name, scopes)
+      def filter_by(name, scopes)
+        config.add_filter_group(name, scopes)
       end
 
       def sorting(*args)

data/lib/admino/query/{group.rb → filter_group.rb}

@@ -3,7 +3,7 @@ require 'active_support/core_ext/hash'
 
 module Admino
   module Query
-    class Group
+    class FilterGroup
       attr_reader :params
       attr_reader :config
       attr_reader :query_i18n_key
@@ -23,7 +23,7 @@ module Admino
       end
 
       def active_scope
-        if param_value && available_scopes.include?(param_value.to_sym)
+        if param_value && scopes.include?(param_value.to_sym)
           param_value.to_sym
         else
           nil
@@ -42,8 +42,8 @@ module Admino
         config.name
       end
 
-      def available_scopes
-        [nil] + config.scopes
+      def scopes
+        config.scopes
       end
 
       def i18n_key

data/lib/admino/query/{group_presenter.rb → filter_group_presenter.rb}

@@ -7,7 +7,7 @@ require 'active_support/core_ext/hash'
 
 module Admino
   module Query
-    class GroupPresenter < Showcase::Presenter
+    class FilterGroupPresenter < Showcase::Presenter
       def scope_link(scope, *args)
         options = args.extract_options!
 
@@ -30,20 +30,19 @@ module Admino
       def scope_params(scope)
         params = ActiveSupport::HashWithIndifferentAccess.new(h.request.query_parameters)
 
-        if scope
-          params.merge!(param_name => scope.to_s)
-        else
+        if is_scope_active?(scope)
           params.delete(param_name)
+        else
+          params.merge!(param_name => scope.to_s)
         end
 
         params
       end
 
       def scope_name(scope)
-        scope ||= 'none'
         I18n.t(
           :"#{query_i18n_key}.#{i18n_key}.scopes.#{scope}",
-          scope: 'query.groups',
+          scope: 'query.filter_groups',
           default: [
             :"#{i18n_key}.scopes.#{scope}",
             scope.to_s.titleize
@@ -54,7 +53,7 @@ module Admino
       def name
         I18n.t(
           :"#{query_i18n_key}.#{i18n_key}.name",
-          scope: 'query.groups',
+          scope: 'query.filter_groups',
           default: [
             :"#{i18n_key}.name",
             i18n_key.to_s.titleize

data/lib/admino/query/sorting.rb

@@ -36,7 +36,7 @@ module Admino
       end
 
       def active_scope
-        if param_value && available_scopes.include?(param_value.to_sym)
+        if param_value && scopes.include?(param_value.to_sym)
           param_value.to_sym
         elsif default_scope
           default_scope
@@ -65,13 +65,9 @@ module Admino
         :sorting
       end
 
-      def available_scopes
+      def scopes
         config.scopes
       end
-
-      def scope_name
-        config.name
-      end
     end
   end
 end

data/lib/admino/table/head_row.rb

@@ -43,13 +43,13 @@ module Admino
         html_options = html_options.to_h
 
         sorting_scope = html_options.delete(:sorting)
+        sorting_html_options = html_options.delete(:sorting_html_options) { {} }
         if sorting_scope
           raise ArgumentError, 'query object is required' unless query
-          sorting_html_options = html_options.delete(:sorting_html_options) { {} }
           label = query.sorting.scope_link(sorting_scope, label, sorting_html_options)
         end
 
-        @columns << h.content_tag(:th, label.to_s, html_options.to_h)
+        @columns << h.content_tag(:th, label.to_s, html_options)
       end
 
       def to_html

data/lib/admino/version.rb

@@ -1,4 +1,4 @@
 module Admino
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end
 

data/spec/admino/query/base_spec.rb

@@ -34,19 +34,19 @@ module Admino
         end
       end
 
-      context 'with a declared group' do
+      context 'with a declared filter_group' do
         let(:config) { Configuration.new }
-        let(:group_config) { config.add_group(:group, [:one, :two]) }
+        let(:filter_group_config) { config.add_filter_group(:filter_group, [:one, :two]) }
 
         before do
-          group_config
+          filter_group_config
         end
 
-        it 'returns a configured Group' do
-          group = query.group_by_name(:group)
-          expect(group.config).to eq group_config
-          expect(group.params).to eq params
-          expect(group.i18n_key).to eq :group
+        it 'returns a configured FilterGroup' do
+          filter_group = query.filter_group_by_name(:filter_group)
+          expect(filter_group.config).to eq filter_group_config
+          expect(filter_group.params).to eq params
+          expect(filter_group.i18n_key).to eq :filter_group
         end
       end
 
@@ -107,15 +107,15 @@ module Admino
           end
         end
 
-        context 'with a set of fields and groups' do
+        context 'with a set of fields and filter_groups' do
           let(:field_config) { config.add_field(:field) }
-          let(:group_config) { config.add_group(:group, [:one, :two]) }
+          let(:filter_group_config) { config.add_filter_group(:filter_group, [:one, :two]) }
           let(:scope_chained_with_field) { double('scope 1') }
           let(:final_chain) { double('scope 2') }
 
           before do
             field_config
-            group_config
+            filter_group_config
             query
 
             query.field_by_name(:field).
@@ -123,7 +123,7 @@ module Admino
               with(starting_scope).
               and_return(scope_chained_with_field)
 
-            query.group_by_name(:group).
+            query.filter_group_by_name(:filter_group).
               stub(:augment_scope).
               with(scope_chained_with_field).
               and_return(final_chain)

data/spec/admino/query/dsl_spec.rb

@@ -12,10 +12,10 @@ module Admino
         expect(field.coerce_to).to eq :to_date
       end
 
-      it 'allows #group declaration' do
-        group = config.groups.first
-        expect(group.name).to eq :bar
-        expect(group.scopes).to eq [:one, :two]
+      it 'allows #filter_by declaration' do
+        filter_group = config.filter_groups.first
+        expect(filter_group.name).to eq :bar
+        expect(filter_group.scopes).to eq [:one, :two]
       end
 
       it 'allows #sortings declaration' do

data/spec/admino/query/{group_presenter_spec.rb → filter_group_presenter_spec.rb}

@@ -2,21 +2,21 @@ require 'spec_helper'
 
 module Admino
   module Query
-    describe GroupPresenter do
-      subject(:presenter) { GroupPresenter.new(group, view) }
+    describe FilterGroupPresenter do
+      subject(:presenter) { FilterGroupPresenter.new(filter_group, view) }
       let(:view) { RailsViewContext.new }
-      let(:group) do
+      let(:filter_group) do
         double(
-          'Group',
+          'FilterGroup',
           query_i18n_key: :query_name,
-          i18n_key: :group,
-          param_name: :group
+          i18n_key: :filter_group,
+          param_name: :filter_group
         )
       end
       let(:request_object) do
         double(
           'ActionDispatch::Request',
-          query_parameters: { 'group' => 'bar' },
+          query_parameters: { 'filter_group' => 'bar' },
           path: '/'
         )
       end
@@ -27,15 +27,15 @@ module Admino
 
       describe '#scope_link' do
         subject { presenter.scope_link(:foo) }
+        let(:scope_active) { false }
 
         before do
-          group.stub(:is_scope_active?).with(:foo).and_return(false)
+          filter_group.stub(:is_scope_active?).
+            with(:foo).and_return(scope_active)
         end
 
         context 'active CSS class' do
-          before do
-            group.stub(:is_scope_active?).with(:foo).and_return(true)
-          end
+          let(:scope_active) { true }
 
           it 'adds an is-active class' do
             should have_tag(:a, with: { class: 'is-active' })
@@ -86,15 +86,23 @@ module Admino
       end
 
       describe '#scope_params' do
-        context 'if scope is nil' do
-          it 'deletes the group param' do
-            expect(presenter.scope_params(nil)).not_to have_key 'group'
+        before do
+          filter_group.stub(:is_scope_active?).with(:foo).and_return(scope_active)
+        end
+
+        context 'if scope is active' do
+          let(:scope_active) { true }
+
+          it 'deletes the filter_group param' do
+            expect(presenter.scope_params(:foo)).not_to have_key 'filter_group'
           end
         end
 
         context 'else' do
-          it 'deletes the group param' do
-            expect(presenter.scope_params(:bar)[:group]).to eq 'bar'
+          let(:scope_active) { false }
+
+          it 'is set as filter group value' do
+            expect(presenter.scope_params(:foo)[:filter_group]).to eq 'foo'
           end
         end
       end
@@ -104,18 +112,18 @@ module Admino
           before do
             I18n.backend.store_translations(
               :en,
-              query: { groups: { query_name: { group: { name: 'NAME' } } } }
+              query: { filter_groups: { query_name: { filter_group: { name: 'NAME' } } } }
             )
           end
 
-          it 'returns a I18n translatable name for the group' do
+          it 'returns a I18n translatable name for the filter_group' do
             expect(presenter.name).to eq 'NAME'
           end
         end
 
         context 'if no translation is available' do
-          it 'falls back to a titleized version of the group name' do
-            expect(presenter.name).to eq 'Group'
+          it 'falls back to a titleized version of the filter_group name' do
+            expect(presenter.name).to eq 'Filter Group'
           end
         end
       end
@@ -125,7 +133,7 @@ module Admino
           before do
             I18n.backend.store_translations(
               :en,
-              query: { groups: { query_name: { group: { scopes: { bar: 'NAME' } } } } }
+              query: { filter_groups: { query_name: { filter_group: { scopes: { bar: 'NAME' } } } } }
             )
           end
 

data/spec/admino/query/{group_spec.rb → filter_group_spec.rb}

@@ -2,9 +2,9 @@ require 'spec_helper'
 
 module Admino
   module Query
-    describe Group do
-      subject(:group) { Group.new(config, params) }
-      let(:config) { Configuration::Group.new(:foo, [:bar]) }
+    describe FilterGroup do
+      subject(:filter_group) { FilterGroup.new(config, params) }
+      let(:config) { Configuration::FilterGroup.new(:foo, [:bar]) }
       let(:params) { {} }
 
       describe '#active_scope' do
@@ -12,7 +12,7 @@ module Admino
           let(:params) { {} }
 
           it 'returns nil' do
-            expect(group.active_scope).to be_nil
+            expect(filter_group.active_scope).to be_nil
           end
         end
 
@@ -20,7 +20,7 @@ module Admino
           let(:params) { { 'foo' => 'qux' } }
 
           it 'returns nil' do
-            expect(group.active_scope).to be_nil
+            expect(filter_group.active_scope).to be_nil
           end
         end
 
@@ -28,19 +28,19 @@ module Admino
           let(:params) { { 'foo' => 'bar' } }
 
           it 'returns the scope name' do
-            expect(group.active_scope).to eq :bar
+            expect(filter_group.active_scope).to eq :bar
           end
         end
       end
 
       describe '#augment_scope' do
-        let(:result) { group.augment_scope(scope) }
+        let(:result) { filter_group.augment_scope(scope) }
         let(:scope) { ScopeMock.new('original') }
 
         context 'if the field has a value' do
           let(:params) { { 'foo' => 'bar' } }
 
-          it 'returns the original scope chained with the group scope' do
+          it 'returns the original scope chained with the filter_group scope' do
             expect(result.chain).to eq [:bar, []]
           end
         end
@@ -56,7 +56,7 @@ module Admino
         let(:params) { { 'foo' => 'bar' } }
 
         it 'returns true if the provided scope is the one currently active' do
-          expect(group.is_scope_active?(:bar)).to be_true
+          expect(filter_group.is_scope_active?(:bar)).to be_true
         end
       end
     end

data/spec/admino/query/sorting_spec.rb

@@ -123,6 +123,14 @@ module Admino
           end
         end
       end
+
+      describe '#is_scope_active?' do
+        let(:params) { { 'sorting' => 'by_date' } }
+
+        it 'returns true if the provided scope is the one currently active' do
+          expect(sorting.is_scope_active?(:by_date)).to be_true
+        end
+      end
     end
   end
 end

data/spec/spec_helper.rb

@@ -35,7 +35,7 @@ class TestQuery < Admino::Query::Base
   field :foo
   field :starting_from, coerce: :to_date
 
-  group :bar, [:one, :two]
+  filter_by :bar, [:one, :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.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Stefano Verna
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-17 00:00:00.000000000 Z
+date: 2014-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: showcase
@@ -174,10 +174,12 @@ files:
 - .gitignore
 - .travis.yml
 - CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- TODO.md
 - admino.gemspec
 - lib/admino.rb
 - lib/admino/query.rb
@@ -186,8 +188,8 @@ files:
 - lib/admino/query/configuration.rb
 - lib/admino/query/dsl.rb
 - lib/admino/query/field.rb
-- lib/admino/query/group.rb
-- lib/admino/query/group_presenter.rb
+- lib/admino/query/filter_group.rb
+- lib/admino/query/filter_group_presenter.rb
 - lib/admino/query/sorting.rb
 - lib/admino/query/sorting_presenter.rb
 - lib/admino/table.rb
@@ -200,8 +202,8 @@ files:
 - spec/admino/query/base_spec.rb
 - spec/admino/query/dsl_spec.rb
 - spec/admino/query/field_spec.rb
-- spec/admino/query/group_presenter_spec.rb
-- spec/admino/query/group_spec.rb
+- spec/admino/query/filter_group_presenter_spec.rb
+- spec/admino/query/filter_group_spec.rb
 - spec/admino/query/sorting_presenter_spec.rb
 - spec/admino/query/sorting_spec.rb
 - spec/admino/table/head_row_spec.rb
@@ -238,8 +240,8 @@ test_files:
 - spec/admino/query/base_spec.rb
 - spec/admino/query/dsl_spec.rb
 - spec/admino/query/field_spec.rb
-- spec/admino/query/group_presenter_spec.rb
-- spec/admino/query/group_spec.rb
+- spec/admino/query/filter_group_presenter_spec.rb
+- spec/admino/query/filter_group_spec.rb
 - spec/admino/query/sorting_presenter_spec.rb
 - spec/admino/query/sorting_spec.rb
 - spec/admino/table/head_row_spec.rb