capistrano_multiconfig_parallel 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 96a47c7dcecfeada5fe7fb23dd257df92fd521f9
+  data.tar.gz: 20512948d23bc465d2bb4146ed7f41ffe887f991
+SHA512:
+  metadata.gz: 724ae116cd13d103f79ed45225d74a68cce7087e5e068d1d5a440597a228a85375523a9ab7c29a5940a5f3d3f9708fa430ae88f1449396456108f63d776631e6
+  data.tar.gz: 0054782386ac8e6eacae69d3fb3e166e49170bf31d9893417f7d9d4fa7bd810a0cdeb6c1ed4cb534110c19e1cd4b73f7953980bea50ba09a6152e5a4a6053faa

data/.coveralls.yml

@@ -0,0 +1,2 @@
+service_name: travis-ci
+repo_token: 8c9edNJkEV8BFTLrfU11md2H4FsSEPT9b

data/.gitignore

@@ -0,0 +1,21 @@
+s.rbx/
+.bundle/
+*.gem
+.idea/
+.rvmrc
+*.swp
+log/*.log
+pkg/
+spec/dummy/db/*.sqlite3
+spec/dummy/log/*.log
+spec/dummy/tmp/
+coverage
+tags
+Gemfile.lock
+/nbproject/
+/.git-rewrite/
+/bin/**/*
+
+# But not these files...
+!.gitignore
+!/bin/multi_cap

data/.rspec

@@ -0,0 +1 @@
+--colour

data/.rubocop.yml

@@ -0,0 +1,68 @@
+AllCops:
+  Exclude:
+    - capistrano_multiconfig_parallel.gemspec
+    - bin/**/*
+    - Guardfile
+
+Documentation:
+  Enabled: true
+
+Encoding:
+  Enabled: false
+
+LineLength:
+  Max: 200
+
+AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+IfUnlessModifier:
+  Enabled: false
+
+CaseIndentation:
+  IndentWhenRelativeTo: case
+  IndentOneStep: true
+
+MethodLength:
+  CountComments: false
+  Max: 20
+
+SignalException:
+  Enabled: false
+
+ColonMethodCall:
+  Enabled: false
+
+AsciiComments:
+  Enabled: false
+
+RegexpLiteral:
+  Enabled: false
+
+AssignmentInCondition:
+  Enabled: false
+
+ParameterLists:
+  CountKeywordArgs: false
+
+SingleLineBlockParams:
+  Methods:
+    - reduce:
+      - memo
+      - item
+
+Metrics/AbcSize:
+  Enabled: false
+
+Style/CollectionMethods:
+  Enabled: true
+
+Style/SymbolArray:
+  Enabled: true
+
+Style/ExtraSpacing:
+  Enabled: true
+
+Style/FileName:
+  Enabled: false
+

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+before_install:
+  - "echo 'gem: --no-ri --no-rdoc' > ~/.gemrc"
+  - gem install bundler
+rvm:
+  - 1.9.3
+  - jruby-19mode
+  - 2.0.0
+env:
+ - RAILS_ENV=test RACK_ENV=test
+notifications:
+  email: false

data/CONTRIBUTING.md

@@ -0,0 +1,44 @@
+# Contributing
+
+We love pull requests. Here's a quick guide.
+
+Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+
+Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+
+Fork, then clone the repo:
+
+    git clone git@github.com:your-username/capistrano_multiconfig_parallel.git
+
+Start a feature/bugfix branch.
+
+Set up your machine:
+
+    bundle install
+
+Make sure the tests pass:
+
+    bundle exec rake
+
+Make your change. Add tests for your change. Make the tests pass:
+
+    bundle exec rake
+
+Push to your fork and [submit a pull request][pr].
+
+[pr]: https://github.com/bogdanRada/capistrano_multiconfig_parallel/compare
+
+At this point you're waiting on us. We like to at least comment on pull requests
+within three business days (and, typically, one business day). We may suggest
+some changes or improvements or alternatives.
+
+Some things that will increase the chance that your pull request is accepted:
+
+* Write tests.
+* Try to follow this [style guide][style].
+* Write a [good commit message][commit].
+
+[style]: https://github.com/thoughtbot/guides/tree/master/style
+[commit]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
+
+Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/Guardfile

