concierge 0.1

data/README

@@ -0,0 +1,13 @@
+Concierge
+=========
+
+Introduction goes here.
+
+
+Example
+=======
+
+Example goes here.
+
+
+Copyright (c) 2007 [name of plugin creator], released under the MIT license

data/lib/concierge.rb

@@ -0,0 +1,23 @@
+require 'ostruct'
+require 'rubygems'
+require 'active_support'
+
+require 'concierge/registry'
+require 'concierge/loader'
+require 'concierge/provider'
+require 'concierge/consumer'
+
+
+module CodeRhythm #:nodoc
+  module Concierge #:nodoc
+    def self.included(base)
+      raise "Please don't include CodeRhythm::Concierge directly, choose the Provider or Consumer interface."
+    end
+    
+    class MissingServiceError < RuntimeError
+      def initialize(service_name)
+        super "Sorry, couldn't load a service called #{service_name.to_s}."
+      end
+    end
+  end
+end

data/lib/concierge/consumer.rb

@@ -0,0 +1,24 @@
+module CodeRhythm
+  module Concierge
+    module Consumer
+      class << self
+        def included(base)
+          base.extend ClassMethods
+        end
+      end
+
+      module ClassMethods
+        def consumes_service(service_name)
+          require_service! service_name
+          define_method service_name do
+            CodeRhythm::Concierge::Provider.registry[service_name]
+          end
+        end
+
+        def require_service!(service_name)
+          CodeRhythm::Concierge::Provider.require_service! service_name
+        end
+      end
+    end
+  end
+end

data/lib/concierge/loader.rb

@@ -0,0 +1,29 @@
+module CodeRhythm
+  module Concierge
+    class Loader
+      cattr_reader :config
+      @@config = OpenStruct.new
+
+      def self.configure(&block)
+        block.call config if block
+      end
+
+      def load!(service_name)
+        begin
+          Dependencies.depend_on service_name.to_s
+        rescue MissingSourceFile
+          raise MissingServiceError.new(service_name.to_s)
+        end
+      end
+      
+      def load_config(service_name)
+        config_path = "#{config.service_config_path}/#{service_name}.yml"
+        if File.exists?(config_path)
+          File.open(config_path) do |f|
+            OpenStruct.new(YAML::load(f)[config.env])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/concierge/provider.rb

@@ -0,0 +1,28 @@
+module CodeRhythm
+  module Concierge
+    class Provider
+      cattr_reader :loader
+      @@loader = Loader.new
+      
+      cattr_reader :registry
+      @@registry = Registry.new
+      
+      class_inheritable_accessor :config
+      
+      class << self
+        def provides_service(service_name)
+          registry[service_name] = self
+          self.config = loader.load_config(service_name) || OpenStruct.new
+        end
+        
+        def require_service!(service_name)
+          loader.load!(service_name) unless registry.has_a?(service_name)
+        end
+      end
+      
+      def config
+        self.class.config
+      end
+    end
+  end
+end

data/lib/concierge/registry.rb

@@ -0,0 +1,30 @@
+module CodeRhythm
+  module Concierge
+    class Registry
+      def initialize
+        @services_to_providers = {}
+      end
+      
+      def clear
+        @services_to_providers.clear
+      end
+      
+      def has_a?(service_name)
+        @services_to_providers[service_name] != nil
+      end
+      alias :have_a? :has_a?
+      
+      def size
+        @services_to_providers.size
+      end
+
+      def []=(service_name, provider_class)
+        @services_to_providers[service_name] = provider_class.send(:new)
+      end
+      
+      def [](service_name)
+        @services_to_providers[service_name]
+      end
+    end
+  end
+end

data/lib/concierge/test_helper.rb

@@ -0,0 +1,46 @@
+module CodeRhythm
+  module Concierge
+    module TestHelper
+      class << self
+        def included(base)
+          base.send(:include, InstanceMethods)
+          base.send(:alias_method, :run_without_concierge_goodness, :run)
+          base.send(:alias_method, :run, :run_with_concierge_goodness)
+        end
+      end
+      
+      CodeRhythm::Concierge::Provider.registry.instance_variable_set '@stubs', {}
+      class << CodeRhythm::Concierge::Provider.registry
+        def []=(service_name, provider_class)
+          provider_class == Stub ? @stubs[:service_name] = provider_class.new : super
+        end
+        
+        def [](service_name)
+          @stubs[:service_name] || super
+        end
+      end
+
+      module InstanceMethods
+        def run_with_concierge_goodness(result, &block)
+          begin
+            run_without_concierge_goodness(result) do |channel, value|
+              block.call channel, value
+            end
+          ensure
+            CodeRhythm::Concierge::Provider.registry.instance_variable_get('@stubs').clear
+          end
+        end
+        
+        def stub_service(service_name)
+          CodeRhythm::Concierge::Provider.registry[service_name] = CodeRhythm::Concierge::TestHelper::Stub
+        end
+      end
+
+      class Stub
+        def method_missing(method, *args)
+          # This is the bit bucket
+        end
+      end
+    end
+  end
+end

