merb_app_config 1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Jacques Crocker
+
+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,90 @@
+== Summary
+Application level configuration.
+
+== Author
+Jacques Crocker
+Modified from Original Project (AppConfig by Christopher J. Bottaro)
+
+=== Compatibility
+Rails 2.1/2.2 and Merb 1.0
+
+=== 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_entry
+
+=== Common config file
+Config entries are compiled from
+ config/app_config.yml
+ config/app_config/settings.yml
+ config/app_config/#{environment}.yml
+ config/environments/#{environment}.yml
+ config/app_config/assets.yml
+ config/app_config/stylesheets.yml
+ config/app_config/javascripts.yml
+  
+settings defined in files that are lower in the list override settings higher
+ 
+=== Reloading config files
+You can reload the AppConfig from file at any time by running AppConfig.reload!
+  
+=== 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:
+ RAILS_ROOT/config/environments/development.yml
+ 
+Example production environment config file:
+ RAILS_ROOT/config/environments/production.yml
+
+=== Embedded Ruby (ERB)
+ Embedded Ruby is allowed in the configuration files.  See examples below.
+
+=== Accessing Configuration Settings
+Consider the two following config files.
+
+RAILS_ROOT/config/app_config.yml:
+ size: 1
+ server: google.com
+
+RAILS_ROOT/config/environments/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
+ 
+ 
+==== Managing Asset Files with AppConfig
+Defining stylesheets: and/or javascripts: keys will allow you to easily manage lists of assets via config
+
+javascripts:
+  - application.js
+  - prototype_scriptaculous:
+    - prototype.js
+    - scriptaculous/effects.js
+  - base:
+    - libraries/*.js
+  
+All * file paths will be expanded out into a full list of files. 
+
+To add these javascripts to your layout just run
+
+<%= javascripts_from_config %>
+
+This will group the assets by key in order to use the built in Bundling

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+
+require 'merb-core'
+require 'merb-core/tasks/merb'
+
+GEM_NAME = "merb_app_config"
+GEM_VERSION = "1.0"
+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,132 @@
+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
+    @@load_paths = []
+    @@expand_keys = []
+    @@root_path = ""
+  
+    # 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(options = {})
+      config = OpenStruct.new
+      
+      @@load_paths = [options[:paths]].flatten.compact.uniq
+      @@expand_keys = [options[:expand_keys]].flatten.compact.uniq
+      @@root_path = options[:root_path]
+      
+      # add singleton method to our AppConfig that reloads its settings from the load_paths options
+      def config.reload!
+        conf = {}
+        ConfigBuilder.load_paths.to_a.each do |path|
+          file_conf = YAML.load(ERB.new(IO.read(path)).result) if path and File.exists?(path)
+          conf.merge!(file_conf) if file_conf
+        end
+        
+        # expand the javascripts config to handle *.* paths
+        ConfigBuilder.expand_keys.to_a.each do |expand_path|
+          expand_path = expand_path.to_s
+          if conf[expand_path]
+            conf[expand_path] = ApplicationConfig::ConfigBuilder.expand(conf[expand_path], "#{ConfigBuilder.root_path}/public/#{expand_path}")
+          end
+        end
+
+        # load all the new values into the openstruct
+        marshal_load(ApplicationConfig::ConfigBuilder.convert(conf).marshal_dump)
+        
+        return self
+      end
+
+      config.reload!
+      return config
+    end
+    
+    def self.load_paths
+      @@load_paths
+    end
+
+    def self.expand_keys
+      @@expand_keys
+    end
+
+    def self.root_path
+      @@root_path
+    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.is_a?(Hash)
+          s.send( (k+'=').to_sym, convert(v))
+        elsif v.is_a?(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
+    
+    # expand a config val
+    def self.expand(config, base_path)
+      case config.class.to_s
+      when "Hash"
+        return expand_hash(config, base_path)
+      when "Array"
+        return expand_array(config, base_path)
+      when "String"
+        return expand_string(config, base_path)
+      end      
+      return config
+    end
+    
+    # expand a string and returns a list
+    def self.expand_string(config, base_path)
+      # puts "Expanding String: #{config.inspect}"
+      if config.include?("*")
+        results = Dir["#{base_path}/#{config}"].map{|i| i.to_s.gsub("#{base_path}/", "") }
+
+        # puts "EXPANDED PATH: #{base_path}/#{config}"
+        # puts results.inspect        
+        return results
+      else
+        return config
+      end
+    end
+    
+    # expand a hash by cycling throw all the hash values
+    def self.expand_hash(config, base_path)
+      # puts "Expanding Hash: #{config.inspect}"
+      new_config = {}
+      config.each do |key, val|
+        new_config[key] = expand(val, base_path)
+      end
+      return new_config
+    end
+    
+    # expand an array by cycling through all the values
+    def self.expand_array(config, base_path)
+      # puts "Expanding Array: #{config.inspect}"
+      new_config = []
+      config.each do |val|
+        new_val = expand(val, base_path)
+        if new_val.is_a?(Array)
+          new_val.each do |inner|
+            new_config << inner
+          end
+        else
+          new_config << new_val
+        end
+      end
+      return new_config.uniq
+    end
+    
+  end
+end

data/lib/application_config/view_helpers.rb

@@ -0,0 +1,71 @@
+module ApplicationConfig
+  module ViewHelpers
+    def javascripts_from_config(options = {})
+      html = ""
+      if defined?(AppConfig) and AppConfig.javascripts
+        AppConfig.javascripts.each do |javascript|
+          if javascript.is_a?(OpenStruct)
+            javascript = javascript.marshal_dump
+          end
+          
+          if javascript.is_a? Hash
+            javascript.each do |key, val|
+              args = [val].flatten
+              args = args.map{|s| s.gsub("javascripts/", AppConfig.javascript_path)} if AppConfig.javascript_path
+              if defined?(Merb)
+                args << options.merge(:bundle => key.to_sym)
+                html << js_include_tag(*args)
+              elsif defined?(Rails)
+                args << options.merge(:cache => key.to_s)
+                html << javascript_include_tag(*args)
+              end
+              html << "\n"
+            end
+          else
+            args = [javascript].flatten
+            args = args.map{|s| s.gsub("javascripts/", AppConfig.javascript_path)} if AppConfig.javascript_path
+            args << options
+            if defined?(Merb)
+              html << js_include_tag(*args)
+            elsif defined?(Rails)
+              html << javascript_include_tag(*args)
+            end
+          end
+        end
+      end
+      return html
+    end
+    
+    def stylesheets_from_config(options = {})
+      html = ""
+      if defined?(AppConfig) and AppConfig.stylesheets
+        AppConfig.stylesheets.each do |stylesheet|
+          if stylesheet.is_a?(OpenStruct)
+            stylesheet = stylesheet.marshal_dump
+          end
+          
+          if stylesheet.is_a? Hash
+            stylesheet.each do |key, val|
+              args = [val].flatten
+              args = args.map{|s| s.gsub("stylesheets/", AppConfig.stylesheet_path)} if AppConfig.stylesheet_path
+              if defined?(Merb)
+                args << options.merge(:bundle => key.to_sym)
+                html << css_include_tag(*args)
+              elsif defined?(Rails)
+                args << options.merge(:cache => key.to_s)
+                html << stylesheet_link_tag(*args)
+              end
+            end
+          else
+            args = [stylesheet].flatten
+            args = args.map{|s| s.gsub("stylesheets/", AppConfig.stylesheet_path)} if AppConfig.stylesheet_path
+            args << options
+            html << stylesheet_link_tag(*args)
+          end
+          html << "\n"
+        end
+      end
+      return html
+    end
+  end
+end

data/lib/merb_app_config.rb

@@ -0,0 +1,47 @@
+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,
+    :view_helpers => true,
+    :paths => [
+      "#{Merb.root}/config/app_config.yml",
+      "#{Merb.root}/config/app_config/settings.yml",
+      "#{Merb.root}/config/app_config/#{Merb.env}.yml",
+      "#{Merb.root}/config/environments/#{Merb.env}.yml",
+      "#{Merb.root}/config/assets.yml",
+      "#{Merb.root}/config/javascripts.yml",
+      "#{Merb.root}/config/stylesheets.yml"
+    ]
+  }
+  
+  Merb::BootLoader.before_app_loads do
+    if defined?(::AppConfig)
+      AppConfig.reload!
+    else
+      ::AppConfig = ApplicationConfig::ConfigBuilder.load_files(
+        :paths =>  Merb::Plugins.config[:app_config][:paths].to_a,
+        :expand_keys => [:javascripts, :stylesheets],
+        :root_path => Merb.root
+      )
+    end
+
+    if Merb::Plugins.config[:app_config][:view_helpers]
+      Merb::Controller.send(:include, ApplicationConfig::ViewHelpers)
+    end
+  end
+  
+  Merb::BootLoader.after_app_loads do
+    if Merb::Plugins.config[:app_config][:auto_reload]
+      Merb.logger.info "[AppConfig] Auto reloading AppConfig on *every request*."
+      Merb.logger.info "[AppConfig] Set via Merb::Plugins.config[:app_config][:auto_reload]"
+
+      Merb::Controller.before Proc.new{ AppConfig.reload! }
+    end
+  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.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

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: merb_app_config
+version: !ruby/object:Gem::Version 
+  version: "1.0"
+platform: ruby
+authors: 
+- Jacques Crocker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-23 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_app_config.rb
+- lib/merbtasks.rb
+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: []
+