app_constants 1.0.0

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec"
+  gem "jeweler"
+end

data/Gemfile.lock

@@ -0,0 +1,25 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rspec (2.4.0)
+      rspec-core (~> 2.4.0)
+      rspec-expectations (~> 2.4.0)
+      rspec-mocks (~> 2.4.0)
+    rspec-core (2.4.0)
+    rspec-expectations (2.4.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jeweler
+  rspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 [name of plugin creator]
+
+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.rdoc

@@ -0,0 +1,97 @@
+=== Note for Rails 2.3.x users
+Check out the branch rails_2_3_x.
+
+Master is Rails 3 compatible only.
+
+= AppConstants
+
+It's funny how every Rails application I work on ends up needing some sort of per-environment global constants.
+
+Examples may include the application url - It might be used in account activation emails and thus should be different between the development and production environments.
+
+Or perhaps your application depends on external services that, depending on the environment, are available in different URIs.
+
+One common approach is to define these constants in your environment files:
+
+  # in environment.rb
+  Rails::Initializer.run do |config|
+    ...
+    ACTIVATION_URL = "http://www.example.com/activate"
+  end
+  
+  #and then in development.rb
+    ACTIVATION_URL = "http://localhost:3000/activate"
+    
+But in my experience constants end up being scattered all around, people don't know where to look for them and much less where new ones should be defined.
+
+AppConstants can be used as a gem or as a plugin. It provides a clean way to handle this need.
+
+
+== Installing AppConstants as a gem
+
+Add it to your Gemfile:
+
+  gem 'app_constants'
+
+Then bundle install and run the generator:
+
+  $ bundle install
+  
+  $ rails generate app_constants
+    exists  config
+    create  config/constants.yml
+    exists  config/initializers
+    create  config/initializers/load_app_constants.rb
+
+== Installing AppConstants as a plugin
+
+Just install the plugin as you normally would and run the generator
+
+  $ rails plugin install git://github.com/leonardoborges/app_constants.git
+
+  $ rails generate app_constants
+    exists  config
+    create  config/constants.yml
+    exists  config/initializers
+    create  config/initializers/load_app_constants.rb
+    
+Now use the constants.yml file to define your own constants and the load_app_constants.rb initializer to customize the plugin. e.g: Change the default location for the constants.yml file.
+
+== Example
+
+If you have a constants.yml file that looks like this:
+
+  # Enter your per-environment constants below
+
+  development: &default
+    activation_url:  "http://localhost:3000/activate"
+    max_upload_in_bytes: <%= 1.megabyte %>
+
+  production:
+    <<: *default
+    activation_url:  "http://www.example.com/activate"
+    
+Then you can use the AppConstant class to retrieve your constants anywhere in your app:
+
+  # somewhere in the activation email view
+  Visit this url to activate your account:
+    <%= "#{AppConstants.activation_url}/#{activation_code}" %>
+
+Notice how I used embedded ruby code in the second constant. It works just fine:
+
+  # somewhere in your upload handling code
+  max_size = AppConstants.max_upload_in_bytes # 1048576
+
+== Contributing to app_constants
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2010-2011 {Leonardo Borges}[http://www.leonardoborges.com], released under the MIT license

data/Rakefile

@@ -0,0 +1,62 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rake'
+require 'rake/rdoctask'
+require 'rspec/core/rake_task'
+require 'jeweler'
+require 'jeweler/tasks'
+require 'jeweler/specification'
+require 'jeweler/rubygems_dot_org_tasks'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+desc 'Default: run unit tests.'
+task :default => :spec
+
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "app_constants"
+  gem.homepage = "http://github.com/leonardoborges/app_constants"
+  gem.license = "MIT"
+  gem.summary = %Q{A clean and simple way to manage your application's per-environment constants}
+  gem.description = %Q{A clean and simple way to manage your application's per-environment constants}
+  gem.email = "leonardoborges.rj@gmail.com"
+  gem.authors = ["Leonardo Borges"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  gem.add_development_dependency 'rspec'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = Dir.glob('test/**/*_spec.rb')
+end
+
+desc 'Generate documentation for the app_constants plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'AppConstants'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/init.rb

@@ -0,0 +1 @@
+require 'app_constants'

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/app_constants.rb

@@ -0,0 +1,40 @@
+require 'yaml'
+require 'erb'
+
+class AppConstants
+  @@config_path = Object.const_defined?(:Rails) ? "#{Rails.root}/config/constants.yml" : nil
+  @@environment = Object.const_defined?(:Rails) ? Rails.env : 'test'
+  
+  def self.config_path=(path)
+    @@config_path = path
+  end
+  
+  def self.environment=(environment)
+    @@environment = environment
+  end  
+  
+  def self.method_missing(method, *args)
+    @@instance.send(method).is_a?(Hash) ? AppConstants.new(@@instance.constants_hash[method.to_s]) : @@instance.send(method)
+  end
+  
+  def method_missing(method, *args)
+    constants_hash[method.to_s].nil? ? "" : constants_hash[method.to_s] 
+  end
+  
+  def self.load!
+    raise ArgumentError.new("No config file path specified. Use 'AppConstants.config_path = PATH' to set it up") if @@config_path.nil?
+    constants_config = YAML::load(pre_process_constants_file)
+    constants_hash = constants_config[@@environment] || {}
+    @@instance = AppConstants.new(constants_hash)
+  end  
+  
+  def self.pre_process_constants_file
+    template = File.open(@@config_path).read
+    ERB.new(template).result
+  end
+  
+  attr_reader :constants_hash
+  def initialize(constants_hash)
+    @constants_hash = constants_hash
+  end
+end

data/lib/generators/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Creates the default constants.yml file the the load_app_constants.rb initializer 
+
+Example:
+    rails generate app_constants
+
+    This will create:
+        config/constants.yml - constants definition file
+        config/initializers/load_app_constants.yml - Initialization and customization file

data/lib/generators/app_constants_generator.rb

@@ -0,0 +1,10 @@
+class AppConstantsGenerator < Rails::Generators::Base
+  def self.source_root
+    @source_root ||= File.expand_path('../templates', __FILE__)
+  end  
+  
+  def copy_config_files
+    copy_file('constants.yml', 'config/constants.yml')
+    copy_file('load_app_constants.rb', 'config/initializers/load_app_constants.rb')
+  end  
+end

data/lib/generators/templates/constants.yml

@@ -0,0 +1,12 @@
+# Enter your per-environment constants below
+
+development: &default
+  constant1:  "value1"
+  constant2:  "value2"
+
+production:
+  <<: *default
+  constant1:  "overriden value1"
+  
+test:
+  <<: *default

data/lib/generators/templates/load_app_constants.rb

@@ -0,0 +1,4 @@
+# Loads the default configuration file located under RAILS_ROOT/config/constants.yml
+# Change the default location by modifying the following line:
+AppConstants.config_path = "#{Rails.root}/config/constants.yml"
+AppConstants.load!

data/test/app_constants_spec.rb

@@ -0,0 +1,38 @@
+require File.expand_path(File.dirname(__FILE__) + '/../lib/app_constants')
+
+describe "AppConstants" do
+  it "should access the constants in the config file" do
+    AppConstants.config_path = "#{File.dirname(__FILE__)}/fixtures/constants.yml"
+    AppConstants.environment = "development"
+    AppConstants.load!
+
+    AppConstants.public_url.should == "development.myawesomeapp.com"
+    AppConstants.app_name.should == "Master of awesomeness"
+  end
+
+  it "should return nil for non-existing environments" do
+    AppConstants.config_path = "#{File.dirname(__FILE__)}/fixtures/constants.yml"
+    AppConstants.environment = "invalid"
+    AppConstants.load!
+    AppConstants.public_url.should be_empty
+
+  end
+
+  it "should process embedded code" do
+    AppConstants.config_path = "#{File.dirname(__FILE__)}/fixtures/template_constants.yml"
+    AppConstants.environment = "development"
+    AppConstants.load!
+
+    AppConstants.max_upload_in_bytes.should == 1048576
+  end
+
+  describe "#load!" do
+
+    before(:each) do
+      AppConstants.config_path = nil
+    end
+    it "should raise an ArgumentError if path is null" do
+      expect { AppConstants.load! }.to raise_error(ArgumentError)
+    end
+  end
+end

data/test/fixtures/constants.yml

@@ -0,0 +1,6 @@
+development: &default
+  public_url:  "development.myawesomeapp.com"
+  app_name: "Master of awesomeness"
+production:
+  <<: *default
+  public_url:  "www.myawesomeapp.com"

data/test/fixtures/nested_constants.yml

@@ -0,0 +1,9 @@
+development: &default
+  public_url:  "development.myawesomeapp.com"
+  app_name: "Master of awesomeness"
+  email:
+    admin: "admin@myapp.com"
+    support: "support@myapp.com"    
+production:
+  <<: *default
+  public_url:  "www.myawesomeapp.com"

data/test/fixtures/template_constants.yml

@@ -0,0 +1,4 @@
+development: &default
+  max_upload_in_bytes:  <%= 1 * 1024 * 1024 %>
+production:
+  <<: *default

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'test/unit'
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification 
+name: app_constants
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Leonardo Borges
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-02 00:00:00 +11:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+description: A clean and simple way to manage your application's per-environment constants
+email: leonardoborges.rj@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- init.rb
+- install.rb
+- lib/app_constants.rb
+- lib/generators/USAGE
+- lib/generators/app_constants_generator.rb
+- lib/generators/templates/constants.yml
+- lib/generators/templates/load_app_constants.rb
+- test/app_constants_spec.rb
+- test/fixtures/constants.yml
+- test/fixtures/nested_constants.yml
+- test/fixtures/template_constants.yml
+- test/test_helper.rb
+- uninstall.rb
+has_rdoc: true
+homepage: http://github.com/leonardoborges/app_constants
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -601260458832168315
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A clean and simple way to manage your application's per-environment constants
+test_files: 
+- test/app_constants_spec.rb
+- test/test_helper.rb