Replace hashie mash with hash

.gitignore

@@ -26,8 +26,11 @@ coverage
 doc
 pkg
 .rvmrc
+.ruby-version
+.ruby-gemset
 .bundle
 .yardoc/*
+.byebug_history
 dist
 Gemfile.lock
 gemfiles/*.lock

.rubocop.yml

@@ -2,11 +2,11 @@ AllCops:
   TargetRubyVersion: 2.1
   Include:
     - Dangerfile
-    - gemfiles/*.gemfile
 
   Exclude:
     - vendor/**/*
     - bin/**/*
+    - gemfiles/*.gemfile
 
 inherit_from: .rubocop_todo.yml
 

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 #### Features
 
+* [#1594](https://github.com/ruby-grape/grape/pull/1594): Make Hashie::Mash params optional - [@james2m](https://github.com/james2m).
 * [#1555](https://github.com/ruby-grape/grape/pull/1555): Added code coverage w/Coveralls - [@dblock](https://github.com/dblock).
 * [#1568](https://github.com/ruby-grape/grape/pull/1568): Add `proc` option to `values` validator to allow custom checks - [@jlfaber](https://github.com/jlfaber).
 * [#1575](https://github.com/ruby-grape/grape/pull/1575): Include nil values for missing nested params in declared - [@thogg4](https://github.com/thogg4).

Gemfile

@@ -8,6 +8,7 @@ group :development, :test do
   gem 'bundler'
   gem 'rake'
   gem 'rubocop', '0.47.0'
+  gem 'hashie', require: false
 end
 
 group :development do

README.md

@@ -509,7 +509,7 @@ post 'users/signup' do
 end
 ````
 
-If we do not specify any params, `declared` will return an empty `Hashie::Mash` instance.
+If we do not specify any params, `declared` will return an empty `ActiveSupport::HashWithIndifferentAccess` hash.
 
 **Request**
 
@@ -562,10 +562,10 @@ curl -X POST -H "Content-Type: application/json" localhost:9292/users/signup -d
 }
 ````
 
-The returned hash is a `Hashie::Mash` instance, allowing you to access parameters via dot notation:
+The returned hash is a `ActiveSupport::HashWithIndifferentAccess` hash.
 
 ```ruby
-  declared(params).user == declared(params)['user']
+  declared(params)[:user] == declared(params)['user']
 ```
 
 
@@ -797,6 +797,22 @@ params do
 end
 ```
 
+By default Grape 1.x presents the parameters to the endpoint as an
+ActiveSupport::HashWithIndifferentAccess. This is a change from 0.x where a
+Hashie::Mash was previously presented.
+
+To restore the previous behaviour check out [UPGRADING](UPGRADING.md).
+
+If you would rather have the parameters presented as a plain old Ruby Hash you
+can specify this using build_with in the params block;
+
+```ruby
+params do
+  build_with Grape::Extensions::Hash::ParamBuilder
+  optional :color, type: String, default: 'blue', values: ['blue', 'red', 'green']
+end
+```
+
 ### Supported Parameter Types
 
 The following are all valid types, supported out of the box by Grape:
@@ -905,11 +921,14 @@ params do
   requires :avatar, type: File
 end
 post '/' do
-  # Parameter will be wrapped using Hashie:
-  params.avatar.filename # => 'avatar.png'
-  params.avatar.type     # => 'image/png'
-  params.avatar.tempfile # => #<File>
+  # Parameter will be wrapped using HashWithIndifferentAccess:
+  params[:avatar][:filename] # => 'avatar.png'
+  params['avatar']['avatar'] # => 'image/png'
+  params[:avatar][:tempfile] # => #<File>
 end
+
+`params` hash keys  can accesed with `""` or `:`
+`:avatar` and `"avatar"` are considered to be the same.
 ```
 
 ### First-Class `JSON` Types

UPGRADING.md

@@ -1,5 +1,19 @@
 Upgrading Grape
 ===============
+### Upgrading to >= 1.0.0
+Prior to this version the endpoint was presented with params in the form of a Hashie::Mash. From 1.0.0 upwards Grape presents the parameters to the endpoint as an
+ActiveSupport::HashWithIndifferentAccess.
+
+To restore the previous behaviour you can specify Hashie::Mash using build_with in the params block;
+
+```ruby
+params do
+  build_with Grape::Extensions::Hashie::Mash::ParamBuilder
+  optional :color, type: String, default: 'blue', values: ['blue', 'red', 'green']
+end
+```
+
+The various options are documented in [Grape::DSL::Parameters](lib/grape/dsl/parameters.rb)
 
 ### Upgrading to >= 0.19.1
 

gemfiles/rack_1.5.2.gemfile

@@ -8,6 +8,7 @@ group :development, :test do
   gem 'bundler'
   gem 'rake'
   gem 'rubocop', '0.47.0'
+  gem 'hashie', require: false
 end
 
 group :development do

gemfiles/rack_edge.gemfile

@@ -8,6 +8,7 @@ group :development, :test do
   gem 'bundler'
   gem 'rake'
   gem 'rubocop', '0.47.0'
+  gem 'hashie', require: false
 end
 
 group :development do

gemfiles/rails_3.gemfile

@@ -9,6 +9,7 @@ group :development, :test do
   gem 'bundler'
   gem 'rake'
   gem 'rubocop', '0.47.0'
+  gem 'hashie', require: false
 end
 
 group :development do

gemfiles/rails_4.gemfile

@@ -8,6 +8,7 @@ group :development, :test do
   gem 'bundler'
   gem 'rake'
   gem 'rubocop', '0.47.0'
+  gem 'hashie', require: false
 end
 
 group :development do

gemfiles/rails_5.gemfile

@@ -8,6 +8,7 @@ group :development, :test do
   gem 'bundler'
   gem 'rake'
   gem 'rubocop', '0.47.0'
+  gem 'hashie', require: false
 end
 
 group :development do

gemfiles/rails_edge.gemfile

@@ -8,6 +8,7 @@ group :development, :test do
   gem 'bundler'
   gem 'rake'
   gem 'rubocop', '0.47.0'
+  gem 'hashie', require: false
 end
 
 group :development do

grape.gemspec

@@ -18,7 +18,6 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'activesupport'
   s.add_runtime_dependency 'multi_json', '>= 1.3.2'
   s.add_runtime_dependency 'multi_xml', '>= 0.5.2'
-  s.add_runtime_dependency 'hashie', '>= 2.1.0'
   s.add_runtime_dependency 'virtus', '>= 1.0.0'
   s.add_runtime_dependency 'builder'
 

lib/grape.rb

@@ -4,7 +4,6 @@
 require 'rack/accept'
 require 'rack/auth/basic'
 require 'rack/auth/digest/md5'
-require 'hashie'
 require 'set'
 require 'active_support/version'
 require 'active_support/core_ext/hash/indifferent_access'

lib/grape/dsl/inside_route.rb

@@ -46,7 +46,7 @@ def declared_array(passed_params, options, declared_params)
         end
 
         def declared_hash(passed_params, options, declared_params)
-          declared_params.each_with_object(Hashie::Mash.new) do |declared_param, memo|
+          declared_params.each_with_object({}) do |declared_param, memo|
             # If it is not a Hash then it does not have children.
             # Find its value or set it to nil.
             if !declared_param.is_a?(Hash)
@@ -56,7 +56,7 @@ def declared_hash(passed_params, options, declared_params)
               declared_param.each_pair do |declared_parent_param, declared_children_params|
                 next unless options[:include_missing] || passed_params.key?(declared_parent_param)
 
-                passed_children_params = passed_params[declared_parent_param] || Hashie::Mash.new
+                passed_children_params = passed_params[declared_parent_param] || {}
                 memo[optioned_param_key(declared_parent_param, options)] = declared(passed_children_params, options, declared_children_params)
               end
             end

lib/grape/dsl/parameters.rb

@@ -8,6 +8,31 @@ module DSL
     module Parameters
       extend ActiveSupport::Concern
 
+      # Set the module used to build the request.params.
+      #
+      # @param build_with the ParamBuilder module to use when building request.params
+      #   Available builders are;
+      #     * Grape::Extensions::HashWithIndifferentAccess::ParamBuilder (default)
+      #     * Grape::Extensions::Hash::ParamBuilder
+      #     * Grape::Extensions::Hashie::Mash::ParamBuilder
+      #
+      # @example
+      #
+      #     require 'grape/extenstions/hashie_mash'
+      #     class API < Grape::API
+      #       desc "Get collection"
+      #       params do
+      #         build_with Grape::Extensions::Hashie::Mash::ParamBuilder
+      #         requires :user_id, type: Integer
+      #       end
+      #       get do
+      #         params['user_id']
+      #       end
+      #     end
+      def build_with(build_with = nil)
+        @api.namespace_inheritable(:build_with, build_with)
+      end
+
       # Include reusable params rules among current.
       # You can define reusable params with helpers method.
       #

lib/grape/endpoint.rb

@@ -5,7 +5,7 @@ module Grape
   # blocks are executed. In other words, any methods
   # on the instance level of this class may be called
   # from inside a `get`, `post`, etc.
-  class Endpoint
+  class Endpoint # rubocop:disable ClassLength
     include Grape::DSL::Settings
     include Grape::DSL::InsideRoute
 
@@ -239,15 +239,12 @@ def equals?(e)
     def run
       ActiveSupport::Notifications.instrument('endpoint_run.grape', endpoint: self, env: env) do
         @header = {}
-
-        @request = Grape::Request.new(env)
+        @request = Grape::Request.new(env, build_params_with: namespace_inheritable(:build_with))
         @params = @request.params
         @headers = @request.headers
 
         cookies.read(@request)
-
         self.class.run_before_each(self)
-
         run_filters befores, :before
 
         if (allowed_methods = env[Grape::Env::GRAPE_ALLOWED_METHODS])

lib/grape/extensions/deep_mergeable_hash.rb

@@ -0,0 +1,19 @@
+module Grape
+  module Extensions
+    class DeepMergeableHash < ::Hash
+      def deep_merge!(other_hash)
+        other_hash.each_pair do |current_key, other_value|
+          this_value = self[current_key]
+
+          self[current_key] = if this_value.is_a?(::Hash) && other_value.is_a?(::Hash)
+                                this_value.deep_merge(other_value)
+                              else
+                                other_value
+                              end
+        end
+
+        self
+      end
+    end
+  end
+end

lib/grape/extensions/deep_symbolize_hash.rb

@@ -0,0 +1,22 @@
+module Grape
+  module Extensions
+    module DeepSymbolizeHash
+      def self.deep_symbolize_keys_in(object)
+        case object
+        when ::Hash
+          object.each_with_object({}) do |(key, value), new_hash|
+            new_hash[symbolize_key(key)] = deep_symbolize_keys_in(value)
+          end
+        when ::Array
+          object.map { |element| deep_symbolize_keys_in(element) }
+        else
+          object
+        end
+      end
+
+      def self.symbolize_key(key)
+        key.respond_to?(:to_sym) ? key.to_sym : key
+      end
+    end
+  end
+end

lib/grape/extensions/hash.rb

@@ -0,0 +1,19 @@
+require_relative 'deep_mergeable_hash'
+require_relative 'deep_symbolize_hash'
+module Grape
+  module Extensions
+    module Hash
+      module ParamBuilder
+        def build_params
+          params = Grape::Extensions::DeepMergeableHash[rack_params]
+          params.deep_merge!(grape_routing_args) if env[Grape::Env::GRAPE_ROUTING_ARGS]
+          post_process_params(params)
+        end
+
+        def post_process_params(params)
+          Grape::Extensions::DeepSymbolizeHash.deep_symbolize_keys_in(params)
+        end
+      end
+    end
+  end
+end

lib/grape/extensions/hash_with_indifferent_access.rb

@@ -0,0 +1,17 @@
+module Grape
+  module Extensions
+    module HashWithIndifferentAccess
+      def params_builder
+        Grape::Extensions::HashWithIndifferentAccess::ParamBuilder
+      end
+
+      module ParamBuilder
+        def build_params
+          params = ActiveSupport::HashWithIndifferentAccess[rack_params]
+          params.deep_merge!(grape_routing_args) if env[Grape::Env::GRAPE_ROUTING_ARGS]
+          params
+        end
+      end
+    end
+  end
+end

lib/grape/extensions/hashie_mash.rb

@@ -0,0 +1,20 @@
+require 'hashie'
+module Grape
+  module Extensions
+    module Hashie
+      module Mash
+        def params_builder
+          Grape::Extensions::Hashie::Mash::ParamBuilder
+        end
+
+        module ParamBuilder
+          def build_params
+            params = ::Hashie::Mash.new(rack_params)
+            params.deep_merge!(grape_routing_args) if env[Grape::Env::GRAPE_ROUTING_ARGS]
+            params
+          end
+        end
+      end
+    end
+  end
+end

lib/grape/middleware/globals.rb

@@ -4,7 +4,7 @@ module Grape
   module Middleware
     class Globals < Base
       def before
-        request = Grape::Request.new(@env)
+        request = Grape::Request.new(@env, build_params_with: @options[:build_params_with])
         @env[Grape::Env::GRAPE_REQUEST] = request
         @env[Grape::Env::GRAPE_REQUEST_HEADERS] = request.headers
         @env[Grape::Env::GRAPE_REQUEST_PARAMS] = request.params if @env[Grape::Env::RACK_INPUT]