direct 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 27fe15c82f220ce786dad7ac7fc5104ed0b8a94c
+  data.tar.gz: 8f9d2316648c6c4b16d4780f9d4468237ce2583d
+SHA512:
+  metadata.gz: f3b80b10949809a4d16dec4b7be942cfb51ca80b80fdae3420bf9ee69ec84ab12d3770ce965fa45269b6e88f16f6dabf242a478aa254ff124c302f220394e8cc
+  data.tar.gz: 792b7bdf1ea01b24d42f8f28151cc46264efa84115a99f3219b31c494ecbfd9c3c93e848be073dcc7030357acfea47dcfe7161723a81f03cc93d43350728e8e7

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,27 @@
+sudo: false
+before_install:
+  - gem install bundler -v 1.16.1
+language: ruby
+cache: bundler
+rvm:
+  - 2.2.9
+  - 2.3.6
+  - 2.4.3
+  - 2.5.0
+  - ruby-head
+  - jruby-head
+env:
+  global:
+    - CC_TEST_REPORTER_ID=3c4cb48bcc4e29bb3292e99b7736c6dd7c13d0f6a908785e164d03666f5070cc
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rake
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

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 jim@saturnflyer.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 direct.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Jim Gay
+
+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,125 @@
+# Direct
+
+Tell your objects what to do when things work properly or when they fail.
+
+This allows you to encapsulate behavior inside the object. Avoid using `if`
+outside of your objects and just tell them what to do.
+
+## Usage
+
+```ruby
+class SomeClass
+  include Direct
+
+  def save
+    # do stuff
+    as_directed(:success, 'some', 'success', 'values')
+  rescue => e
+    as_directed(:failure, 'some', 'failure', e.message)
+  end
+end
+
+# Somewhere else
+
+SomeClass.new.direct(:success){|*data|
+  STDOUT.puts data
+}.direct(:failure){|*errors|
+  STDERR.puts errors
+}.save
+```
+
+## Why?
+
+You could easily write code that says `if` this `else` that.
+
+For example:
+
+```ruby
+if Something.new.save!
+  puts "yay!"
+else
+  puts "boo!"
+end
+```
+
+But eventually you may want more information about your successes and failures
+
+```ruby
+something = Something.new
+if something.save!
+  puts "yay! #{something}"
+else
+  puts "boo! #{something}: #{something.errors}"
+end
+```
+
+That's intially not so bad that you need to initialize the object separately 
+from the `if` expression. But when we discover a third or fourth scenario, then
+the code can become complicated:
+
+```ruby
+something = Something.new
+if something.save!
+  puts "yay! #{something}"
+elsif something.valid? && !something.persisted?
+  puts "it sort of worked"
+elseif !something.valid? || something.need_some_other_thing_set?
+  puts "an alternative to it not working"
+else
+  puts "boo! #{something}: #{something.errors}"
+end
+```
+
+It's just too easy to expand logic *and* knowledge about the internal state of
+the object with `if` and `else` and `elsif`.
+
+Instead, we can name these scenarios and allow the object to handle them; we
+merely provide the block of code to execute:
+
+```ruby
+Something.new.direct(:success){|the_object|
+  puts "yay! #{the_object}"
+}.direct(:failure){ |the_object, errors|
+  puts "boo! #{the_object}: #{errors}"
+}.direct(:other_scenario){|the_object|
+  puts "here's what happened and what to do..."
+}
+```
+
+_Inside_ of the object is where we can handle these named scenarios. If the
+meaning of `:success` or `:failure` or any other name changes, the object
+itself can handle it with no changes implicitly required in the calling code.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'direct'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install direct
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/saturnflyer/direct. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Direct project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/saturnflyer/direct/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

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

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "direct/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "direct"
+  spec.version       = Direct::VERSION
+  spec.authors       = ["Jim Gay"]
+  spec.email         = ["jim@saturnflyer.com"]
+
+  spec.summary       = %q{Direct objects to perform arbitrary blocks by name}
+  spec.description   = %q{Direct objects to perform arbitrary blocks by name}
+  spec.homepage      = "https://github.com/saturnflyer/direct"
+  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 "concurrent-ruby", ">= 1.0"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 12.3"
+  spec.add_development_dependency "minitest", "~> 5.11"
+end

data/lib/direct.rb

@@ -0,0 +1,53 @@
+require "direct/version"
+require "concurrent"
+
+# Include this module in your classes to provide a way for
+# your objects to handle named scenarios with blocks of code.
+module Direct
+  # Tell the object what to do in a given scenario.
+  #
+  # object.direct(:success){|obj| puts "it worked!" }
+  # object.direct(:failure){|obj| puts "it failed!" }
+  #
+  # You may also chain calls to this method
+  #
+  # object.direct(:success){ |obj| 
+  #   puts "it worked!"
+  # }.direct(:failure){ |obj|
+  #   puts "it failed!"
+  # }.do_it
+  # 
+  def direct(key, &block)
+    __direct_store(key, block)
+    self
+  end
+
+  # Perform the named block of code
+  #
+  # def do_it
+  #   # do things here
+  #   as_directed(:success, "success", "messages")
+  # rescue => e
+  #   as_directed(:failure, errors)
+  # end
+  #
+  # This will raise an error if the provided key is not found
+  def as_directed(key, *args)
+    __direct_store_fetch(key).each do |block|
+      block.call(self, *args)
+    end
+  end
+
+  private
+
+  def __direct_store(key, block)
+    @__direct_store ||= Concurrent::Map.new
+    @__direct_store.put_if_absent(key, Concurrent::Array.new)
+    @__direct_store.fetch(key) << block
+    @__direct_store
+  end
+
+  def __direct_store_fetch(key)
+    @__direct_store.fetch(key)
+  end
+end

data/lib/direct/version.rb

@@ -0,0 +1,3 @@
+module Direct
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: direct
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jim Gay
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+description: Direct objects to perform arbitrary blocks by name
+email:
+- jim@saturnflyer.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- direct.gemspec
+- lib/direct.rb
+- lib/direct/version.rb
+homepage: https://github.com/saturnflyer/direct
+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.5.2.2
+signing_key: 
+specification_version: 4
+summary: Direct objects to perform arbitrary blocks by name
+test_files: []