dinject 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0117d663baa4930c4d3fc4ecb07590964299de2d
-  data.tar.gz: 675365a6dd4ba61f0de0550c05c2c5c4c5bcc187
+  metadata.gz: e5bc520adef1400c6c9b692afaa744444f668eff
+  data.tar.gz: 1246aac81fe48c9a221bcf1ba80be349ab46845d
 SHA512:
-  metadata.gz: ce89a7c1e23f1c3e13378ff4c58e4cfe471eb41efa1980cb327ec0f50a983562d0c72f7e0f15d4d1c51b09b86f278beba98cd9863dacc32da61ff998ec542481
-  data.tar.gz: 8deff621d8903d14bff29c73e8902146c28568d1ed704f10c6725ab5fa2c68467a2dcbae15c728934721d1a831c2eea0760b6dd8e60dd9268c6df6e2d99c4a8c
+  metadata.gz: f4373378eb1d067367af16f05289d559110ea390c316608e1d169dd7e2663928ebc8be95ba1533592dfeba9f06fafadd4fe098a2246ce8a36bd36498754bda24
+  data.tar.gz: 6704057364f4e31098127bada5abae74c73493e5b3e399802ead2477afdef53715ba8e4610e6b38cc4cfc51b9cddacbb420e92ab7396b8d2cd0639cdf0b9dbd4

data/README.md

@@ -7,36 +7,39 @@ via the `injector` module.
 
 Add this line to your application's Gemfile:
 
-    gem 'inject'
+    gem 'dinject'
 
 And then execute:
 
     $ bundle
 
-Or install it yourself as:
+Or install it yourself with:
 
