bragi-app 0.2.3

data/History.rdoc

@@ -0,0 +1,53 @@
+=== 0.2.3 / 2009-06-02
+
+* 2 minor enhancements
+
+  * Non existing nested keys are ignored and null is returned
+  * Generator uses existing app.yml.example file when it exists in application
+
+=== 0.2.2 / 2009-04-17
+
+* 2 minor enhancements
+
+  * Remember to better ensure immutability.
+  * Include "README.rdoc" in gemspec.
+
+
+=== 0.2.1 / 2009-04-17
+
+* 1 minor enhancement
+
+  * Configuration files no longer require scoping to environments.
+
+
+=== 0.2.0 / 2009-04-17
+
+* 2 major enhancements
+
+  * Option to modular configuration files (from "config/app/**/*.yml").
+  * App.name is now App.to_s (overriding the name is cool, but dangerous).
+
+* 1 minor enhancement
+
+  * Removed superfluous "init" and "uninstall" files (handle load errors more
+    gracefully in "app", and let "script/destroy" do its thing).
+
+=== 0.1.2 / 2009-04-02
+
+* 1 minor enhancement
+
+  * Change README.txt to README.rdoc in gem specification.
+
+
+=== 0.1.1 / 2009-04-02
+
+* 1 major enhancement
+
+  * Gemified!
+
+
+=== 0.1.0 / 2009-04-02
+
+* 1 major enhancement
+
+  * Birthday!

data/Manifest.txt

@@ -0,0 +1,12 @@
+History.rdoc
+Manifest.txt
+README.rdoc
+Rakefile
+generators/app_config/app_config_generator.rb
+generators/app_config/templates/app.yml
+install.rb
+lib/app.rb
+test/app_test.rb
+test/fixtures/app/authenticate/basic/config.yml
+test/fixtures/app/authenticate.yml
+test/fixtures/app.yml

data/README.rdoc

@@ -0,0 +1,136 @@
+= App
+
+http://github.com/stephencelis/app
+
+
+== DESCRIPTION
+
+Move the config out of your app, and into App.
+
+Sure, it's been done before, and others will do it again, but this is my way,
+and I like it.
+
+
+== FEATURES/PROBLEMS
+
+* Easy, environmentally-friendly configuration access.
+
+
+For mutability, try acts_as_singleton or KVC:
+
+* http://github.com/stephencelis/acts_as_singleton
+* http://github.com/stephencelis/kvc
+
+
+== SYNOPSIS
+
+App looks for and loads configuration from "config/app.yml", providing a
+namespaced API for access.
+
+  App.config # => {"apis"=>{"flickr"=>{ ... }}
+
+
+Sugar is always sweeter:
+
+  App.config("apis", "flickr") # => App.config["apis"]["flickr"]
+
+
+Who doesn't like sugar?
+
+  App["apis", "flickr"]
+
+
+Sugar, sugar, sugar.
+
+  App.apis("flickr")
+
+
+Let's not overdo it, though. <tt>App.apis.flickr</tt> just doesn't look right.
+
+
+== REQUIREMENTS
+
+* Rails 2.3.2 or greater.
+
+
+== INSTALL
+
+=== With a template:
+
+In existing projects:
+
+  % rake rails:template LOCATION=http://gist.github.com/97629.txt
+
+
+For new projects:
+
+  % rails newapp -m http://gist.github.com/97629.txt
+
+
+=== Or as a gem:
+
+Configure:
+
+  # config/environment.rb
+  config.gem "stephencelis-app", :lib     => "app",
+                                 :source  => "http://gems.github.com",
+                                 :version => ">= 0.2.2"
+
+And install:
+
+  % sudo rake gems:install
+
+
+=== Or as a plugin:
+
+Install:
+
+  % script/plugin install git://github.com/stephencelis/app.git
+
+
+Or submodule:
+
+  % git submodule add git://github.com/stephencelis/app.git vendor/plugins/app
+
+
+=== Finally, generate:
+
+  % script/generate app_config
+
+
+If your "app.yml" gets out of hand, modularize, like in this heavy-handed
+example:
+
+  % script/generate app_config apis/twitter
+        create  config/app/apis
+        create  config/app/apis/twitter.yml # Configure me!
+
+
+Namespaces avoid collisions:
+
+  App::Apis::Twitter.username
+
+
+== LICENSE
+
+(The MIT License)
+
+(c) 2009-* Stephen Celis, stephen@stephencelis.com.
+
+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/Rakefile

