commandoes 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 01232f3d19184508a987df015c4dc04c22dae0c7
+  data.tar.gz: c8a05f7e1aa4349255e4376619d3763e82ac5640
+SHA512:
+  metadata.gz: 71d40f8d35e901e9b1aca4525390b3e6b1c2db31158f81c3d79191215283625823ed66a1e7eecd92ac198215ff88b0281e4681e7a506b9de9fe68152b29a01dc
+  data.tar.gz: 6b631a98bc261237835acd06628163d1c9a43db0f955df21fbe7638ea431ce3c0f3e55e6b36cf19424229c13e57775e545b488ed1799e6777121fd0987729ccb

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.ruby-version
+.ruby-gemset
+.DS_Store
+*.swp

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.14.4

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+ruby   '2.3.1'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Michael Elkins
+
+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,44 @@
+# COMMANDO
+
+Commandoes is a project designed to help any ruby app use the command pattern to
+change state.
+
+## PREREQUISITES
+* ruby-2.3.1
+
+## DEPENDENCIES
+* Virtus (https://github.com/solnic/virtus)
+* ActiveModel::Validations
+
+## INSTALLATION
+
+In your Gemfile
+
+```
+gem 'commando', github: 'mdelkins/commando'
+```
+
+## EXAMPLES
+
+1. [Command & Handler](./examples/command_and_handler.md)
+2. [Registry & Dispatcher](./examples/command_registry_and_dispatcher.md)
+
+## PLUGINS
+
+Commandoes uses a plugin system similar to
+[sequel](https://github.com/jeremyevans/sequel) or
+[roda](https://github.com/jeremyevans/roda) to extend the behavior of your
+command objects.  Currently their are two dependent plugins:
+
+* Commandoes::Plugins::VirtusPlugin
+* Commandoes::Plugins::ActiveModelPlugin
+
+### Commandoes::Plugins::VirtusPlugin
+
+This plugin injects the `Virtus.value_object` behavior into
+`Commandoes::IAmACommand` as well as a few helper methods for easily defining
+typed attributes.
+
+### Commandoes::Plugins::ActiveModelPlugin
+
+This plugin is used to give commands active model like validation behavior.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

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

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/commandoes.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'commandoes/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "commandoes"
+  spec.version       = Commandoes::VERSION
+  spec.authors       = ["Michael Elkins"]
+  spec.email         = ["mike@mdelkins.com"]
+
+  spec.summary       = %q{Commandoes is a library to support the command design pattern}
+  spec.description   = %q{Commandoes is a library to help build the series of objects needed for the command design pattern.  It can help wtih building commands, handlers to execute commands, and command registries.}
+  spec.homepage      = "https://github.com/mdelkins/commando"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "virtus", "~> 1.0"
+  spec.add_dependency "activemodel", "~> 5.0"
+
+  spec.add_development_dependency "bump",    "~> 0.5"
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "minitest-color", "~> 0.0"
+end

data/examples/command_and_handler.md

@@ -0,0 +1,42 @@
+# COMMAND & HANDLER
+
+```ruby
+class RegisterAccountCommand < Commandoes::IAmACommand
+  values do
+    string :identity
+    string :password
+    string :password_confirmation
+  end
+
+  validates_presence_of \
+    :identity,
+    :password,
+    :password_confirmation
+
+  validate \
+    :password_confirmation!
+
+private
+  def password_confirmation!
+    unless password_confirmation == password
+      errors.add :password_confirmation, "doesn't match password"
+    end
+  end
+end
+
+class RegisterAccountHandler
+  def initialize(command)
+    @command = command 
+  end
+
+  def call
+    return command unless command.valid?
+    account_to_register = Account.new command.attributes
+    account_to_register.save!
+  end
+end
+
+command = RegisterAccountCommand.new identity: 'test@test.test', password: 'Password123123!@#', password_confirmation: 'Password123123!@#'
+handler = RegisterAccountHandler.new command
+handler.call
+```

data/examples/command_registry_and_dispatcher.md

@@ -0,0 +1,56 @@
+```ruby
+class RegisterAccountCommand < Commandoes::IAmACommand
+  values do
+    string :identity
+    string :password
+    string :password_confirmation
+  end
+
+  validates_presence_of \
+    :identity,
+    :password,
+    :password_confirmation
+
+  validate \
+    :password_confirmation!
+
+private
+  def password_confirmation!
+    unless password_confirmation == password
+      errors.add :password_confirmation, "doesn't match password"
+    end
+  end
+end
+
+class RegisterAccountHandler
+  def initialize(command)
+    @command = command 
+  end
+
+  def call
+    return command unless command.valid?
+    account_to_register = Account.new command.attributes
+    account_to_register.save!
+  end
+end
+
+
+class AccountCommandRegistry < IAmACommandRegistry
+  def initialize
+    register RegisterAccountCommand, handler: RegisterAccountHandler
+  end
+end
+
+class AccountService
+  def initialize
+    @dispatcher = Commandoes::Dispatcher.new registry: AccountCommandRegistry.new
+  end
+
+  def register_account(safe_params)
+    dispatcher.dispatch RegisterAccountCommand.new safe_params
+  end
+
+private
+  attr_reader :dispatcher
+end
+```

data/lib/commandoes/command.rb

@@ -0,0 +1,29 @@
+module Commandoes
+  class IAmACommand
+    include ActiveModel::Validations
+
+    module ClassMethods
+      def use(plugin, *args, &block)
+        unless plugins.include? plugin
+          plugins << plugin
+          extend  plugin::ClassMethods    if plugin.const_defined? :ClassMethods
+          include plugin::InstanceMethods if plugin.const_defined? :InstanceMethods
+        end
+
+        self
+      end
+
+    private
+      def plugins
+        @@pluglins ||= []
+      end
+    end
+
+    extend ClassMethods
+
+    use self
+    use Plugins::VirtusPlugin
+    use Plugins::ActiveModelPlugin
+
+  end
+end

data/lib/commandoes/dispatcher.rb

@@ -0,0 +1,29 @@
+module Commandoes
+  UnknownCommand   = Class.new StandardError
+  RegistryNotFound = Class.new StandardError
+
+  class Dispatcher
+    def initialize(registry: nil)
+      @registry = registry
+    end
+
+    def dispatch(command)
+      raise RegistryNotFound unless registry.present?
+      raise UnknownCommand   unless command.kind_of? IAmACommand
+
+      registry.find_by command do |handler|
+        handler = handler.new command
+        result  = handler.call
+
+        if block_given?
+          yield result
+        end
+        
+        return result
+      end
+    end
+
+  private
+    attr_reader :registry
+  end
+end

data/lib/commandoes/plugins/activemodel_plugin.rb

@@ -0,0 +1,23 @@
+module Commandoes
+  module Plugins
+    module ActiveModelPlugin
+
+      module ClassMethods
+        def self.extended(object)
+          object.send(:include, ActiveModel::Validations)
+        end
+      end
+
+      module InstanceMethods
+        def valid?
+          @valid ||= super
+        end
+
+        def invalid?
+          not valid?
+        end
+      end
+
+    end
+  end
+end

data/lib/commandoes/plugins/virtus_plugin.rb

@@ -0,0 +1,47 @@
+module Commandoes
+  module Plugins
+    module VirtusPlugin
+
+      module ClassMethods
+        def self.extended(object)
+          object.send(:include, Virtus.value_object)
+        end
+
+        def bool(value, options={})
+          attribute value, Axiom::Types::Boolean, options
+        end
+
+        def date(value, options={})
+          attribute value, Date, options
+        end
+
+        def datetime(value, options={})
+          attribute value, DateTime, options
+        end
+
+        def decimal(value, options={})
+          attribute value, BigDecimal, options
+        end
+
+        def float(value, options={})
+          attribute value, Float, options
+        end
+
+        def integer(value, options={})
+          attribute value, Integer, options
+        end
+
+        def string(value, options={})
+          attribute value, String, options
+        end
+
+        def time(value, options={})
+          attribute value, Time, options
+        end
+      end
+
+      module InstanceMethods
+      end
+    end
+  end
+end

data/lib/commandoes/registry.rb

@@ -0,0 +1,52 @@
+module Commandoes
+  class IAmACommandRegistry
+    def initialize(storage: DefaultStorageStrategy)
+      @storage = storage
+    end
+
+    def [](command)
+      handlers.fetch(storage_strategy.call command) { NullHandler }.tap do |handler|
+        yield handler if block_given?
+      end
+    end
+
+    alias_method :find_by, :[]
+
+  protected
+
+    def handlers
+      @handlers ||= {}
+    end
+
+    def storage_strategy
+      @storage ||= DefaultStorageStrategy
+    end
+
+    def register(command, handler: nil)
+      unless handler.nil?
+        handlers[storage_strategy.call command] = handler
+      end
+    end
+  end
+
+  DefaultStorageStrategy = ->(command) do
+    return command.class unless command.kind_of? Class
+    command
+  end
+
+  class NullHandler
+    def initialize(command)
+      @command = command
+    end
+
+    def call
+      puts "-" * 65
+      puts " NO HANDLER REGISTERED FOR #{command.class.upcase}"
+      puts "-" * 65
+      puts command.inspect
+    end
+
+  private
+    attr_reader :command
+  end
+end

data/lib/commandoes/version.rb

@@ -0,0 +1,3 @@
+module Commandoes
+  VERSION = "0.1.1"
+end

data/lib/commandoes.rb

@@ -0,0 +1,13 @@
+
+require 'active_model'
+require 'virtus'
+
+require "commandoes/plugins/virtus_plugin"
+require "commandoes/plugins/activemodel_plugin"
+
+require "commandoes/command"
+require "commandoes/dispatcher"
+require "commandoes/registry"
+
+require "commandoes/version"
+

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: commandoes
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Michael Elkins
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bump
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-color
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+description: Commandoes is a library to help build the series of objects needed for
+  the command design pattern.  It can help wtih building commands, handlers to execute
+  commands, and command registries.
+email:
+- mike@mdelkins.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- commandoes.gemspec
+- examples/command_and_handler.md
+- examples/command_registry_and_dispatcher.md
+- lib/commandoes.rb
+- lib/commandoes/command.rb
+- lib/commandoes/dispatcher.rb
+- lib/commandoes/plugins/activemodel_plugin.rb
+- lib/commandoes/plugins/virtus_plugin.rb
+- lib/commandoes/registry.rb
+- lib/commandoes/version.rb
+homepage: https://github.com/mdelkins/commando
+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.6.6
+signing_key: 
+specification_version: 4
+summary: Commandoes is a library to support the command design pattern
+test_files: []