merb-plugins-app-config 0.3

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 YOUR NAME
+
+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

@@ -0,0 +1,83 @@
+== Summary
+Application level configuration.
+
+== Original Author
+Christopher J. Bottaro
+
+== Merb Port
+Jacques Crocker
+
+=== Accessing the AppConfig object
+After installing this plugin, the AppConfig object will be global available.  Entries are accessed via object member notation:
+ AppConfig.my_config_entry
+Nested entries are supported:
+ AppConfig.my_section.some_entr
+
+=== Common config file
+Config entries defined in
+ Merb.root/config/app_config/settings.yml
+will be available to all environments.
+
+=== Environment specific config files
+You can have environment specific config files.  Environment specific config entries take precedence over common config entries.
+
+Example development environment config file:
+ Merb.root/config/app_config/development.yml
+ 
+Example production environment config file:
+ Merb.root/config/app_config/production.yml
+
+=== Embedded Ruby (ERB)
+ Embedded Ruby is allowed in the configuration files.  See examples below.
+
+== Easy Stylesheets and Javascripts
+You can also define your javascripts and stylesheets using AppConfig
+
+Merb.root/config/javascripts.yml
+Merb.root/config/stylesheets.yml
+
+prototype:
+  - prototype
+  - scriptaculous
+  
+jquery:
+  - jquery
+  - jquery.ui/tabs
+  
+components:
+  - components/blah
+  - components/blah2
+
+This will include all the javasciprt files listed when running the helper "javascripts", and on prod, it will bundle them up by key (prototype-bundle.js, jquery-bundle.js, components-bundle.js)
+
+In your application layout, just include the calls to
+<%= stylesheets %>
+<%= javascripts %>
+
+=== Examples
+Consider the two following config files.
+
+Merb.root/config/app_config.yml:
+ size: 1
+ server: google.com
+
+Merb.root/config/app_config/development.yml:
+ size: 2
+ computed: <%= 1 + 2 + 3 %>
+ section:
+   size: 3
+   servers: [ {name: yahoo.com}, {name: amazon.com} ]
+
+Notice that the environment specific config entries overwrite the common entries.
+ AppConfig.size -> 2
+ AppConfig.server -> google.com
+
+Notice the embedded Ruby.
+ AppConfig.computed -> 6
+
+Notice that object member notation is maintained even in nested entries.
+ AppConfig.section.size -> 3
+
+Notice array notation and object member notation is maintained.
+ AppConfig.section.servers[0].name -> yahoo.com
+ AppConfig.section.servers[1].name -> amazon.com

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+
+require 'merb-core'
+require 'merb-core/tasks/merb'
+
+GEM_NAME = "merb-plugins-app-config"
+GEM_VERSION = "0.3"
+AUTHOR = "Jacques Crocker"
+EMAIL = "merbjedi@gmail.com"
+HOMEPAGE = "http://www.merbjedi.com/"
+SUMMARY = "Merb plugin that provides easy to use Application Configurations via YAML"
+
+spec = Gem::Specification.new do |s|
+  s.rubyforge_project = 'merb'
+  s.name = GEM_NAME
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README", "LICENSE"]
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  s.add_dependency('merb', '>= 1.0')
+  s.add_dependency('merb-assets', '>= 1.0')
+  s.require_path = 'lib'
+  s.files = %w(LICENSE README Rakefile) + Dir.glob("{lib,spec}/**/*")
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "install the plugin as a gem"
+task :install do
+  Merb::RakeHelper.install(GEM_NAME, :version => GEM_VERSION)
+end
+
+desc "Uninstall the gem"
+task :uninstall do
+  Merb::RakeHelper.uninstall(GEM_NAME, :version => GEM_VERSION)
+end
+
+desc "Create a gemspec file"
+task :gemspec do
+  File.open("#{GEM_NAME}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end
+
+require 'lib/merbtasks'

data/lib/application_config/config_builder.rb

@@ -0,0 +1,45 @@
+require 'ostruct'
+require 'yaml'
+require 'erb'
+
+module ApplicationConfig
+  # == Summary
+  # This is API documentation, NOT documentation on how to use this plugin.  For that, see the README.
+  class ConfigBuilder
+  
+    # Create a config object (OpenStruct) from a yaml file.  If a second yaml file is given, then the sections of that file will overwrite the sections
+    # if the first file if they exist in the first file.
+    def self.load_files(*conf_load_paths)
+      @@conf_paths = []
+      @@conf_paths << conf_load_paths
+      @@conf_paths.flatten!.uniq!
+      return reload
+    end
+  
+    def self.reload
+      conf = {}
+      @@conf_paths.to_a.each do |path|
+        new_conf = YAML.load(ERB.new(IO.read(path)).result) if path and File.exists?(path)
+        conf.merge!(new_conf) if new_conf
+      end
+      return convert(conf)
+    end
+  
+    # Recursively converts Hashes to OpenStructs (including Hashes inside Arrays)
+    def self.convert(h) #:nodoc:
+      s = OpenStruct.new
+      h.each do |k, v|
+        s.new_ostruct_member(k)
+        if v.instance_of?(Hash)
+          s.send( (k+'=').to_sym, convert(v))
+        elsif v.instance_of?(Array)
+          converted_array = v.collect { |e| e.instance_of?(Hash) ? convert(e) : e }
+          s.send("#{k}=".to_sym, converted_array)
+        else
+          s.send("#{k}=".to_sym, v)
+        end
+      end
+      s
+    end
+  end
+end

data/lib/application_config/view_helpers.rb

@@ -0,0 +1,20 @@
+module ApplicationConfig
+  module ViewHelpers
+    def javascripts
+      js_hash = AppConfigJavascripts.marshal_dump
+      js_hash.each do |key, val|
+        require_js val, :bundle => key.to_sym
+      end
+      include_required_js
+    end
+  
+    def stylesheets
+      style_hash = AppConfigStylesheets.marshal_dump
+      style_hash.each do |key, val|
+        require_css val, :bundle => key.to_sym
+      end
+      
+      include_required_css
+    end
+  end
+end

data/lib/merb-plugins-app-config.rb

@@ -0,0 +1,36 @@
+require 'application_config/config_builder'
+require 'application_config/view_helpers'
+
+# make sure we're running inside Merb
+if defined?(Merb::Plugins)
+  # Merb gives you a Merb::Plugins.config hash...feel free to put your stuff in your piece of it
+  Merb::Plugins.config[:app_config] = {
+    :auto_reload => false,
+    :include_viewhelpers => true
+  }
+  
+  Merb::BootLoader.before_app_loads do
+    ::AppConfig = ApplicationConfig::ConfigBuilder.load_files(Merb.root+"/config/app_config/settings.yml",
+                                                              Merb.root+"/config/app_config/#{Merb.env}.yml")
+
+    if Merb::Plugins.config[:app_config][:include_viewhelpers]
+      ::AppConfigStylesheets = ApplicationConfig::ConfigBuilder.load_files(Merb.root+"/config/app_config/stylesheets.yml")
+      ::AppConfigJavascripts = ApplicationConfig::ConfigBuilder.load_files(Merb.root+"/config/app_config/javascripts.yml")
+    end
+
+    # add reload method to our ostruct
+    def AppConfig.reload!
+      AppConfig.marshal_load(ApplicationConfig::ConfigBuilder.reload.marshal_dump)
+      return AppConfig
+    end
+    
+    if Merb::Plugins.config[:app_config][:include_viewhelpers]
+      Merb::Controller.send(:include, ApplicationConfig::ViewHelpers)
+    end
+  end
+  
+  # Merb::BootLoader.after_app_loads do
+  # end
+  
+  Merb::Plugins.add_rakefiles "merbtasks"
+end

data/lib/merbtasks.rb

@@ -0,0 +1,17 @@
+namespace :app_config do
+  desc "Create a blank config/app_config.yml file"
+  task :init do
+    puts "Setting up AppConfig files..."
+    `mkdir -p config/app_config`
+    
+    ["config/app_config/settings.yml",
+     "config/app_config/development.yml",
+     "config/app_config/production.yml"
+    ].each do |path|
+      `touch #{path}`
+      puts "Created: #{path}"
+    end
+    puts "Complete!"
+    puts "Add key/value pairs to your yaml file,\nthen access them in your Merb project via AppConfig.[key]"
+  end
+end

data/spec/app_config_spec.rb

@@ -0,0 +1,46 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require 'merb-plugins-app-config'
+
+describe "AppConfig Plugin" do
+  before(:each) do
+    @settings_path = "spec/test_configs"
+  end
+  
+  it "should load a common app config with simple settings" do
+    config = ApplicationConfig::ConfigBuilder.load_files("#{@settings_path}/app_config.yml")
+    config.size.should == 1
+    config.server.should == "google.com"
+  end
+  
+  it "should allow environment overrides" do
+    config = ApplicationConfig::ConfigBuilder.load_files("#{@settings_path}/app_config.yml", "#{@settings_path}/development.yml")
+    config.size.should == 2
+    config.server.should == "google.com"    
+  end
+  
+  it "should allow nested sets of configurations" do
+    config = ApplicationConfig::ConfigBuilder.load_files("#{@settings_path}/development.yml")
+    config.section.size.should == 3
+  end
+
+  it "should allow array definitions in settings" do
+    config = ApplicationConfig::ConfigBuilder.load_files("#{@settings_path}/development.yml")
+    config.section.servers[0].name.should == "yahoo.com"
+    config.section.servers[1].name.should == "amazon.com"
+  end
+
+  it "should not crash on missing files" do
+    config = ApplicationConfig::ConfigBuilder.load_files("#{@settings_path}/nothing_here.yml", "#{@settings_path}/nothing_here2.yml")
+    config.should == OpenStruct.new
+  end
+
+  it "should allow erb in settings" do
+    config = ApplicationConfig::ConfigBuilder.load_files("#{@settings_path}/development.yml")
+    config.computed.should == 6
+  end
+  
+  it "should not crash on empty files" do
+    config = ApplicationConfig::ConfigBuilder.load_files("#{@settings_path}/empty1.yml", "#{@settings_path}/empty2.yml")
+    config.should == OpenStruct.new
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+$:.push File.join(File.dirname(__FILE__), '..', 'lib')

data/spec/test_configs/app_config.yml

@@ -0,0 +1,2 @@
+size: 1
+server: google.com

data/spec/test_configs/development.yml

@@ -0,0 +1,5 @@
+size: 2
+computed: <%= 1 + 2 + 3 %>
+section:
+  size: 3
+  servers: [ {name: yahoo.com}, {name: amazon.com} ]

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: merb-plugins-app-config
+version: !ruby/object:Gem::Version 
+  version: "0.3"
+platform: ruby
+authors: 
+- Jacques Crocker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-15 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: merb
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "1.0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: merb-assets
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "1.0"
+    version: 
+description: Merb plugin that provides easy to use Application Configurations via YAML
+email: merbjedi@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+files: 
+- LICENSE
+- README
+- Rakefile
+- lib/application_config
+- lib/application_config/config_builder.rb
+- lib/application_config/view_helpers.rb
+- lib/merb-plugins-app-config.rb
+- lib/merbtasks.rb
+- spec/app_config_spec.rb
+- spec/spec_helper.rb
+- spec/test_configs
+- spec/test_configs/app_config.yml
+- spec/test_configs/development.yml
+- spec/test_configs/empty1.yml
+- spec/test_configs/empty2.yml
+has_rdoc: true
+homepage: http://www.merbjedi.com/
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: merb
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: Merb plugin that provides easy to use Application Configurations via YAML
+test_files: []
+