verbalize 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f008ed2bf42154162943268c8c10d75ca09ca586
+  data.tar.gz: fdc71af9ad1a73d1f49ce85ec2bbc94a4870c1ac
+SHA512:
+  metadata.gz: 85ba485dee2564adb6cb8a3d3ca073a05f7cf27f65ef94599664575e64ae10d2d009c3d0bc404e1dc332e88f95c778f8e2bf7ff311cc314e3feace3fd0728f69
+  data.tar.gz: 5cda9a96c5e0162fd9f3f16645f85dcd8cefb6a1b8c0db49091b7ce4aff594eeedc2e28ba1fa9f229e1589f7d8fe77beed2a992cf604ed00cd920ef47d143083

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 2.1
+
+Metrics/LineLength:
+  Max: 90
+
+Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Zach Taylor
+
+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,185 @@
+# Verbalize
+
+[![Build Status](https://circleci.com/gh/taylorzr/verbalize.svg?style=shield&circle-token=58dcd03ffacd1c21e57766a0fba6b2008bafd777)](https://circleci.com/gh/taylorzr/verbalize/tree/master) [![Coverage Status](https://coveralls.io/repos/github/taylorzr/verbalize/badge.svg?branch=master)](https://coveralls.io/github/taylorzr/verbalize?branch=master)
+
+## Usage
+
+```ruby
+class Add
+  include Verbalize
+
+  input :a, :b
+
+  def call
+    a + b
+  end
+end
+
+result = Add.call(a: 35, b: 7)
+result.outcome # => :ok
+result.value # => 42
+result.succeeded? # => true
+result.failed? # => false
+
+outcome, value = Add.call(a: 35, b: 7)
+outcome # => :ok
+value # => 42
+```
+
+```ruby
+class Add
+  include Verbalize
+
+  input :a, :b
+
+  def call
+    a + b
+  end
+
+  private
+
+  def a
+    @a ||= 35
+  end
+
+  def b
+    @b ||= 7
+  end
+end
+
+Add.call # => [:ok, 42]
+Add.call(a: 42, b: 0) # => [:ok, 42]
+```
+
+```ruby
+class Divide
+  include Verbalize
+
+  input :a, :b
+
+  def call
+    fail! 'You can’t divide by 0' if b == 0
+    a / b
+  end
+end
+
+result = Divide.call(a: 1, b: 0) # => [:error, 'You can’t divide by 0']
+result.failed? # => true
+```
+
+## Comparison/Benchmark
+```ruby
+class RubyAdd
+  def self.call(a:, b:)
+    new(a: a, b: b).call
+  end
+
+  def initialize(a:, b:)
+    @a = a
+    @b = b
+  end
+
+  def call
+    a + b
+  end
+
+  private
+
+  attr_reader :a, :b
+end
+```
+
+```ruby
+class VerbalizeAdd
+  include Verbalize
+
+  input :a, :b
+
+  def call
+    a + b
+  end
+end
+```
+
+```ruby
+class ActionizerAdd
+  include Actionizer
+
+  def call
+    output.sum = input.a + input.b
+  end
+end
+```
+
+```ruby
+class InteractorAdd
+  include Interactor
+
+  def call
+    context.sum = context.a + context.b
+  end
+end
+```
+
+```ruby
+require 'benchmark/ips'
+
+Benchmark.ips do |x|
+  x.report('Ruby')       { RubyAdd.call(a: 1, b: 2) }
+  x.report('Verbal')     { VerbalAdd.call(a: 1, b: 2) }
+  x.report('Actionizer') { ActionizerAdd.call(a: 1, b: 2) }
+  x.report('Interactor') { InteractorAdd.call(a: 1, b: 2) }
+  x.compare!
+end
+```
+
+```
+Calculating -------------------------------------
+          Interactor      4619 i/100ms
+          Actionizer      4919 i/100ms
+              Verbal     21841 i/100ms
+                Ruby     43212 i/100ms
+-------------------------------------------------
+          Interactor    46966.6 (±7.5%) i/s -     235569 in   5.046586s
+          Actionizer    48493.5 (±6.0%) i/s -     245950 in   5.091045s
+              Verbal   259273.2 (±4.7%) i/s -    1310460 in   5.065844s
+                Ruby   618459.0 (±5.4%) i/s -    3111264 in   5.046011s
+
+Comparison:
+                Ruby:   618459.0 i/s
+              Verbal:   259273.2 i/s - 2.39x slower
+          Actionizer:    48493.5 i/s - 12.75x slower
+          Interactor:    46966.6 i/s - 13.17x slower
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'verbalize'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install verbalize
+
+## 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 `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/taylorzr/verbalize.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'verbalize'
+
+# 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

data/bin/setup

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

data/circle.yml

@@ -0,0 +1,7 @@
+machine:
+  ruby:
+    version: '2.1'
+
+test:
+  post:
+    - bundle exec rubocop

data/lib/verbalize.rb

@@ -0,0 +1,42 @@
+require 'verbalize/version'
+require 'verbalize/build_initialize'
+require 'verbalize/build_action'
+require 'verbalize/build_attributes'
+require 'verbalize/build_argument_validator'
+require 'verbalize/result'
+
+module Verbalize
+  def outcome
+    @outcome = @fail || :ok
+  end
+
+  def fail!(failure_value)
+    @fail = :error
+    throw :verbalize_error, failure_value
+  end
+
+  def self.included(target)
+    target.extend ClassMethods
+  end
+
+  module ClassMethods
+    def call
+      action = new
+      value = catch(:verbalize_error) { action.call }
+      Result.new(outcome: action.outcome, value: value)
+    end
+
+    def input(*arguments, verbalize_method_name: :call, **keyword_arguments)
+      raise ArgumentError unless keyword_arguments.empty?
+      class_eval BuildAction.new(arguments, verbalize_method_name).build
+      class_eval BuildInitialize.new(arguments).build
+      class_eval BuildAttributes.new(arguments).build
+      class_eval BuildArgumentValidator.new(arguments).build
+    end
+
+    def verbalize(*arguments, **keyword_arguments)
+      method_name, *arguments = arguments
+      input(*arguments, verbalize_method_name: method_name, **keyword_arguments)
+    end
+  end
+end

data/lib/verbalize/build_action.rb

@@ -0,0 +1,24 @@
+require_relative 'build_method_base'
+
+module Verbalize
+  class BuildAction < BuildMethodBase
+    private
+
+    def declaration
+      "def self.#{method_name}(#{declaration_keyword_arguments})"
+    end
+
+    def body
+      [
+        "action = new(#{initialize_keyword_arguments})",
+        '_verbalize_validate_arguments(action)',
+        "value = catch(:verbalize_error) { action.#{method_name} }",
+        'Result.new(outcome: action.outcome, value: value)'
+      ].join("\n")
+    end
+
+    def initialize_keyword_arguments
+      keywords.map { |variable| "#{variable}: #{variable}" }.join(', ')
+    end
+  end
+end

data/lib/verbalize/build_argument_validator.rb

@@ -0,0 +1,36 @@
+require_relative 'build_method_base'
+
+module Verbalize
+  class BuildArgumentValidator < BuildMethodBase
+    private
+
+    def declaration
+      'def self._verbalize_validate_arguments(instance)'
+    end
+
+    def body
+      return if keywords.empty?
+      (check_values + raise_error_if_necessary).join("\n")
+    end
+
+    def check_values
+      [
+        "keywords = [#{keywords.map(&:inspect).join(', ')}]",
+        'keywords_without_values = keywords.select do |keyword|',
+        '  instance.send(keyword).nil?',
+        'end'
+      ]
+    end
+
+    def raise_error_if_necessary
+      [
+        'if keywords_without_values.any?',
+        "  error_message = 'missing keyword'",
+        "  error_message += 's' if keywords_without_values.count > 1",
+        %q{  error_message += ": #{keywords_without_values.join(', ')}"},
+        '  raise ArgumentError.new(error_message)',
+        'end'
+      ]
+    end
+  end
+end

data/lib/verbalize/build_attributes.rb

@@ -0,0 +1,16 @@
+module Verbalize
+  class BuildAttributes
+    def initialize(keywords)
+      @keywords = keywords
+    end
+
+    def build
+      return '' if keywords.empty?
+      "attr_reader #{keywords.map(&:inspect).join ', '}"
+    end
+
+    private
+
+    attr_reader :keywords
+  end
+end

data/lib/verbalize/build_initialize.rb

@@ -0,0 +1,21 @@
+require_relative 'build_method_base'
+
+module Verbalize
+  class BuildInitialize < BuildMethodBase
+    private
+
+    def declaration
+      "def initialize(#{declaration_keyword_arguments})"
+    end
+
+    def body
+      return if keywords.empty?
+
+      lines = keywords.map do |keyword|
+        "@#{keyword} = #{keyword}"
+      end
+
+      lines.join("\n")
+    end
+  end
+end

data/lib/verbalize/build_method_base.rb

@@ -0,0 +1,31 @@
+class BuildMethodBase
+  def initialize(keywords, method_name = :call)
+    @keywords    = keywords
+    @method_name = method_name
+  end
+
+  def build
+    parts.compact.join "\n"
+  end
+
+  private
+
+  attr_reader :keywords, :method_name
+
+  def parts
+    [declaration, body, 'end']
+  end
+
+  def declaration
+    raise NotImplementedError
+  end
+
+  def body
+    raise NotImplementedError
+  end
+
+  def declaration_keyword_arguments
+    return if keywords.empty?
+    keywords.map { |keyword| "#{keyword}: nil" }.join(', ')
+  end
+end

data/lib/verbalize/result.rb

@@ -0,0 +1,23 @@
+module Verbalize
+  class Result < Array
+    def initialize(outcome:, value:)
+      super([outcome, value])
+    end
+
+    def succeeded?
+      !failed?
+    end
+
+    def failed?
+      outcome == :error
+    end
+
+    def outcome
+      first
+    end
+
+    def value
+      last
+    end
+  end
+end

data/lib/verbalize/version.rb

@@ -0,0 +1,3 @@
+module Verbalize
+  VERSION = '0.1.0'.freeze
+end

data/verbalize.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'verbalize/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'verbalize'
+  spec.version       = Verbalize::VERSION
+  spec.authors       = ['Zach Taylor']
+  spec.email         = ['taylorzr@gmail.com']
+
+  spec.summary       = 'Verb based class pattern'
+  spec.homepage      = 'https://github.com/taylorzr/verbalize'
+  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'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'pry'
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: verbalize
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Zach Taylor
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-07 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: 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: coveralls
+  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: rubocop
+  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: pry
+  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:
+- taylorzr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- circle.yml
+- lib/verbalize.rb
+- lib/verbalize/build_action.rb
+- lib/verbalize/build_argument_validator.rb
+- lib/verbalize/build_attributes.rb
+- lib/verbalize/build_initialize.rb
+- lib/verbalize/build_method_base.rb
+- lib/verbalize/result.rb
+- lib/verbalize/version.rb
+- verbalize.gemspec
+homepage: https://github.com/taylorzr/verbalize
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Verb based class pattern
+test_files: []