paraphrase 0.9.0 → 0.10.0

data/gemfiles/4.0.gemfile

@@ -2,8 +2,8 @@
 
 source "https://rubygems.org"
 
-gem "activerecord", "~> 4.0"
-gem "activesupport", "~> 4.0"
-gem "actionpack", "~> 4.0"
+gem "activerecord", "~> 4.0.0"
+gem "activesupport", "~> 4.0.0"
+gem "actionpack", "~> 4.0.0"
 
 gemspec :path=>"../"

data/gemfiles/4.0.gemfile.lock

@@ -1,31 +1,31 @@
 PATH
-  remote: /Users/edd_d/Work/paraphrase
+  remote: ../
   specs:
-    paraphrase (0.9.0)
-      activemodel (>= 3.0, < 4.2)
-      activerecord (>= 3.0, < 4.2)
-      activesupport (>= 3.0, < 4.2)
+    paraphrase (0.10.0)
+      activemodel (>= 3.1, < 4.2)
+      activerecord (>= 3.1, < 4.2)
+      activesupport (>= 3.1, < 4.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (4.0.2)
-      activesupport (= 4.0.2)
+    actionpack (4.0.4)
+      activesupport (= 4.0.4)
       builder (~> 3.1.0)
       erubis (~> 2.7.0)
       rack (~> 1.5.2)
       rack-test (~> 0.6.2)
-    activemodel (4.0.2)
-      activesupport (= 4.0.2)
+    activemodel (4.0.4)
+      activesupport (= 4.0.4)
       builder (~> 3.1.0)
-    activerecord (4.0.2)
-      activemodel (= 4.0.2)
+    activerecord (4.0.4)
+      activemodel (= 4.0.4)
       activerecord-deprecated_finders (~> 1.0.2)
-      activesupport (= 4.0.2)
+      activesupport (= 4.0.4)
       arel (~> 4.0.0)
     activerecord-deprecated_finders (1.0.3)
-    activesupport (4.0.2)
-      i18n (~> 0.6, >= 0.6.4)
+    activesupport (4.0.4)
+      i18n (~> 0.6, >= 0.6.9)
       minitest (~> 4.2)
       multi_json (~> 1.3)
       thread_safe (~> 0.1)
@@ -33,8 +33,7 @@ GEM
     appraisal (0.5.2)
       bundler
       rake
-    arel (4.0.1)
-    atomic (1.1.14)
+    arel (4.0.2)
     builder (3.1.4)
     codeclimate-test-reporter (0.3.0)
       simplecov (>= 0.7.1, < 1.0.0)
@@ -45,8 +44,8 @@ GEM
     i18n (0.6.9)
     method_source (0.8.2)
     minitest (4.7.5)
-    multi_json (1.8.4)
-    pry (0.9.12.4)
+    multi_json (1.10.1)
+    pry (0.9.12.6)
       coderay (~> 1.0)
       method_source (~> 0.8)
       slop (~> 3.4)
@@ -55,33 +54,36 @@ GEM
       rack (>= 1.0)
     rake (0.9.6)
     redcarpet (2.1.1)
-    rspec (2.14.1)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.7)
-    rspec-expectations (2.14.4)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.4)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.0)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.0)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.0)
     simplecov (0.8.2)
       docile (~> 1.1.0)
       multi_json
       simplecov-html (~> 0.8.0)
     simplecov-html (0.8.0)
-    slop (3.4.7)
-    sqlite3 (1.3.8)
-    thread_safe (0.1.3)
-      atomic
-    tzinfo (0.3.38)
-    yard (0.8.7.3)
+    slop (3.5.0)
+    sqlite3 (1.3.9)
+    thread_safe (0.3.3)
+    tzinfo (0.3.39)
+    yard (0.8.7.4)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  actionpack (~> 4.0)
-  activerecord (~> 4.0)
-  activesupport (~> 4.0)
+  actionpack (~> 4.0.0)
+  activerecord (~> 4.0.0)
+  activesupport (~> 4.0.0)
   appraisal (~> 0.4)
   bundler (~> 1.0)
   codeclimate-test-reporter (~> 0.3)
