expose_query 0.0.3 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3830e41dbd932f912f2174a3a7530fda54ca641c
-  data.tar.gz: d62a10521d46316a6ec22dab2dabf2cc8266df3b
+  metadata.gz: 2990d8edf4bcc0b2bb48032c1abfd2a0db7dbb82
+  data.tar.gz: a744527beb953afb61684edb4a8e4e714a24556a
 SHA512:
-  metadata.gz: 8b56696c3499018413edc05b43b22bc4ac3239c614a88620245753527a74162a45c4a3452630b13aa73e9c54aa4747769015e8cba3536027b162dafbd792cef6
-  data.tar.gz: 0eebdf0ce5b1f4ae5c1c3931f11d81a1e11305975391f9d44ae171604816931abdbb2b4a05617e87f4ef1dfe12f380543c9ccaf689c09a2bd6c49588b827016e
+  metadata.gz: 91aaeff699c20c1c02e4445287d8f43b1eb215a55b7ad39a8e365e8fe78c0d9f736d99574a07df9f264b2c86961317f85911b2d60312a8b383f24b1332c229b4
+  data.tar.gz: ae5ef76b24b63ee1440dd47f9977cdcdc6d9c808fb17a5e831cef0a65d37d0ef4a881afaff690e296eb94e4e82e11f9b64eb432071841c77a7d94ebae3a223af

data/.rspec

@@ -1,3 +1,4 @@
 --color
---warnings
 --require spec_helper
+--format documentation
+--backtrace

data/.travis.yml

@@ -3,6 +3,7 @@ rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.0
+  - 2.2.0
 addons:
   code_climate:
     repo_token:

data/Gemfile

@@ -4,7 +4,8 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'rails'
-
+gem 'pry'
+gem 'sqlite3'
 group :development do
   gem 'guard-rspec', require: false
 end

data/README.md

@@ -17,7 +17,7 @@ And then execute:
 
 ## Usage
 
-Add module to paticular controller:
+Include module to controller:
 
 ```
   class PhotosController  < ApplicationController
@@ -37,6 +37,22 @@ And define query class:
   end
 ```
 
+## Advanced parameters
+
+Allow define query objects for specific expose:
+
+```
+  class PhotosController  < ApplicationController
+    include ExposeQuery::ControllerDsl
+    expose(:photos)
+    expose(:recent_photos, model: :photo)
+
+    expose_query PhotoQuery, PaginationQuery, only: :photos
+    expose_query RecentPhotosQuery, only: :recent_photos
+
+  end
+```
+
 
 ## Contributing
 

data/expose_query.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'decent_exposure', '~> 2.0'
 
   spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rspec-rails'
   spec.add_development_dependency 'actionpack', '>= 3.1.0'
   spec.add_development_dependency 'activesupport', '>= 3.1.0'

data/lib/expose_query/active_record_query_strategy.rb

@@ -2,7 +2,7 @@ module ExposeQuery
   module ActiveRecordQueryStrategy
 
     def filtered_resource
-      plural? ? controller.apply_filters(original_resource) : original_resource
+      plural? ? controller.apply_filters(original_resource, name) : original_resource
     end
 
   end

data/lib/expose_query/controller_dsl.rb

@@ -5,17 +5,47 @@ module ExposeQuery
 
     included do
 
-      class_attribute :query_classes
+      class_attribute :query_objects
 
-      def self.expose_query(*filter_classes)
-        self.query_classes = Array.wrap(filter_classes.to_a)
+      def self.expose_query(*attrs)
+        self.query_objects ||= []
+        options = attrs.extract_options!
+        filter_classes = attrs.map do |class_filter|
+          OpenStruct.new(query_class: class_filter,
+                         only: Array.wrap(options[:only]).compact,
+                         except: Array.wrap(options[:except]).compact)
+        end
+        self.query_objects += Array.wrap(filter_classes)
       end
 
+      def self.query_classes
+        self.query_objects.map(&:query_class)
+      end
+
+    end
+
+    def apply_filters(source_scope, expose_name = nil)
+      query_objects ? apply_objects_for(source_scope, expose_name) : source_scope
     end
 
