mc-settings 0.0.1

data/.document

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

data/Gemfile

@@ -0,0 +1,14 @@
+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 "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.1"
+  gem "rcov", ">= 0"
+  gem "ruby-debug"
+end

data/Gemfile.lock

@@ -0,0 +1,36 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    columnize (0.3.2)
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.5.1)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    linecache (0.43)
+    rake (0.8.7)
+    rcov (0.9.9)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.0)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    ruby-debug (0.10.4)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.4.0)
+    ruby-debug-base (0.10.4)
+      linecache (>= 0.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.1)
+  rcov
+  rspec
+  ruby-debug

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Edwin Cruz
+
+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,53 @@
+= Settings
+
+Application Settings Manager
+
+== Usage in Rails
+Settings conventions
+    key_name:
+      default: value
+    key_name: value
+    multiples_values:
+      default: default
+      another_value: another_default
+
+
+  config/settings/default.yml
+  config/settings/environments/development.yml
+  config/settings/environments/production.yml
+  config/settings/local/custom.yml
+  config/settings/local/verysecret.yml
+
+  Setting.load(:files => ["default.yml", "environments/#{Rails.env}.yml"],
+             :path   => "#{Rails.root}/config/settings",
+             :local => true)
+
+  Setting.key_name
+  Setting.available_settings['key_name']
+  Setting.available_settings['key_name']['another_value']
+  Setting['key_name']
+  Setting[:key_name]
+  Setting['multiples_values']['another_value']
+
+
+This means:
+  * Read default.yml, and load all setings in Setting object
+  * Override specific keys depending on rails environment
+  * Apply all #{path}/local/*.yml files to Settings, overriding common keys
+
+
+== Contributing to mc-settings
+ 
+* 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 Edwin Cruz. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,50 @@
+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 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "mc-settings"
+  gem.homepage = "http://github.com/modcloth/mc-settings"
+  gem.license = "MIT"
+  gem.summary = %Q{Manage settings per environment}
+  gem.description = %Q{implement custom keys indenendently of environment}
+  gem.email = "rubydev@modcloth.com"
+  gem.authors = ["Edwin Cruz", "Colin Shield"]
+  # 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', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+require 'ruby-debug'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "mc-settings #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/mc-settings.rb

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

data/lib/setting.rb

@@ -0,0 +1,84 @@
+require 'singleton'
+class Setting
+  class SettingNotFound < RuntimeError; end
+  class SettingFileError < RuntimeError; end
+
+  include Singleton
+
+  def self.reload params = {}
+    @available_settings = {}
+    self.load params
+  end
+
+  def self.available_settings
+    self.instance ? @available_settings : {}
+  end
+
+  # get a setting value by [] notation
+  def self.[](name)
+    self.check_value(name.to_s)
+    self.value_for(name.to_s)
+  end
+
+  def self.method_missing(method, *args, &block)
+    # see if this method is defined above us in the hierarchy
+    super(method, *args)
+  rescue
+    name = method.to_s
+    if name[-1, 1] == "?"
+      name.chomp!('?')
+      self[name]['default'].to_i > 0
+    else
+      self[name]
+    end
+  end
+
+  def initialize
+    @available_settings ||= {}
+  end
+
+  class << self
+    def has_key?(key)
+      @available_settings.has_key?(key)
+    end
+
+    def value_for(value)
+      v = @available_settings[value]
+      if v.is_a?(Hash) && v.size > 1
+        v
+      elsif v.is_a?(Hash) && v.has_key?("default")
+        v['default'].nil? ? "" : v['default']
+      else
+        v
+      end
+    end
+  end
+
+  def self.load(params)
+    files = []
+    path  = params[:path]
+    params[:files].each do |file|
+      files << File.join(path, file)
+    end
+    if params[:local]
+      files << Dir.glob(File.join(path, 'local', '*.yml'))
+    end
+    @available_settings ||= {}
+    files.flatten.each do |file|
+      begin
+        @available_settings.merge!(YAML::load(File.open(file)) || {}) if File.exists?(file)
+      rescue Exception => e
+        raise SettingNotFound.new("Error parsing file #{file}, with: #{e.message}")
+      end
+    end
+    @available_settings
+  end
+
+  private
+
+  def self.check_value(name)
+    raise RuntimeError.new("settings are not yet initialized") unless self.instance
+    raise SettingNotFound.new("#{name} not found") unless self.has_key?(name)
+  end
+
+end

