verbalize 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f008ed2bf42154162943268c8c10d75ca09ca586
-  data.tar.gz: fdc71af9ad1a73d1f49ce85ec2bbc94a4870c1ac
+  metadata.gz: a7744e15c5aa0fc769954ed09eee485ae48e09c7
+  data.tar.gz: 5e3399e68683e2c832867b15d7dd7ce83fccdddf
 SHA512:
-  metadata.gz: 85ba485dee2564adb6cb8a3d3ca073a05f7cf27f65ef94599664575e64ae10d2d009c3d0bc404e1dc332e88f95c778f8e2bf7ff311cc314e3feace3fd0728f69
-  data.tar.gz: 5cda9a96c5e0162fd9f3f16645f85dcd8cefb6a1b8c0db49091b7ce4aff594eeedc2e28ba1fa9f229e1589f7d8fe77beed2a992cf604ed00cd920ef47d143083
+  metadata.gz: 8dfcf51ef06b9d77c5b7139339511e7d0800d11294f065a37cfcf412a805b3e67dcbd420672658f9797790294dfb19097fc4c70fccd9b8c5ec2e02e1f1ab96e4
+  data.tar.gz: bf914ab418dc0266d1b89e794c275258f6b406481a9e44b67797eef035c2ee31aaa6554a22bad47a5f7a371f6a834ee76e4dc1b380e799376a2dcb2b3d5320c2

data/README.md

@@ -30,7 +30,7 @@ value # => 42
 class Add
   include Verbalize
 
-  input :a, :b
+  input optional: [:a, :b]
 
   def call
     a + b
@@ -48,7 +48,7 @@ class Add
 end
 
 Add.call # => [:ok, 42]
-Add.call(a: 42, b: 0) # => [:ok, 42]
+Add.call(a: 660, b: 6) # => [:ok, 666]
 ```
 
 ```ruby
@@ -69,6 +69,11 @@ result.failed? # => true
 
 ## Comparison/Benchmark
 ```ruby
+require 'verbalize'
+require 'actionizer'
+require 'interactor'
+require 'benchmark/ips'
+
 class RubyAdd
   def self.call(a:, b:)
     new(a: a, b: b).call
@@ -87,9 +92,7 @@ class RubyAdd
 
   attr_reader :a, :b
 end
-```
 
-```ruby
 class VerbalizeAdd
   include Verbalize
 
@@ -99,9 +102,7 @@ class VerbalizeAdd
     a + b
   end
 end
-```
 
-```ruby
 class ActionizerAdd
   include Actionizer
 
@@ -109,9 +110,7 @@ class ActionizerAdd
     output.sum = input.a + input.b
   end
 end
-```
 
-```ruby
 class InteractorAdd
   include Interactor
 
@@ -119,14 +118,10 @@ class InteractorAdd
     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('Verbalize')  { VerbalizeAdd.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!
@@ -134,22 +129,23 @@ end
 ```
 
 ```
+Warming up --------------------------------------
+                Ruby    53.203k i/100ms
+           Verbalize    27.518k i/100ms
+          Actionizer     4.933k i/100ms
+          Interactor     4.166k i/100ms
 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
+                Ruby    544.025k (±13.7%) i/s -      2.660M in   5.011207s
+           Verbalize    278.738k (± 8.0%) i/s -      1.403M in   5.074676s
+          Actionizer     49.571k (± 7.0%) i/s -    246.650k in   5.006194s
+          Interactor     45.896k (± 7.1%) i/s -    229.130k in   5.018389s
 
 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
+                Ruby:   544025.0 i/s
+           Verbalize:   278737.9 i/s - 1.95x  slower
+          Actionizer:    49571.1 i/s - 10.97x  slower
+          Interactor:    45896.1 i/s - 11.85x  slower
+
 ```
 
 ## Installation

data/lib/verbalize.rb

@@ -1,8 +1,7 @@
 require 'verbalize/version'
-require 'verbalize/build_initialize'
-require 'verbalize/build_action'
-require 'verbalize/build_attributes'
-require 'verbalize/build_argument_validator'
+require 'verbalize/build_initialize_method'
+require 'verbalize/build_action_method'
+require 'verbalize/build_attribute_readers'
 require 'verbalize/result'
 
 module Verbalize
@@ -20,23 +19,47 @@ module Verbalize
   end
 
   module ClassMethods
-    def call
-      action = new
-      value = catch(:verbalize_error) { action.call }
-      Result.new(outcome: action.outcome, value: value)
+    def verbalize(*arguments, **keyword_arguments)
+      method_name, *arguments = arguments
+      input(*arguments, method_name: method_name, **keyword_arguments)
     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