@@ -0,0 +1,23 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the app plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the app plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'App'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/generators/app_config/app_config_generator.rb

@@ -0,0 +1,37 @@
+require "fileutils"
+
+class AppConfigGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      if ARGV.empty?
+        if File.exist? Rails.root.join("config", "app.yml")
+          show_banner
+        elsif File.exist? Rails.root.join("config", "app.yml.example")
+          FileUtils.cp(Rails.root.join("config", "app.yml.example"),
+            Rails.root.join("config", "app.yml"))
+        else
+          m.file "app.yml", "config/app.yml"
+        end
+      else
+        ARGV.each do |arg|
+          path = "config/app/#{arg.underscore}"
+          m.directory File.dirname(path)
+          m.file "app.yml", "#{path}.yml"
+        end
+      end
+    end
+  end
+
+  private
+
+  def show_banner
+    puts "App: you already have an app.yml!"
+    puts
+    puts "  Remember to pass arguments to generate new configurations:"
+    puts "    script/generate app_config apis/twitter"
+    puts
+    puts "  Generates:"
+    puts "    config/app/apis"
+    puts "    config/app/apis/twitter.yml"
+  end
+end

data/generators/app_config/templates/app.yml

@@ -0,0 +1,15 @@
+# An app config, provided by App: http://github.com/stephencelis/app
+---
+development: &development
+  loaded_at: <%= Time.zone.now.iso8601 %>
+  # Example of nested data:
+  # apis:
+  #   braintree:
+  #     :login: testapi
+  #     :password: password1
+ 
+test:
+  <<: *development
+
+production:
+  loaded_at: <%= Time.zone.now.iso8601 %>

data/install.rb

@@ -0,0 +1 @@
+$stdout.puts 'Run `script/generate app_config` to generate "config/app.yml".'

data/lib/app.rb

