operatic 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f5f46398654b0cda4099550dc86d85e82833fa9671722f901dfeb09a0c9ef6e5
+  data.tar.gz: c5098edb779caedbefc2ddf39861ffd6e005315f5928da73b5eaaa04046c68fc
+SHA512:
+  metadata.gz: 93c89546ab8bc0a51fd1e58e059a5ec5da145443fdffadc4072e8af304fad195d1034f31b37a446870fe7e230292d7a40bf0168cfc1cc536ceab4e7b251907fb
+  data.tar.gz: 8a14b3e513e2416c55fc768612f0445697da7dabd331594d651c88f8da42c866db3bef42933d22ba44b3ef29b37dc5a6aa77b00af93360b7738c1563d32280c3

data/.github/workflows/ruby.yml

@@ -0,0 +1,31 @@
+name: Ruby
+
+on: [push]
+
+jobs:
+  rspec:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby:
+          - '2.5.x'
+          - '2.6.x'
+
+    name: Ruby ${{ matrix.ruby }} RSpec
+
+    steps:
+    - uses: actions/checkout@v1
+
+    - name: Set up Ruby
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+
+    - name: Install latest bundler
+      run: gem install bundler
+
+    - name: Install operatic dependencies
+      run: bundle install --jobs 4
+
+    - name: Run RSpec
+      run: bundle exec rspec

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format documentation
+--require spec_helper

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 spideryoung@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 operatic.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Ben Pickles
+
+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,70 @@
+# Operatic
+
+[![GitHub Actions status](https://github.com/benpickles/operatic/workflows/Ruby/badge.svg)](https://github.com/benpickles/operatic)
+
+## Installation
+
+Add Operatic to your application's Gemfile and run `bundle install`.
+
+```ruby
+gem 'operatic'
+```
+
+## Usage
+
+An Operatic class encapsulates an operation and communicates the status of the operation via its result object. As well as being either a `#success?` or a `#failure?` further data can be attached via `#success!`, `#failure!` or convenience accessors.
+
+```ruby
+class SayHello
+  include Operatic
+
+  # Readers for attributes passed via `.call`.
+  attr_reader :name
+
+  # Declare convenience accessors on the result.
+  result :message
+
+  def call
+    # Exit the method and mark the result as a failure.
+    return failure! unless name
+
+    # Mark the result as a success and attach further data.
+    success!(message: "Hello #{name}")
+  end
+end
+
+result = SayHello.call(name: 'Dave')
+result.success? # => true
+result.message  # => "Hello Dave"
+result.to_hash  # => {:message=>"Hello Dave"}
+
+result = SayHello.call
+result.failure? # => true
+result.success? # => false
+result.message  # => nil
+result.to_hash  # => {}
+```
+
+A Rails controller might use Operatic like this:
+
+```ruby
+class HellosController < ApplicationController
+  def create
+    result = SayHello.call(name: params[:name])
+
+    if result.success?
+      render plain: result.message
+    else
+      render :new
+    end
+  end
+end
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Operatic project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/benpickles/operatic/blob/master/CODE_OF_CONDUCT.md).

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 'operatic'
+
+# 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/operatic.rb

@@ -0,0 +1,116 @@
+require 'operatic/errors'
+require 'operatic/result'
+require 'operatic/version'
+
+module Operatic
+  # @!visibility private
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    # The main way of calling an operation.
+    #
+    # The class is instantiated with supplied +attrs+ and calls {Operatic#call}
+    # returning a frozen {Result} instance.
+    #
+    # @param attrs [Hash<Symbol, anything>] an optional hash of key/values to
+    #   to the result. The class must have corresponding +attr_reader+s
+    #
+    # @return a [Result] which is fro
+    def call(attrs = nil)
+      new(attrs)
+        .tap(&:call)
+        .result
+        .freeze
+    end
+
+    # Calls {#call} but raises {FailureError} if the returned {Result} is a
+    # {Result#failure?} - useful for things like background jobs, rake tasks,
+    # test setups, etc.
+    #
+    # @return [Result]
+    def call!(attrs = nil)
+      call(attrs).tap { |result|
+        raise FailureError if result.failure?
+      }
+    end
+
+    # Define a {Result} subclass with named accessors specific to the class via
+    # {Result.generate}.
+    #
+    # @example
+    #   class SayHello
+    #     include Operatic
+    #
+    #     attr_reader :name
+    #
+    #     result :message
+    #
+    #     def call
+    #       success!(message: "Hello #{name}")
+    #     end
+    #   end
+    #
+    #   result = SayHello.call(name: 'Dave')
+    #   result.success? # => true
+    #   result.message  # => "Hello Dave"
+    def result(*args)
+      @result_class = Result.generate(*args)
+    end
+
+    def result_class
+      @result_class || Result
+    end
+  end
+
+  # An instance of {Result} or a subclass generated by {ClassMethods#result}.
+  #
+  # @return [Result]
+  attr_reader :result
+
+  def initialize(attrs = nil)
+    @result = self.class.result_class.new
+
+    attrs.each do |key, value|
+      instance_variable_set("@#{key}", value)
+    end if attrs
+  end
+
+  # Override this method with your implementation. Use {#success!} or
+  # {#failure!} methods to communicate the {#result}'s status and to attach
+  # data it. Define convenience result accessors with {ClassMethods#result}.
+  #
+  # @example
+  #   class SayHello
+  #     include Operatic
+  #
+  #     attr_reader :name
+  #
+  #     def call
+  #       return failure! unless name
+  #       success!(message: "Hello #{name}")
+  #     end
+  #   end
+  #
+  #   result = SayHello.call(name: 'Dave')
+  #   result.success? # => true
+  #   result.to_hash  # => {:message=>"Hello Dave"}
+  #
+  #   result = SayHello.call
+  #   result.failure? # => true
+  #   result.success? # => false
+  #   result.to_hash  # => {}
+  def call
+  end
+
+  # Convenience shortcut to the operation's {Result#failure!}.
+  def failure!(data = nil)
+    result.failure!(data)
+  end
+
+  # Convenience shortcut to the operation's {Result#success!}.
+  def success!(data = nil)
+    result.success!(data)
+  end
+end

data/lib/operatic/errors.rb

@@ -0,0 +1,4 @@
+module Operatic
+  OperaticError = Class.new(StandardError)
+  FailureError = Class.new(OperaticError)
+end

data/lib/operatic/result.rb

@@ -0,0 +1,87 @@
+module Operatic
+  class Result
+    # Generate a subclass of {Result} with named +attrs+ accessors. This
+    # wouldn't normally be called directly, see {ClassMethods#result} for
+    # example usage.
+    #
+    # @param attrs [Array<Symbol>] a list of accessors to the result's data.
+    def self.generate(*attrs)
+      Class.new(self) do
+        attrs.each do |name|
+          define_method name do
+            @data[name]
+          end
+
+          define_method "#{name}=" do |value|
+            @data[name] = value
+          end
+        end
+      end
+    end
+
+    def initialize
+      @data = {}
+      @success = true
+    end
+
+    # Mark the result as a failure, optionally attach data, and freeze the
+    # object so it cannot be modified further.
+    #
+    # *Note*: After calling this method calling {#success!} or {#failure!}
+    # again will raise a +FrozenError+.
+    #
+    # @param data [Hash<Symbol, anything>] an optional hash of data to attach
+    #   to the result.
+    def failure!(data = nil)
+      set_data(data) if data
+      @success = false
+      freeze
+    end
+
+    def failure?
+      !@success
+    end
+
+    def freeze
+      @data.freeze
+      super
+    end
+
+    # Mark the result as a success, optionally attach data, and freeze the
+    # object so it cannot be modified further.
+    #
+    # Calling this is not strictly necessary as a result defaults to being a
+    # success, but it's a convenient means of attaching data and of indicating
+    # intent in the consuming code.
+    #
+    # *Note*: After calling this method calling {#success!} or {#failure!}
+    # again will raise a +FrozenError+.
+    #
+    # @param data [Hash<Symbol, anything>] an optional hash of data to attach
+    #   to the result.
+    def success!(data = nil)
+      set_data(data) if data
+      @success = true
+      freeze
+    end
+
+    def success?
+      @success
+    end
+
+    # Returns the full hash of data attached to the result via {#success!},
+    # {#failure!}, or convenience accessors added with {.generate}.
+    #
+    # @return [Hash]
+    def to_hash
+      @data
+    end
+
+    private
+      def set_data(data)
+        data.each do |key, value|
+          @data[key] = value
+        end
+      end
+  end
+end

data/lib/operatic/version.rb

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

data/operatic.gemspec

@@ -0,0 +1,36 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'operatic/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'operatic'
+  spec.version       = Operatic::VERSION
+  spec.authors       = ['Ben Pickles']
+  spec.email         = ['spideryoung@gmail.com']
+
+  spec.summary       = 'Operations'
+  spec.description   = ''
+  spec.homepage      = 'https://github.com/benpickles/operatic'
+  spec.license       = 'MIT'
+
+  # spec.metadata['allowed_push_host'] = 'TODO: Set to 'http://mygemserver.com''
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  # spec.metadata['source_code_uri'] = 'TODO: Put your gem's public repo URL here.'
+  # spec.metadata['changelog_uri'] = 'TODO: Put your gem's CHANGELOG.md URL here.'
+
+  spec.required_ruby_version = '>= 2.5.0'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: operatic
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Ben Pickles
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-11-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !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:
+- spideryoung@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/operatic.rb
+- lib/operatic/errors.rb
+- lib/operatic/result.rb
+- lib/operatic/version.rb
+- operatic.gemspec
+homepage: https://github.com/benpickles/operatic
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/benpickles/operatic
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Operations
+test_files: []