paraphrase 0.3.2 → 0.4.0

data/CHANGELOG

@@ -1,3 +1,10 @@
+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

data/README.md

@@ -29,8 +29,7 @@ $ gem install paraphrase
 
 ### Setup
 
-paraphrase aims to be as flexible as possible. `Query` classes can be created
-in the following ways:
+`Paraphrase::Query` classes can be created in the following ways:
 
 * Calling `register_mapping` in an `ActiveRecord::Base` subclass:
 
@@ -46,23 +45,12 @@ class Post < ActiveRecord::Base
 end
 ```
 
-* A configuration block through `Paraphrase.configure`:
-
-```ruby
-# config/initializers/paraphrase.rb
-
-Paraphrase.configure do |mappings|
-  mappings.register :post do
-    paraphrases Post
-    scope :by_user, :key => :author
-  end
-end
-```
-
 * Subclassing `Paraphrase::Query`:
 
 ```ruby
 class PostQuery < Paraphrase::Query
+  # takes the constant or a symbol/string that can be classified
+  # into a constant name
   paraphrases Post
 
   scope :by_user, :key => :author
@@ -79,11 +67,7 @@ class PostsController < ApplicationController
 
   def index
     @posts = Post.paraphrase(params)
-
-    # Or
-    # @posts = Paraphrase.query(:post, params)
-
-    # If you created a subclass
+    # Or if you created a subclass
     # @posts = PostQuery.new(params)
 
     respond_with(@posts)

data/lib/paraphrase/errors.rb

@@ -1,4 +1,3 @@
 module Paraphrase
-  class DuplicateMappingError < StandardError; end
   class DuplicateScopeError < StandardError; end
 end

data/lib/paraphrase/query.rb

@@ -1,6 +1,7 @@
-require 'active_support/core_ext/class/attribute_accessors'
 require 'active_support/core_ext/class/attribute'
 require 'active_support/core_ext/module/delegation'
+require 'active_support/core_ext/string/inflections'
+require 'active_support/hash_with_indifferent_access'
 require 'active_model/naming'
 
 module Paraphrase
@@ -12,8 +13,7 @@ module Paraphrase
     #
     # @!attribute [r] source
     #   @return [ActiveRecord::Relation] source to apply scopes to
-    cattr_reader :scopes, :source
-    @@scopes = []
+    class_attribute :scopes, :source, :instance_writer => false
 
 
     # Delegate enumerable methods to results
@@ -24,10 +24,16 @@ module Paraphrase
     #   @return [ActiveModel::Errors] errors from determining results
     #
     # @!attribute [r] params
-    #   @return [Hash] filters parameters based on keys defined in scopes
+    #   @return [HashWithIndifferentAccess] filters parameters based on keys defined in scopes
     attr_reader :errors, :params
 
 
+    # Set `scopes` on inheritance to ensure they're unique per subclass
+    def self.inherited(klass)
+      klass.scopes = []
+    end
+
+
     # Specify the ActiveRecord model to use as the source for queries
     #
     # @param [String, Symbol, ActiveRecord::Base] klass name of the class to
@@ -37,9 +43,7 @@ module Paraphrase
         klass = Object.const_get(klass.to_s.classify)
       end
 
-      @@source = klass.scoped
-
-      Paraphrase.add(klass.name, self)
+      self.source = klass
     end
 
 
@@ -47,11 +51,11 @@ module Paraphrase
     #
     # @see ScopeMapping#initialize
     def self.scope(name, options)
-      if @@scopes.map(&:method_name).include?(name)
+      if scopes.map(&:method_name).include?(name)
         raise DuplicateScopeError, "scope :#{name} has already been added"
       end
 
-      @@scopes << ScopeMapping.new(name, options)
+      scopes << ScopeMapping.new(name, options)
     end
 
 
@@ -59,8 +63,8 @@ module Paraphrase
     #
     # @param [Hash] params query parameters
     def initialize(params = {})
