verbalize 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca403601a9b7decbc85e77a20103926c8d92765a
-  data.tar.gz: ad015b2d9a8bfa2afa3e9524be0bc8dcfe4260d8
+  metadata.gz: 28277ada3b560d5fd8ed11a9b568dd03f8c0156a
+  data.tar.gz: 9ff1315685ffa11c9a997a15a07206fe0e21f112
 SHA512:
-  metadata.gz: 10d7fcf1fda2c00aa8b12d571858595222bc329d8714234ffc4d52a247e31c66fa183e5c0da9d52475a88ca76de7c407a9d6ced73c30aa9dbe2ba88b8a103d38
-  data.tar.gz: c0699fbe4b2c5da4e8f40f143058c552e90c2ffb421ebbc42946d138269c6b7f16d5167cb783885239e76d8ac4e2ba86fa22a2cad2ff01657690b9c4afb06ac2
+  metadata.gz: e4049ff78ca84f4e44f34c6525089edb96b74206ca6318f3b84c78779dd303863a612f0be86059e9e6bd1d8fce2f364a62e3d65b6269575ee13cd1dc7bbd44b9
+  data.tar.gz: a6528d2fa2ec1dc97d9524f6feb75426a249cc6a8bd2b656d7491d2bb5698512ec9718c836f16b33c0bc85d65aba5551a6d135170e2e1ebfb5fdf37c86770948

data/.codeclimate.yml

@@ -0,0 +1,7 @@
+engines:
+  rubocop:
+    enabled: true
+
+ratings:
+   paths:
+   - "**.rb"

data/circle.yml

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

data/lib/verbalize/action.rb

@@ -1,10 +1,7 @@
+require_relative 'build'
 require_relative 'error'
-require_relative 'build_initialize_method'
-require_relative 'build_safe_action_method'
-require_relative 'build_dangerous_action_method'
-require_relative 'build_attribute_readers'
-require_relative 'success'
 require_relative 'failure'
+require_relative 'success'
 
 module Verbalize
   module Action
@@ -19,46 +16,19 @@ module Verbalize
     end
 
     module ClassMethods
