merge_params 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d02292b14bbd8378da9306edaaf9ba131f54bf7a638ce247c96db14f10ef7e80
-  data.tar.gz: f86ffa29a81b4d8d427f99757f18ee4b505727830c7fb8b8e3459bd8fe4e3d1b
+  metadata.gz: 50468b8b15c7c21253bc50acaaa50f423eb45f012373ec5d09e96d8477fa115d
+  data.tar.gz: a3733c9745be932c2c7792aee32966a8cb5b7c36a67785b63afe9094e8858a74
 SHA512:
-  metadata.gz: f14c18536515ec20bc11ab826acb0eabf8b417ee485a844eb3cb9fbf9e0d7ee24428e146f2f42ca79f10281cb68d12c1d0faca6159869634c65e3b9292827cac
-  data.tar.gz: e4c02db3a74fdb11ecc5b2ff4aa8a0ad65e0c2615af1c6338a6df4afc67e968391e1aa5a7f76b37c2f90f2b5f3e03e5aef8abe82ab8a005a53cbdea2acc0169f
+  metadata.gz: 458352f9fae2cc4f410886360880c8261466d1c1358bc52cbb40f6bc79268c1752a5a6962308ce34021da751eb392b6c46b4b78bfcc95a9ce53a6aecb2e6dfc4
+  data.tar.gz: da60236fa26260b6d227b7923b7562f455962256f247e6fff84fdbb1c5f6008f6d2b9f653f22452bc6df0472ce1463e97e8f61f247862d433d64636ab060e05b

data/Changelog.md

