keyword_builder 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 743dfc25e553bb58429f988d10aa0e1b4b78b5c6d0cf285b88215485047257ea
+  data.tar.gz: 8153a618882d9a8aece384223901b7ac4aa073faa8ecee9e65fe91016ecc0bf4
+SHA512:
+  metadata.gz: a4e2df82927a3f3f1c3249af0d266b7b7e8da191415de8798d48d80992b159479e751a66a410af99b098f4ec78cb16ace3966d9c5c28a2ab06a9f12cfe58fb1a
+  data.tar.gz: ec0a214b4ebb2ad2f8c5a627891dbb969e718c0dc4ce9d75c1e1f9a95f8ce5b97dc7de6cddb9eae242a0be2cd18e914b0bb6651762a8b00404765470d2546c92

data/.circleci/config.yml

@@ -0,0 +1,95 @@
+version: 2.1
+
+executors:
+  ruby:
+    parameters:
+      ruby-version:
+        type: string
+        default: "2.6"
+      gemfile:
+        type: string
+        default: "Gemfile"
+    docker:
+      - image: circleci/ruby:<< parameters.ruby-version >>
+        environment:
+          BUNDLE_JOBS: 3
+          BUNDLE_RETRY: 3
+          BUNDLE_PATH: vendor/bundle
+          RAILS_ENV: test
+          BUNDLE_GEMFILE: << parameters.gemfile >>
+
+jobs:
+  test:
+    parameters:
+      ruby-version:
+        type: string
+    executor:
+      name: ruby
+      ruby-version: << parameters.ruby-version >>
+    parallelism: 1
+    steps:
+      - checkout
+
+      - run:
+          # Remove the non-appraisal gemfile for safety: we never want to use it.
+          name: Prepare bundler
+          command: bundle -v
+
+      - run:
+          name: Compute a gemfile lock
+          command: bundle lock && cp "${BUNDLE_GEMFILE}.lock" /tmp/gem-lock
+
+      - restore_cache:
+          keys:
+            - keyword_builder-<< parameters.ruby-version >>-{{ checksum "/tmp/gem-lock" }}
+            - keyword_builder-
+
+      - run:
+          name: Bundle Install
+          command: bundle check || bundle install
+
+      - save_cache:
+          key: keyword_builder-<< parameters.ruby-version >>-{{ checksum "/tmp/gem-lock" }}
+          paths:
+            - vendor/bundle
+
+      - run:
+          name: Run rspec
+          command: bundle exec rspec --profile 10 --format RspecJunitFormatter --out test_results/rspec.xml --format progress
+
+      - store_test_results:
+          path: test_results
+
+  publish:
+    executor: ruby
+    steps:
+       - checkout
+       - run:
+           name: Setup Rubygems
+           command: |
+             mkdir ~/.gem &&
+             echo -e "---\r\n:rubygems_api_key: $RUBYGEMS_API_KEY" > ~/.gem/credentials &&
+             chmod 0600 ~/.gem/credentials
+       - run:
+           name: Publish to Rubygems
+           command: |
+             gem build keyword_builder.gemspec
+             gem push keyword_builder-*.gem
+
+
+workflows:
+  version: 2.1
+  build:
+    jobs:
+      - test:
+          name: "ruby 2.5"
+          ruby-version: "2.5"
+      - test:
+          name: "ruby 2.6"
+          ruby-version: "2.6"
+      - publish:
+          filters:
+            branches:
+              only: master
+            tags:
+              ignore: /.*/

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in keyword_builder.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2018 DMM.com
+
+MIT License
+
+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,24 @@
+# KeywordBuilder
+
+KeywordBuilder is a simple wrapper to create a builder-style DSL for any method
+taking keyword arguments.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'keyword_builder'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install keyword_builder
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/iknow/keyword_builder.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "keyword_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/keyword_builder.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'keyword_builder/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'keyword_builder'
+  spec.version       = KeywordBuilder::VERSION
+  spec.authors       = ['DMM Eikaiwa']
+  spec.email         = ['dev@iknow.jp']
+
+  spec.summary       = 'DSL builder interface to wrap keyword constructors.'
+  spec.homepage      = 'https://github.com/iknow/keyword_builder'
+  spec.license       = 'MIT'
+
+  # 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(__dir__)) 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']
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec_junit_formatter'
+end

data/lib/keyword_builder.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+# Abstract builder interface for types with keyword argument constructors.
+class KeywordBuilder
+  class BuilderError < ArgumentError; end
+
+  class << self
+    def create(clazz, constructor: :new)
+      keywords, wildcard = parse_constructor_parameters(clazz, constructor)
+
+      Class.new(self) do
+        define_singleton_method(:clazz) { clazz }
+        define_singleton_method(:constructor) { constructor }
+        define_singleton_method(:keywords) { keywords }
+        define_singleton_method(:wildcard?) { wildcard }
+        keywords.each do |keyword|
+          define_method(keyword) { |*args, &block| _set_attribute(keyword, *args, &block) }
+        end
+      end
+    end
+
+    def valid_keyword?(param)
+      wildcard? || keywords.include?(param)
+    end
+
+    def build!(**initial_attrs, &block)
+      builder = self.new(initial_attrs)
+      builder.instance_eval(&block) if block_given?
+      clazz.public_send(constructor, **builder.attrs)
+    end
+
+    private
+
+    def parse_constructor_parameters(clazz, constructor)
+      parameters =
+        if constructor == :new
+          clazz.instance_method(:initialize).parameters
+        else
+          clazz.method(constructor).parameters
+        end
+
+      keywords = Set.new
+      wildcard = false
+
+      parameters.each do |type, name|
+        case type
+        when :opt, :rest
+          next
+        when :key, :keyreq
+          keywords << name
+        when :keyrest
+          wildcard = true
+        else
+          raise ArgumentError.new("Invalid builder method, contains required non-keyword parameter #{name}")
+        end
+      end
+
+      [keywords.freeze, wildcard]
+    end
+  end
+
+  attr_reader :attrs
+
+  def initialize(initial_attrs)
+    @attrs = initial_attrs.dup
+  end
+
+  def _set_attribute(attr, *args, &block)
+    if attrs.has_key?(attr)
+      raise BuilderError.new("Invalid builder state: #{attr} already provided")
+    end
+
+    value =
+      if block_given?
+        raise ArgumentError.new('Cannot provide both immediate and block value') unless args.blank?
+
+        block
+      elsif args.size == 1
+        args[0]
+      else
+        raise ArgumentError.new('Wrong number of arguments: expected 1 or block')
+      end
+
+    attrs[attr] = value
+  end
+
+  def method_missing(attr, *args, &block)
+    if self.class.wildcard?
+      _set_attribute(attr, *args, &block)
+    else
+      super
+    end
+  end
+
+  def respond_to_missing?(attr, _include_all = false)
+    self.class.wildcard? || super
+  end
+end

data/lib/keyword_builder/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class KeywordBuilder
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: keyword_builder
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- DMM Eikaiwa
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- dev@iknow.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- keyword_builder.gemspec
+- lib/keyword_builder.rb
+- lib/keyword_builder/version.rb
+homepage: https://github.com/iknow/keyword_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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: DSL builder interface to wrap keyword constructors.
+test_files: []