garcon 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 70e6459dde2b9a208c1fd89d5917e7818443d2e2
+  data.tar.gz: 739061b54a73366276729161eeb18288437d7a38
+SHA512:
+  metadata.gz: bf265524c8e31f50f9b59cd4ddae995abe4b0b1f06ef3a8904e33554df4305c86e2253e5567ae8e420241cb8968ff3d51e4d4b0d7230cbefc11703d67bf1428e
+  data.tar.gz: 881113987fceac165fe1c8998bbadc26e6b5ec4264dcc31c0f81adf8532dd56d8fc021869903b77405fe30c0d9cf356ea6bd83613310764a30f90add097c1d23

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Rahoul Baruah
+
+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,91 @@
+# Garcon
+
+Garcon is a simple Service Locator object.  
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'garcon'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install garcon
+
+## Usage
+
+Create an instance of your service locator, and then register your
+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" }
+```
+
+Then use this Service Locator to find your related objects, instead of
+having hard-coded constants.  
+
+```ruby
+class FileStorage < Struct.new(:services)
+  def store_file file
+    services[:file_server].store file, path: DEFAULT_PATH
+  end
+  DEFAULT_PATH = '/home/someone/somewhere';
+end
+
+file_storage = FileStorage.new(services)
+file_storage.store_file my_file
+```
+
+If you're writing a Rails app I like to configure it like so - create
+your services object in config/initializers/services.rb.  Then store it
+in your application's configuration: 
+
+```ruby
+services = Garcon::ServiceLocator.new
+services.register(:thing_server) { ThingServer.new }
+MyStuff::Application.config.services = services
+```
+
+Then, in your application controller, add a protected method to access
+it: 
+
+```ruby
+class ApplicationController < ActionController::Base
+
+  protected
+
+  def services
+    MyStuff::Application.config.services
+  end
+end
+```
+
+And finally you can then use it in your controllers as you wish (and
+then pass it on to everything else): 
+
+```ruby
+class MyThingsController < ApplicationController
+  def index
+    @things = services[:thing_server].find_all
+  end
+end
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/rahoulb/garcon/fork )
+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,7 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/**/*_test.rb"
+end
+

data/garcon.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'garcon/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "garcon"
+  spec.version       = Garcon::VERSION
+  spec.authors       = ["Rahoul Baruah"]
+  spec.email         = ["rahoulb@madeofstone.net"]
+  spec.summary       = %q{A simple Service Locator class}
+  spec.description   = %q{}
+  spec.homepage      = "http://github.com/rahoulb"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.5.0"
+  spec.add_development_dependency "mocha", "~> 1.1.0"
+end

data/lib/garcon/service_locator.rb

@@ -0,0 +1,17 @@
+module Garcon
+  class ServiceLocator
+
+    def initialize
+      super
+      @services = {}
+    end
+
+    def [] service_name
+      @services[service_name.to_s].call
+    end
+
+    def register service_name, &handler
+      @services[service_name.to_s] = handler
+    end
+  end
+end

data/lib/garcon/version.rb

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

data/lib/garcon.rb

@@ -0,0 +1,6 @@
+require "garcon/version"
+require "garcon/service_locator"
+
+module Garcon
+
+end

data/test/garcon/service_locator_test.rb

@@ -0,0 +1,33 @@
+require_relative '../test_helper'
+require_relative '../../lib/garcon/service_locator'
+
+describe Garcon::ServiceLocator do
+  subject { Garcon::ServiceLocator.new }
+
+  CONSTANT = "HELLO".freeze
+  let(:factory) { stub 'Factory' }
+  let(:value1) { stub 'Value1' }
+  let(:value2) { stub 'Value2' }
+
+  it "registers constants" do
+    subject.register "constant" do
+      CONSTANT
+    end
+
+    subject['constant'].must_equal CONSTANT
+  end
+
+  it "registers dynamic objects" do
+    factory.expects(:new).with(1).returns(value1)
+    factory.expects(:new).with(2).returns(value2)
+
+    count = 0
+    subject.register 'dynamic' do 
+      count += 1
+      factory.new(count)
+    end
+
+    subject['dynamic'].must_equal value1
+    subject['dynamic'].must_equal value2
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'minitest/autorun'
+require 'mocha/setup'

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: garcon
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rahoul Baruah
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.5.0
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+description: ''
+email:
+- rahoulb@madeofstone.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- garcon.gemspec
+- lib/garcon.rb
+- lib/garcon/service_locator.rb
+- lib/garcon/version.rb
+- test/garcon/service_locator_test.rb
+- test/test_helper.rb
+homepage: http://github.com/rahoulb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: A simple Service Locator class
+test_files:
+- test/garcon/service_locator_test.rb
+- test/test_helper.rb