-    $ gem install inject
+    $ gem install dinject
 
 ## Usage
 
 Install the gem, then use it like this:
 
 ```ruby
-require 'inject'
+require 'dinject'
+
 # Create injector
 injector = Injector.new
+
 # same as injector.insert(:epoch, :setter, Time.now, before: :all)
 injector.epoch = Time.now
 
 # Add a rule for `ip_address` that queries ipecho.net if potential other methods fail
-# The `after: :all` ensures that this is only run if other rules fail
-injector.insert(:ip_address, :ipecho, -> { open("http://ipecho.net/plain").read }, after: :all)
+# The `after: :all` ensures that this is run last if all other rules fail to inject a non-nil value
+injector.insert(:ip_address, :ipecho, -> { require 'open-uri'; open("http://ipecho.net/plain").read }, after: :all)
 
 # Add another rule for `ip_address`.
 # We name this rule "ifconfig" as it calls that UNIX command to retrieve network information
-# from the system. We assume a call to `ifconfig` is faster than a HTTP request, so we prioritize
-# this over the :ipecho method.
-injector.insert(:ip_address, :ifconfig, -> { SomeModule.extract_ip(`ifconfig`) }, before: :ipecho)
+# from the system. We assume a call to `ifconfig` is faster than an HTTP request, so we prioritize
+# this over the :ipecho method. Note that the `before: :ipecho` here is redundant and could be
+# omitted since `ipecho` already specifies to be considered last.
+injector.insert(:ip_address, :ifconfig, -> { extract_ip_address(`ifconfig`) }, before: :ipecho)
 
 # We may also use a gem that does the job for us - presumably, it uses some native syscalls
 # and is the fastest method, so we give it the highest priority.
@@ -47,7 +50,7 @@ injector.insert(:ip_address, :some_gem, -> { require 'some_gem'; SomeGem.ip_addr
 # a RuleNotFound error will be raised.
 # Optional arguments (as in `|x, y = 42|`) have the same effect.
 # For optional arguments, you must use the key arguments (`|x, y: 42|`) introduced in Ruby 2.0
-# Note that rules that return `nil` will override those.
+# Note that rules will inject those, even with `nil`.
 injector.inject do |ip_address, epoch|
   puts "ip: #{ip_address}, epoch: #{epoch}"
 end
@@ -57,7 +60,60 @@ The injector works with a priority queue, so in the above example, it will try t
 the ip_address *lazily* using `some_gem`. If `SomeGem.ip_address` returned `nil`, the next
 rule `ifconfig` will be used and if that returns nil, a call to `ipecho.net` will be made via the
 `ipecho` rule. If all rules return `nil`, `nil` is returned. If no rules exist,
-`RuleNotFound` will be raised (or `NoMethodError` if called directly via e.g. `injector.ip_address`)
+`RuleNotFound` will be raised (or `NoMethodError` if called directly via e.g. `injector.ip_address`).
+
+Once a value is injected, it will be used for any consecutive calls (it will not be injected again).
+
+You can also define dependencies for rules. For a real world example,
+let's say you need an authentication token to make API calls to a web service,
+and you want to store this token locally for future invocations of your program.
+What you'd do naturally is look in the local file whether the token is already there,
+and if not, check for the environment variable SOME_WEB_SERVICE_TOKEN (or e.g. the CLI parameter),
+and if that's empty, invoke a login to said web service using the user credentials for which we
+have established multiple rules as well. Let's see it in action:
+
+```
+# injector that already has rules/values for "token_file" and "cli_params" 
+
+injector.insert(:token, :file, -> (token_file) do
+  extract_token_from(token_file.read)
+end, before: :all)
+
+injector.insert(:token, :cli, -> (cli_params) do
+  cli_params[:web_service_token]
+end, after: :file)
+
+injector.insert(:token, :env, -> do
+  ENV["SOME_WEB_SERVICE_TOKEN"]
+end, after: :cli)
+
+injector.insert(:token, :login, -> (username, password) do
+  SomeWebService.login(username, password).token
+end, after: :all)
+
+injector.insert(:username, :cli_params -> (cli_params) do
+  cli_params[:username]
+end, before: :all)
+
+injector.insert(:username, :prompt, -> do
+  $stdout.print "(someweb.service) Username: "
+  $stdin.gets.chomp
+end, after: :all)
+
+injector.insert(:password, :cli_params -> (cli_params) do
+  cli_params[:password]
+end, before: :all)
+
+injector.insert(:password, :prompt, -> do
+  require 'io/console'
+  begin
+    $stdout.print "(someweb.service) Password: "
+    $stdin.noecho(&:gets).chomp
+  ensure puts
+  end
+end, after: :all)
+```
+
 
 ## Contributing
 

data/inject.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["cydrop@gmail.com"]
   spec.summary       = %q{Inject objects into variables by name or symbol}
   spec.description   = %q{Inspired by angular's inject, with addition of rules and flexibility.}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/muja/inject.rb"
   spec.licenses      = ["MIT"]
 
   spec.files         = `git ls-files`.split($/)

data/lib/dinject.rb

@@ -0,0 +1 @@
+require 'inject'

data/lib/inject/version.rb

@@ -1,3 +1,3 @@
 module Inject
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/injector.rb

@@ -56,7 +56,6 @@ class Injector
       result = overrides.fetch(index) do
         # then fetch by value
         overrides.fetch(value) do
-          puts type
           # Unfortunately, optional arguments are not possible, as
           # a Ruby block passed to `inject` will have exclusively optional arguments.
           # Instead, key arguments introduced in Ruby 2.0 should be used.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dinject
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Danyel Bayraktar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-29 00:00:00.000000000 Z
+date: 2017-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pqueue
@@ -37,11 +37,12 @@ files:
 - README.md
 - Rakefile
 - inject.gemspec
+- lib/dinject.rb
 - lib/inject.rb
 - lib/inject/rule.rb
 - lib/inject/version.rb
 - lib/injector.rb
-homepage: ''
+homepage: https://github.com/muja/inject.rb
 licenses:
 - MIT
 metadata: {}
@@ -61,7 +62,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Inject objects into variables by name or symbol