resolvable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 307c63c5b3b354142cdc7357958cbb7268cd0522
+  data.tar.gz: 773f2db4f3bdeb1e1c1a97042421f41f1d3f8d66
+SHA512:
+  metadata.gz: d0d387d58d08f9a0ffc29c9c068755cf76dc0e83f6dea90328cee7da45e33e1da9f73f1b32ea51296e99126912f239684025abd8499d50db270b330331db370a
+  data.tar.gz: 66d33d70eaf0d1c26150325fdaca09be7cf635d7940fc31ee83e195de74bc137d562a86b7551aea7b9c1dc134ceebcc3cd17833fe58909d453b73f9ee497fc08

data/.gitignore

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

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2-head

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.4
+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 alechipshear@gmail.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 resolvable.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Alec Hipshear
+
+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,95 @@
+# Resolvable
+
+Resolve your successful and failed actions.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'resolvable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install resolvable
+
+## Usage
+
+```ruby
+class SendDelicateMessage
+  include Resolvable
+
+  def perform_the_delicate_send!
+    begin
+      perform_the_delicate_send
+      success!
+    rescue => e
+      failure!
+    end
+  end
+end
+
+delicate_sender = SendDelicateMessage.new
+delicate_sender.perform_the_delicate_send!
+
+if delicate_sender.success?
+  # yay
+else
+  # boo
+end
+```
+
+### OpenStructShim
+
+Maybe you have a lot of open structs hanging around in your codebase, and you want to start to migrate those:
+
+```ruby
+class DelicateResult < Resolvable::OpenStructShim; end
+
+begin
+  perform_the_delicate_send
+  return DelicateResult.new(:success? => true)
+rescue => e
+  return DelicateResult.new(:success? => false, :important_context => "It failed")
+end
+```
+
+Or maybe you already subclassed OpenStruct in a weird and interesting way, and you want to migrate those, too:
+
+```ruby
+class Success < Resolvable::OpenStructShim
+  automatic :success!
+end
+
+class Failure < Resolvable::OpenStructShim
+  automatic :failure!
+end
+
+begin
+  perform_the_delicate_send
+  return Success.new(:important_context => "It worked")
+rescue => e
+  return Failure.new(:important_context => "It failed")
+end
+
+```
+## 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/xionon/resolvable. 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/bin/console

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

@@ -0,0 +1,62 @@
+require "resolvable/version"
+require "resolvable/open_struct_shim"
+
+module Resolvable
+  class DoubleSuccessError < StandardError; end
+  class FailureAfterSuccessError < StandardError; end
+  class SuccessAfterFailureError < StandardError; end
+
+  module ClassMethods
+    def default_failure_message
+    "Failed to resolve #{self.name}"
+    end
+  end
+
+  def self.included(klass)
+    klass.extend(Resolvable::ClassMethods)
+  end
+
+  def success!
+    raise SuccessAfterFailureError.new if(failure?)
+    raise DoubleSuccessError.new if(success?)
+
+    resolve(:success)
+
+    self
+  end
+
+  def failure!(message = nil)
+    raise FailureAfterSuccessError.new if(success?)
+
+    resolve(:failure)
+    add_error(message || self.class.default_failure_message)
+
+    self
+  end
+
+  def success?
+    resolution == :success
+  end
+
+  def failure?
+    resolution == :failure
+  end
+
+  def errors
+    @errors ||= []
+  end
+
+  private
+
+  def add_error(message)
+    errors << message
+  end
+
+  def resolution
+    @resolution
+  end
+
+  def resolve(resolve_into_state=:success)
+    @resolution = resolve_into_state
+  end
+end

data/lib/resolvable/open_struct_shim.rb

@@ -0,0 +1,24 @@
+require 'ostruct'
+
+module Resolvable
+  class OpenStructShim < OpenStruct
+    include Resolvable
+    def self.default_failure_message
+      "Failed to resolve #{self.name}"
+    end
+
+    attr_writer :kernel
+
+    def method_missing(method_name, *args)
+      file, line, method_info = caller(1, 1)[0].split(":")
+
+      kernel.warn "Missing method called on OpenStructShim: #{method_name} is not defined on #{self.class.name} (Called from #{file}##{line} in #{method_info}"
+
+      super
+    end
+
+    def kernel
+      @kernel ||= Kernel
+    end
+  end
+end

data/lib/resolvable/version.rb

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

data/resolvable.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'resolvable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "resolvable"
+  spec.version       = Resolvable::VERSION
+  spec.authors       = ["Alec Hipshear"]
+  spec.email         = ["alechipshear@gmail.com"]
+
+  spec.summary       = %q{Resolve tasks consistently}
+  spec.homepage      = "https://github.com/xionon/resolvable"
+  spec.license       = "MIT"
+
+  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_development_dependency "bundler", "~> 1.11"
+  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: resolvable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alec Hipshear
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-15 00:00:00.000000000 Z
+dependencies:
+- !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'
+description: 
+email:
+- alechipshear@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/resolvable.rb
+- lib/resolvable/open_struct_shim.rb
+- lib/resolvable/version.rb
+- resolvable.gemspec
+homepage: https://github.com/xionon/resolvable
+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.1
+signing_key: 
+specification_version: 4
+summary: Resolve tasks consistently
+test_files: []