enviro 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format nested
+

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.9.2@enviro_dev

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/README

@@ -0,0 +1,5 @@
+= Enviro
+
+Add rails compatable environments, configutation and logging to any ruby object.
+
+

data/Rakefile

@@ -0,0 +1,3 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+Dir.glob(File.join(File.dirname(__FILE__), 'tasks/*.rake')).each {|f| load f }

data/config/cucumber.yml

@@ -0,0 +1,13 @@
+<%
+opts = '--color --require features'
+rerun = File.file?('rerun.txt') ? IO.read('rerun.txt') : ""
+rerun_opts = rerun.to_s.strip.empty? ? 
+  "#{opts} --format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} features" : 
+  "#{opts} --format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} #{rerun}"
+std_opts = "#{opts} --format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} --strict --tags ~@wip"
+%>
+default: <%= std_opts %> features
+wip: <%= opts %> --tags @wip:3 --wip features
+rerun: <%= rerun_opts %> --format rerun --out rerun.txt --strict --tags ~@wip
+autotest: <%= std_opts %>
+autotest-all: <%= std_opts %>

data/enviro.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "enviro/version"
+
+Gem::Specification.new do |s|
+  s.name        = "enviro"
+  s.version     = Enviro::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Bram Swenson"]
+  s.email       = ["bram@craniumisajar.com"]
+  s.homepage    = "http://github.com/bramswenson/enviro"
+  s.summary     = %q{ Add rails like application wide environment configuration, logging and more. }
+  s.description = %q{ Add rails like application wide environment configuration, logging and more. }
+
+  s.rubyforge_project = "enviro"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency('cucumber')
+  s.add_development_dependency('rspec')
+  s.add_development_dependency('autotest-standalone')
+  s.add_development_dependency('autotest-growl')
+  s.add_development_dependency('simplecov')
+  s.add_development_dependency('ruby-debug19')
+end

data/features/enviro/version.feature

@@ -0,0 +1,8 @@
+Feature: Enviro should be versioned
+
+  As an Enviro user
+  I should be able to figure out the current version
+  So I can respond as needed
+
+  Scenario: Enviro::VERSION
+    Then "Enviro::VERSION" should be "0.0.1"

data/features/step_definitions/version_steps.rb

