operate 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d93185f6ff1d022b5511ba6f6fbd2e815e27eaf1
+  data.tar.gz: d0ba09ef7bb5723dc5e0302847dd0c635c28191d
+SHA512:
+  metadata.gz: ee4756b459c0db03be97b7e581ad4e7d27fbc9202bc5e661f393f55f806f66cedd489ea9d25b4ec89ad91b5f0f56c6cdc48bcfd4d627e04c0c5b8fcc7ccee943
+  data.tar.gz: 8daae04166fe135d2f4e70b3d37946bcbb24291834a91371b87d44cc55e999f0f5b87d43379ad115da0840e583376f4a5825405072b29179e3c87edc1ccb8f2d

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at tomichj@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Justin Tomich
+
+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,127 @@
+# Operate
+
+Operate is a gem to help create [service objects].
+
+Use Operate to __remove all business logic from your controller and model__, subsuming it in an Operate-based 
+class that represents your processes. Examples might be: a user addition, a post addition, or adding  a comment.  
+
+Service objects can out factor behavior that would bloat models or controllers, and is a useful step to patterns
+like Strategy and Command.
+
+Operate is in the very earliest stages of development. Additional features will be added. The core API 
+exposed via `Operate::Command` is solid and no changes are in the words.
+
+
+## Dependencies
+
+Operate requires:
+* `ActiveRecord` 4.2 or greater
+* `ActiveSupport` 4.2 or greater
+
+It's not required, but a form object library like [Reform] is recommended. Reform is used in the examples below.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'operate'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install operate
+
+
+## Usage
+
+Just `include Operate::Command` in your class. Operate's api provides:
+
+Methods used in your service class:
+* `self#call(*args, &block)` will initialize your service class with *args and invoke #call
+* `#broadcast(:event, *args)` that will broadcast an event to a subscriber
+* `#transaction(&block)` that wraps a block inside a transaction
+
+Methods used by clients of your service class:
+* `#on(*events, &block)` that subscribe to an event or events, and provide a block to handle that event
+
+
+An example service:
+
+```ruby
+class UserAddition
+  include Operate::Command
+  
+  def initialize(form, params)
+    @form = form
+    @params = params
+  end
+  
+  def call
+    return broadcast(:invalid) unless @form.validate(@params)
+    
+    transaction do
+      create_user
+      audit_trail
+      welcome_user
+    end
+    
+    broadcast(:ok)
+  end
+  
+  def create_user
+    # ...
+  end
+  
+  def audit_trail
+    # ...
+  end
+  
+  def welcome_user
+    # ...
+  end
+end
+```
+
+And your controller:
+
+```ruby
+class UserController < ApplicationController
+  def create
+    @form = UserForm.new(params) # a simple Reform form object
+    UserAddition.call(@form) do
+      on(:ok)      { redirect_to dashboard_path }
+      on(:invalid) { render :new }
+    end
+  end
+end
+```
+
+
+## Credit
+
+The core of Operate is based on [rectify] and [wisper], and would not exist without these fine projects.
+Both rectify and wisper are excellent gems, they just provide more functionality than I require, and with
+some philosophical differences in execution (rectify requires you extend their base class, operate provides mixins).
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tomichj/operate. 
+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).
+
+[service objects]: https://gist.github.com/blaix/5764401
+[Reform]: http://trailblazer.to/gems/reform/index.html
+[rectify]: https://github.com/andypike/rectify
+[wisper]: https://github.com/krisleech/wisper

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,9 @@
+require 'active_support'
+require 'active_model'
+require 'active_record'
+
+require 'operate/version'
+require 'operate/pubsub/events'
+require 'operate/pubsub/publisher'
+require 'operate/pubsub/registration'
+require 'operate/command'

data/lib/operate/command.rb

@@ -0,0 +1,47 @@
+module Operate
+
+  #
+  # A command-pattern implementation for controller actions, etc.
+  #
+  # `register` handlers with on().
+  # `broadcast` results with broadcast().
+  # `transaction` wraps ActiveRecord transactions.
+  #
+  module Command
+    include Operate::Pubsub::Publisher
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+
+      #
+      # Call will initialize the class with *args and invoke `call` with no parameters.
+      #
+      def call(*args, &block)
+        command = new(*args)
+        command.evaluate(&block) if block_given?
+        command.call
+      end
+    end
+
+    def transaction(&block)
+      ActiveRecord::Base.transaction(&block) if block_given?
+    end
+
+    def evaluate(&block)
+      @caller = eval('self', block.binding)
+      instance_eval(&block)
+    end
+
+    def method_missing(method_name, *args, &block)
+      if @caller.respond_to?(method_name, true)
+        @caller.send(method_name, *args, &block)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      @caller.respond_to?(method_name, include_private)
+    end
+  end
+end

