paraphrase 0.7.0 → 0.8.0

data/spec/paraphrase/scope_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+module Paraphrase
+  describe Scope do
+    def build_account_scope(options = {})
+      options.reverse_merge!(
+        keys: [:name],
+        to: :name_like
+      )
+
+      keys = options.delete(:keys)
+
+      Scope.new(keys, options)
+    end
+
+    describe "#chain" do
+      it "applies scope method to relation with values from params hash" do
+        scope = build_account_scope
+
+        expect(Account).to receive(:name_like).with('Jon Snow')
+        scope.chain({ name: 'Jon Snow' }, Account)
+      end
+
+      it "does nothing if values are missing" do
+        scope = build_account_scope
+
+        expect(Account).not_to receive(:name_like)
+        scope.chain({}, Account)
+      end
+
+      it "passes through blank values if scope has been whitelisted" do
+        scope = build_account_scope(whitelist: true)
+
+        expect(Account).to receive(:name_like).with(nil)
+        scope.chain({}, Account)
+      end
+
+      it 'allows whitelisting a subset of keys' do
+        scope = build_account_scope(
+          keys: [:name, :status],
+          to: :with_name_and_status,
+          whitelist: true
+        )
+
+        expect(Account).to receive(:with_name_and_status).with('George', nil)
+
+        scope.chain({ name: 'George' }, Account)
+      end
+    end
+  end
+end

data/spec/paraphrase/syntax_spec.rb

@@ -1,13 +1,32 @@
 require 'spec_helper'
 
 module Paraphrase
-  module Syntax
-    describe Base do
-      describe "#register_mapping" do
-        it "creates new sublcass of Query" do
-          Account.register_mapping {}
-          Account._paraphraser.should_not be_nil
-        end
+  describe Syntax do
+    class ::AccountQuery < Paraphrase::Query
+      map :name, to: :named
+    end
+
+    describe '.paraphrase' do
+      it "passes through results from an initialized query" do
+        expect_any_instance_of(AccountQuery).to receive(:result).and_call_original
+
+        result = Account.paraphrase
+        expect(result).to eq Account
+      end
+
+      it 'raises if query class is not defined' do
+        expect { User.paraphrase }.to raise_error Paraphrase::NoQueryDefined
+      end
+
+      it "works on instances of `ActiveRecord::Relation`, preserving existing filters" do
+        user = User.create!
+        Account.create!(user: user)
+        Account.create!(name: 'Sophie')
+        account = Account.create!(name: 'Sophie', user: user)
+
+        result = user.accounts.paraphrase(name: 'Sophie')
+
+        expect(result).to eq [account]
       end
     end
   end

data/spec/spec_helper.rb

@@ -1,4 +1,63 @@
 require 'rspec'
 require 'pry'
 require 'paraphrase'
-require 'support/database'
+require 'active_record'
+
+I18n.enforce_available_locales = false
+
+ActiveRecord::Base.establish_connection(
+  adapter: 'sqlite3',
+  database: ':memory:'
+)
+
+ActiveRecord::Migration.verbose = false
+ActiveRecord::Schema.define do
+  create_table :users, force: true do
+  end
+
+  create_table :posts, force: true do |t|
+    t.string :title
+    t.boolean :published
+    t.datetime :published_at
+    t.references :user
+  end
+
+  create_table :accounts, force: true do |t|
+    t.string :name
+    t.references :user
+  end
+end
+
+ActiveRecord::Base.extend Paraphrase::Syntax
+ActiveRecord::Relation.send(:include, Paraphrase::Syntax)
+
+class User < ActiveRecord::Base
+  has_many :accounts
+  has_many :posts
+end
+
+class Post < ActiveRecord::Base
+  belongs_to :user
+
+  scope :titled, ->(title) { where(title: title) }
+
+  def self.published
+    where(published: true)
+  end
+
+  def self.by_users(names)
+    joins(:user).where(users: { name: names })
+  end
+
+  def self.published_between(start_date, end_date)
+    where(published_at: start_date..end_date)
+  end
+end
+
+class Account < ActiveRecord::Base
+  belongs_to :user
+
+  def self.named(name)
+    where(name: name)
+  end
+end

metadata