-      def input( # rubocop:disable Metrics/MethodLength
-        *required_keywords,
-        optional: [],
-        **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 BuildSafeActionMethod.call(
-          required_keywords: required_keywords,
-          optional_keywords: optional_keywords
-        )
-
-        class_eval BuildDangerousActionMethod.call(
-          required_keywords: required_keywords,
-          optional_keywords: optional_keywords
-        )
-
-        class_eval BuildInitializeMethod.call(
-          required_keywords: required_keywords,
-          optional_keywords: optional_keywords
-        )
-
-        class_eval BuildAttributeReaders.call(
-          attributes: required_keywords + optional_keywords
-        )
+      def input(*required_keywords, optional: [])
+        class_eval Build.call(required_keywords, Array(optional))
       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
       def call
-        __verbalized_send
+        __proxied_call
       end
 
       def call!
-        __verbalized_send!
+        __proxied_call!
       end
 
       private
@@ -67,7 +37,13 @@ module Verbalize
         new(*args).send(:call)
       end
 
-      def __verbalized_send(*args)
+      # We used __proxied_call/__proxied_call! for 2 reasons:
+      #   1. The declaration of call/call! needs to be explicit so that tools
+      #      like rspec-mocks can verify the actions keywords actually
+      #      exist when stubbing
+      #   2. Because #1, meta-programming a simple interface to these proxied
+      #      methods is much simpler than meta-programming the full methods
+      def __proxied_call(*args)
         error = catch(:verbalize_error) do
           value = perform(*args)
           return Success.new(value)
@@ -76,7 +52,7 @@ module Verbalize
         Failure.new(error)
       end
 
-      def __verbalized_send!(*args)
+      def __proxied_call!(*args)
         perform(*args)
       rescue UncaughtThrowError => uncaught_throw_error
         fail_value = uncaught_throw_error.value

data/lib/verbalize/build.rb

@@ -0,0 +1,58 @@
+module Verbalize
+  class Build
+    def self.call(required_keywords = [], optional_keywords = [])
+      new(required_keywords, optional_keywords).call
+    end
+
+    def initialize(required_keywords, optional_keywords)
+      @required_keywords = required_keywords
+      @optional_keywords = optional_keywords
+    end
+
+    def call
+      <<-CODE
+def self.call(#{declaration_arguments_string})
+  __proxied_call(#{forwarding_arguments_string})
+end
+
+def self.call!(#{declaration_arguments_string})
+  __proxied_call!(#{forwarding_arguments_string})
+end
+
+def initialize(#{declaration_arguments_string})
+  #{initialize_body}
+end
+
+private
+
+attr_reader #{attribute_readers_string}
+      CODE
+    end
+
+    attr_reader :required_keywords, :optional_keywords
+
+    private
+
+    def all_keywords
+      required_keywords + optional_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(', ')
+    end
+
+    def forwarding_arguments_string
+      all_keywords.map { |keyword| "#{keyword}: #{keyword}" }.join(', ')
+    end
+
+    def initialize_body
+      all_keywords.map { |keyword| "@#{keyword} = #{keyword}" }.join("\n  ")
+    end
+
+    def attribute_readers_string
+      all_keywords.map { |keyword| ":#{keyword}" }.join(', ')
+    end
+  end
+end

data/lib/verbalize/version.rb

@@ -1,3 +1,3 @@
 module Verbalize
-  VERSION = '2.0.0'.freeze
+  VERSION = '2.0.1'.freeze
 end

data/verbalize.gemspec

@@ -24,6 +24,6 @@ Gem::Specification.new do |spec|
   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 'rubocop', '0.45'
   spec.add_development_dependency 'pry'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: verbalize
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Zach Taylor
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-14 00:00:00.000000000 Z
+date: 2016-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,16 +70,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.45'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.45'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -101,6 +101,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -114,11 +115,7 @@ files:
 - circle.yml
 - lib/verbalize.rb
 - lib/verbalize/action.rb
-- lib/verbalize/build_attribute_readers.rb
-- lib/verbalize/build_dangerous_action_method.rb
-- lib/verbalize/build_initialize_method.rb
-- lib/verbalize/build_method_base.rb
-- lib/verbalize/build_safe_action_method.rb
+- lib/verbalize/build.rb
 - lib/verbalize/error.rb
 - lib/verbalize/failure.rb
 - lib/verbalize/result.rb

data/lib/verbalize/build_attribute_readers.rb

@@ -1,20 +0,0 @@
-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_dangerous_action_method.rb

@@ -1,15 +0,0 @@
-require_relative 'build_method_base'
-
-module Verbalize
-  class BuildDangerousActionMethod < BuildMethodBase
-    private
-
-    def declaration
-      declare('self.call!')
-    end
-
-    def body
-      verbalized_send_string(bang: true)
-    end
-  end
-end

data/lib/verbalize/build_initialize_method.rb

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

data/lib/verbalize/build_method_base.rb

@@ -1,68 +0,0 @@
-module Verbalize
-  class BuildMethodBase
-    def self.call(required_keywords: [], optional_keywords: [])
-      new(
-        required_keywords: required_keywords,
-        optional_keywords: optional_keywords
-      ).call
-    end
-
-    def initialize(required_keywords: [], optional_keywords: [])
-      @required_keywords = required_keywords
-      @optional_keywords = optional_keywords
-    end
-
-    def call
-      parts.compact.join "\n"
-    end
-
-    private
-
-    attr_reader :required_keywords, :optional_keywords
-
-    def parts
-      [declaration, body, "end\n"]
-    end
-
-    def declaration
-      raise NotImplementedError
-    end
-
-    def body
-      raise NotImplementedError
-    end
-
-    def declare(method_name)
-      "def #{method_name}(#{declaration_keyword_arguments})"
-    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 all_keywords.empty?
-      (required_keyword_segments + optional_keyword_segments).join(', ')
-    end
-
-    def initialize_keywords_and_values
-      all_keywords.map { |variable| "#{variable}: #{variable}" }.join(', ')
-    end
-
-    def verbalized_send_string(bang: false)
-      send_string = '  __verbalized_send'
-      send_string += '!' if bang
-
-      return send_string if all_keywords.empty?
-      send_string + "(#{initialize_keywords_and_values})"
-    end
-  end
-end

data/lib/verbalize/build_safe_action_method.rb

@@ -1,15 +0,0 @@
-require_relative 'build_method_base'
-
-module Verbalize
-  class BuildSafeActionMethod < BuildMethodBase
-    private
-
-    def declaration
-      declare('self.call')
-    end
-
-    def body
-      verbalized_send_string(bang: false)
-    end
-  end
-end