test/fixtures/app.yml test/fixtures/app/authenticate.yml test/fixtures/app/authenticate/basic/config.yml @@ -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 History.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 Manifest.txt @@ -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 README.rdoc @@ -2,32 +2,32 @@ Gem::Specification.new do |s| s.name = %q{app} - s.version = "0.1.2" + s.version = "0.2.0" s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version= s.authors = ["Stephen Celis"] - s.date = %q{2009-04-02} + s.date = %q{2009-04-17} s.description = %q{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.} s.email = ["stephen@stephencelis.com"] s.extra_rdoc_files = ["History.txt", "Manifest.txt"] - s.files = ["History.txt", "Manifest.txt", "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"] + s.files = ["History.txt", "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"] s.has_rdoc = true s.rdoc_options = ["--main", "README.rdoc"] s.require_paths = ["lib"] s.rubyforge_project = %q{app} - s.rubygems_version = %q{1.3.1} + s.rubygems_version = %q{1.3.2} s.summary = %q{Move the config out of your app, and into App} if s.respond_to? :specification_version then current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION - s.specification_version = 2 + s.specification_version = 3 if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then - s.add_development_dependency(%q<hoe>, [">= 1.11.0"]) + s.add_development_dependency(%q<hoe>, [">= 1.12.0"]) else - s.add_dependency(%q<hoe>, [">= 1.11.0"]) + s.add_dependency(%q<hoe>, [">= 1.12.0"]) end else - s.add_dependency(%q<hoe>, [">= 1.11.0"]) + s.add_dependency(%q<hoe>, [">= 1.12.0"]) end end app.gemspec @@ -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 generators/app_config/app_config_generator.rb @@ -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 %> generators/app_config/templates/app.yml @@ -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".' install.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 lib/app.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 test/app_test.rb init.rb uninstall.rb e1d5644e1b349ea2ea5514f31e5ad307be52cbf4 Stephen Celis stephen@stephencelis.com http://github.com/stephencelis/app/commit/f4a788560dd457fdc8545632f3690ec4c878c38c f4a788560dd457fdc8545632f3690ec4c878c38c 2009-04-17T11:49:20-07:00 2009-04-17T11:45:40-07:00 Option to modular configuration files (from "config/app/**/*.yml"). App.name is now App.to_s (overriding the name is cool, but dangerous). Removed superfluous "init" and "uninstall" files (handle load errors more gracefully in "app", and let "script/destroy" do its thing). 4a520c4c15846b3b210fde10c9580bc13b6154b5 Stephen Celis stephen@stephencelis.com