-    def apply_filters(source_scope)
-      query_classes ? query_classes.reduce(source_scope){|scope, filter| filter.new(self).apply(scope)} : source_scope
+    private
+
+    def apply_objects_for(source_scope, expose_name)
+      query_objects.reduce(source_scope) do |scope, filter_object|
+        if filter_object_allowed_for?(filter_object, expose_name.to_sym)
+          filter_object.query_class.new(self).apply(scope)
+        else
+          scope
+        end
+      end
     end
 
+    def filter_object_allowed_for?(object, expose_name)
+      if object.only.blank?
+        !object.except.include?(expose_name)
+      else
+        object.only.include?(expose_name)
+      end
+    end
   end
 end

data/lib/expose_query/version.rb

@@ -1,3 +1,3 @@
 module ExposeQuery
-  VERSION = "0.0.3"
+  VERSION = "0.1.3"
 end

data/spec/expose_query/controller_dsl_spec.rb

@@ -1,25 +1,11 @@
 require 'spec_helper'
-require 'decent_exposure/expose'
-require 'action_controller'
+require 'expose_query'
 
-class DummyQuery < ExposeQuery::BaseQuery
-
-  def apply(source_scope)
-    source_scope
-  end
-
-end
-
-class DummyController < ActionController::Base
-  expose(:bird) #{ 'Bird' }
-  expose_query DummyQuery
-
-end
 
 describe ExposeQuery::ControllerDsl do
 
   describe '.expose_query' do
-    subject { DummyController }
+    subject { Controllers::WithOnlyParameterController }
 
     it { should respond_to(:expose_query) }
 
@@ -28,21 +14,55 @@ describe ExposeQuery::ControllerDsl do
   end
 
   describe '.query_classes' do
-    subject { DummyController.query_classes }
+    subject { Controllers::WithOnlyParameterController.query_classes }
 
     it { is_expected.to include(DummyQuery) }
 
+    it { is_expected.to include(NewDummyQuery) }
+
   end
 
-  describe '' do
-    let(:controller) { DummyController.new }
-    let(:scope) {double(:scope)}
-    before { expect_any_instance_of(DummyQuery).to receive(:apply).and_call_original }
-    subject { controller.apply_filters(scope) }
+  describe 'applying queries' do
+    before do
+      allow(controller).to receive(:request) do
+        double('request', post?: false, put?: false, patch?: false)
+      end
+
+    end
+
+    context 'when expose_query pass only parameter' do
+      let(:controller) { Controllers::WithOnlyParameterController.new }
+
+      it 'apply filters only one expose' do
+        expect_any_instance_of(DummyQuery).to receive(:apply)
+        expect_any_instance_of(NewDummyQuery).not_to receive(:apply)
+        controller.birds
+      end
+
+      it 'apply filter for only expose' do
+        expect_any_instance_of(DummyQuery).to receive(:apply)
+        expect_any_instance_of(NewDummyQuery).to receive(:apply)
+        controller.another_birds
+      end
+
+    end
+
+    context 'when expose_query pass except parameter' do
+      let(:controller) { Controllers::WithExceptParameterController.new}
 
-    it { is_expected.to eq(scope) }
+      it 'apply query for birds' do
+        expect_any_instance_of(DummyQuery).to receive(:apply)
+        expect_any_instance_of(NewDummyQuery).to receive(:apply)
+        controller.birds
+      end
 
+      it 'apply with except for another_birds' do
+        expect_any_instance_of(DummyQuery).to receive(:apply)
+        expect_any_instance_of(NewDummyQuery).not_to receive(:apply)
+        controller.another_birds
+      end
 
+    end
 
   end
 

data/spec/fixtures/bird.rb

@@ -0,0 +1,3 @@
+class Bird < ActiveRecord::Base
+
+end

data/spec/fixtures/birds.yml

@@ -0,0 +1,6 @@
+cacadu:
+  id: 1
+  name: 'Cacadu'
+  beak: 'Qua'
+  created_at: 1999-02-19 08:00
+  updated_at: 1999-02-19 08:00

data/spec/fixtures/controllers/with_except_parameter_controller.rb

@@ -0,0 +1,19 @@
+require 'action_controller'
+require 'decent_exposure/expose'
+
+class Controllers::WithExceptParameterController < ActionController::Base
+  expose(:birds)
+  expose(:another_birds, model: :bird)
+
+  expose_query DummyQuery
+  expose_query NewDummyQuery, except: :another_birds
+
+  decent_configuration do
+    strategy DecentExposure::ActiveRecordStrategy
+  end
+
+  def params
+    {}
+  end
+
+end

