yaml_config_file 0.2.0 → 0.2.2

data/Rakefile

@@ -1,5 +1,6 @@
 require 'rubygems'
 require 'rake'
+require 'rake/rdoctask'
 
 begin
   require 'jeweler'
@@ -10,6 +11,7 @@ begin
     gem.email = "tcravit@taylored-software.com"
     gem.homepage = "http://github.com/tammycravit/yaml_config_file"
     gem.authors = ["Tammy Cravit"]
+    gem.add_dependency "rails", ">= 3.0.0"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new
@@ -17,3 +19,12 @@ rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
 end
 
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  
+  rdoc.title = "yaml_config_file #{version}"
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.2

data/lib/generators/yaml_config_file/yaml_config_file_generator.rb

@@ -1,17 +1,48 @@
+# Generate a YAML configuration file, and an initializer to access the
+# settings stored there.
+#
+# == Structure of the YAML Configuration File
+#
+# The YAML configuration file is a standard YAML file, similar to the
+# standard Rails +database.yml+ file. It contains sections for each
+# Rails environment, as well as a *global* section. The environment-specific
+# section is parsed after the global section, so you can define settings
+# and then override them on an environment-specific basis, like so:
+#
+#    global:
+#      some_setting: false
+#      another_setting: 3
+#   
+#    development:
+#      some_setting: true    # Will be true in development environment, false otherwise
+#
+# The YAML file is also evaluated through ERB, like Rails' database.yml,
+# so you can use ERB blocks in your configuration file. 
+
 class YamlConfigFileGenerator < Rails::Generators::NamedBase
   
   source_root File.expand_path('../templates', __FILE__)
   
+  # Option to skip generation of the YAML file
   class_option :skip_yaml_file, :type => :boolean, :default => false, :description => "Skip generation of the YAML file"
+  
+  # Option to skip generation of the initializer
   class_option :skip_initializer, :type => :boolean, :default => false, :description => "Skip generation of the initializer"  
   
+  # Generates the YAML configuration file.
   def yaml_config_file
     template "config_file.yml", "config/#{gen_file_name}.yml" unless options.skip_yaml_file?
-    template "config_file.rb", "config/initializers/#{gen_file_name}.rb" unless options.skip_initializer?
   end
+
+  # Generates the initializer.
+  def initializer
+    template "config_file.rb", "config/initializers/#{gen_file_name}.rb" unless options.skip_initializer?
+  end  
   
   private
+  
+  # Underscore the file name if it's provided CamelCased.
   def gen_file_name
     file_name.underscore
   end
-end
+end

data/yaml_config_file.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{yaml_config_file}
-  s.version = "0.2.0"
+  s.version = "0.2.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Tammy Cravit"]
@@ -42,9 +42,12 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rails>, [">= 3.0.0"])
     else
+      s.add_dependency(%q<rails>, [">= 3.0.0"])
     end
   else
+    s.add_dependency(%q<rails>, [">= 3.0.0"])
   end
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: yaml_config_file
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: false
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 2
+  version: 0.2.2
 platform: ruby
 authors: 
 - Tammy Cravit
@@ -17,8 +17,23 @@ cert_chain: []
 
 date: 2010-09-24 00:00:00 -07:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id001
 description: YAML Configuration File generator for Rails 3
 email: tcravit@taylored-software.com
 executables: []