kete-capistrano-configuration 0.1.2 → 0.2.0

data/CHANGELOG.rdoc

@@ -1,3 +1,10 @@
+== 0.2.0 (March 9, 2009)
+
+* Multi level configuration is now possible (when previously only one level was working)
+* A to_file option can be passed to configure method to specify the location of the yml file (defaults to config directory)
+* Raises to ensure methods are called in the right order
+* Testing - Covers all the main parts of Capistrano Configuration so hopefully this release is pretty bug free
+
 == 0.1.2 (January 12, 2009)
 
 * Fixing configuration writing issue

data/Manifest

@@ -6,3 +6,4 @@ Manifest
 MIT-LICENSE
 Rakefile
 README.rdoc
+test/capistrano_configuration_test.rb

data/README.rdoc

@@ -42,22 +42,6 @@ that method has an alias called 'context' which you can use to do the
 same thing.
 
 
-== Issues
-
-The gem currently only supports one environment level, that is, code
-like this won't work:
-
-  configure :database do
-    environment :test do
-      environment :remote do
-        config 'username', 'app'
-      end
-    end
-  end
-
-This feature (nested environments) is planned for a future version.
-
-
 == Bug and Feature Requests
 
 You can report bugs and request features / submit patches at our Lighthouse account

data/Rakefile

@@ -1,6 +1,10 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
 namespace :gem do
 
-  task :default => :build
+  task :default => ['gem:build', 'gem:install']
 
   desc 'Build the Capistrano Configuration Gem'
   task :build do
@@ -13,9 +17,25 @@ namespace :gem do
   desc 'Install the Capistrano Configuration Gem'
   task :install do
     gem_filename = Dir['*.gem'].first
-    sh "sudo gem install --local #{gem_filename}"
+    sh "sudo gem install #{gem_filename}"
   end
 
 end
 
-task :default => ['gem:build', 'gem:install']
+task :gem => ['gem:build', 'gem:install']
+
+desc 'Test Capistrano Configuration Gem'
+Rake::TestTask.new(:test) do |t|
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+task :default do
+  puts "----"
+  puts "              rake  -  This menu"
+  puts "         rake test  -  Test the gem"
+  puts "          rake gem  -  Build and install gem"
+  puts "    rake gem:build  -  Build gem"
+  puts "  rake gem:install  -  Install gem"
+  puts "----"
+end

data/capistrano-configuration.gemspec

@@ -2,8 +2,8 @@
 
 Gem::Specification.new do |s|
   s.name              = "capistrano-configuration"
-  s.version           = "0.1.2"
-  s.date              = "2009-01-12"
+  s.version           = "0.2.0"
+  s.date              = "2009-03-09"
   s.author            = "Kieran Pilkington"
   s.email             = "kieran@katipo.co.nz"
   s.homepage          = "http://github.com/kete/capistrano-configuration"
@@ -17,13 +17,13 @@ Gem::Specification.new do |s|
                             Manifest
                             MIT-LICENSE
                             Rakefile
