app 0.2.2 → 0.9.0

data/History.rdoc

@@ -1,3 +1,10 @@
+=== 0.9.0 / 2010-02-21
+
+* 1 major enhancement
+
+  * Rebirthday!
+
+
 === 0.2.2 / 2009-04-17
 
 * 2 minor enhancements
@@ -25,6 +32,7 @@
   * 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

data/README.rdoc

@@ -1,127 +1,129 @@
 = 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"]
+== WARNING:
 
+This release is new, improved, and almost completely incompatible with the
+gem formerly known as App. (See "What about YAML?", below.)
 
-Sugar, sugar, sugar.
 
-  App.apis("flickr")
+== K.
 
+=== Rails (3.0)
 
-Let's not overdo it, though. <tt>App.apis.flickr</tt> just doesn't look right.
+  % echo 'gem "app"' >> Gemfile
+  % bundle install
+  % rails g configurable
 
 
-== REQUIREMENTS
+You now have App config files at config/app. It will generate an override per
+Rails environment.
 
-* Rails 2.3.2 or greater.
+  # config/app.rb
+  class App < Configurable
+    config.javascript_expansions = {
+      :prototype     => "prototype"
+      :scriptaculous => %w(effects dragdrop controls)
+    }
+  end
 
 
-== INSTALL
+Need to update those sources for production?
 
-=== With a template:
+  # config/app/production.rb
+  App.configure do
+    ajax_lib_base = "http://ajax.googleapis.com/ajax/libs"
 
-In existing projects:
+    config.javascript_expansions.update({
+      :prototype     => "#{ajax_lib_base}/prototype/1.6.1.0/prototype.js"
+      :scriptaculous => "#{ajax_lib_base}/scriptaculous/1.8.3/scriptaculous.js"
+    })
+  end
 
-  % rake rails:template LOCATION=http://gist.github.com/97629.txt
 
+=== Ruby
 
-For new projects:
+App can be used in any Ruby application. Just bundle (see "Rails", above, less
+the `rails g`) or install the gem.
 
-  % rails newapp -m http://gist.github.com/97629.txt
+Make sure "app" is required in your environment, and define a class from there.
 
+  class MyConfig < Configurable
+    config.launched_at = Time.now.utc
+  end
 
-=== Or as a gem:
 
-Configure:
+== What about YAML?
 
-  # config/environment.rb
-  config.gem "stephencelis-app", :lib     => "app",
-                                 :source  => "http://gems.github.com",
-                                 :version => ">= 0.2.2"
+YAML is great, really, but it just wasn't great beyond simple configuration.
 
-And install:
+Take that last example. ERB would be required, and still it's cumbersome.
 
-  % sudo rake gems:install
+  # app.yml
+  ---
+  launched_at: <%= Time.now.utc.iso8601 %>
 
 
-=== Or as a plugin:
+Forget the ISO 8601 formatting and you'll get a string back, instead.
 
-Install:
+But that's just the surface. Where you're manipulating the primitive objects
+that YAML supports most easily, you could have stored complex Ruby objects:
+Pathname, Proc, or anything else.
 
-  % script/plugin install git://github.com/stephencelis/app.git
+  class App < Configurable
+    config.config_path = Rails.root.join("config")
+    config.uptime = Proc.new { (Time.now.utc - App.launched_at).seconds }
+    config.asset_host = ActiveSupport::StringInquirer.new "amazon"
+  end
 
+  App.config_path.join("app") # => #<Pathname:config/app>
+  App.uptime.call             # => 430.198400 seconds
+  App.asset_host.amazon?      # => true
 
-Or submodule:
 
-  % git submodule add git://github.com/stephencelis/app.git vendor/plugins/app
+And because these configuration files are just class definitions, you can
+write your own methods, as well.
 
+  class App < Configurable
+    def self.destroy_sessions!
+      Session.delete_all
+    end
+  end
 
-=== Finally, generate:
+  App.destroy_sessions! # => 1
 
-  % script/generate app_config
 
+If Ruby can handle it, so can App.
 
-If your "app.yml" gets out of hand, modularize, like in this heavy-handed
-example:
+But OK, OK, there's still an upgrade path:
 
-  % script/generate app_config apis/twitter
-        create  config/app/apis
-        create  config/app/apis/twitter.yml # Configure me!
+  class App < Configurable
+    # This must come first.
+    self.config = <<YAML
+  legacy: <%= "configuration" %>
+  YAML
 
+    # config.key = "value"
+  end
 
-Namespaces avoid collisions:
 
-  App::Apis::Twitter.username
+This is not backwards-compatible. This is only to help ease the transition.
+You will most likely have to upgrade your calls.
 
 
 == LICENSE
 
 (The MIT License)
 
-(c) 2009-* Stephen Celis, stephen@stephencelis.com.
+(c) 2009-2010 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 
+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

data/Rakefile

@@ -1,23 +1,10 @@
-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/lib/app.rb

@@ -1,73 +1,91 @@
-# App is your app.
+# Provides configuration via superclass. Inherit from Configurable, and you
+# have a handy little DSL/class for assigning/accessing your app settings.
 #
