paraphrase 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 54d269a79cf5f4ab55d4afe39c4f9e0c4dd6841f
-  data.tar.gz: e95b97c71c317d9e6f534bb7dcfb10037cde2bfe
+  metadata.gz: 7eee455eab9622de9d86136dfe8d1b5b766373e1
+  data.tar.gz: fbba2474e3febdd44f4937347cdf14888de70125
 SHA512:
-  metadata.gz: f69b9ef6eb394171092763aa92144d0f044e0f7668c374a4d609da84d0a2e163d39fa2679771fa9a32894150a8a478002d531acd6f3ff139c521742fa5494b75
-  data.tar.gz: 93221d4cd686cd4f7a84d958df0608264a4869045ce891239e4dc47d7330c68c2712faf6a049fde322cd3f79fd938e709caf0bea14a96e45822a395ca6d35ce4
+  metadata.gz: 146a851d81c039939c2ba35688aaf55e01bc85bf2d3608a1d5441668aee600e37d46cc03aa8eb51b672e77de9fe1704829b239b3e3dd4f44222a3ad1cfc35711
+  data.tar.gz: d383c9f1d43cd46e979618feb616c34dcc1acd58fdb70b51c9438cf313aef93540f132422712b6f8f6e2ac240dbe259bb9cf65235cb02cb0c7c248beac681e5f

data/.travis.yml

@@ -3,8 +3,8 @@ rvm:
   - 2.0.0
   - 2.1.1
   - jruby-19mode
+  - rbx-2
 gemfile:
-  - gemfiles/3.0.gemfile
   - gemfiles/3.1.gemfile
   - gemfiles/3.2.gemfile
   - gemfiles/4.0.gemfile
@@ -15,3 +15,6 @@ env:
   global:
     # Code Climate coverage reporting
     - secure: "VylP1haJogwCq04GRrM3hVfNT4YJiZ4RJoklOQLgqPMRalOCzVPOIRoTz3qpVbdQHf3l18VhVDrDbu2W2qfBKJq7/anIuYYgPd0uRAGliZD4h5B2PgQDqvPeTEftj/g3IYDh6PvZCuhgnxMdldmSnxd9WAjAnkLtjoiLgE6elCE="
+matrix:
+  allow_failures:
+    - rvm: rbx-2

data/Appraisals

@@ -1,29 +1,23 @@
-appraise '3.0' do
-  gem 'activerecord', '~> 3.0'
-  gem 'activesupport', '~> 3.0'
-  gem 'actionpack', '~> 3.0'
-end
-
 appraise '3.1' do
-  gem 'activerecord', '~> 3.1'
-  gem 'activesupport', '~> 3.1'
-  gem 'actionpack', '~> 3.1'
+  gem 'activerecord', '~> 3.1.0'
+  gem 'activesupport', '~> 3.1.0'
+  gem 'actionpack', '~> 3.1.0'
 end
 
 appraise '3.2' do
-  gem 'activerecord', '~> 3.2'
-  gem 'activesupport', '~> 3.2'
-  gem 'actionpack', '~> 3.2'
+  gem 'activerecord', '~> 3.2.0'
+  gem 'activesupport', '~> 3.2.0'
+  gem 'actionpack', '~> 3.2.0'
 end
 
 appraise '4.0' do
-  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'
 end
 
 appraise '4.1' do
-  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'
 end

data/CHANGELOG.md

@@ -1,4 +1,16 @@
-## 0.9.0
+## Next Release
+
+* Add convenience class-level API for pre-processing query params
+* Pre-process params and then scrub them from
+* Rename `Scope` to the more appropriate `Mapping`
+* Mark `Mapping` and `ActiveModel` classes as private API
+* Add ability to define scopes in the `Query` subclass via `Paraphrase::Repository`
+  (see README)
+* Refactor `Query.source` to be a regular class attribute
+* Require `Paraphrase::Query` be initialized with an `ActiveRecord::Relation`
+  instance. Ensure this happens in `Paraphrase::Syntax`.
+
+## 0.9.0 / 5-2-2014
 
 * Define methods to process query params on a subclass of `Paraphrase::Params`
   that also handles filtering blank query params.

data/README.md

@@ -42,7 +42,7 @@ symbol to the `source` method.
 # app/queries/admin_post_query.rb
 class AdminPostQuery < Paraphrase::Query
   # This needs the source specific since it will look for an `AdminPost` model.