@@ -89,6 +91,6 @@ DEPENDENCIES
   pry (~> 0.9)
   rake (~> 0.9.2)
   redcarpet (~> 2.1.1)
-  rspec (~> 2.14)
+  rspec (~> 3.0)
   sqlite3 (~> 1.3.6)
   yard (~> 0.7)

data/gemfiles/4.1.gemfile

@@ -2,8 +2,8 @@
 
 source "https://rubygems.org"
 
-gem "activerecord", "~> 4.1"
-gem "activesupport", "~> 4.1"
-gem "actionpack", "~> 4.1"
+gem "activerecord", "~> 4.1.0"
+gem "activesupport", "~> 4.1.0"
+gem "actionpack", "~> 4.1.0"
 
 gemspec :path=>"../"

data/gemfiles/4.1.gemfile.lock

@@ -1,31 +1,31 @@
 PATH
   remote: ../
   specs:
-    paraphrase (0.9.0)
-      activemodel (>= 3.0, < 4.2)
-      activerecord (>= 3.0, < 4.2)
-      activesupport (>= 3.0, < 4.2)
+    paraphrase (0.10.0)
+      activemodel (>= 3.1, < 4.2)
+      activerecord (>= 3.1, < 4.2)
+      activesupport (>= 3.1, < 4.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (4.1.0)
-      actionview (= 4.1.0)
-      activesupport (= 4.1.0)
+    actionpack (4.1.1)
+      actionview (= 4.1.1)
+      activesupport (= 4.1.1)
       rack (~> 1.5.2)
       rack-test (~> 0.6.2)
-    actionview (4.1.0)
-      activesupport (= 4.1.0)
+    actionview (4.1.1)
+      activesupport (= 4.1.1)
       builder (~> 3.1)
       erubis (~> 2.7.0)
-    activemodel (4.1.0)
-      activesupport (= 4.1.0)
+    activemodel (4.1.1)
+      activesupport (= 4.1.1)
       builder (~> 3.1)
-    activerecord (4.1.0)
-      activemodel (= 4.1.0)
-      activesupport (= 4.1.0)
+    activerecord (4.1.1)
+      activemodel (= 4.1.1)
+      activesupport (= 4.1.1)
       arel (~> 5.0.0)
-    activesupport (4.1.0)
+    activesupport (4.1.1)
       i18n (~> 0.6, >= 0.6.9)
       json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
@@ -45,8 +45,8 @@ GEM
     i18n (0.6.9)
     json (1.8.1)
     method_source (0.8.2)
-    minitest (5.3.3)
-    multi_json (1.9.3)
+    minitest (5.3.4)
+    multi_json (1.10.1)
     pry (0.9.12.6)
       coderay (~> 1.0)
       method_source (~> 0.8)
@@ -56,33 +56,37 @@ GEM
       rack (>= 1.0)
     rake (0.9.6)
     redcarpet (2.1.1)
-    rspec (2.14.1)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.8)
-    rspec-expectations (2.14.5)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.6)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.0)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.0)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.0)
     simplecov (0.8.2)
       docile (~> 1.1.0)
       multi_json
       simplecov-html (~> 0.8.0)
     simplecov-html (0.8.0)
     slop (3.5.0)
-    sqlite3 (1.3.8)
+    sqlite3 (1.3.9)
     thread_safe (0.3.3)
     tzinfo (1.1.0)
       thread_safe (~> 0.1)
-    yard (0.8.7.3)
+    yard (0.8.7.4)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  actionpack (~> 4.1)
-  activerecord (~> 4.1)
-  activesupport (~> 4.1)
+  actionpack (~> 4.1.0)
+  activerecord (~> 4.1.0)
+  activesupport (~> 4.1.0)
   appraisal (~> 0.4)
   bundler (~> 1.0)
   codeclimate-test-reporter (~> 0.3)
@@ -90,6 +94,6 @@ DEPENDENCIES
   pry (~> 0.9)
   rake (~> 0.9.2)
   redcarpet (~> 2.1.1)
-  rspec (~> 2.14)
+  rspec (~> 3.0)
   sqlite3 (~> 1.3.6)
   yard (~> 0.7)

