ghaki-env 2011.11.29.1

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2010 Gerald Kalafut
+
+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

@@ -0,0 +1,23 @@
+= Ghaki Env - Run mode discovery helpers
+
+Ghaki Env is a collection of application helpers for dealing with the run time environment.
+
+== Download
+
+The latest version of Ghaki Env can be found at
+
+* git@github.com:ghaki/ghaki-env.git
+
+== Installation
+
+The preferred method of installing Ghaki Env is through its GEM file.
+
+  % [sudo] gem install ghaki-env-0.0.1.gem
+
+== License
+
+Ghaki Env is released under the MIT license.
+
+== Support
+
+Contact mailto:gerald@kalafut.org

data/lib/ghaki/env/app.rb

@@ -0,0 +1,13 @@
+require 'ghaki/app/engine'
+require 'ghaki/env/mixin'
+
+# Adds environment plugin to the app engine.
+
+module Ghaki #:nodoc:
+module App   #:nodoc:
+
+  class Engine #:nodoc:
+    include Ghaki::Env::Mixin
+  end
+
+end end

data/lib/ghaki/env/engine.rb

@@ -0,0 +1,90 @@
+require 'singleton'
+
+module Ghaki #:nodoc:
+module Env   #:nodoc:
+
+  # Run time environment discovery singleton.
+  #
+  # - Detects GHAKI_RUN_ENV, RAILS_ENV, RACK_ENV in environment.
+  # - Detects the RAILS_ENV global constant.
+  # - Detects Sinatra and Merb classes in the Ruby namespace.
+  #
+  # ==== Examples
+  #
+  #    Ghaki::Env.instance.clear_environment
+  #    RACK_ENV = 'testing'
+  #    Ghaki::Env.instance.environment        #=> 'testing'
+
+  class Engine
+    include Singleton
+
+    # Environment read attribute, detects current environment if not already set.
+
+    def environment
+      @environment ||= self.detect_environment
+    end
+
+    # Environment write attribute. Asserts on acceptable values.
+
+    def environment= val
+      @environment = _assert_environment( val )
+    end
+
+    # Clears current set environment.
+
+    def clear_environment
+      @environment = nil
+    end
+
+    # Throw an exception if the environment is not valid.
+
+    def assert_environment
+      _assert_environment( @environment )
+    end
+
+    # Check environment for current run state.
+
+    def detect_environment
+      _assert_environment( self._detect_environment )
+    end
+
+    protected
+
+    def _assert_environment val #:nodoc:
+      case val
+      when nil
+        raise ArgumentError, 'Missing Environment'
+      when :production, :prod, 'production', 'prod'
+        :production
+      when :devel, :development, :dev, 'devel', 'development', 'dev'
+        :development
+      when :test, :testing, 'test', 'testing'
+        :test
+      else
+        raise ArgumentError, "Invalid Environment Name: #{val}"
+      end
+    end
+
+    def _detect_environment #:nodoc:
+      if not @environment.nil?
+        @environment
+      elsif ENV.has_key?('GHAKI_RUN_ENV')
+        ENV['GHAKI_RUN_ENV']
+      elsif ENV.has_key?('RACK_ENV')
+        ENV['RACK_ENV']
+      elsif defined?(RAILS_ENV)
+        RAILS_ENV
+      elsif ENV.has_key?('RAILS_ENV') # deprecated
+        ENV['RAILS_ENV']
+      elsif defined?(Sinatra)
+        Sinatra.environment
+      elsif defined?(Merb)
+        Merb.environment
+      else
+        nil
+      end
+    end
+
+  end
+
+end end 

data/lib/ghaki/env/mixin.rb

@@ -0,0 +1,18 @@
+require 'ghaki/env/engine'
+require 'forwardable'
+
+module Ghaki #:nodoc:
+module Env   #:nodoc:
+
+  # Extends class with environment methods delegated to the environment singleton.
+
+  module Mixin
+    extend Forwardable
+
+    def_delegators 'Ghaki::Env::Engine.instance',
+      :environment,:environment=,:clear_environment,
+      :assert_environment,:detect_environment
+
+  end
+
+end end

data/spec/ghaki/env/app_spec.rb

@@ -0,0 +1,23 @@
+require 'ghaki/env/app'
+
+ENV['GHAKI_RUN_ENV'] = 'test'
+
+describe Ghaki::App::Engine do
+
+  context 'object' do
+    subject { Ghaki::App::Engine.instance }
+    it { should respond_to :environment }
+    it { should respond_to :environment= }
+    it { should respond_to :assert_environment }
+    it { should respond_to :clear_environment }
+    it { should respond_to :detect_environment }
+
+    describe '#environment' do
+      it 'should actually see ENV[GHAKI_RUN_ENV]' do
+        subject.environment.should == :test
+      end
+    end
+
+  end
+
+end

data/spec/ghaki/env/engine_spec.rb

