dinject 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0117d663baa4930c4d3fc4ecb07590964299de2d
+  data.tar.gz: 675365a6dd4ba61f0de0550c05c2c5c4c5bcc187
+SHA512:
+  metadata.gz: ce89a7c1e23f1c3e13378ff4c58e4cfe471eb41efa1980cb327ec0f50a983562d0c72f7e0f15d4d1c51b09b86f278beba98cd9863dacc32da61ff998ec542481
+  data.tar.gz: 8deff621d8903d14bff29c73e8902146c28568d1ed704f10c6725ab5fa2c68467a2dcbae15c728934721d1a831c2eea0760b6dd8e60dd9268c6df6e2d99c4a8c

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in inject.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Danyel Bayraktar
+
+MIT License
+
+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,68 @@
+# Inject
+
+Inspired by angular's injection capabilities, this library provides some dependency injection
+via the `injector` module. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'inject'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install inject
+
+## Usage
+
+Install the gem, then use it like this:
+
+```ruby
+require 'inject'
+# 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)
+
+# 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)
+
+# 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.
+injector.insert(:ip_address, :some_gem, -> { require 'some_gem'; SomeGem.ip_address }, before: :all)
+
+# Use the variables. The arguments will be injected by name.
+# If any of the arguments associates with a non-existing rule,
+# 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.
+injector.inject do |ip_address, epoch|
+  puts "ip: #{ip_address}, epoch: #{epoch}"
+end
+```
+
+The injector works with a priority queue, so in the above example, it will try to retrieve 
+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`)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/inject.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'inject/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dinject"
+  spec.version       = Inject::VERSION
+  spec.authors       = ["Danyel Bayraktar"]
+  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.licenses      = ["MIT"]
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.0.0"
+  spec.add_dependency "pqueue", "~> 2.1"
+end

data/lib/inject.rb

@@ -0,0 +1,2 @@
+require 'inject/version'
+require 'injector'

data/lib/inject/rule.rb

@@ -0,0 +1,17 @@
+class Inject::Rule
+  attr_reader :key, :identifier, :value, :options
+
+  def initialize(key, identifier, value, **options)
+    @key = key
+    @identifier = identifier
+    @value = value
+    @options = options
+  end
+
+  def <=>(other)
+    # this one has before: :all or before: other
+    [other.identifier, :all].include?(self.options[:before]) ||
+      # other one has after: :all, or after: self
+      [self.identifier, :all].include?(other.options[:after])
+  end
+end

data/lib/inject/version.rb

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

data/lib/injector.rb

@@ -0,0 +1,141 @@
+require 'pqueue'
+require 'inject/rule'
+
+class Injector
+  class RuleNotFound < StandardError; end
+
+  def initialize(**params)
+    @rules = {}
+    @injected = {injector: self}
+    @callbacks = {}
+    params.each do |k, v|
+      set(k, v)
+    end
+  end
+
+  def get(key, overrides = {})
+    # (lazily) evaluate rule, then store it
+    @injected[key] ||= begin
+      arr = @rules[key]
+      if arr.nil?
+        raise RuleNotFound,
+          "No rule for #{key.inspect}. Available fields: #{@rules.keys.map(&:inspect).join(', ')}"
+      end
+      result = nil
+      arr.to_a.reverse.each do |rule|
+        rule.value.tap do |x|
+          # if it's a callable value, call that and return its result, else return itself
+          result = if x.is_a?(Proc) or x.is_a?(Method)
+            inject(overrides, &x)
+          else
+            x
+          end
+        end
+        unless result.nil?
+          fire(:after_fetch, key, result, rule.identifier)
+          break
+        end
+      end
+      result
+    end
+  end
+
+  def inject(overrides = {}, &block)
+    params = []
+    keys = {}
+    block.parameters.each_with_index do |(type, value), index|
+      raise(
+        ArgumentError,
+        [
+          "splash operator arguments are not permitted when injecting.",
+          ":#{value} in #{ block.source_location }"
+        ].join(" ")
+      ) if type == :rest or type == :keyrest
+
+      # fetch by index first! e.g. inject(0 => 40) { |x| x + 2 }
+      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.
+          if type == :key
+            begin self.get(value)
+            rescue RuleNotFound
+            end
+          else
+            self.get(value)
+          end
+        end
+      end
+      if type == :key
+        keys[value] = result
+      else
+        params << result
+      end
+    end
+
+    if keys.empty?
+      block.call(*params)
+    else
+      block.call(*params, keys)
+    end
+  end
+
+  def set(key, value)
+    insert(key, :setter, value, before: :all)
+  end
+
+  alias :[]  :get
+  alias :[]= :set
+
+  def when_fetched(key = nil, &block)
+    add_callback(:after_fetch, key, &block)
+  end
+
+  def insert(key, identifier = nil, block, **options)
+    insert_rule(Inject::Rule.new(key, identifier, block, **options))
+  end
+  alias_method :provide, :insert
+
+  def insert_rules(rules)
+    rules.each(&method(:insert_rule))
+  end
+
+  def insert_rule(rule)
+    (@rules[rule.key] ||= PQueue.new) << rule
+    define_singleton_method(rule.key) { get(rule.key) }
+  end
+
+  def invalidate(key, identifier = :all)
+    if queue = @rules[key]
+      new_queue = case identifier
+      when :all then []
+      else
+        queue.to_a.delete_if do |rule|
+          rule.identifier == identifier
+        end
+      end
+      queue.replace(new_queue)
+      true
+    end
+  end
+
+private
+  def add_callback(event, key, &block)
+    key ||= block.parameters.first.last
+    ((@callbacks[event] ||= {})[key] ||= []) << block
+  end
+
+  def fire(event, key, value, identifier)
+    @callbacks.fetch(event, {}).fetch(key, []).each do |block|
+      inject(method: identifier, 0 => value, &block)
+    end
+  end
+
+  def method_missing(method, *args)
+    super unless method.to_s.end_with? "="
+    self.set(method[0...-1].to_sym, *args)
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: dinject
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Danyel Bayraktar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pqueue
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: Inspired by angular's inject, with addition of rules and flexibility.
+email:
+- cydrop@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- inject.gemspec
+- lib/inject.rb
+- lib/inject/rule.rb
+- lib/inject/version.rb
+- lib/injector.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Inject objects into variables by name or symbol
+test_files: []