@@ -0,0 +1,74 @@
+# App is your app.
+#
+# What would your app be without it? Still an app, but without App.
+module App
+  VERSION = "0.2.2"
+
+  @@config = {} # Initialize.
+  class << self
+    # Returns the application configuration hash, as defined in
+    # "config/app.yml".
+    #
+    # Follows args through the hash tree. E.g.:
+    #
+    #   App.config("apis", "flickr") # => config_hash["apis"]["flickr"]
+    #
+    # <tt>App.config</tt> is aliased to <tt>App.[]</tt>, so shorten things up:
+    #
+    #   App["apis", "flickr"]
+    #
+    # Or rely on +method_missing+ to make it even shorter (and sweeter):
+    #
+    #   App.apis("flickr")
+    def config(*args)
+      @@config if args.empty?
+      args.inject(@@config) { |config, arg| config && config[arg] }
+    end
+    alias [] config
+
+    def inspect
+      "#<#{name}: #{config.inspect}>"
+    end
+
+    private
+
+    def method_missing(method, *args)
+      self[method.to_s, *args] || self[method, *args]
+    end
+  end
+
+  begin
+    raw = File.read Rails.root.join("config", "#{name.underscore}.yml")
+    all = YAML.load ERB.new(raw).result
+    @@config = all[Rails.env] || all
+    @@config.freeze
+  rescue Errno::ENOENT => e
+    
+    puts '** App: no file "config/app.yml". Run `script/generate app_config`.'
+  end
+end
+
+unless __FILE__ == "(eval)"
+  module App
+    class << self
+      # Returns the name of the web application.
+      def to_s
+        File.basename Rails.root
+      end
+    end
+  end
+
+  # Iterate through other App configs and namespace them.
+  Dir[Rails.root.join("config", "app", "**/*.yml")].sort.each do |config|
+    name = config.gsub(/#{Rails.root.join("config")}\/|\.yml/) {}.classify
+
+    # Recognize all parents.
+    line = name.split "::"
+    line.inject line.shift do |parentage, descendant|
+      eval "module #{parentage}; end"
+      "#{parentage}::#{descendant}"
+    end
+
+    eval File.read(__FILE__).sub("module App", "module #{name}")
+  end
+end

data/test/app_test.rb

@@ -0,0 +1,68 @@
+require 'test/unit'
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'
+require 'mocha'
+require 'erb'
+
+# Mock!
+module Rails
+  def self.root
+    self
+  end
+  def self.join(*args)
+    args.shift # No "config" dir, OK?
+    File.expand_path File.join(File.dirname(__FILE__), "fixtures", *args)
+  end
+  def self.env
+    "development"
+  end
+end
+
+# And load!
+require 'app'
+
+class AppTest < ActiveSupport::TestCase
+  test "should access many ways" do
+    assert_equal "Welcome!", App.config["welcome_message"]
+    assert_equal "Welcome!", App.config("welcome_message")
+    assert_equal "Welcome!", App["welcome_message"]
+    assert_equal "Welcome!", App.welcome_message
+
+    assert_equal "testapi", App.config["apis"]["braintree"][:login]
+    assert_equal "testapi", App.config("apis", "braintree", :login)
+    assert_equal "testapi", App["apis", "braintree", :login]
+    assert_equal "testapi", App.apis("braintree", :login)
+  end
+
+  test "should parse ERB" do
+    assert_instance_of Time, App.loaded_at
+  end
+
+  test "should accept boolean keys" do
+    assert !App.process_payments?
+  end
+
+  test "should infer App.name" do
+    File.stubs(:basename).returns "root"
+    assert_equal "root", App.to_s
+  end
+
+  test "should namespace configs" do
+    assert_instance_of Module, App::Authenticate
+    assert_equal "frobozz", App::Authenticate["Stephen"]
+  end
+
+  test "should nest multiple levels of configs" do
+    assert_instance_of Module, App::Authenticate::Basic::Config
+    assert_equal :basic, App::Authenticate::Basic::Config.authentication_type
+  end
+
+  test "should be frozen" do
+    assert_raise(TypeError) { App.config["loaded_at"] = Time.now }
+  end
+
+  test "should ignore null nested keys" do
+    assert_nil App.config("missing_scope", "nested_missing_key")
+  end
+end

data/test/fixtures/app/authenticate/basic/config.yml

@@ -0,0 +1,2 @@
+---
+authentication_type: :basic

data/test/fixtures/app/authenticate.yml

@@ -0,0 +1,4 @@
+---
+development:
+  Stephen: frobozz
+  housemd: God

data/test/fixtures/app.yml

@@ -0,0 +1,9 @@
+---
+development:
+  loaded_at: <%= Time.now.iso8601 %>
+  welcome_message: Welcome!
+  process_payments?: false
+  apis:
+    braintree:
+      :login: testapi
+      :password: password1

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: bragi-app
+version: !ruby/object:Gem::Version 
+  version: 0.2.3
+platform: ruby
+authors: 
+- Stephen Celis
+- "\xC5\x81ukasz Piestrzeniewicz"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-02 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.12.0
+    version: 
+description: Move the config out of your app, and into App. Sure, it's been done before, and others will do it again, but this is my way, and I like it.
+email: 
+- stephen@stephencelis.com
+- bragi@ragnarson.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.rdoc
+- Manifest.txt
+- README.rdoc
+files: 
+- History.rdoc
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- generators/app_config/app_config_generator.rb
+- generators/app_config/templates/app.yml
+- install.rb
+- lib/app.rb
+- test/app_test.rb
+- test/fixtures/app/authenticate/basic/config.yml
+- test/fixtures/app/authenticate.yml
+- test/fixtures/app.yml
+has_rdoc: true
+homepage: http://github.com/stephencelis/app
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+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: app
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: Move the config out of your app, and into App
+test_files: []
+