verbalize 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 69dc4bbf8a11fde19d5c0b7f84e0f5ea76cdbd4f
-  data.tar.gz: 7aaa0f4b6d81861140a5b37c555371cec36aa6a2
+SHA256:
+  metadata.gz: 318052d8276c42ce2790698c6293930e55f6ae6a726e53e15279f4e562b8daeb
+  data.tar.gz: cb2e05c821a3e0af1e9c7ded9677c756b5eaf5e2466acd7ce63f46fd48a5cc5a
 SHA512:
-  metadata.gz: 7a39dcb9fb9c3458c00a9cda65018a3b2e68f5487b1e2f7a483d65d5590e196283de48dfb8b61d847771718313c7dbcb8532d02b4a1506357b022742e924927b
-  data.tar.gz: 412d8f380f07a076783c6ff5335a19d29c93cc2220211c9e79a7b72e59f396edf208f1147e415b06937489e03fbc2ad8cbcdc9e1823f2d569592e2d8e3efd70d
+  metadata.gz: 0a2d4819f7168e6062a2ddf1cd8b2881988371597604601ab8f40d7e7e730574bac68f189d7d0aea9f3d1ac878b0e28a4ebab205766935f2c7d202a16faf21ce
+  data.tar.gz: 31a1b94052096f62aef1238ef6f1a250f7dc5eabadca325ee1c730feaba78e24492f7e4d931363c9f7743abc736cf0da178e1f586bc3fe5fd53fc9941cf8627d

data/.travis.yml

@@ -1,4 +1,6 @@
 language: ruby
 rvm:
-  - 2.2.2
-before_install: gem install bundler -v 1.10.6
+  - 2.6
+  - 2.5
+  - 2.4
+  - 2.3

data/CHANGELOG.md

@@ -4,6 +4,15 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [Unreleased]
+### Added
+- release documentation
+
+## 2.3.0 - 2019-09-23
+### Added
+- you can now specify `validates :key { |value| ... }` on actions to run validation on the input
+  *before* running the `call` block.
+
 ## 2.2.0 - 2017-08-19
 ### Added
 - changelog started

data/README.md

@@ -125,6 +125,25 @@ Add.optional_inputs # [:c, :d]
 Add.inputs # [:a, :b, :c, :d]
 ```
 
+## Validation
+```ruby
+class FloatAdd
+  include Verbalize::Action
+
+  input :a, :b
+  validate(:a) { |a| a.is_a?(Float) }
+  validate(:b) { |b| b.is_a?(Float) && b > 10.0 }
+
+  def call
+    a + b
+  end
+end
+
+FloatAdd.call!(a: 1, b: 1) # fails with  Input "a" failed validation!
+FloatAdd.call!(a: 1.0, b: 1.0) # fails with Input "b" failed validation!
+FloatAdd.call!(a: 1.0, b: 12.0) # 13.0
+```
+
 ## Comparison/Benchmark
 ```ruby
 require 'verbalize'
@@ -188,21 +207,21 @@ end
 
 ```
 Warming up --------------------------------------
-                Ruby    53.203k i/100ms
-           Verbalize    27.518k i/100ms
-          Actionizer     4.933k i/100ms
-          Interactor     4.166k i/100ms
+                Ruby    63.091k i/100ms
+           Verbalize    40.521k i/100ms
+          Actionizer     5.226k i/100ms
+          Interactor     4.874k i/100ms
 Calculating -------------------------------------
-                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
+                Ruby    751.604k (± 3.0%) i/s -      3.785M in   5.041472s
+           Verbalize    457.598k (± 6.1%) i/s -      2.310M in   5.072488s
+          Actionizer     54.874k (± 3.5%) i/s -    276.978k in   5.054541s
+          Interactor     52.294k (± 3.2%) i/s -    263.196k in   5.038365s
 
 Comparison:
-                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
+                Ruby:   751604.0 i/s
+           Verbalize:   457597.9 i/s - 1.64x  slower
+          Actionizer:    54873.6 i/s - 13.70x  slower
+          Interactor:    52293.6 i/s - 14.37x  slower
 
 ```
 