@@ -1,181 +1,222 @@
 --- !ruby/object:Gem::Specification
 name: paraphrase
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Eduardo Gutierrez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-26 00:00:00.000000000 Z
+date: 2014-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '4.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '4.1'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '4.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
-    - - <
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
       - !ruby/object:Gem::Version
         version: '4.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: '2.14'
 - !ruby/object:Gem::Dependency
-  name: redcarpet
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.1
+        version: 0.9.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.1
+        version: 0.9.2
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.2
+        version: '0.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.2
+        version: '0.4'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.6
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.6
+        version: '0.9'
 - !ruby/object:Gem::Dependency
-  name: appraisal
+  name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: 2.1.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: 2.1.1
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 1.3.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 1.3.6
 description: "\n                        Map query params to model scopes, pairing
   one or\n                        more keys to a scope. Parameters can be required,
   or\n                        whitelisted providing fine tuned control over how\n
   \                       scopes are run.\n                      "
-email: edd_d@mit.edu
+email: eduardo@vermonster.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .yardopts
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- ".yardopts"
 - Appraisals
-- CHANGELOG
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -189,18 +230,18 @@ files:
 - gemfiles/4.0.gemfile
 - gemfiles/4.0.gemfile.lock
 - lib/paraphrase.rb
+- lib/paraphrase/active_model.rb
 - lib/paraphrase/errors.rb
 - lib/paraphrase/query.rb
 - lib/paraphrase/rails.rb
-- lib/paraphrase/scope_mapping.rb
+- lib/paraphrase/scope.rb
 - lib/paraphrase/syntax.rb
 - lib/paraphrase/version.rb
 - paraphrase.gemspec
 - spec/paraphrase/query_spec.rb
-- spec/paraphrase/scope_mapping_spec.rb
+- spec/paraphrase/scope_spec.rb
 - spec/paraphrase/syntax_spec.rb
 - spec/spec_helper.rb
-- spec/support/database.rb
 homepage: https://github.com/ecbypi/paraphrase
 licenses:
 - MIT
@@ -211,24 +252,23 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Map query params to model scopes
 test_files:
 - spec/paraphrase/query_spec.rb
-- spec/paraphrase/scope_mapping_spec.rb
+- spec/paraphrase/scope_spec.rb
 - spec/paraphrase/syntax_spec.rb
 - spec/spec_helper.rb
-- spec/support/database.rb
 has_rdoc: 

data/CHANGELOG

@@ -1,39 +0,0 @@
-0.7.0 / 1-25-2014
-
-* Add Rails 4 support
-
-0.5.0 / 8-7-2012
-
-* Cleanup ScopeMapping class
-* Add ability to query from an existing ActiveRecord::Relation instance
-(typically an association).
-* Update syntax for generating mappings.
-
-0.4.0 / 7-6-2012
-
-* Setup Query#params to be HashWithIndifferentAccess.
-* Gut out Paraphrase module methods. These were for use cases I had planned
-for but have yet to encounter.
-* Model's query class is now stored on the model itself.
-
-0.3.2 / 7-5-2012
-
-* Cache Query#results
-* Setup Query#method_missing to proxy to Query#results
-* Setup Query#respond_to? to check Query#results
-
-0.3.1 / 7-5-2012
-
-* Fix for rails 3.0
-
-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/lib/paraphrase/scope_mapping.rb

