finest-builder 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f6bd0969d3381163aa131504fea2d04442e65c2534487ee0868111e3e4cf1fba
+  data.tar.gz: b4fb3de4f0660a3031faa62ab4c65c07b9d98e96f133d8ec8bf0a44eea068ac0
+SHA512:
+  metadata.gz: 9aaf7f776df73d89f7b533a98f359b1a6722b2bcd27c532223c13850d400d1be194bc5ab4c7cd562ddb2c1f30c86fdc20c33f204b7cf2a6be68f386ac3478f2a
+  data.tar.gz: 545dec40b0e4b13887abd815908782a3322cba6363cc12bcdbfaedfdcb8b65fb604cf798e3084df2a4889679cd5d2ee4c2d8a1e070444764765e80262e9b4535

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/*
+Gemfile.lock
+/.idea/

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at edugarcas@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Eduard
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,95 @@
+# 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)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'finest-builder'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install finest-builder
+
+## Usage
+OpenStruct and accessor builder modules.
+
+### Used as OpenStruct
+Initialize an instance using json data, including the Builder class on your class definition.
+Once initialized just use the accessors as any other instance. 
+```ruby
+  class Issue
+    include Finest::Struct
+
+    def initialize(json = nil)
+      super json
+    end
+  end
+  
+  issue = Issue.new({id: 1234})
+  issue.id # => 1234
+```
+
+### Used on ActiveRecord models
+Finest-Builder includes another helper that can be used to initialize *ActiveRecord* models based on its column names.
+In case not using column names but an array of method names, new accessors would be crated to access those methods.
+```ruby
+  class Issue < ApplicationRecord
+    include Finest::Helper
+  end
+    
+  issue = Issue.new.build_by_keys({id: 1234,text: "hocus pocus"},Issue.column_names) # => Issue.column_names = id:
+  issue.as_json # => {id: 1234}
+  issue.to_h # => nil
+  
+  issue = Issue.new.build_by_keys({id: 1234,text: "hocus pocus"}) # => Issue.column_names = id:
+  issue.id # => {id: 1234}
+  issue.text # => {text: "hocus pocus"}
+  issue.as_json #=> {id: 1234,text: "hocus pocus"}
+  issue.to_h # => nil
+```
+
+
+Call *build_by_keys* method once the model has been initialized passing a json message,
+it would *yield* itself as a block in case you want to perform further actions. 
+```ruby  
+  build_by_keys(json = {},keys = nil) 
+```
+This method would also create an instance variable called *@to_h* contains a pair-value hash as a result. 
+*@to_h* instance variable won't be available if the class inherits from *ActiveRecord::Base* 
+
+### Auxiliary methods
+Finest-Builder comes with two extra methods to search and create instance variable and methods.
+It creates a instance variable along with its accessor methods (read/write).
+```ruby  
+  accessor_builder(key, value) 
+```
+This method goes through the whole object, being a hash, looking for the passed key and return the value found.
+```ruby  
+  nested_hash_value(obj, key) 
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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).
+
+## 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).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Finest::Builder project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/binky-builder/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "finest/builder"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/finest-builder.gemspec

@@ -0,0 +1,29 @@
+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         = ["eduard@rzilient.club"]
+
+  spec.summary       = %q{Builder modules to create either class ghost methods from a given json or an open struct.}
+  #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.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"
+
+  # 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
+    `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.require_paths = ["lib"]
+end

data/lib/finest/builder.rb

@@ -0,0 +1,95 @@
+require "binky/builder/version"
+
+module Binky
+  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?('=')}
+      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)})
+      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)})
+    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
+    #   if obj.respond_to?(:key?) && obj.key?(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)
+    #
+    # For every Array found it make a recursive call to itself passing
+    # the last element of the array and the Key it's looking for.
+    #   r = nested_hash_value(a.last, key)
+    def nested_hash_value(obj, key)
+      if obj.respond_to?(:key?) && obj.key?(key)
+        obj[key]
+      elsif obj.respond_to?(:each)
+        r = nil
+        obj.find do |*a|
+          r = nested_hash_value(a.last, key)
+        end
+        r
+      end
+    end
+
+
+    def method_missing(name,*args)
+      accessor_builder(name.to_s.gsub(/=$/,''), args[0]) if name.to_s =~ /=$/
+    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)}
+    end
+  end
+
+  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)
+      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
+      else
+        @to_h[attribute]
+      end
+    end
+  end
+
+  module Builder
+    class Error < StandardError; end
+    include Helper
+    alias_method :initialize,:build_by_keys
+  end
+
+end

data/lib/finest/builder/version.rb

@@ -0,0 +1,5 @@
+module Finest
+  module Builder
+    VERSION = "0.0.1"
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: finest-builder
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Eduard Garcia Castello
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-04-28 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- eduard@rzilient.club
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- finest-builder.gemspec
+- lib/finest/builder.rb
+- lib/finest/builder/version.rb
+homepage: https://github.com/eddygarcas/finest-builder
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  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: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Builder modules to create either class ghost methods from a given json or
+  an open struct.
+test_files: []