@@ -0,0 +1,101 @@
+############################################################################
+require 'ghaki/env/engine'
+
+############################################################################
+module Ghaki module Env module EngineTesting
+  describe Ghaki::Env::Engine do
+
+    ########################################################################
+    subject { Ghaki::Env::Engine.instance }
+    context 'singleton instance' do
+      it { should respond_to :environment }
+      it { should respond_to :environment= }
+      it { should respond_to :assert_environment }
+      it { should respond_to :clear_environment }
+      it { should respond_to :detect_environment }
+    end
+
+    ########################################################################
+    def clear_all
+      ENV.delete('GHAKI_RUN_ENV')
+      ENV.delete('RAILS_ENV')
+      ENV.delete('RACK_ENV')
+      Object.send( :remove_const, :Sinatra )   if defined? ::Sinatra
+      Object.send( :remove_const, :Merb )      if defined? ::Merb
+      Object.send( :remove_const, :RAILS_ENV ) if defined? ::RAILS_ENV
+    end
+
+    before(:all) do clear_all end
+    after(:each) do clear_all end
+
+    ########################################################################
+    describe '#assert_environment' do
+      it 'complains when missing' do
+        lambda {
+          subject.assert_environment
+        }.should raise_error( ArgumentError, 'Missing Environment' )
+      end
+      it 'does not complain when present' do
+        subject.environment = 'production'
+        lambda {
+          subject.assert_environment
+        }.should_not raise_error( ArgumentError, 'Missing Environment' )
+      end
+    end
+
+    ########################################################################
+    describe '#clear_environment' do
+      it 'cleans environment' do
+        subject.environment = 'test'
+        subject.clear_environment
+        lambda {
+          subject.assert_environment
+        }.should raise_error( ArgumentError, 'Missing Environment' )
+      end
+    end
+
+    before(:each) do subject.clear_environment end
+
+    ########################################################################
+    USING_SETUP = {
+      'explicit assignment' => [ :production,  lambda {
+        Ghaki::Env::Engine.instance.environment  = 'production'
+      }],
+      'ENV[GHAKI_RUN_ENV]'  => [ :development, lambda { ENV['GHAKI_RUN_ENV'] = 'development' }],
+      'ENV[RAILS_ENV]'      => [ :development, lambda { ENV['RAILS_ENV']     = 'development' }],
+      'ENV[RACK_ENV]'       => [ :test,        lambda { ENV['RACK_ENV']      = 'test' }],
+      'RAILS_ENV'           => [ :development, lambda { ::RAILS_ENV          = 'development' }],
+      'Merb'                => [ :production,  lambda {
+        Object::const_set( :Merb, Class::new )
+        ::Merb.expects(:environment).returns('production')
+      }],
+      'Sinatra'             => [ :test,        lambda {
+        Object::const_set( :Sinatra, Class::new )
+        ::Sinatra.expects(:environment).returns('test')
+      }],
+    }
+
+    ########################################################################
+    describe '#detect_environment' do
+      USING_SETUP.each_key do |desc|
+        want,func = USING_SETUP[desc]
+        it "detects #{desc}" do
+          func.call
+          subject.detect_environment.should == want
+        end
+      end
+    end
+
+    ########################################################################
+    describe '#environment' do
+      USING_SETUP.each_key do |desc|
+        want,func = USING_SETUP[desc]
+        it "accepts #{desc}" do
+          func.call
+          subject.environment.should == want
+        end
+      end
+    end
+
+  end
+end end end

data/spec/ghaki/env/mixin_spec.rb

@@ -0,0 +1,34 @@
+############################################################################
+require 'ghaki/env/mixin'
+
+############################################################################
+module Ghaki module Env module MixinTesting
+describe Ghaki::Env::Mixin do
+
+  ########################################################################
+  class TestEnv
+    include Ghaki::Env::Mixin
+  end
+
+  ########################################################################
+  context 'including objects' do
+
+    subject { TestEnv.new }
+    it { should respond_to :environment }
+    it { should respond_to :environment= }
+    it { should respond_to :assert_environment }
+    it { should respond_to :clear_environment }
+    it { should respond_to :detect_environment }
+
+    describe '#environment' do
+      it 'should actually see ENV[GHAKI_RUN_ENV]' do
+        subject.environment.should == :test
+      end
+    end
+
+  end
+
+end
+end end end
+############################################################################
+

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'mocha'
+
+RSpec.configure do |cfg|
+  cfg.mock_with :mocha
+  cfg.color_enabled = true
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: ghaki-env
+version: !ruby/object:Gem::Version
+  version: 2011.11.29.1
+  prerelease: 
+platform: ruby
+authors:
+- Gerald Kalafut
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-30 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ghaki-app
+  requirement: &78229850 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *78229850
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &78229590 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :development
+  prerelease: false
+  version_requirements: *78229590
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &78229330 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+  type: :development
+  prerelease: false
+  version_requirements: *78229330
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &78229100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.9.4
+  type: :development
+  prerelease: false
+  version_requirements: *78229100
+description: Collection of application helpers for dealing with the run time environment.
+email: gerald@kalafut.org
+executables: []
+extensions: []
+extra_rdoc_files:
+- README
+files:
+- lib/ghaki/env/engine.rb
+- lib/ghaki/env/mixin.rb
+- lib/ghaki/env/app.rb
+- README
+- LICENSE
+- spec/ghaki/env/app_spec.rb
+- spec/ghaki/env/mixin_spec.rb
+- spec/ghaki/env/engine_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/ghaki
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: ghaki-env
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Run mode discovery helpers
+test_files:
+- spec/ghaki/env/app_spec.rb
+- spec/ghaki/env/mixin_spec.rb
+- spec/ghaki/env/engine_spec.rb
+- spec/spec_helper.rb