mad_flatter 1.0.0.pre.beta → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 996b96ff524cf36af3fc367f1de538beab06023345e7a45ba206b131d6106c08
-  data.tar.gz: 2d8672213da7902f712d4d40e14de3cc54305df6d19a53dfb0ed41a785fab335
+  metadata.gz: 970e8a0b3df7bbe9ef22e8aca026ca61aba74d115f24b06f82fd52a0e75fdd71
+  data.tar.gz: 7e60a9691f934b7a438a7c368c53cedb2143099d5ffc523d51c7e72b1274e28d
 SHA512:
-  metadata.gz: b41f5116f99ee102ef8a46b95930832aa94c06255b4df886a85177fa474f73d48dbdf799cc6f20b2c29baa84e354400e6f758da28f590a45a4837a42ed234445
-  data.tar.gz: fa5ce245cb03083dacc0ff8c5ba2318d8b1c89c20c157332ddcd611860de3ba6d431cac9d828a9cf3aeae0f65855ad3d894c7a991c4fc0d7444b436f4da4eab9
+  metadata.gz: 7c644ab261b05fb7fdec5d1ca050c4d16d2defda599a428be8e224795f4512936758e6cae6a9e833764738744f599d77a563d8b4af63bfedda713b7102ba83a7
+  data.tar.gz: 8d2c362749860e61d29acd458113973a2e2393563742f26292a69ac82dcd9aa38223947c0ac42825ad604a7f16bd27661c572841922ef581cf7550b4546bdccd

data/CHANGELOG.md