@@ -0,0 +1,12 @@
+# More info at https://github.com/guard/guard#readme
+
+# Could be changed to whatever you want.
+#  See: https://github.com/guard/guard#notification
+notification :off
+
+guard 'rspec' do
+  watch %r{^spec/.+_spec\.rb$}
+  watch %r{lib/} do 'spec' end
+end
+
+# vim:ft=ruby

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013 bogdanRada
+
+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

@@ -0,0 +1,220 @@
+capistrano_multiconfig_parallel
+==================
+
+
+Description
+--------
+CapistranoMulticonfigParallel is a simple ruby implementation that allows you to run multiple tasks in parallel for multiple applications and uses websockets for inter-process communication and has a interactive menu
+
+IMPORTANT!  The whole reason for this gem was for using [Caphub][caphub]  in a more easy way and allowing you to run tasks in parallel for multiple aplications . 
+However this can be used for normal applications also, if you want for example to deploy your app to multiple sandboxes on development environment
+or even deploy in parallel to multiple stages.
+
+CAUTION!! PLEASE READ CAREFULLY!! Capistrano is not thread-safe. However in order to work around this problem, each of the task is executing inside a thread that spawns a new process in order to run capistrano tasks
+The thread monitors the process. This works well, however if the tasks you are executing is working with files, you might get into deadlocks because multiple proceses try to access same resource.
+Instead of using files , please consider using StringIO instead. 
+
+[caphub]: https://github.com/railsware/caphub
+
+Requirements
+--------
+1.  [Ruby 1.9.x or Ruby 2.x.x][ruby]
+2. [ActiveSuport >= 4.2.0][activesupport]
+3. [celluloid-pmap >= 0.2.0][celluloid_pmap]
+4. [celluloid_pubsub >= 0.0.11][celluloid_pubsub]
+5. [composable_state_machine >= 1.0.2][composable_state_machine]
+6. [terminal-table >= 1.4.5][terminal_table]
+7. [formatador >= 0.2.5] [formatador]
+8. [colorize] [colorize]
+9. [eventmachine >= 1.0.7] [eventmachine]
+10. [right_popen >= 1.1.3] [right_popen]
+11. [capistrano-multiconfig >= 3.0.8] [capistrano-multiconfig]
+12. [capistrano >= 3.0] [capistrano]
+13. [configurations >= 2.0.0] [configurations]
+
+[ruby]: http://www.ruby-lang.org
+[activesupport]:https://rubygems.org/gems/activesupport
+[celluloid_pubsub]:https://github.com/bogdanRada/celluloid_pubsub
+[celluloid_pmap]:https://github.com/jwo/celluloid-pmap
+[composable_state_machine]: https://github.com/swoop-inc/composable_state_machine
+[terminal_table]: https://github.com/tj/terminal-table
+[formatador]: https://github.com/geemus/formatador
+[colorize]: https://github.com/fazibear/colorize
+[eventmachine]: https://github.com/eventmachine/eventmachine
+[right_popen]: https://github.com/rightscale/right_popen
+[capistrano-multiconfig]: https://github.com/railsware/capistrano-multiconfig
+[capistrano]: https://github.com/capistrano/capistrano/
+[configurations]: https://github.com/beatrichartz/configurations
+
+Compatibility
+--------
+
+Rails >3.0 only. MRI 1.9.x, 2.x
+
+Ruby 1.8 is not officially supported. We will accept further compatibilty pull-requests but no upcoming versions will be tested against it.
+
+Rubinius and Jruby  support temporarily dropped due to Rails 4 incompatibility.
+
+Installation Instructions
+--------
+
+Add the following to your Gemfile:
+  
+```ruby
+  gem "capistrano_multiconfig_parallel"
+```
+
+
+Add the following to your Capfile:
+  
+```ruby
+  require 'capistrano_multiconfig_parallel'
+```
+
+Please read  [Release Details][release-details] if you are upgrading. We break backward compatibility between large ticks but you can expect it to be specified at release notes.
+[release-details]: https://github.com/bogdanRada/capistrano_multiconfig_parallel/releases
+
+Usage Instructions
+--------
+
+[![capistrano multiconfig parallel ](img/parallel_demo.png)](#features)
+
+1. Single Apps ( normal Rails or rack applications) 
+    
+CapistranoMulticonfigParallel recognizes only "development" and "webdev" as stages for development
+if you use other stages for development, you need to configure it like this. This will override the default configuration.
+You will need to require this file in your Capfile also.
+
+```ruby
+CapistranoMulticonfigParallel.configure do |c|
+c.development_stages = ["development", "some_other_stage"]
+end
+```
+### Deploying the application  to multiple sandboxes ( works only with development environments)
+
+```shell
+# <box_name>     - the name of a sandbox
+#<development_stage> - the name of one of the stages you previously configured
+#<task_name> - the capistrano task that you want to execute ( example: 'deploy' )
+
+bundle exec multi_cap  <development_stage> <task_name>   BOX=<box_name>,<box_name> 
+
+```
+
+If a branch is specified using "BRANCH=name" it will deploy same branch to all sandboxes
+If a branch is not specified, will ask for each of the sandboxes the name of the branch to deploy
+The branch environment variable is then passed to the capistrano task
+
+Also the script will ask if there are any other environment variables that user might want to pass to each of the sandboxes separately.
+
+### Deploying the application  to multiple stages  ( Using the customized command "deploy_stages")
+  
+
+```shell
+
+bundle exec multi_cap deploy_stages  STAGES=development, staging, production
+```
+
+If a branch is specified using "BRANCH=name" it will deploy same branch to all stages
+If a branch is not specified, will ask for each of the stage the name of the branch to deploy
+The branch environment variable is then passed to the capistrano process
+
+Also the script will ask if there are any other environment variables that user might want to pass to each of the stages separately.
+
+
+
+2. Multiple Apps ( like [Caphub][caphub]  ) 
+
+
+Configuration for this types of application is more complicated
+
+```ruby
+CapistranoMulticonfigParallel.configure do |c|
+c.development_stages = ['development', 'webdev']  
+c.task_confirmation_active = true
+ c.task_confirmations = ['deploy:symlink:release'] 
+ c.track_dependencies = true
+  c.application_dependencies = [
+    { app: 'blog', priority: 1, dependencies: [] },
+    { app: 'blog2', priority: 2, dependencies: ['blog'] },
+    { app: 'blog3', priority: 3, dependencies: ['blog', 'blog2'] },
+  ]
+end
+```
+
+The "development_stages" options is used so that the gem can know if sandboxes are allowed for those environments.
+
+The "task_confirmation_active" option can have only two values:
+    - false  - all threads are executing normally without needing confirmation from user
+   - true - means threads need confirmation from user ( Can we used to synchronize all processes to wait before executing a task) 
+             For this we use the option "task_confirmations" which is a array with string. 
+              Each string is  the name of the task that needs confirmation.
+
+
+If you want to deploy an application with dependencies you can use   the option "track_dependencies".
+If that options has value "true" , it will ask the user before deploying a application if he needs the dependencies deployed too
+
+The dependencies are being kept in the option "application_dependencies"
+This is an array of hashes. Each hash has only the keys "app" ( app name), "priority" and "dependencies" ( an array of app names that this app is dependent to)
+
+ Default Configuration:
+--------
+
+```ruby
+CapistranoMulticonfigParallel.configure do |c|
+   c.task_confirmations = ['deploy:symlink:release']
+        c.task_confirmation_active = false
+        c.track_dependencies = false
+        c.websocket_server = { enable_debug: false }
+        c.development_stages = ['development', 'webdev']
+end
+```
+
+ Available command line  options when executing a command
+--------
+
+--multi-debug
+   If option is present , will enable debugging of workers
+
+--multi-progress
+  If option is present will first execute before any process , same task but with option "--dry-run" in order to show progress of how many tasks are in total for that task and what is the progress of executing
+ This will slow down the workers , because they will execute twice the same task.
+
+--multi-secvential
+  If parallel executing does not work for you, you can use this option so that each process is executed normally and ouputted to the screen.
+  However this means that all other tasks will have to wait for each other to finish before starting 
+
+ Testing
+--------
+
+To test, do the following:
+
+1. cd to the gem root.
+2. bundle install
+3. bundle exec rake
+
+Contributions
+--------
+
+Please log all feedback/issues via [Github Issues][issues].  Thanks.
+
+[issues]: http://github.com/bogdanRada/capistrano_multiconfig_parallel/issues
+
+Contributing to capistrano_multiconfig_parallel
+--------
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+* You can read more details about contributing in the [Contributing][contributing] document
+
+[contributing]: https://github.com/bogdanRada/capistrano_multiconfig_parallel/blob/master/CONTRIBUTING.md
+
+== Copyright
+
+Copyright (c) 2015 bogdanRada. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'coveralls/rake/task'
+require 'yard'
+require 'yard-rspec'
+Coveralls::RakeTask.new
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.rspec_opts = ['--backtrace '] if ENV['DEBUG']
+end
+
+# desc "Prepare dummy application"
+# task :prepare do
+#  ENV["RAILS_ENV"] ||= 'test'
+#  require File.expand_path("./spec/dummy/config/environment", File.dirname(__FILE__))
+#  Dummy::Application.load_tasks
+#  Rake::Task["db:test:prepare"].invoke
+# end
+YARD::Config.options[:load_plugins] = true
+YARD::Config.load_plugins
+
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/**/*.rb', 'spec/**/*_spec.rb'] # optional
+  t.options = ['--any', '--extra', '--opts', '--markup-provider=redcarpet', '--markup=markdown', '--debug'] # optional
+  t.stats_options = ['--list-undoc'] # optional
+end
+
+unless ENV['TRAVIS']
+  require 'rvm-tester'
+  RVM::Tester::TesterTask.new(:suite) do |t|
+    t.rubies = %w(1.9.3 2.0.0 2.1.0) # which versions to test (required!)
+    t.bundle_install = true # updates Gemfile.lock, default is true
+    t.use_travis = true # looks for Rubies in .travis.yml (on by default)
+    t.command = 'bundle exec rake' # runs plain "rake" by default
+    t.env = { 'VERBOSE' => '1', 'RAILS_ENV' => 'test', 'RACK_ENV' => 'test' } # set any ENV vars
+    t.num_workers = 5 # defaults to 3
+    t.verbose = true # shows more output, off by default
+  end
+end
+
+desc 'Default: run the unit tests.'
+task default: [:all]
+
+desc 'Test the plugin under all supported Rails versions.'
+task :all do |_t|
+  if ENV['TRAVIS']
+    exec(' bundle exec phare &&  bundle exec rake  spec && bundle exec rake coveralls:push')
+  else
+    exec('bundle exec rubocop -a . && bundle exec phare && bundle exec rake spec')
+  end
+end
+
+task :docs do
+  exec(' bundle exec rubocop -a .  && bundle exec phare  && bundle exec inch --pedantic && bundle exec yard')
+end

data/bin/multi_cap

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+require "pathname"
+bin_file = Pathname.new(__FILE__).realpath
+# add self to libpath
+$:.unshift File.expand_path("../../lib", bin_file)
+require "capistrano_multiconfig_parallel/cli"
+CapistranoMulticonfigParallel::CLI.start

data/capistrano_multiconfig_parallel.gemspec

@@ -0,0 +1,51 @@
+require File.expand_path('../lib/capistrano_multiconfig_parallel/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name = 'capistrano_multiconfig_parallel'
+  s.version = CapistranoMulticonfigParallel.gem_version
+  s.platform = Gem::Platform::RUBY
+  s.description = 'CapistranoMulticonfigParallel is a simple ruby implementation that allows you to run multiple tasks in parallel for single or multiple applications and uses websockets for inter-process communication and has a interactive menu'
+  s.email = 'raoul_ice@yahoo.com'
+  s.homepage = 'http://github.com/bogdanRada/capistrano_multiconfig_parallel/'
+  s.summary = 'CapistranoMulticonfigParallel is a simple ruby implementation that allows you to run multiple tasks in parallel and uses websockets for inter-process communication and has a interactive menu'
+  s.authors = ['bogdanRada']
+  s.date = Date.today
+
+  s.licenses = ['MIT']
+  s.files = `git ls-files`.split("\n")
+  s.test_files = s.files.grep(/^(spec)/)
+  s.require_paths = ['lib']
+  s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+
+  s.add_runtime_dependency 'celluloid-pmap', '~> 0.2', '>= 0.2.0'
+  s.add_runtime_dependency 'celluloid_pubsub', '~> 0.0', '>= 0.0.15'
+  s.add_runtime_dependency 'composable_state_machine', '~> 1.0', '>= 1.0.2'
+  s.add_runtime_dependency 'terminal-table', '~> 1.4', '>= 1.4.5'
+  s.add_runtime_dependency 'formatador', '~> 0.2', '>= 0.2.5'
+  s.add_runtime_dependency 'colorize', '~> 0.7', '>= 0.7'
+  s.add_runtime_dependency 'eventmachine', '~> 1.0', '>= 1.0.3'
+  s.add_runtime_dependency 'right_popen', '~> 1.1', '>= 1.1.3'
+  s.add_runtime_dependency 'capistrano-multiconfig','~> 3.0', '>= 3.0.8'
+  s.add_runtime_dependency 'capistrano','~> 3.0','>= 3.0'
+  s.add_runtime_dependency 'activesupport',  '~> 4.0','>= 4.0'
+  s.add_runtime_dependency 'configurations', '~> 2.0', '>= 2.0.0'
+
+  
+  s.add_development_dependency 'rspec-rails', '~> 2.0', '>= 2.0'
+  s.add_development_dependency 'guard', '~> 2.6', '>= 2.6.1'
+  s.add_development_dependency 'guard-rspec', '~> 4.2', '>= 4.2.9'
+  s.add_development_dependency 'simplecov', '~> 0.9', '>= 0.9'
+  s.add_development_dependency 'simplecov-summary', '~> 0.0.4', '>= 0.0.4'
+  s.add_development_dependency 'mocha', '~> 1.1', '>= 1.1'
+  s.add_development_dependency 'coveralls', '~> 0.7', '>= 0.7'
+  s.add_development_dependency 'rvm-tester', '~> 1.1', '>= 1.1'
+
+  s.add_development_dependency 'rubocop', '0.29',  '>= 0.29'
+  s.add_development_dependency 'phare', '~> 0.6', '>= 0.6'
+  s.add_development_dependency 'yard', '~> 0.8', '>= 0.8.7'
+  s.add_development_dependency 'yard-rspec', '~> 0.1', '>= 0.1'
+  s.add_development_dependency 'redcarpet', '~> 3.2', '>= 3.2.2'
+  s.add_development_dependency 'github-markup', '~> 1.3', '>= 1.3.3'
+  s.add_development_dependency 'inch', '~> 0.5', '>= 0.5.10'
+  s.add_development_dependency 'guard-inch', '~> 0.1', '>= 0.1.0'
+end

data/init.rb

@@ -0,0 +1 @@
+require 'capistrano_multiconfig_parallel'

data/lib/capistrano_multiconfig_parallel/application.rb

@@ -0,0 +1,57 @@
+module CapistranoMulticonfigParallel
+  # class used as a wrapper around capistrano
+  class Application < Capistrano::Application
+    def name
+      'multi_cap'
+    end
+
+    def sort_options(options)
+      super.push(multi_debug, multi_progress, multi_secvential)
+    end
+
+    def multi_debug
+      ['--multi-debug', '-D',
+       'Sets the debug enabled for celluloid actors',
+       lambda do |_value|
+         CapistranoMulticonfigParallel::CelluloidManager.debug_enabled = true
+         Celluloid.task_class = Celluloid::TaskThread
+       end
+      ]
+    end
+
+    def multi_progress
+      ['--multi-progress', '--multi-progress',
+       'Sets the debug enabled for celluloid actors',
+       lambda do |_value|
+         CapistranoMulticonfigParallel.show_task_progress = true
+       end
+      ]
+    end
+
+    def multi_secvential
+      ['--multi-secvential', '--multi-secvential',
+       'Sets the debug enabled for celluloid actors',
+       lambda do |_value|
+         CapistranoMulticonfigParallel.execute_in_sequence = true
+       end
+      ]
+    end
+
+    def top_level
+      job_manager = multi_manager_class.new(self, top_level_tasks, stages)
+      if job_manager.can_start? && !options.show_prereqs && !options.show_tasks
+        job_manager.start
+      else
+        super
+      end
+    end
+
+    def multi_apps?
+      stages.find { |stage| stage.include?(':') }.present?
+    end
+
+    def multi_manager_class
+      multi_apps? ? CapistranoMulticonfigParallel::MultiAppManager : CapistranoMulticonfigParallel::SingleAppManager
+    end
+  end
+end