data/test/unit/consumer_test.rb

@@ -0,0 +1,21 @@
+require "#{File.dirname(__FILE__)}/../test_helper"
+
+class ConsumerTest < Test::Unit::TestCase
+  def setup
+    @guest = ShamGuest.new
+  end
+  
+  def test_injection
+    assert_nothing_raised do
+      @guest.ruby_museum_guide_service.show_matz_portrait
+    end
+  end
+  
+  def test_cant_include_concierge_directly
+    assert_raises(RuntimeError) do
+      Class.new do
+        include CodeRhythm::Concierge
+      end
+    end
+  end
+end

data/test/unit/provider_test.rb

@@ -0,0 +1,50 @@
+require "#{File.dirname(__FILE__)}/../test_helper"
+
+class ProviderTest < Test::Unit::TestCase
+  def setup
+    @registry = CodeRhythm::Concierge::Provider.registry
+  end
+  
+  def test_configuration
+    ShamGuest.send :consumes_service, :greeter
+    assert_equal "howdy", ShamGuest.new.greeter.greet
+  end
+  
+  def test_duplicate_registration
+    assert @registry[:ruby_museum_guide_service].is_a?(RubyMuseumGuideService)
+  end
+
+  def test_registration
+    assert @registry.has_a?(:ruby_museum_guide_service)
+  end
+  
+  def test_discovery
+    assert_difference @registry, :size do
+      ShamGuest.send :consumes_service, :hiding_on_the_disk
+    end
+  end
+  
+  def test_discovery_service_doesnt_exist
+    assert_raises(CodeRhythm::Concierge::MissingServiceError) do
+      ShamGuest.send :consumes_service, :java_training
+    end
+  end
+  
+  def test_discovery_namespaced
+    assert_difference @registry, :size do
+      ShamGuest.send :consumes_service, 'example/modular'
+    end
+  end
+  
+  def test_provider_gets_config_instance_method
+    ShamGuest.send :consumes_service, :greeter
+    assert @registry[:greeter].method(:config)
+  end
+  
+  def test_unloading
+    greeter_before = Greeter.new
+    Dependencies.clear
+    greeter_after  = Greeter.new
+    assert_not_same greeter_before, greeter_after
+  end
+end

data/test/unit/test_helper_test.rb

@@ -0,0 +1,16 @@
+require "#{File.dirname(__FILE__)}/../test_helper"
+
+class ConciergeTest < Test::Unit::TestCase
+  def setup
+    @guest = ShamGuest.new
+    @registry = CodeRhythm::Concierge::Provider.registry
+  end
+  
+  def test_stub_service
+    test = ShamTest.new('test_truth')
+    test.setup
+    assert @guest.ruby_museum_guide_service.is_a?(CodeRhythm::Concierge::TestHelper::Stub)
+    test.run(Test::Unit::TestResult.new) {}
+    assert !@guest.ruby_museum_guide_service.is_a?(CodeRhythm::Concierge::TestHelper::Stub)
+  end
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.0
+specification_version: 1
+name: concierge
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+date: 2007-06-16 00:00:00 -04:00
+summary: Concierge is a minimal service discovery and configuration framework.
+require_paths: 
+- lib
+email: chris@coderhythm.com
+homepage: http://concierge.rubyforge.org
+rubyforge_project: 
+description: 
+autorequire: concierge
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Chris O'Meara
+files: 
+- lib/concierge
+- lib/concierge/consumer.rb
+- lib/concierge/loader.rb
+- lib/concierge/provider.rb
+- lib/concierge/registry.rb
+- lib/concierge/test_helper.rb
+- lib/concierge.rb
+- README
+test_files: 
+- test/unit/consumer_test.rb
+- test/unit/provider_test.rb
+- test/unit/test_helper_test.rb
+rdoc_options: []
+
+extra_rdoc_files: 
+- README
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+