@@ -0,0 +1,4 @@
+Then /^"([^"]*)" should be "([^"]*)"$/ do |constant, value|
+  eval(constant).should == value
+end
+

data/features/support/env.rb

@@ -0,0 +1,3 @@
+require 'bundler/setup'
+Bundler.require(:default, :development)
+require 'cucumber/formatter/unicode' # Remove this line if you don't want Cucumber Unicode support

data/lib/enviro/configuration.rb

@@ -0,0 +1,44 @@
+module Enviro
+  module Configuration
+
+    class FileNotFound < StandardError; end
+    class UnknownEnvironment < StandardError; end
+
+    def self.included(base)
+      base.send(:extend,  ClassMethods)
+    end
+
+    module ClassMethods
+
+      def configuration_path_env(value=nil)
+        @_configuration_path_env ||= 'ENVY_CONF_PATH'
+        @_configuration_path_env = value.to_s.upcase unless value.nil?
+        @_configuration_path_env
+      end
+
+      def configuration_path
+        @_configuration_path ||= (ENV[self.configuration_path_env]||'enviro.yml')
+      end
+
+      def configuration
+        @_configuration ||= _load_configuration_path
+      end
+
+      private
+
+        def _load_configuration_path
+          raise FileNotFound.new(self.configuration_path) unless
+            File.exists?(self.configuration_path)
+
+          @raw_configuration = YAML.load_file(self.configuration_path)
+
+          raise UnknownEnvironment.new(self.environment) unless
+            @raw_configuration.key?(self.environment)
+
+          OpenStruct.new(@raw_configuration[self.environment].merge(:environment => self.environment))
+        end
+
+    end
+  end
+end
+

data/lib/enviro/environate.rb

@@ -0,0 +1,14 @@
+module Enviro
+  module Environate
+
+    def self.included(base)
+      base.class_eval do
+        attr_accessor :environment, :configuration, :logger
+      end
+      base.send(:include, Enviro::Environment)
+      base.send(:include, Enviro::Configuration)
+      base.send(:include, Enviro::Logger)
+    end
+
+  end
+end

data/lib/enviro/environment.rb

@@ -0,0 +1,35 @@
+module Enviro
+  module Environment
+
+    def self.included(base)
+      base.send(:extend,  ClassMethods)
+    end
+
+    module ClassMethods
+      def environment
+        @environment ||= _setup_environment
+      end
+
+      def environment=(value)
+        @environment = value
+      end
+      alias :env :environment
+
+      def env?(value)
+        self.environment == value.to_sym
+      end
+
+      private
+
+        def _setup_environment
+          if defined?(Rails)
+            Rails.env
+          else
+            ENV['ENVY_ENV'].nil? ? :development : ENV['ENVY_ENV'].to_sym
+          end
+        end
+
+    end
+  end
+end
+

data/lib/enviro/logger.rb

@@ -0,0 +1,49 @@
+module Enviro
+  module Logger
+
+    class DirectoryNotFound < StandardError; end
+
+    def self.included(base)
+      base.send(:extend, ClassMethods)
+      base.instance_eval do
+        class << self
+          extend Forwardable
+          def_delegators :logger, :debug, :error, :fatal, :info, :warn
+        end
+      end
+    end
+
+    module ClassMethods
+
+      def logger_dir_env(value=nil)
+        @_logger_dir_env ||= 'ENVY_LOG_DIR'
+        @_logger_dir_env = value.to_s.upcase unless value.nil?
+        @_logger_dir_env
+      end
+
+      def logger_dir
+        @_logger_dir ||= ENV[self.logger_dir_env]
+      end
+
+      def logger
+        @_logger ||= _setup_logger_for_environment
+      end
+
+      private
+
+        def _setup_logger_for_environment
+          return ::Rails.logger if defined?(::Rails)
+          unless self.logger_dir.nil?
+            raise DirectoryNotFound unless File::directory?(self.logger_dir)
+            @logger_path = File.join(self.logger_dir, "#{self.environment}.log")
+          else
+            @logger_path = STDOUT
+          end
+          require 'logger'
+          return ::Logger.new(@logger_path)
+        end
+    end
+
+  end
+end
+

data/lib/enviro/version.rb

@@ -0,0 +1,3 @@
+module Enviro
+  VERSION = "0.0.1"
+end

data/lib/enviro.rb

@@ -0,0 +1,10 @@
+require "bundler/setup"
+Bundler.require
+require 'forwardable'
+
+module Enviro
+  autoload :Environment,   'enviro/environment'
+  autoload :Configuration, 'enviro/configuration'
+  autoload :Logger,        'enviro/logger'
+  autoload :Environate,    'enviro/environate'
+end

data/spec/enviro/configuration_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+describe Enviro::Configuration do
+  context "with standard environment variable" do
+    before(:each) do
+      Object.send(:remove_const, :TestEnviroConfiguration) if defined?(TestEnviroConfiguration)
+      ENV['ENVY_CONF_PATH'] = '/tmp/enviro.yml'
+      class TestEnviroConfiguration
+        include Enviro::Environment
+        include Enviro::Configuration
+      end
+      config = {
+        :development => {
+        },
+        :test => {
+        },
+        :production => {
+        },
+      }
+      File.open(ENV['ENVY_CONF_PATH'], 'w') do |f|
+        f.write(YAML.dump(config))
+      end
+    end
+
+    it "should have configuration available as a struct like object" do
+      TestEnviroConfiguration.configuration.should respond_to(:methods)
+    end
+
+    it "should have configuration for current environment" do
+      TestEnviroConfiguration.configuration.environment.should be(:development)
+    end
+
+    it "should raise when configuration file is not found" do
+      ENV['ENVY_CONF_PATH'] = 'who_the_heck_knows'
+      expect {
+        TestEnviroConfiguration.configuration
+      }.should raise_error(Enviro::Configuration::FileNotFound)
+    end
+
+    it "should raise when configuration for current environment is not found" do
+      ENV['ENVY_ENV'] = 'who_the_heck_knows'
+      expect {
+        TestEnviroConfiguration.configuration.environment
+      }.should raise_error(Enviro::Configuration::UnknownEnvironment)
+    end
+  end
+
+  context "with custom environment variable" do
+    before(:each) do
+      Object.send(:remove_const, :TestEnviroConfiguration) if defined?(TestEnviroConfiguration)
+      ENV['CUSTOM_PATH'] = '/tmp/enviro_custom.yml'
+      class TestEnviroConfiguration
+        include Enviro::Environment
+        include Enviro::Configuration
+        configuration_path_env :custom_path
+      end
+      config = {
+        :development => {
+        },
+        :test => {
+        },
+        :production => {
+        },
+      }
+      File.open(ENV['CUSTOM_PATH'], 'w') do |f|
+        f.write(YAML.dump(config))
+      end
+    end
+
+    it "should upcase the configuration_path_env attribute" do
+      TestEnviroConfiguration.configuration_path_env.should == 'CUSTOM_PATH'
+    end
+
+  end
+end

data/spec/enviro/environate_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Enviro::Environate do
+  context "the extended class" do
+
+    context "should respond to" do
+      %w( environment configuration logger).each do |meth|
+        it "#{meth}" do
+          EnviroMe.should respond_to(meth.to_sym)
+        end
+      end
+    end
+  end
+
+end

data/spec/enviro/environment_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe Enviro::Environment do
+  before(:each) do
+    Object.send(:remove_const, :TestEnviroEnvironment) if defined?(TestEnviroEnvironment)
+    class TestEnviroEnvironment
+      include Enviro::Environment
+    end
+  end
+
+  it "should have the environment attribute set the default when no session ENV setting is set" do
+    ENV['ENVY_ENV'] = nil
+    ENV['ENVY_ENV'].should be_nil
+    TestEnviroEnvironment.environment.should == :development
+  end
+
+  it "should have the environment attribute set the same as the session ENV setting" do
+    ENV['ENVY_ENV'] = 'production'
+    ENV['ENVY_ENV'].should == "production"
+    TestEnviroEnvironment.environment.should == :production
+  end
+
+  it "should alias env to environment" do
+    ENV['ENVY_ENV'] = nil
+    ENV['ENVY_ENV'].should be_nil
+    TestEnviroEnvironment.env.should == :development
+  end
+
+  it "should return true on env?(value) when value is environment" do
+    ENV['ENVY_ENV'] = nil
+    ENV['ENVY_ENV'].should be_nil
+    TestEnviroEnvironment.env?('development').should be_true
+  end
+
+  it "should return false on env?(value) when value is not environment" do
+    ENV['ENVY_ENV'] = nil
+    ENV['ENVY_ENV'].should be_nil
+    TestEnviroEnvironment.env?('production').should be_false
+  end
+
+  context "within Rails" do
+    before(:each) do
+      module Rails
+        def self.env
+          :production
+        end
+      end
+    end
+
+    after(:each) do
+      Object.send(:remove_const, :Rails) if defined?(Rails)
+    end
+
+    it "should inherit the environment from Rails should it be loaded" do
+      ENV['ENVY_ENV'] = nil
+      ENV['ENVY_ENV'].should be_nil
+      TestEnviroEnvironment.environment.should == :production
+    end
+  end
+end

data/spec/enviro/logger_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+
+describe Enviro::Logger do
+  context "with standard environment variable" do
+    before(:each) do
+      Object.send(:remove_const, :TestEnviroLogger) if defined?(TestEnviroLogger)
+      class TestEnviroLogger
+        include Enviro::Environment
+        include Enviro::Logger
+      end
+      ENV['ENVY_LOG_DIR'] = nil
+      ENV['ENVY_CONF_PATH'] = nil
+      ENV['ENVY_ENV'] = nil
+    end
+
+    it "should have logger like object available" do
+      TestEnviroLogger.logger.should respond_to(:debug)
+    end
+
+    it "should log to STDOUT if ENVY_LOG_DIR is nil" do
+      TestEnviroLogger.logger.instance_variable_get(:@logdev).dev.should be(STDOUT)
+    end
+
+    it "should log to /tmp/development.log if ENVY_LOG_DIR is /tmp and ENVY_ENV is development" do
+      ENV['ENVY_LOG_DIR'] = '/tmp'
+      TestEnviroLogger.logger.instance_variable_get(:@logdev).dev.path.should == '/tmp/development.log'
+    end
+
+    %w( debug error fatal info warn ).each do |level|
+      it "should allow logging to level #{level}" do
+        expect { TestEnviroLogger.send(level.to_sym, 'test') }.should_not raise_error
+      end
+    end
+
+    it "should raise when log file is not writable" do
+      ENV['ENVY_LOG_DIR'] = '/tmp/this_dir_is_not_here'
+      expect {
+        TestEnviroLogger.logger
+      }.should raise_error(Enviro::Logger::DirectoryNotFound)
+    end
+
+    context "within Rails" do
+      before(:each) do
+        module ::Rails
+          def self.logger
+            ::Logger.new(STDOUT)
+          end
+        end
+      end
+
+      after(:each) do
+        Object.send(:remove_const, :Rails) if defined?(Rails)
+      end
+
+      it "should inherit the logger from Rails should it be loaded" do
+        # if we set the log dir to something that doesn't exist 
+        # we can more sure that the Rails.logger is getting used
+        # since otherwise we would raise an error due to the missing dir
+        ENV['ENVY_LOG_DIR'] = '/tmp/this_should_not_exits'
+        TestEnviroLogger.logger.instance_variable_get(:@logdev).dev.should == Rails.logger.instance_variable_get(:@logdev).dev
+      end
+    end
+  end
+  context "with custom environment variable" do
+    before(:each) do
+      Object.send(:remove_const, :TestEnviroLogger) if defined?(TestEnviroLogger)
+      ENV['CUSTOM_LOG'] = '/tmp'
+      class TestEnviroLogger
+        include Enviro::Environment
+        include Enviro::Logger
+        logger_dir_env :custom_log
+      end
+      ENV['ENVY_LOG_DIR'] = nil
+      ENV['ENVY_CONF_PATH'] = nil
+      ENV['ENVY_ENV'] = nil
+    end
+
+    it "should upcase the logger_dir_env attribute" do
+      TestEnviroLogger.logger_dir_env.should == 'CUSTOM_LOG'
+    end
+
+  end
+end

data/spec/enviro/version_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Enviro::VERSION do
+  it "should be 0.0.1" do
+    Enviro::VERSION.should == '0.0.1' 
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'bundler/setup'
+Bundler.require(:default, :development)
+
+class EnviroMe
+  include Enviro::Environate
+end
+

data/tasks/cucumber.rake

@@ -0,0 +1,8 @@
+require 'cucumber'
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "--color --require features --format pretty features"
+end
+task :cucumber => :features
+task :cuke => :features

data/tasks/default.rake

@@ -0,0 +1 @@
+task :default => [ :spec, :cuke ]

data/tasks/rspec.rake

@@ -0,0 +1,5 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.fail_on_error = true
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: enviro
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Bram Swenson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-03-04 00:00:00.000000000 -06:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: &20410940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *20410940
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &20442280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *20442280
+- !ruby/object:Gem::Dependency
+  name: autotest-standalone
+  requirement: &20441860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *20441860
+- !ruby/object:Gem::Dependency
+  name: autotest-growl
+  requirement: &20441440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *20441440
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &20441020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *20441020
+- !ruby/object:Gem::Dependency
+  name: ruby-debug19
+  requirement: &20440600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *20440600
+description: ! ' Add rails like application wide environment configuration, logging
+  and more. '
+email:
+- bram@craniumisajar.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- README
+- Rakefile
+- config/cucumber.yml
+- enviro.gemspec
+- features/enviro/version.feature
+- features/step_definitions/.initialize_steps.rb.swp
+- features/step_definitions/version_steps.rb
+- features/support/env.rb
+- lib/enviro.rb
+- lib/enviro/configuration.rb
+- lib/enviro/environate.rb
+- lib/enviro/environment.rb
+- lib/enviro/logger.rb
+- lib/enviro/version.rb
+- spec/enviro/configuration_spec.rb
+- spec/enviro/environate_spec.rb
+- spec/enviro/environment_spec.rb
+- spec/enviro/logger_spec.rb
+- spec/enviro/version_spec.rb
+- spec/spec_helper.rb
+- tasks/cucumber.rake
+- tasks/default.rake
+- tasks/rspec.rake
+has_rdoc: true
+homepage: http://github.com/bramswenson/enviro
+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: '0'
+requirements: []
+rubyforge_project: enviro
+rubygems_version: 1.5.3
+signing_key: 
+specification_version: 3
+summary: Add rails like application wide environment configuration, logging and more.
+test_files: []