finest-builder 0.0.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '018ef6f0c97be9bf47f517b2ac49831f84c679225d85f0755d8b9786d8908f7c'
-  data.tar.gz: ac90aad8f8b4efab4736931e097d885a54119d8fdd2f1daad2b03653a4ce7d10
+  metadata.gz: 6e146958c0527929112ef202b28806eca032b460d5ab0db7fe7ed4d5071d0fbf
+  data.tar.gz: a89df1b3b477cf4fa4104a4086d0426b0530f0f794fc6c2dca69c651321e9ddb
 SHA512:
-  metadata.gz: b018cc343c668f7a654d3c1609f6bbaa61ddbb59269312f07b9b46e4bcb27b2d4cb17ef3b0bbb05c7800588d646896e5be1775315a570ebed19714077403a9d0
-  data.tar.gz: 4472b5431bb7b1159d5cd14e245a7eb3c3fa291ebcb82e56938252a27c8f26ce7248efbb72d219ab0d1578a9173df79c0673b7c9458614dd4b874a18c50fc0bf
+  metadata.gz: a42f861011bd9b67bd10f665ffc90d1e4724d9e35e0cc9dcdbcaf81adf667790e90a2d12bcd10dd9db24485ca580792ce1271d1fc89076e067304fccd077597f
+  data.tar.gz: b70fe07db6f8214e09505f9e7db3c4be89e061183b6f03d01b0ed3dd5e684ecbf538abf26b4e521b8523255bb7a260331aa20ecedf24354df2cee7b8fe2b1e1e

data/Gemfile

@@ -3,5 +3,5 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in finest-builder.gemspec
 gemspec
 
-gem "rake", "~> 12.0"
-gem "minitest", "~> 5.0"
+gem "rake"
+gem "minitest"

data/README.md

@@ -1,4 +1,4 @@
-# Finest::Builder ![Travis](https://travis-ci.org/eddygarcas/finest-builder.svg) [![Gem Version](https://badge.fury.io/rb/binky-builder.svg)](https://badge.fury.io/rb/binky-builder)
+# Finest::Builder ![Travis](https://travis-ci.com/eddygarcas/finest-builder.svg) [![Gem Version](https://badge.fury.io/rb/finest-builder.svg)](https://badge.fury.io/rb/finest-builder)
 
 ## Installation
 
@@ -81,9 +81,11 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+Rake issues  bundle install --path vendor/cache
+
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/eddygarcas/finest-builder. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/binky-builder/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/eddygarcas/finest-builder. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/Finest-builder/blob/master/CODE_OF_CONDUCT.md).
 
 
 ## License

data/finest-builder.gemspec

@@ -1,29 +1,31 @@
+# frozen_string_literal: true
+
 require_relative 'lib/finest/builder/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "finest-builder"
+  spec.name          = 'finest-builder'
   spec.version       = Finest::Builder::VERSION
-  spec.authors       = ["Eduard Garcia Castello"]
-  spec.email         = ["eduard@rzilient.club"]
+  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 an open struct.}
+  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(">= 2.3.0")
+  spec.homepage      = 'https://github.com/eddygarcas/finest-builder'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
 
-  spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org/'
 
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/eddygarcas/finest-builder"
-  spec.metadata["changelog_uri"] = "https://github.com/eddygarcas/finest-builder"
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/eddygarcas/finest-builder'
+  spec.metadata['changelog_uri'] = 'https://github.com/eddygarcas/finest-builder'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  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.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 end

data/lib/finest/builder.rb

@@ -1,37 +1,65 @@
-require "finest/builder/version"
+# frozen_string_literal: true
+
+require 'finest/builder/version'
+
+# Add snake case in String
+class String
+  def snake_case
+    length > 7 ? strip.gsub(/(\w[A-Z]|\s\S)/) { |e| "#{e[0].strip}_#{e[1].strip.downcase}" }.downcase : strip.downcase
+  end
+end
 
 module Finest
+  # Finest Builder
   module Helper
 
-    # Parses a given json structure looking for specific keys inside the structure.
-    # Keys are given through a block.
-    # The result of it it's stored on a instance variable called to_hash and accessible through accessors with same name.
-    def build_by_keys(json = {}, keys = nil)
-      k = keys || json&.keys
-      raise ArgumentError "keys argument is not an array" unless k&.respond_to?(:each)
-      accessor_builder('to_h',{}) unless self.class.method_defined?(:as_json)
-      json.transform_keys!(&:to_s)
-      k&.reject!{|ky| ky.end_with?('=')}
+    # Parses a given json structure looking for specific keys inside the structure if passed
+    #
+    # 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.
+    # All methods are created using the snake case approach.
+    #
+    #   e = MyObjectBuilder.new({"client"=> {"idSA"=>1,"id"=>3434, "ManagementType"=>"iOSUnsupervised"}})
+    #
+    # Result:
+    #   e.client.to_h[:id_sa]
+    #   e.client.id_sa
+    #
+    # Any key value less than three characters will just be down cased.
+    #   e.client.to_h[:id]
+    #   e.client.id
+    #
+    def build_by_keys(**args)
+      k = args[:keys] || args.fetch(:json, {})&.keys
+      raise ArgumentError unless k&.respond_to?(:each)
+
+      accessor_builder('to_h', {}) unless self.class.method_defined?(:as_json)
+      args.fetch(:json, {}).transform_keys!(&:to_s)
+      k&.reject! { |ky| ky.end_with?('=') }
       k&.each do |key|
