youthtree-settings 0.1.0

data/.document

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

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) 2010, Youth Tree
+All rights reserved.
+ 
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+3. All advertising materials mentioning features or use of this software
+   must display the following acknowledgement:
+   This product includes software developed by the Youth Tree.
+4. Neither the name of the Youth Tree nor the
+   names of its contributors may be used to endorse or promote products
+   derived from this software without specific prior written permission.
+ 
+THIS SOFTWARE IS PROVIDED BY YOUTH TREE ''AS IS'' AND ANY
+EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL YOUTH TREE BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,65 @@
+# YouthTree Settings #
+
+## Installation ##
+
+1. Add "gem 'youthtree-settings' to your Gemfile"
+2. Run bundle install
+
+## Usage ##
+
+Simply add the gem,file in your `config/settings.yml`
+and use on the Settings object. Note that you can use:
+
+* `Setting.name` - base
+* `Setting.name.other` - nested
+* `Setting.name.other?` - check for a key
+
+## Configuration ##
+
+Simply put a yaml file in `config/settings.yml`. As an example:
+
+    ---
+    default:
+      some_key: 1
+      nested: true
+    production:
+      google_analytics:
+        identifier: "UA-XXXXXXXX-X"
+      mailer:
+        contact_email: "team@site.com"
+        from: "noreply@site.com"
+        host: "site.com"
+        delivery_method: smtp
+        smtp_settings:
+          address: smtp.gmail.com
+          port: 587
+          authentication: plain
+          enable_starttls_auto: true
+          domain: site.com 
+          user_name: user@site.com
+          password: yourpassword
+    development:
+      mailer:
+        contact_email: "test@site.dev"
+        from: "test@site.dev"
+        host: "localhost:3000"
+        delivery_method: sendmail
+    test:
+      mailer:
+        contact_email: "example@example.com"
+        from: "example@example.com"
+        host: "example.com"
+        delivery_method: test
+
+
+## Note on Patches/Pull Requests ##
+ 
+1. Fork the project.
+2. Make your feature addition or bug fix.
+3. Add tests for it. This is important so I don't break it in a future version unintentionally.
+4. Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+5. Send me a pull request. Bonus points for topic branches.
+
+## Copyright ##
+
+Copyright (c) 2010 Youth Tree. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+require 'active_support'
+require 'active_support/core_ext'
+require File.expand_path('lib/youth_tree/settings', File.dirname(__FILE__))
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name        = "youthtree-settings"
+    gem.summary     = "Simple Settings for Rails Applications"
+    gem.description = %Q{Lets you use config/settings.yml in a rails application to manage settings on a per-env basis.}
+    gem.email       = "sutto@sutto.net"
+    gem.homepage    = "http://github.com/YouthTree/youthtree-settings"
+    gem.authors     = ["Darcy Laycock"]
+    gem.version     = YouthTree::Settings::VERSION
+    gem.add_dependency "activesupport", ">= 3.0.0.beta4"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "youthtree-settings #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/youth_tree/settings.rb

@@ -0,0 +1,141 @@
+require 'yaml'
+
+module YouthTree
+  class Settings
+
+    VERSION = "0.1.0".freeze
+
+    cattr_reader :settings_path
+    def self.settings_path
+      @@settings_path ||= Rails.root.join("config", "settings.yml")
+    end
+
+    def initialize(hash = {})
+      @hash = Hash.new { |h,k| h[k] = self.class.new }
+      hash.each_pair { |k, v| self[k] = v }
+    end
+
+    def to_hash
+      unpack_attr @hash
+    end
+
+    def []=(k, v)
+      @hash[k.to_sym] = normalize_attr(v)
+    end
+
+    def [](k)
+      @hash[k.to_sym]
+    end
+
+    def has?(key)
+      key = key.to_sym
+      @hash.has_key?(key) && @hash[key].present?
+    end
+
+    def blank?
+      @hash.blank?
+    end
+
+    def present?
+      !blank?
+    end
+
+    def method_missing(name, *args, &blk)
+      name = name.to_s
+      key, modifier = name[0..-2], name[-1, 1]
+      case modifier
+      when '?'
+        has?(key)
+      when '='
+        send(:[]=, key, *args)
+      else
+        self[name]
+      end
+    end
+
+    def respond_to?(name, key = false)
+      true
+    end
+
+    class << self
+
+      def load_from_file
+        contents = YAML.load(File.read(self.settings_path))
+        (contents["default"] || {}).deep_merge(contents[Rails.env] || {})
+      end
+
+      def default
+        @@__default ||= begin
+          groups = [load_from_file]
+          self.new(groups.inject({}) { |a,v| a.deep_merge(v) })
+        end
+      end
+
+      def method_missing(name, *args, &blk)
+        default.send(name, *args, &blk)
+      end
+
+      def respond_to?(name, key = false)
+        true
+      end
+
+      def ssl?
+        !disable_ssl? && (force_ssl? || Rails.env.production?)
+      end
+
+      def ssl_protocol
+        ssl? ? "https" : "http"
+      end
+
+      # Sets up ActionMailer to use settings from Settings.
+      def setup_mailer!
+        return unless mailer?
+        s = mailer
+        ActionMailer::Base.default_url_options[:host] = s.host
+        ActionMailer::Base.delivery_method            = s.delivery_method.to_sym
+        ActionMailer::Base.smtp_settings              = s.smtp_settings.to_hash     if s.smtp_settings?
+        ActionMailer::Base.sendmail_settings          = s.sendmail_settings.to_hash if s.sendmail_settings?
+        ActionMailer::Base.default              :from => s.from
+      end
+
+    end
+
+    protected
+
+    def normalize_attr(value)
+      case value
+      when Hash
+        self.class.new(value)
+      when Array
+        value.map { |v| normalize_attr(v) }
+      else
+        value
+      end
+    end
+
+    def unpack_attr(value)
+      case value
+      when self.class
+        value.to_hash
+      when Hash
+        returning({}) do |h|
+          value.each_pair { |k,v| h[k] = unpack_attr(v) }
+        end
+      when Array
+        value.map { |v| unpack_attr(v) }
+      else
+        value
+      end
+    end
+
+  end
+
+  if defined?(Rails::Railtie)
+    class Railtie < Rails::Railtie
+      initializer "youthtree.settings" do
+        YouthTree::Settings.setup_mailer!
+      end
+    end
+  end
+
+end

data/lib/youthtree-settings.rb

@@ -0,0 +1,3 @@
+require 'youth_tree/settings'
+# Alias it in place to just Settings.
+::Settings = YouthTree::Settings

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: youthtree-settings
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Darcy Laycock
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-08 00:00:00 +08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: -1848230024
+        segments: 
+        - 3
+        - 0
+        - 0
+        - beta4
+        version: 3.0.0.beta4
+  type: :runtime
+  version_requirements: *id001
+description: Lets you use config/settings.yml in a rails application to manage settings on a per-env basis.
+email: sutto@sutto.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- lib/youth_tree/settings.rb
+- lib/youthtree-settings.rb
+has_rdoc: true
+homepage: http://github.com/YouthTree/youthtree-settings
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: Simple Settings for Rails Applications
+test_files: []
+