actions 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 85a2c1a6c481e689e03e4b574e0dec8edd153f43
+  data.tar.gz: 7677c7d9e149e4c8df950ef5da1ae33f9f45671a
+SHA512:
+  metadata.gz: 26bc1ef1eb0ac9accc9047368255bd338c1f7816d115c471c210328e0779890ca4544ae53ce22bf554b3759f047dc94a43d8e0e8818e14bc42f89ac6993c5c4b
+  data.tar.gz: 023d9da4eee4f7293535ae18b209406cc6d0e2cba0db03921eee934b70f19ef2b94d48096bd6f6e9a8485092bd887cfdcae119dd968328198b14563f30c589bd

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,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Joao Carlos
+
+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,41 @@
+# Actions
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/actions`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'actions'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install actions
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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]/actions.
+
+
+## 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/actions.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'actions/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "actions"
+  spec.version       = Actions::VERSION
+  spec.authors       = ["Joao Carlos", "Lauri Jutila"]
+  spec.email         = ["mail@joao-carlos.com", "ruby@laurijutila.com"]
+
+  spec.summary       = %q{Action!}
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing 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 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_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "simplecov"
+end

data/bin/console

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

@@ -0,0 +1,12 @@
+require "actions/action"
+require "actions/group"
+
+module Actions
+  def self.storage_adapter=(storage_adapter)
+    @storage_adapter = storage_adapter
+  end
+
+  def self.storage_adapter
+    @storage_adapter
+  end
+end

data/lib/actions/action.rb

@@ -0,0 +1,62 @@
+require "actions/context"
+require "actions/safe_context"
+require "actions/action/error_handling"
+require "actions/action/storage"
+require "json"
+
+module Actions
+  module Action
+
+    def self.included(base)
+      base.class_eval do
+        prepend Storage
+        prepend ErrorHandling
+        extend ClassMethods
+        attr_reader :context
+      end
+    end
+
+    module ClassMethods
+
+      def call(context={})
+        new(context).call
+      end
+
+      def input(attribute, type: Object, required: false, mutable: false)
+        self.inputs[attribute.to_s] = { type: type, mutable: mutable, required: required }
+      end
+
+      def output(attribute, type: Object)
+        self.outputs[attribute.to_s] = { type: type }
+      end
+
+      def inputs
+        @inputs ||= {}
+      end
+
+      def outputs
+        @outputs ||= {}
+      end
+
+    end
+
+    # FIXME: Handle context failures more gracefully, i.e. don't initialize a new
+    # action if one in the group failed previously.
+    def initialize(context = {})
+      @context = SafeContext.new(context)
+      if @context.success? && (self.class.inputs.any? || self.class.outputs.any?)
+        @context.action = self
+        self.class.inputs.each do |name, options|
+          @context.input!(name, type: options[:type], mutable: options[:mutable], required: options[:required])
+        end
+        self.class.outputs.each do |name, options|
+          @context.output!(name, type: options[:type])
+        end
+      else
+        @context = Context.build(context)
+        @context.action = self
+      end
+    end
+
+  end
+end

data/lib/actions/action/error_handling.rb

@@ -0,0 +1,18 @@
+require "actions/errors"
+
+module Actions
+  module ErrorHandling
+
+    def call
+      super
+      context.called!(self)
+      context
+    rescue Actions::Errors::Failure
+      context.rollback!
+      return context
+    rescue
+      context.rollback!
+      raise
+    end
+  end
+end

data/lib/actions/action/storage.rb

@@ -0,0 +1,47 @@
+module Actions
+  module Storage
+
+    def initialize(context = {})
+      super
+    rescue Actions::Errors::ValidationFailed => error
+      context = JSON.load(JSON.dump(error.context.to_h))
+      store(:validation_failed, context, { message: context.message })
+    end
+
+    def call
+      store_around(:started, :done, :failed) do
+        super
+      end
+    end
+
+    def rollback
+      store_around(:rollback_started, :rollback_succeeded, :rollback_failed) do
+        super
+      end
+    end
+
+    private
+
+    def store(status, input, output)
+      Actions.storage_adapter.store(
+        name: self.class.name,
+        context_id: self.context.id,
+        input: input,
+        output: output,
+        status: status
+      )
+    end
+
+    def store_around(initial, success, failure, &block)
+      input_context = JSON.load(JSON.dump(context.to_h))
+      begin
+        store(initial, input_context, nil)
+        block.call
+        store(success, input_context, context.to_h)
+      rescue
+        store(failure, input_context, context.to_h)
+        raise
+      end
+    end
+  end
+end

data/lib/actions/context.rb

@@ -0,0 +1,100 @@
+require "ostruct"
+require "securerandom"
+require "actions/errors"
+
+module Actions
+  class Context < BasicObject
+
+    attr_reader :id
+    attr_accessor :action
+
+    def self.build(context={})
+      self === context ? context : new(context)
+    end
+
+    def initialize(initial={})
+      @id = ::SecureRandom.uuid
+      @hash = {}
+      @failure = false
+      _update(initial)
+    end
+
+    def success?
+      !failure?
+    end
+
+    def failure?
+      @failure
+    end
+
+    def fail!(context={})
+      _update(context)
+      @failure = true
+      ::Kernel.raise ::Actions::Errors::Failure.new(self, self)
+    end
+
+    def defined?(attribute)
+      @hash.has_key?(attribute.to_s)
+    end
+
+    def called!(action)
+      _called << action
+    end
+
+    def rollback!
+      return false if @rolled_back
+      _called.reverse_each(&:rollback)
+      @rolled_back = true
+    end
+
+    def method_missing(name, *args)
+      mname = name.id2name
+      len = args.length
+      if mname.chomp!("=")
+        if len != 1
+          ::Kernel.raise ::ArgumentError, "wrong number of arguments (#{len} for 1)", ::Kernel.caller(1)
+        end
+        @hash[mname] = args[0]
+      elsif len == 0
+        @hash[mname]
+      else
+        ::Kernel.raise ::NoMethodError, "undefined method `#{mname}' for #{self}", ::Kernel.caller(1)
+      end
+    end
+
+    def respond_to?(*args)
+      true
+    end
+
+    def class
+      (class << self; self end).superclass
+    end
+
+    def inspect
+      status = success? ? "success" : "failure"
+      attributes = to_h.map { |k,v| "#{k}=#{v.inspect}" }.join(", ")
+      "#{self.class.name}[#{status}](#{attributes})"
+    end
+
+    def to_s
+      inspect
+    end
+
+    def to_h
+      @hash
+    end
+
+    private
+
+    def _update(context)
+      context.each do |key, value|
+        __send__("#{key}=", value)
+      end
+    end
+
+    def _called
+      @called ||= []
+    end
+
+  end
+end

