actionizer 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7d4a6febf9f8f524d048670f7d5448ca762f11c8
+  data.tar.gz: 0adcb11a4177e39bebf7388e414372b2cd45dc37
+SHA512:
+  metadata.gz: 3018b241c4e794f31c5fd22a8f1f3c987ffb9520f2d9a102fe63e3e9c682eed98663a53a5af082806017fae7521d691b44ea17c5d91d87b62d8f8de97985b102
+  data.tar.gz: 81b4b7072f415438303a66fe04e198b953214c925f28a73f0011f823cc3c3d84d0ddf06a64e3146346f4a4d0c739448d79cbb2dd2aa340822d096dc9c4786737

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,13 @@
+Metrics/LineLength:
+  Max: 120
+
+Style/Documentation:
+  Enabled: false
+Style/EmptyLinesAroundBlockBody:
+  Enabled: false
+Style/EmptyLinesAroundClassBody:
+  Enabled: false
+Style/MutableConstant:
+  Enabled: false
+Style/TrivialAccessors:
+  Enabled: false

data/.simplecov

@@ -0,0 +1,8 @@
+SimpleCov.start do
+  track_files '**/*.rb'
+
+  add_filter '/spec'
+  add_filter '/lib/actionizer/version'
+
+  minimum_coverage 100.00
+end

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

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 mykphyre@yahoo.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 actionizer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Mike Nichols
+
+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,117 @@
+# Actionizer
+
+## Turn your classes into small, modular, resuable Actions!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'actionizer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install actionizer
+
+## Usage
+
+Here's how you define an Action:
+
+```ruby
+module Action
+  module Users
+
+    class Create
+      include Actionizer
+
+      def call
+        # Do stuff here
+        output.user = user
+      end
+    end
+
+  end
+end
+```
+
+You can immediately stop execution with the `fail!` method
+```ruby
+module Action
+  module Users
+
+    class Delete
+      include Actionizer
+
+      def call
+        # Possibly failing code here
+        fail!(error: "Nope, didn't work") if failure_condition
+
+        # This code never runs
+        output.foo = 'bar'
+      end
+    end
+
+  end
+end
+```
+
+Here's how you invoke it:
+```ruby
+module Action
+  module Users
+
+    class Onboard
+      include Actionizer
+
+      def call
+        result = Action::Users::Create.call(name: name, email: email)
+        fail!(error: result.error) if result.failure?
+
+        result = Action::Users::SendWelcomeEmail.call(name: name, email: email)
+        fail!(error: result.error) if result.failure?
+      end
+    end
+
+  end
+end
+```
+
+This pattern is so common, there's a shorthand: `call_and_check_failure!`
+```ruby
+module Action
+  module Users
+
+    class Onboard
+      include Actionizer
+
+      def call
+        # This code is identical to the example above
+        call_and_check_failure!(Action::Users::Create, name: name, email: email)
+        call_and_check_failure!(Action::Users::SendWelcomeEmail, name: name, email: email)
+      end
+    end
+
+  end
+end
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests and `rubocop -D` to check for style errors. 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/mikenichols/actionizer. 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/actionizer.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'actionizer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'actionizer'
+  spec.version       = Actionizer::VERSION
+  spec.authors       = ['Mike Nichols']
+  spec.email         = ['mykphyre@yahoo.com']
+
+  spec.summary       = 'Turn your classes into small, modular, reusable Actions'
+  spec.homepage      = 'https://github.com/mikenichols/actionizer'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  unless spec.respond_to?(:metadata)
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  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_runtime_dependency 'hashie'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'byebug', '~> 8.2'
+  spec.add_development_dependency 'rubocop', '~> 0.37'
+  spec.add_development_dependency 'simplecov', '~> 0.11'
+end

data/bin/console

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

@@ -0,0 +1,54 @@
+require 'actionizer/result'
+require 'actionizer/failure'
+require 'actionizer/version'
+
+module Actionizer
+  attr_reader :output
+
+  def self.included(base)
+    base.class_eval do
+      extend ClassMethods
+    end
+  end
+
+  module ClassMethods
+    def call(inputs = {})
+      new(inputs).tap(&:call).output
+    rescue Actionizer::Failure => af
+      af.output
+    end
+  end
+
+  def initialize(inputs = {})
+    @output = Actionizer::Result.new
+
+    inputs.each_pair do |key, value|
+      next if key.to_s == 'output'
+
+      instance_variable_set("@#{key}".to_sym, value)
+
+      self.class.class_eval do
+        attr_reader key
+      end
+    end
+  end
+
+  def fail!(params = {})
+    params.each_pair { |key, value| output[key] = value }
+
+    output.fail
+
+    raise Actionizer::Failure.new('Failed!', output)
+  end
+
+  def call_and_check_failure!(action_class, params = {})
+    unless action_class.include? Actionizer
+      raise ArgumentError, "#{action_class.name} must include Actionizer"
+    end
+
+    result = action_class.call(params)
+    fail!(error: result.error) if result.failure?
+
+    result
+  end
+end

data/lib/actionizer/failure.rb

@@ -0,0 +1,11 @@
+module Actionizer
+  class Failure < StandardError
+    attr_reader :output
+
+    def initialize(msg, output)
+      @output = output
+      super msg
+    end
+
+  end
+end

data/lib/actionizer/result.rb

@@ -0,0 +1,23 @@
+require 'hashie'
+
+module Actionizer
+  class Result < Hashie::Mash
+
+    def initialize
+      @success = true
+    end
+
+    def success?
+      @success
+    end
+
+    def failure?
+      !@success
+    end
+
+    def fail
+      @success = false
+    end
+
+  end
+end

data/lib/actionizer/version.rb

@@ -0,0 +1,3 @@
+module Actionizer
+  VERSION = '0.2.0'
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: actionizer
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Mike Nichols
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashie
+  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.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.2'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.37'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.37'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+description: 
+email:
+- mykphyre@yahoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".simplecov"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- actionizer.gemspec
+- bin/console
+- bin/setup
+- lib/actionizer.rb
+- lib/actionizer/failure.rb
+- lib/actionizer/result.rb
+- lib/actionizer/version.rb
+homepage: https://github.com/mikenichols/actionizer
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Turn your classes into small, modular, reusable Actions
+test_files: []