-                            README.rdoc }
+                            README.rdoc
+                            test/capistrano_configuration_test.rb }
   s.has_rdoc          = true
   s.extra_rdoc_files  = %w{ CHANGELOG.rdoc
                             MIT-LICENSE
                             README.rdoc }
   s.rdoc_options      = ["--line-numbers",
-                         "--inline-source",
                          "--title",
                          "capistrano-configuration",
                          "--main",

data/lib/capistrano-configuration.rb

@@ -5,29 +5,45 @@ end
 module CapistranoConfiguration
   unless included_modules.include? CapistranoConfiguration
 
+    class CapistranoConfigurationError < Exception; end
+
+    @@current_config = nil
     @@configurations = Hash.new
-    @@current_config = String.new
-    @@current_env = String.new
+    @@locations = Hash.new
+    @@current_envs = Array.new
+    @@original_envs = Array.new
 
-    def configure(config)
-      @@current_config = config
+    def configure(config, options={})
+      raise CapistranoConfigurationError.new("You cannot call configure without first closing an already existing configure.") unless @@current_config.nil?
+      raise CapistranoConfigurationError.new("Configure is designed to work with a block. Please pass it one.") unless block_given?
+      @@current_config = config.to_sym
       @@configurations[@@current_config] ||= Hash.new
+      @@locations[@@current_config] = options[:to_file] if options[:to_file]
       yield
+      @@current_config = nil
     end
 
     def environment(env)
-      @@current_env = env
-      @@configurations[@@current_config][@@current_env] ||= Hash.new
+      raise CapistranoConfigurationError.new("You cannot call environment without wrapping it inside a configure call.") if @@current_config.nil?
+      raise CapistranoConfigurationError.new("Environment is designed to work with a block. Please pass it one.") unless block_given?
+      current_level[env] ||= Hash.new
+      @@original_envs << @@current_envs.dup
+      @@current_envs << env
       yield
-      @@current_env = nil
+      @@current_envs = @@original_envs.pop
     end
     alias :context :environment
 
     def config(setting, value)
-      if @@current_env.nil?
-        @@configurations[@@current_config][setting] = value
+      raise CapistranoConfigurationError.new("You cannot call config without wrapping it inside a configure or environment call.") if @@current_config.nil?
+      current_level[setting] = value
+    end
+
+    def file_path_for(configuration, default='.')
+      if @@locations[configuration.to_sym]
+        @@locations[configuration.to_sym]
       else
-        @@configurations[@@current_config][@@current_env][setting] = value
+        "#{default}/#{configuration}.yml"
       end
     end
 
@@ -40,20 +56,28 @@ module CapistranoConfiguration
           desc 'Write the configuration files based on whats in @@configurations'
           task :write, :role => :app do
             abort "@@configurations is empty. Did you forget to define some configurations?" if @@configurations.empty?
-            @@configurations.each do |file, value|
-              run "cd #{current_path} && rm -rf config/#{file}.yml"
-              put value.to_yaml, "#{current_path}/config/#{file}.yml"
+            @@configurations.each do |configuration, value|
+              file_path = file_path_for(configuration, "#{current_path}/config")
+              run "cd #{current_path} && rm -rf #{file_path}"
+              put value.to_yaml, file_path
             end
           end
 
         end
 
       end
-      
+
       after "deploy:symlink", "deploy:configuration:write"
 
     end
 
+    private
+
+    def current_level
+      env_string = @@current_envs.collect { |env| env.is_a?(String) ? "['#{env}']" : "[:#{env}]" }.join('')
+      eval("@@configurations[@@current_config]#{env_string}")
+    end
+
   end
 end
 

data/test/capistrano_configuration_test.rb

@@ -0,0 +1,279 @@
+require 'test/unit'
+
+# Mock Capistrano modules/methods.
+# We don't need to test them (capistrano does that)
+module Capistrano
+  class Configuration
+    def self.instance; self; end
+    def self.load(&block); end
+  end
+end
+
+require File.dirname(__FILE__) + "/../lib/capistrano-configuration"
+
+class CapistranoConfigurationTest < Test::Unit::TestCase
+
+  include CapistranoConfiguration
+
+  def setup
+    @@current_config = nil
+    @@configurations = Hash.new
+    @@locations = Hash.new
+    @@current_envs = Array.new
+    @@original_envs = Array.new
+  end
+
+  def test_configure_cannot_be_used_within_itself
+    assert_raise CapistranoConfigurationError do
+      configure :test do
+        configure :this
+      end
+    end
+  end
+
+  def test_environment_cannot_be_used_on_its_own
+    assert_raise CapistranoConfigurationError do
+      environment :test
+    end
+  end
+
+  def test_config_cannot_be_used_on_its_own
+    assert_raise CapistranoConfigurationError do
+      config :key, :value
+    end
+  end
+
+  def test_configure_requires_a_block
+    assert_raise CapistranoConfigurationError do
+      configure :test
+    end
+  end
+
+  def test_environment_requires_a_block
+    assert_raise CapistranoConfigurationError do
+      configure :test do
+        environment :test
+      end
+    end
+  end
+
+  def test_configure_stores_correct_settings
+    configure :test do
+      assert_equal :test, @@current_config
+    end
+    assert_equal({ :test => {} }, @@configurations)
+    assert_equal nil, @@current_config
+  end
+
+  def test_configure_stores_symbols
+    configure 'test' do
+      assert_equal :test, @@current_config
+    end
+  end
+
+  def test_config_within_an_configure
+    configure :test do
+      config 'key', 'value'
+    end
+    assert_equal({ :test => { 'key' => 'value' } }, @@configurations)
+  end
+
+  def test_config_within_an_environment_within_an_configure
+    configure :test do
+      environment :test do
+        config 'key', 'value'
+      end
+    end
+    assert_equal({ :test => { :test => { 'key' => 'value' } } }, @@configurations)
+  end
+
+  def test_config_within_two_environments_within_an_configure
+    configure :test do
+      environment :test do
+        environment :test do
+          config 'key', 'value'
+        end
+      end
+    end
+    assert_equal({ :test => { :test => { :test => { 'key' => 'value' } } } }, @@configurations)
+  end
+
+  def test_config_within_different_environments_within_a_configure
+    configure :test do
+      environment :test1 do
+        config 'key', 'value'
+      end
+      environment :test2 do
+        config 'key', 'value'
+      end
+    end
+    assert_equal({ :test => { :test1 => { 'key' => 'value' },
+                              :test2 => { 'key' => 'value' } } }, @@configurations)
+  end
+
+  def test_config_within_different_environments_within_an_environment_within_an_configure
+    configure :test do
+      environment :test1 do
+        environment :test2 do
+          config 'key', 'value'
+        end
+        environment :test3 do
+          config 'key', 'value'
+        end
+      end
+    end
+    assert_equal({ :test => { :test1 => { :test2 => { 'key' => 'value' },
+                                          :test3 => { 'key' => 'value' } } } }, @@configurations)
+  end
+
+  def test_complex_nesting_with_multiple_environments_and_configurations
+    configure :test do
+      environment :test1 do
+        environment :test2 do
+          config 'key', 'value'
+          environment :test3 do
+            config 'key', 'value'
+            environment :test4 do
+              config 'key', 'value'
+            end
+            environment :test5 do
+              config 'key', 'value'
+              environment :test6 do
+                config 'key', 'value'
+              end
+            end
+          end
+        end
+        environment :test7 do
+          config 'key', 'value'
+        end
+      end
+    end
+    assert_equal({
+      :test => {
+        :test1 => {
+          :test2 => {
+            "key"=>"value",
+            :test3 => {
+              "key"=>"value",
+              :test4 => { "key"=>"value" },
+              :test5 => {
+                "key"=>"value",
+                :test6 => { "key"=>"value" }
+              }
+            }
+          },
+          :test7 => { "key"=>"value" }
+        }
+      }
+    }, @@configurations)
+  end
+
+  def test_normal_usage_of_capistrano_configuration
+    configure :database do
+      environment 'development' do
+        config 'adapter', 'mysql'
+        config 'database', 'test'
+        config 'username', 'test'
+        config 'password', 'test'
+        config 'host', 'localhost'
+      end
+      environment 'production' do
+        config 'adapter', 'mysql'
+        config 'database', 'test'
+        config 'username', 'test'
+        config 'password', 'test'
+        config 'host', 'localhost'
+      end
+      environment 'test' do
+        config 'adapter', 'mysql'
+        config 'database', 'test'
+        config 'username', 'test'
+        config 'password', 'test'
+        config 'host', 'localhost'
+      end
+    end
+    configure :backgroundrb do
+      context :backgroundrb do
+        config :port, 5000
+        config :ip, '127.0.0.1'
+        config :environment, 'production'
+        config :result_storage, 'memcache'
+        config :persistent_disabled, true
+      end
+      config :memcache, "127.0.0.1:11211"
+    end
+    configure :google_map_api do
+      context :google_map_api do
+        config :api_key, 'google-key'
+        config :default_latitude, 1.2345
+        config :default_longitude, 1.2345
+        config :default_zoom_lvl, 2
+      end
+    end
+    configure :site_lockdown_auth_credentials do
+      config 'username', 'username'
+      config 'password', 'password'
+    end
+
+    assert_equal({
+      :database => {
+        "development" => {
+          "username"=>"test",
+          "adapter"=>"mysql",
+          "host"=>"localhost",
+          "password"=>"test",
+          "database"=>"test"
+        },
+        "test" => {
+          "username"=>"test",
+          "adapter"=>"mysql",
+          "host"=>"localhost",
+          "password"=>"test",
+          "database"=>"test"
+        },
+        "production" => {
+          "username"=>"test",
+          "adapter"=>"mysql",
+          "host"=>"localhost",
+          "password"=>"test",
+          "database"=>"test"
+        }
+      },
+      :backgroundrb => {
+        :backgroundrb => {
+          :port=>5000,
+          :ip=>"127.0.0.1",
+          :result_storage=>"memcache",
+          :persistent_disabled=>true,
+          :environment=>"production"
+        },
+        :memcache=>"127.0.0.1:11211"
+      },
+      :google_map_api => {
+        :google_map_api => {
+          :api_key=>"google-key",
+          :default_latitude=>1.2345,
+          :default_longitude=>1.2345,
+          :default_zoom_lvl=>2
+        }
+      },
+      :site_lockdown_auth_credentials => {
+        "username" => "username",
+        "password" => "password"
+      }
+    }, @@configurations)
+  end
+
+  def test_file_path_for
+    configure :test1 do; end
+    configure :test2, :to_file => '/etc/configs/test2.yml' do; end
+    configure :test3, :to_file => '/etc/configs/test3.yml' do; end
+
+    assert_equal "./test1.yml", file_path_for(:test1)
+    assert_equal "/etc/configs/test1.yml", file_path_for(:test1, '/etc/configs')
+    assert_equal "/etc/configs/test2.yml", file_path_for(:test2)
+    assert_equal "/etc/configs/test3.yml", file_path_for(:test3)
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: kete-capistrano-configuration
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors: 
 - Kieran Pilkington
@@ -9,11 +9,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-12 00:00:00 -08:00
+date: 2009-03-09 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: capistrano
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -40,12 +41,12 @@ files:
 - MIT-LICENSE
 - Rakefile
 - README.rdoc
+- test/capistrano_configuration_test.rb
 has_rdoc: true
 homepage: http://github.com/kete/capistrano-configuration
 post_install_message: 
 rdoc_options: 
 - --line-numbers
-- --inline-source
 - --title
 - capistrano-configuration
 - --main