data/lib/actions/errors.rb

@@ -0,0 +1,21 @@
+module Actions
+  module Errors
+    class Error < StandardError
+      attr_reader :context
+
+      def initialize(message, context)
+        super(message)
+        @context = context
+      end
+    end
+
+    class Failure < Error
+    end
+
+    class ValidationFailed < Error
+    end
+
+    class InvalidType < Error
+    end
+  end
+end

data/lib/actions/group.rb

@@ -0,0 +1,37 @@
+require "actions/action"
+
+module Actions
+  module Group
+
+    def self.included(base)
+      base.class_eval do
+        include Action
+        extend ClassMethods
+        include InstanceMethods
+      end
+    end
+
+    module ClassMethods
+
+      def actions(*actions)
+        @actions ||= []
+        if actions.length > 0
+          @actions = actions.freeze
+        else
+          @actions
+        end
+      end
+
+    end
+
+    module InstanceMethods
+
+      def call
+        self.class.actions.each { |action| action.call(context) }
+        context
+      end
+
+    end
+
+  end
+end

data/lib/actions/safe_context.rb

@@ -0,0 +1,59 @@
+require "set"
+require "forwardable"
+require "actions/errors"
+
+module Actions
+  class SafeContext
+    extend Forwardable
+
+    def initialize(context = {})
+      @context = Context.build(context)
+    end
+
+    def input!(name, type: Object, required: false, mutable: false)
+      attribute!(name, type: type, readonly: !mutable)
+      validate!(name, type: type, required: required)
+    end
+
+    def output!(name, type: Object)
+      attribute!(name, type: type, readonly: false)
+    end
+
+    private
+
+    def attribute!(name, type: Object, readonly: false)
+      define_singleton_method(name) do
+        @context.__send__(name)
+      end
+
+      unless readonly
+        define_singleton_method("#{name}=") do |value|
+          unless value.is_a?(type)
+            raise Errors::InvalidType.new("#{name} allows values of type #{type}, received #{value.class}", self)
+          end
+
+          @context.__send__("#{name}=", value)
+        end
+      end
+    end
+
+    def validate!(attribute, type: Object, required: false)
+      value = @context.__send__(attribute)
+
+      if required
+        if value.nil?
+          raise Errors::ValidationFailed.new("expected #{attribute} not to be nil", self)
+        end
+      end
+
+      if @context.defined?(attribute)
+        unless value.is_a?(type)
+          raise Errors::ValidationFailed.new("expected #{attribute} to be of type #{type}, is #{value.class}", self)
+        end
+      end
+    end
+
+    def_delegators :@context, :success?, :failure?, :fail!, :called!,
+      :rollback!, :id, :to_h, :to_s, :defined?, :inspect, :action, :action=
+  end
+end

data/lib/actions/storage_adapter/active_record.rb

@@ -0,0 +1,42 @@
+module Actions
+  module StorageAdapter
+    class ActiveRecord
+
+      class Record < ::ActiveRecord::Base
+        serialize :input, JSON
+        serialize :output, JSON
+
+        enum status: {
+          started: 0,
+          done: 1,
+          failed: 2,
+          rollback_started: 3,
+          rollback_succeeded: 4,
+          rollback_failed: 5,
+          validation_failed: 6
+        }
+      end
+
+      def initialize(table_name)
+        @table_name = table_name
+        @record_class = Class.new(Record)
+        @record_class.table_name = table_name
+      end
+
+      def store(name:, context_id:, input:, output:, status:)
+        @record_class.create!(
+          name: name,
+          context_id: context_id,
+          input: input,
+          output: output,
+          status: status
+        )
+      end
+
+      def records
+        @record_class
+      end
+
+    end
+  end
+end

data/lib/actions/storage_adapter/null_adapter.rb

@@ -0,0 +1,8 @@
+module Actions
+  module StorageAdapter
+    class NullAdapter
+      def store(*args)
+      end
+    end
+  end
+end

data/lib/actions/version.rb

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

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: actions
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joao Carlos
+- Lauri Jutila
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: 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: 
+email:
+- mail@joao-carlos.com
+- ruby@laurijutila.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- actions.gemspec
+- bin/console
+- bin/setup
+- lib/actions.rb
+- lib/actions/action.rb
+- lib/actions/action/error_handling.rb
+- lib/actions/action/storage.rb
+- lib/actions/context.rb
+- lib/actions/errors.rb
+- lib/actions/group.rb
+- lib/actions/safe_context.rb
+- lib/actions/storage_adapter/active_record.rb
+- lib/actions/storage_adapter/null_adapter.rb
+- lib/actions/version.rb
+homepage: 
+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: Action!
+test_files: []
+has_rdoc: