absinthe 0.0.2 → 0.0.3

data/CHANGELOG.md

@@ -0,0 +1,25 @@
+# Changelog
+
+Breaking changes, bugfixes, and new features for each release are summarized here.
+For full details, please consult the SCM changelog.
+
+## v0.0.3
+ * Breaking change: Moved require_dir from :namespace to :source_loader.
+ * Breaking change: Plugins are now loaded into the injected module.
+   This will break any load path manipulation or lazy require usage.
+ * Breaking change: The block passed to boot is now evaluated directly
+   against the context, rather then the provided object or main.
+ * Add support for registering run blocks which will run against the
+   provided object or main.
+ * Add the beginnings of a test suite.
+ * Add supporting documents to gem build.
+ * Add the plugin_injector plugin, which creates proxy classes
+   for all registered plugins on the root namespace. For example,
+   the context plugin instance will be available through the Context
+   class in the namespace.
+
+## v0.0.2
+ * Fixed gemspec.
+
+## v0.0.1
+ * First release, yanked due to invalid gemspec.

data/LICENCE

@@ -0,0 +1,9 @@
+Copyright (c) 2013, Lance Cooper <lance.m.cooper@gmail.com>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+Neither the name of the Absinthe Project nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,15 @@
+# Absinthe
+
+Absinthe is a lightweight IoC container for Ruby applications.
+
+## Philosophy
+
+Absinthe is designed around the premise that all metaprogramming in a Ruby application must be done via IoC if it is to be reliable, performant, or testable.
+
+## Status
+
+The project is currently experimental and should not be used for production applications.
+
+## Licence
+
+The 'new' or '3 clause' BSD licence, see LICENCE for details.

data/lib/absinthe.rb

@@ -1,7 +1,18 @@
 module Absinthe
   $:.unshift(File.expand_path(File.join(File.dirname(__FILE__), 'absinthe')))
-  require 'dsl'
   require 'distillery'
 
-  extend Dsl
+  def boot! boot_file, calling_context = nil, &block
+    injector = Distillery.injector
+    injector.register :app_root, File.expand_path(File.dirname(boot_file))
+    injector.register :calling_context, calling_context
+    injector.register :boot_proc, block
+    injector.inject(:plugin).tap do |plugin|
+      plugin.load :context
+      plugin.boot!
+    end
+    injector.inject(:context)
+  end
+
+  extend self
 end

data/lib/absinthe/distillery.rb

@@ -1,28 +1,23 @@
 module Absinthe
-  module Plugins; end
-
   class Exception < ::Exception; end
 
   module Distillery
-    require 'distillery/context'
+    require 'distillery/injector'
+    require 'distillery/root_namespace'
     require 'distillery/source_loader'
+    require 'distillery/plugin'
 
-    class Warehouse
-      attr_reader :root_context
-      def initialize main_object
-        raise "Warehouse init failure!" if main_object.nil?
-        @root_context = Context.new
-        root_context.register :namespace, RootNamespace.new(main_object)
-        root_context.register :source_loader, SourceLoader
+    def self.injector
+      Injector.new.tap do |injector|
+        injector.register :main_object, @main_object
+        injector.register :namespace, RootNamespace, :main_object
+        injector.register :source_loader, SourceLoader, :app_root, :namespace
+        injector.register :plugin, Plugin, :injector, :namespace, :source_loader
       end
     end
 
-    def self.root_context
-      @warehouse.root_context
-    end
-
     def self.configure main_object
-      @warehouse = Warehouse.new(main_object)
+      @main_object = main_object
     end
   end
 end

data/lib/absinthe/distillery/injector.rb

@@ -0,0 +1,30 @@
+module Absinthe
+  module Distillery
+    class Injector
+      attr_reader :service_names
+
+      def initialize
+        @parameters = { }
+        @args = { }
+        @service_names = []
+        register :injector, self
+      end
+
+      def register name, clazz, *args
+        @parameters[name] = clazz
+        if @parameters[name].is_a?(Class)
+          @args[name] = args
+          @service_names << name # we lack ordered hash traversal on 1.8.
+        end
+      end
+
+      def inject name
+        return @parameters[name] unless @parameters[name].is_a?(Class)
+        injections = @args[name].map do |injection|
+          injection.is_a?(Symbol) ? inject(injection) : injection
+        end
+        @parameters[name] = @parameters[name].new(*injections)
+      end
+    end
+  end
+end

data/lib/absinthe/distillery/plugin.rb

@@ -0,0 +1,35 @@
+module Absinthe
+  module Plugins; end
+
+  module Distillery
+    class Plugin
+      class NotLoaded < Exception; end
+
+      attr_reader :injector, :namespace, :names
+      def initialize injector, namespace, source_loader
+        @injector, @namespace, @source_loader = injector, namespace, source_loader
+        @names = []
+      end
+
+      def load name
+        @source_loader.require_dir :plugins, name
+
+        # HACK not like this!
+        mod = @namespace.root::Absinthe::Plugins
+        plugin_name = mod.constants.grep(/#{name.to_s.gsub('_', '')}/i).first
+        raise NotLoaded, "#{name} was not found in Absinthe::Plugins" unless plugin_name
+        plugin = mod.const_get plugin_name
+        plugin.register @injector if plugin.respond_to? :register
+        @names << name
+      end
+
+      def boot!
+        @names.map do |name|
+          @injector.inject(name)
+        end.reverse.each do |plugin|
+          plugin.boot! if plugin.respond_to?(:boot!)
+        end
+      end
+    end
+  end
+end

data/lib/absinthe/distillery/root_namespace.rb

@@ -0,0 +1,27 @@
+module Absinthe
+  module Distillery
+    class RootNamespace
+      class LoadFailed < Exception; end
+
+      attr_reader :root, :main
+      def initialize main
+        @main = main
+        @root = Module.new { extend self }
+        main.include root
+      end
+
+      def register name, value
+        @root.send(:define_method, name) { value }
+      end
+
+      def load_file file
+        begin
+          @root.send(:module_eval, file.read, file.path, 1)
+        rescue Exception => ex
+          puts "Failed to load #{file.path}: #{ex.message}"
+          raise LoadFailed, ex
+        end
+      end
+    end
+  end
+end

data/lib/absinthe/distillery/source_loader.rb

@@ -2,9 +2,10 @@ module Absinthe::Distillery
   class PluginNotFound < Exception; end
 
   class SourceLoader
-    def boot! ctx
-      if ctx[:app_root]
-        $LOAD_PATH.unshift(File.expand_path(File.join(ctx[:app_root], 'lib')))
+    def initialize app_root, namespace
+      @namespace = namespace
+      if app_root
+        $LOAD_PATH.unshift(File.expand_path(File.join(app_root, 'lib')))
       end
 
       @plugin_paths = []
@@ -16,32 +17,45 @@ module Absinthe::Distillery
       end
     end
 
-    def source_files root, paths
+    def require_dir root, *paths
       # TODO validate the root param
-      sources = []
-
       # TODO this is a mess
       paths.each do |path|
         plugin_sources = []
         @plugin_paths.each do |plugin_path|
           target = File.join plugin_path, "#{path}.rb"
-          if File.file? target
-            file = File.new target
-            plugin_sources << file
+          next unless File.file? target
 
-            support_dir = File.join plugin_path, path.to_s
-            if File.directory? support_dir
-              $LOAD_PATH.unshift support_dir
-            end
+          support_dir = File.join plugin_path, path.to_s
 
-            yield file
-            $LOAD_PATH.delete support_dir
+          with_hooked_require(support_dir) do
+            plugin_sources << target
+            @namespace.load_file File.new(target)
           end
         end
+
         if plugin_sources.empty?
           raise PluginNotFound, "No plugin named #{path} was found in #{@plugin_paths.join ', '}"
         end
       end
     end
+
+    private
+    def with_hooked_require support_dir
+      original_require = ::Kernel.method(:require)
+      namespace = @namespace
+      ::Kernel.send(:define_method, :require) do |filename|
+        target = File.join support_dir, "#{filename}.rb"
+        if File.file? target
+          namespace.load_file File.new(target)
+        else
+          original_require.call filename
+        end
+      end
+
+      yield
+    ensure
+      ::Kernel.send(:define_method, :require, &original_require)
+    end
   end
 end

data/lib/absinthe/plugins/context.rb

@@ -0,0 +1,55 @@
+module Absinthe
+  module Plugins
+    class Context
+      def self.register injector
+        injector.register :context, Context, :injector
+      end
+
+      def initialize injector
+        @injector = injector
+        @run_blocks = []
+        self[:namespace].register :context, self
+        instance_exec(&self[:boot_proc]) if self[:boot_proc]
+      end
+
+      def configure &block
+        self.instance_eval &block
+      end
+
+      def const name, value
+        @injector.register name, value
+      end
+
+      def register name, clazz, *args
+        @injector.register name, clazz, *args
+      end
+
+      def inject name
+        @injector.inject name
+      end
+
+      def [] name
+        inject name
+      end
+
+      def plugin! name
+        self[:plugin].load name
+      end
+
+      def run *args, &block
+        @run_blocks << {
+          :args => args,
+          :block => block
+        }
+      end
+
+      def boot!
+        boot_scope = (self[:calling_context] || self[:main_object])
+        @run_blocks.each do |run|
+          injections = run[:args].map(&method(:inject))
+          boot_scope.instance_exec(*injections, &run[:block])
+        end
+      end
+    end
+  end
+end

data/lib/absinthe/plugins/plugin_injector.rb

@@ -0,0 +1,25 @@
+module Absinthe::Plugins
+  class PluginInjector
+    def self.register injector
+      injector.register :plugin_injector, PluginInjector, :plugin
+    end
+
+    def initialize plugin
+      @plugin = plugin
+    end
+
+    def boot!
+      @plugin.names.each do |service_name|
+        service = @plugin.injector.inject(service_name)
+        proxy = Module.new { extend self }
+        proxy.send(:define_method, :method_missing) do |meth, *args, &block|
+          service.send meth, *args, &block
+        end
+
+        # TODO should be elsewhere.
+        clazz_name = service_name.to_s.split('_').map(&:capitalize!).join ''
+        @plugin.namespace.root.send :const_set, clazz_name, proxy
+      end
+    end
+  end
+end

data/lib/absinthe/version.rb

@@ -0,0 +1,3 @@
+module Absinthe
+  VERSION = '0.0.3'
+end

data/test/integration/test_absinthe_boot.rb

@@ -0,0 +1,20 @@
+require 'test_helper'
+
+class TestAbsintheBoot < Test::Unit::TestCase
+  def test_registers_constants_on_the_returned_context
+    context = Absinthe.boot!(__FILE__) {
+      const :foo, :bar
+    }
+    assert_equal :bar, context[:foo]
+  end
+
+  def test_calls_run_blocks_in_the_given_scope
+    calling_context = Object.new
+    Absinthe.boot!(__FILE__, calling_context) do
+      run do
+        @scope_var = 'set_on_scope'
+      end
+    end
+    assert_equal 'set_on_scope', calling_context.instance_variable_get(:@scope_var)
+  end
+end

data/test/integration/test_plugin_injector.rb

@@ -0,0 +1,30 @@
+require 'test_helper'
+
+class TestPluginInjector < Test::Unit::TestCase
+  class Foo
+    attr_reader :msg
+
+    def initialize msg
+      @msg = msg
+    end
+  end
+
+  def test_injector_is_available_in_run_blocks
+    Absinthe.boot!(__FILE__, self) do
+      plugin! :plugin_injector
+      run do
+        assert PluginInjector.class
+      end
+    end
+  end
+
+  def test_injected_plugins_are_proxied_on_the_namespace
+    context = Absinthe.boot!(__FILE__) do
+      register :baxter, Foo, 'hi!'
+      plugin! :plugin_injector
+    end
+
+    msg = context[:namespace].root::Context[:baxter].msg
+    assert_equal 'hi!', msg
+  end
+end

data/test/integration/test_root_context.rb

@@ -0,0 +1,21 @@
+require 'test_helper'
+
+TOPLEVEL = self
+class TestRootContext < Test::Unit::TestCase
+  def test_contexts_namespace_has_main
+    context = Absinthe.boot! __FILE__
+    assert_equal TOPLEVEL, context[:namespace].main
+  end
+
+  def test_context_injects_params_for_run_blocks
+    params = nil
+    Absinthe.boot!(__FILE__) do
+      const :a, 1
+      const :b, 2
+      run :a, :b, do |a, b|
+        params = [a, b]
+      end
+    end
+    assert_equal [1, 2], params
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'test/unit'
+require 'absinthe'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: absinthe
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-06 00:00:00.000000000 Z
+date: 2013-06-09 00:00:00.000000000Z
 dependencies: []
 description: Not yet suitable for production use!
 email: lance.m.cooper@gmail.com
@@ -17,11 +17,22 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/absinthe/distillery/context.rb
+- README.md
+- CHANGELOG.md
+- LICENCE
+- lib/absinthe/distillery/injector.rb
+- lib/absinthe/distillery/root_namespace.rb
 - lib/absinthe/distillery/source_loader.rb
-- lib/absinthe/dsl.rb
+- lib/absinthe/distillery/plugin.rb
 - lib/absinthe/distillery.rb
+- lib/absinthe/plugins/context.rb
+- lib/absinthe/plugins/plugin_injector.rb
+- lib/absinthe/version.rb
 - lib/absinthe.rb
+- test/integration/test_absinthe_boot.rb
+- test/integration/test_plugin_injector.rb
+- test/integration/test_root_context.rb
+- test/test_helper.rb
 homepage: https://github.com/deathwish/absinthe
 licenses:
 - bsd
@@ -43,7 +54,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Absinthe is an opinioned IoC container for Ruby.

data/lib/absinthe/distillery/context.rb

@@ -1,112 +0,0 @@
-module Absinthe
-  module Distillery
-    class RootNamespace
-      class LoadFailed < Exception; end
-
-      attr_reader :root, :main
-      def initialize main_object
-        @main = main_object
-        @plugins = []
-      end
-
-      def boot! ctx
-        @context = ctx
-        @root = Module.new { extend self }
-
-        # Import ourselves into the new namespace, and remove ourselves from main.
-        @root.const_set :Absinthe, ::Absinthe
-        Object.send :remove_const, :Absinthe
-
-        root.send(:define_method, :context) { ctx }
-        main.include root
-        (ctx[:calling_context] || main).instance_eval { 
-          ctx[:boot_proc].call ctx if ctx[:boot_proc]
-        }
-      end
-
-      def load_plugin name
-        require_dir :plugins, name
-
-        # HACK not like this!
-        plugin_name = Absinthe::Plugins.constants.grep(/#{name.to_s.gsub('_', '')}/i).first
-        plugin = Absinthe::Plugins.const_get plugin_name
-        plugin
-      end
-
-      def require_dir root, *paths
-        @context[:source_loader].source_files(root, paths) do |file|
-          eval_in_scope file
-        end
-      end
-
-      private
-      def eval_in_scope file
-        begin
-          @root.send(:module_eval, file.read, file.path, 1)
-        rescue Exception => ex
-          puts "Failed to load #{file.path}: #{ex.message}"
-          raise LoadFailed, ex
-        end
-      end
-    end
-
-    class Context
-      module Dsl
-        def configure &block
-          self.instance_eval &block
-        end
-
-        def const name, value
-          register name, value
-        end
-
-        def [] name, *args
-          inject name, *args
-        end
-      end
-      include Dsl
-
-      attr_reader :parameters, :args
-      def initialize
-        @parameters = { }
-        @args = { }
-      end
-
-      def boot!
-        inject(:namespace).boot! self
-      end
-
-      def register name, clazz, *args
-        @parameters[name] = clazz
-        @args[name] = args if @parameters[name].is_a?(Class)
-      end
-
-      def inject name, *args
-        return @parameters[name] unless @parameters[name].is_a?(Class)
-        injections = (@args[name] + args).map do |injection|
-          injection.is_a?(Symbol) ? inject(injection) : injection
-        end
-        @parameters[name].new(*injections).tap do |obj|
-          if obj.respond_to?(:boot!)
-            # anything responding to boot is treated as a singleton service.
-            @parameters[name] = obj
-            case obj.method(:boot!).arity
-            when 0
-              obj.boot!
-            when 1
-              obj.boot! self
-            else
-              raise "Invalid boot method for #{name}"
-            end
-          end
-        end
-      end
-
-      def plugin! name
-        plugin = inject(:namespace).load_plugin name
-        plugin.register self if plugin.respond_to? :register
-        inject name
-      end
-    end
-  end
-end

data/lib/absinthe/dsl.rb

@@ -1,12 +0,0 @@
-module Absinthe
-  module Dsl
-    def boot! boot_file, calling_context = nil, &block
-      Distillery.root_context.configure do
-        const :app_root, File.expand_path(File.dirname(boot_file))
-        const :calling_context, calling_context
-        const :boot_proc, block
-        boot!
-      end
-    end
-  end
-end