-  source :Post
+  self.source = :Post
 end
 ```
 
@@ -196,23 +196,26 @@ Post.paraphrase(published: '1').to_sql
 
 ### Pre-processing Query Params
 
-By default, for each query param specified that maps to a model scope, a method
-is defined on the query class that fetches the value for that key. To pre-process a
-query param, such as an ISO formatted date, override the method in the query
-class.
+To pre-process a query param, such as an ISO formatted date, you can either use
+the `param` class method or re-open the `ParamsFilter` class that is defined
+when inheriting from `Paraphrase::Query`. Using the `param` class method
+defines the equivalent method on the `ParamsFilter` class.
+
+In the method, you have access to the `params` attribute that represents the
+original, unprocessed params.
 
 ```ruby
 class PostQuery < Paraphrase::Query
   map :start_date, :end_date, to: :published_within
 
-  class Params < Paraphrase::Params
+  class ParamsFilter
     def start_date
-      @start_date ||= Time.zone.parse(params[:start_date]) rescue nil
+      Time.zone.parse(params[:start_date]) rescue nil
     end
+  end
 
-    def end_date
-      @start_date ||= Time.zone.parse(params[:end_date]) rescue nil
-    end
+  param :end_date do
+    Time.zone.parse(params[:end_date]) rescue nil
   end
 end
 
@@ -230,9 +233,48 @@ In the above example, if either `:start_date` or `:end_date` are incorrectly
 formatted, the `pubished_within` scope will not be applied because the values
 are will be `nil`.
 
+### Define scopes on the `Query` class
+
+If your model is cluttered with scopes that aren't general-purpose, and only
+used by your query class, you can define them in the query class. You can
+define scopes by re-opening the `Repository` class defined on inheritance from
+`Paraphrase::Query`. There is also the `scope` class method that serves as a
+proxy for defining methods on the `Repository` class.
+
+In the method, you have to call the scope on the `relation` property of the
+`Repository` instance.
+
+```ruby
+class PostQuery < Paraphrase::Query
+  map :title, to: :titled
+  map :authors, to: :by_users
+  map :is_published, to: :published
+
+  scope :by_users do |authors|
+    relation.joins(:user).where(users: { name: authors })
+  end
+
+  # OR
+  # class Repository
+  #   def by_users(authors)
+  #     relation.joins(:user).where(users: { name: authors })
+  #   end
+  # end
+end
+
+class Post < ActiveRecord::Base
+end
+
+Post.paraphrase(authors: ['Robert', 'Susie']).to_sql
+# => SELECT "posts".* FROM "posts"
+#    INNER JOIN "users" ON "users"."id" = "posts"."user_id"
+#    WHERE "users"."name" IN ('Robert', 'Susie')
+```
+
 ### Using with `FormBuilder`
 
