capistrano-multiconfig 3.0.1 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7a4a01eddf6db929483491f1ab6e8f1bee0c1de0
-  data.tar.gz: 37b27ad85cb0cdfb72562e666e3886c90a09256d
+  metadata.gz: 2c9b7fb215030f53d9d0eff91305889ad41b26a7
+  data.tar.gz: 29adfd8cfd8a8864ea0cb39597aa54b46d143428
 SHA512:
-  metadata.gz: 4125540d382803fa4f317d7452eeb83229bae15457aaefab91de85b1f5d2c3331d492b6e3dc9441c48c23d63ecd5e3818875f1141aaacc2f71c5811c7442d7a6
-  data.tar.gz: a1e9b7b9dbad421babef44a1704180a9a8d90156a87ca8e0b76d8f8048ead068cad6b234f80d08df0b335cc1d216d74142f76fbaff4d4256e2d1cc4e71f4be18
+  metadata.gz: 6ddd88b0ee9b23fd0f94f26ce880e3ec304fe38c18aa4afd38c27e4a92b63060f43e129a395a9a68ef0fe449cbc7ec7b4241fb71c6f55a9363f45dfc0b3393aa
+  data.tar.gz: 9ec37a468dc70b0524814853c5ca2a7edb223f57458285288cded0cc7679020ccc93382be91a79a733652f1401bba103b7f30f66173cd79c8569de3f5ac6071b

data/README.md

@@ -9,6 +9,11 @@ But it's not only about 'stage' configurations. It's about any configuration tha
 Extension recursively builds configuration list from configuration root directory.
 Each configuration loads recursively configuration from it namespace files and own configuration file.
 
