garcon 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 70e6459dde2b9a208c1fd89d5917e7818443d2e2
-  data.tar.gz: 739061b54a73366276729161eeb18288437d7a38
+  metadata.gz: 16b8e6f63d6d342e4670b5423de18da7f4facb14
+  data.tar.gz: c32746bb3ddb05071dd9c5ea586c071c95b3e8a3
 SHA512:
-  metadata.gz: bf265524c8e31f50f9b59cd4ddae995abe4b0b1f06ef3a8904e33554df4305c86e2253e5567ae8e420241cb8968ff3d51e4d4b0d7230cbefc11703d67bf1428e
-  data.tar.gz: 881113987fceac165fe1c8998bbadc26e6b5ec4264dcc31c0f81adf8532dd56d8fc021869903b77405fe30c0d9cf356ea6bd83613310764a30f90add097c1d23
+  metadata.gz: 3157455c1f221d7b703ecc7f63e52a436f6aacc638427a559edd79c6e002510b275336a6588c3f64164e7ab480e52dde1e34035dbfd9af8d6e14d1a515679e06
+  data.tar.gz: 700ce985f2bb2444477461e3151782f00cfb6be87a133d912ec7d88b06615168f80849320c31e718b2051d765c444d1ae48df22208b98f706c91105b686a6279

data/.ruby-version

@@ -0,0 +1 @@
+2.2.0

data/README.md

@@ -2,6 +2,31 @@
 
 Garcon is a simple Service Locator object.  
 
+Why?
+
+Dependencies, that's why.  
+
+Each object in your application has dependencies and related objects.
+
+For a good design, you need to know those dependencies and keep track of
+them.  
+
+For a flexible design it's useful to be able to switch those
+dependencies in and out.  
+
+So instead of hard-coding your dependencies or injecting them as a long
+trail of constructor parameters, use a service locator;
+register your services in the locator and tell it to fetch one for you
+when you need it.  
+
+Your dependency map becomes a list of services - :file_server,
+:email_server etc.  
+
+Your implementation can be switched out at a moment's notice without
+affecting anything else.  
+
+You can go home relaxed and have a nice cup of tea.  
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -26,20 +51,19 @@ services with it:
 ```ruby
 services = Garcon::ServiceLocator.new
 
-services.register(:file_server) { MyFileServer.new }
-services.register(:email_server) { MyEmailServer.new(configuration_details) }
-services.register(:hostname) { "mysite.example.com" }
+services.register(:file_server) { MyFileServer.new(services) }
+services.register(:path_finder) { MyPathFinder.new(services) }
 ```
 
 Then use this Service Locator to find your related objects, instead of
-having hard-coded constants.  
+having hard-coded constants.  For example, MyFileServer never needs to
+know how the Path Finder is implemented; it just needs to respond to #default.
 
 ```ruby
-class FileStorage < Struct.new(:services)
-  def store_file file
-    services[:file_server].store file, path: DEFAULT_PATH
+class MyFileServer < Struct.new(:services)
+  def store file
+    write file: file, path: services[:path_finder].default
   end
-  DEFAULT_PATH = '/home/someone/somewhere';
 end
 
 file_storage = FileStorage.new(services)
@@ -52,7 +76,7 @@ in your application's configuration:
 
 ```ruby
 services = Garcon::ServiceLocator.new
-services.register(:thing_server) { ThingServer.new }
+services.register(:thing_server) { ThingServer.new(services) }
 MyStuff::Application.config.services = services
 ```
 
@@ -81,6 +105,13 @@ class MyThingsController < ApplicationController
 end
 ```
 
+Alternatively, the default behaviour is to try to load a class, based
+upon the service name you have passed to it: 
+
+```ruby
+services['String'].class #=> String
+```
+
 
 ## Contributing
 

data/lib/garcon/service_locator.rb

@@ -7,7 +7,8 @@ module Garcon
     end
 
     def [] service_name
-      @services[service_name.to_s].call
+      service = @services[service_name.to_s]
+      service.nil? ? Object.const_get(service_name.to_s) : service.call
     end
 
     def register service_name, &handler

data/lib/garcon/version.rb

@@ -1,3 +1,3 @@
 module Garcon
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/test/garcon/service_locator_test.rb

@@ -30,4 +30,8 @@ describe Garcon::ServiceLocator do
     subject['dynamic'].must_equal value1
     subject['dynamic'].must_equal value2
   end
+
+  it "retrieves a class dynamically" do
+    subject["String"].must_equal String
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: garcon
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Rahoul Baruah
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-12 00:00:00.000000000 Z
+date: 2015-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -74,6 +74,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".ruby-version"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -104,7 +105,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: A simple Service Locator class