capistrano-configuration 0.2.0

data/CHANGELOG.rdoc

@@ -0,0 +1,21 @@
+== 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
+    - Replacing 'echo >>' syntax with Capistrano's much less buggy 'put' command
+
+== 0.1.1 (January 7, 2009)
+
+* Fixing deployment issues
+    - Configuration write now happens after symlink, not code update (so current directory is present)
+    - YAML files were parsing incorrectly (would leave backslashes at the end of lines breaking format)
+
+== 0.1.0 (January 6, 2009)
+
+* Initial Release

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Kieran Pilkington
+
+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/Manifest

@@ -0,0 +1,9 @@
+capistrano-configuration.gemspec
+CHANGELOG.rdoc
+install.rb
+lib/capistrano-configuration.rb
+Manifest
+MIT-LICENSE
+Rakefile
+README.rdoc
+test/capistrano_configuration_test.rb

data/README.rdoc

@@ -0,0 +1,54 @@
+= Capistrano Configuration
+
+Capistrano Configuration allows you to create configurations on deployment,
+so you don't have to worry about copy different yml files to the right place
+(especially when you have multiple deploy stages in one repository)
+
+
+== Installation
+
+  sudo gem install kete-capistrano-configuration --source=http://gems.github.com
+
+
+== Usage
+
+Simply add the following to your deploy.rb file:
+
+  require 'capistrano-configuration'
+
+and then write your configurations in ruby like so:
+
+  configure :database do
+    environment 'development' do
+      config 'username', 'app'
+      config 'password', 'secret'
+    end
+    environment 'production' do
+      config 'username', 'app_production'
+      config 'password', 'secret_production'
+    end
+  end
+  
+  configure :google_map_key do
+    config 'map_key', 'u232398b208x9830x30xb383'
+  end
+
+The gem will take care of the rest. It stores your configurations,
+and after the code is updated, it'll write the configurations needed
+for things like migrations.
+
+Note: The method name environment doesn't suit all configurations, so
+that method has an alias called 'context' which you can use to do the
+same thing.
+
+
+== Bug and Feature Requests
+
+You can report bugs and request features / submit patches at our Lighthouse account
+
+http://kete.lighthouseapp.com/projects/23036-capistrano-configuration
+
+
+== Credits
+
+Gem created and maintained by Kieran Pilkington <kieran@katipo.co.nz>

data/Rakefile

@@ -0,0 +1,41 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+namespace :gem do
+
+  task :default => ['gem:build', 'gem:install']
+
+  desc 'Build the Capistrano Configuration Gem'
+  task :build do
+    Dir['*.gem'].each do |gem_filename|
+      sh "rm -rf #{gem_filename}"
+    end
+    sh "gem build capistrano-configuration.gemspec"
+  end
+
+  desc 'Install the Capistrano Configuration Gem'
+  task :install do
+    gem_filename = Dir['*.gem'].first
+    sh "sudo gem install #{gem_filename}"
+  end
+
+end
+
+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

@@ -0,0 +1,34 @@
+# Gem::Specification for capistrano-configuration
+
+Gem::Specification.new do |s|
+  s.name              = "capistrano-configuration"
+  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"
+  s.summary           = "Configure your application on deployment"
+  s.description       = "Write application configuration files on deployment with Ruby"
+  s.require_path      = "lib"
+  s.files             = %w{ capistrano-configuration.gemspec
+                            CHANGELOG.rdoc
+                            install.rb
+                            lib/capistrano-configuration.rb
+                            Manifest
+                            MIT-LICENSE
+                            Rakefile
+                            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",
+                         "--title",
+                         "capistrano-configuration",
+                         "--main",
+                         "README.rdoc"]
+  s.rubygems_version  = "1.1.1"
+  s.add_dependency      "capistrano", ">= 1.1.0"
+  s.rubyforge_project = "capistrano-conf"
+end

data/install.rb

@@ -0,0 +1 @@
+puts IO.read(File.join(File.dirname(__FILE__), 'README.rdoc'))

data/lib/capistrano-configuration.rb

@@ -0,0 +1,84 @@
+unless Capistrano::Configuration.respond_to?(:instance)
+  abort "capistrano-configuration requires Capistrano 2"
+end
+
+module CapistranoConfiguration
+  unless included_modules.include? CapistranoConfiguration
+
+    class CapistranoConfigurationError < Exception; end
+
+    @@current_config = nil
+    @@configurations = Hash.new
+    @@locations = Hash.new
+    @@current_envs = Array.new
+    @@original_envs = Array.new
+
+    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)
+      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_envs = @@original_envs.pop
+    end
+    alias :context :environment
+
+    def 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
+        "#{default}/#{configuration}.yml"
+      end
+    end
+
+    Capistrano::Configuration.instance.load do
+
+      namespace :deploy do
+
+        namespace :configuration do
+
+          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 |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
+
+Capistrano::Configuration.send(:include, CapistranoConfiguration)

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

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: capistrano-configuration
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Kieran Pilkington
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-09 00:00:00 +13:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: capistrano
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.0
+    version: 
+description: Write application configuration files on deployment with Ruby
+email: kieran@katipo.co.nz
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG.rdoc
+- MIT-LICENSE
+- README.rdoc
+files: 
+- capistrano-configuration.gemspec
+- CHANGELOG.rdoc
+- install.rb
+- lib/capistrano-configuration.rb
+- Manifest
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+- test/capistrano_configuration_test.rb
+has_rdoc: true
+homepage: http://github.com/kete/capistrano-configuration
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --title
+- capistrano-configuration
+- --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: capistrano-conf
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Configure your application on deployment
+test_files: []
+