@@ -355,10 +374,10 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Releasing
 
-- Update changelog, and VERSION
-- Commit to master and push to github
+- Update CHANGELOG.md, and lib/verbalize/version.rb, commit, and push
 - [Create a new release on github](https://github.com/taylorzr/verbalize/releases/new)
-- 
+- Build the gem version: `gem build verbalize.gemspec`
+- Push the gem version to rubygems: `gem push verbalize-<VERSION>.gem`
 
 ## Contributing
 

data/lib/verbalize/action.rb

@@ -11,10 +11,25 @@ module Verbalize
       throw(THROWN_SYMBOL, failure_value)
     end
 
+    def action_inputs
+      self.class.inputs.map { |i| [i, self.send(i)] }.to_h
+    end
+
     def self.included(target)
       target.extend ClassMethods
     end
 
+    private
+
+    def __setup(key, value)
+      is_valid = self.class.input_is_valid?(key, value)
+      local_error = self.class.pop_local_error
+      fail!(local_error) if !is_valid && local_error
+      fail! "Input '#{key}' failed validation!" unless is_valid
+
+      instance_variable_set(:"@#{key}", value)
+    end
+
     module ClassMethods
       def required_inputs
         @required_inputs || []
@@ -36,6 +51,26 @@ module Verbalize
         @defaults
       end
 
+      def input_validations
+        @input_validations ||= {}
+      end
+
+      def input_is_valid?(input, value)
+        return true unless input_validations.include?(input.to_sym)
+
+        input_validations[input].call(value) == true
+      rescue => e
+        @local_error = e
+        false
+      end
+
+      def pop_local_error
+        return nil unless @local_error
+        @local_error
+      ensure
+        @local_error = nil
+      end
+
       # Because call/call! are defined when Action.input is called, they would
       # not be defined when there is no input. So we pre-define them here, and
       # if there is any input, they are overwritten
@@ -59,6 +94,11 @@ module Verbalize
         class_eval Build.call(required_inputs, optional_inputs, default_inputs)
       end
 
+      def validate(keyword, &block)
+        raise Verbalize::Error, 'Missing block to validate against!' unless block_given?
+        input_validations[keyword.to_sym] = block
+      end
+
       def assign_defaults(optional)
         @defaults = optional.select { |kw| kw.is_a?(Hash) }.reduce(&:merge)
         @defaults = (@defaults || {})

data/lib/verbalize/build.rb

@@ -44,9 +44,9 @@ attr_reader #{attribute_readers_string}
     end
 
     def declaration_arguments_string
-      required_segments  = required_keywords.map { |keyword| "#{keyword}:" }
-      optional_segments  = optional_keywords.map { |keyword| "#{keyword}: nil" }
-      default_segments   = default_keywords.map  { |keyword| "#{keyword}: self.defaults[:#{keyword}].call" }
+      required_segments  = required_keywords.map { |kw| "#{kw}:" }
+      optional_segments  = optional_keywords.map { |kw| "#{kw}: nil" }
+      default_segments   = default_keywords.map  { |kw| "#{kw}: self.defaults[:#{kw}].call" }
       (required_segments + optional_segments + default_segments).join(', ')
     end
 
@@ -55,7 +55,9 @@ attr_reader #{attribute_readers_string}
     end
 
     def initialize_body
-      all_keywords.map { |keyword| "@#{keyword} = #{keyword}" }.join("\n  ")
+      all_keywords.map do |keyword|
+        "__setup(:#{keyword}, #{keyword})"
+      end.join("\n  ")
     end
 
     def attribute_readers_string

data/lib/verbalize/version.rb

@@ -1,3 +1,3 @@
 module Verbalize
-  VERSION = '2.2.0'.freeze
+  VERSION = '2.3.0'.freeze
 end

data/verbalize.gemspec

@@ -21,9 +21,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'coveralls'
-  spec.add_development_dependency 'rubocop', '0.45'
+  spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'pry'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: verbalize
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Zach Taylor
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-19 00:00:00.000000000 Z
+date: 2019-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,16 +28,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -70,16 +70,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.45'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.45'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -142,8 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Verb based class pattern