-      keys = scopes.map(&:param_keys).flatten
-      @params = params.dup
+      keys = scopes.map(&:param_keys).flatten.map(&:to_s)
+      @params = HashWithIndifferentAccess.new(params)
       @params.select! { |key, value| keys.include?(key) }
       @params.freeze
 
@@ -73,13 +77,13 @@ module Paraphrase
     #
     # @return [ActiveRecord::Relation, Array]
     def results
-      @results ||= begin
-                     results = scopes.inject(source) do |query, scope|
-                       scope.chain(self, @params, query)
-                     end
+      return @results if @results
+
+      results = scopes.inject(source.scoped) do |query, scope|
+        scope.chain(self, @params, query)
+      end
 
-                     @errors.any? ? [] : results
-                   end
+      @results = @errors.any? ? [] : results
     end
 
 

data/lib/paraphrase/syntax.rb

@@ -1,18 +1,21 @@
 module Paraphrase
   module Syntax
 
+    def self.extended(klass)
+      klass.instance_eval do
+        class_attribute :paraphraser, :instance_writer => false, :instance_reader => false
+      end
+    end
+
     # 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)
-      if mapping = Paraphrase.mapping(self.name.underscore)
-        mapping.scopes.clear
-        mapping.instance_eval(&block)
-      else
-        Paraphrase.register(self.name, &block)
-      end
+      klass = Class.new(Query, &block)
+      klass.source = self
+      self.paraphraser = klass
     end
 
 
@@ -20,7 +23,7 @@ module Paraphrase
     #
     # @param [Hash] params query parameters
     def paraphrase(params)
-      Paraphrase.query(self.name.underscore, params)
+      self.paraphraser.new(params)
     end
   end
 end

data/lib/paraphrase/version.rb

@@ -1,3 +1,3 @@
 module Paraphrase
-  VERSION = "0.3.2"
+  VERSION = "0.4.0"
 end

data/lib/paraphrase.rb

@@ -1,64 +1,3 @@
-require 'active_support/core_ext/module/attribute_accessors'
-require 'active_support/core_ext/hash/indifferent_access'
-require 'active_support/core_ext/string/inflections'
-
-module Paraphrase
-
-  @@mappings = {}.with_indifferent_access
-
-  # Allows for configuring multiple {Query} classes in a single block. Useful
-  # in an initializer.
-  def self.configure(&block)
-    yield self
-  end
-
-
-  # Retreive a registered Query subclass.
-  #
-  # @param [String, Symbol] name of the class underscored
-  # @return [Query]
-  def self.mapping(name)
-    @@mappings[name]
-  end
-
-
-  # Add a new subclass of Paraprhase::Query. The provided block is evaluated in
-  # the context of a Query subclass to define scope mappings.
-  #
-  # @param [String, Symbol] name name of the model in any inflector form
-  # @param [Proc] block defining mappings of scopes to keys for Query subclass
-  def self.register(name, &block)
-    klass = Class.new(Query, &block)
-    klass.paraphrases(name.to_s.classify)
-  end
-
-
-  # Register a subclass of Paraphrase::Query. Useful for manually subclassing
-  # Paraphrase::Query to add custom functionality.
-  #
-  # @param [String, Symbol] name name of the class in any ActiveSupport inflector form
-  # @param [Query] klass subclass of Paraphrase::Query
-  def self.add(name, klass)
-    name = name.to_s.underscore
-
-    if @@mappings[name]
-      raise DuplicateMappingError, "#{name.classify} has already been added"
-    end
-
-    @@mappings[name] = klass
-  end
-
-
-  # Instantiate a new Query subclass using supplied params
-  #
-  # @param [String, Symbol] name name of the model in underscored form
-  # @param [Hash] params hash of query params
-  # @return [Query]
-  def self.query(name, params)
-    @@mappings[name].new(params)
-  end
-end
-
 require 'paraphrase/errors'
 require 'paraphrase/query'
 require 'paraphrase/syntax'

