hopsoft-fig 0.8.5 → 1.0.0

data/.document

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

data/.gitignore

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

data/{MIT-LICENSE → LICENSE}

@@ -1,4 +1,4 @@
-Copyright (c) 2008 Hopsoft LLC
+Copyright (c) 2009 Nathan Hopkins
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -2,14 +2,13 @@
 
 ===DRY up those magic numbers and hard coded strings into something more managable.  Fig is the smart way to manage stuff that really belongs in a config file instead of scattered throughout your code.
 
-Here are the Rdocs[http://hopsoft.github.com/fig/README.rdoc.html]
-Video tutorial coming soon...
+Read the RDocs[http://hopsoft.github.com/fig/README.rdoc.html] or jump right in with the tutorial video[http://www.screencast.com/t/WwhGvspEy].
 
 ==Why
 
 Even though Ruby is a dynamic language and hard coded values aren't as big a deal, it's still good practice to have a centralized place to hold certain settings.
 
-In the past I would use a globally available Hash to store this stuff, but have always wanted something more powerful and elegant.
+In the past I used a global Hash to store this stuff, but have always wanted something more powerful and elegant.
 
 
 ==What
@@ -30,7 +29,6 @@ The primary features are:
 The simplest way to get started is to watch the 10 minute tutorial.
 
 
-
 ===Installation
 
 Fig is availabe as both a Gem and as a Rails Plugin.
@@ -50,32 +48,26 @@ Second, install the Gem.
 ===Usage
 Create a YAML file that will serve as one of the configuration files you plan to use.  In a Rails application, I usually create the file config/app.yml, but you can name the file anything you like and can save it to any location within your appliation or library.
 
-Require Fig either explicitly or implicitly.  In a Rails application, I generally do this in environment.rb. Note: this step isn't required if you installed as a Rails plugin.
-  # implicit
-  require 'hopsoft/fig'
-  # explicit
-  gem 'hopsoft-fig'
-
 Instantiate a Fig object that is globally available to your application.  In a Rails application, I generally do this in environment.rb.
-  APP_CONFIG = Hopsoft::Fig.new(RAILS_ROOT + '/config/app.yml')
+  CONFIG = Hopsoft::Fig.new(RAILS_ROOT + '/config/app.yml')
 
 Start using your settings.
-  puts APP_CONFIG.settings.message
-  puts APP_CONFIG.yaml['message']
-  puts APP_CONFIG.get_setting('message')
+  puts CONFIG.settings.message
+  puts CONFIG.yaml['message']
+  puts CONFIG.get_setting('message')
 
   # returns nil instead of an error when the setting doesn't exist
-  puts APP_CONFIG.get_setting('some.nested.setting.that.may.not.exist')
+  puts CONFIG.get_setting('some.nested.setting.that.may.not.exist')
   
 Reuse settings in your YAML file (This is a great way to apply the DRY principle to your configuration settings):
   name: Nathan Hopkins
   message: Hello from {fig:name}.
  
-  puts APP_CONFIG.get_setting('message')
+  puts CONFIG.get_setting('message')
   # outputs -> Hello from Nathan Hopkins.
 
 Update the YAML file and load the changes without restarting your application.
-  APP_CONFIG.load
+  CONFIG.load
 
 
 Copyright (c) 2008 Hopsoft LLC, released under the MIT license

data/Rakefile

@@ -1,13 +1,55 @@
-require 'echoe'
+require 'rubygems'
+require 'rake'
 
-Echoe.new('fig', '0.8.5') do |p|
-  p.description = "The smart way to manage configuration settings for your Ruby applications."
-  p.url = "http://github.com/hopsoft/fig"
-  p.author = "Nathan Hopkins, Hopsoft LLC"
-  p.email = "natehop@gmail.com"
-  p.ignore_pattern = ["nbproject*"]
-  p.development_dependencies = []
-  puts p.class
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "hopsoft-fig"
+    gem.summary = "Easy & powerful configuration utility"
+    gem.description = <<-DESC
+      Easy & powerful configuration for your Ruby applications.
+      Similar to settingslogic with a slightly different approach and a few more features.
+    DESC
+    gem.email = "natehop@gmail.com"
+    gem.homepage = "http://github.com/hopsoft/fig"
+    gem.authors = ["Nathan Hopkins"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # 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
 
-Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each {|file| load file}
+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 = "fig #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/hopsoft/fig.rb

@@ -1,11 +1,11 @@
 require 'yaml'
 require 'ostruct'
 require 'thread'
-require File.dirname(__FILE__) + '/../string'
+require File.join(File.dirname(__FILE__), 'string')
 
 module Hopsoft
   class Fig
- 
+
     # Constructor...
     #
     # ====Params
@@ -97,18 +97,18 @@ module Hopsoft
         pattern = /\{fig:/i
         start = value.index(pattern, 0)
         replace = {}
-      
+
         while start
           finish = value.index(/\}/, start)
           key = value[(start + 1)..(finish - 1)]
           replace[key] = eval("yaml['#{key.sub(/^fig:/i, "").gsub(/\./, "']['")}'].to_s")
           start = value.index(pattern, finish)
         end
-      
+
         value.interpolate(replace, true)
       end
     end
-  
+
     # Recursively adds a hash to an OpenStruct object, ultimately creating a complete OpenStruct object with attributes
     # for all key/value pairs in the Hash.
     #
@@ -127,6 +127,6 @@ module Hopsoft
         end
       end
     end
-   
+
   end
 end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'fig2'
+
+class Test::Unit::TestCase
+end

data/test/{fig_test.rb → test_fig.rb}

@@ -1,9 +1,9 @@
 require 'test/unit'
 require 'fileutils'
-require File.dirname(__FILE__) + '/../lib/hopsoft/fig'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'hopsoft', 'fig')
 
 class FigTest < Test::Unit::TestCase
-  @@fig = Hopsoft::Fig.new(File.dirname(__FILE__) + '/test.yml')
+  @@fig = Hopsoft::Fig.new('test.yml')
   
   def test_yaml_values
     assert @@fig.yaml
@@ -49,11 +49,15 @@ class FigTest < Test::Unit::TestCase
     assert @@fig.get_setting('some.complete.garbage') == nil
   end
 
+  def test_nested_interpolation
+    assert_equal 'Hi there Nathan Hopkins', @@fig.get_setting('parent.child.message')    
+  end
+
   def test_change_and_reload
     dir_name = File.dirname(__FILE__)
-    orig_file = dir_name + '/test.yml'
-    new_file = dir_name + '/test2.yml'
-    bak_file = dir_name + '/test.yml.bak'
+    orig_file = File.join(dir_name, 'test.yml')
+    new_file = File.join(dir_name, 'test2.yml')
+    bak_file = File.join(dir_name, 'test.yml.bak')
 
     # make a backup
     FileUtils.rm(bak_file) if File.exist?(bak_file)

data/test/{string_test.rb → test_string.rb}

@@ -1,5 +1,5 @@
 require 'test/unit'
-require File.dirname(__FILE__) + '/../lib/string'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'hopsoft', 'string')
 
 class StringTest < Test::Unit::TestCase
 

metadata

@@ -1,55 +1,53 @@
 --- !ruby/object:Gem::Specification 
 name: hopsoft-fig
 version: !ruby/object:Gem::Version 
-  version: 0.8.5
+  version: 1.0.0
 platform: ruby
 authors: 
-- Nathan Hopkins, Hopsoft LLC
+- Nathan Hopkins
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-03-18 00:00:00 -07:00
+date: 2009-10-21 00:00:00 -06:00
 default_executable: 
-dependencies: []
-
-description: The smart way to manage configuration settings for your Ruby applications.
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: "      Easy & powerful configuration for your Ruby applications.\n      Similar to settingslogic with a slightly different approach and a few more features.\n"
 email: natehop@gmail.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- lib/hopsoft/fig.rb
-- lib/string.rb
+- LICENSE
 - README.rdoc
-- tasks/fig_tasks.rake
 files: 
-- fig.gemspec
-- init.rb
-- install.rb
-- lib/hopsoft/fig.rb
-- lib/string.rb
-- Manifest
-- MIT-LICENSE
-- Rakefile
+- .document
+- .gitignore
+- LICENSE
 - README.rdoc
-- tasks/fig_tasks.rake
-- test/fig_test.rb
-- test/string_test.rb
-- test/test.yml
-- test/test2.yml
-- uninstall.rb
+- Rakefile
+- VERSION
+- lib/hopsoft/fig.rb
+- lib/hopsoft/string.rb
+- test/helper.rb
 has_rdoc: true
 homepage: http://github.com/hopsoft/fig
+licenses: []
+
 post_install_message: 
 rdoc_options: 
-- --line-numbers
-- --inline-source
-- --title
-- Fig
-- --main
-- README.rdoc
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -62,15 +60,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      version: "1.2"
+      version: "0"
   version: 
 requirements: []
 
-rubyforge_project: fig
-rubygems_version: 1.2.0
+rubyforge_project: 
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
-summary: The smart way to manage configuration settings for your Ruby applications.
+specification_version: 3
+summary: Easy & powerful configuration utility
 test_files: 
-- test/fig_test.rb
-- test/string_test.rb
+- test/test_fig.rb
+- test/helper.rb
+- test/test_string.rb

data/fig.gemspec

@@ -1,32 +0,0 @@
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = %q{fig}
-  s.version = "0.8.5"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Nathan Hopkins, Hopsoft LLC"]
-  s.date = %q{2009-03-18}
-  s.description = %q{The smart way to manage configuration settings for your Ruby applications.}
-  s.email = %q{natehop@gmail.com}
-  s.extra_rdoc_files = ["lib/hopsoft/fig.rb", "lib/string.rb", "README.rdoc", "tasks/fig_tasks.rake"]
-  s.files = ["fig.gemspec", "init.rb", "install.rb", "lib/hopsoft/fig.rb", "lib/string.rb", "Manifest", "MIT-LICENSE", "Rakefile", "README.rdoc", "tasks/fig_tasks.rake", "test/fig_test.rb", "test/string_test.rb", "test/test.yml", "test/test2.yml", "uninstall.rb"]
-  s.has_rdoc = true
-  s.homepage = %q{http://github.com/hopsoft/fig}
-  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Fig", "--main", "README.rdoc"]
-  s.require_paths = ["lib"]
-  s.rubyforge_project = %q{fig}
-  s.rubygems_version = %q{1.3.1}
-  s.summary = %q{The smart way to manage configuration settings for your Ruby applications.}
-  s.test_files = ["test/fig_test.rb", "test/string_test.rb"]
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 2
-
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-    else
-    end
-  else
-  end
-end

data/init.rb

@@ -1,2 +0,0 @@
-require 'string'
-require 'hopsoft/fig'

data/install.rb

@@ -1 +0,0 @@
-# Install hook code here

data/tasks/fig_tasks.rake

@@ -1,4 +0,0 @@
-# desc "Explaining what the task does"
-# task :fig do
-#   # Task goes here
-# end

data/test/test.yml

@@ -1,9 +0,0 @@
-name: Nathan Hopkins
-message: Hello there {fig:name}
-message2: Hello there {fig:name2}
-name2: Page Hopkins
-list: [a, b, c, d, e, f]
-parent:
-  name: '{fig:name}'
-  child:
-    name: Emma Hopkins

data/test/test2.yml

@@ -1,9 +0,0 @@
-name: Jeff Hopkins
-message: Hello there {fig:name}
-message2: Hello there {fig:name2}
-name2: Marie Hopkins
-list: [a, b, c, d, e, f]
-parent:
-  name: '{fig:name}'
-  child:
-    name: Nathan Hopkins

data/uninstall.rb

@@ -1 +0,0 @@
-# Uninstall hook code here