@@ -1,78 +0,0 @@
-require 'active_support/core_ext/object/blank'
-
-module Paraphrase
-  class ScopeMapping
-    # @!attribute [r] keys
-    #   @return [Array<Symbol>] param keys to extract
-    #
-    # @!attribute [r] method_name
-    #   @return [Symbol] scope name
-    #
-    # @!attribute [r] required
-    #   @return [Array] keys required for query
-    #
-    # @!attribute [r] whitelist
-    #   @return [Array] keys allowed to be nil
-    attr_reader :keys, :method_name, :required, :whitelist
-
-    # @param [Symbol] name name of the scope
-    # @param [Hash] options options to configure {ScopeMapping ScopeMapping} instance
-    # @option options [Symbol, Array<Symbol>] :to param key(s) to extract values from
-    # @option options [true, Symbol, Array<Symbol>] :require lists all or a
-    #   subset of param keys as required
-    # @option options [true, Symbol, Array<Symbol>] :whitelist lists all or a
-    #   subset of param keys as whitelisted
-    def initialize(name, options)
-      @method_name = name
-      @keys = Array(options.delete(:to))
-
-      @required = register_keys(options[:require])
-      @whitelist = register_keys(options[:whitelist])
-
-      if @whitelist.empty? && !@required.empty?
-        @whitelist = @keys - @required
-      end
-
-      if (whitelist & required).any?
-        raise ArgumentError, "cannot whitelist and require the same keys"
-      end
-    end
-
-    # Sends {#method_name} to `chain`, extracting arguments from `params`.  If
-    # values are missing for any {#keys}, return the `chain` unmodified.
-    # If {#required? required}, errors are added to the {Query} instance as
-    # well.
-    #
-    # @param [Hash] params hash of query parameters
-    # @param [ActiveRecord::Relation, ActiveRecord::Base] relation scope chain
-    # @return [ActiveRecord::Relation]
-    def chain(params, relation)
-      scope = relation.respond_to?(:klass) ? relation.klass.method(method_name) : relation.method(method_name)
-
-      inputs = keys.map do |key|
-        input = params[key]
-
-        if input.nil?
-          break    if required.include?(key)
-          break [] if !whitelist.include?(key)
-        end
-
-        input
-      end
-
-      if inputs.nil?
-        return
-      elsif inputs.empty?
-        return relation
-      end
-
-      scope.arity == 0 ? relation.send(method_name) : relation.send(method_name, *inputs)
-    end
-
-    private
-
-    def register_keys(option)
-      option == true ? Array(keys) : Array(option)
-    end
-  end
-end

data/spec/paraphrase/scope_mapping_spec.rb

@@ -1,46 +0,0 @@
-require 'spec_helper'
-
-module Paraphrase
-  describe ScopeMapping do
-
-    describe "#chain" do
-      let(:mapping) { ScopeMapping.new(:name_like, :to => :name) }
-
-      it "applies scope method to relation with values from params hash" do
-        Account.should_receive(:name_like).with('Jon Snow')
-
-        mapping.chain({ :name => 'Jon Snow' }, Account)
-      end
-
-      it "does nothing if values are missing" do
-        Account.should_not_receive(:name_like).with('Jon Snow')
-
-        mapping.chain({}, Account)
-      end
-
-      it "passes through nil values if scope has been whitelisted" do
-        mapping = ScopeMapping.new(:name_like, :to => :name, :whitelist => true)
-
-        Account.should_receive(:name_like).with(nil)
-
-        mapping.chain({}, Account)
-      end
-    end
-
-    describe "compound keys" do
-      let(:compound_mapping) do
-        ScopeMapping.new(:name_like, :to => [:first_name, :last_name], :require => :last_name)
-      end
-
-      it "can require a subset of a compound key" do
-        Account.should_receive(:name_like).with(nil, 'Lannister')
-
-        compound_mapping.chain({ :last_name => 'Lannister' }, Account)
-      end
-
-      it "whitelists the the non-required keys of a compound key" do
-        compound_mapping.whitelist.include?(:first_name).should be_true
-      end
-    end
-  end
-end

data/spec/support/database.rb

@@ -1,38 +0,0 @@
-require 'active_record'
-
-ActiveRecord::Relation.send(:include, Paraphrase::Syntax::Relation)
-
-ActiveRecord::Base.establish_connection(
-  :adapter => 'sqlite3',
-  :database => ':memory:'
-)
-
-ActiveRecord::Migration.verbose = false
-ActiveRecord::Schema.define do
-  create_table :users, :force => true do
-  end
-
-  create_table :accounts, :force => true do |t|
-    t.references :user
-  end
-end
-
-class User < ActiveRecord::Base
-  has_many :accounts
-end
-
-class Account < ActiveRecord::Base
-  extend Paraphrase::Syntax::Base
-  belongs_to :user
-
-  def self.title_like(*args)
-    ActiveRecord::VERSION::MAJOR > 3 ?  all : scoped
-  end
-
-  def self.name_like(*args)
-    ActiveRecord::VERSION::MAJOR > 3 ?  all : scoped
-  end
-end
-
-class AccountQuery < Paraphrase::Query
-end