methodobject 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8f916404cf4e974217978e9ae9059d1096fab845
+  data.tar.gz: 770f10363861e160a56f3762fe65478b3be6d114
+SHA512:
+  metadata.gz: 4c32191104f627bfef8a295790497146ec76788fac297ae4ed02a1f87e8dfab25cfe79d15758466690ca2bca710d841edb2cc954410f6e9b699d016528c076bd
+  data.tar.gz: 95ada31f90716259011285e221d67e7441bf8b8e316a1e83466158632c4cc374d4c5ab4422856a3d4da7ef7bcc0bee6f73ecd3e6c113bb4fe27834e1cea9242b

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,10 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.0.0-p648
+  - 2.1.10
+  - 2.2.7
+  - 2.3.4
+  - 2.4.1
+  - jruby-9.1.5.0
+before_install: gem install bundler -v 1.12.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at michele.piccirillo@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in methodobject.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Michele Piccirillo
+
+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/README.md

@@ -0,0 +1,129 @@
+# Method Object
+[![Gem Version](https://badge.fury.io/rb/methodobject.svg)](https://rubygems.org/gems/methodobject)
+[![Build Status](https://travis-ci.org/LIQIDTechnology/methodobject.svg?branch=master)](https://travis-ci.org/LIQIDTechnology/methodobject)
+[![Coverage Status](https://coveralls.io/repos/github/LIQIDTechnology/methodobject/badge.svg?branch=master)](https://coveralls.io/github/LIQIDTechnology/methodobject?branch=master)
+[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/gems/methodobject/)
+[![Documentation coverage](https://inch-ci.org/github/LIQIDTechnology/methodobject.svg?branch=master)](https://inch-ci.org/github/LIQIDTechnology/methodobject)
+
+
+Provides a lightweight and dependency-free solution for the creation of [method objects](https://sourcemaking.com/refactoring/replace-method-with-method-object),
+a common pattern used to ease the extraction of complex methods from other classes and for the implementation of service objects.
+
+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.
+
+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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'methodobject'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install methodobject
+
+## Usage
+
+### Defining and invoking a method object
+
+```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 #===
+  # e.g. parameter :start_number, ->(p) { p.respond_to?(:to_i) }
+  parameter :start_number, Integer
+
+  # Parameters that define a default are optional.
+  # `default` supports also a proc, that gets evaluated at
+  # object instantiation.
+  # e.g. default: -> { Time.now }
+  parameter :end_number, Integer, default: 2
+
+  # Defines the `call` method body.
+  # Inheritance works also as expected. Calling `super()` invokes
+  # superclass' implementation.
+  called do
+    @magic_number = 42
+    perform_complex_calculation
+  end
+
+  private
+
+  def perform_complex_calculation
+    # The arguments are available as accessors
+    start_number + second_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
+
+# `call` can also be omitted, as per usual Ruby semantics
+ComplexCalculation.(start_number: 1)
+
+# The class-method version of `to_proc` returns a proc that takes the same arguments
+ComplexCalculation.to_proc.call(start_number: 1)
+
+# The method object can also be instantiated, passing the arguments to the constructor
+# or to the accessors
+calculation = ComplexCalculation.new(end_number: 3)
+calculation.start_number = 1
+calculation.call # => 46
+
+calculation.end_number = 2
+calculation.call # => 45
+
+# The instance-method version of `to_proc` returns a lambda that calls the method object
+# with the parameters currently set
+calculation.to_proc.call # => 45
+```
+
+### Using the method object as a block
+
+```ruby
+class NameSayer < MethodObject
+  parameter :name
+
+  called { "You're #{name}" }
+end
+
+def say_my_name
+  puts "- Say my name."
+  puts "- " + yield(name: "Heisenberg")
+  puts "- You're goddamn right!"
+end
+
+say_my_name(&NameSayer)
+# Output:
+#
+# - Say my name.
+# - You're Heisenberg
+# - You're goddamn right!
+```
+
+## 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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/LIQIDTechnology/methodobject. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "methodobject"
+
+# 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

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/method_object/parameter.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+class MethodObject
+  # @!visibility private
+  class Parameter
+    def initialize(name, type, options = {})
+      invalid_options = options.keys - [:default]
+      raise ArgumentError, "Invalid keys: #{invalid_options.inspect}. Valid keys are: :default" \
+        unless invalid_options.empty?
+
+      @name = name
+      @type = type
+      @options = options
+
+      freeze
+    end
+
+    attr_reader :name, :type
+
+    def default?
+      @options.key?(:default)
+    end
+
+    def default
+      @options[:default]
+    end
+
+    def default_in(context)
+      if @options[:default].respond_to?(:call)
+        context.instance_exec(&@options[:default])
+      else
+        @options[:default]
+      end
+    end
+
+    def hash
+      name.to_s.hash
+    end
+
+    def acceptable?(value)
+      (value.nil? && nullable?) || type === value # rubocop:disable Style/CaseEquality
+    end
+
+    def nullable?
+      default? && default.nil?
+    end
+
+    def ==(other)
+      instance_of?(other.class) && name == other.name
+    end
+
+    alias eql? ==
+  end
+end

data/lib/method_object/version.rb

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

data/lib/method_object.rb

@@ -0,0 +1,193 @@
+# frozen_string_literal: true
+
+require 'method_object/parameter'
+
+# Allows for the creation of {https://sourcemaking.com/refactoring/replace-method-with-method-object method objects},
+# to ease the extraction of complex methods from other classes and the implementation of service objects.
+#
+# A method object works similarly to a proc/lambda, exposing a {.call} method and convenience
+# {.to_proc} method to convert it to a Proc.
+#
+# Major differences in behaviour compared to a `lambda`:
+#   * It accepts only named parameters
+#   * It performs type checking on the parameters
+#
+# @example Defining and invoking a method object
+#   class ComplexCalculation < MethodObject
+#     parameter :start_number, Integer
+#     parameter :end_number, Integer, default: 2
+#
+#     called do
+#       @magic_number = 42
+#       perform_complex_calculation
+#     end
+#
+#     private
+#
+#     def perform_complex_calculation
+#       start_number + second_number + @magic_number
+#     end
+#   end
+#
+#   ComplexCalculation.call(start_number: 1, end_number: 3) #=> 46
+#   ComplexCalculation.call(start_number: 1) #=> 45
+#   ComplexCalculation.call(end_number: 3) #=> raise ArgumentError
+#
+#   calculation = ComplexCalculation.new(end_number: 3)
+#   calculation.start_number = 1
+#   calculation.call # => 46
+#
+#   calculation.end_number = 2
+#   calculation.call # => 45
+#
+# @example Using the method object as a block
+#   class NameSayer < MethodObject
+#     parameter :name, String
+#
+#     called { "You're #{name}" }
+#   end
+#
+#   def say_my_name
+#     puts "- Say my name."
+#     puts "- " + yield(name: "Heisenberg")
+#     puts "- You're goddamn right!"
+#   end
+#
+#   say_my_name(&NameSayer)
+#   # Output:
+#   #
+#   # - Say my name.
+#   # - You're Heisenberg
+#   # - You're goddamn right!
+class MethodObject
+  class << self
+    # Calls the MethodObject with the given arguments.
+    #
+    # @param **args [Hash{Symbol => Object}] arguments to pass to the method
+    # @return [Object] return value of the method object
+    def call(**args)
+      new(**args).call
+    end
+
+    # Returns a proc that calls the MO with the given arguments.
+    # @return [Proc]
+    def to_proc
+      proc { |**args| call(**args) }
+    end
+
+    protected
+
+    # Defines a parameter for the method object.
+    #
+    # Parameters are also inherited from superclasses and can be redefined (overwritten) in subclasses.
+    #
+    # @param name [Symbol] name of the parameter
+    # @param type [Class, #===] type of the parameter. Can be a Class, a Proc or anything that defines a meaningful
+    #   `===` method
+    # @param **options [Hash] extra options for the parameter
+    # @option **options [Object, #call] :default default value if the parameter is not passed. If the default implements
+    #   `#call`, it gets called once in the context of the method object instance when it is instanciated
+    #
+    # @return [void]
+    def parameter(name, type = BasicObject, **options)
+      arg = MethodObject::Parameter.new(name, type, options)
+      parameters.delete(arg)
+      parameters << arg
+
+      define_method("#{name}=") do |value|
+        raise ArgumentError, "Expected a #{type} for #{name}, #{value.class} received" unless arg.acceptable?(value)
+        @monitor.synchronize { instance_variable_set("@#{name}", value) }
+      end
+
+      define_method("#{name}?") do
+        !public_send(name).nil?
+      end
+
+      attr_reader name
+    end
+
+    # Defines the method body.
+    # The body can be overwritten in subclasses and the superclass implementation can be invoked with `super()`,
+    # as with a regular method definition.
+    #
+    # @yield Block to be used as method body definition for the method object
+    # @return [void]
+    def called(&block)
+      define_method(:do_call, &block)
+      protected :do_call
+    end
+
+    private
+
+    # @return [Set]
+    def superclass_parameters
+      if superclass < MethodObject
+        superclass.send(:parameters)
+      else
+        Set.new
+      end
+    end
+
+    # @return [Set]
+    def parameters
+      @parameters ||= Set.new(superclass_parameters)
+    end
+  end
+
+  # @param **args [Hash{Symbol => Object}] arguments to set on the method object
+  def initialize(**args)
+    self.class.send(:parameters).freeze
+
+    @monitor = Monitor.new
+
+    args.each { |k, v| public_send("#{k}=", v) }
+    self.class.send(:parameters)
+        .reject { |p| args.keys.map(&:to_sym).include?(p.name) }
+        .select(&:default?)
+        .each { |p| public_send("#{p.name}=", p.default_in(self)) }
+  end
+
+  # Returns a hash with the parameters currently set.
+  # @return [Hash{Symbol => Object}]
+  def parameters
+    Hash[
+      self.class.send(:parameters).map(&:name)
+          .select { |p| instance_variable_defined?("@#{p}") }
+          .map { |p| [p, public_send(p)] }
+    ]
+  end
+
+  # Calls the method object with the parameters currently set.
+  # @raise [ArgumentError] if any required parameter is missing
+  # @return [Object] the return value result of the method invokation
+  def call
+    unless respond_to?(:do_call, true)
+      raise NotImplementedError,
+            'Implementation missing. Please use `called { ... }` to define method body'
+    end
+
+    @monitor.synchronize do
+      assert_required_arguments!
+      do_call
+    end
+  end
+
+  # Returns a lambda that calls the method object with the parameters currently set.
+  # @return [Proc]
+  def to_proc
+    -> { call }
+  end
+
+  private
+
+  # @raise [ArgumentError]
+  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(', ')}" \
+      unless missing_params.empty?
+  end
+end

data/lib/methodobject.rb

@@ -0,0 +1 @@
+require "method_object"

data/methodobject.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'method_object/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "methodobject"
+  spec.version       = MethodObject::VERSION
+  spec.authors       = ["Michele Piccirillo"]
+  spec.email         = ["michele@liqid.de"]
+
+  spec.summary       = 'Method Object pattern in Ruby for your service objects'
+  spec.description   = <<-EOF
+    Lightweight and dependency-free solution for the creation of method objects,
+    a common pattern used to ease the extraction of complex methods from other classes
+    and for the implementation of service objects.
+  EOF
+
+  spec.homepage      = "https://github.com/LIQIDTechnology/methodobject"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = "~> 2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "simplecov"
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: methodobject
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michele Piccirillo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: simplecov
+  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: |2
+      Lightweight and dependency-free solution for the creation of method objects,
+      a common pattern used to ease the extraction of complex methods from other classes
+      and for the implementation of service objects.
+email:
+- michele@liqid.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/method_object.rb
+- lib/method_object/parameter.rb
+- lib/method_object/version.rb
+- lib/methodobject.rb
+- methodobject.gemspec
+homepage: https://github.com/LIQIDTechnology/methodobject
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Method Object pattern in Ruby for your service objects
+test_files: []