+## Purpose
+
+Extension was specially created to implement [Caphub](https://github.com/railsware/caphub) concept.
+[Read more](http://railsware.com/blog/2011/11/18/caphub-multiple-applications-deployment-with-capistrano/).
+
 ## Usage
 
 Install gem
@@ -51,7 +56,6 @@ Create configuration files:
 
 Add to `Capfile`:
 
-    set :config_root, 'config/deploy'
     require 'capistrano/multiconfig'
 
 Put related capistrano configuration to each file according to file meaning.
@@ -89,7 +93,7 @@ So we must provide configuration as first task:
 Configuration task loads not only configuration associated with it filename.
 It also recursively load configurations from all namespaces.
 
-For example for *:config_root* `config/deploy` task `cap apps/blog/qa.rb` loads with **order** next configuration files (if they exist):
+For example task `cap apps/blog/qa.rb` loads with **order** next configuration files (if they exist):
 
 * config/deploy/apps.rb
 * config/deploy/apps/blog.rb
@@ -97,6 +101,12 @@ For example for *:config_root* `config/deploy` task `cap apps/blog/qa.rb` loads
 
 So it's easy to put shared configuration.
 
+## Custom stages configuration location
+
+Specify in `Capfile`:
+
+    set :stages_root, 'deployment'
+    require 'capistrano/multiconfig'
 
 ## Testing
 
@@ -107,3 +117,9 @@ So it's easy to put shared configuration.
 
 * Copyright (c) 2013 Railsware [www.railsware.com](http://www.railsware.com)
 * [MIT](www.opensource.org/licenses/MIT)
+
+## References
+
+* [capistrano](https://github.com/capistrano/capistrano)
+* [caphub](https://github.com/railsware/caphub)
+

data/capistrano-multiconfig.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "capistrano-multiconfig"
-  s.version     = "3.0.1"
+  s.version     = "3.0.2"
   s.authors     = ["Andriy Yanko"]
   s.email       = ["andriy.yanko@gmail.com"]
   s.homepage    = "https://github.com/railsware/multiconfig"

data/fixtures/Capfile

@@ -1,7 +1,9 @@
-set :config_root, ENV.fetch('CONFIG_ROOT')
+set :stages_root, ENV.fetch('STAGES_ROOT')
 
 require 'capistrano/multiconfig'
 
 task :hello_world do
   puts fetch(:message, "hello")
 end
+
+# vim syntax=ruby

data/lib/capistrano/multiconfig.rb

@@ -1,33 +1,85 @@
-require 'capistrano/multiconfig/configurations'
-
 include Capistrano::DSL
 
-config_root_path = File.expand_path(fetch(:config_root, "config/deploy"))
+def stages_root
+  fetch(:stages_root, 'config/deploy')
+end
+
+# Build stages with nested configurations
+#
+# @example simple stages
+#
+#   config
+#   ├── deploy
+#   │   ├── production.rb
+#   │   └── staging.rb
+#   └── deploy.rb
+#
+# * cap production
+# * cap staging
+#
+# @example stages with nested configurations
+#
+#   config
+#   ├── deploy
+#   │   ├── soa
+#   │   │   ├── blog
+#   │   │   │   ├── production.rb
+#   │   │   │   └── staging.rb
+#   │   │   └── wiki
+#   │   │       └── qa.rb
+#   │   └── soa.rb
+#   └── deploy.rb
+#
+# * cap soa:blog:production
+# * cap soa:blog:staging
+# * cap soa:wiki:qa
+def stages
+  Dir["#{stages_root}/**/*.rb"].map { |file|
+    file.slice(stages_root.size + 1 .. -4).tr('/', ':')
+  }.tap { |paths|
+    paths.reject! { |path|
+      paths.any? { |another| another != path && another.start_with?(path) }
+    }
+  }.sort
+end
 
-config_names = Capistrano::Multiconfig::Configurations.find_names(config_root_path)
+stages.each do |stage|
+  Rake::Task.define_task(stage) do
 
-config_names.each do |config_name|
-  Rake::Task.define_task(config_name) do
-    set(:config_name, config_name)
+    # Set stage variable
+    set(:stage, stage)
 
+    # Load defaults variables
     load "capistrano/defaults.rb"
 
-    paths = [ config_root_path + '.rb' ]
-
-    (segments = config_name.split(":")).size.times do |i|
-      paths << File.join([config_root_path] + segments[0..i]) + '.rb'
+    # Load stage configuration(s).
+    #
+    # For stage 'production' will be loaded next configurations:
+    #
+    # * config/deploy.rb
+    # * config/deploy/production.rb
+    #
+    # For stage 'soa:blog:production' will be loaded next configurations:
+    #
+    # * config/deploy.rb
+    # * config/deploy/soa.rb
+    # * config/deploy/soa/blog.rb
+    # * config/deploy/soa/blog/production.rb
+    stage.split(':').inject([stages_root]) do |paths, segment|
+      paths << File.join(paths.last, segment)
+    end.each do |path|
+      file = "#{path}.rb"
+      load(file) if File.exists?(file)
     end
 
-    paths.each { |path| load(path) if File.exists?(path) }
-
+    # Load SCM tasks
     load "capistrano/#{fetch(:scm)}.rb"
+
+    # Set locale
     I18n.locale = fetch(:locale, :en)
-    configure_backend
-  end.add_description("Load #{config_name} configuration")
-end
 
-set(:config_names, config_names)
+    # configure core backend
+    configure_backend
 
-def stages
-  fetch(:config_names)
+  end.add_description("Load #{stage} configuration")
 end

data/spec/integration_spec.rb

@@ -1,7 +1,7 @@
 describe "integration" do
   def run_cap(args)
     Dir.chdir 'fixtures' do
-      `env CONFIG_ROOT=#{config_root} bundle exec cap #{args}`
+      `env STAGES_ROOT=#{stages_root} bundle exec cap #{args}`
     end
   end
 
@@ -10,8 +10,13 @@ describe "integration" do
       run_cap("-T")
     end
 
+    context "empty root" do
+      let(:stages_root) { 'config/empty' }
+      it { should == "" }
+    end
+
     context "two files root" do
-      let(:config_root) { "config/two_files" }
+      let(:stages_root) { 'config/two_files' }
 
       it "should display configurations" do
         subject.should == <<-TEXT
@@ -21,24 +26,90 @@ TEXT
       end
     end
 
+    context "root with nested directory and two files inside" do
+      let(:stages_root) { 'config/nested' }
+      it {
+        should == <<-TEXT
+cap app:production  # Load app:production configuration
+cap app:staging     # Load app:staging configuration
+TEXT
+      }
+    end
+
+    context "root with two nested directories and two files inside" do
+      let(:stages_root) { 'config/two_nested' }
+      it {
+        should == <<-TEXT
+cap api:production  # Load api:production configuration
+cap api:staging     # Load api:staging configuration
+cap app:production  # Load app:production configuration
+cap app:staging     # Load app:staging configuration
+TEXT
+      }
+    end
+
+    context "root nested with shared file" do
+      let(:stages_root) { 'config/nested_with_shared_file' }
+      it {
+        should == <<-TEXT
+cap app:production  # Load app:production configuration
+cap app:staging     # Load app:staging configuration
+TEXT
+      }
+    end
+
+    context "root nested with another file" do
+      let(:stages_root) { 'config/nested_with_another_file' }
+      it {
+        should == <<-TEXT
+cap app:production  # Load app:production configuration
+cap app:staging     # Load app:staging configuration
+cap deploy          # Load deploy configuration
+TEXT
+      }
+    end
+
+    context "root nested with shared and another file" do
+      let(:stages_root) { 'config/nested_with_shared_and_another_file' }
+      it {
+        should == <<-TEXT
+cap app:production  # Load app:production configuration
+cap app:staging     # Load app:staging configuration
+cap deploy          # Load deploy configuration
+TEXT
+      }
+    end
+
+    context "root with foreign file" do
+      let(:stages_root) { 'config/with_foreign_file' }
+      it {
+        should == <<-TEXT
+cap production  # Load production configuration
+cap staging     # Load staging configuration
+TEXT
+      }
+    end
+
     context "third level nested root" do
-      let(:config_root) { "config/third_level_nested" }
+      let(:stages_root) { "config/third_level_nested" }
 
-      it "should display configurations" do
-        subject.should == <<-TEXT
+      it  {
+        should == <<-TEXT
 cap app:blog:production  # Load app:blog:production configuration
 cap app:blog:staging     # Load app:blog:staging configuration
 cap app:wiki:production  # Load app:wiki:production configuration
 cap app:wiki:qa          # Load app:wiki:qa configuration
 TEXT
-      end
+      }
     end
   end
 
+
+
   describe "task invocation" do
 
     context "sample configurations" do
-      let(:config_root) { 'config/sample' }
+      let(:stages_root) { 'config/sample' }
 
       context "without configuration" do
         subject { run_cap("hello_world") }
@@ -65,7 +136,7 @@ TEXT
     end
 
     context "configurations with shared file" do
-      let(:config_root) { 'config/nested_with_shared_file' }
+      let(:stages_root) { 'config/nested_with_shared_file' }
       context "with app:production" do
         subject { run_cap("app:production hello_world") }
         it "should display certain message" do
@@ -81,7 +152,7 @@ TEXT
     end
 
     context "configuration with double nested shared file" do
-      let(:config_root) { 'config/double_nested_shared_file' }
+      let(:stages_root) { 'config/double_nested_shared_file' }
       subject { run_cap("level0:level1:config hello_world") }
       it "should display nested message from all levels" do
           subject.should == "hello from level0 level1 world\n"
@@ -89,7 +160,7 @@ TEXT
     end
 
     context "configuration with root and nested" do
-      let(:config_root) { 'config/root_with_nested' }
+      let(:stages_root) { 'config/root_with_nested' }
       subject { run_cap("app:config hello_world") }
       it "should display nested message from root" do
         subject.should == "hello from root world\n"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-multiconfig
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.0.2
 platform: ruby
 authors:
 - Andriy Yanko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-16 00:00:00.000000000 Z
+date: 2013-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -76,8 +76,6 @@ files:
 - fixtures/config/with_foreign_file/readme.md
 - fixtures/config/with_foreign_file/staging.rb
 - lib/capistrano/multiconfig.rb
-- lib/capistrano/multiconfig/configurations.rb
-- spec/capistrano/multiconfig/configurations_spec.rb
 - spec/integration_spec.rb
 homepage: https://github.com/railsware/multiconfig
 licenses: []
@@ -103,5 +101,4 @@ signing_key:
 specification_version: 4
 summary: Capistrano extension that allows to use multiple configurations
 test_files:
-- spec/capistrano/multiconfig/configurations_spec.rb
 - spec/integration_spec.rb

data/lib/capistrano/multiconfig/configurations.rb

@@ -1,49 +0,0 @@
-module Capistrano
-  module Multiconfig
-    class Configurations
-      def self.find_names(root_path)
-        new(root_path).find_names
-      end
-
-      attr_reader :root_path
-
-      def initialize(root_path)
-        @root_path = root_path
-      end
-
-      # find configuration names
-      def find_names
-        files = scan_files
-        files.sort!
-        remove_shared_files!(files)
-        build_names(files)
-      end
-
-      private
-
-      # Scan recursively root path
-      def scan_files
-        Dir["#{root_path}/**/*.rb"]
-      end
-
-      # Remove path when there is the same directory with child.
-      #
-      # app/staging.rb (is shared configuration for 'alpha' and 'beta')
-      # app/staging/alpha.rb
-      # app/staging/beta.rb
-      def remove_shared_files!(files)
-        files.reject! do |file|
-          dir = file.gsub(/\.rb$/, '/')
-          files.any? { |f| f[0, dir.size] == dir }
-        end
-      end
-
-      # Convert "app/blog/production" to "app:blog:production"
-      def build_names(files)
-        files.map do |file|
-          file.sub("#{root_path}/", '').sub(/\.rb$/, '').gsub('/', ':')
-        end
-      end
-    end
-  end
-end

data/spec/capistrano/multiconfig/configurations_spec.rb

@@ -1,100 +0,0 @@
-require 'capistrano/multiconfig/configurations'
-
-describe Capistrano::Multiconfig::Configurations do
-
-  describe ".find_names" do
-    subject { described_class.find_names(config_root) }
-
-    context "empty root" do
-      let(:config_root) { 'fixtures/config/empty' }
-      it { should == [] }
-    end
-
-    context "root with two files" do
-      let(:config_root) { 'fixtures/config/two_files' }
-      it {
-        should == [
-          'production',
-          'staging'
-        ]
-      }
-    end
-
-    context "root with nested directory and two files inside" do
-      let(:config_root) { 'fixtures/config/nested' }
-      it {
-        should == [
-          'app:production',
-          'app:staging'
-        ]
-      }
-    end
-
-    context "root with two nested directories and two files inside" do
-      let(:config_root) { 'fixtures/config/two_nested' }
-      it {
-        should == [
-          'api:production',
-          'api:staging',
-          'app:production',
-          'app:staging'
-        ]
-      }
-    end
-
-    context "root with third nested directories" do
-      let(:config_root) { 'fixtures/config/third_level_nested' }
-      it {
-        should == [
-          'app:blog:production',
-          'app:blog:staging',
-          'app:wiki:production',
-          'app:wiki:qa'
-        ]
-      }
-    end
-
-    context "root nested with shared file" do
-      let(:config_root) { 'fixtures/config/nested_with_shared_file' }
-      it {
-        should == [
-          'app:production',
-          'app:staging',
-        ]
-      }
-    end
-
-    context "root nested with another file" do
-      let(:config_root) { 'fixtures/config/nested_with_another_file' }
-      it {
-        should == [
-          'app:production',
-          'app:staging',
-          'deploy'
-        ]
-      }
-    end
-
-    context "root nested with shared and another file" do
-      let(:config_root) { 'fixtures/config/nested_with_shared_and_another_file' }
-      it {
-        should == [
-          'app:production',
-          'app:staging',
-          'deploy'
-        ]
-      }
-    end
-
-    context "root with foreign file" do
-      let(:config_root) { 'fixtures/config/with_foreign_file' }
-      it {
-        should == [
-          'production',
-          'staging'
-        ]
-      }
-    end
-
-  end
-end