data/spec/mc_settings_spec.rb

@@ -0,0 +1,50 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+describe Setting do
+  subject { Setting }
+
+  context "Test environment" do
+    before :each do
+      stub_setting_files
+      Setting.reload(
+          :files => ["default.yml", "environments/test.yml"],
+          :path  => "config/settings",
+          :local => true)
+    end
+    it 'should return test specific values' do
+      Setting.available_settings['one'].should == "test"
+      Setting.one.should == "test"
+      Setting['one'].should == "test"
+    end
+
+    it "should handle custom values overriding everything else" do
+      Setting.seven.should == "seven from custom"
+    end
+
+    it "handles multiple values" do
+      Setting['six'].should == {"default"=>"default value", "extra"=>"extra"}
+      Setting.available_settings['six']['default'].should == "default value"
+      Setting.available_settings['six']['extra'].should == "extra"
+      Setting.seven.should == "seven from custom"
+    end
+
+    it "should support symbols as keys" do
+      Setting[:six].should == {"default"=>"default value", "extra"=>"extra"}
+    end
+    it "handles default key" do
+      Setting.default_setting.should == 1
+      Setting['seven'].should == "seven from custom"
+    end
+
+    it "should handle empty strings" do
+      Setting.empty.should == ""
+    end
+
+    it "should responds to ? mark" do
+      Setting.autologin?.should == true
+    end
+
+    it "should returns false correctly" do
+      Setting.flag_false.should be(false)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'mc-settings'
+require 'ruby-debug'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+
+end

data/spec/support/settings_helper.rb

@@ -0,0 +1,46 @@
+def stub_setting_files
+  defaults = <<-CONTENT
+    one: default
+    two:
+      three: 3
+      four: "4"
+    five: "default string"
+    default_setting: 1
+    six:
+      default: "default value"
+      extra: "extra"
+    seven:
+      default: "seven"
+    empty:
+      default:
+    autologin:
+      format: int
+      default: 7
+    flag_false:
+      default: false
+CONTENT
+  test = <<-CONTENT
+    one: test
+    two:
+      three: 5
+      four: "6"
+    five: "test string"
+  CONTENT
+
+  empty = <<-CONTENT
+  CONTENT
+
+  custom = <<-CONTENT
+    seven:
+      default: "seven from custom"
+  CONTENT
+
+  File.stub!(:exists?).and_return(true)
+  File.stub!(:exists?).with("config/settings/environments/development.yml").and_return(false)
+  File.stub!(:open).with("config/settings/default.yml").and_return(defaults)
+  File.stub!(:open).with("config/settings/environments/test.yml").and_return(test)
+  File.stub!(:open).with("config/settings/local/custom.yml").and_return(custom)
+  File.stub!(:open).with("config/settings/local/empty.yml").and_return(empty)
+
+  Dir.stub!(:glob).and_return(["config/settings/local/empty.yml", "config/settings/local/custom.yml"])
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification 
+name: mc-settings
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Edwin Cruz
+- Colin Shield
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-17 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        - 5
+        - 1
+        version: 1.5.1
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+description: implement custom keys indenendently of environment
+email: rubydev@modcloth.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/mc-settings.rb
+- lib/setting.rb
+- spec/mc_settings_spec.rb
+- spec/spec_helper.rb
+- spec/support/settings_helper.rb
+has_rdoc: true
+homepage: http://github.com/modcloth/mc-settings
+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: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Manage settings per environment
+test_files: 
+- spec/mc_settings_spec.rb
+- spec/spec_helper.rb
+- spec/support/settings_helper.rb