-# What would your app be without it? Still an app, but without App.
-module App
-  VERSION = "0.2.2"
+#   class App < Configurable
+#     config.launched_at = Time.now.utc
+#   end
+#
+#   App.launched_at # => 2010-02-21 12:34:56 UTC
+#
+# Configurable classes will warn you when you call undefined settings.
+#
+#   App.typo # => nil
+#   warning: undefined setting `typo' for App:Class
+#
+# If you don't care about these warnings, just redefine the logger.
+#
+#   App.configure do
+#     config.logger = Logger.new nil
+#   end
+class Configurable
+  autoload :Logger,     "logger"
+  autoload :OpenStruct, "ostruct"
+
+  # Deprecated autoloads.
+  autoload :ERB,        "erb"
+  autoload :YAML,       "yaml"
 
-  @@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[arg] }
+    alias __name__ name
+    undef name
+
+    alias configure class_eval
+
+    def [](key)
+      unless config.respond_to? key
+        logger.warn "warning: undefined setting `#{key}' for #{__name__}:Class"
+      end
+
+      config.send key
     end
-    alias [] config
 
     def inspect
-      "#<#{name}: #{config.inspect}>"
+      config.inspect.sub config.class.name, __name__
+    end
+
+    def logger
+      return config.logger if config.respond_to? :logger
+      @logger ||= defined?(Rails) ? Rails.logger : Logger.new(STDERR)
     end
 
     private
 
-    def method_missing(method, *args)
-      self[method.to_s, *args] || self[method, *args]
+    def config
+      @config ||= OpenStruct.new
     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
+    def config=(settings)
+      @config = case settings
+      when String
+        logger.warn "warning: YAML is deprecated (#{__FILE__}:#{__LINE__})"
+        OpenStruct.new YAML.load(ERB.new(settings).result)
+      when Hash
+        OpenStruct.new settings
+      else
+        settings
       end
     end
+
+    def method_missing(method, *args, &block)
+      super if (key = method.to_s).end_with?("=")
+      boolean = key.chomp!("?")
+      value   = self[key]
+      value   = value.call(*args, &block) if value.respond_to?(:call)
+      boolean ? !!value : value
+    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
+  if defined? Rails
+    class Plugin < Rails::Railtie # :nodoc:
+      railtie_name :configurable
 
-    # Recognize all parents.
-    line = name.split "::"
-    line.inject line.shift do |parentage, descendant|
-      eval "module #{parentage}; end"
-      "#{parentage}::#{descendant}"
+      initializer "configurable.require_app" do |app|
+        begin
+          require app.root.join "config", "app"
+          require app.root.join "config", "app", Rails.env
+        rescue LoadError
+        end
+      end
     end
-
-    eval File.read(__FILE__).sub("module App", "module #{name}")
   end
 end

data/lib/generators/configurable_generator.rb

@@ -0,0 +1,13 @@
+class ConfigurableGenerator < Rails::Generators::Base # :nodoc:
+  def self.source_root
+    @_configurable_source_root ||=
+      File.expand_path("../#{base_name}/templates", __FILE__)
+  end
+
+  def install
+    copy_file "app.rb", "config/app.rb"
+    Dir[Rails.root.join("config", "environments", "*.rb").to_s].each do |env|
+      template "app/env.rb", "config/app/#{File.basename env}"
+    end
+  end
+end

data/lib/generators/configurable_generator/templates/app.rb

@@ -0,0 +1,6 @@
+class App < Configurable # :nodoc:
+  # Settings in config/app/* take precedence over those specified here.
+  config.name = Rails::Application.instance.class.parent.name
+
+  # config.key = "value"
+end

data/lib/generators/configurable_generator/templates/app/env.rb

@@ -0,0 +1,5 @@
+App.configure do
+  # Settings specified here will take precedence over those in config/app.rb
+
+  # config.key = "value"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: app
 version: !ruby/object:Gem::Version 
-  version: 0.2.2
+  version: 0.9.0
 platform: ruby
 authors: 
 - Stephen Celis
@@ -9,43 +9,27 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-17 00:00:00 -05:00
+date: 2010-02-21 00:00:00 -06: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
+dependencies: []
+
+description: Move the config out of your app, and into App.
+email: stephen@stephencelis.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
+- lib/generators/configurable_generator/templates/app/env.rb
+- lib/generators/configurable_generator/templates/app.rb
+- lib/generators/configurable_generator.rb
 has_rdoc: true
 homepage: http://github.com/stephencelis/app
 licenses: []
@@ -70,10 +54,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: app
+rubyforge_project: 
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: Move the config out of your app, and into App
+summary: Application configuration.
 test_files: []
 

data/Manifest.txt

@@ -1,12 +0,0 @@
-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/generators/app_config/app_config_generator.rb

@@ -1,32 +0,0 @@
-class AppConfigGenerator < Rails::Generator::Base
-  def manifest
-    record do |m|
-      if ARGV.empty?
-        if File.exist? Rails.root.join("config", "app.yml")
-          show_banner
-        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

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

data/install.rb

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

data/test/app_test.rb

@@ -1,64 +0,0 @@
-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
-end

data/test/fixtures/app.yml

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

data/test/fixtures/app/authenticate.yml

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

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

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