-        self.send("#{key}=",nested_hash_value(json, key.to_s))
-        @to_h&.merge!({key.to_sym => nested_hash_value(json,key.to_s)})
+        send("#{key.to_s.snake_case}=", nested_hash_value(args.fetch(:json, {}), key.to_s))
+        @to_h&.merge!({ key.to_s.snake_case.to_sym => send(key.to_s.snake_case.to_s) })
       end
       yield self if block_given?
       self
     end
 
     # Builds an instance variable as well as its class method accessors from a key value pair.
-    def accessor_builder(k, v)
-      self.instance_variable_set("@#{k}", v)
-      self.class.send(:define_method, "#{k}", proc {self.instance_variable_get("@#{k}")})
-      self.class.send(:define_method, "#{k}=", proc {|v| self.instance_variable_set("@#{k}", v)})
+    def accessor_builder(key, val)
+      instance_variable_set("@#{key}", val)
+      self.class.send(:define_method, key.to_s, proc { instance_variable_get("@#{key}") })
+      self.class.send(:define_method, "#{key}=", proc { |val| instance_variable_set("@#{key}", val) })
     end
 
-    #Goes through a complex Hash nest and gets the value of a passed key.
+    # 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
     #   if obj.respond_to?(:key?) && obj.key?(key)
     #
+    # If result object is a hash itself, will call constructor method to parse this hash first.
+    #
+    #   obj[key].is_a?(Hash) ? self.class.new(obj[key]) : obj[key]
+    #
     # If it's not a Hash will check if it's a Array instead,
     # checking out whether it responds to a Array.each method or not.
     #   elsif obj.respond_to?(:each)
@@ -41,7 +69,7 @@ module Finest
     #   r = nested_hash_value(a.last, key)
     def nested_hash_value(obj, key)
       if obj.respond_to?(:key?) && obj.key?(key)
-        obj[key]
+        obj[key].is_a?(Hash) ? self.class.new(json: obj[key]) : obj[key]
       elsif obj.respond_to?(:each)
         r = nil
         obj.find do |*a|
@@ -51,45 +79,55 @@ module Finest
       end
     end
 
-
-    def method_missing(name,*args)
-      accessor_builder(name.to_s.gsub(/=$/,''), args[0]) if name.to_s =~ /=$/
+    def method_missing(name, *args)
+      accessor_builder(name.to_s.gsub(/=$/, ''), args[0]) if name.to_s =~ /=$/
     end
 
+    def respond_to_missing?; end
+
     def attribute_from_inner_key(elem, attr, in_key = nil)
-      {attr.to_sym => nested_hash_value(elem, in_key&.present? ? in_key : attr.to_s)}
+      { attr.to_sym => nested_hash_value(elem, in_key&.present? ? in_key : attr.to_s) }
     end
+
   end
 
+  # Finest Struct
   module Struct
     class Error < StandardError; end
+
     include Helper
 
-    def initialize(json = nil)
-      accessor_builder('to_h',{})
-      json&.each do |k, v|
-        self.send("#{k}=", v)
+    def initialize(**args)
+      accessor_builder('to_h', {})
+      args[:json]&.each do |k, v|
+        send("#{k}=", v)
       end
     end
 
     def method_missing(name, *args)
       attribute = name.to_s.start_with?(/\d/) ? "_#{name.to_s}" : name.to_s
       if attribute =~ /=$/
-        if args[0].respond_to?(:key?) || args[0].is_a?(Hash)
-          @to_h[attribute.chop] = self.class.new(args[0])
-        else
-          @to_h[attribute.chop] = args[0]
-        end
+        @to_h[attribute.chop] =
+          if args[0].respond_to?(:key?) || args[0].is_a?(Hash)
+            self.class.new(args[0])
+          else
+            args[0]
+          end
       else
         @to_h[attribute]
       end
     end
+
+    def respond_to_missing?; end
+
   end
 
+  # Finest Builder
   module Builder
     class Error < StandardError; end
+
     include Helper
-    alias_method :initialize,:build_by_keys
+    alias initialize build_by_keys
   end
 
 end

data/lib/finest/builder/version.rb

@@ -1,5 +1,5 @@
 module Finest
   module Builder
-    VERSION = "0.0.3"
+    VERSION = "1.0.0"
   end
 end

metadata

@@ -1,17 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: finest-builder
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Eduard Garcia Castello
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-28 00:00:00.000000000 Z
+date: 2021-08-16 00:00:00.000000000 Z
 dependencies: []
-description: 
+description:
 email:
+- edugarcas@gmail.com
 - eduard@rzilient.club
 executables: []
 extensions: []
@@ -37,7 +38,7 @@ metadata:
   homepage_uri: https://github.com/eddygarcas/finest-builder
   source_code_uri: https://github.com/eddygarcas/finest-builder
   changelog_uri: https://github.com/eddygarcas/finest-builder
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -52,9 +53,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
-summary: Builder modules to create either class ghost methods from a given json or
-  an open struct.
+summary: Builder modules to create either class ghost methods from a given JSON or
+  a OpenStruct
 test_files: []