+    def input( # rubocop:disable Metrics/MethodLength
+      *required_keywords,
+      optional:    [],
+      method_name: :call,
+      **other_keyword_arguments
+    )
+
+      unless other_keyword_arguments.empty?
+        raise(
+          ArgumentError,
+          "Unsupported keyword arguments received: #{other_keyword_arguments.inspect}"
+        )
+      end
+
+      optional_keywords = Array(optional)
+
+      class_eval BuildActionMethod.call(
+        required_keywords: required_keywords,
+        optional_keywords: optional_keywords,
+        method_name:       method_name
+      )
+
+      class_eval BuildInitializeMethod.call(
+        required_keywords: required_keywords,
+        optional_keywords: optional_keywords
+      )
+
+      class_eval BuildAttributeReaders.call(
+        attributes: required_keywords + optional_keywords
+      )
     end
 
-    def verbalize(*arguments, **keyword_arguments)
-      method_name, *arguments = arguments
-      input(*arguments, verbalize_method_name: method_name, **keyword_arguments)
+    def call
+      action = new
+      value = catch(:verbalize_error) { action.call }
+      Result.new(outcome: action.outcome, value: value)
     end
   end
 end

data/lib/verbalize/{build_action.rb → build_action_method.rb}

@@ -1,7 +1,7 @@
 require_relative 'build_method_base'
 
 module Verbalize
-  class BuildAction < BuildMethodBase
+  class BuildActionMethod < BuildMethodBase
     private
 
     def declaration
@@ -11,14 +11,13 @@ module Verbalize
     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(', ')
+      all_keywords.map { |variable| "#{variable}: #{variable}" }.join(', ')
     end
   end
 end

data/lib/verbalize/build_attribute_readers.rb

@@ -0,0 +1,20 @@
+module Verbalize
+  class BuildAttributeReaders
+    def self.call(attributes: [])
+      new(attributes: attributes).call
+    end
+
+    def initialize(attributes: [])
+      @attributes = attributes
+    end
+
+    def call
+      return '' if attributes.empty?
+      "attr_reader #{attributes.map(&:inspect).join ', '}"
+    end
+
+    private
+
+    attr_reader :attributes
+  end
+end

data/lib/verbalize/{build_initialize.rb → build_initialize_method.rb}

@@ -1,7 +1,7 @@
 require_relative 'build_method_base'
 
 module Verbalize
-  class BuildInitialize < BuildMethodBase
+  class BuildInitializeMethod < BuildMethodBase
     private
 
     def declaration
@@ -9,9 +9,9 @@ module Verbalize
     end
 
     def body
-      return if keywords.empty?
+      return if all_keywords.empty?
 
-      lines = keywords.map do |keyword|
+      lines = all_keywords.map do |keyword|
         "@#{keyword} = #{keyword}"
       end
 

data/lib/verbalize/build_method_base.rb

@@ -1,16 +1,25 @@
 class BuildMethodBase
-  def initialize(keywords, method_name = :call)
-    @keywords    = keywords
-    @method_name = method_name
+  def self.call(required_keywords: [], optional_keywords: [], method_name: :call)
+    new(
+      required_keywords: required_keywords,
+      optional_keywords: optional_keywords,
+      method_name:       method_name
+    ).call
   end
 
-  def build
+  def initialize(required_keywords: [], optional_keywords: [], method_name: :call)
+    @required_keywords = required_keywords
+    @optional_keywords = optional_keywords
+    @method_name       = method_name
+  end
+
+  def call
     parts.compact.join "\n"
   end
 
   private
 
-  attr_reader :keywords, :method_name
+  attr_reader :required_keywords, :optional_keywords, :method_name
 
   def parts
     [declaration, body, 'end']
@@ -24,8 +33,20 @@ class BuildMethodBase
     raise NotImplementedError
   end
 
+  def all_keywords
+    required_keywords + optional_keywords
+  end
+
+  def required_keyword_segments
+    required_keywords.map { |keyword| "#{keyword}:" }
+  end
+
+  def optional_keyword_segments
+    optional_keywords.map { |keyword| "#{keyword}: nil" }
+  end
+
   def declaration_keyword_arguments
-    return if keywords.empty?
-    keywords.map { |keyword| "#{keyword}: nil" }.join(', ')
+    return if all_keywords.empty?
+    (required_keyword_segments + optional_keyword_segments).join(', ')
   end
 end

data/lib/verbalize/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: verbalize
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Zach Taylor
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-07 00:00:00.000000000 Z
+date: 2016-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -113,10 +113,9 @@ files:
 - 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_action_method.rb
+- lib/verbalize/build_attribute_readers.rb
+- lib/verbalize/build_initialize_method.rb
 - lib/verbalize/build_method_base.rb
 - lib/verbalize/result.rb
 - lib/verbalize/version.rb

data/lib/verbalize/build_argument_validator.rb

@@ -1,36 +0,0 @@
-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

@@ -1,16 +0,0 @@
-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