-The `Paraphrase::Query` class implements the `ActiveModel` API required for use with form builders.
+The `Paraphrase::Query` class implements the `ActiveModel` API required for use
+with form builders.
 
 ```ruby
 class PostQuery < Paraphrase::Query

data/gemfiles/3.1.gemfile

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

data/gemfiles/3.1.gemfile.lock

@@ -1,39 +1,40 @@
 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 (3.2.16)
-      activemodel (= 3.2.16)
-      activesupport (= 3.2.16)
+    actionpack (3.1.12)
+      activemodel (= 3.1.12)
+      activesupport (= 3.1.12)
       builder (~> 3.0.0)
       erubis (~> 2.7.0)
-      journey (~> 1.0.4)
-      rack (~> 1.4.5)
+      i18n (~> 0.6)
+      rack (~> 1.3.6)
       rack-cache (~> 1.2)
+      rack-mount (~> 0.8.2)
       rack-test (~> 0.6.1)
-      sprockets (~> 2.2.1)
-    activemodel (3.2.16)
-      activesupport (= 3.2.16)
+      sprockets (~> 2.0.4)
+    activemodel (3.1.12)
+      activesupport (= 3.1.12)
       builder (~> 3.0.0)
-    activerecord (3.2.16)
-      activemodel (= 3.2.16)
-      activesupport (= 3.2.16)
-      arel (~> 3.0.2)
+      i18n (~> 0.6)
+    activerecord (3.1.12)
+      activemodel (= 3.1.12)
+      activesupport (= 3.1.12)
+      arel (~> 2.2.3)
       tzinfo (~> 0.3.29)
-    activesupport (3.2.16)
-      i18n (~> 0.6, >= 0.6.4)
+    activesupport (3.1.12)
       multi_json (~> 1.0)
     appraisal (0.5.2)
       bundler
       rake
-    arel (3.0.3)
+    arel (2.2.3)
     builder (3.0.4)
     codeclimate-test-reporter (0.3.0)
       simplecov (>= 0.7.1, < 1.0.0)
@@ -43,51 +44,55 @@ GEM
     erubis (2.7.0)
     hike (1.2.3)
     i18n (0.6.9)
-    journey (1.0.4)
     method_source (0.8.2)
-    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)
-    rack (1.4.5)
+    rack (1.3.10)
     rack-cache (1.2)
       rack (>= 0.4)
+    rack-mount (0.8.3)
+      rack (>= 1.0.0)
     rack-test (0.6.2)
       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)
-    sprockets (2.2.2)
+    slop (3.5.0)
+    sprockets (2.0.4)
       hike (~> 1.2)
-      multi_json (~> 1.0)
       rack (~> 1.0)
       tilt (~> 1.1, != 1.3.0)
-    sqlite3 (1.3.8)
+    sqlite3 (1.3.9)
     tilt (1.4.1)
-    tzinfo (0.3.38)
-    yard (0.8.7.3)
+    tzinfo (0.3.39)
+    yard (0.8.7.4)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  actionpack (~> 3.1)
-  activerecord (~> 3.1)
-  activesupport (~> 3.1)
+  actionpack (~> 3.1.0)
+  activerecord (~> 3.1.0)
+  activesupport (~> 3.1.0)
   appraisal (~> 0.4)
   bundler (~> 1.0)
   codeclimate-test-reporter (~> 0.3)
@@ -95,6 +100,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/3.2.gemfile

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

data/gemfiles/3.2.gemfile.lock

@@ -1,17 +1,17 @@
 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 (3.2.16)
-      activemodel (= 3.2.16)
-      activesupport (= 3.2.16)
+    actionpack (3.2.18)
+      activemodel (= 3.2.18)
+      activesupport (= 3.2.18)
       builder (~> 3.0.0)
       erubis (~> 2.7.0)
       journey (~> 1.0.4)
@@ -19,15 +19,15 @@ GEM
       rack-cache (~> 1.2)
       rack-test (~> 0.6.1)
       sprockets (~> 2.2.1)
-    activemodel (3.2.16)
-      activesupport (= 3.2.16)
+    activemodel (3.2.18)
+      activesupport (= 3.2.18)
       builder (~> 3.0.0)
-    activerecord (3.2.16)
-      activemodel (= 3.2.16)
-      activesupport (= 3.2.16)
+    activerecord (3.2.18)
+      activemodel (= 3.2.18)
+      activesupport (= 3.2.18)
       arel (~> 3.0.2)
       tzinfo (~> 0.3.29)
-    activesupport (3.2.16)
+    activesupport (3.2.18)
       i18n (~> 0.6, >= 0.6.4)
       multi_json (~> 1.0)
     appraisal (0.5.2)
@@ -45,8 +45,8 @@ GEM
     i18n (0.6.9)
     journey (1.0.4)
     method_source (0.8.2)
-    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)
@@ -57,37 +57,41 @@ 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)
+    slop (3.5.0)
     sprockets (2.2.2)
       hike (~> 1.2)
       multi_json (~> 1.0)
       rack (~> 1.0)
       tilt (~> 1.1, != 1.3.0)
-    sqlite3 (1.3.8)
+    sqlite3 (1.3.9)
     tilt (1.4.1)
-    tzinfo (0.3.38)
-    yard (0.8.7.3)
+    tzinfo (0.3.39)
+    yard (0.8.7.4)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  actionpack (~> 3.2)
-  activerecord (~> 3.2)
-  activesupport (~> 3.2)
+  actionpack (~> 3.2.0)
+  activerecord (~> 3.2.0)
+  activesupport (~> 3.2.0)
   appraisal (~> 0.4)
   bundler (~> 1.0)
   codeclimate-test-reporter (~> 0.3)
@@ -95,6 +99,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)