curryable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c69f5509d381742d21f5c98772a3b88c063c19a4
+  data.tar.gz: 03a2828d99d416ef2e09ad6371a35dd7307a13ae
+SHA512:
+  metadata.gz: 963468f73b842c42c27d6c1746f9c6485c5cf9bb72d6ad6e9a3babc6bf977c93a8e832335ebcc73818ecdef671243581984be54b52d618bfa3cec9d19469bc44
+  data.tar.gz: a24666d8a5f70fe3f207ad6d2e46c292e0f2bb62b31e771a8c25124719e7f83f5389bc96c318cc8b3e70664460333d80ae5e963cf723aa34ed204a20514e4f57

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,28 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, 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, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual
+language or imagery, derogatory comments or personal attacks, trolling, public
+or private harassment, insults, or other 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. Project maintainers who do not
+follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by opening an issue or contacting one or more of the project
+maintainers.
+
+This Code of Conduct is adapted from the [Contributor
+Covenant](http:contributor-covenant.org), version 1.0.0, available at
+[http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,17 @@
+PATH
+  remote: .
+  specs:
+    curryable (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (10.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.9)
+  curryable!
+  rake (~> 10.0)

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Stephen Best and Dominic Baggot
+
+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,48 @@
+Curryable
+=========
+
+## What is a command object?
+
+An object (noun) that acts as a container for a function (verb).
+
+## Design goals
+
+* Objects should be immutable
+* Object should act like a function
+* Arguments to the object can be curried
+* Objects should be inspectable. Inspection should reveal
+  * the class
+  * which arguments have been curried, and their values
+
+```ruby
+class SignUpUser
+  def initialize(user_creator:, attributes:, email_api:, crm_api:)
+    @user_creator = user_creator
+    @attributes = attributes
+    @email_api = email_api
+    @crm_api = crm_api
+  end
+
+  attr_reader :user_creator, :attributes, :email_api, :crm_api
+  private     :user_creator, :attributes, :email_api, :crm_api
+
+  def call
+    create_user_record
+    send_confirmation_email
+    add_user_to_crm
+  end
+end
+
+signup_service = Curryable.new(SignUpUser).call(
+  user_creator: User,
+  email_api: EmailAPI.new(EMAIL_AUTH_TOKEN),
+  crm_api: CRMAPI.new(CRM_AUTH_TOKEN),
+)
+
+signup_service.inspect
+# => <# Curryable<SignUpUser> user_creator=User, email_api=<#EmailAPI>, crm_api=<#CRMAPI>, attributes=>
+
+signup_service.call(
+  attributes: user_attrs,
+)
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "curryable"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/curryable.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'curryable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "curryable"
+  spec.version       = Curryable::VERSION
+  spec.authors       = ["Stephen Best", "Dominic Baggot"]
+  spec.email         = ["bestie@gmail.com", "dominic.baggot@gmail.com"]
+
+  spec.summary       = %q{Enables immutable command objects to act as currable functions}
+  spec.homepage      = "https://github.com/evilstreak/curryable"
+  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.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry", "0.10.1"
+end

data/lib/curryable/version.rb

@@ -0,0 +1,3 @@
+module Curryable
+  VERSION = "0.1.0"
+end

data/lib/curryable.rb

@@ -0,0 +1,94 @@
+class Curryable
+  def initialize(command_class, *arguments)
+    @command_class = command_class
+    @arguments = arguments
+  end
+
+  attr_reader :command_class, :arguments
+  private     :command_class, :arguments
+
+  def call(*new_arguments)
+    curryable = self.class.new(
+      command_class,
+      *combined_arguments(new_arguments)
+    )
+
+    if curryable.enough_arguments?
+      curryable.execute
+    else
+      curryable
+    end
+  end
+
+  protected
+
+  def enough_arguments?
+    enough_positional_arguments? && enough_keyword_arguments?
+  end
+
+  def execute
+    command_class.new(*arguments).call
+  end
+
+  private
+
+  def combined_arguments(new_arguments)
+    combined = arguments + new_arguments
+
+    positional = combined.take(arity)
+
+    possible_keywords = combined.drop(arity)
+
+    unless possible_keywords.all? { |arg| arg.is_a?(Hash) }
+      excess_arg_count = combined.length
+
+      raise ArgumentError.new(
+        "wrong number of arguments (#{excess_arg_count} for #{arity})"
+      )
+    end
+
+    keywords = possible_keywords.reduce(&:merge) || {}
+
+    unknown_keywords = keywords.keys - required_keywords
+
+    if unknown_keywords.any?
+      plural = unknown_keywords.length > 1 ? "s" : ""
+
+      raise ArgumentError.new(
+        "unknown keyword#{plural}: #{unknown_keywords.join(", ")}"
+      )
+    end
+
+    positional + [keywords].reject(&:empty?)
+  end
+
+  def enough_positional_arguments?
+    arguments.length >= arity
+  end
+
+  def enough_keyword_arguments?
+    provided_keywords & required_keywords == required_keywords
+  end
+
+  def provided_keywords
+    provided_keyword_arguments.keys
+  end
+
+  def provided_keyword_arguments
+    arguments.drop(arity).fetch(0, {})
+  end
+
+  def required_keywords
+    parameters
+      .select { |(type, _name)| type == :keyreq }
+      .map { |(_type, name)| name }
+  end
+
+  def arity
+    parameters.count { |(type, _name)| type == :req }
+  end
+
+  def parameters
+    command_class.instance_method(:initialize).parameters
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: curryable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stephen Best
+- Dominic Baggot
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+description: 
+email:
+- bestie@gmail.com
+- dominic.baggot@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- curryable.gemspec
+- lib/curryable.rb
+- lib/curryable/version.rb
+homepage: https://github.com/evilstreak/curryable
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Enables immutable command objects to act as currable functions
+test_files: []