dependency_bundle 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44823d9bfdaf9b6c44a0608b7a13a0f6fcdec235adfa462b236c692c0727b99c
-  data.tar.gz: c827b37f403b10835d2904fbd8c975452a2abca50232c799fa8ac8c59131730f
+  metadata.gz: de42a0c02b932ffa098f92eaf23a15bcd76eb13bc36817f754df43c2c44f1fcf
+  data.tar.gz: 36a9cfaef6f2b7f4efe42ba2f748617df2bb875d1611929999deb440c4c23e33
 SHA512:
-  metadata.gz: bee3954383ada6a2ec98b411e0cab0a761fe6b15ce01b2aa3adade10e54f20409e2903f60ab7e719ac652609f8005567ee23e358aeb9e931b1767a4d601987dc
-  data.tar.gz: 59ce7706fe7103af008f9c53e9cdd68da1ea7280dcc8d3501b149ea0b01268e9013b17d71623ae75f7a2a2ddee0fb9e036721b7cde4d6b6dbcb6727d7b40720d
+  metadata.gz: ea5b4526704e0fb34d35c58f92f2b6c9fb12d76c8171f8ce237c7ecda5ef542f2d7e77a0576ea8e27eb268a7c1c3441e72d582af7c5c8e89aaff1c52baac9e5f
+  data.tar.gz: 609741c77cedad3362f990054770f611a1ae4d8e70242eb408ad5677f615b3e7a92c7fc6319cc0b61ba00674f7d96aa0b87a19b67bdbff400e059edfa906e8d5

data/.gitlab-ci.yml

@@ -0,0 +1,7 @@
+before_script:
+  - gem install bundler -v '< 2'
+  - bundle install
+
+rspec:
+  image: ruby:2.5.1
+  script: bundle exec rspec

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## RELEASE 1.0.0
+
+* BREAKING: Changed the `#initialize` and `#set` method signatures.
+
 ## RELEASE 0.1.0
 
 * FEATURE: It exists. See the README for instructions.

data/Gemfile

@@ -4,3 +4,5 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in dependency_bundle.gemspec
 gemspec
+
+gem 'coveralls', require: false

data/Gemfile.lock

@@ -1,13 +1,19 @@
 PATH
   remote: .
   specs:
-    dependency_bundle (0.1.0)
+    dependency_bundle (1.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     byebug (9.1.0)
     coderay (1.1.2)
+    coveralls (0.8.22)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.16.1)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.4)
+      tins (~> 1.6)
     diff-lcs (1.3)
     docile (1.3.1)
     git (1.5.0)
@@ -40,12 +46,17 @@ GEM
     simplecov-html (0.10.2)
     structured_changelog (0.11.0)
       git
+    term-ansicolor (1.7.0)
+      tins (~> 1.0)
+    thor (0.19.4)
+    tins (1.20.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 1.16)
+  coveralls
   dependency_bundle!
   pry-byebug
   rake (~> 10.0)
@@ -54,4 +65,4 @@ DEPENDENCIES
   structured_changelog
 
 BUNDLED WITH
-   1.16.1
+   1.17.3

data/README.adoc

@@ -5,6 +5,7 @@
 :linkattrs:
 :icons: font
 :toc: macro
+:toc-title:
 :toclevels: 3
 ifdef::env-github[]
 :tip-caption: :bulb:
@@ -14,9 +15,9 @@ ifdef::env-github[]
 :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]]
+image:https://badge.fury.io/rb/dependency_bundle.svg["Gem Version", link="https://badge.fury.io/rb/dependency_bundle"]
+image:https://travis-ci.org/yarmiganosca/dependency_bundle.svg?branch=master["Build Status", link="https://travis-ci.org/yarmiganosca/dependency_bundle"]
+image:https://coveralls.io/repos/github/yarmiganosca/dependency_bundle/badge.svg?branch=master["Test Coverage", link="https://coveralls.io/github/yarmiganosca/dependency_bundle?branch=master"]
 
 toc::[]
 
@@ -33,14 +34,14 @@ Instead, DependencyBundle is a Depedency Registry that's designed to be injected
 ----
 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
+deps = DependencyBundle.new
+# by default, DependencyBundle instances also come with:
+#   .env    -> the ENV global
+#   .stdin  -> the STDIN global
+#   .stdout -> the STDOUT global
+#   .stderr -> the STDERR global
+
+deps.set(logger: Logger.new(deps.stdout))
 ----
 
 But building your entire codebase around it is even better.
@@ -67,14 +68,17 @@ So your bundle would look something like this:
 ----
 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
+deps = DependencyBundle.new
+
+deps.set(logger: Logger.new(self.stdout))      # default DependencyBundle stdout
+deps.set(
+  mailer:          Mailer(deps: self)),         # Mailer needs a logger, so we inject deps into it
+  http_client:     HTTPClient.new(deps: self)), # the HTTPClient also needs a logger
+  memcache_client: MemcacheClient.new(          # MemcacheClient needs:
+    host: "cache.example.com",                  #   a host to connect to
+    deps: self                                  #   a logger, which we again get from our DependencyBundle
   )
+)
 end
 ----
 
@@ -121,10 +125,12 @@ Testing your code with Dependency Bundles is also easy! Build `DependencyBundle`
 ----
 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')
+    DependencyBundle.new(
+      logger: Logger.new(StringIO.new),
+      mailer: instance_double("Mailer"),
+      http_client: instance_double('HTTPClient'),
+      memcache_client: instance_double('MemcacheClient')
+    )
   end
 
   context 'happy path' do
@@ -182,7 +188,12 @@ To install this gem onto your local machine, run `bundle exec rake install`.
 
 === Testing
 
-To run all the tests, run `bundle exec rspec`.
+To run all the tests, run
+
+[subs=+macros]
+----
++++<span style="pointer-events:none;user-select:none;">$ </span>+++bundle exec rspec
+----
 
 === Pull Requests
 

data/lib/dependency_bundle.rb

@@ -4,20 +4,20 @@ 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?
+  def initialize(**dependencies)
+    set(
+      {
+        env:    ENV,
+        stdin:  STDIN,
+        stdout: STDOUT,
+        stderr: STDERR,
+      }.merge(**dependencies)
+    )
   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 }
+  def set(**dependencies)
+    dependencies.each do |name, dependency|
+      set_single_dependency(name, dependency)
     end
   end
 
@@ -30,4 +30,14 @@ class DependencyBundle
 
     true
   end
+
+  private
+
+  def set_single_dependency(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
 end

data/lib/dependency_bundle/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dependency_bundle
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Chris Hoffman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-08 00:00:00.000000000 Z
+date: 2019-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -102,6 +102,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".gitlab-ci.yml"
 - ".rspec"
 - ".travis.yml"
 - CHANGELOG.md