paraphrase 0.2.0 → 0.3.1

data/.gitignore

@@ -1,5 +1,5 @@
 Gemfile.lock
 doc/
-pkg/
+*.gem
 vendor/cache/*.gem
 .yardoc

data/CHANGELOG

@@ -0,0 +1,11 @@
+0.3.0 / 7-5-2012
+
+* Allow nil values to be passed to scoped using :allow_nil option.
+* Require/whitelist individual keys of a compound key.
+* Update Paraphrase::Syntax.register_mapping to update an existing mapping to
+avoid errors when a model class is reloaded during development.
+
+0.2.0 / 6-22-2012
+
+* Initial release
+

data/gemfiles/3.0.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: /Users/edd_d/src/paraphrase
   specs:
-    paraphrase (0.1.0)
+    paraphrase (0.3.0)
       activemodel (~> 3.0)
       activerecord (~> 3.0)
       activesupport (~> 3.0)

data/gemfiles/3.1.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: /Users/edd_d/src/paraphrase
   specs:
-    paraphrase (0.1.0)
+    paraphrase (0.3.0)
       activemodel (~> 3.0)
       activerecord (~> 3.0)
       activesupport (~> 3.0)

data/gemfiles/3.2.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: /Users/edd_d/src/paraphrase
   specs:
-    paraphrase (0.1.0)
+    paraphrase (0.3.0)
       activemodel (~> 3.0)
       activerecord (~> 3.0)
       activesupport (~> 3.0)

data/lib/paraphrase/query.rb

@@ -2,7 +2,6 @@ require 'active_support/core_ext/class/attribute_accessors'
 require 'active_support/core_ext/class/attribute'
 require 'active_support/core_ext/module/delegation'
 require 'active_model/naming'
-require 'active_model/errors'
 
 module Paraphrase
   class Query

data/lib/paraphrase/scope_mapping.rb

@@ -8,7 +8,13 @@ module Paraphrase
     #
     # @!attribute [r] options
     #   @return [Hash] configuration options
-    attr_reader :param_keys, :method_name, :options
+    #
+    # @!attribute [r] required_keys
+    #   @return [Array] keys required for query
+    #
+    # @!attribute [r] whitelisted_keys
+    #   @return [Array] keys allowed to be nil
+    attr_reader :param_keys, :method_name, :options, :required_keys, :whitelisted_keys
 
 
     # @param [Symbol] name name of the scope
@@ -17,15 +23,30 @@ module Paraphrase
     # @option options [true] :require lists scope as required
     def initialize(name, options)
       @method_name = name
-      @param_keys = [options.delete(:key)].flatten
+      @param_keys = Array(options.delete(:key))
+
+      @required_keys = register_keys(options[:require])
+      @whitelisted_keys = register_keys(options[:allow_nil])
+
+      if @whitelisted_keys.empty? && !@required_keys.empty?
+        @whitelisted_keys = @param_keys - @required_keys
+      end
 
       @options = options.freeze
     end
 
 
-    # Checks if scope is required for query
-    def required?
-      !options[:require].nil?
+    # True if scope is required for query
+    # @param [Symbol, String] key param key being checked
+    def required?(key)
+      required_keys.include?(key)
+    end
+
+
+    # True if nil param values can be passed to scope
+    # @see #required?
+    def whitelisted?(key)
+      whitelisted_keys.include?(key)
     end
 
 
@@ -39,17 +60,24 @@ module Paraphrase
     # @param [ActiveRecord::Relation, ActiveRecord::Base] chain current model scope
     # @return [ActiveRecord::Relation]
     def chain(query, params, chain)
-      inputs = param_keys.map { |key| params[key] }
+      inputs = param_keys.map do |key|
+        input = params[key]
 
-      if inputs.include?(nil)
-        param_keys.each do |key|
-          query.errors.add(key, 'is required')
-        end if required?
+        if input.nil? && ( required?(key) || !whitelisted?(key) )
+          query.errors.add(key, 'is required') if required?(key)
+          break []
+        end
 
-        chain
-      else
-        chain.send(method_name, *inputs)
+        input
       end
+
+      inputs.empty? ? chain : chain.send(method_name, *inputs)
+    end
+
+    private
+
+    def register_keys(option)
+      option == true ? Array(param_keys) : Array(option)
     end
   end
 end

data/lib/paraphrase/syntax.rb

@@ -1,11 +1,18 @@
 module Paraphrase
   module Syntax
 
-    # Register a {Query} class mapped to `self`.
+    # Register a {Query} class mapped to `self`. If the mapping has already
+    # been registered, calling again will clear existing scopes and evaluate
+    # the block.
     #
     # @param [Proc] &block block to define scope mappings
     def register_mapping(&block)
-      Paraphrase.register(self.name, &block)
+      if mapping = Paraphrase.mapping(self.name.underscore)
+        mapping.scopes.clear
+        mapping.instance_eval(&block)
+      else
+        Paraphrase.register(self.name, &block)
+      end
     end
 
 

data/lib/paraphrase/version.rb

@@ -1,3 +1,3 @@
 module Paraphrase
-  VERSION = "0.2.0"
+  VERSION = "0.3.1"
 end

data/paraphrase.gemspec

@@ -6,11 +6,14 @@ Gem::Specification.new do |gem|
   gem.name          = "paraphrase"
   gem.version       = Paraphrase::VERSION
   gem.summary       = %q{Map param keys to class scopes}
-  gem.description   = %q{Map param keys to class scopes}
+  gem.description   = %q{
+                        Build customizable classes to determine which scope
+                        methods to call based on supplied parameters.
+                      }
   gem.license       = "MIT"
   gem.authors       = ["Eduardo Gutierrez"]
   gem.email         = "edd_d@mit.edu"
-  gem.homepage      = "https://rubygems.org/gems/paraphrase"
+  gem.homepage      = "https://github.com/ecbypi/paraphrase"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/spec/paraphrase/scope_mapping_spec.rb

@@ -2,35 +2,47 @@ require 'spec_helper'
 
 module Paraphrase
   describe ScopeMapping do
-    let(:scope_mapping) do
-      ScopeMapping.new :name_like, :key => :name
-    end
-
-    it "removes keys from options" do
-      scope_mapping.options.should_not have_key :key
+    let(:mapping) { ScopeMapping.new(:name_like, :key => :name) }
+    let(:compound_mapping) { ScopeMapping.new(:name_like, :key => [:first_name, :last_name], :require => :last_name) }
+    let(:query) do
+      query = double('query')
+      query.stub(:errors).and_return(double('errors'))
+      query
     end
 
     describe "#chain" do
-      let(:query) { double('query') }
-
       it "applies scope method to query object with values from params hash" do
         Account.should_receive(:name_like).with('Jon Snow')
-        scope_mapping.chain(query, { :name => 'Jon Snow' }, Account)
+        mapping.chain(query, { :name => 'Jon Snow' }, Account)
       end
 
       it "does nothing if values are missing" do
         Account.should_not_receive(:name_like).with('Jon Snow')
-        scope_mapping.chain(query, {}, Account)
+        mapping.chain(query, {}, Account)
       end
 
       it "adds errors to query object if missing and required" do
-        errors = double('errors')
-        query.stub(:errors).and_return(errors)
-        required_mapping = ScopeMapping.new :name_like, :key => :name, :require => true
+        required_mapping = ScopeMapping.new(:name_like, :key => :name, :require => true)
 
-        errors.should_receive(:add)
+        query.errors.should_receive(:add)
         required_mapping.chain(query, {}, Account)
       end
+
+      it "passes through nil values if scope has been whitelisted" do
+        mapping = ScopeMapping.new(:name_like, :key => :name, :allow_nil => true)
+
+        Account.should_receive(:name_like).with(nil)
+        mapping.chain(query, {}, Account)
+      end
+    end
+
+    it "can require a subset of a compound key" do
+      Account.should_receive(:name_like).with(nil, 'Lannister')
+      compound_mapping.chain(query, { :last_name => 'Lannister' }, Account)
+    end
+
+    it "whitelists the the non-required keys of a compound key" do
+      compound_mapping.whitelisted?(:first_name).should be_true
     end
   end
 end

data/spec/paraphrase/syntax_spec.rb

@@ -7,6 +7,15 @@ module Paraphrase
         ::Account.register_mapping {}
         Paraphrase.mapping(:account).should_not be_nil
       end
+
+      it "updates scopes if already registered" do
+        ::Account.register_mapping do
+          scope :name_like, :key => :name
+        end
+
+        mapping = Paraphrase.mapping(:account)
+        mapping.scopes.should_not be_empty
+      end
     end
 
     describe ".paraphrase" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paraphrase
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-23 00:00:00.000000000 Z
+date: 2012-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70178168974020 !ruby/object:Gem::Requirement
+  requirement: &70300799182120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70178168974020
+  version_requirements: *70300799182120
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70178168972120 !ruby/object:Gem::Requirement
+  requirement: &70300799180260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70178168972120
+  version_requirements: *70300799180260
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &70178168971600 !ruby/object:Gem::Requirement
+  requirement: &70300799177960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70178168971600
+  version_requirements: *70300799177960
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70178168971060 !ruby/object:Gem::Requirement
+  requirement: &70300799176700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *70178168971060
+  version_requirements: *70300799176700
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70178168970400 !ruby/object:Gem::Requirement
+  requirement: &70300799167400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: '0.7'
   type: :development
   prerelease: false
-  version_requirements: *70178168970400
+  version_requirements: *70300799167400
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70178168969700 !ruby/object:Gem::Requirement
+  requirement: &70300799166180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: '2.10'
   type: :development
   prerelease: false
-  version_requirements: *70178168969700
+  version_requirements: *70300799166180
 - !ruby/object:Gem::Dependency
   name: redcarpet
-  requirement: &70178168969060 !ruby/object:Gem::Requirement
+  requirement: &70300799164540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70178168969060
+  version_requirements: *70300799164540
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70178168968360 !ruby/object:Gem::Requirement
+  requirement: &70300799163600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70178168968360
+  version_requirements: *70300799163600
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70178168967600 !ruby/object:Gem::Requirement
+  requirement: &70300799162540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70178168967600
+  version_requirements: *70300799162540
 - !ruby/object:Gem::Dependency
   name: appraisal
-  requirement: &70178168966640 !ruby/object:Gem::Requirement
+  requirement: &70300799161860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,19 +120,20 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70178168966640
-description: Map param keys to class scopes
+  version_requirements: *70300799161860
+description: ! "\n                        Build customizable classes to determine
+  which scope\n                        methods to call based on supplied parameters.\n
+  \                     "
 email: edd_d@mit.edu
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .document
 - .gitignore
 - .rspec
 - .yardopts
 - Appraisals
-- ChangeLog.md
+- CHANGELOG
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -156,7 +157,7 @@ files:
 - spec/paraphrase/syntax_spec.rb
 - spec/paraphrase_spec.rb
 - spec/spec_helper.rb
-homepage: https://rubygems.org/gems/paraphrase
+homepage: https://github.com/ecbypi/paraphrase
 licenses:
 - MIT
 post_install_message: 

data/.document

@@ -1,3 +0,0 @@
-- 
-ChangeLog.md
-LICENSE.txt

data/ChangeLog.md

@@ -1,4 +0,0 @@
-### 0.1.0 / 2012-06-04
-
-* Initial release:
-