method_object 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1bfe8995eec3e81eaefbb5ecb602df64a8b245ac
-  data.tar.gz: d47526095a680c8b3541c26d4aa3ca44e1293813
+SHA256:
+  metadata.gz: 3b6cfbf7d4687cd268dadbd876eb81148740f126d2f30d1ecc925df05572e263
+  data.tar.gz: 003b2f8abf57ee1aa073e5715b318016e1597053b31a6d540b41627838e813d6
 SHA512:
-  metadata.gz: e7fab229d72852bb1a9d53995537c03f2d70b1a549eba1473fe909897fe14165d237aca12021a5ccf41df3db244328b1b455a8129ce716d96213a86bece5f5a8
-  data.tar.gz: 923bb884354b0dfb5ddc2f9cb33b6b15df12480e37ca6d143b93f6f696a4cbc3ff32f5240a8c179033611a07f742e978695bea1dd4e5f6a3743a8143165618da
+  metadata.gz: 42177284d72db7f0f4888c3a4d42af7f96d7d6ddc0e6a85c7b9926c07b7c34fe511f194ab775da2145fed1a3dd50420e20499554181d42e08a13d73ca43c6ab1
+  data.tar.gz: b56eabe3a2f69cfd845ea74e2ea8b7304f494ad3bdf8d4408d0f31228fa27abd57bab72f0e9581c0fe0644ec0a6fe8f71c39768df2cfe57d218f9025908112b8

data/README.md

@@ -1,43 +1,169 @@
 # MethodObject
 