data/lib/operate/pubsub/events.rb

@@ -0,0 +1,52 @@
+module Operate
+  module Pubsub #:nodoc:
+    # Describes allowed events
+    #
+    # Duck-types the argument to quack like array of strings
+    # when responding to the {#include?} method call.
+    class Events
+      # Initialize with a list of events.
+      #
+      # @param [NilClass, String, Symbol, Array, Regexp] list
+      def initialize(list)
+        @list = list
+      end
+
+      # Check if given event is included in the 'list' of events.
+      #
+      # @param [#to_s] event
+      #
+      # @return [Boolean]
+      def include?(event)
+        appropriate_method.call(event.to_s)
+      end
+
+      private
+
+      # Different event types and their corresponding matching method.
+      def methods
+        {
+          NilClass   => ->(_event) { true },
+          String     => ->(event)  { list == event },
+          Symbol     => ->(event)  { list.to_s == event },
+          Enumerable => ->(event)  { list.map(&:to_s).include? event },
+          Regexp     => ->(event)  { list.match(event) || false }
+        }
+      end
+
+      attr_reader :list
+
+      def appropriate_method
+        @appropriate_method ||= methods[recognized_type]
+      end
+
+      def recognized_type
+        methods.keys.detect(&list.method(:is_a?)) || type_not_recognized
+      end
+
+      def type_not_recognized
+        raise(ArgumentError, "#{list.class} not supported for `on` argument")
+      end
+    end
+  end
+end

data/lib/operate/pubsub/publisher.rb

@@ -0,0 +1,51 @@
+require 'active_support/notifications'
+
+module Operate
+  module Pubsub
+
+    #
+    # A Command uses Publisher to register event handlers and broadcast to them.
+    #
+    module Publisher
+
+      # Subscribe a block
+      #
+      # @example
+      #   my_publisher.on(:order_created) { |args| ... }
+      #
+      # @return [self]
+      def on(*events, &block)
+        raise ArgumentError, 'must give at least one event' if events.empty?
+        raise ArgumentError, 'must pass a block' unless block
+        registrations << Operate::Pubsub::Registration.new(block, on: events)
+        self
+      end
+
+      # Broadcasts an event
+      #
+      # @example
+      #   def call
+      #     # ...
+      #     broadcast(:finished)
+      #   end
+      #
+      # @return [self]
+      def broadcast(event, *args)
+        registrations.each do |registration|
+          registration.broadcast(clean_event(event), *args)
+        end
+        self
+      end
+
+      private
+
+      def registrations
+        @registrations ||= Set.new
+      end
+
+      def clean_event(event)
+        event.to_s.gsub('-', '_')
+      end
+    end
+  end
+end

data/lib/operate/pubsub/registration.rb

@@ -0,0 +1,25 @@
+module Operate
+  module Pubsub
+    #
+    # Registers a listener for an event(s).
+    #
+    class Registration
+      attr_reader :on, :listener
+
+      def initialize(listener, options)
+        @listener = listener
+        @on = Operate::Pubsub::Events.new options[:on]
+      end
+
+      def broadcast(event, *args)
+        listener.call(*args) if should_broadcast?(event)
+      end
+
+      private
+
+      def should_broadcast?(event)
+        on.include? event
+      end
+    end
+  end
+end

data/lib/operate/version.rb

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

data/operate.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'operate/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'operate'
+  spec.version       = Operate::VERSION
+  spec.authors       = ['Justin Tomich']
+  spec.email         = ['tomichj@gmail.com']
+
+  spec.summary       = 'An operation object.'
+  spec.description   = ''
+  spec.homepage      = 'https://github.com/tomichj/operate'
+  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'] = "TODO: Set to 'http://mygemserver.com'"
+  # 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_dependency 'activesupport', '>= 4.2.0'
+  spec.add_dependency 'activerecord',  '>= 4.2.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: operate
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Justin Tomich
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !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: 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'
+description: ''
+email:
+- tomichj@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/operate.rb
+- lib/operate/command.rb
+- lib/operate/pubsub/events.rb
+- lib/operate/pubsub/publisher.rb
+- lib/operate/pubsub/registration.rb
+- lib/operate/version.rb
+- operate.gemspec
+homepage: https://github.com/tomichj/operate
+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.11
+signing_key: 
+specification_version: 4
+summary: An operation object.
+test_files: []