figleaf 0.0.1

data/.gitignore

@@ -0,0 +1,32 @@
+**.orig
+*.gem
+*.rbc
+*.sassc
+.bundle
+.config
+.rspec
+.sass-cache
+.yardoc
+/.bundle
+/coverage/
+/db/*.sqlite3
+/log/*
+/public/system/*
+/spec/tmp/*
+/tmp/*
+/vendor/bundle
+Gemfile.lock
+InstalledFiles
+_yardoc
+capybara-*.html
+coverage
+doc/
+lib/bundler/man
+pickle-email-*.html
+pkg
+rdoc
+rerun.txt
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Juan C. Müller
+
+MIT License
+
+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.md

@@ -0,0 +1,73 @@
+# Settings
+
+YAML based DRY settings manager.
+
+The YAML expansion functionality came about by our getting tired of having to
+create a YAML file and then create an initializer that would expand such file
+and include in our applications.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'settings'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install settings
+
+## Usage
+
+In `application.rb`:
+
+```
+Settings.configure_with_auto_define do |s|
+  s.env = Rails.env
+  s.some_awesome_flag = true
+  s.load_settings
+end
+```
+Then, you can override any particular setting inside your environments/*.rb
+files.
+
+eg: In `production.rb`
+```
+Settings.configure do |s|
+  s.some_awesome_flag = false
+end
+```
+etc...
+
+Also, it provides the ability for you to define all your environment dependent
+settings in just one YAML file inside `config/settings/`. The anatomy of these
+files should be:
+
+```
+development:
+  foo: bar
+
+test:
+  foo: flob
+
+production:
+  foo: foo
+```
+
+The Settings parser will create a namespace for your YAML file after the file
+name.
+
+Then, assuming that you named your YAML file `mysetting.yml`. you can just
+access `foo` as `Settings.mysetting["foo"]`. (Inspired by Rails' `database.yml`,
+of course.)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,21 @@
+#!/usr/bin/env rake
+
+$:.push File.expand_path("../lib", __FILE__)
+
+require "rspec/core/rake_task"
+require "bundler/gem_tasks"
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = "spec/**/*_spec.rb"
+end
+
+desc "Clean backup and swap files, and artifacts"
+task :clean do
+  require "fileutils"
+  Dir["{pkg/*,**/*~,**/.*.sw?,coverage/**,spec/reports/**}"].each do |file|
+    rm_rf file
+  end
+end
+
+desc "Run rspec by default"
+task :default => :spec

data/figleaf.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/figleaf/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Juan C. Müller"]
+  gem.email         = ["jcmuller@gmail.com"]
+  gem.description   = %q{YAML based DRY settings manager.}
+  gem.summary       = %q{YAML based DRY settings manager.}
+  gem.homepage      = "http://github.com/challengepost/figleaf"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "figleaf"
+  gem.require_paths = ["lib"]
+  gem.version       = Figleaf::VERSION
+
+  %w(rake rspec).each do |g|
+    gem.add_development_dependency(g)
+  end
+
+  gem.add_dependency("activesupport")
+end

data/lib/figleaf/settings.rb

@@ -0,0 +1,78 @@
+require 'yaml'
+require 'active_support/core_ext/class'
+require 'pathname'
+
+module Figleaf
+  class Settings
+    class_attribute :auto_define
+    self.auto_define = false
+
+    def self.configure_with_auto_define
+      self.auto_define.tap do |cached_auto_define|
+        self.auto_define = true
+        yield self
+        self.auto_define = cached_auto_define
+      end
+    end
+
+    def self.configure
+      self.auto_define.tap do |cached_auto_define|
+        self.auto_define = false
+        yield self
+        self.auto_define = cached_auto_define
+      end
+    end
+
+    def self.override_with_local!(local_file)
+      #this file (i.e. test.local.rb) is an optional place to put settings
+      local_file.tap do |local_settings_path|
+        eval(IO.read(local_settings_path), binding) if File.exists?(local_settings_path)
+      end
+    end
+
+    def self.method_missing(method_name, *args)
+      if self.auto_define && method_name.to_s =~ /=$/ && args.length == 1
+        self.define_cattr_methods(method_name)
+        self.send(method_name, args.shift)
+      else
+        super
+      end
+    end
+
+    def self.define_cattr_methods(setter_name)
+      getter_name = setter_name.to_s.gsub('=','')
+
+      cattr_writer getter_name
+      define_singleton_method(getter_name) do
+        result = class_variable_get "@@#{getter_name}"
+        result.respond_to?(:call) ? result.call : result
+      end
+    end
+
+    # Load all files in config/settings and set their contents as first level
+    # citizen of Settings:
+    # config/settings/some_service.yml contains
+    # production:
+    #   foo: bar
+    # --> Settings.some_service.foo = bar
+    def self.load_settings
+      Dir.glob(root.join('config', 'settings', '*.yml')).each do |file|
+        property_name = File.basename(file, '.yml')
+        property = YAML.load_file(file)[env]
+        configure_with_auto_define do |s|
+          s.send("#{property_name}=", property)
+        end
+      end
+    end
+
+    def self.root
+      return Rails.root if defined?(Rails)
+      Pathname.new('.')
+    end
+
+    def self.env
+      return Rails.env if defined?(Rails)
+      ENV['ENVIRONMENT']
+    end
+  end
+end

