figleaf 0.0.1 → 0.0.2

data/.gitignore

@@ -15,7 +15,6 @@
 /spec/tmp/*
 /tmp/*
 /vendor/bundle
-Gemfile.lock
 InstalledFiles
 _yardoc
 capybara-*.html

data/.travis.yml

@@ -0,0 +1,10 @@
+---
+language: ruby
+bundler_args:
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - jruby-19mode
+  - jruby-head
+  - ruby-head
+  - rbx-19mode

data/Gemfile

@@ -1,3 +1,4 @@
 source :rubygems
 
 gemspec
+gem 'hashie', git: 'https://github.com/intridea/hashie.git'

data/Gemfile.lock

@@ -0,0 +1,48 @@
+GIT
+  remote: https://github.com/intridea/hashie.git
+  revision: 8dd0fec950c33373c5c954d7ac72df4724334b12
+  specs:
+    hashie (2.0.0.beta)
+
+PATH
+  remote: .
+  specs:
+    figleaf (0.0.2)
+      activesupport
+      hashie
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.8)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    coderay (1.0.7)
+    diff-lcs (1.1.3)
+    i18n (0.6.0)
+    method_source (0.8)
+    multi_json (1.3.6)
+    pry (0.9.10)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.3.1)
+    rake (0.9.2.2)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.2)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.2)
+    slop (3.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  figleaf!
+  hashie!
+  pry
+  rake
+  rspec

data/README.md

@@ -1,4 +1,6 @@
-# Settings
+# Figleaf
+[![Build Status](https://secure.travis-ci.org/challengepost/figleaf.png?branch=master)](http://travis-ci.org/challengepost/figleaf)
+
 
 YAML based DRY settings manager.
 
@@ -10,7 +12,7 @@ and include in our applications.
 
 Add this line to your application's Gemfile:
 
-    gem 'settings'
+    gem 'figleaf'
 
 And then execute:
 
@@ -18,14 +20,14 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install settings
+    $ gem install figleaf
 
 ## Usage
 
 In `application.rb`:
 
 ```
-Settings.configure_with_auto_define do |s|
+Figleaf::Settings.configure_with_auto_define do |s|
   s.env = Rails.env
   s.some_awesome_flag = true
   s.load_settings
@@ -36,7 +38,7 @@ files.
 
 eg: In `production.rb`
 ```
-Settings.configure do |s|
+Figleaf::Settings.configure do |s|
   s.some_awesome_flag = false
 end
 ```
@@ -57,11 +59,11 @@ production:
   foo: foo
 ```
 
-The Settings parser will create a namespace for your YAML file after the file
+The Figleaf::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`,
+access `foo` as `Figleaf::Settings.mysetting["foo"]`. (Inspired by Rails' `database.yml`,
 of course.)
 
 ## Contributing

data/figleaf.gemspec

@@ -15,9 +15,10 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = Figleaf::VERSION
 
-  %w(rake rspec).each do |g|
+  %w(rake rspec pry).each do |g|
     gem.add_development_dependency(g)
   end
 
   gem.add_dependency("activesupport")
+  gem.add_dependency("hashie")
 end

data/lib/figleaf/configuration.rb

@@ -0,0 +1,54 @@
+module Figleaf
+  module Configuration
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :auto_define
+      self.auto_define = false
+    end
+
+    module ClassMethods
+      def 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 configure
+        self.auto_define.tap do |cached_auto_define|
+          self.auto_define = false
+          yield self
+          self.auto_define = cached_auto_define
+        end
+      end
+
+      def 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 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 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
+    end
+  end
+end

data/lib/figleaf/fighash.rb

@@ -0,0 +1,7 @@
+module Figleaf
+  class Fighash < Hash
+    include Hashie::Extensions::IndifferentAccess
+    include Hashie::Extensions::MergeInitializer
+    include Hashie::Extensions::MethodAccess
+  end
+end

data/lib/figleaf/load_settings.rb

@@ -0,0 +1,40 @@
+require 'pry'
+module Figleaf
+  module LoadSettings
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      # 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 load_settings
+        Dir.glob(root.join('config', 'settings', '*.yml')).each do |file|
+          property_name = File.basename(file, '.yml')
+          property = YAML.load_file(file)[env]
+          property = use_hashie_if_hash(property)
+          self.configure_with_auto_define do |s|
+            s.send("#{property_name}=", property)
+          end
+        end
+      end
+
+      def root
+        return Rails.root if defined?(Rails)
+        Pathname.new('.')
+      end
+
+      def env
+        return Rails.env if defined?(Rails)
+        ENV['ENVIRONMENT']
+      end
+
+      def use_hashie_if_hash(property)
+        return Figleaf::Fighash.new(property) if property.is_a?(Hash)
+        property
+      end
+    end
+  end
+end

data/lib/figleaf/settings.rb

@@ -1,78 +1,6 @@
-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
+    include Figleaf::Configuration
+    include Figleaf::LoadSettings
   end
 end

data/lib/figleaf/version.rb

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

data/lib/figleaf.rb

@@ -1,4 +1,13 @@
+require 'active_support/concern'
+require 'active_support/core_ext/class'
+require 'hashie'
+require 'pathname'
+require 'yaml'
+
 module Figleaf
+  autoload :Fighash, 'figleaf/fighash'
+  autoload :Configuration, 'figleaf/configuration'
+  autoload :LoadSettings, 'figleaf/load_settings'
   autoload :Settings, 'figleaf/settings'
   autoload :VERSION, 'figleaf/version'
 end

data/spec/settings_spec.rb

@@ -79,14 +79,76 @@ describe Figleaf::Settings do
     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"})
+  describe "self.load_settings" do
+    let(:configuration) {
+      {
+        "test" => {
+          "foo" => "bar",
+          "bool_true" => true,
+          "bool_false" => false
+        }
+      }
+    }
+
+    before do
+      Dir.stub(:glob).and_return(["config/described_class/some_service.yml"])
+      described_class.stub(:env).and_return("test")
+      YAML.stub(:load_file).and_return(configuration)
+
+      described_class.load_settings
+    end
+
+    it "should load some service" do
+      described_class.some_service["foo"].should == "bar"
+    end
+
+    it "should load indifferently the key names" do
+      described_class.some_service["foo"].should == "bar"
+      described_class.some_service[:foo].should == "bar"
+    end
+
+    it "should create foo as a method" do
+      described_class.some_service.foo.should == "bar"
+    end
+
+    it "should create bool_true? and return true" do
+      described_class.some_service.bool_true?.should be_true
+    end
+
+    it "should create bool_false? and return false" do
+      described_class.some_service.bool_false?.should be_false
+    end
+
+    it "should work for arrays as well" do
+      YAML.stub(:load_file).and_return({ "test" => [1, 2] })
+      described_class.load_settings
+      described_class.some_service.should == [1, 2]
+    end
+
+    it "and for plain strings" do
+      YAML.stub(:load_file).and_return({ "test" => "Hello, World!" })
+      described_class.load_settings
+      described_class.some_service.should == "Hello, World!"
+    end
+
+    it "and for booleans (true)" do
+      YAML.stub(:load_file).and_return({ "test" => true })
       described_class.load_settings
-      described_class.some_service.should == "foo"
+      described_class.some_service.should be_true
     end
+
+    it "and for booleans (false)" do
+      YAML.stub(:load_file).and_return({ "test" => false })
+      described_class.load_settings
+      described_class.some_service.should be_false
+    end
+
+    it "should raise exception when loading an undefined value" do
+      YAML.stub(:load_file).and_return({ "test" => {} })
+      described_class.load_settings
+      expect { described_class.some_service.blah }.to raise_error NoMethodError
+    end
+
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: figleaf
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-13 00:00:00.000000000 Z
+date: 2012-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -43,6 +43,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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
@@ -59,6 +75,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  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
@@ -68,12 +100,17 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
 - figleaf.gemspec
 - lib/figleaf.rb
+- lib/figleaf/configuration.rb
+- lib/figleaf/fighash.rb
+- lib/figleaf/load_settings.rb
 - lib/figleaf/settings.rb
 - lib/figleaf/version.rb
 - spec/settings_spec.rb
@@ -90,12 +127,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -1491263342896218815
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -1491263342896218815
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24