scoping 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bf670267565ddc463c9db198a7ada3844bedfc44
+  data.tar.gz: 018e1965ce44d3bf3cf72495e49cb72450613f67
+SHA512:
+  metadata.gz: e5ff5856a942ef716e168af4a2807d4c8fe18e7ab22696184cc5412236e2fe2934fd566e00434b75065f35e61848537350da2b2843a71b10dbb59dd04d315348
+  data.tar.gz: 01f8918f0c44d6f1c4b6f4567fac64fefd36fb06700c17d69c090609f178b000c33a6eb3697400b049fcec8bbaf9ca227e922259353bb420627444527171c010

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jiří Zajpt
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# ScopeComposer
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'scoping'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install scoping
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/scope_composer/fork )
+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

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/scoping/scope_composer.rb

@@ -0,0 +1,134 @@
+require 'ostruct'
+require 'active_support/core_ext/object'
+
+# This is light-weight filtering helper class that will compose all given
+# criteria (scopes). When using this class all filtering logic has to be stored
+# in scopes instead of creating ad-hoc filtering objects.
+#
+# Usage example:
+#
+#     composer = ScopeComposer.new(Challenge)
+#     composer.with_state = 'cancelled'
+#     composer.created_during_past = '1 week'
+#
+# Or you can provide criteria as a second argument to new:
+#
+#     ScopeComposer.new(Challenge,
+#       with_state: 'cancelled',
+#       created_during_past: '1 week')
+#
+# Which translates to:
+#
+#     Challenge.with_state(:cancelled).created_during_past('1 week')
+#
+#
+# If you want to call the scopes which do not take arguments, you can safely
+# use them with one condition - the scope is ommited if the argument value
+# given is not "1" or true.
+#
+# For example:
+#
+#     ScopeComposer.new(Challenge, accepted: false)
+#
+# Would not result in the scope `accepted` applied, but on the other hand
+# following code would:
+#
+#     ScopeComposer.new(Challenge, accepted: "1")
+#
+module Scoping
+  class ScopeComposer < OpenStruct
+
+    # Initialize new instance with given scope and criteria table.
+    #
+    # @param [ActiveRecord::Base] base_scope
+    # @param [Hash] table
+    def initialize(base_scope, table = nil)
+      @base_scope = base_scope
+      @current_scope = base_scope
+      @applied = false
+      super({})
+      @table = table if table
+    end
+
+    # Apply the scopes and return all the matching records.
+    #
+    # @return [ActiveRecord::Relation]
+    def all
+      return @current_scope.all if fields.empty?
+      apply_fields_on_current_scope
+    end
+
+    # Apply the scopes and return decorated the matching records.
+    #
+    # @return [ActiveRecord::Relation]
+    def decorate
+      all.decorate
+    end
+
+    # Apply the scopes and return paginated records.
+    #
+    # @return [Array]
+    def paginate(*args)
+      apply_fields_on_current_scope
+      @current_scope.paginate(*args)
+    end
+
+    # Apply the scopes and return count.
+    #
+    # @return [Fixnum]
+    def count
+      apply_fields_on_current_scope
+      @current_scope.count
+    end
+
+    # Apply the scopes and return the resulting scope.
+    #
+    # @return [ActiveRecord::Relation]
+    def scope
+      apply_fields_on_current_scope
+      @current_scope
+    end
+
+    private
+
+    # Applies assigned scopes and returns the result scope.
+    #
+    # The scope is called only when the value (argument for scope) is non-empty
+    # value.
+    def apply_fields_on_current_scope
+      return @current_scope if @applied
+      fields.each do |field|
+        value = public_send(field)
+        next unless value.present?
+        apply_field_on_current_scope field, value
+      end
+      @applied = true
+      @current_scope
+    end
+
+    # Applies given scope with given argument to current scope
+    #
+    # @param [String] field
+    # @param [Object] value
+    def apply_field_on_current_scope(field, value)
+      arity = @base_scope.method(field).arity
+      if arity == 0
+        if value == "1" || value == true
+          @current_scope = @current_scope.public_send field
+        end
+      else
+        @current_scope = @current_scope.public_send field, value
+      end
+    end
+
+    # Return the filter fields.
+    #
+    # @return [Array]
+    def fields
+      @table.keys
+    end
+
+  end
+
+end
+

