ecraft-extensions 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1793e42f7e71ad0913157c4ad714822f10aa45ef
-  data.tar.gz: f9816c1556f31a5dc88abe6ac704b402315383d9
+  metadata.gz: c25113dc68cc699ceb7211a9f6350287931416a8
+  data.tar.gz: fcf1be83809dc87238fd1731f79602bb84b8b7e5
 SHA512:
-  metadata.gz: 34b93ece0f0c01b4bb6043d7c5d458db24a7463dfeee3c7e5a0667aa9bd1fb52b1ff4467245204929155396451113f9ff1b6063ac6c5797959211c7da4ee6802
-  data.tar.gz: 1b3d62e52486973b3fcf8f31cf213c6dde565d75b3b0d9ddda1613a7a497389cb53348786dc1a4174409feaf4ea5b57938899f104470068dc7215fb809d5981f
+  metadata.gz: 8238dc69b792b8c9221f22b139e1ffa797d21d48c44b0a1003473d410d3d064c0f1d50550246ed11e2a04290e460fed56f51bfbb60d1239d3d28c47a315f8b7a
+  data.tar.gz: a94300f74e6c00a4bf5f4d295afc1bc2c845dce93473387900777c21ed9660a2e67091441fe6ef60b567ee770d2543b141515950549a01ba90f531a77de4a1d0

data/.rubocop.yml

@@ -33,3 +33,5 @@ Style/NumericPredicate:
   Enabled: false
 Style/FrozenStringLiteralComment:
   Enabled: false
+
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,29 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2017-10-10 12:17:14 +0300 using RuboCop version 0.50.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: 2
+Metrics/AbcSize:
+  Max: 20
+
+# Offense count: 2
+Metrics/CyclomaticComplexity:
+  Max: 8
+
+# Offense count: 3
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 14
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ModuleLength:
+  Max: 135
+
+# Offense count: 2
+Metrics/PerceivedComplexity:
+  Max: 9

data/README.md

@@ -4,6 +4,8 @@
 
 This code contains some useful extension methods to various Ruby classes.
 
+It also contains a few mixins in the `Ecraft::Extensions::Mixins` module.
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/ecraft-extensions.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_runtime_dependency 'activesupport', '>= 4.0'
   spec.add_runtime_dependency 'json', '>= 1.8'
 
   spec.add_development_dependency 'bundler'

data/lib/ecraft/extensions/mixins/hashable.rb

@@ -0,0 +1,113 @@
+#
+# Utility mixin for converting arbitrary objects to Hashes.
+#
+# Similar to https://github.com/mustafaturan/hashable, but different in implementation.
+#
+# This mixin is deprecated, since it changes the behavior of to_h in a potentially unpleasant and surprising way for developers.
+# It should only be used to make legacy code run and work; it should preferably not be used for new code being written.
+#
+
+require 'active_support'
+require 'active_support/core_ext/hash/keys'
+
+module Ecraft
+  module Extensions
+    module Mixins
+      module Hashable
+        def to_h(*targets)
+          target = get_target(targets)
+
+          if target.is_a?(Hash)
+            strip_string_recurse_enumerable_values(target)
+          elsif target.is_a?(Array)
+            strip_array(target)
+          elsif target.is_a?(OpenStruct)
+            target.marshal_dump
+          elsif value_type?(target)
+            target
+          # We need to check to ensure we don't call ourselves recursively.
+          elsif !target.class.included_modules.include?(Hashable) && target.respond_to?(:to_h)
+            target.to_h
+          else
+            turn_object_into_hash(target)
+          end
+        end
+
+        def to_hash(target = nil)
+          to_h(target)
+        end
+
+        private
+
+        def get_target(targets)
+          if targets.empty?
+            self
+          else
+            targets.first
+          end
+        end
+
+        def value_type?(v)
+          v.is_a?(BigDecimal) ||
+            v.is_a?(Integer) ||
+            v.is_a?(Float) ||
+            v.is_a?(String) ||
+            v.is_a?(TrueClass) ||
+            v.is_a?(FalseClass)
+        end
+
+        def strip_string_recurse_enumerable_values(hash)
+          hash.each_value do |v|
+            v.rstrip! if v.respond_to?(:rstrip!) && !v.frozen?
+            to_h(v) if v.is_a?(Enumerable)
+          end
+          hash.symbolize_keys
+        end
+
+        def strip_array(array)
+          array.map do |v|
+            if v.nil?
+              nil
+            elsif v.is_a?(String)
+              v.rstrip
+            elsif v.respond_to?(:to_h) && !v.is_a?(Hash)
+              v.to_h
+            else
+              to_h(v)
+            end
+          end
+        end
+
+        # Returns a Symbol-keyed Hash based on target's instance variables.
+        #
+        # @param target [Object]
+        #
+        # @return [Hash] with Symbol keys
+        def turn_object_into_hash(target)
+          target.instance_variables.each_with_object({}) do |var, hash|
+            original = target.instance_variable_get(var)
+            value = original
+
+            if value.is_a?(Hash)
+              # Nothing to do - it's already a hash, so we presume we don't have to do do any more conversions of it.
+            elsif value.is_a?(Array) && value.first.is_a?(Hash)
+              # Nothing to do - an Array of Hashes already have a sane enough format.
+            else
+              map_enumerable(original) if original.respond_to?(:each)
+              value = original.to_h if original.respond_to?(:to_h)
+              value.rstrip! if value.respond_to?(:rstrip!) && !value.frozen?
+            end
+
+            hash[var.to_s.delete('@').to_sym] = value
+          end
+        end
+
+        def map_enumerable(enumerable)
+          enumerable.map do |v|
+            v.respond_to?(:to_h) ? v.to_h : v
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecraft/extensions/version.rb

@@ -1,5 +1,5 @@
 module Ecraft
   module Extensions
-    VERSION = '0.2.3'.freeze
+    VERSION = '0.3.0'.freeze
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: ecraft-extensions
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Tre Kronor
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-25 00:00:00.000000000 Z
+date: 2017-10-10 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -146,6 +160,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".ruby-version"
 - ".travis.yml"
 - ".yardopts"
@@ -159,6 +174,7 @@ files:
 - lib/ecraft/extensions/bigdecimal.rb
 - lib/ecraft/extensions/date.rb
 - lib/ecraft/extensions/datetime.rb
+- lib/ecraft/extensions/mixins/hashable.rb
 - lib/ecraft/extensions/ostruct.rb
 - lib/ecraft/extensions/string.rb
 - lib/ecraft/extensions/symbol.rb
@@ -184,7 +200,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: eCraft Extensions