data/spec/paraphrase/query_spec.rb

@@ -5,55 +5,55 @@ module Paraphrase
 
     describe ".paraphrases" do
       it "stores the class being queried" do
-        UserSearch.paraphrases :user
-        UserSearch.source.should eq User.scoped
-      end
-
-      it "registers the query in Paraphrase.querys" do
-        Paraphrase.mapping(:user).should eq UserSearch
+        AccountSearch.paraphrases :account
+        AccountSearch.source.should eq Account
       end
     end
 
     describe ".scope" do
       it "adds information to Query.scopes" do
-        UserSearch.instance_eval do
+        AccountSearch.instance_eval do
           scope :name_like, :key => :name
         end
 
-        UserSearch.scopes.should_not be_empty
+        AccountSearch.scopes.should_not be_empty
       end
 
       it "raises an error if a scope is added twice" do
-        expect { UserSearch.instance_eval { scope :name_like, :key => :name } }.to raise_error Paraphrase::DuplicateScopeError
+        expect { AccountSearch.instance_eval { scope :name_like, :key => :name } }.to raise_error Paraphrase::DuplicateScopeError
       end
     end
 
     describe "#initialize" do
-      it "filters out params not specified in scopes" do
-        query = UserSearch.new(:name => 'Tyrion Lannister', :nickname => 'Half Man')
+      let(:query) { AccountSearch.new(:name => 'Tyrion Lannister', :nickname => 'Half Man') }
 
+      it "filters out params not specified in scopes" do
         query.params.should_not have_key :nickname
         query.params.should have_key :name
       end
+
+      it "sets up params with indifferent access" do
+        query.params.should have_key 'name'
+      end
     end
 
     describe "#results" do
       before :all do
-        UserSearch.instance_eval do
+        AccountSearch.instance_eval do
           scope :title_like, :key => :title, :require => true
         end
       end
 
       it "loops through scope methods and applies them to source" do
-        User.should_receive(:title_like).and_return(User.scoped)
-        User.should_receive(:name_like).and_return(User.scoped)
+        Account.should_receive(:title_like).and_return(Account.scoped)
+        Account.should_receive(:name_like).and_return(Account.scoped)
 
-        query = UserSearch.new(:name => 'Jon Snow', :title => 'Wall Watcher')
+        query = AccountSearch.new(:name => 'Jon Snow', :title => 'Wall Watcher')
         query.results
       end
 
       it "returns empty array if errors were added" do
-        query = UserSearch.new
+        query = AccountSearch.new
         query.results.should eq []
         query.errors.should_not be_empty
       end

data/spec/paraphrase/syntax_spec.rb

@@ -4,24 +4,8 @@ module Paraphrase
   describe Syntax do
     describe ".register_mapping" do
       it "forwards to Paraphrase.register" do
-        ::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
-      it "forwards to Paraphrase.query" do
-        Paraphrase.should_receive(:query).with('account', {})
-        ::Account.paraphrase({})
+        Account.register_mapping {}
+        Account.paraphraser.should_not be_nil
       end
     end
   end

data/spec/spec_helper.rb

@@ -11,25 +11,13 @@ ActiveRecord::Base.silence do
   ActiveRecord::Migration.verbose = false
 
   ActiveRecord::Schema.define do
-    create_table(:users, :force => true) {}
     create_table(:accounts, :force => true) {}
-    create_table(:foobars, :force => true) {}
-    create_table(:people, :force => true) {}
   end
 end
 
-class Person < ActiveRecord::Base
-end
-
-class Foobar < ActiveRecord::Base
-end
-
 class Account < ActiveRecord::Base
   extend Paraphrase::Syntax
 end
 
