capistrano-multiconfig 0.0.4 → 3.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2444c019b2164fb48b8c2b07ad2b92f43852cfb7
+  data.tar.gz: 22c2d78e1dfeaf94989f2f4a0f0d6f7478db8852
+SHA512:
+  metadata.gz: cd67f960281c7c3e633c1c9cdd9562ebf4c9b4f9ee848a93b8d1229b6e53c446f0ef01dfa2facbd2ff7c8bb5348e99da003b19c0314c9f4af307dafee4124302
+  data.tar.gz: 2e2f10fc4c5f9e4ad3257d1feac61495a50bdd0d3a68c92537e3f204d7ed4b3027771a1b4ec14208b24e2702c745afc0bedae1b5731b15586ec221f2aeb6f955

data/Gemfile

@@ -1 +1,9 @@
 source "http://rubygems.org"
+
+gemspec
+
+gem "capistrano", "3.0.0"
+
+group :test do
+  gem "rspec", "2.14.1"
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Railsware (www.railsware.com)
+
+MIT License
+
+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/README.md

@@ -21,6 +21,14 @@ Add to `Capfile`
     set :config, 'path/to/your/configurations'
     require 'capistrano/multiconfig'
 
+## Capistrano3
+
+Use multiconfig v3.x.x
+
+## Capistrano2
+
+For legacy capistrano v2.x.x use multiconfig gem v0.0.x
+
 ## Example
 
 Assume we need next configurations:
@@ -88,3 +96,14 @@ For example for *:config_root* `config/deploy` task `cap apps/blog/qa.rb` loads
 * config/deploy/apps/blog/qa.rb
 
 So it's easy to put shared configuration.
