ssoroka-app_settings 0.2.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Steven Soroka
+
+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,47 @@
+= app_settings
+
+Simple wrapper for YAML config files for Rails apps and gems
+
+== Install
+
+    sudo gem install ssoroka-app_settings
+    rake app_settings:install_config
+
+== Usage
+
+=== Usage with Rails
+
+in an initializer, put:
+
+    $settings = AppSettings.new(File.join(Rails.root, 'config', 'app_settings.yml'))
+
+Then anywhere in your app you can access the settings with:
+
+    $settings['users/tim/user_name']
+    $settings['users/tim/password']
+
+Or whatever applies for your config file.
+
+See example_config/example_for_rails.yml for an example yml file, here's some code examples to match:
+
+    $settings['google_maps_api_keys/localhost']
+    
+    $settings['domains/legacy']
+    
+    $settings['from_address']
+    
+    $settings.from_address
+    
+=== Usage with Gems or Plugins
+
+    # if user_config_file_path doesn't exist, default_config_file_path will be used.
+    @settings = AppSettings.new(user_config_file_path, default_config_file_path)
+    @settings['hoptoad/auth_token']
+
+=== ERB in config files
+
+The config files support ERB: <%= %>
+
+== Copyright
+
+Copyright (c) 2009 Steven Soroka. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "app_settings"
+    gem.summary = %Q{Simple wrapper for YAML config files for Rails apps and gems}
+    gem.email = "ssoroka78@gmail.com"
+    gem.homepage = "http://github.com/ssoroka/app_settings"
+    gem.authors = ["Steven Soroka"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "app_settings #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 2
+:patch: 0

data/app_settings.gemspec

@@ -0,0 +1,50 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{app_settings}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Steven Soroka"]
+  s.date = %q{2009-07-22}
+  s.email = %q{ssoroka78@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION.yml",
+     "app_settings.gemspec",
+     "example_config/example_for_gem.yml",
+     "example_config/example_for_rails.yml",
+     "init.rb",
+     "lib/app_settings.rb",
+     "spec/app_settings_spec.rb",
+     "spec/spec_helper.rb",
+     "tasks/app_settings.rake"
+  ]
+  s.homepage = %q{http://github.com/ssoroka/app_settings}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.3}
+  s.summary = %q{Simple wrapper for YAML config files for Rails apps and gems}
+  s.test_files = [
+    "spec/app_settings_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/example_config/example_for_gem.yml

@@ -0,0 +1,8 @@
+# ERB is allowed in this file. eg. test_value: <%= 3 * 12 %> Keep in mind, when
+# using ERB, it's only evaluated ONCE when the application loads!
+twitter:
+  user: frank
+  password: orange
+  sleep: 300
+bitly:
+  api: abc123

data/example_config/example_for_rails.yml

@@ -0,0 +1,48 @@
+# Settings in defaults: affect all environments. settings in other environments override the
+# defaults setting erb is allowed in this file. eg. test_value: <%= 3 * 12 %> Keep in mind, when
+# using erb, it's only evaluated ONCE when the application loads! (at least, in production).
+defaults: &defaults
+  domains:
+    www: <%= ENV['TMPDIR'].to_s.match(/passenger/) ? 'AppSettings.local' : '0.0.0.0:3000' %>
+    mail: localhost
+    legacy: www.AppSettings.com
+    images: images.AppSettings.com
+
+  # settings can reference other settings like so:
+  from_address: help@AppSettings.com
+  attachment_path: public/images
+
+  # This is at least until we have a dedicated exception sender.  Or always; whatever.
+  exception_sender: rails@AppSettings.com
+  
+  items_per_page: 50
+
+  # git commit number that HEAD currently points to.  Only evaluated once on server start
+  git_head: <%= `git log --abbrev=8 -1 --pretty=format:"%h"` %>
+
+  google_maps_api_keys:
+    0.0.0.0: key here
+    localhost: key here
+
+  request_history_size: 4
+
+development: &development
+  <<: *defaults
+
+test:
+  <<: *defaults
+  domains:
+    www: 0.0.0.0:3001
+    mail: localhost
+    legacy: www.AppSettings.com
+    images: images.AppSettings.com
+
+production: &production
+  <<: *defaults
+  google_maps_api_keys: # Each subdomain requires its own key, I do believe
+    www.AppSettings.com: key_here
+  domains:
+    www: www.AppSettings.com
+    mail: AppSettings.com
+    legacy: www1.AppSettings.com
+    images: images.AppSettings.com

data/init.rb

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

data/lib/app_settings.rb

@@ -0,0 +1,56 @@
+require 'erb'
+require 'yaml'
+
+# see README.rdoc
+class AppSettings
+  class MissingConfigFileException < Exception
+    def initialize(file)
+      border = "\n" << ('*' * 60) << "\n"
+      super("#{border} Config file #{file} does not exist. Please create it. #{border}")
+    end
+  end
+  attr_accessor :config_file, :stored_settings
+  
+  # use the first config file passed in that exists. Nice for allowing users to override your default config
+  # defaults to "#{RAILS_ROOT}/config/app_settings.yml" in rails apps if no config filename is passed in
+  def initialize(*config_files)
+    @config_file = Array(config_files).detect{|f| File.exist?(f) }
+    @config_file ||= "#{RAILS_ROOT}/config/app_settings.yml" if defined?(RAILS_ROOT)
+  end
+  
+  # allows $settings.key_name shortcut for simple structures.
+  def method_missing(m, *a, &b)
+    read_settings(m.to_s)
+  end
+
+  # supports $settings['twitter/api/keys/frank'] style settings. Wont blow up on nil keys
+  # if RAILS_ENV is defined, it'll look for the keys in the appropriate environment inside app_settings.yml
+  def [](k)
+    keys = k.to_s.split('/')
+    result = read_settings(keys.shift)
+    while result && keys.any?
+      result = result[keys.shift]
+    end
+    result
+  end
+
+  # immediately expires the settings caches
+  def reload!
+    @stored_settings &&= nil
+  end
+  
+  protected
+    def read_settings(k)
+      unless @stored_settings
+        die_if_file_missing
+        @stored_settings = YAML::load(ERB.new(File.read(config_file)).result)
+        @stored_settings = @stored_settings[RAILS_ENV] if defined?(RAILS_ENV)
+      end
+
+      @stored_settings[k.to_s]
+    end
+
+    def die_if_file_missing
+      raise MissingConfigFileException.new(@config_file) if !@config_file || !File.exist?(@config_file)
+    end
+end

data/spec/app_settings_spec.rb

@@ -0,0 +1,29 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "AppSettings" do
+  before(:each) do
+    @settings = AppSettings.new(File.join(File.dirname(__FILE__), %w(.. example_config/example_for_rails.yml)))
+  end
+  
+  describe '[]' do
+    it "should support single keys" do
+      @settings['domains/legacy'].should == 'www.AppSettings.com'
+    end
+  
+    it "should support nested keys" do
+      @settings[:items_per_page].should == 50
+    end
+    
+    it "should not die on keys that don't exist" do
+      lambda {
+        @settings['a/b/c/d/e/f/g'].should be_nil
+      }.should_not raise_error
+    end
+  end
+
+  describe '.value' do
+    it "should work" do
+      @settings.domains['legacy'].should == 'www.AppSettings.com'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'spec'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+RAILS_ENV = 'test'
+
+require 'app_settings'
+
+Spec::Runner.configure do |config|
+  AppSettings::APP_SETTINGS_FILE = File.join(File.dirname(__FILE__), %w(.. example_config app_settings.yml))
+  
+end

data/tasks/app_settings.rake

@@ -0,0 +1,13 @@
+namespace :app_settings do
+  desc "Install the default config file"
+  task :install_config => [:environment] do
+    dest_file = File.join(Rails.root, 'config', 'app_settings.yml')
+    if File.exist?(dest_file)
+      puts "#{dest_file} already exists.  Remove it first if you want to overwrite it."
+    else
+      puts "installing default config file to #{dest_file}"
+      FileUtils.mv(File.join(File.dirname(__FILE__), %w(.. example_config example_for_rails.yml)), dest_file)
+    end
+  end
+end
+

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: ssoroka-app_settings
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Steven Soroka
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-22 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: ssoroka78@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- app_settings.gemspec
+- example_config/example_for_gem.yml
+- example_config/example_for_rails.yml
+- init.rb
+- lib/app_settings.rb
+- spec/app_settings_spec.rb
+- spec/spec_helper.rb
+- tasks/app_settings.rake
+has_rdoc: false
+homepage: http://github.com/ssoroka/app_settings
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: Simple wrapper for YAML config files for Rails apps and gems
+test_files: 
+- spec/app_settings_spec.rb
+- spec/spec_helper.rb