methodobject 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f916404cf4e974217978e9ae9059d1096fab845
-  data.tar.gz: 770f10363861e160a56f3762fe65478b3be6d114
+  metadata.gz: 10216ed93b5d15e346c868027b9521f22ca0a248
+  data.tar.gz: 7712785d34e678ac89b433c83704b3f899a81611
 SHA512:
-  metadata.gz: 4c32191104f627bfef8a295790497146ec76788fac297ae4ed02a1f87e8dfab25cfe79d15758466690ca2bca710d841edb2cc954410f6e9b699d016528c076bd
-  data.tar.gz: 95ada31f90716259011285e221d67e7441bf8b8e316a1e83466158632c4cc374d4c5ab4422856a3d4da7ef7bcc0bee6f73ecd3e6c113bb4fe27834e1cea9242b
+  metadata.gz: d5c4c44ca7934c5df3f44f1dd56db376d0f8566d247f3e8811eccfbcd465a50f4bc9fe5d33d683f1400d5d166c34df67edf21accffd1a18253910aa2c2d0c19b
+  data.tar.gz: f510bb02516ec64eed92e041640a4193485258993543d36c9633820dd9e56f5a906160e6aa0abcb9b8c60ad4d4c3dd12701866752be023363584c8ae26efb790

data/README.md

@@ -11,9 +11,9 @@ a common pattern used to ease the extraction of complex methods from other class
 
 The __method object pattern__ is advisable when a method is too long and difficult to separate due to tangled masses of local variables that are hard to isolate from each other: the solution is to extract the entire method into a separate class and turn its local variables into fields of the class; this allows isolating the problem at the class level and it paves the way for splitting a large and unwieldy method into smaller ones that would not fit with the purpose of the original class anyway.
 
-This gem also provides a uniform interface to write __service objects__, that is a common way to extract common operations from models and controllers in Rails application. Borrowing the design from [an article](http://brewhouse.io/blog/2014/04/30/gourmet-service-objects.html) on what the author defines as _"Gourmet Service Object"_, it provides some plumbing to implement such a pattern, with objects that expose a operation as their entry-point.
+This gem also provides a uniform interface to write __service objects__, that is a common way to extract common operations from models and controllers in Rails application. Borrowing the design from [an article](http://brewhouse.io/blog/2014/04/30/gourmet-service-objects.html) on what the author defines as _"Gourmet Service Object"_, it provides some plumbing to implement such a pattern, with objects that expose an operation as their entry-point.
 
-The interface exposed by a MethodObject is similar to the one of a _proc_/_lambda_, exposing a `call` method both at class and instance level and a convenience `to_proc` method to convert it to a Proc. Other neat features include optional type checking for the arguments and inheritance between MO's.
+The interface exposed by a MethodObject is similar to the one of a _proc_/_lambda_, exposing a `call` method both at class and instance level and a convenience `to_proc` method to convert it to a Proc. Other neat features include optional type checking for the arguments and inheritance between method objects.
 
 ## Installation
 
@@ -38,7 +38,7 @@ Or install it yourself as:
 ```ruby
 class ComplexCalculation < MethodObject
   # Type checking is optional. If omitted, anything is accepted.
-  # Type checking can also done with a proc or anything that responds to #===
+  # Type checking can also be done with a proc or anything that responds to #===
   # e.g. parameter :start_number, ->(p) { p.respond_to?(:to_i) }
   parameter :start_number, Integer
 
@@ -60,14 +60,14 @@ class ComplexCalculation < MethodObject
 
   def perform_complex_calculation
     # The arguments are available as accessors
-    start_number + second_number + @magic_number
+    start_number + end_number + @magic_number
   end
 end
 
 # The class-method version of `call` accepts the arguments as named parameters
 ComplexCalculation.call(start_number: 1, end_number: 3) #=> 46
 ComplexCalculation.call(start_number: 1)                #=> 45
-ComplexCalculation.call(end_number: 3)                  #=> raise ArgumentError
+ComplexCalculation.call(end_number: 3)                  #=> raise MethodObject::UnknownParameter
 
 # `call` can also be omitted, as per usual Ruby semantics
 ComplexCalculation.(start_number: 1)
@@ -112,6 +112,15 @@ say_my_name(&NameSayer)
 # - You're goddamn right!
 ```
 
+### Errors
+
+* `MethodObject::ParameterRequired` is raised when a required parameter is not set on `call`
+* `MethodObject::InvalidParameterValue` is raised when a given value's type does not match the type specified for the parameter
+* `MethodObject::UnknownParameter` is raised when using an undefined parameter
+
+All these classes inherit from `MethodObject::ParameterError`, which inherits from `ArgumentError`.
+
+
 ## 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.

data/lib/method_object.rb

@@ -31,7 +31,7 @@ require 'method_object/parameter'
 #
 #   ComplexCalculation.call(start_number: 1, end_number: 3) #=> 46
 #   ComplexCalculation.call(start_number: 1) #=> 45
-#   ComplexCalculation.call(end_number: 3) #=> raise ArgumentError
+#   ComplexCalculation.call(end_number: 3) #=> raise MethodObject::UnknownParameter
 #
 #   calculation = ComplexCalculation.new(end_number: 3)
 #   calculation.start_number = 1
@@ -60,6 +60,11 @@ require 'method_object/parameter'
 #   # - You're Heisenberg
 #   # - You're goddamn right!
 class MethodObject
+  ParameterError = Class.new(::ArgumentError)
+  ParameterRequired = Class.new(ParameterError)
+  InvalidParameterValue = Class.new(ParameterError)
+  UnknownParameter = Class.new(ParameterError)
+
   class << self
     # Calls the MethodObject with the given arguments.
     #
@@ -95,7 +100,7 @@ class MethodObject
       parameters << arg
 
       define_method("#{name}=") do |value|
-        raise ArgumentError, "Expected a #{type} for #{name}, #{value.class} received" unless arg.acceptable?(value)
+        raise InvalidParameterValue, "Expected a #{type} for #{name}, #{value.class} received" unless arg.acceptable?(value)
         @monitor.synchronize { instance_variable_set("@#{name}", value) }
       end
 
@@ -140,7 +145,12 @@ class MethodObject
 
     @monitor = Monitor.new
 
-    args.each { |k, v| public_send("#{k}=", v) }
+    args.each do |k, v|
+      method = "#{k}="
+      raise UnknownParameter, "Parameter #{k} unknown" unless respond_to?(method)
+      public_send(method, v)
+    end
+
     self.class.send(:parameters)
         .reject { |p| args.keys.map(&:to_sym).include?(p.name) }
         .select(&:default?)
@@ -180,14 +190,14 @@ class MethodObject
 
   private
 
-  # @raise [ArgumentError]
+  # @raise [ParameterRequired]
   def assert_required_arguments!
     missing_params =
       self.class.send(:parameters)
           .select { |p| !p.default? && !public_send("#{p.name}?") }
           .map(&:name)
 
-    raise ArgumentError, "Missing required arguments: #{missing_params.join(', ')}" \
+    raise ParameterRequired, "Missing required arguments: #{missing_params.join(', ')}" \
       unless missing_params.empty?
   end
 end

data/lib/method_object/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class MethodObject
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/methodobject.gemspec

@@ -29,5 +29,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "pry"
-  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "coveralls"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: methodobject
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Michele Piccirillo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-27 00:00:00.000000000 Z
+date: 2017-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -125,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Method Object pattern in Ruby for your service objects