verbalize 2.1.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fbb81a57e922f9eb1725daf38886898e1ec0e0d8
-  data.tar.gz: 1ce4904ec6243de8e40e269b7e773ebd516d0d9b
+  metadata.gz: 69dc4bbf8a11fde19d5c0b7f84e0f5ea76cdbd4f
+  data.tar.gz: 7aaa0f4b6d81861140a5b37c555371cec36aa6a2
 SHA512:
-  metadata.gz: 2b9acacd50f16370208e8adde4c37b2822051ec77fd0fa9979e2fcddac898053ecdb3413a6db3d87ec821bceed104c453881d7ced95dfef726bda5eb6c2f24b6
-  data.tar.gz: a89f9934e93a7dbbb1124ff443cc9551ae2e3af5fb3346ffb0b1445787c77095b3dc6b6c2e9012f1ad84770207d7b9b489c475249036c8d9a4383884eb757c3c
+  metadata.gz: 7a39dcb9fb9c3458c00a9cda65018a3b2e68f5487b1e2f7a483d65d5590e196283de48dfb8b61d847771718313c7dbcb8532d02b4a1506357b022742e924927b
+  data.tar.gz: 412d8f380f07a076783c6ff5335a19d29c93cc2220211c9e79a7b72e59f396edf208f1147e415b06937489e03fbc2ad8cbcdc9e1823f2d569592e2d8e3efd70d

data/CHANGELOG.md

@@ -0,0 +1,81 @@
+# Change Log
+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/).
+
+## 2.2.0 - 2017-08-19
+### Added
+- changelog started
+- You can now specify default values for optional inputs in the `input` call.
+  Use a regular value to load it once, at load-time, and a lambda to lazily load
+  the value each time the action is called.
+### Changed
+- privatize Action.input. Now that we have Action.inputs, we want to avoid calling Action.input (no s) outside of the action itself
+
+## 2.1.1 - 2017-02-21
+### Fixed
+- ensure Verbalize::Action.optional_input always returns an array
+
+## 2.1.0 - 2017-02-21
+### Added
+- introspect Action input using Action.inputs, Action.required_inputs, and Action.optional_inputs
+
+## 2.0.2 - 2017-2-21 [YANKED]
+- new functionality was added, so minor version should have been increased instead of patch
+
+## 2.0.1 - 2016-12-16
+### Changed
+- internal refactoring
+
+## 2.0.0 - 2016-02-14
+### Added
+- execution of action routed through Action#perform to better support stubbing
+- 100% test coverage!!!
+### Changed
+- calling Failure#value now raises an error, use Failure#failure instead? Did this happen in 1.3?
+### Removed
+- removes action implementation methods other than #call/#call!
+
+## 1.4.1 - 2016-12-14
+### Added
+- Failure#failure added to replace Failure#value
+### Changed
+- Result split into Success/Failure
+### Deprecated
+- stop including Verbalize itself, use Verbalize::Action instead
+- stop using action implementation methods other than #call/#call!
+- stop using Failure#value, used Failure#failure instead
+
+## 1.4.0 [YANKED] - 2016-12-14
+### Fixed
+- error while uploading to ruby gems, yanked and released v1.4.1
+
+## 1.3.0 - 2016-11-09
+### Changed
+- better failure handling
+
+## 1.2.0 - 2016-11-07
+### Added
+- alias Result.success? to Result.succeeded?
+- alias Result.failure? to Result.failed?
+### Changed
+- Action now implements #to_ary instead of subclassing Array
+
+## 1.1.2 - 2016-11-07 [YANKED]
+- new functionality was added, so minor version should have been increased instead of patch
+
+## 1.1.1 - 2016-08-25
+### Changed
+- internal refactoring
+
+## 1.0.1 - 2016-08-10
+### Fixed
+- Use send to call Action#call so that Action#call can be privatized
+
+## 1.0.0 - 2016-08-09
+### Added
+- optional input
+
+## 0.1.0 - 2016-08-07
+- initial release

data/README.md

