stephencelis-app 0.1.2 → 0.2.0

data/History.txt

@@ -1,3 +1,15 @@
+=== 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

data/Manifest.txt

@@ -4,8 +4,9 @@ README.rdoc
 Rakefile
 generators/app_config/app_config_generator.rb
 generators/app_config/templates/app.yml
-init.rb
 install.rb
 lib/app.rb
 test/app_test.rb
-uninstall.rb
+test/fixtures/app/authenticate/basic/config.yml
+test/fixtures/app/authenticate.yml
+test/fixtures/app.yml

data/README.rdoc

@@ -47,6 +47,18 @@ Sugar, sugar, sugar.
 
 Let's not overdo it, though. <tt>App.apis.flickr</tt> just doesn't look right.
 
+If your "app.yml" gets out of hand, modularize:
+
+  # config/app/authenticate.yml
+  ---
+  username: password
+
+  # (elsewhere)
+  App::Authenticate["username"] # => "password"
+
+
+Namespaces avoid collisions.
+
 
 == REQUIREMENTS
 

data/generators/app_config/app_config_generator.rb

@@ -1,7 +1,32 @@
 class AppConfigGenerator < Rails::Generator::Base
   def manifest
     record do |m|
-      m.file "app.yml", "config/app.yml"
+      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,6 +1,4 @@
-# Your app config, provided by the App plugin.
-#
-# See "vendor/plugins/app/README.txt" for details.
+# An app config, provided by App: http://github.com/stephencelis/app
 ---
 development: &development
   loaded_at: <%= Time.zone.now.iso8601 %>

data/install.rb

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

data/lib/app.rb

@@ -1,12 +1,10 @@
 # App is your app.
 #
-# What would your app be without it? Still an app, but without the App.
+# What would your app be without it? Still an app, but without App.
 module App
-  VERSION = "0.1.2"
-
-  raw_config = File.read Rails.root.join("config", "app.yml")
-  @@config = YAML.load(ERB.new(raw_config).result)[Rails.env].freeze
+  VERSION = "0.2.0"
 
+  @@config = {} # Initialize.
   class << self
     # Returns the application configuration hash, as defined in
     # "config/app.yml".
@@ -26,20 +24,10 @@ module App
       @@config if args.empty?
       args.inject(@@config) { |config, arg| config[arg] }
     end
-
-    alias []       config
-    alias __name__ name
-
-    # Returns the name of the web application, which can be overridden in
-    # "config/app.yml".
-    #
-    # To return the name of the module, use <tt>App.__name__</tt>.
-    def name
-      @@name ||= method_missing(:name) || File.basename(Rails.root)
-    end
+    alias [] config
 
     def inspect
-      "#<App: #{config.inspect}>"
+      "#<#{name}: #{config.inspect}>"
     end
 
     private
@@ -48,4 +36,37 @@ module App
       self[method.to_s, *args] || self[method, *args]
     end
   end
+
+  begin
+    raw = File.read Rails.root.join("config", "#{name.underscore}.yml")
+    @@config = YAML.load(ERB.new(raw).result)[Rails.env]
+  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, which can be overridden in
+      # "config/app.yml".
+      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

@@ -5,38 +5,29 @@ require 'active_support/test_case'
 require 'mocha'
 require 'erb'
 
-# Mock
-module App
-  module Rails
-    def self.root
-      File
-    end
-    def self.env
-      "development"
-    end
+# 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
 
-File.stubs(:read).returns <<-YAML
----
-development:
-  loaded_at: <%= Time.now.iso8601 %>
-  username: Stephen
-  password: frobozz
-  apis:
-    braintree:
-      :login: testapi
-      :password: password1
-YAML
-
+# And load!
 require 'app'
 
 class AppTest < ActiveSupport::TestCase
-  test "different ways of access should return same values" do
-    assert_equal "Stephen", App.config["username"]
-    assert_equal "Stephen", App.config("username")
-    assert_equal "Stephen", App["username"]
-    assert_equal "Stephen", App.username
+  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)
@@ -44,12 +35,26 @@ class AppTest < ActiveSupport::TestCase
     assert_equal "testapi", App.apis("braintree", :login)
   end
 
-  test "ERB should be parsed" do
+  test "should parse ERB" do
     assert_instance_of Time, App.loaded_at
   end
 
-  test "App.name should be inferred" do
+  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.name
+    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
 end

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

data/test/fixtures/app/authenticate.yml

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

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

@@ -0,0 +1,3 @@
+---
+development:
+  authentication_type: :basic

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: stephencelis-app
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors: 
 - Stephen Celis
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-02 00:00:00 -07:00
+date: 2009-04-17 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.11.0
+        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: 
@@ -39,11 +39,12 @@ files:
 - Rakefile
 - generators/app_config/app_config_generator.rb
 - generators/app_config/templates/app.yml
-- init.rb
 - install.rb
 - lib/app.rb
 - test/app_test.rb
-- uninstall.rb
+- test/fixtures/app/authenticate/basic/config.yml
+- test/fixtures/app/authenticate.yml
+- test/fixtures/app.yml
 has_rdoc: true
 homepage: 
 post_install_message: 
@@ -69,7 +70,7 @@ requirements: []
 rubyforge_project: app
 rubygems_version: 1.2.0
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Move the config out of your app, and into App
 test_files: []
 

data/init.rb

@@ -1,3 +0,0 @@
-if !File.exist? Rails.root.join("config", "app.yml")
-  puts '** App: "config/app.yml" not found. Run `script/generate app_config`.'
-end

data/uninstall.rb

@@ -1,7 +0,0 @@
-app_yaml = Rails.root.join("config", "app.yml")
-if File.exist? app_yaml
-  print 'Also remove "config/app.yml"? [yN] '
-  if STDIN.gets.chomp =~ /^y)/i
-    File.delete app_yaml
-  end
-end