data/lib/scoping/version.rb

@@ -0,0 +1,3 @@
+module Scoping
+  VERSION = "0.0.1"
+end

data/lib/scoping.rb

@@ -0,0 +1,5 @@
+require 'scoping/version'
+require 'scoping/scope_composer'
+
+module Scoping
+end

data/scoping.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'scoping/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "scoping"
+  spec.version       = Scoping::VERSION
+  spec.authors       = ["Jiří Zajpt"]
+  spec.email         = ["jzajpt@blueberry.cz"]
+  spec.summary       = %q{Scoping is utility gem for AR composing scopes}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_dependency 'activesupport'
+end

data/spec/scoping/scope_composer_spec.rb

@@ -0,0 +1,81 @@
+# encoding: utf-8
+
+require "spec_helper"
+
+describe Scoping::ScopeComposer do
+  describe "#all" do
+    let(:scope) { double "Scope" }
+    subject { Scoping::ScopeComposer.new scope, table }
+
+    context 'given criteria table' do
+      let(:table) { { a: '1', b: '2', c: '3' } }
+
+      it "applies all scopes" do
+        scope.stub_chain(:method, :arity).and_return 1
+        scope.stub_chain(:a, :b, :c).and_return "halelujah"
+        expect(subject.all).to eq "halelujah"
+      end
+    end
+
+    context 'not given any criteria table' do
+      let(:table) { nil }
+
+      it "applies all scopes" do
+        expect(scope).to receive :all
+        subject.all
+      end
+    end
+  end
+
+  describe "#count" do
+    let(:scope) { double "Scope" }
+    subject { Scoping::ScopeComposer.new scope, table }
+
+    context 'given criteria table' do
+      let(:table) { { a: '1', b: '2', c: '3' } }
+      let(:result) { double "ResultScope" }
+
+      it "applies all scopes" do
+        scope.stub_chain(:method, :arity).and_return 1
+        scope.stub_chain(:a, :b, :c).and_return result
+        expect(result).to receive :count
+        subject.count
+      end
+    end
+
+    context 'not given any criteria table' do
+      let(:table) { nil }
+
+      it "applies all scopes" do
+        expect(scope).to receive :count
+        subject.count
+      end
+    end
+  end
+
+  describe "#paginate" do
+    let(:scope) { double "Scope" }
+    subject { Scoping::ScopeComposer.new scope, table }
+
+    context 'given criteria table' do
+      let(:table) { { a: '1', b: '2', c: '3' } }
+      let(:result) { double "ResultScope" }
+
+      it "applies all scopes" do
+        scope.stub_chain(:method, :arity).and_return 1
+        scope.stub_chain(:a, :b, :c).and_return result
+        expect(result).to receive(:paginate).with page: 1, per_page: 123
+        subject.paginate(page: 1, per_page: 123)
+      end
+    end
+
+    context 'not given any criteria table' do
+      let(:table) { nil }
+
+      it "applies all scopes" do
+        expect(scope).to receive :paginate
+        subject.paginate
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require File.expand_path('../../lib/scoping', __FILE__)
+require 'rspec/autorun'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: scoping
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jiří Zajpt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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
+  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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- jzajpt@blueberry.cz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/scoping.rb
+- lib/scoping/scope_composer.rb
+- lib/scoping/version.rb
+- scoping.gemspec
+- spec/scoping/scope_composer_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: Scoping is utility gem for AR composing scopes
+test_files:
+- spec/scoping/scope_composer_spec.rb
+- spec/spec_helper.rb