merge_params 0.2.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 60f0644a975a59c156bcd0324be1f7a08e07d1bc
-  data.tar.gz: d2bdd9e4ab258fabb6025bfd49415014a94aa818
+SHA256:
+  metadata.gz: d43d9cf3df4fb81e7b97db8b9a4881983d93c76fd2a2c62da80afae6209cae95
+  data.tar.gz: b76c110bc2145c68e4f7d7eb33b39c5b2264a84e1dcf96828bb378c6e53d5251
 SHA512:
-  metadata.gz: 575ceab7b08f14f19aa7609709f64299effeaf21925d0dc4cedbdf4a776542cc237dfacea2983864c30e98aae752825444c8a37184e7feec3033158851fb6725
-  data.tar.gz: db13d502675945cad348f8ba5d0467c225a6abe513a8c89603ea47da9407bd2670ea2b2d81a5ada876603d5adf4da1ae5a1e39fe42f2adfb6310d925706eec17
+  metadata.gz: 1630b02c9715804035906a2c29994352f9cdbacfd61c398df1ed2c2afb0672d01fe7f5f442d2a5cda371cd98ae881207dd9126a61aaf0258dd11f93e80e17b2f
+  data.tar.gz: 82c2373090cd74310668114f6ea0b4742d66955d2c329b8c4c4f9377dce402aa377cd608eed8975b0ab2757db744b2ded9b35dc04fa3cc8347d965fb13cdea51

data/Changelog.md

@@ -0,0 +1,54 @@
+# Changelog
+
+This project follows [semver 2.0.0](http://semver.org/spec/v2.0.0.html) and the
+recommendations of [keepachangelog.com](http://keepachangelog.com/).
+
+## (Unreleased)
+
+## 0.5.0 (2020-08-25)
+- Change the order of arguments for `add_params` to `add_params(url, query_params_to_add)`.
+  This feels more natural, since you are adding the new query params to the _end_ of the given URL.
+  It is also more consistent with the Rails route helpers, like `something_path(query_params_to_add)`.
+
+## 0.4.2 (2019-02-10)
+- Fix `merge_url_for` to not pass on reserved options like only_path (which were only intended for
+  consumption by `url_for`) to `add_params`. It was adding it to the end of the URL, like
+  `only_path=true`.
+
+## 0.4.1 (2019-02-08)
+- Fix issue with merge_params not merging nested hashes as expected (changed to
+  use `deep_merge` instead of `merge`)
+
+## 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)
+
+### Fixed
+- Fix `merge_url_for` to not try to add a param as a query param if it's been recognized as a route
+  param (part of the route path). We don't want the same param to be passed both via the route path
+  *and* the query string.
+
+### Added
+- `merge_url_for`: Allow keys that are currently in `query_params` to be deleted by setting their
+  value to `nil`.
+
+
+## 0.2.0 (2018-12-05)
+
+### Fixed
+- Fix `add_params` to not inadvertently add a '?' to the end of the URI if there are no params to add
+
+### Added
+- Add `slice_params` helper
+
+
+## 0.1.0 (2018-11-16)
+
+Initial release

data/License

@@ -1,4 +1,4 @@
-Copyright (c) 2018 Tyler Rick
+Copyright (c) 2020 Tyler Rick
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
 associated documentation files (the "Software"), to deal in the Software without restriction,

data/Readme.md

@@ -1,5 +1,7 @@
 # MergeParams
 
+[![Gem Version](https://badge.fury.io/rb/merge_params.svg)](https://badge.fury.io/rb/merge_params)
+
 ## Why do we need it?
 
 Have you ever wanted to take the current route and change just one parameter in the route to

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.
+      deep_merge(new_params.deep_symbolize_keys)
   end
 
   # Easily extract just certain param keys.
@@ -79,26 +86,36 @@ module MergeParams::Helpers
 
   # Safely merges the given params with the params from the current request, then generates a route
   # from the merged params.
+  # You can remove a key by passing nil as the value, for example {key: nil}.
   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 || '')
-    query_params_to_add = query_params.except(*query_params_already_added.keys)
-    add_params(query_params_to_add, url)
+#    # 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 = params_for_url_for(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(url, query_params_to_add)
   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(url = request.fullpath, new_params = {})
     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
 
@@ -112,9 +129,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.2.0"
+    "0.5.0"
   end
 end

data/merge_params.gemspec

@@ -11,11 +11,11 @@ Gem::Specification.new do |spec|
 
   spec.summary       = %q{Safely merge params for use with url_for or for the query string}
   spec.description   = spec.summary
-  spec.homepage      = "http://github.com/TylerRick/merge_params"
+  spec.homepage      = "https://github.com/TylerRick/merge_params"
 
   spec.metadata["homepage_uri"]    = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
-  spec.metadata["changelog_uri"] = "TODO: Put your gem's Changelog.md URL here."
+  spec.metadata["changelog_uri"] = "#{spec.metadata["source_code_uri"]}/blob/master/Changelog.md"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -29,8 +29,9 @@ 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 "bundler", "~> 2"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: merge_params
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Tyler Rick
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-05 00:00:00.000000000 Z
+date: 2020-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -50,20 +50,34 @@ 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
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -102,23 +116,25 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- Changelog.md
 - Gemfile
 - License
 - Rakefile
 - 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
 - merge_params.gemspec
-homepage: http://github.com/TylerRick/merge_params
+homepage: https://github.com/TylerRick/merge_params
 licenses:
 - MIT
 metadata:
-  homepage_uri: http://github.com/TylerRick/merge_params
-  source_code_uri: http://github.com/TylerRick/merge_params
-  changelog_uri: 'TODO: Put your gem''s Changelog.md URL here.'
+  homepage_uri: https://github.com/TylerRick/merge_params
+  source_code_uri: https://github.com/TylerRick/merge_params
+  changelog_uri: https://github.com/TylerRick/merge_params/blob/master/Changelog.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -134,8 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Safely merge params for use with url_for or for the query string