lasershark 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4cc32e3d2b7b1000e189afcdda6faeddb437f665
+  data.tar.gz: 4dd2d1590e1ebe2ca46d271ae47f54624e50e463
+SHA512:
+  metadata.gz: 5ac08a10316c0fa9d0457f90bdb1f339fbc4f0dd107db72d259e3e2635fa3301fd3381bb0613b823517b741c9f2243b3cff9f2e81b2fca05627fd3c3ac561d62
+  data.tar.gz: 5ca38bd5c687d860b95c25b986153e888fd8356bd883e61004a0d91728776f2fa5b11d7e162cb0bf9fdf0108f4040d9fd741571394c3a6e8d584feef0f6e08eb

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in lasershark.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Jon Stokes
+
+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,39 @@
+# Lasershark
+
+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/lasershark`. 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 'lasershark'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lasershark
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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]/lasershark.
+
+## 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,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "lasershark/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "lasershark"
+  spec.version       = Lasershark::VERSION
+  spec.authors       = ["Jon Stokes"]
+  spec.email         = ["jon@jonstokes.com"]
+
+  spec.summary       = %q{The interactor gem with BYO context obects.}
+  spec.homepage      = "http://github.com/jonstokes/lasershark"
+  spec.license       = "MIT"
+
+  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 'interactor', '~> 3.1'
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/lasershark.rb

@@ -0,0 +1,33 @@
+require "interactor"
+require "lasershark/version"
+require "lasershark/common_context"
+require "lasershark/context_methods"
+
+module Lasershark
+  def self.included(base)
+    Interactor.class_eval do
+      def initialize(context = {})
+        @context = new_context(context)
+      end
+
+      def new_context(context)
+        if context_class
+          context_class.build(context)
+        elsif context.class.respond_to?(:build)
+          context.class.build(context)
+        else
+          Interactor::Context.build(context)
+        end
+      end
+
+      def context_class
+        self.class.context_class
+      end
+    end
+
+    base.class_eval do
+      include Interactor
+      extend ContextMethods
+    end
+  end
+end

data/lib/lasershark/common_context.rb

@@ -0,0 +1,158 @@
+module Lasershark
+  module CommonContext
+    module ClassMethods
+      # Internal: Initialize an Interactor::Context or preserve an existing one.
+      # If the argument given is an Interactor::Context, the argument is returned.
+      # Otherwise, a new Interactor::Context is initialized from the provided
+      # hash.
+      #
+      # The "build" method is used during interactor initialization.
+      #
+      # context - A Hash whose key/value pairs are used in initializing a new
+      #           Interactor::Context object. If an existing Interactor::Context
+      #           is given, it is simply returned. (default: {})
+      #
+      # Examples
+      #
+      #   context = Interactor::Context.build(foo: "bar")
+      #   # => #<Interactor::Context foo="bar">
+      #   context.object_id
+      #   # => 2170969340
+      #   context = Interactor::Context.build(context)
+      #   # => #<Interactor::Context foo="bar">
+      #   context.object_id
+      #   # => 2170969340
+      #
+      # Returns the Interactor::Context.
+      def build(context = {})
+        self === context ? context : new(context)
+      end
+    end
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    # Public: Whether the Interactor::Context is successful. By default, a new
+    # context is successful and only changes when explicitly failed.
+    #
+    # The "success?" method is the inverse of the "failure?" method.
+    #
+    # Examples
+    #
+    #   context = Interactor::Context.new
+    #   # => #<Interactor::Context>
+    #   context.success?
+    #   # => true
+    #   context.fail!
+    #   # => Interactor::Failure: #<Interactor::Context>
+    #   context.success?
+    #   # => false
+    #
+    # Returns true by default or false if failed.
+    def success?
+      !failure?
+    end
+
+    # Public: Whether the Interactor::Context has failed. By default, a new
+    # context is successful and only changes when explicitly failed.
+    #
+    # The "failure?" method is the inverse of the "success?" method.
+    #
+    # Examples
+    #
+    #   context = Interactor::Context.new
+    #   # => #<Interactor::Context>
+    #   context.failure?
+    #   # => false
+    #   context.fail!
+    #   # => Interactor::Failure: #<Interactor::Context>
+    #   context.failure?
+    #   # => true
+    #
+    # Returns false by default or true if failed.
+    def failure?
+      @failure || false
+    end
+
+    # Public: Fail the Interactor::Context. Failing a context raises an error
+    # that may be rescued by the calling interactor. The context is also flagged
+    # as having failed.
+    #
+    # Optionally the caller may provide a hash of key/value pairs to be merged
+    # into the context before failure.
+    #
+    # context - A Hash whose key/value pairs are merged into the existing
+    #           Interactor::Context instance. (default: {})
+    #
+    # Examples
+    #
+    #   context = Interactor::Context.new
+    #   # => #<Interactor::Context>
+    #   context.fail!
+    #   # => Interactor::Failure: #<Interactor::Context>
+    #   context.fail! rescue false
+    #   # => false
+    #   context.fail!(foo: "baz")
+    #   # => Interactor::Failure: #<Interactor::Context foo="baz">
+    #
+    # Raises Interactor::Failure initialized with the Interactor::Context.
+    def fail!(context = {})
+      modifiable.update(context)
+      @failure = true
+      raise Interactor::Failure, self
+    end
+
+    # Internal: Track that an Interactor has been called. The "called!" method
+    # is used by the interactor being invoked with this context. After an
+    # interactor is successfully called, the interactor instance is tracked in
+    # the context for the purpose of potential future rollback.
+    #
+    # interactor - An Interactor instance that has been successfully called.
+    #
+    # Returns nothing.
+    def called!(interactor)
+      _called << interactor
+    end
+
+    # Public: Roll back the Interactor::Context. Any interactors to which this
+    # context has been passed and which have been successfully called are asked
+    # to roll themselves back by invoking their "rollback" instance methods.
+    #
+    # Examples
+    #
+    #   context = MyInteractor.call(foo: "bar")
+    #   # => #<Interactor::Context foo="baz">
+    #   context.rollback!
+    #   # => true
+    #   context
+    #   # => #<Interactor::Context foo="bar">
+    #
+    # Returns true if rolled back successfully or false if already rolled back.
+    def rollback!
+      return false if @rolled_back
+      _called.reverse_each(&:rollback)
+      @rolled_back = true
+    end
+
+    # Internal: An Array of successfully called Interactor instances invoked
+    # against this Interactor::Context instance.
+    #
+    # Examples
+    #
+    #   context = Interactor::Context.new
+    #   # => #<Interactor::Context>
+    #   context._called
+    #   # => []
+    #
+    #   context = MyInteractor.call(foo: "bar")
+    #   # => #<Interactor::Context foo="baz">
+    #   context._called
+    #   # => [#<MyInteractor @context=#<Interactor::Context foo="baz">>]
+    #
+    # Returns an Array of Interactor instances or an empty Array.
+    def _called
+      @called ||= []
+    end
+  end
+end

data/lib/lasershark/context_methods.rb

@@ -0,0 +1,11 @@
+module Lasershark
+  module ContextMethods
+    def context_with(klass)
+      @context_class = klass
+    end
+
+    def context_class
+      @context_class
+    end
+  end
+end

data/lib/lasershark/version.rb

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

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: lasershark
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jon Stokes
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: interactor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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'
+description: 
+email:
+- jon@jonstokes.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lasershark.gemspec
+- lib/lasershark.rb
+- lib/lasershark/common_context.rb
+- lib/lasershark/context_methods.rb
+- lib/lasershark/version.rb
+homepage: http://github.com/jonstokes/lasershark
+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.12
+signing_key: 
+specification_version: 4
+summary: The interactor gem with BYO context obects.
+test_files: []