@@ -1,5 +1,16 @@
-## [Unreleased]
+### 2.0.0
+* Changes
+  * Add spec coverage.
+  * Update README.md.
+* Breaking change
+  * Remove unused Module HashRetrievable.
+* Bug Fixes
+  * Fix bug that raised an error when :namespace option is not a Symbol due cut & paste error from validation routine that checked the :metadata option for validity.
+  * Fix bug when checking `MadFlatter::Service#options.namespace? an error was raised if option :namespace was not passed as an option since it is optional.
 
-## [0.1.0] - 2022-08-15
+### 1.0.1-beta
+* Bug Fixes
+  * Fix bug requiring support codez in lib/mad_flatter.rb.
 
-- Initial release
+### 1.0.0-alpha
+* Initial release.

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    mad_flatter (1.0.0.pre.beta)
+    mad_flatter (2.0.0)
       activesupport (~> 7.0, >= 7.0.3.1)
       immutable_struct_ex (~> 0.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.3.1)
+    activesupport (7.0.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -21,11 +21,11 @@ GEM
     docile (1.4.0)
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
-    immutable_struct_ex (0.2.2)
+    immutable_struct_ex (0.2.3)
     json (2.6.2)
     kwalify (0.7.2)
     method_source (1.0.0)
-    minitest (5.16.2)
+    minitest (5.16.3)
     parallel (1.22.1)
     parser (3.1.2.1)
       ast (~> 2.4.1)
@@ -40,7 +40,7 @@ GEM
       kwalify (~> 0.7.0)
       parser (~> 3.1.0)
       rainbow (>= 2.0, < 4.0)
-    regexp_parser (2.5.0)
+    regexp_parser (2.6.0)
     rexml (3.2.5)
     rspec (3.11.0)
       rspec-core (~> 3.11.0)
@@ -48,14 +48,14 @@ GEM
       rspec-mocks (~> 3.11.0)
     rspec-core (3.11.0)
       rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
+    rspec-expectations (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
     rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
-    rubocop (1.35.0)
+    rspec-support (3.11.1)
+    rubocop (1.36.0)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.1.2.1)
@@ -67,11 +67,11 @@ GEM
       unicode-display_width (>= 1.4.0, < 3.0)
     rubocop-ast (1.21.0)
       parser (>= 3.1.1.0)
-    rubocop-performance (1.14.3)
+    rubocop-performance (1.15.0)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rspec (2.12.1)
-      rubocop (~> 1.31)
+    rubocop-rspec (2.13.2)
+      rubocop (~> 1.33)
     ruby-progressbar (1.11.0)
     simplecov (0.21.2)
       docile (~> 1.1)
@@ -81,7 +81,7 @@ GEM
     simplecov_json_formatter (0.1.4)
     tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.2.0)
+    unicode-display_width (2.3.0)
 
 PLATFORMS
   x86_64-darwin-19

data/README.md

@@ -11,13 +11,7 @@
 
 [![License](http://img.shields.io/badge/license-MIT-yellowgreen.svg)](#license)
 
-This is a work in process. No breaking changes are expected before v1.0.0.
-
-TODO: Add specs.
-TODO: Better documentation.
-
-mad_flatter is a Ruby gem that takes a Ruby `Hash` and flattens the Hash keys to
-create a new Hash with unique Hash keys; that is, embedded Hashes use their
+mad_flatter is a Ruby gem that takes a Ruby `Hash` and flattens the Hash keys to create a new Hash with unique Hash keys; that is, embedded Hashes use their
 respective keys as namespaces to create unique keys across the entire Hash.
 For example:
 

data/lib/mad_flatter/hash_informable.rb

@@ -9,16 +9,16 @@ module MadFlatter
       hash.each do |key, value|
         if value.is_a? Hash
           load_hash_info(hash: value,
-                         namespace: namespace,
-                         dig: dig << key,
-                         hash_info: hash_info)
+            namespace: namespace,
+            dig: dig << key,
+            hash_info: hash_info)
           dig.pop
         else
           assign_hash_info(hash_info: hash_info,
-                           key: key,
-                           value: value,
-                           namespace: namespace,
-                           dig: dig)
+            key: key,
+            value: value,
+            namespace: namespace,
+            dig: dig)
         end
 
         next

data/lib/mad_flatter/options.rb

@@ -14,10 +14,16 @@ module MadFlatter
       def new(**options)
         immutable_struct_ex = ImmutableStructEx.new(**options) do
           def namespace?
+            return false unless respond_to? :namespace
+
             namespace || false
           end
 
           def metadata?
+            # This should never return false since
+            # the :metadata option is required.
+            return false unless respond_to? :metadata
+
             metadata || false
           end
         end
@@ -26,6 +32,8 @@ module MadFlatter
       end
 
       def with_defaults(options, defaults: DEFAULT_OPTIONS)
+        validate_options_type!(options: options) unless options.respond_to? :to_h
+
         new(**defaults.to_h.merge(options.to_h))
       end
 

data/lib/mad_flatter/options_validatable.rb

@@ -12,17 +12,17 @@ module MadFlatter
     OPTIONS = [OPTION_METADATA, OPTION_NAMESPACE].freeze
 
     def validate_options!(options:)
-      raise ArgumentError, 'options is not a Hash' unless options.is_a? Hash
+      validate_options_type! options: options
 
-      validate_options_present! options: options
+      return if options.blank?
 
       validate_option_keys! options: options
       validate_option_metadata! metadata: options[:metadata]
       validate_option_namespace! namespace: options[:namespace]
     end
 
-    def validate_options_present!(options:)
-      raise ArgumentError, 'options is blank?' if options.blank?
+    def validate_options_type!(options:)
+      raise ArgumentError, "options (#{options.class}) is not a Hash" unless options.is_a? Hash
     end
 
     def validate_option_keys!(options:)
@@ -31,16 +31,16 @@ module MadFlatter
       return if invalid_options.blank?
 
       raise ArgumentError, 'One or more option keys were unrecognized. ' \
-        "#{OPTIONS} was expected but '#{invalid_options} was received."
+                           "#{OPTIONS} was expected but '#{invalid_options}' was received."
     end
 
     def validate_option_metadata!(metadata:)
       return if [TrueClass, FalseClass].include? metadata.class
 
       raise ArgumentError, "option :#{OPTION_METADATA} value is invalid. " \
-        'A TrueClass/FalseClass was expected ' \
-        "with the acceptable values #{OPTION_METADATA_VALUES} " \
-        "but '#{metadata}' (#{metadata.class}) was received."
+                           'A TrueClass/FalseClass was expected ' \
+                           "with the acceptable values #{OPTION_METADATA_VALUES} " \
+                           "but '#{metadata}' (#{metadata.class}) was received."
     end
 
     def validate_option_namespace!(namespace:)
@@ -48,9 +48,8 @@ module MadFlatter
       return if namespace.blank? || namespace.is_a?(Symbol)
 
       raise ArgumentError, "option :#{OPTION_NAMESPACE} value is invalid. " \
-        'A Symbol was expected ' \
-        "with the acceptable values #{OPTION_METADATA_VALUES} " \
-        "but '#{metadata}' (#{metadata.class}) was received."
+                           'A Symbol was expected ' \
+                           "but '#{namespace}' (#{namespace.class}) was received."
     end
   end
 end

data/lib/mad_flatter/service.rb

@@ -12,6 +12,8 @@ module MadFlatter
     include Optionable
 
     def initialize(options: nil)
+      options ||= {}
+
       # Accept whatever options are sent, but make sure
       # we have defaults set up. #with_defaults
       # will merge options into OptionsDefaultable::DEFAULT_OPTIONS
@@ -20,6 +22,8 @@ module MadFlatter
     end
 
     def execute(hash:, options: nil)
+      options ||= {}
+
       # Merge options received into the default options passed through
       # the constructor. Options received here, will override any options
       # passed to the constructor, allowing us to retain defaut options

data/lib/mad_flatter/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MadFlatter
-  VERSION = '1.0.0-beta'
+  VERSION = '2.0.0'
 end

data/lib/mad_flatter.rb

@@ -1,8 +1,13 @@
 # frozen_string_literal: true
 
 require 'active_support'
+require_relative 'mad_flatter/hash_informable'
+require_relative 'mad_flatter/hash_loadable'
+require_relative 'mad_flatter/metadata_optionable'
+require_relative 'mad_flatter/namespace_optionable'
+require_relative 'mad_flatter/optionable'
+require_relative 'mad_flatter/options_defaultable'
+require_relative 'mad_flatter/options_validatable'
+require_relative 'mad_flatter/options'
+require_relative 'mad_flatter/service'
 require_relative 'mad_flatter/version'
-
-Dir[File.join('.', 'lib/mad_flatter/**/*.rb')].each do |f|
-  require f
-end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mad_flatter
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.beta
+  version: 2.0.0
 platform: ruby
 authors:
 - gangelo
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-17 00:00:00.000000000 Z
+date: 2022-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -183,7 +183,6 @@ files:
 - lib/mad_flatter.rb
 - lib/mad_flatter/hash_informable.rb
 - lib/mad_flatter/hash_loadable.rb
-- lib/mad_flatter/hash_retrievable.rb
 - lib/mad_flatter/metadata_optionable.rb
 - lib/mad_flatter/namespace_optionable.rb
 - lib/mad_flatter/optionable.rb
@@ -211,11 +210,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.3.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.3.22
 signing_key:
 specification_version: 4
 summary: mad_flatter gem

data/lib/mad_flatter/hash_retrievable.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module MadFlatter
-  # Defines methods to retrieve model hash values dynamically.
-  module HashRetrievable
-    module_function
-
-    # Returns the value of the hash using fully quaified hash names.
-    def get_hash_value(hash:, hash_info:)
-      hash.dig(*[hash_info[:dig], hash_info[:field_name]].flatten.compact)
-    end
-  end
-end