paraphrase 0.13.0 → 0.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43ecedf4659ea90875e14caa3f42c0a4c038dfdd7f3b52521fd60219275a779c
-  data.tar.gz: daa305cc3762548d156e03b988efa086793c1b74dabd9201ceb205042c904a10
+  metadata.gz: 3e88857c04d639004cb135da22ea4c6633b94b810a7f3a5d32a118d41d1702a9
+  data.tar.gz: 6374a8407974747997ce431d12ef6aa9aedd672e6f800c2d1a314d4f2edfdd47
 SHA512:
-  metadata.gz: e74d5856ec1dea6a7b31684008302ba1e873633083a376a2b161054347ac6fdb83b0838b90fe5cdaee38a67d8ad6fee07cdef0a45d763fa51b19b9dfcd87bdaa
-  data.tar.gz: 57787b886775a26c1afe0f8784fed1dc223a6f33b6b89c485e446936d30f75cf4813d786a074f7c68c25990554aed146a5cdbd1eda261a30100bf3077709d441
+  metadata.gz: 4f8d982b5b0af890c2f61fb9d7811ba017d85311b6204581a6dad9ed63331eaf2853c12e2afee9dd7615cb689c258a104e320d1497998062a413b8e435a536a9
+  data.tar.gz: 1445af920f0ddaa4c90ea42889dec9e17d850db3bd000eafb5dbcfb5b589a9fe83220b09b50b9948128d2cb46d76d659130c2e4c8b49fd535c1bf408b712944d

data/.gitignore