-class User < ActiveRecord::Base
-end
-
-class UserSearch < Paraphrase::Query
+class AccountSearch < Paraphrase::Query
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paraphrase
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-05 00:00:00.000000000 Z
+date: 2012-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70289301081080 !ruby/object:Gem::Requirement
+  requirement: &70360247937200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70289301081080
+  version_requirements: *70360247937200
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70289301078480 !ruby/object:Gem::Requirement
+  requirement: &70360247936360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70289301078480
+  version_requirements: *70360247936360
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &70289301077280 !ruby/object:Gem::Requirement
+  requirement: &70360247934800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70289301077280
+  version_requirements: *70360247934800
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70289301067840 !ruby/object:Gem::Requirement
+  requirement: &70360247926020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *70289301067840
+  version_requirements: *70360247926020
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70289301066540 !ruby/object:Gem::Requirement
+  requirement: &70360247925260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: '0.7'
   type: :development
   prerelease: false
-  version_requirements: *70289301066540
+  version_requirements: *70360247925260
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70289301064900 !ruby/object:Gem::Requirement
+  requirement: &70360247924500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: '2.10'
   type: :development
   prerelease: false
-  version_requirements: *70289301064900
+  version_requirements: *70360247924500
 - !ruby/object:Gem::Dependency
   name: redcarpet
-  requirement: &70289301064000 !ruby/object:Gem::Requirement
+  requirement: &70360247923780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70289301064000
+  version_requirements: *70360247923780
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70289301063120 !ruby/object:Gem::Requirement
+  requirement: &70360247922620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70289301063120
+  version_requirements: *70360247922620
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70289301061980 !ruby/object:Gem::Requirement
+  requirement: &70360247921580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70289301061980
+  version_requirements: *70360247921580
 - !ruby/object:Gem::Dependency
   name: appraisal
-  requirement: &70289301061200 !ruby/object:Gem::Requirement
+  requirement: &70360247921160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,7 +120,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70289301061200
+  version_requirements: *70360247921160
 description: ! "\n                        Build customizable classes to determine
   which scope\n                        methods to call based on supplied parameters.\n
   \                     "
@@ -155,7 +155,6 @@ files:
 - spec/paraphrase/query_spec.rb
 - spec/paraphrase/scope_mapping_spec.rb
 - spec/paraphrase/syntax_spec.rb
-- spec/paraphrase_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/ecbypi/paraphrase
 licenses:
@@ -186,6 +185,5 @@ test_files:
 - spec/paraphrase/query_spec.rb
 - spec/paraphrase/scope_mapping_spec.rb
 - spec/paraphrase/syntax_spec.rb
-- spec/paraphrase_spec.rb
 - spec/spec_helper.rb
 has_rdoc: 

data/spec/paraphrase_spec.rb

@@ -1,43 +0,0 @@
-require 'spec_helper'
-
-describe Paraphrase do
-
-  describe ".configure" do
-    it "is a convenience method for configuring multiple query classes" do
-      Paraphrase.configure do |mapping|
-        mapping.register(:person) {}
-      end
-
-      Paraphrase.mapping(:person).should_not be_nil
-    end
-  end
-
-  describe ".register" do
-    it "a sublcass of Paraphrase::Query to @@mappings" do
-      Paraphrase.register(:foobar) {}
-      Paraphrase.mapping(:foobar).should_not be_nil
-    end
-
-    it "adds the source to the new subclass" do
-      Paraphrase.mapping(:foobar).source.should eq Foobar.scoped
-    end
-
-    it "raises an error if mappings for a class are added twice" do
-      expect { Paraphrase.register(:foobar) {} }.to raise_error Paraphrase::DuplicateMappingError
-    end
-  end
-
-  describe ".query" do
-    it "instantiates a new Query class" do
-      Paraphrase.query(:foobar, {}).should be_a Paraphrase::Query
-    end
-  end
-
-  describe ".add" do
-    it "adds class to mapping with specified name" do
-      klass = Class.new(Paraphrase::Query)
-      Paraphrase.add(:baz, klass)
-      Paraphrase.mapping(:baz).should eq klass
-    end
-  end
-end