abstract_builder 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d1510bbd2e6f2501d0dd235dce25b353075165fab4d27c810297c4cf6218de0e
+  data.tar.gz: 0f644442394e9b52fb6de6930c6d9a4de0dd24adee25eec8f449bdc64546b7ba
+SHA512:
+  metadata.gz: 2816f65be6345a916578a231c574ef611b5f2adf9f80e0815660e3a7f74bdd74bc1b1902480c562083e44e4b1ce683aa976858882ef0c2f13146b9ec7c377a0c
+  data.tar.gz: 9bd710bd5eea983fa57a4d279fa427e26e14b76ae2c99cb8ebc3dc6796842262f89c2f1e232689f79cb88c417dcbda0caa748e42105ca9d9e42d31d97c376cae

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.16.0

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 gabriel.sobrinho@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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in abstract_builder.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    abstract_builder (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  abstract_builder!
+  bundler (~> 1.16)
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Gabriel Sobrinho
+
+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,143 @@
+# AbstractBuilder
+
+AbstractBuilder gives you a simple DSL for declaring structures that beats manipulating giant hash structures. This is particularly helpful when the generation process is fraught with conditionals and loops.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'abstract_builder'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install abstract_builder
+
+## Usage
+
+AbstractBuilder gives you a simple DSL for declaring structures:
+
+```ruby
+builder = AbstractBuilder.new
+builder.(company, :name, :created_at, :updated_at)
+builder.size company.employees.count
+builder.merge! company.metadata
+
+builder.address do |address_builder|
+  address_builder.street company.address.street
+  address_builder.number company.address.number
+end
+
+builder.phones company.phones do |phone_builder, phone|
+  phone_builder.number phone.number
+  phone_builder.contact phone.contact
+end
+
+builder.data!
+{
+  :name => "...",
+  :created_at => "...",
+  :updated_at => "...",
+  :size => "...",
+  :metadata => { ... },
+  :address => {
+    :street => "...",
+    :number => "..."
+  },
+  :phones => [
+    {
+      :number => "...",
+      :contact => "..."
+    }
+  ]
+}
+```
+
+Alternatively, you can use the low-level API for declaring complex structures:
+
+```ruby
+builder = AbstractBuilder.new
+
+company.block! company.uuid do |block_builder|
+  block_builder.name company.name
+
+  company.phones.each do |phone|
+    builder.set! "phone_number_#{phone.index}", phone.number
+  end
+
+  company.messages.each_slice(2).each_with_index do |messages, index|
+    builder.array! "messages_#{index}", messages do |message_builder, message|
+      message_builder.content message.content
+    end
+  end
+end
+
+builder.data!
+{
+  "461d84cf-039e-4b86-9e92-8f04cce19a1d" => {
+    :name => "...",
+    :phone_number_0 => "...",
+    :phone_number_1 => "..."
+    :messages_0 => [
+      {
+        :content => "..."
+      },
+      {
+        :content => "..."
+      }
+    ],
+    :messages_1 => [
+      {
+        :content => "..."
+      }
+    ]
+  },
+}
+```
+
+Since the AbstractBuilder is abstract to the data protocol, you may serialize the result into any protocol you want, like JSON:
+
+```ruby
+JSON.dump(builder.data!)
+```
+
+Be aware that if you are doing this over and over again, you can inherit from AbstractBuilder to DRY:
+
+```ruby
+class MyBuilder < AbstractBuilder
+  def to_json
+    JSON.dump(data!)
+  end
+
+  def to_yaml
+    YAML.dump(data!)
+  end
+
+  def to_msgpack
+    MessagePack.pack(data!)
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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 `abstract_builder.gemspec`, 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/sobrinho/abstract_builder. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## 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 AbstractBuilder project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/sobrinho/abstract_builder/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/abstract_builder.gemspec

@@ -0,0 +1,21 @@
+Gem::Specification.new do |spec|
+  spec.name          = "abstract_builder"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Gabriel Sobrinho"]
+  spec.email         = ["gabriel.sobrinho@gmail.com"]
+
+  spec.summary       = %q{AbstractBuilder gives you a simple DSL for declaring structures that beats manipulating giant hash structures.}
+  spec.homepage      = "https://github.com/sobrinho/abstract_builder"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "abstract_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/lib/abstract_builder.rb

@@ -0,0 +1,150 @@
+require 'abstract_builder/null_cache'
+require 'abstract_builder/lazy_cache'
+
+class AbstractBuilder
+  @@format_key = nil
+  @@ignore_value = nil
+  @@cache_store = NullCache.new
+
+  def self.cache_store!(cache_store)
+    @@cache_store = cache_store
+  end
+
+  def self.format_key!(&block)
+    @@format_key = block
+  end
+
+  def self.ignore_value!(&block)
+    @@ignore_value = block
+  end
+
+  def initialize
+    @format_key = @@format_key
+    @ignore_value = @@ignore_value
+    @cache_store = @@cache_store
+    @lazy_cache = LazyCache.new(@@cache_store)
+    @stack = []
+  end
+
+  def format_key!(&block)
+    @format_key = block
+  end
+
+  def ignore_value!(&block)
+    @ignore_value = block
+  end
+
+  def cache_store!(cache_store)
+    @cache_store = cache_store
+    @lazy_cache = LazyCache.new(cache_store)
+  end
+
+  def set!(key, value)
+    @stack << [key, value]
+  end
+
+  def merge!(value)
+    value.each_pair do |key, value|
+      set! key, value
+    end
+  end
+
+  def call(object, *keys)
+    keys.each do |key|
+      set! key, object.public_send(key)
+    end
+  end
+
+  def block!(key, &block)
+    builder = _inherit
+    block.call(builder)
+    value = builder.data!
+
+    set! key, value unless value.empty?
+  end
+
+  def array!(key, collection, &block)
+    values = collection.map do |item|
+      builder = _inherit
+      block.call(builder, item)
+      builder.data!
+    end
+
+    set! key, values
+  end
+
+  def cache!(cache_key, options = {}, &block)
+    cache_key = _compute_cache_key(cache_key)
+
+    @lazy_cache.add(cache_key, options) do
+      builder = _inherit
+      block.call(builder)
+      builder.data!
+    end
+  end
+
+  def data!
+    data = {}
+
+    @stack.each do |(key, value)|
+      key = _format_key(key)
+      data[key] = value unless _ignore_value?(value)
+    end
+
+    @lazy_cache.resolve.each do |value|
+      data.merge!(value)
+    end
+
+    data
+  end
+
+  def method_missing(*args, &block)
+    if args.length == 2 && block
+      array!(args[0], args[1], &block)
+    elsif args.length == 1 && block
+      block!(args[0], &block)
+    elsif args.length == 2
+      set!(args[0], args[1])
+    else
+      raise ArgumentError, <<~EOF.chomp
+        Expected 1 argument without a block, 0 arguments with a block or 1 argument with a block.
+
+        This is `AbstractBuilder#set!', `AbstractBuilder#block!' or `AbstractBuilder#array!' signatures, example:
+
+            builder.content post.content
+
+            builder.meta do |meta_builder|
+              meta_builder.hashtags post.hashtags
+            end
+
+            builder.comments post.comments do |comment_builder, comment|
+              comment_builder.content comment.content
+            end
+
+        Received `#{args[0]}' with #{args.length - 1} argument#{'s' if args.length > 2} #{block ? "with a block" : "without a block"}.
+      EOF
+    end
+  end
+
+  private
+
+  def _format_key(key)
+    @format_key ? @format_key.call(key) : key
+  end
+
+  def _inherit
+    builder = self.class.new
+    builder.format_key!(&@format_key)
+    builder.ignore_value!(&@ignore_value)
+    builder.cache_store!(@cache_store)
+    builder
+  end
+
+  def _compute_cache_key(cache_key)
+    [:abstract_builder, :v1, cache_key]
+  end
+
+  def _ignore_value?(value)
+    @ignore_value && @ignore_value.call(value)
+  end
+end

data/lib/abstract_builder/lazy_cache.rb

@@ -0,0 +1,42 @@
+class AbstractBuilder
+  class LazyCache
+    def initialize(driver)
+      @cache = Hash.new { |h, k| h[k] = {} }
+      @driver = driver
+    end
+
+    def add(key, options, &block)
+      cache[options][key] = block
+    end
+
+    def resolve
+      resolved = []
+
+      # Fail-fast if there is no items to be computed.
+      return resolved if cache.empty?
+
+      # We can't add new items during interation, so iterate through a clone
+      # that will allow us to add new items.
+      previous = cache.clone
+      cache.clear
+
+      # Keys are grouped by options and because of that, fetch_multi will use
+      # the same options for the same group of keys.
+      previous.each do |options, group|
+        result = driver.fetch_multi(*group.keys, options) do |group_key|
+          [group[group_key].call, *resolve]
+        end
+
+        # Since the fetch_multi returns { cache_key => value }, we need to
+        # discard the cache key and merge only the values.
+        resolved.concat result.values.flatten(1)
+      end
+
+      resolved
+    end
+
+    private
+
+    attr_reader :cache, :driver
+  end
+end

data/lib/abstract_builder/null_cache.rb

@@ -0,0 +1,19 @@
+class AbstractBuilder
+  class NullCache
+    def fetch(key, _options = nil, &block)
+      block.call
+    end
+
+    def fetch_multi(*keys, options, &block)
+      result = {}
+
+      keys.each do |key|
+        result[key] = fetch(key, options) do
+          block.call(key)
+        end
+      end
+
+      result
+    end
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: abstract_builder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gabriel Sobrinho
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- gabriel.sobrinho@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- abstract_builder.gemspec
+- bin/console
+- bin/setup
+- lib/abstract_builder.rb
+- lib/abstract_builder/lazy_cache.rb
+- lib/abstract_builder/null_cache.rb
+homepage: https://github.com/sobrinho/abstract_builder
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.2
+signing_key: 
+specification_version: 4
+summary: AbstractBuilder gives you a simple DSL for declaring structures that beats
+  manipulating giant hash structures.
+test_files: []