-MethodObject is a simple class for facilitating the method object pattern.
+[![Version](https://img.shields.io/gem/v/method_object)](https://github.com/bukowskis/method_object.svg/releases)
+[![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](https://github.com/bukowskis/method_object/blob/master/LICENSE.md)
+[![Build Status](https://circleci.com/gh/bukowskis/method_object.svg?style=shield)](https://circleci.com/gh/bukowskis/method_object)
+[![Maintainability](https://api.codeclimate.com/v1/badges/55b133b2c8e1a9649d88/maintainability)](https://codeclimate.com/repos/5c8032b7c1be5c599400eedd/maintainability)
 
-You can think of a MethodObject as a proc with the power of a class. Define methods, use instance variables, etc.
+### TL; DR
 
-## Installation
+The [method object pattern](https://refactoring.guru/replace-method-with-method-object) implies that you have one Ruby class for one single thing you want to perform.
+
+This gem helps you to do just that with minimal overhead. The convention is to use the `.call` class method like so:
+
+```ruby
+class SaySometing
+  include MethodObject
+  
+  # Input
+  option :text
+  
+  # Output
+  def call
+    puts text
+  end
+end
 
-Add this line to your application's Gemfile:
+SaySometihng.call(text: 'Hi there!') # => 'Hi there!'
+```
 
-    gem 'method_object'
+## Rationale
 
-And then execute:
+A minimal implementation of the method object pattern would probably look [like this](https://github.com/deadlyicon/method_object/blob/16944f7088bbe4d9e0039688077b91fdd4adcdbd/lib/method_object.rb). This is sometimes also referred to as "service class".
 
-    $ bundle
+```ruby
+class SaySometing
+  def self.call(*args, &block)
+    new.call(*args, &block)
+  end
+  
+  def call(text)
+    puts text
+  end
+end
+```
 
-Or install it yourself as:
+> Fun fact: [previously](https://github.com/deadlyicon/method_object/issues/3) that was actually the implementation of this gem.
 
-    $ gem install method_object
+Basically everything passed to `MyClass.call(...)` would be passed on to `MyClass.new.call(...)`. 
 
-## Usage
+Even better still, it *should* be passed on to `MyClass.new(...).call` so that your implementation becomes cleaner:
 
 ```ruby
-  class OpenDoor < MethodObject
-    def call door
-      open_door!(door)
-    end
+class SaySometing
+  def self.call(*args, &block)
+    new(*args, &block).call
+  end
+  
+  def initialize(text:)
+    @text = text
+  end
+  
+  def call
+    puts @text
+  end
+end
+```
+
+
+People [implemented that](https://github.com/LIQIDTechnology/methodobject/blob/89ba022d61ac6037564cc1056c00813375a2d3ae/lib/method_object.rb#L73-L75), but in doing so reinvented the wheel. Because now you not only have the method object pattern (i.e. `call`), now you also have to deal with initialization (i.e. `new`).
+
+That's where the popular [dry-initializer](https://dry-rb.org/gems/dry-initializer) gem comes in. It is a battle-tested way to initialize objects with mandatory and optional attributes.
 
-    def open_door!(door)
-      door.open
-    end
+The `method_object` gem (you're looking at it right now), combines both the method object pattern and dry initialization.
+
+## Installation
+
+```
+# Add this to your Gemfile
+gem 'method_object`
+```
+
+## Usage
+
+If you only have one mandatory, obvious argument, this is what your implementation most likely would look like:
+
+```ruby
+class CalculateTax
+  include MethodObject
+  
+  param :product
+  
+  def call
+    product.price * 0.1
   end
+end
 
-  OpenDoor.call(my_door)
+bike = Bike.new(price: 50)
+CalculateTax.call(bike) # => 5
 ```
 
-# Contributing
+If you prefer to use named keywords, use this instead:
+
+````ruby
+class CalculateTax
+  include MethodObject
+  
+  option :product
+  
+  def call
+    product.price * 0.1
+  end
+end
+
+bike = Bike.new(price: 50)
+CalculateTax.call(product: bike) # => 5
+````
+
+You can also use both params and options. They are all mandatory.
+
+````ruby
+class CalculateTax
+  include MethodObject
+  
+  param :product
+  option :dutyfree
+  
+  def call
+    return 0 if dutyfree
+    product.price * 0.1
+  end
+end
+
+bike = Bike.new(price: 50)
+CalculateTax.call(bike, dutyfree: true) # => 0
+````
+
+You can make options optional by defining a default value in a proc:
+
+````ruby
+class CalculateTax
+  include MethodObject
+  
+  param :product
+  option :dutyfree, default: -> { false }
+  
+  def call
+    return 0 if dutyfree
+    product.price * 0.1
+  end
+end
+
+bike = Bike.new(price: 50)
+CalculateTax.call(bike) # => 5
+````
+
+That's it! 
+
+# Caveats
+
+* `params` cannot be optional (or have default values). This is because there can be several params in a row, which leads to confusion when they are optional.
+
+# Thanks
+
+* A big thank you to [Jared](https://github.com/deadlyicon) who was so kind to give us the `method_object` gem name for our implementation.
+* The [dry-rb](https://dry-rb.org/) team for their sense of beauty.
+
+# License
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+MIT License, see [LICENSE.md](https://github.com/bukowskis/method_object/blob/master/LICENSE.md)

data/lib/method_object.rb

@@ -1,21 +1,51 @@
-class MethodObject
+require 'dry-initializer'
 
-  VERSION = '0.1.1'
+module MethodObject
+  def self.included(base)
+    base.extend Dry::Initializer
+    base.extend ClassMethods
+    base.send(:private_class_method, :new)
+  end
+
+  module ClassMethods
+    def call(*args, &block)
+      __check_for_unknown_options(*args)
+      new(*args).call(&block)
+    end
 
-  class << self
-    private :new
+    # Because of the positioning of multiple params, params can never be omitted.
+    def param(name, type = nil, **opts, &block)
+      raise ArgumentError, "Default value for param not allowed - #{name}" if opts.key? :default
+      raise ArgumentError, "Optional params not supported - #{name}" if opts.fetch(:optional, false)
 
-    def call *args, &block
-      new.call(*args, &block)
+      dry_initializer.param(name, type, **opts, &block)
+      self
     end
 
-    def to_proc
-      method(:call).to_proc
+    # DEPRECATED
+    def assign(variable, to:)
+      warn 'MethodObject.assign is deprecated. ' \
+           "Please use this instead: `option #{variable.inspect}, default: ...`"
+      option variable, default: to
     end
-  end
 
-  def call
-    raise "#{self.class}#call is not defined"
-  end
+    def __check_for_unknown_options(*args)
+      return if __defined_options.empty?
+
+      opts = args.drop(__defined_params.length).first || {}
+      raise ArgumentError, "Unexpected argument #{opts}" unless opts.is_a? Hash
 
+      unknown_options = opts.keys - __defined_options
+      message = "Key(s) #{unknown_options} not found in #{__defined_options}"
+      raise KeyError, message if unknown_options.any?
+    end
+
+    def __defined_options
+      dry_initializer.options.map(&:source)
+    end
+
+    def __defined_params
+      dry_initializer.params.map(&:source)
+    end
+  end
 end

data/spec/method_object_spec.rb

@@ -1,71 +1,97 @@
 require 'spec_helper'
 
-describe MethodObject do
+class MinimalMethodObject
+  include MethodObject
 
-  let(:block) { ->{} }
+  option :color
 
-  class SimpleMethodObject < MethodObject
-    def call *args, &block
-      [args, block]
-    end
+  def call
+    "The color is #{color}"
   end
+end
+
+class ExampleMethodObject
+  include MethodObject
 
-  class SimpleMethodObjectWithNoCallMethod < MethodObject
+  param :shape
+  option :color
+  option :size, default: -> { :big }
+
+  def call
+    block_given? ? yield(to_s) : to_s
   end
 
-  shared_examples 'a method object' do
-    describe '.new' do
-      it 'should be private' do
-        expect(subject.private_methods).to include :new
+  def to_s
+    "#{size} #{color} #{shape}"
+  end
+end
+
+RSpec.describe MethodObject do
+  describe '.param' do
+    context 'when defining a default value' do
+      it 'raises an error' do
+        expect do
+          Class.new do
+            include MethodObject
+
+            param :shape, default: -> { :square }
+          end
+        end.to raise_error ArgumentError, /not allowed/
       end
     end
-    describe '.to_proc' do
-      it 'should return a proc that calls call' do
-        expect(subject.to_proc).to be_a Proc
-        expect(subject).to receive(:call).with(:a,:b)
-        subject.to_proc.(:a, :b)
+
+    context 'when defined as optional' do
+      it 'raises an error' do
+        expect do
+          Class.new do
+            include MethodObject
+
+            param :user, optional: true
+          end
+        end.to raise_error ArgumentError, /not supported/
       end
     end
-  end
 
-
-  describe SimpleMethodObjectWithNoCallMethod do
-    subject{ SimpleMethodObjectWithNoCallMethod }
-    it_behaves_like 'a method object'
-    describe '.call' do
-      it 'should raise a SimpleMethodObjectWithNoCallMethod#call is not defined error' do
-        expect{ subject.call }.to raise_error StandardError, "SimpleMethodObjectWithNoCallMethod#call is not defined"
+    context 'when properly defined' do
+      it 'is mandatory' do
+        expect do
+          ExampleMethodObject.call
+        end.to raise_error ArgumentError, /wrong number of arguments/
       end
     end
   end
 
-  describe SimpleMethodObject do
-    subject{ SimpleMethodObject }
-    it_behaves_like 'a method object'
-    it "should curry all args and block to #call" do
-      expect( subject.call(1,2,3, &block)         ).to eq [[1,2,3], block]
-      expect( subject.to_proc.call(1,2,3, &block) ).to eq [[1,2,3], block]
+  describe '.call' do
+    context 'without block' do
+      it 'has access to options' do
+        result = MinimalMethodObject.call color: 'blue'
+
+        expect(result).to eq 'The color is blue'
+      end
     end
-  end
 
-  describe 'used as a block' do
-    it 'should work' do
-      expect( [1,2,3].map(&SimpleMethodObject) ).to eq [
-        [[1], nil],
-        [[2], nil],
-        [[3], nil],
-      ]
+    context 'with block' do
+      it 'passes the block' do
+        result = ExampleMethodObject.call('circle', color: 'blue', &:upcase)
+
+        expect(result).to eq 'BIG BLUE CIRCLE'
+      end
     end
-  end
 
-  describe 'used to define a method' do
-    it 'should work' do
-      _class = Class.new do
-        define_method :foo, &SimpleMethodObject
+    context 'with unknown options' do
+      it 'raises an error' do
+        expect do
+          ExampleMethodObject.call 'square', color: 'red', ability: 'Totally invalid'
+        end.to raise_error KeyError, 'Key(s) [:ability] not found in [:color, :size]'
       end
+    end
 
-      expect( _class.new.foo('hello', :world, &block) ).to eq [['hello', :world], block]
+    context 'without options' do
+      it 'raises an error' do
+        expect do
+          ExampleMethodObject.call 'square', 'boom!'
+        end.to raise_error ArgumentError, 'Unexpected argument boom!'
+      end
     end
   end
-
 end

data/spec/spec_helper.rb

@@ -1,19 +1,14 @@
+require 'bundler/setup'
 require 'method_object'
-require 'pry'
-# This file was generated by the `rspec --init` command. Conventionally, all
-# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
-# Require this file using `require "spec_helper"` to ensure that it is only
-# loaded once.
-#
-# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
 RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
-  config.run_all_when_everything_filtered = true
-  config.filter_run :focus
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = '.rspec_status'
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
 
-  # Run specs in random order to surface order dependencies. If you find an
-  # order dependency and want to debug it, you can fix the order by providing
-  # the seed, which is printed after each run.
-  #     --seed 1234
-  config.order = 'random'
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
 end

metadata

@@ -1,90 +1,96 @@
 --- !ruby/object:Gem::Specification
 name: method_object
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
-- Jared Grippe
+- Bukowskis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-19 00:00:00.000000000 Z
+date: 2019-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: dry-initializer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec-expectations
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry-debugger
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: wraps up the method object pattern into a class
-email:
-- jared@deadlyicon.com
+description: 
+email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
-- Gemfile
-- LICENSE
 - README.md
-- Rakefile
 - lib/method_object.rb
-- method_object.gemspec
 - spec/method_object_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/deadlyicon/method_object
+homepage: https://github.com/bukowskis/method_object
 licenses:
 - MIT
 metadata: {}
@@ -94,20 +100,19 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.1.10
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
-summary: wraps up the method object pattern into a class
+summary: Combining the method object pattern with DRY initialization
 test_files:
-- spec/method_object_spec.rb
 - spec/spec_helper.rb
+- spec/method_object_spec.rb

data/.gitignore

@@ -1,17 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp

data/.rspec

@@ -1,2 +0,0 @@
---color
---format progress

data/.travis.yml

@@ -1,12 +0,0 @@
-language: ruby
-rvm:
-  - 2.0.0
-  - 1.9.3
-  - 1.9.2
-  - jruby-18mode
-  - jruby-19mode
-  - rbx-2.1.1
-  - ruby-head
-  - jruby-head
-  - 1.8.7
-  - ree

data/Gemfile

@@ -1,3 +0,0 @@
-source 'http://rubygems.org'
-
-gemspec

data/LICENSE

@@ -1,22 +0,0 @@
-Copyright (c) 2012 Jared Grippe
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -1,8 +0,0 @@
-#!/usr/bin/env rake
-require "bundler/gem_tasks"
-
-task :test do
-  exec 'bundle exec rspec'
-end
-
-task :default => :test

data/method_object.gemspec

@@ -1,25 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'method_object'
-
-Gem::Specification.new do |spec|
-  spec.name          = "method_object"
-  spec.version       = MethodObject::VERSION
-  spec.authors       = ["Jared Grippe"]
-  spec.email         = ["jared@deadlyicon.com"]
-  spec.description   = %q{wraps up the method object pattern into a class}
-  spec.summary       = %q{wraps up the method object pattern into a class}
-  spec.homepage      = "https://github.com/deadlyicon/method_object"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'pry-debugger'
-end