+
+
+## Testing
+
+    $ bundle install
+    $ rspec -fs spec
+
+## License
+
+* Copyright (c) 2013 Railsware [www.railsware.com](http://www.railsware.com)
+* [MIT](www.opensource.org/licenses/MIT)

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     = "0.0.4"
+  s.version     = "3.0.0"
   s.authors     = ["Andriy Yanko"]
   s.email       = ["andriy.yanko@gmail.com"]
   s.homepage    = "https://github.com/railsware/multiconfig"
@@ -22,5 +22,5 @@ Each configuration loads recursively configuration from namespace files and own
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_runtime_dependency "capistrano", ">=2.5.5"
+  s.add_runtime_dependency "capistrano", ">=3.0.0"
 end

data/fixtures/Capfile

@@ -0,0 +1,7 @@
+set :config_root, ENV.fetch('CONFIG_ROOT')
+
+require 'capistrano/multiconfig'
+
+task :hello_world do
+  puts fetch(:message, "hello")
+end

data/fixtures/config/double_nested_shared_file/level0.rb

@@ -0,0 +1 @@
+set :message, "hello from level0"

data/fixtures/config/double_nested_shared_file/level0/level1.rb

@@ -0,0 +1 @@
+set :message, "#{fetch(:message)} level1"

data/fixtures/config/double_nested_shared_file/level0/level1/config.rb

@@ -0,0 +1 @@
+set :message, "#{fetch(:message)} world"

data/fixtures/config/nested_with_shared_file/app.rb

@@ -0,0 +1 @@
+set :message, "hello from shared world"

data/fixtures/config/nested_with_shared_file/app/production.rb

@@ -0,0 +1 @@
+set :message, "hello from production world"

data/fixtures/config/sample/apps/world1.rb

@@ -0,0 +1 @@
+set :message, "hello from world1"

data/fixtures/config/sample/apps/world2.rb

@@ -0,0 +1 @@
+set :message, "hello from world2"

data/lib/capistrano/multiconfig.rb

@@ -1,2 +1,24 @@
 require 'capistrano/multiconfig/configurations'
-require 'capistrano/multiconfig/ensure'
+
+include Capistrano::DSL
+
+config_root_path = File.expand_path(fetch(:config_root, "config/deploy"))
+
+config_names = Capistrano::Multiconfig::Configurations.find_names(config_root_path)
+
+config_names.each do |config_name|
+  Rake::Task.define_task(config_name) do
+    set(:config_name, config_name)
+    segments = config_name.split(":")
+    segments.size.times do |i|
+      path = File.join([config_root_path] + segments[0..i]) + '.rb'
+      load(path) if File.exists?(path)
+    end
+  end.add_description("Load #{config_name} configuration")
+end
+
+set(:config_names, config_names)
+
+def stages
+  fetch(:config_names)
+end

data/lib/capistrano/multiconfig/configurations.rb

@@ -1,90 +1,49 @@
-Capistrano::Configuration.instance(true).load do
-  # configurations root directory
-  config_root = File.expand_path(fetch(:config_root, "config/deploy"))
-
-  # list of configurations files
-  config_files = Dir["#{config_root}/**/*.rb"]
+module Capistrano
+  module Multiconfig
+    class Configurations
+      def self.find_names(root_path)
+        new(root_path).find_names
+      end
 
-  # remove configuration file if it's part of another configuration
-  config_files.reject! do |config_file|
-    config_dir = config_file.gsub(/\.rb$/, '/')
-    config_files.any? { |file| file[0, config_dir.size] == config_dir }
-  end
+      attr_reader :root_path
 
-  # build configuration names list
-  config_names = config_files.map do |config_file|
-    config_file.sub("#{config_root}/", '').sub(/\.rb$/, '').gsub('/', ':')
-  end
+      def initialize(root_path)
+        @root_path = root_path
+      end
 
-  # ensure that configuration segments don't override any method, task or namespace
-  config_names.each do |config_name|
-    config_name.split(':').each do |segment|
-      if all_methods.any? { |m| m == segment }
-        raise ArgumentError,
-          "Config task #{config_name} name overrides #{segment.inspect} (method|task|namespace)"
+      # find configuration names
+      def find_names
+        files = scan_files
+        files.sort!
+        remove_shared_files!(files)
+        build_names(files)
       end
-    end
-  end
 
-  # create configuration task for each configuration name
-  config_names.each do |config_name|
-    segments = config_name.split(':')
-    namespace_names = segments[0, segments.size - 1]
-    task_name = segments.last
+      private
 
-    # create configuration task block.
-    # NOTE: Capistrano 'namespace' DSL invokes instance_eval that
-    # that pass evaluable object as argument to block.
-    block = lambda do |parent|
-      desc "Load #{config_name} configuration"
-      task(task_name) do
-        # set configuration name as :config_name variable
-        top.set(:config_name, config_name)
+      # Scan recursively root path
+      def scan_files
+        Dir["#{root_path}/**/*.rb"]
+      end
 
-        # recursively load configurations
-        segments.size.times do |i|
-          path = ([config_root] + segments[0..i]).join('/') + '.rb'
-          top.load(:file => path) if File.exists?(path)
+      # 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
-    end
 
-    # wrap task block into namespace blocks
-    #
-    # namespace_names = [nsN, ..., ns2, ns1]
-    #
-    # block = block0 = lambda do |parent|
-    #   desc "DESC"
-    #   task(:task_name) { TASK }
-    # end
-    # block = block1 = lambda { |parent| parent.namespace(:ns1, &block0) }
-    # block = block2 = lambda { |parent| parent.namespace(:ns2, &block1) }
-    # ...
-    # block = blockN = lambda { |parent| parent.namespace(:nsN, &blockN-1) }
-    #
-    block = namespace_names.reverse.inject(block) do |child, name|
-      lambda do |parent|
-        parent.namespace(name, &child)
+      # 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
-
-    # create namespaced configuration task
-    #
-    # block = lambda do
-    #   namespace :nsN do
-    #     ...
-    #     namespace :ns2 do
-    #       namespace :ns1 do
-    #         desc "DESC"
-    #         task(:task_name) { TASK }
-    #       end
-    #     end
-    #     ...
-    #   end
-    # end
-    block.call(top)
   end
-
-  # set configuration names list
-  set(:config_names, config_names)
 end

data/spec/capistrano/multiconfig/configurations_spec.rb

@@ -0,0 +1,100 @@
+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

data/spec/integration_spec.rb

@@ -0,0 +1,92 @@
+describe "integration" do
+  def run_cap(args)
+    Dir.chdir 'fixtures' do
+      `env CONFIG_ROOT=#{config_root} bundle exec cap #{args}`
+    end
+  end
+
+  describe "displaying tasks" do
+    subject do
+      run_cap("-T")
+    end
+
+    context "two files root" do
+      let(:config_root) { "config/two_files" }
+
+      it "should display configurations" do
+        subject.should == <<-TEXT
+cap production  # Load production configuration
+cap staging     # Load staging configuration
+TEXT
+      end
+    end
+
+    context "third level nested root" do
+      let(:config_root) { "config/third_level_nested" }
+
+      it "should display configurations" do
+        subject.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' }
+
+      context "without configuration" do
+        subject { run_cap("hello_world") }
+        it "should require configuration" do
+          subject.should include("Stage not set")
+        end
+      end
+
+      context "with apps:world1 configuration" do
+        subject { run_cap("apps:world1 hello_world") }
+
+        it "should use value set in configuration" do
+          subject.should == "hello from world1\n"
+        end
+      end
+
+      context "with apps:world2 configuration" do
+        subject { run_cap("apps:world2 hello_world") }
+
+        it "should use value set in configuration" do
+          subject.should == "hello from world2\n"
+        end
+      end
+    end
+
+    context "configurations with shared file" do
+      let(:config_root) { 'config/nested_with_shared_file' }
+      context "with app:production" do
+        subject { run_cap("app:production hello_world") }
+        it "should display certain message" do
+          subject.should == "hello from production world\n"
+        end
+      end
+      context "with app:staging" do
+        subject { run_cap("app:staging hello_world") }
+        it "should display shared message" do
+          subject.should == "hello from shared world\n"
+        end
+      end
+    end
+
+    context "configuration with double nested shared file" do
+      let(:config_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"
+      end
+    end
+  end
+
+end

metadata

@@ -1,94 +1,105 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: capistrano-multiconfig
-version: !ruby/object:Gem::Version 
-  hash: 23
-  prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 4
-  version: 0.0.4
+version: !ruby/object:Gem::Version
+  version: 3.0.0
 platform: ruby
-authors: 
+authors:
 - Andriy Yanko
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-04-27 00:00:00 +03:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-10-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: capistrano
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 17
-        segments: 
-        - 2
-        - 5
-        - 5
-        version: 2.5.5
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
   type: :runtime
-  version_requirements: *id001
-description: "\n\
-  Multiconfig extension is similar to [multistage](https://github.com/capistrano/capistrano-ext) extenstion.\n\
-  But it's not only about 'stage' configurations. It's about any configuration that you may need.\n\
-  Extension recursively builds configuration list from configuration root directory.\n\
-  Each configuration loads recursively configuration from namespace files and own configuration file.\n  "
-email: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: "\nMulticonfig extension is similar to [multistage](https://github.com/capistrano/capistrano-ext)
+  extenstion.\nBut it's not only about 'stage' configurations. It's about any configuration
+  that you may need.\nExtension recursively builds configuration list from configuration
+  root directory.\nEach configuration loads recursively configuration from namespace
+  files and own configuration file.\n  "
+email:
 - andriy.yanko@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - capistrano-multiconfig.gemspec
+- fixtures/Capfile
+- fixtures/config/double_nested_shared_file/level0.rb
+- fixtures/config/double_nested_shared_file/level0/level1.rb
+- fixtures/config/double_nested_shared_file/level0/level1/config.rb
+- fixtures/config/empty/.gitkeep
+- fixtures/config/nested/app/production.rb
+- fixtures/config/nested/app/staging.rb
+- fixtures/config/nested_with_another_file/app/production.rb
+- fixtures/config/nested_with_another_file/app/staging.rb
+- fixtures/config/nested_with_another_file/deploy.rb
+- fixtures/config/nested_with_shared_and_another_file/app.rb
+- fixtures/config/nested_with_shared_and_another_file/app/production.rb
+- fixtures/config/nested_with_shared_and_another_file/app/staging.rb
+- fixtures/config/nested_with_shared_and_another_file/deploy.rb
+- fixtures/config/nested_with_shared_file/app.rb
+- fixtures/config/nested_with_shared_file/app/production.rb
+- fixtures/config/nested_with_shared_file/app/staging.rb
+- fixtures/config/sample/apps/world1.rb
+- fixtures/config/sample/apps/world2.rb
+- fixtures/config/third_level_nested/app/blog/production.rb
+- fixtures/config/third_level_nested/app/blog/staging.rb
+- fixtures/config/third_level_nested/app/wiki/production.rb
+- fixtures/config/third_level_nested/app/wiki/qa.rb
+- fixtures/config/two_files/production.rb
+- fixtures/config/two_files/staging.rb
+- fixtures/config/two_nested/api/production.rb
+- fixtures/config/two_nested/api/staging.rb
+- fixtures/config/two_nested/app/production.rb
+- fixtures/config/two_nested/app/staging.rb
+- fixtures/config/with_foreign_file/production.rb
+- fixtures/config/with_foreign_file/readme.md
+- fixtures/config/with_foreign_file/staging.rb
 - lib/capistrano/multiconfig.rb
 - lib/capistrano/multiconfig/configurations.rb
-- lib/capistrano/multiconfig/ensure.rb
-has_rdoc: true
+- spec/capistrano/multiconfig/configurations_spec.rb
+- spec/integration_spec.rb
 homepage: https://github.com/railsware/multiconfig
 licenses: []
-
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: capistrano-multiconfig
-rubygems_version: 1.5.2
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Capistrano extension that allows to use multiple configurations
-test_files: []
-
+test_files:
+- spec/capistrano/multiconfig/configurations_spec.rb
+- spec/integration_spec.rb

data/lib/capistrano/multiconfig/ensure.rb

@@ -1,15 +0,0 @@
-Capistrano::Configuration.instance(true).load do
-  namespace :multiconfig do
-    desc "[internal] Ensure that a configuration has been selected"
-    task :ensure do
-      unless exists?(:config_name)
-        puts "No configuration specified. Please specify one of:"
-        config_names.each { |name| puts "  * #{name}" }
-        puts "(e.g. `cap #{config_names.first} #{ARGV.last}')"
-        abort
-      end
-    end
-  end
-
-  on :start, 'multiconfig:ensure', :except => config_names
-end