@@ -4,3 +4,4 @@ doc/
 vendor/cache/*.gem
 .yardoc
 coverage
+.byebug_history

data/.travis.yml

@@ -13,6 +13,3 @@ before_install:
   - gem update --system
   - gem install bundler
 script: 'bundle exec rake'
-matrix:
-  allow_failures:
-    - gemfile: gemfiles/5.2.gemfile

data/Appraisals

@@ -14,7 +14,7 @@ appraise '5.1' do
 end
 
 appraise '5.2' do
-  gem 'activerecord', '~> 5.2.0.rc2'
-  gem 'activesupport', '~> 5.2.0.rc2'
-  gem 'actionpack', '~> 5.2.0.rc2'
+  gem 'activerecord', '~> 5.2.0'
+  gem 'activesupport', '~> 5.2.0'
+  gem 'actionpack', '~> 5.2.0'
 end

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## Unreleased
 
+## [0.13.1] - 2018-04-12
+### Added
+* Add `Query#[]` for easier, validated lookup of `params` values.
+* Support released version of rails 5.2
+
+### Fixed
+* Correctly handle `ActionController::Parameters` in `ParamsFilter` processing.
+
 ## [0.13.0] - 2018-04-09
 ### Removed
 * Support for ruby < 2.3

data/gemfiles/4.2.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    paraphrase (0.13.0)
+    paraphrase (0.13.1)
       activemodel (>= 4.2, < 6.0)
       activerecord (>= 4.2, < 6.0)
       activesupport (>= 4.2, < 6.0)
@@ -40,6 +40,7 @@ GEM
       thor (>= 0.14.0)
     arel (6.0.4)
     builder (3.2.3)
+    byebug (10.0.2)
     coderay (1.1.2)
     concurrent-ruby (1.0.5)
     crass (1.0.4)
@@ -100,13 +101,14 @@ DEPENDENCIES
   activesupport (~> 4.2.0)
   appraisal (>= 1.0)
   bundler (~> 1.0)
+  byebug (~> 10.0)
   paraphrase!
   pry (~> 0.9)
   rake (~> 12.3)
   redcarpet (~> 3.2)
   rspec (~> 3.0)
   sqlite3 (~> 1.3.6)
-  yard (~> 0.7)
+  yard (~> 0.9)
 
 BUNDLED WITH
    1.16.1

data/gemfiles/5.0.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    paraphrase (0.13.0)
+    paraphrase (0.13.1)
       activemodel (>= 4.2, < 6.0)
       activerecord (>= 4.2, < 6.0)
       activesupport (>= 4.2, < 6.0)
@@ -39,6 +39,7 @@ GEM
       thor (>= 0.14.0)
     arel (7.1.4)
     builder (3.2.3)
+    byebug (10.0.2)
     coderay (1.1.2)
     concurrent-ruby (1.0.5)
     crass (1.0.4)
@@ -96,13 +97,14 @@ DEPENDENCIES
   activesupport (~> 5.0.0)
   appraisal (>= 1.0)
   bundler (~> 1.0)
+  byebug (~> 10.0)
   paraphrase!
   pry (~> 0.9)
   rake (~> 12.3)
   redcarpet (~> 3.2)
   rspec (~> 3.0)
   sqlite3 (~> 1.3.6)
-  yard (~> 0.7)
+  yard (~> 0.9)
 
 BUNDLED WITH
    1.16.1

data/gemfiles/5.1.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    paraphrase (0.13.0)
+    paraphrase (0.13.1)
       activemodel (>= 4.2, < 6.0)
       activerecord (>= 4.2, < 6.0)
       activesupport (>= 4.2, < 6.0)
@@ -39,6 +39,7 @@ GEM
       thor (>= 0.14.0)
     arel (8.0.0)
     builder (3.2.3)
+    byebug (10.0.2)
     coderay (1.1.2)
     concurrent-ruby (1.0.5)
     crass (1.0.4)
@@ -96,13 +97,14 @@ DEPENDENCIES
   activesupport (~> 5.1.0)
   appraisal (>= 1.0)
   bundler (~> 1.0)
+  byebug (~> 10.0)
   paraphrase!
   pry (~> 0.9)
   rake (~> 12.3)
   redcarpet (~> 3.2)
   rspec (~> 3.0)
   sqlite3 (~> 1.3.6)
-  yard (~> 0.7)
+  yard (~> 0.9)
 
 BUNDLED WITH
    1.16.1

data/gemfiles/5.2.gemfile

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

data/gemfiles/5.2.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    paraphrase (0.13.0)
+    paraphrase (0.13.1)
       activemodel (>= 4.2, < 6.0)
       activerecord (>= 4.2, < 6.0)
       activesupport (>= 4.2, < 6.0)
@@ -9,26 +9,26 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (5.2.0.rc2)
-      actionview (= 5.2.0.rc2)
-      activesupport (= 5.2.0.rc2)
+    actionpack (5.2.0)
+      actionview (= 5.2.0)
+      activesupport (= 5.2.0)
       rack (~> 2.0)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.2.0.rc2)
-      activesupport (= 5.2.0.rc2)
+    actionview (5.2.0)
+      activesupport (= 5.2.0)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activemodel (5.2.0.rc2)
-      activesupport (= 5.2.0.rc2)
-    activerecord (5.2.0.rc2)
-      activemodel (= 5.2.0.rc2)
-      activesupport (= 5.2.0.rc2)
+    activemodel (5.2.0)
+      activesupport (= 5.2.0)
+    activerecord (5.2.0)
+      activemodel (= 5.2.0)
+      activesupport (= 5.2.0)
       arel (>= 9.0)
-    activesupport (5.2.0.rc2)
+    activesupport (5.2.0)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
@@ -39,6 +39,7 @@ GEM
       thor (>= 0.14.0)
     arel (9.0.0)
     builder (3.2.3)
+    byebug (10.0.2)
     coderay (1.1.2)
     concurrent-ruby (1.0.5)
     crass (1.0.4)
@@ -91,18 +92,19 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  actionpack (~> 5.2.0.rc2)
-  activerecord (~> 5.2.0.rc2)
-  activesupport (~> 5.2.0.rc2)
+  actionpack (~> 5.2.0)
+  activerecord (~> 5.2.0)
+  activesupport (~> 5.2.0)
   appraisal (>= 1.0)
   bundler (~> 1.0)
+  byebug (~> 10.0)
   paraphrase!
   pry (~> 0.9)
   rake (~> 12.3)
   redcarpet (~> 3.2)
   rspec (~> 3.0)
   sqlite3 (~> 1.3.6)
-  yard (~> 0.7)
+  yard (~> 0.9)
 
 BUNDLED WITH
    1.16.1

data/lib/paraphrase.rb

@@ -1,13 +1,31 @@
 module Paraphrase
   class DuplicateMappingError < StandardError
     def initialize(scope_name)
-      @message = "scope :#{scope_name} has already been mapped"
+      @scope_name = scope_name
+    end
+
+    def 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`"
+      @query_name = query_name
+    end
+
+    def message
+      "No query class found. #{@query_name} must be defined as a subclass of `Paraphrase::Query`"
+    end
+  end
+
+  class UndefinedKeyError < StandardError
+    def initialize(invalid_key, keys)
+      @invalid_key, @keys = invalid_key, keys
+    end
+
+    def message
+      "key `#{@invalid_key}' is not a valid key for this query; valid keys are: #{@keys.join(', ')}"
     end
   end
 end

data/lib/paraphrase/params_filter.rb

@@ -17,14 +17,14 @@ module Paraphrase
   # can be re-opened inside the {Query} class definition or by calling the
   # {Query.param param} class method.
   class ParamsFilter
-    attr_reader :params, :result
-
-    def initialize(unfiltered_params, keys)
-      @params = unfiltered_params.with_indifferent_access.slice(*keys)
+    def initialize(params, keys)
+      @keys = keys
+      @params = params
+    end
 
-      @result = keys.inject(HashWithIndifferentAccess.new) do |result, key|
-        value = respond_to?(key) ? send(key) : @params[key]
-        value = scrub(value)
+    def result
+      @keys.inject(ActiveSupport::HashWithIndifferentAccess.new) do |result, key|
+        value = scrub(public_send(key))
 
         if value.present?
           result[key] = value
@@ -34,6 +34,14 @@ module Paraphrase
       end
     end
 
+    def [](key)
+      @params[key.to_sym] || @params[key.to_s]
+    end
+
+    def params
+      self
+    end
+
     private
 
     def scrub(value)

data/lib/paraphrase/query.rb

@@ -3,7 +3,6 @@ require 'active_support/core_ext/class/attribute'
 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/mapping'
@@ -68,6 +67,10 @@ module Paraphrase
 
       keys.each do |key|
         define_method(key) { params[key] }
+
+        params_filter.class_eval do
+          define_method(key) { params[key] }
+        end
       end
     end
 
@@ -105,6 +108,17 @@ module Paraphrase
       end
     end
 
+    # Look up a `params` value
+    #
+    # @param [String,Symbol] key key to read
+    def [](key)
+      unless keys.include?(key.to_sym)
+        raise UndefinedKeyError.new(key, keys)
+      end
+
+      params[key]
+    end
+
     # Return an `ActiveRecord::Relation` corresponding to the source class
     # determined from the `source` class attribute that defaults to the name of
     # the class.

data/lib/paraphrase/version.rb

@@ -1,3 +1,3 @@
 module Paraphrase
-  VERSION = "0.13.0"
+  VERSION = "0.13.1"
 end

data/paraphrase.gemspec

@@ -30,7 +30,8 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency 'actionpack', '>= 4.2', '< 6.0'
   gem.add_development_dependency 'bundler', '~> 1.0'
-  gem.add_development_dependency 'yard', '~> 0.7'
+  gem.add_development_dependency "byebug", "~> 10.0"
+  gem.add_development_dependency 'yard', '~> 0.9'
   gem.add_development_dependency 'rspec', '~> 3.0'
   gem.add_development_dependency "rake", "~> 12.3"
   gem.add_development_dependency "appraisal", ">= 1.0"

data/spec/paraphrase/query_spec.rb

@@ -1,5 +1,6 @@
 require 'spec_helper'
 require 'action_view/test_case'
+require "action_controller/metal/strong_parameters"
 
 module Paraphrase
   describe Query do
@@ -155,6 +156,29 @@ module Paraphrase
       expect(result).not_to include green_post
     end
 
+    it "works with ActionController::Parameters" do
+      query = PostQuery.new(ActionController::Parameters.new(title: "D3 How-To"))
+
+      expect(query.params).to have_key "title"
+    end
+
+    it "handles symbol or string keys when filtering params" do
+      query = PostQuery.new(title: "Top 10", "authors" => "Andre")
+
+      expect(query.params[:title]).to eq "Top 10"
+      expect(query.params[:authors]).to eq "Andre"
+    end
+
+    describe "#[]" do
+      it "raises if argument is not in set of defined keys" do
+        query = PostQuery.new(title: "Another How-To", authors: ["jim"])
+
+        expect(query["authors"]).to eq ["jim"]
+        expect(query[:title]).to eq "Another How-To"
+        expect { query["sorted_by"] }.to raise_error Paraphrase::UndefinedKeyError
+      end
+    end
+
     describe 'is action view compliant' do
       it 'by working with form builders' do
         router = ActionDispatch::Routing::RouteSet.new

data/spec/spec_helper.rb

@@ -1,10 +1,6 @@
-if ENV.key?('CODECLIMATE_REPO_TOKEN')
-  require 'codeclimate-test-reporter'
-  CodeClimate::TestReporter.start
-end
-
 require 'rspec'
 require 'pry'
+require "byebug"
 require 'paraphrase'
 require 'active_record'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paraphrase
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.13.1
 platform: ruby
 authors:
 - Eduardo Gutierrez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-09 00:00:00.000000000 Z
+date: 2018-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -104,20 +104,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement