pulsar 0.3.5 → 1.0.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 85ff94bd2e09cdb4b78e52f893e1325e57040096
-  data.tar.gz: 6a9555c19b9dd1a2fac4da55d898cc508ef802c3
+  metadata.gz: 921914916a66521e123a39711c7b62f7336cb901
+  data.tar.gz: 15e6595fcaa432a63321128e515cfd2141af9ec3
 SHA512:
-  metadata.gz: b192211345aeee06d45a10c4123e5294af7baf776bdde2c0a1772f7dc6fc41060c8592671cf10b400d9bee79a4876a61f616252a55ee08400b6a318ee9260086
-  data.tar.gz: a3acf3cea61a0431d419cc92781515695ed92d183cb1f3bef408ff46268e982bc6122f11b2e29b0e5429a9e6562c053a8a152788de153f9a0409a9ac1507fac2
+  metadata.gz: f7c0a941f8cce88aadf721b9d5dda5a98169be84853447dfd061046c3a6475fc667eb519019eb324b65922e93814d7b85ac01ca69994c8af82dba23e8d1bfe0b
+  data.tar.gz: e508f7f5149735f13802e5506c33ae592a3ffb08a11eb2254b3fea1d6b2d08560b05a056ebeadab78f1689db59514754e1f9224e06de6078d5ef00c1db9910e1

data/.gitignore

@@ -1,3 +1,4 @@
+.DS_Store
 *.gem
 *.rbc
 .bundle

data/.rspec

@@ -1 +1,2 @@
 --color
+--format documentation

data/.rubocop.yml

@@ -1,5 +1,155 @@
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Exclude:
+    - "spec/**/*.rb"
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*.rb"
+
+# Relaxed.Ruby.Style
+
+Style/Alias:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylealias
+
+Style/BeginBlock:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylebeginblock
+
+Style/BlockDelimiters:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleblockdelimiters
+
 Style/Documentation:
   Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styledocumentation
+
+Style/DotPosition:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styledotposition
+
+Style/DoubleNegation:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styledoublenegation
+
+Style/EndBlock:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleendblock
+
+Style/FormatString:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleformatstring
+
+Style/IfUnlessModifier:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleifunlessmodifier
+
+Style/Lambda:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylelambda
+
+Style/ModuleFunction:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylemodulefunction
+
+Style/MultilineBlockChain:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylemultilineblockchain
+
+Style/NegatedIf:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylenegatedif
+
+Style/NegatedWhile:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylenegatedwhile
+
+Style/ParallelAssignment:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleparallelassignment
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylepercentliteraldelimiters
+
+Style/PerlBackrefs:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleperlbackrefs
+
+Style/Semicolon:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylesemicolon
+
+Style/SignalException:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylesignalexception
+
+Style/SingleLineBlockParams:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylesinglelineblockparams
+
+Style/SingleLineMethods:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylesinglelinemethods
+
+Style/SpaceBeforeBlockBraces:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylespacebeforeblockbraces
+
+Style/SpaceInsideParens:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylespaceinsideparens
 
 Style/SpecialGlobalVars:
   Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylespecialglobalvars
+
+Style/StringLiterals:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylestringliterals
+
+Style/TrailingCommaInLiteral:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styletrailingcommainliteral
+
+Style/WhileUntilModifier:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylewhileuntilmodifier
+
+Lint/AmbiguousRegexpLiteral:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#lintambiguousregexpliteral
+
+Lint/AssignmentInCondition:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#lintassignmentincondition
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false

data/.ruby-version

@@ -1 +1 @@
-2.2.0
+2.4.0

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012 NebuLab
+Copyright (c) 2017 Nebulab
 
 MIT License
 

data/README.md

@@ -1,4 +1,4 @@
-# Pulsar [![Gem Version](https://badge.fury.io/rb/pulsar.svg)](http://badge.fury.io/rb/pulsar) [![Build Status](https://travis-ci.org/nebulab/pulsar.svg?branch=master)](https://travis-ci.org/nebulab/pulsar) [![Test Coverage](https://codeclimate.com/github/nebulab/pulsar/badges/coverage.svg)](https://codeclimate.com/github/nebulab/pulsar) [![Code Climate](https://codeclimate.com/github/nebulab/pulsar/badges/gpa.svg)](https://codeclimate.com/github/nebulab/pulsar)
+# Pulsar
 
 The easy [Capistrano](https://rubygems.org/gems/capistrano) deploy and configuration manager.
 
@@ -11,272 +11,11 @@ have all your application dependencies installed). This lets you integrate Pulsa
 Some of the benefits of using Pulsar:
 * No capistrano configurations in the application code
 * No need to have the application locally to deploy
-* Multistage support by default
 * Every recipe can be shared between all applications
 * Can easily be integrated with other tools
 * Write the least possible code to deploy
 
-## Installation
+## Capistrano support
 
-The most useful way of installing Pulsar is as a system gem:
-
-```bash
-$ gem install pulsar
-```
-
-This will install two commands: `pulsar` and `pulsar-utils`. The first command is required to run capistrano,
-the other is for everything else.
-
----
-
-You'll need to create your own configuration repo:
-
-```bash
-$ pulsar-utils init ~/Desktop/pulsar-conf
-```
-
-This will create a basic start point for building your configuration repository. As soon as you're done configuring
-you should consider storing this folder as an actual git repository.
-
-Here it is possible to see how this configuration repository will look like: [Pulsar Conf Demo](http://github.com/nebulab/pulsar-conf-demo)
-
-**NOTE**: Pulsar only supports git and *nix systems.
-
-## Configuration
-
-This is an example repository configuration layout:
-
-```bash
-pulsar-conf/
-  |── Gemfile
-  ├── Gemfile.lock
-  ├── apps
-  │   ├── base.rb
-  │   └── my_application
-  │       ├── defaults.rb
-  │       ├── production.rb
-  │       ├── recipes
-  │       │   └── custom_recipe.rb
-  │       └── staging.rb
-  └── recipes
-      ├── generic
-      │   ├── cleanup.rb
-      │   ├── maintenance_mode.rb
-      │   ├── notify.rb
-      │   └── utils.rb
-      ├── rails
-      │   ├── passenger.rb
-      │   ├── repair_permissions.rb
-      │   ├── symlink_configs.rb
-      │   ├── unicorn.rb
-      │   └── whenever.rb
-      └── spree_1
-          └── symlink_assets.rb
-```
-
-Pulsar uses these files to build capistrano configurations on the fly, depending on how you invoke the `pulsar` command.
-Since Pulsar it's basically a capistrano wrapper, the content of these files is plain old capistrano syntax.
-
-### _apps_ directory
-
-This directory contains your application configurations. You'll have one directory per application.
-
-* `base.rb` has configurations that are shared by all applications
-* `my_application/defaults.rb` includes configuration shared by every stage of the application
-* `my_application/staging.rb` and `my_application/production.rb` files include stage configurations
-* `my_application/recipes/` are recipes that are always included for that application (no need to use `load_recipes`)
-
-### _recipes_ directory
-
-This directory contains your recipes. You can create any number of directories to organize your recipes.
-To load a recipe from your configurations you can use the `load_recipes` helper:
-
-```ruby
-#
-# Somewhere inside apps/
-#
-load_recipes do
-  rails :repair_permissions, :unicorn
-  generic :cleanup, :utils
-end
-```
-
-This will use capistrano's `load` method to include recipes from `rails/` and `generic/`.
-
----
-
-Another way to include your recipes is by using the `Gemfile`. Many gems already include custom recipes for capistrano so
-you just need to require those. An example with [Whenever](https://github.com/javan/whenever):
-
-```ruby
-#
-# Inside Gemfile
-#
-gem 'whenever'
-
-#
-# Inside recipes/rails/whenever.rb
-#
-require 'whenever/capistrano'
-
-set :whenever_command, "bundle exec whenever"
-
-#
-# Somewhere inside apps/
-#
-load_recipes do
-  rails :whenever
-end
-```
-
----
-
-You can specify some recipes to be loaded only when you run Pulsar from inside a Rack application directory.
-This is useful with recipes that require something inside that directory (like retrieving the database/assets
-from a staging environment).
-
-You can do that like this:
-
-```ruby
-#
-# Somewhere inside apps/
-#
-
-#
-# These recipes will be available only if you're running
-# Pulsar inside a Rack application (like Rails) directory
-#
-load_recipes(app_only: true) do
-  rails :assets_pull, :database_pull
-end
-```
-
-### Loading the repository
-
-Once the repository is ready, you'll need to tell Pulsar where it is. The repository location can be specified either
-as a full git path or a github repository path (`gh-user/pulsar-conf`).
-
-Since Pulsar requires the repository for everything, there are multiple ways to store this information so that
-you don't have to type it everytime. You can also use local repository, which is useful while developing your
-deployment.
-
-You have three possibilities:
-
-* `-c` command line option
-* `PULSAR_CONF_REPO` environment variable
-* `~/.pulsar/config` configuration file
-
-The fastest way is probably the `.pulsar/config` file inside your home directory:
-
-```bash
-#
-# Inside ~/.pulsar/config
-#
-PULSAR_CONF_REPO="gh-user/pulsar-conf"
-
-#
-# You can use local repository for development so you don't need to push changes every time
-#
-# PULSAR_CONF_REPO="/full/path/to/repository"
-
-#
-# Also supported
-#
-# PULSAR_CONF_REPO="git://github.com/gh-user/pulsar-conf.git"
-```
-
-Pulsar will read this file and set the environment variables properly.
-
----
-
-If you don't want to add another file to your home directory you can export the variables yourself:
-
-```bash
-#
-# Inside ~/.bash_profile or ~/.zshrc
-#
-export PULSAR_CONF_REPO="gh-user/pulsar-conf"
-```
-
-## Usage
-
-After the repository is ready, running Pulsar is straightforward. To deploy `my_application` to `production`:
-
-```bash
-$ pulsar my_application production
-```
-
-As a rule of thumb, anything that's added at the end of the command is passed to capistrano. Some examples:
-
-```bash
-$ pulsar my_application production --tasks
-
-$ pulsar my_application staging deploy:migrations
-
-$ pulsar my_application staging shell
-
-#
-# Deploy multiple apps by using commas
-#
-$ pulsar my_app1,my_app2,my_app3 production
-
-#
-# Deploy multiple apps by using pattern matching
-# (uses Dir.glob)
-#
-$ pulsar my_app* production
-# or
-$ pulsar *worker staging
-
-```
-
-### Running inside a Rack application (e.g. Ruby on Rails application)
-
-In case you frequently work from a Rack application and would like a workflow similar to that of capistrano, Pulsar
-supports running from inside a Rack application directory. If you use this a lot, you should consider installing
-Pulsar via the application `Gemfile`.
-
-When deploying from inside a Rack application you can omit the application name:
-
-```bash
-$ cd /path/to/my_application
-
-$ pulsar production
-
-$ pulsar staging deploy:migrations
-```
-
----
-
-If you need a particular configuration for an application you can store a `.pulsar` file inside the application
-directory:
-
-```bash
-#
-# Inside /path/to/my_application/.pulsar
-#
-PULSAR_CONF_REPO="gh-user/pulsar-conf"
-
-#
-# If the application directory name is different than what
-# you configured inside the Pulsar configuration repository
-#
-# PULSAR_APP_NAME="my-application"
-```
-
-## Integrations
-
-Pulsar is easy to integrate, you just need access to the configurations repository and the ability to
-run a command.
-
-### Hubot
-
-https://gist.github.com/mtylty/5324075
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes with tests (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+This version of Pulsar, version `1.0.0` only supports Capistrano v3. If you're looking for Capistrano v2 support you can
+use Pulsar version `0.3.5` but, take care, that version is not maintained anymore.