@@ -5,6 +5,14 @@ recommendations of [keepachangelog.com](http://keepachangelog.com/).
 
 ## (Unreleased)
 
+## 0.4.0 (2019-02-07)
+
+### Added/Changed
+- Better support for nested hashes: Using `deep_symbolize_keys` instead of `symbolize_keys`.
+- Allow keys in nested hashes to be deleted by setting their value to nil
+- Add `params_from_url(url)` helper
+- Allow a hash to be passed as an argument to `params_for_url_for`
+- Add dependency on `facets` gem
 
 ## 0.3.0 (2019-01-24)
 

data/lib/facets/hash/recursively_comparing.rb

@@ -0,0 +1,31 @@
+require 'facets/hash/recursively'
+
+class Hash
+  def recursively_comparing(other_enum, path: [], &block)
+    ComparingRecursor.new(self, other_enum, &block)
+  end
+
+  class ComparingRecursor < Enumerable::Recursor #:nodoc:
+    def initialize(enum, other_enum, *types, &block)
+      @other_enum = other_enum
+      super(enum, *types, &block)
+    end
+    def method_missing(op, &yld)
+      yld = yld    || lambda{ |k,v| [k,v] }  # ? to_enum
+      rec = @block || yld #lambda{ |k,v| [k,v] }
+      @enum.__send__(op) do |k,v|
+        other_v = @other_enum.dig(k)
+        #puts %(#{@enum.inspect}: k=#{k.inspect}, v=#{v.inspect}, other_v=#{other_v.inspect})
+        case v
+        when String # b/c of 1.8
+          yld.call(k, v, other_v)
+        when *@types
+          res = v.recursively_comparing(other_v, &@block).__send__(op,&yld)
+          rec.call(k, res, other_v)
+        else
+          yld.call(k, v, other_v)
+        end
+      end
+    end
+  end
+end

data/lib/merge_params/helpers.rb

@@ -1,25 +1,30 @@
 require 'uri'
+require 'facets/hash/deep_merge'
+require 'facets/hash/recurse'
+require 'facets/hash/recursively_comparing'
+require 'facets/enumerable/graph'
+require 'facets/hash/graph'
 
 module MergeParams::Helpers
   extend ActiveSupport::Concern
 
   # request.parameters but with symbolized keys.
   def request_params
-    request.parameters.symbolize_keys
+    request.parameters.deep_symbolize_keys
   end
 
   # request.parameters (which also includes POST params) but with only those keys that would
   # normally be passed in a query string (without :controller, :action, :format) and with symbolized
   # keys.
   def query_params_from_request_params
-    request.parameters.symbolize_keys.
-      except(*request.path_parameters.symbolize_keys.keys)
+    request.parameters.deep_symbolize_keys.
+      except(*request.path_parameters.deep_symbolize_keys.keys)
   end
 
   # Returns a hash of params from the query string (https://en.wikipedia.org/wiki/Query_string),
   # with symbolized keys.
   def query_params
-    request.query_parameters.symbolize_keys
+    request.query_parameters.deep_symbolize_keys
   end
 
   # Params that can safely be passed to url_for to build a route. (Used by merge_url_for.)
@@ -40,8 +45,9 @@ module MergeParams::Helpers
   # (And we don't even need to pass the path_parameters on to url_for because url_for already
   # includes those (from :_recall)
   #
-  def params_for_url_for
-    params.to_unsafe_h.symbolize_keys.except(
+  def params_for_url_for(params = params())
+    params = params.to_unsafe_h if params.respond_to?(:to_unsafe_h)
+    params.deep_symbolize_keys.except(
       *ActionDispatch::Routing::RouteSet::RESERVED_OPTIONS,
       :controller,
       :action,
@@ -51,7 +57,8 @@ module MergeParams::Helpers
 
   # Safely merges the given params with the params from the current request
   def merge_params(new_params = {})
-    params_for_url_for.merge(new_params)
+    params_for_url_for.
+      merge(new_params.deep_symbolize_keys)
   end
 
   # Easily extract just certain param keys.
@@ -83,31 +90,31 @@ module MergeParams::Helpers
   def merge_url_for(new_params = {})
     url = url_for(merge_params(new_params))
 
-    # Now pass along in the *query string* any params that we couldn't pass to url_for because they
-    # were reserved options.
-    query_params_already_added = parse_nested_query(URI(url).query || '')
-    # Some params from new_params (like company_id) that we pass in may be recognized by a route and
-    # therefore no longer be query params. We use recognize_path to find those params that ended up
-    # as route params instead of query_params but are nonetheless aready added to the url.
-    params_already_added = Rails.application.routes.recognize_path(url).merge(query_params_already_added)
-    keys_already_added = params_already_added.keys
-    # Allow keys that are currently in query_params to be deleted by setting their value to nil in
-    # new_params.
-    keys_to_delete = new_params.select {|k,v| v.nil?}.keys
-    query_params_to_add = query_params.except(*keys_already_added + keys_to_delete)
+#    # Now pass along in the *query string* any params that we couldn't pass to url_for because they
+#    # were reserved options.
+#    query_params_already_added = parse_nested_query(URI(url).query || '')
+#    # Some params from new_params (like company_id) that we pass in may be recognized by a route and
+#    # therefore no longer be query params. We use recognize_path to find those params that ended up
+#    # as route params instead of query_params but are nonetheless already added to the url.
+#    params_already_added = Rails.application.routes.recognize_path(url).merge(query_params_already_added)
+    params_already_added = params_from_url(url)
+    query_params_to_add = new_params.recursively_comparing(params_already_added).graph { |k,v, other|
+      if v.is_a?(Hash) || v.nil? || other.nil?
+        [k, v]
+      end
+    }
     add_params(query_params_to_add, url)
   end
 
   # Adds params to the query string
   # (Unlike url_for_merge, which tries to generate a route from the params.)
-  # TODO: Should URL be first like https://libraries.io/github/jordanmaguire/uri_query_merger ?
-  #   UriQueryMerger.new("http://www.google.com?other=1", {jordan: "rules"}).merge
-  # Can we make it work that way when a URL is supplied buth otherwise let the params be the first
-  # and only argument (to optimize for that more common use case)?
-  def add_params(params = {}, url = request.fullpath)
+  def add_params(new_params = {}, url = request.fullpath)
     uri = URI(url)
-    params    = parse_nested_query(uri.query || '').merge(params)
-    uri.query = Rack::Utils.build_nested_query(params) if params.present?
+    # Allow keys that are currently in query_params to be deleted by setting their value to nil in
+    # new_params (including in nested hashes).
+    merged_params = parse_nested_query(uri.query || '').
+      deep_merge(new_params).recurse(&:compact)
+    uri.query = Rack::Utils.build_nested_query(merged_params).presence
     uri.to_s
   end
 
@@ -121,9 +128,16 @@ module MergeParams::Helpers
     ) if respond_to?(:helper_method)
   end
 
-private
+  # Parsing helpers
+  def params_from_url(url)
+    query_params = parse_nested_query(URI(url).query || '')
+    route_params = Rails.application.routes.recognize_path(url.to_s)
+    params_for_url_for(
+      route_params.merge(query_params)
+    )
+  end
 
   def parse_nested_query(query)
-    Rack::Utils.parse_nested_query(query || '').symbolize_keys
+    Rack::Utils.parse_nested_query(query || '').deep_symbolize_keys
   end
 end

data/lib/merge_params/version.rb

@@ -1,5 +1,5 @@
 module MergeParams
   def self.version
-    "0.3.0"
+    "0.4.0"
   end
 end

data/merge_params.gemspec

@@ -29,6 +29,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 2.3.0"
   spec.add_dependency "activesupport", [">= 4.2", "< 5.3"]
   spec.add_dependency "actionpack", [">= 4.2", "< 5.3"]
+  spec.add_dependency "facets"
 
   spec.add_development_dependency "bundler", "~> 1.17"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: merge_params
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Tyler Rick
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-25 00:00:00.000000000 Z
+date: 2019-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -50,6 +50,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '5.3'
+- !ruby/object:Gem::Dependency
+  name: facets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -109,6 +123,7 @@ files:
 - Readme.md
 - bin/console
 - bin/setup
+- lib/facets/hash/recursively_comparing.rb
 - lib/merge_params.rb
 - lib/merge_params/helpers.rb
 - lib/merge_params/version.rb