dependency_bundle 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 44823d9bfdaf9b6c44a0608b7a13a0f6fcdec235adfa462b236c692c0727b99c
+  data.tar.gz: c827b37f403b10835d2904fbd8c975452a2abca50232c799fa8ac8c59131730f
+SHA512:
+  metadata.gz: bee3954383ada6a2ec98b411e0cab0a761fe6b15ce01b2aa3adade10e54f20409e2903f60ab7e719ac652609f8005567ee23e358aeb9e931b1767a4d601987dc
+  data.tar.gz: 59ce7706fe7103af008f9c53e9cdd68da1ea7280dcc8d3501b149ea0b01268e9013b17d71623ae75f7a2a2ddee0fb9e036721b7cde4d6b6dbcb6727d7b40720d

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## RELEASE 0.1.0
+
+* FEATURE: It exists. See the README for instructions.

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 choffman@optoro.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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in dependency_bundle.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    dependency_bundle (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (9.1.0)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    docile (1.3.1)
+    git (1.5.0)
+    json (2.1.0)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.5.1)
+      byebug (~> 9.1)
+      pry (~> 0.10)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    structured_changelog (0.11.0)
+      git
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  dependency_bundle!
+  pry-byebug
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  simplecov
+  structured_changelog
+
+BUNDLED WITH
+   1.16.1

data/README.adoc

