admino 0.0.16 → 0.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 58ca3e32d9e7c3a7f09785d413a90d85335f5d2e
-  data.tar.gz: cbf4064ab9463949fb64f47d4a1825f8107852e7
+  metadata.gz: 119481a7da909a0c22fd1e660cf932069efda0b9
+  data.tar.gz: 248ae36712a2f036640ddfe7b1bffccf2ed65fa7
 SHA512:
-  metadata.gz: 662ab77aa388252b75e0463c8ec4ad112c45fd2ee9393bdd26d15b163a3630150813f6917b5f3fb09bd83432b7ed9828e1f67b66f47419def995372a84c5622b
-  data.tar.gz: 8469b32536e19f81058a5c8111d094515ecff383094a8494d6e1651e55afaa81265e90951242ff9d6501c8f74bbf643277f62005b331a6f7466a453de4ca7eac
+  metadata.gz: a7a69fb319804d48bf90a98fc9da3d7e258a8cd82af23a01b64b79fa9616307f0c97ed30dcca76636ea823b689c9665c4843ccf638f2bf88cdeabb7ca66a57c1
+  data.tar.gz: 1099cf74ec2b87cb2255377d6767e1fa83b8ca6432c846f3571ce262ae046c512522d3e10e5b4b7a16d0c9c30414619c99499d68aef139c61a685a7b35a7f88e

data/README.md

@@ -200,6 +200,23 @@ class TasksQuery < Admino::Query::Base
 end
 ```
 
+### Let the query object do the chaining
+
+If you do not want to pollute your ActiveRecord model with all these scopes, you are free to implement the scopes on the query object itself:
+
+```ruby
+class Task < ActiveRecord::Base
+end
+
+class TasksQuery < Admino::Query::Base
+  search_field :title_matches
+
+  def title_matches(scope, text)
+    scope.where('title ILIKE ?', "%#{text}%")
+  end
+end
+```
+
 ### Inspecting the query state
 
 A query object supports various methods to inspect the available search fields, filters and sortings, and their state:

data/lib/admino/query/base.rb

@@ -6,6 +6,7 @@ require 'active_support/hash_with_indifferent_access'
 require 'active_support/core_ext/hash'
 
 require 'admino/query/dsl'
+require 'admino/query/builder'
 
 module Admino
   module Query
@@ -40,19 +41,20 @@ module Admino
                              raise ArgumentError, 'no starting scope provided'
                            end
 
-        scope_builder = starting_scope
-
+        query_builder = Builder.new(self, starting_scope)
         scope_augmenters = search_fields + filter_groups
         scope_augmenters << sorting if sorting
 
         scope_augmenters.each do |search_field|
-          scope_builder = search_field.augment_scope(scope_builder)
+          query_builder = search_field.augment_scope(query_builder)
         end
 
+        scope = query_builder.scope
+
         if config.ending_scope_callable
-          scope_builder.instance_exec(self, &config.ending_scope_callable)
+          scope.instance_exec(self, &config.ending_scope_callable)
         else
-          scope_builder
+          scope
         end
       end
 

data/lib/admino/query/builder.rb

@@ -0,0 +1,23 @@
+module Admino
+  module Query
+    class Builder
+      attr_accessor :scope
+      attr_reader :context
+
+      def initialize(context, scope)
+        @context = context
+        @scope = scope
+      end
+
+      private
+
+      def method_missing(method, *args)
+        if context.respond_to?(method)
+          Builder.new(context, context.send(method, scope, *args))
+        else
+          Builder.new(context, scope.send(method, *args))
+        end
+      end
+    end
+  end
+end

data/lib/admino/version.rb

@@ -1,3 +1,3 @@
 module Admino
-  VERSION = "0.0.16"
+  VERSION = "0.0.17"
 end

data/spec/admino/query/base_spec.rb

@@ -112,33 +112,66 @@ module Admino
           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(:scope_chained_with_group_filter) { double('scope 2') }
-          let(:final_chain) { double('scope 3') }
+          let(:params) do
+            {
+              query: {
+                search_field: "foo",
+                filter_group: "one",
+              },
+              sorting: "title",
+              sort_order: "desc"
+            }
+          end
 
           before do
             search_field_config
             filter_group_config
             sorting_config
             query
+          end
 
-            allow(query.search_field_by_name(:search_field)).
-              to receive(:augment_scope).
-              with(starting_scope).
-              and_return(scope_chained_with_search_field)
+          context 'if query object does not respond to scopes' do
+            it 'chains from starting scope' do
+              expect(result.chain).to eq [
+                :search_field, ["foo"],
+                :one, [],
+                :title, [:desc]
+              ]
+            end
+          end
 
-            allow(query.filter_group_by_name(:filter_group)).
-              to receive(:augment_scope).
-              with(scope_chained_with_search_field).
-              and_return(scope_chained_with_group_filter)
+          context 'else' do
+            let(:query_klass) do
+              Class.new(Base) do
+                def self.model_name
+                  ActiveModel::Name.new(self, nil, "temp")
+                end
+
+                def search_field(scope, foo)
+                  scope.my_search_field(foo)
+                end
+
+                def one(scope)
+                  scope.my_one
+                end
+
+                def title(scope, order)
+                  scope.my_title(order)
+                end
+              end
+            end
 
-            allow(query.sorting).to receive(:augment_scope).
-              with(scope_chained_with_group_filter).
-              and_return(final_chain)
-          end
+            subject(:query) do
+              query_klass.new(params, config)
+            end
 
-          it 'chains them toghether' do
-            expect(result).to eq final_chain
+            it 'chains from starting scope calling query object methods' do
+              expect(result.chain).to eq [
+                :my_search_field, ["foo"],
+                :my_one, [],
+                :my_title, [:desc]
+              ]
+            end
           end
         end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: admino
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.17
 platform: ruby
 authors:
 - Stefano Verna
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-01 00:00:00.000000000 Z
+date: 2016-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: showcase
@@ -205,6 +205,7 @@ files:
 - lib/admino/query.rb
 - lib/admino/query/base.rb
 - lib/admino/query/base_presenter.rb
+- lib/admino/query/builder.rb
 - lib/admino/query/configuration.rb
 - lib/admino/query/dsl.rb
 - lib/admino/query/filter_group.rb
@@ -254,7 +255,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Make administrative views creation less repetitive