activecommand 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6539a80be081d5bb2ca07a4c214fd505456bf9b9
+  data.tar.gz: 13c3d3d4554c819a8373961ba7b3a881532503af
+SHA512:
+  metadata.gz: f81fae5b5fe169483413092a52549b4b0340ef0d9ed9680c5e3acf6d00fcb04daafc80bdda1996f5e109cb2d1d0e14d3a4524d3c1132705d9c4a1f4bb50eac82
+  data.tar.gz: 01e987eccf9471dc91d2463b4572027128c41c63e33d55381230ed713cd3439e3566c03e644b2a41b5b2ba4cd37c65a39a8219f7b8ce71d3bc048a8e7030d163

data/.gitignore

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

data/.rbenv-gemsets

@@ -0,0 +1 @@
+active_command

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+rvm:
+  - 2.2.3
+  - jruby
+before_install: gem install bundler -v 1.10.6
+
+script: 'bundle exec rake'
+
+notifications:
+  email:
+    recipients:
+      - jeff.carley@gmail.com
+    on_failure: change
+    on_success: never

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# 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, ethnicity, 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 activecommand.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Jefferson Carley
+
+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,68 @@
+# ActiveCommand
+
+ActiveCommand adds the ability to use the command pattern commonly seen in CQRS.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activecommand'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activecommand
+
+## Usage
+
+Developing a new command is pretty straight forward.
+
+First create your command.  Perhaps adding it to a commands folder under app, if you are using rails.
+
+    app
+      - commands
+        - SubmitOrderCommand.rb
+
+Then inherit from the base command class and implement an execute method.
+
+```ruby
+class SubmitOrderCommand < ActiveCommand::Command
+  def execute
+  end
+end
+```
+
+Add the desired implementation to the execute method.  In this case, what ever is needed to submit an order. To
+execute the command, instantiate it and execute it using the CommandBus.  The returned value from executing the command
+is a CommandResult object.  The CommandResult will tell you if the command was successful or not.
+
+```ruby
+submit_order_command = SubmitOrderCommand.new
+cr = ActiveCommand::CommandBus.execute(submit_order_command)
+if cr.success?
+  redirect "/"
+else
+  render "submit_path"
+end
+```
+
+## 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/[USERNAME]/activecommand. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](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/activecommand.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_command/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "activecommand"
+  spec.version       = ActiveCommand::VERSION
+  spec.authors       = ["Jefferson Carley"]
+  spec.email         = ["jeff.carley@gmail.com"]
+
+  spec.summary       = %q{ActiveCommand adds the ability to use the command pattern commonly seen in CQRS.}
+  spec.homepage      = "https://github.com/jcarley/activecommand"
+  spec.license       = "MIT"
+
+  spec.add_dependency 'virtus'
+  spec.add_dependency 'middleware'
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'activemodel'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  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.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/bin/console

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

@@ -0,0 +1,20 @@
+require 'virtus'
+require 'middleware'
+require 'active_support'
+require 'active_support/hash_with_indifferent_access'
+require 'active_model'
+
+module ActiveCommand
+  extend ActiveSupport::Autoload
+
+  autoload :Command
+  autoload :CommandBus
+  autoload :CommandResult
+  autoload :CommandNotValidError
+
+  autoload_under 'middleware' do
+    autoload :CommandRunner
+  end
+
+end
+

data/lib/active_command/command.rb

@@ -0,0 +1,31 @@
+module ActiveCommand
+  class Command
+    include Virtus.model
+    include ActiveModel::Validations
+    include ActiveModel::Serializers::JSON
+
+    def self.from_json(json)
+      klass = self.new
+      klass.from_json(json)
+      klass
+    end
+
+    def to_params
+      ActiveSupport::HashWithIndifferentAccess.new(attributes).delete_if { |k, v| v.nil? }
+    end
+    alias_method :to_hash, :to_params
+
+    def run
+      if self.valid?
+        self.execute
+      else
+        raise ActiveCommand::CommandNotValidError, self.errors.full_messages
+      end
+    end
+
+    def execute
+      raise NotImplementedError, "#{self.class.name} does not implement an execute method"
+    end
+
+  end
+end

data/lib/active_command/command_bus.rb

@@ -0,0 +1,28 @@
+module ActiveCommand
+  class CommandBus
+    include Singleton
+
+    def self.execute(command)
+      bus = self.instance
+      bus.execute(command)
+    end
+
+    def execute(command)
+      env = {:command => command}
+      default_middleware.call(env)
+      env[:command_result]
+    end
+
+    private
+
+    def default_middleware
+      @stack ||= Middleware::Builder.new do
+        # use ActiveCommand::Middleware::Benchmarker
+        use ActiveCommand::CommandRunner
+      end
+      @stack
+    end
+
+  end
+end
+

data/lib/active_command/command_not_valid_error.rb

@@ -0,0 +1 @@
+class ActiveCommand::CommandNotValidError < StandardError; end

data/lib/active_command/command_result.rb

@@ -0,0 +1,29 @@
+module ActiveCommand
+  class CommandResult
+
+    attr_accessor :command, :error
+
+    def initialize(command)
+      @command = command
+    end
+
+    def success?
+      self.error.nil?
+    end
+    alias_method :is_successful?, :success?
+
+    def on_success?(&block)
+      if self.is_successful?
+        block.call(self)
+      end
+      self
+    end
+
+    def on_error?(&block)
+      if ! self.is_successful?
+        block.call(self)
+      end
+      self
+    end
+  end
+end

data/lib/active_command/middleware/command_runner.rb

@@ -0,0 +1,28 @@
+module ActiveCommand
+  class CommandRunner
+
+    class MissingCommandError < StandardError; end;
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      cmd = env.fetch(:command, nil)
+
+      result = CommandResult.new(cmd).tap do |cr|
+        begin
+          raise MissingCommandError if cr.command.nil?
+          cr.command.run
+        rescue StandardError => e
+          cr.error = e
+        end
+      end
+
+      env[:command_result] = result
+
+      @app.call(env) if @app
+    end
+
+  end
+end

data/lib/active_command/version.rb

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

data/lib/activecommand.rb

@@ -0,0 +1,2 @@
+# Pointer for auto-require
+require 'active_command'

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: activecommand
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jefferson Carley
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- jeff.carley@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rbenv-gemsets"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activecommand.gemspec
+- bin/console
+- bin/setup
+- lib/active_command.rb
+- lib/active_command/command.rb
+- lib/active_command/command_bus.rb
+- lib/active_command/command_not_valid_error.rb
+- lib/active_command/command_result.rb
+- lib/active_command/middleware/command_runner.rb
+- lib/active_command/version.rb
+- lib/activecommand.rb
+homepage: https://github.com/jcarley/activecommand
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5.1
+signing_key: 
+specification_version: 4
+summary: ActiveCommand adds the ability to use the command pattern commonly seen in
+  CQRS.
+test_files: []