@@ -0,0 +1,222 @@
+= DependencyBundle
+:ext-relative: .adoc
+:source-highlighter: coderay
+:sectanchors:
+:linkattrs:
+:icons: font
+:toc: macro
+:toclevels: 3
+ifdef::env-github[]
+:tip-caption: :bulb:
+:note-caption: :information_source:
+:important-caption: :heavy_exclamation_mark:
+:caution-caption: :fire:
+:warning-caption: :warning:
+endif::[]
+
+https://badge.fury.io/rb/dependency_bundle[image:https://badge.fury.io/rb/dependency_bundle.png[Gem Version]]
+https://travis-ci.org/yarmiganosca/dependency_bundle[image:https://secure.travis-ci.org/yarmiganosca/dependency_bundle.png[Build Status]]
+https://coveralls.io/r/yarmiganosca/dependency_bundle[image:https://coveralls.io/repos/yarmiganosca/dependency_bundle/badge.png?branch=master[Test Coverage]]
+
+toc::[]
+
+== Overview
+
+DependencyBundle helps you write Dependency Injected code without a Global Dependency Registry or a Dependency Injection Framework, because:
+
+* Global Dependency Registries are bad for all the same reasons regular globals are bad (which we're trying to get away from with DI in the first place!).
+* Dependency Injection Frameworks aren't bad, but they are heavy, and aren't necessary in all situations where you want DI.
+
+Instead, DependencyBundle is a Depedency Registry that's designed to be injected. Using it is simple. Here's an a Dependency Bundle with just a logger:
+
+[source,ruby]
+----
+require 'dependency_bundle'
+
+deps = DependencyBundle.new do
+  set :logger, Logger.new(self.stdout) # self is the DependencyBundle instance
+                                       # by default, DependencyBundle instances come with:
+                                       #   :env    -> the ENV global
+                                       #   :stdin  -> the STDIN global
+                                       #   :stdout -> the STDOUT global
+                                       #   :stderr -> the STDERR global
+end
+----
+
+But building your entire codebase around it is even better.
+
+== Using DependencyBundle
+
+Let's say you've got a report that gets run every morning. It:
+
+. makes some HTTP API requests
+. does some math on the results of those requests
+. caches the result on a Memcache instance
+. emails the attendees of a standing morning meeting
+
+Assuming you don't need any dependencies for the computation itself, you've got these dependencies:
+
+* HTTP Client
+* Memcache Client
+* Mailer
+* Logger (not mentioned explicitly, but you always need one)
+
+So your bundle would look something like this:
+
+[source,ruby]
+----
+require 'dependency_bundle'
+
+deps = DependencyBundle.new do
+  set :logger, Logger.new(self.stdout)         # each DependencyBundle has stdout by default
+  set :mailer, Mailer(deps: self)              # which needs a logger
+  set :http_client, HTTPClient.new(deps: self) # also needs a logger
+  set :memcache_client, MemcacheClient.new(
+    host: "cache.example.com",                 # needs a host to connect to
+    deps: self                                 # needs a logger
+  )
+end
+----
+
+and your report class might look like this:
+
+[source,ruby]
+----
+class MorningMeetingReport
+  def initialize(deps:, date: Date.today.prev_day)
+    # One of DependencyBundle's best features is dependency verification.
+    # It allows us to:
+    #   * Discover during testing if we have unsatisfied class dependencies
+    #   * Document the dependencies of our classes
+    deps.verify_dependencies!(:logger, :http_client, :memcache_client, :mailer)
+
+    @deps = deps
+    @date = date
+  end
+
+  def generate
+    # collect data with @deps.http_client
+  end
+
+  def store
+    # cache report with @deps.memcache_client
+  end
+
+  def notify
+    # email attendees with @deps.mailer
+  end
+end
+----
+
+If you design entire programs this way,
+
+* adding new dependencies is easy
+* testing your code's response to failures is simple
+
+=== Testing with DependencyBundle
+
+Testing your code with Dependency Bundles is also easy! Build `DependencyBundle` instances in your setup steps, and instantiate your test subjects with them. As an example, if we use the above code and RSpec doubles, it'll look something like this:
+
+[source,ruby]
+----
+RSpec.describe MorningMeetingReport do
+  let(:deps) do
+    set :logger, Logger.new(StringIO.new)
+    set :mailer, instance_double('Mailer')
+    set :http_client, instance_double('HTTPClient')
+    set :memcache_client, instance_double('MemcacheClient')
+  end
+
+  context 'happy path' do
+    before do
+      allow(deps.http_client).to receive(:get).with(url).and_return(fixture)
+      allow(deps.memcache_client).to receive(:set).with(key, value).and_return(true)
+      allow(deps.mailer).to receive(:send_mail).and_return(true)
+    end
+
+    # ...
+  end
+
+  # ...
+end
+----
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+[source,ruby]
+----
+gem 'dependency_bundle'
+----
+
+And then execute:
+
+[subs=+macros]
+----
++++<span style="pointer-events:none;user-select:none;">$ </span>+++bundle install
+----
+
+Or install it yourself as:
+
+[subs=+macros]
+----
++++<span style="pointer-events:none;user-select:none;">$ </span>+++gem install dependency_bundle
+----
+
+== Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/yarmiganosca/dependency_bundle
+
+[IMPORTANT]
+.Code of Conduct
+====
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the http://contributor-covenant.org[Contributor Convenant] code of conduct.
+====
+
+=== 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`.
+
+=== Testing
+
+To run all the tests, run `bundle exec rspec`.
+
+=== Pull Requests
+
+Pull requests should be well-scoped and include tests appropriate to the changes.
+
+When submitting a pull request that changes user-facing behavior, add release note lines to the commit message body http://github.com/yarmiganosca/structured_changelog#with-multiple-contributors[like this]. You can preview your release lines by running
+
+[subs=+macros]
+----
++++<span style="pointer-events:none;user-select:none;">$ </span>+++bundle exec rake changelog:preview
+----
+
+=== Releases
+
+Releasing a new version is a 2-step process.
+
+First, run
+
+[subs=+macros]
+----
++++<span style="pointer-events:none;user-select:none;">$ </span>+++bundle exec rake changelog:compile
+----
+
+This will add a new release section before the other release sections. It will contain all the release notes in the commit messages since the last release, and will be prepopulated with the minimum possible version given those changes. Proof-read it and reorder the notes if you think doing so would be necessary or clearer. Feel free to increase the version if necessary (to force a major release, for example).
+
+Once you're satisfied, run
+
+[subs=+macros]
+----
++++<span style="pointer-events:none;user-select:none;">$ </span>+++bundle exec rake changelog:release
+----
+
+This will create a git tag for the version, push git commits and tags, and push the `.gem` file to https://rubygems.org[rubygems.org].
+
+== License
+
+The gem is available as open source under the terms of the https://opensource.org/licenses/MIT[MIT License].

data/Rakefile

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

data/bin/console

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

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "dependency_bundle/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "dependency_bundle"
+  spec.version       = DependencyBundle::VERSION
+  spec.authors       = ["Chris Hoffman"]
+  spec.email         = ["yarmiganosca@gmail.com"]
+
+  spec.summary       = %q{An Injectable Dependency Container implementation for Ruby}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/yarmiganosca/dependency_bundle"
+
+  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_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "structured_changelog"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "simplecov"
+end

data/lib/dependency_bundle.rb

@@ -0,0 +1,33 @@
+require "dependency_bundle/version"
+
+class DependencyBundle
+  DependencyNotProvided = Class.new(StandardError)
+  OverrideAttempted     = Class.new(StandardError)
+
+  def initialize(&blk)
+    set :env, ENV
+    set :stdin, STDIN
+    set :stdout, STDOUT
+    set :stderr, STDERR
+
+    instance_exec(&blk) if block_given?
+  end
+
+  def set(name, value)
+    if respond_to?(name)
+      raise(OverrideAttempted, "You can't override `:#{name}` on #{inspect}, since it already responds to `:#{name}`. If you're seeing this because you tried to override a dependency, please don't. DependencyBundle doesn't allow that because of the misery it would introduce into debugging (your logger or http client changing between constructors is just asking for trouble). If you didn't try to override a dependency, and there's just a pre-existing Ruby method that happens to be named the same as the key you're using, I'm sorry. Please register your dependency with a different key.")
+    else
+      define_singleton_method(name) { value }
+    end
+  end
+
+  def verify_dependencies!(*names)
+    raise(ArgumentError, "##{__method__} expects names of dependencies to be passed") if names.empty?
+
+    not_found_names = names.reject(&method(:respond_to?))
+
+    raise(DependencyNotProvided, "#{not_found_names} not set") if not_found_names.any?
+
+    true
+  end
+end

data/lib/dependency_bundle/version.rb

@@ -0,0 +1,3 @@
+class DependencyBundle
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: dependency_bundle
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Hoffman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-08 00:00:00.000000000 Z
+dependencies:
+- !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: '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'
+- !ruby/object:Gem::Dependency
+  name: structured_changelog
+  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: pry-byebug
+  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: simplecov
+  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'
+description: An Injectable Dependency Container implementation for Ruby
+email:
+- yarmiganosca@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- README.adoc
+- Rakefile
+- bin/console
+- bin/setup
+- dependency_bundle.gemspec
+- lib/dependency_bundle.rb
+- lib/dependency_bundle/version.rb
+homepage: https://github.com/yarmiganosca/dependency_bundle
+licenses: []
+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.7.6
+signing_key: 
+specification_version: 4
+summary: An Injectable Dependency Container implementation for Ruby
+test_files: []