@@ -53,6 +53,35 @@ Add.call # => [:ok, 42]
 Add.call(a: 660, b: 6) # => [:ok, 666]
 ```
 
+## Default Values
+
+```ruby
+# You can define defaults via key/value pairs, as so:
+class Add
+  include Verbalize::Action
+  # note that these values are evaluated at load-time as they are not wrapped
+  # in lambdas.
+  input optional: [a: 35, b: 7]
+  def call; a + b; end
+end
+
+# default values can be lazily loaded by passing in a lambda, e.g.:
+
+class Tomorrow
+  include Verbalize::Action
+  input optional: [as_of: -> { Time.now }]
+  def call
+    as_of + 1
+  end
+end
+
+start_time = Tomorrow.call!
+sleep(1)
+end_time = Tomorrow.call!
+end_time - start_time # ~1s; the default is executed each call.
+```
+
+
 ```ruby
 class Divide
   include Verbalize::Action
@@ -324,6 +353,13 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 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).
 
+## Releasing
+
+- Update changelog, and VERSION
+- Commit to master and push to github
+- [Create a new release on github](https://github.com/taylorzr/verbalize/releases/new)
+- 
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/taylorzr/verbalize.

data/bin/console

@@ -6,9 +6,5 @@ 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
+require 'pry'
+Pry.start

data/lib/verbalize/action.rb

@@ -16,14 +16,6 @@ module Verbalize
     end
 
     module ClassMethods
-      def input(*required_keywords, optional: [])
-        @required_inputs = required_keywords
-        optional = Array(optional)
-        @optional_inputs = optional
-
-        class_eval Build.call(required_keywords, optional)
-      end
-
       def required_inputs
         @required_inputs || []
       end
@@ -32,8 +24,16 @@ module Verbalize
         @optional_inputs || []
       end
 
+      def default_inputs
+        (@defaults || {}).keys
+      end
+
       def inputs
-        required_inputs + optional_inputs
+        required_inputs + optional_inputs + default_inputs
+      end
+
+      def defaults
+        @defaults
       end
 
       # Because call/call! are defined when Action.input is called, they would
@@ -50,6 +50,22 @@ module Verbalize
 
       private
 
+      def input(*required_keywords, optional: [])
+        @required_inputs = required_keywords
+        optional = Array(optional)
+        @optional_inputs = optional.reject { |kw| kw.is_a?(Hash) }
+        assign_defaults(optional)
+
+        class_eval Build.call(required_inputs, optional_inputs, default_inputs)
+      end
+
+      def assign_defaults(optional)
+        @defaults = optional.select { |kw| kw.is_a?(Hash) }.reduce(&:merge)
+        @defaults = (@defaults || {})
+                    .map { |k, v| [k, v.respond_to?(:call) ? v : -> { v }] }
+                    .to_h
+      end
+
       def perform(*args)
         new(*args).send(:call)
       end

data/lib/verbalize/build.rb

@@ -1,12 +1,13 @@
 module Verbalize
   class Build
-    def self.call(required_keywords = [], optional_keywords = [])
-      new(required_keywords, optional_keywords).call
+    def self.call(required_keywords = [], optional_keywords = [], default_keywords = [])
+      new(required_keywords, optional_keywords, default_keywords).call
     end
 
-    def initialize(required_keywords, optional_keywords)
+    def initialize(required_keywords, optional_keywords, default_keywords)
       @required_keywords = required_keywords
       @optional_keywords = optional_keywords
+      @default_keywords  = default_keywords
     end
 
     def call
@@ -34,18 +35,19 @@ attr_reader #{attribute_readers_string}
       CODE
     end
 
-    attr_reader :required_keywords, :optional_keywords
+    attr_reader :required_keywords, :optional_keywords, :default_keywords
 
     private
 
     def all_keywords
-      required_keywords + optional_keywords
+      required_keywords + optional_keywords + default_keywords
     end
 
     def declaration_arguments_string
-      required_segments = required_keywords.map { |keyword| "#{keyword}:" }
-      optional_segments = optional_keywords.map { |keyword| "#{keyword}: nil" }
-      (required_segments + optional_segments).join(', ')
+      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 + optional_segments + default_segments).join(', ')
     end
 
     def forwarding_arguments_string

data/lib/verbalize/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: verbalize
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.0
 platform: ruby
 authors:
 - Zach Taylor
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-21 00:00:00.000000000 Z
+date: 2017-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -106,6 +106,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -142,7 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Verb based class pattern