data/lib/paraphrase.rb

@@ -1,5 +1,16 @@
-require 'paraphrase/errors'
+module Paraphrase
+  class DuplicateMappingError < StandardError
+    def initialize(scope_name)
+      @message = "scope :#{scope_name} has already been mapped"
+    end
+  end
+
+  class NoQueryDefined < StandardError
+    def initialize(query_name)
+      @message = "No query class found. #{query_name} must be defined as a subclass of `Paraphrase::Query`"
+    end
+  end
+end
+
 require 'paraphrase/query'
-require 'paraphrase/scope'
-require 'paraphrase/syntax'
 require 'paraphrase/rails' if defined?(Rails)

data/lib/paraphrase/active_model.rb

@@ -2,6 +2,7 @@ require 'active_support/concern'
 require 'active_model/naming'
 
 module Paraphrase
+  # @api private
   module ActiveModel
     extend ActiveSupport::Concern
 

data/lib/paraphrase/mapping.rb

@@ -0,0 +1,28 @@
+require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/array/wrap'
+
+module Paraphrase
+  # @api private
+  class Mapping
+    attr_reader :keys, :name, :required_keys
+
+    def initialize(keys, options)
+      @keys = keys
+      @name = options[:to]
+
+      @required_keys = if options[:whitelist] == true
+        []
+      else
+        @keys - Array.wrap(options[:whitelist])
+      end
+    end
+
+    def satisfied?(params)
+      required_keys.all? { |key| params[key] }
+    end
+
+    def values(params)
+      keys.map { |key| params[key] }
+    end
+  end
+end

data/lib/paraphrase/{params.rb → params_filter.rb}

@@ -1,12 +1,18 @@
 module Paraphrase
-  class Params
+  class ParamsFilter
     attr_reader :params, :result
 
-    def initialize(params, keys)
-      @params = params.with_indifferent_access.slice(*keys)
+    def initialize(unfiltered_params, keys)
+      @params = unfiltered_params.with_indifferent_access.slice(*keys)
 
       @result = @params.inject(HashWithIndifferentAccess.new) do |result, (key, value)|
-        value = respond_to?(key) ? send(key) : scrub(@params[key])
+        value = @params[key]
+
+        if respond_to?(key)
+          value = send(key)
+        end
+
+        value = scrub(value)
 
         if value.present?
           result[key] = value

data/lib/paraphrase/query.rb

@@ -4,92 +4,115 @@ require 'active_support/core_ext/module/delegation'
 require 'active_support/core_ext/string/inflections'
 require 'active_support/core_ext/array/extract_options'
 require 'active_support/hash_with_indifferent_access'
+
 require 'paraphrase/active_model'
-require 'paraphrase/params'
+require 'paraphrase/mapping'
+require 'paraphrase/params_filter'
+require 'paraphrase/repository'
 
 module Paraphrase
   class Query
     include ActiveModel
-    # @!attribute [r] scopes
-    #   @return [Array<Scope>] scopes for query
-    class_attribute :scopes, :_source, instance_writer: false
+    # @!attribute [r] mappings
+    #   @return [Array<Paraphrase::Mapping>] mappings for query
+    # @!attribute [r] source
+    #   @return [Symbol, String] name of the class to use as the source for the
+    #   query
+    class_attribute :mappings, instance_writer: false
+    class_attribute :source, instance_writer: false, instance_reader: false
+    class_attribute :params_filter, instance_writer: false
+    class_attribute :repository, instance_writer: false
 
     # @!attribute [r] params
-    #   @return [HashWithIndifferentAccess] filtered parameters based on keys defined in scopes
+    #   @return [HashWithIndifferentAccess] filtered parameters based on keys defined in `mappings`
     #
     # @!attribute [r] result
     #   @return [ActiveRecord::Relation]
     attr_reader :params, :result
 
-    # Set `scopes` on inheritance to ensure they're unique per subclass
+    # Set `mappings` on inheritance to ensure they're unique per subclass
     def self.inherited(klass)