data/spec/fixtures/controllers/with_only_parameter_controller.rb

@@ -0,0 +1,19 @@
+require 'action_controller'
+require 'decent_exposure/expose'
+
+class Controllers::WithOnlyParameterController < ActionController::Base
+  expose(:birds)
+  expose(:another_birds, model: :bird)
+
+  expose_query DummyQuery
+  expose_query NewDummyQuery, only: :another_birds
+
+  decent_configuration do
+    strategy DecentExposure::ActiveRecordStrategy
+  end
+
+  def params
+    {}
+  end
+
+end

data/spec/fixtures/dummy_query.rb

@@ -0,0 +1,8 @@
+class DummyQuery < ExposeQuery::BaseQuery
+
+  def apply(source_scope)
+    source_scope
+  end
+
+end
+

data/spec/fixtures/new_dummy_query.rb

@@ -0,0 +1,8 @@
+
+class NewDummyQuery < ExposeQuery::BaseQuery
+
+  def apply(source_scope)
+    source_scope
+  end
+
+end

data/spec/fixtures/schema.rb

@@ -0,0 +1,10 @@
+ActiveRecord::Schema.define do
+
+  create_table 'birds', force: true do |t|
+    t.string 'name'
+    t.string 'beak'
+    t.datetime 'created_at', null: false
+    t.datetime 'updated_at', null: false
+  end
+
+end

data/spec/spec_helper.rb

@@ -1,10 +1,29 @@
 require 'bundler/setup'
+require 'active_record'
+require 'active_record/fixtures'
+require 'pry'
 Bundler.setup
-require 'codeclimate-test-reporter'
-CodeClimate::TestReporter.start if ENV['CODECLIMATE_REPO_TOKEN']
+
+if ENV['CODECLIMATE_REPO_TOKEN']
+  require 'codeclimate-test-reporter'
+  CodeClimate::TestReporter.start
+end
 
 require 'expose_query' # and any other gems you need
 
+FIXTURES_PATH = File.join(File.dirname(__FILE__), 'fixtures')
+
+ActiveRecord::Base.establish_connection(
+    :adapter => defined?(JRUBY_VERSION) ? 'jdbcsqlite3' : 'sqlite3',
+    :database => ':memory:'
+)
+
+dep = defined?(ActiveSupport::Dependencies) ? ActiveSupport::Dependencies : ::Dependencies
+dep.autoload_paths.unshift FIXTURES_PATH
+
+ActiveRecord::Migration.verbose = false
+load File.join(FIXTURES_PATH, 'schema.rb')
+
 RSpec.configure do |config|
   # some (optional) config here
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: expose_query
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.3
 platform: ruby
 authors:
 - Nick Chubarov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-14 00:00:00.000000000 Z
+date: 2015-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: decent_exposure
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -102,6 +116,13 @@ files:
 - lib/expose_query/version.rb
 - spec/expose_query/active_record_query_strategy_spec.rb
 - spec/expose_query/controller_dsl_spec.rb
+- spec/fixtures/bird.rb
+- spec/fixtures/birds.yml
+- spec/fixtures/controllers/with_except_parameter_controller.rb
+- spec/fixtures/controllers/with_only_parameter_controller.rb
+- spec/fixtures/dummy_query.rb
+- spec/fixtures/new_dummy_query.rb
+- spec/fixtures/schema.rb
 - spec/spec_helper.rb
 homepage: ''
 licenses:
@@ -123,12 +144,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: A helper for creating declaretive interface for decent_exposure queries
 test_files:
 - spec/expose_query/active_record_query_strategy_spec.rb
 - spec/expose_query/controller_dsl_spec.rb
+- spec/fixtures/bird.rb
+- spec/fixtures/birds.yml
+- spec/fixtures/controllers/with_except_parameter_controller.rb
+- spec/fixtures/controllers/with_only_parameter_controller.rb
+- spec/fixtures/dummy_query.rb
+- spec/fixtures/new_dummy_query.rb
+- spec/fixtures/schema.rb
 - spec/spec_helper.rb
-has_rdoc: