Merge branch 'master' into master

Author: LeFnord

.rubocop.yml

@@ -1,37 +1,48 @@
+inherit_from: .rubocop_todo.yml
+
 AllCops:
+  Exclude:
+    - vendor/**/*
+    - example/**/*
   TargetRubyVersion: 2.4
-  Include:
-    - Dangerfile
 
+Layout/EmptyLinesAroundArguments:
+  Enabled: false
+
+Layout/IndentFirstHashElement:
+  EnforcedStyle: consistent
+
+Metrics/AbcSize:
+  Max: 25
+
+Metrics/BlockLength:
   Exclude:
-    - vendor/**/*
-    - bin/**/*
-    - Guardfile
+    - spec/**/*
 
-inherit_from: .rubocop_todo.yml
+Metrics/CyclomaticComplexity:
+  Max: 10
 
-Gemspec/RequiredRubyVersion:
-  Enabled: false
+Metrics/ClassLength:
+  Max: 300
 
-Naming/FileName:
+Metrics/LineLength:
+  Max: 120
   Exclude:
-    - 'Gemfile'
-    - 'Rakefile'
-    - 'grape-entity.gemspec'
-    - 'lib/grape-entity.rb'
+    - spec/**/*
 
-Style/Documentation:
-  Enabled: false
+Metrics/MethodLength:
+  Max: 26
+  Exclude:
+    - spec/**/*
 
-Style/MultilineIfModifier:
-  Enabled: false
+Metrics/PerceivedComplexity:
+  Max: 11
 
-Style/RaiseArgs:
+Naming:
   Enabled: false
 
-Lint/BooleanSymbol:
-  Exclude:
-    - 'spec/grape_entity/exposure_spec.rb'
+Style/Documentation:
+  Enabled: false
 
-Lint/UnneededDisable:
+Style/RegexpLiteral:
   Enabled: false

.rubocop_todo.yml

@@ -1,65 +1,34 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-03-28 21:26:18 +0200 using RuboCop version 0.54.0.
+# on 2019-03-15 00:00:57 +0100 using RuboCop version 0.65.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 1
-Lint/AmbiguousBlockAssociation:
+# Offense count: 6
+Lint/BooleanSymbol:
   Exclude:
-    - 'spec/grape_entity/exposure/represent_exposure_spec.rb'
-
-# Offense count: 5
-Metrics/AbcSize:
-  Max: 25
+    - 'spec/grape_entity/exposure_spec.rb'
 
-# Offense count: 39
-# Configuration parameters: CountComments, ExcludedMethods.
-Metrics/BlockLength:
-  Max: 1632
 
-# Offense count: 1
-# Configuration parameters: CountComments.
-Metrics/ClassLength:
-  Max: 205
-
-# Offense count: 1
-Metrics/CyclomaticComplexity:
-  Max: 10
-
-# Offense count: 6
-# Configuration parameters: CountComments.
-Metrics/MethodLength:
-  Max: 26
+# Offense count: 4
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 146
 
 # Offense count: 1
-Metrics/PerceivedComplexity:
-  Max: 11
-
-# Offense count: 3
-# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
-# AllowedNames: io, id, to
-Naming/UncommunicativeMethodParamName:
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: inline, group
+Style/AccessModifierDeclarations:
   Exclude:
     - 'spec/grape_entity/entity_spec.rb'
 
-# Offense count: 1
-Style/EvalWithLocation:
-  Exclude:
-    - 'lib/grape_entity/exposure/nesting_exposure/nested_exposures.rb'
-
 # Offense count: 1
 # Cop supports --auto-correct.
 # Configuration parameters: IgnoredMethods.
 # IgnoredMethods: respond_to, define_method
 Style/SymbolProc:
   Exclude:
     - 'spec/grape_entity/entity_spec.rb'
-
-# Offense count: 272
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
-# URISchemes: http, https
-Metrics/LineLength:
-  Max: 146

.travis.yml

@@ -1,29 +1,21 @@
-sudo: false
-
 language: ruby
 
 before_install:
-  - gem update --system
   - gem install bundler
 
 after_success:
-  # - coveralls
   - bundle exec danger
 
 rvm:
   - 2.4.5
-  - 2.5.3
-  - 2.6.0
+  - 2.5.4
+  - 2.6.2
+  - ruby-head
+  - jruby-head
 
 matrix:
   fast_finish: true
 
-  include:
-    - rvm: 2.3.8
-    - rvm: ruby-head
-    - rvm: jruby-head
-
   allow_failures:
-    - rvm: 2.3.8
     - rvm: ruby-head
     - rvm: jruby-head

CHANGELOG.md

@@ -3,18 +3,19 @@
 #### Features
 
 * Your contribution here.
+* [#319](https://github.com/ruby-grape/grape-entity/pull/319): Support hashes with string keys - [@mhenrixon](https://github.com/mhenrixon).
 * [#300](https://github.com/ruby-grape/grape-entity/pull/300): Loosens activesupport to 3 - [@ericschultz](https://github.com/ericschultz).
 
 #### Fixes
 
 * Your contribution here.
-* [#258](https://github.com/ruby-grape/grape-entity/pull/307): Allow exposures to call methods defined in modules included in an entity [@robertoz-01](https://github.com/robertoz-01).
+* [#307](https://github.com/ruby-grape/grape-entity/pull/307): Allow exposures to call methods defined in modules included in an entity [@robertoz-01](https://github.com/robertoz-01).
 
 ### 0.7.1 (2018-01-30)
 
 #### Features
 
-* [#292](https://github.com/ruby-grape/grape-entity/pull/297): Introduce `override` option for expose (fixes [#286](https://github.com/ruby-grape/grape-entity/issues/296)) - [@DmitryTsepelev](https://github.com/DmitryTsepelev).
+* [#297](https://github.com/ruby-grape/grape-entity/pull/297): Introduce `override` option for expose (fixes [#286](https://github.com/ruby-grape/grape-entity/issues/296)) - [@DmitryTsepelev](https://github.com/DmitryTsepelev).
 
 ### 0.7.0 (2018-01-25)
 

Gemfile

@@ -5,7 +5,7 @@ source 'http://rubygems.org'
 gemspec
 
 group :development, :test do
-  gem 'rubocop', '~> 0.61', require: false
+  gem 'rubocop', '~> 0.65', require: false
 end
 
 group :test do

Guardfile

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 # A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 
 guard 'rspec', version: 2 do
   watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
   watch(%r{^spec/support/shared_versioning_examples.rb$}) { |_m| 'spec/' }
-  watch('spec/spec_helper.rb')  { 'spec/' }
+  watch('spec/spec_helper.rb') { 'spec/' }
 end
 
 guard 'bundler' do

README.md

@@ -220,7 +220,8 @@ class ExampleEntity < Grape::Entity
 end
 ```
 
-You have always access to the presented instance with `object`
+You always have access to the presented instance (`object`) and the top-level
+entity options (`options`).
 
 ```ruby
 class ExampleEntity < Grape::Entity
@@ -229,7 +230,7 @@ class ExampleEntity < Grape::Entity
   private
 
   def formatted_value
-    "+ X #{object.value}"
+    "+ X #{object.value} #{options[:y]}"
   end
 end
 ```

grape-entity.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |s|
   s.description = 'Extracted from Grape, A Ruby framework for rapid API development with great conventions.'
   s.license     = 'MIT'
 
-  s.required_ruby_version = '>= 2.3'
+  s.required_ruby_version = '>= 2.4'
 
   s.rubyforge_project = 'grape-entity'
 

lib/grape_entity/delegator/fetchable_object.rb

@@ -4,7 +4,7 @@ module Grape
   class Entity
     module Delegator
       class FetchableObject < Base
-        def delegate(attribute)
+        def delegate(attribute, **)
           object.fetch attribute
         end
       end

lib/grape_entity/delegator/hash_object.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
+require 'pry'
+
 module Grape
   class Entity
     module Delegator
       class HashObject < Base
-        def delegate(attribute)
-          object[attribute]
+        def delegate(attribute, hash_access: :to_sym)
+          object[attribute.send(hash_access)]
         end
       end
     end

lib/grape_entity/delegator/openstruct_object.rb

@@ -4,7 +4,7 @@ module Grape
   class Entity
     module Delegator
       class OpenStructObject < Base
-        def delegate(attribute)
+        def delegate(attribute, **)
           object.send attribute
         end
       end

lib/grape_entity/delegator/plain_object.rb

@@ -4,7 +4,7 @@ module Grape
   class Entity
     module Delegator
       class PlainObject < Base
-        def delegate(attribute)
+        def delegate(attribute, **)
           object.send attribute
         end
 

lib/grape_entity/entity.rb

@@ -114,6 +114,22 @@ def formatters
       end
 
       attr_writer :formatters
+
+      def hash_access
+        @hash_access ||= :to_sym
+      end
+
+      def hash_access=(value)
+        @hash_access =
+          case value
+          when :to_s, :str, :string
+            :to_s
+          when :to_sym, :sym, :symbol
+            :to_sym
+          else
+            :to_sym
+          end
+      end
     end
 
     @formatters = {}
@@ -168,10 +184,13 @@ def self.inherited(subclass)
     # @option options :documentation Define documenation for an exposed
     #   field, typically the value is a hash with two fields, type and desc.
     # @option options :merge This option allows you to merge an exposed field to the root
+    #
+    # rubocop:disable Metrics/LineLength
     def self.expose(*args, &block)
       options = merge_options(args.last.is_a?(Hash) ? args.pop : {})
 
       if args.size > 1
+
         raise ArgumentError, 'You may not use the :as option on multi-attribute exposures.' if options[:as]
         raise ArgumentError, 'You may not use the :expose_nil on multi-attribute exposures.' if options.key?(:expose_nil)
         raise ArgumentError, 'You may not use block-setting on multi-attribute exposures.' if block_given?
@@ -191,6 +210,7 @@ def self.expose(*args, &block)
       @nesting_stack ||= []
       args.each { |attribute| build_exposure_for_attribute(attribute, @nesting_stack, options, block) }
     end
+    # rubocop:enable Metrics/LineLength
 
     def self.build_exposure_for_attribute(attribute, nesting_stack, options, block)
       exposure_list = nesting_stack.empty? ? root_exposures : nesting_stack.last.nested_exposures
@@ -291,6 +311,7 @@ def self.documentation
     #
     def self.format_with(name, &block)
       raise ArgumentError, 'You must pass a block for formatters' unless block_given?
+
       formatters[name.to_sym] = block
     end
 
@@ -454,8 +475,8 @@ def inspect
 
     def initialize(object, options = {})
       @object = object
-      @delegator = Delegator.new(object)
       @options = options.is_a?(Options) ? options : Options.new(options)
+      @delegator = Delegator.new(object)
     end
 
     def root_exposures
@@ -509,7 +530,7 @@ def delegate_attribute(attribute)
       if is_defined_in_entity?(attribute)
         send(attribute)
       else
-        delegator.delegate(attribute)
+        delegator.delegate(attribute, hash_access: self.class.hash_access)
       end
     end
 
@@ -534,7 +555,22 @@ def to_xml(options = {})
 
     # All supported options.
     OPTIONS = %i[
-      rewrite as if unless using with proc documentation format_with safe attr_path if_extras unless_extras merge expose_nil override
+      rewrite
+      as
+      if
+      unless
+      using
+      with
+      proc
+      documentation
+      format_with
+      safe
+      attr_path
+      if_extras
+      unless_extras
+      merge
+      expose_nil
+      override
     ].to_set.freeze
 
     # Merges the given options with current block options.