-      klass.scopes = []
-    end
+      klass.mappings = []
+      klass.source = klass.to_s.sub(/Query$/, '')
 
-    # Specify the `ActiveRecord` source class if not determinable from the name
-    # of the `Paraphrase::Query` subclass.
-    #
-    # @param [String, Symbol] name name of the source class
-    def self.source(name)
-      self._source = name.to_s
+      klass.params_filter = Class.new(Paraphrase::ParamsFilter)
+      klass.const_set(:ParamsFilter, klass.params_filter)
+
+      klass.repository = Class.new(Paraphrase::Repository)
+      klass.const_set(:Repository, klass.repository)
     end
 
     # Keys being mapped to scopes
     #
     # @return [Array<Symbol>]
     def self.keys
-      scopes.flat_map(&:keys)
+      mappings.flat_map(&:keys)
     end
 
-    # Returns the class for processing and filtering query params.
-    def self.param_processor
-      self::Params
-    rescue NameError
-      Paraphrase::Params
-    end
-
-    # Add a {Scope} instance to {Query#scopes}. Defines a reader for each key
-    # to read from {Query#params}.
+    # Add a {Mapping} instance to {Query#mappings}. Defines a reader for each
+    # key to read from {Query#params}.
     #
-    # @see Scope#initialize
+    # @overload map(*keys, options)
+    #   Maps a key to a scope
+    #   @param [Array<Symbol>] keys query params to be mapped to the scope
+    #   @param [Hash] options options to configure {Mapping Mapping} instance
+    #   @option options [Symbol, Array<Symbol>] :to scope to map query params to
+    #   @option options [true, Symbol, Array<Symbol>] :whitelist lists all or a
+    #     subset of param keys as optional
     def self.map(*keys)
       options = keys.extract_options!
       scope_name = options[:to]
 
-      if scopes.any? { |scope| scope.name == scope_name }
-        raise DuplicateScopeError, "scope :#{scope_name} has already been mapped"
+      if mappings.any? { |mapping| mapping.name == scope_name }
+        raise DuplicateMappingError.new(scope_name)
       end
 
-      scopes << Scope.new(keys, options)
+      mappings << Mapping.new(keys, options)
 
       keys.each do |key|
         define_method(key) { params[key] }
       end
     end
 
+    # Define a method on `ParamsFilter` to process the raw value of the query
+    # param
+    #
+    # @param [Symbol] query_param query param to process
+    # @param [Proc] block block to process the query param
+    def self.param(query_param, &block)
+      params_filter.class_eval do
+        define_method(query_param, &block)
+      end
+    end
+
+    # Define a scope on `Repository`
+    def self.scope(scope_name, &block)
+      repository.class_eval do
+        define_method(scope_name, &block)
+      end
+    end
+
     # Filters out parameters irrelevant to the query and sets the base scope
     # for to begin the chain.
     #
     # @param [Hash] params query parameters
     # @param [ActiveRecord::Relation] relation object to apply methods to
-    def initialize(params = {}, relation = source)
-      @params = process_params(params)
+    def initialize(query_params, relation = nil)
+      @params = filter_params(query_params || {})
 
-      @result = scopes.inject(relation) do |result, scope|
-        scope.chain(@params, result)
+      @result = mappings.inject(relation || default_relation) do |result, mapping|
+        repository.chain(result, mapping, @params)
       end
     end
 
     # Return an `ActiveRecord::Relation` corresponding to the source class
-    # determined from the `_source` class attribute or the name of the query
-    # class.
+    # determined from the `source` class attribute that defaults to the name of
+    # the class.
     #
     # @return [ActiveRecord::Relation]
-    def source
-      @source ||= begin
-        name = _source || self.class.to_s.sub(/Query$/, '')
-        name.constantize
-      end
+    def default_relation
+      klass = self.class.source.to_s.constantize
+      klass.default_paraphrase_relation
     end
 
     # @see Query.keys
@@ -99,8 +122,8 @@ module Paraphrase
 
     private
 
-    def process_params(params)
-      self.class.param_processor.new(params, keys).result
+    def filter_params(params)
+      params_filter.new(params, keys).result
     end
   end
 end