data/lib/figleaf/version.rb

@@ -0,0 +1,3 @@
+module Figleaf
+  VERSION = '0.0.1'
+end

data/lib/figleaf.rb

@@ -0,0 +1,4 @@
+module Figleaf
+  autoload :Settings, 'figleaf/settings'
+  autoload :VERSION, 'figleaf/version'
+end

data/spec/settings_spec.rb

@@ -0,0 +1,92 @@
+require 'spec_helper'
+require 'figleaf'
+
+describe Figleaf::Settings do
+
+  describe "setters and getters" do
+    context "auto define enabled" do
+      before(:each) do
+        described_class.auto_define = true
+      end
+      it "should auto define methods and set initial value when setter used" do
+        described_class.fictional_feature_enabled = :on
+        described_class.fictional_feature_enabled.should == :on
+      end
+
+      it "should return result of proc when set as a proc" do
+        described_class.call_this_proc = -> { 3 }
+        described_class.call_this_proc.should == 3
+      end
+    end
+
+    context "auto define disabled" do
+      before(:each) do
+        described_class.auto_define = true
+        described_class.fictional_feature_enabled = :on
+        described_class.auto_define = false
+      end
+      it "should not auto defined setters and getters" do
+        lambda {
+          described_class.undefined_setting = :raises_error
+        }.should raise_error
+
+        lambda {
+          described_class.undefined_setting
+        }.should raise_error
+      end
+
+      it "should set/get previous defined attributes" do
+        described_class.fictional_feature_enabled.should eq(:on)
+
+        described_class.fictional_feature_enabled = :off
+        described_class.fictional_feature_enabled.should eq(:off)
+      end
+    end
+  end
+
+  describe "self.configure_with_auto_define" do
+    it "should accept new setter values in block form" do
+      described_class.configure_with_auto_define do |s|
+        s.another_fictional_feature_mode = :admin
+        s.enable_fictional_activity_feed = true
+      end
+
+      described_class.another_fictional_feature_mode.should eq(:admin)
+      described_class.enable_fictional_activity_feed.should be_true
+    end
+  end
+
+  describe "self.configure" do
+    before(:each) do
+      described_class.auto_define = true
+      described_class.fictional_feature_enabled = :on
+    end
+
+    it "should only allow setting of values for previously defined attributes" do
+      described_class.configure do |s|
+        s.fictional_feature_enabled = :off
+      end
+
+      described_class.fictional_feature_enabled.should == :off
+    end
+
+    it "should only allow setting of values for previously defined attributes" do
+      lambda {
+        described_class.configure do |s|
+          s.undefined_setting = :should_raise_error
+        end
+      }.should raise_error
+    end
+  end
+
+  describe "self.load_described_class" do
+    it "should load google analytics" do
+      Dir.should_receive(:glob).and_return(["config/described_class/some_service.yml"])
+      described_class.should_receive(:env).and_return("test")
+      YAML.should_receive(:load_file).and_return({"test" => "foo"})
+      described_class.load_settings
+      described_class.some_service.should == "foo"
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+
+require "rspec/core"
+require "rspec/mocks"
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: figleaf
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Juan C. Müller
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: YAML based DRY settings manager.
+email:
+- jcmuller@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- figleaf.gemspec
+- lib/figleaf.rb
+- lib/figleaf/settings.rb
+- lib/figleaf/version.rb
+- spec/settings_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/challengepost/figleaf
+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: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: YAML based DRY settings manager.
+test_files:
+- spec/settings_spec.rb
+- spec/spec_helper.rb