finest-builder 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66c7b96883a0a0dfec0738a446e283eda837a06585d04309c07badf3425b0d96
-  data.tar.gz: 2ba3a8157b0ec1e4e42e5f9f77810cab68dfc5f91a5ab6d6689cdf330ebe3d1b
+  metadata.gz: 9500bcd59f3997b96597a06dc0548ab86a2b545ae1ded571462cbec3952b1aee
+  data.tar.gz: 6c03ffce45508b415c81afe0627948051fc9119e1c109326de8651bf1a12c1ee
 SHA512:
-  metadata.gz: fe4a9c7f0f9cdac5d70dd4ab0c0f31fb71b1efffd3171b3279a1fc184e5cd42d1ebbf5432740a7b5de76ad35406de5b3acd9ef337c0e9dc45ac5106a0f921e1d
-  data.tar.gz: 8c306f2dce9adda3937b47f8f43b0f60cdff083cce5b04163cb4ecab88d83e3ce4d30779b7b16ab44a7e5dd83f594136c37ce9139e4c44f43951d4b75afb96bb
+  metadata.gz: 0a9bd352545dc30bbdc85a03188b9dc3c713d6e84541753a713ec0aa116e6b01660b8ea0df212905899becaac25aa1172868543fd857c4129bb105a544d07477
+  data.tar.gz: 23a85268461f0283bbfcaae50059faa6830b5784a2588dcae1e637df4b31a431267e4b22526445b0bb6a90db70719cc7e2088a0a46197bf16f05630c7df6eba6

data/.ruby-version

@@ -0,0 +1 @@
+3.3.0

data/finest-builder.gemspec

@@ -3,16 +3,16 @@
 require_relative 'lib/finest/builder/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = 'finest-builder'
-  spec.version       = Finest::Builder::VERSION
-  spec.authors       = ['Eduard Garcia Castello']
-  spec.email         = %w[edugarcas@gmail.com eduard@rzilient.club]
+  spec.name = 'finest-builder'
+  spec.version = Finest::Builder::VERSION
+  spec.authors = ['Eduard Garcia Castello']
+  spec.email = %w[edugarcas@gmail.com eduard@rzilient.club]
 
-  spec.summary       = %q{Builder modules to create either class ghost methods from a given JSON or a OpenStruct}
-  #spec.description   = %q{TODO: Write a longer description or delete this line.}
-  spec.homepage      = 'https://github.com/eddygarcas/finest-builder'
-  spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 3.1.2')
+  spec.summary = %q{Builder modules to create either class ghost methods from a given JSON or a OpenStruct}
+  # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage = 'https://github.com/eddygarcas/finest-builder'
+  spec.license = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 3.3.0')
 
   spec.metadata['allowed_push_host'] = 'https://rubygems.org/'
 
@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 end

data/lib/finest/builder/version.rb

@@ -1,5 +1,5 @@
 module Finest
   module Builder
-    VERSION = "2.0.0"
+    VERSION = "2.0.1"
   end
 end

data/lib/finest/builder.rb

@@ -13,7 +13,7 @@ module Finest
   # Finest Builder
   module Helper
 
-    # Parses a given json structure looking for specific keys inside the structure if passed
+    # Parses a given +json+ structure looking for specific +keys+ and creating instance methods for each key.
     #
     # The result it's stored on a instance variable called to_h and accessible through accessor with same name
     # as well as it created a instance method for every key.
@@ -25,7 +25,7 @@ module Finest
     #   e.client.to_h[:id_sa]
     #   e.client.id_sa
     #
-    # Any key value less than three characters will just be down cased.
+    # Any key value less than seven characters will just be down cased.
     #   e.client.to_h[:id]
     #   e.client.id
     #
@@ -35,8 +35,10 @@ module Finest
       raise ArgumentError unless keys&.respond_to?(:each)
 
       json.transform_keys!(&:to_s)
-      keys&.reject! { |key| key.end_with?('=') }
-      keys&.each do |key|
+      keys.reject! { |key| key.end_with?('=') }
+      keys.each do |key|
+        # Next call will provoke a +method_missing+ call that will later call to +accessor_builder+ method
+        # which eventually will define both methods +setter+ and +getter+ for the instance variable.
         send("#{key.to_s.snake_case}=", nested_hash_value(json, key.to_s))
       end
       yield self if block_given?
@@ -51,14 +53,13 @@ module Finest
     end
 
     # Goes through a complex Hash nest and gets the value of a passed key.
-    # First wil check whether the object has the key? method,
-    # which will mean it's a Hash and also if the Hash the method parameter key
+    # First wil check whether the object has the +key?+ method,
+    # which means it's a +Hash+. If so, will look for the key and return its value.
     #   if obj.respond_to?(:key?) && obj.key?(key)
     #
     # If result object is a hash itself, will call constructor method to parse this hash first.
     #
-    #  if obj[key].is_a?(Hash)
-    #           self.class.new(obj[key])
+    #  if obj[key].is_a?(Hash) self.class.new(obj[key]) end;
     #
     # If it's an array, will call the constructor method for each element of the array, mapping the result.
     #
@@ -72,17 +73,25 @@ module Finest
     # If eventually the keys was not found, it will assign nil to the instance variable.
     #
     def nested_hash_value(obj, key)
+      # Check if the object is a +Hash+ and if that +Hash+ contains the key passed as parameter.
       if obj.respond_to?(:key?) && obj.key?(key)
+        # If the value of the key is a +Hash+ will call the constructor method to parse this hash first.
+        # This way we can go through the nested hash looking for the key, calling itself recursively.
         if obj[key].is_a?(Hash)
           self.class.new(obj[key])
-        elsif (obj[key].is_a?(Array))
+          # If the value of the key is an +Array+ instead, will map the result of the constructor method for each
+          # element of the array.
+        elsif obj[key].is_a?(Array)
           obj[key].map! do |a|
             a.respond_to?(:key?) ? self.class.new(a) : a
           end
         else
+          # If the value of the key is not a +Hash+ nor an +Array+ will just return the value as it was found.
           obj[key]
         end
       elsif obj.respond_to?(:each)
+        # If the object was an +Array+ in the first place, will recursively call itself for each element
+        # of the array passing the key we are looking for as parameter.
         r = nil
         obj.find do |*a|
           r = nested_hash_value(a.last, key)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: finest-builder
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Eduard Garcia Castello
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-11-14 00:00:00.000000000 Z
+date: 2024-02-13 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -19,6 +19,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".ruby-version"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -46,14 +47,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.2
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.4
 signing_key: 
 specification_version: 4
 summary: Builder modules to create either class ghost methods from a given JSON or