blazing 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c9f536163166c533719cbc5d5b33e0777b7f4ca
-  data.tar.gz: 8c99b501e25c992b62457a17d419ad865f76e78e
+  metadata.gz: 9b55d420459708516165067c0187dcb4fff95527
+  data.tar.gz: 7e30457ee430a4957b2684bebdb82c31c479d0c7
 SHA512:
-  metadata.gz: 9aaddee359cca03e1487630cf394bd0160eb3a2780bd29e86c2184895a95ccf1af52603af413295124168d57e1e79c1347b8ab2fd4b05a8883cf3544ee33f037
-  data.tar.gz: 72c957dd7c57dd3dde9a7561861ef242d2d4cf4c8d045819f5d70bb9cba1532551038f423c5ba663797803715b7def29d80541879d4a7e03e8f1246745f10fb4
+  metadata.gz: 2fe75b672e295745f80090ec501b97551d807590f41cc252f03fa3e7b1a187f1cf21e244796e73c235cc91d9104bd56260c81c2ec1a7781a042cb1d2ad90d706
+  data.tar.gz: ab0130d6723a2b4b54474fc83d4369c6b5777e74bed8e8c3a669bb012d96771e30d3a8c6f692d56c64d29f02f8618faccb9b63925b0bd27a78250a52331cc3c4

data/.gitignore

@@ -9,3 +9,4 @@ coverage
 *.rbc
 results.html
 Gemfile.lock
+TODOS

data/.rubocop.yml

@@ -0,0 +1,183 @@
+# This is the default configuration file. Enabling and disabling is configured
+# in separate files. This file adds all other parameters apart from Enabled.
+
+# Common configuration.
+AllCops:
+  # Include gemspec and Rakefile
+  Include:
+    - '**/*.gemspec'
+  Exclude:
+    - Rakefile
+    - spec/spec_helper.rb
+
+# Indent private/protected/public as deep as method definitions
+AccessModifierIndentation:
+  # supported styles are "indent" and "outdent"
+  EnforcedStyle: indent
+
+# Align the elements of a hash literal if they span more than one line.
+AlignHash:
+  # Alignment of entries using hash rocket as separator. Valid values are:
+  #
+  # key - left alignment of keys
+  #   'a' => 2
+  #   'bb' => 3
+  # separator - alignment of hash rockets, keys are right aligned
+  #    'a' => 2
+  #   'bb' => 3
+  # table - left alignment of keys, hash rockets, and values
+  #   'a'  => 2
+  #   'bb' => 3
+  EnforcedHashRocketStyle: key
+  # Alignment of entries using colon as separator. Valid values are:
+  #
+  # key - left alignment of keys
+  #   a: 0
+  #   bb: 1
+  # separator - alignment of colons, keys are right aligned
+  #    a: 0
+  #   bb: 1
+  # table - left alignment of keys and values
+  #   a:  0
+  #   bb: 1
+  EnforcedColonStyle: key
+
+DeprecatedHashMethods:
+  # key? instead of has_key?
+  # value? instead of has_value?
+  Enabled: false
+
+PredicateName:
+  Enabled: false
+
+Delegate:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+# don't prefer 'fail' over raise
+SignalException:
+  Description: 'Checks for proper usage of fail and raise.'
+  Enabled: false
+
+BlockNesting:
+  Max: 3
+
+BracesAroundHashParameters:
+  # Valid values are: braces, no_braces
+  EnforcedStyle: no_braces
+
+ClassLength:
+  CountComments: false  # count full line comments?
+  Max: 100
+
+# Align with the style guide.
+CollectionMethods:
+  PreferredMethods:
+    collect: 'map'
+    collect!: 'map!'
+    inject: 'reduce'
+    find_all: 'select'
+
+# Checks formatting of special comments
+CommentAnnotation:
+  Keywords:
+    - TODO
+    - FIXME
+    - OPTIMIZE
+    - HACK
+    - REVIEW
+    - NOTE
+    - NOTICE
+
+# Avoid complex methods.
+CyclomaticComplexity:
+  Max: 9
+
+PerceivedComplexity:
+  Max: 9
+
+# Multi-line method chaining should be done with leading dots.
+# DotPosition:
+#   Style: 'leading'
+
+# Use empty lines between defs.
+EmptyLineBetweenDefs:
+  # If true, this parameter means that single line method definitions don't
+  # need an empty line between them.
+  AllowAdjacentOneLineDefs: false
+
+HashSyntax:
+  # Valid values are: ruby19, hash_rockets
+  EnforcedStyle: ruby19
+
+LambdaCall:
+  # Valid values are: call, braces
+  EnforcedStyle: call
+
+ClassAndModuleChildren:
+  Enabled: true
+
+LineLength:
+  Max: 180
+
+# MethodLength:
+#   CountComments: false  # count full line comments?
+#   Max: 20
+
+# MethodName:
+#   # Valid values are: snake_case, camelCase
+#   EnforcedStyle: snake_case
+
+NumericLiterals:
+  MinDigits: 5
+
+# Output:
+#   Ignore:
+#     - '^.*\.rake$'
+#     - '^.*/script/.*$'
+#     - '^.*/tasks/.*$'
+#     - 'Rakefile$'
+
+ParameterLists:
+  Max: 4
+  CountKeywordArgs: true
+
+Alias:
+  Enabled: false
+
+# top level documentation
+Documentation:
+  Enabled: false
+
+ModuleFunction:
+  Enabled: false
+
+# TrivialAccessors doesn't require exact name matches and doesn't allow
+# predicated methods by default.
+TrivialAccessors:
+  ExactNameMatch: false
+  AllowPredicates: false
+  Whitelist:
+    - to_ary
+    - to_a
+    - to_c
+    - to_enum
+    - to_h
+    - to_hash
+    - to_i
+    - to_int
+    - to_io
+    - to_open
+    - to_path
+    - to_proc
+    - to_r
+    - to_regexp
+    - to_str
+    - to_s
+    - to_sym
+
+VariableName:
+  # Valid values are: snake_case, camelCase
+  EnforcedStyle: snake_case

data/.travis.yml

@@ -1,5 +1,9 @@
+---
+language: ruby
 rvm:
-  - 1.8.7
-  - 1.9.2
-  - 1.9.3
-  - ree
+  - 2.0.0
+  - 2.1.6
+  - 2.2.2
+script:
+ - bundle exec rake
+ - bundle exec rubocop

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 # CHANGELOG
 
-## master
+## 0.5.0 - August 3, 2015
+
+* removed support for deprecated ruby versions (< 2.0)
+* integrate rubocop and made him happy :)
+* Remove recipe support
+* Support rbenv by default, rework env script handling
+* some bugfixes
 
 ## 0.4.2 - June 28, 2015
 

data/Gemfile

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

data/Guardfile

@@ -1,17 +1,16 @@
-guard :rspec, :version => 2, :cli => "--colour --fail-fast --format nested" do
-
+guard :rspec, version: 2, cli: '--colour --fail-fast' do
   # Generated: by guard-rspec
   watch(%r{^spec/.+_spec\.rb})
   watch(%r{^lib/(.+)\.rb})     { |m| "spec/lib/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb') { "spec" }
+  watch('spec/spec_helper.rb') { 'spec' }
 
   # Not Generated
   watch('spec/spec_helper.rb')                        { %w(spec/spec_helper spec) }
   watch(%r{^spec/.+_spec\.rb})
   watch(%r{^lib/(.+)\.rb})     { |m| "spec/#{m[1]}_spec.rb" }
   watch(%r{^lib/blazing/(.+)\.rb})     { |m| "spec/blazing/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb') { "spec" }
-  watch(%r{^lib/blazing/templates/(.+)}) { "spec" }
-  watch('lib/blazing/cli.rb') { "spec/blazing/integration/*" }
-  watch('lib/blazing/commands.rb') { "spec/blazing/integration/*" }
+  watch('spec/spec_helper.rb') { 'spec' }
+  watch(%r{^lib/blazing/templates/(.+)}) { 'spec' }
+  watch('lib/blazing/cli.rb') { 'spec/blazing/integration/*' }
+  watch('lib/blazing/commands.rb') { 'spec/blazing/integration/*' }
 end

data/README.md

@@ -1,11 +1,13 @@
 [![Build Status](https://secure.travis-ci.org/effkay/blazing.png?branch=master)](http://travis-ci.org/effkay/blazing)
+[![Code Climate](https://codeclimate.com/github/effkay/blazing.png)](https://codeclimate.com/github/effkay/blazing)
+[![Gem Version](https://badge.fury.io/rb/blazing.png)](http://badge.fury.io/rb/blazing)
 
 Blazing fast and painless git push deploys
 ==========================================
 
 *Oh no, yet another deployer!*
 
-Not everyone can or wants to deploy on heroku. But now you can have the same (well, almost the same, since we're not gonna patch SSH) awesomely smooth git push deploys on whatever server you have SSH access to. Blazing helps you to create and distribute your post-receive hooks, which are executed on the remote server after you successfully pushed to it. It also helps you to easily set up remote repositories for deploying to, is extendable by recipes and is configured by a nice DSL.
+Not everyone can or wants to deploy on heroku. But now you can have the same (well, almost the same, since we're not gonna patch SSH) awesomely smooth git push deploys on whatever server you have SSH access to. Blazing helps you to create and distribute your post-receive hooks, which are executed on the remote server after you successfully pushed to it. It also helps you to easily set up remote repositories for deploying to, is extendable by simple rake tasks and is configured by a nice DSL.
 
 Quickstart
 ----------
@@ -17,181 +19,56 @@ Features
 
 Out of the box, blazing can do the following:
 
+* **uses ruby, but works for deploying pretty much anything else just as well**
 * set up a repository you can push to for deployment
 * set up a git post-receive hook, configurable by a simple DSL
 * works with rvm/rbenv/chruby(and probably others)
-* uses bundler for dependency management
-* allows you to run custom rake tasks after deployment
-* is extendable by blazing recipes
-
-Overview & Background
----------------------
-
-Blazing is a deployment tool written in Ruby. It provides helpers to setup your project with a git post-receive hook, which is triggered every time you push to your production repository.
-
-I initially started working on an extension to capistrano which would cover most of my needs and the nees of my team. After a short while I noticed that bolting more functionality on top of capistrano was just going to be messy (and a PTA to maintain). We were alerady using tons of own recipes and customizations, capistrano multistage, capistrano-ext, etc.
-
-I had a look at what others were doing and after a round of trying around and not getting what I wanted, I started this.
-
-#### Design Goals
-
-When I started working on blazing, I had some design goals in mind which I think should stay relevant for this project:
-
-- it must be well tested
-- it must stay robust, simple and with small code base with as few moving parts as possible. Minimum code in the main project, extensions live outside.
-- no messy rake scripts: Define the desired behavior trough a DSL, and extensions add to this DSL in a clean and modular way
-- Deployments should be fast
-
-#### Inspiration & Alternatives
-
-I looked at [Inploy](https://github.com/dcrec1/inploy) and [Vlad](https://github.com/seattlerb/vlad) after having used [Capistrano](https://github.com/capistrano/capistrano) for several
-years. Then got inspired by defunkt's
-[blog post](https://github.com/blog/470-deployment-script-spring-cleaning) about deployment script spring cleaning. Other's doing a similar thing with git push deployments are Mislav's [git-deploy](https://github.com/mislav/git-deploy) (which was a great inspiration and resource) and [pushand](https://github.com/remi/pushand.git) by remi. If you don't like blazing, you might give them a try.
+* allows you to run custom rake tasks during deployment
+* Makes it easy to ssh to target directory on server with env variables
+  set
 
 Usage
 -----
 
-#### Installation
-
-Your machine should be setup with ruby, rubygems, bundler and git. Install blazing by adding it to your `Gemfile` or run `gem install blazing`. The basic assumption from now on will be that you are working on a project with bundler and a Gemfile. Support for other ways to handle dependencies might be added in the future but **at the moment bundler is required**.
-
-#### blazing Commands
-
-##### `blazing init`
-
-Generate a blazing config file
-
-##### `blazing setup <target>`
-
-Setup target repository for deployment and add git remote localy. Use 'all' as target name to update all configured targets at once.
-
-##### `blazing update <target>`
-
-Update post-receive hook according to current config. Run it after changing the blazing config. Use 'all' as target name to update all configured targets at once.
-
-##### `blazing list`
-
-List available recipes
-
-##### `blazing recipes`
-
-Run the configured recipes (used on deployment target, can be used to test recipes localy)
-
-The `setup` and `update` commands also take 'all' as an option. This will perform the action on all your defined targets.
+### Installation
 
-#### Configuration (blazing DSL)
+Make sure you have bundler available on your local machine as well as on
+the server you are deploying to.
 
-```ruby
-# Sample target definition:
-#
-#   target <target_name>, <target_location>, [options]
-#
-# The options provided in the target definition will override any
-# options provided in the recipe call.
-#
-# Options recognized by blazing core:
-#   rails_env: used when calling the rake task after deployment
+### blazing Commands
 
-target :staging, 'user@server:/var/www/someproject.com',
-       :recipe_specific_option => 'foo', :rails_env => 'production'
-
-
-# Sample rvm setup:
-#
-#    rvm <rvm-string>
-#
-# Setting the rvm string will make sure that the correct rvm ruby and
-# gemset is used before the post-receive hook does anything at all.
-# Use :rvmrc as rvm string if you want blazing to use the rvm
-# environment specified in your project's .rvmrc file.
-
-rvm 'ruby-1.9.3@some-gemset'
-
-
-# Sample config for custom rvm location:
-#
-#    rvm_scripts <path_to_rvm_scripts>
-#
-# If you have installed rvm to a custom location, use this method to
-# specify where the rvm scripts are located.
-
-rvm_scripts '/opt/rvm/scripts/rvm'
-
-
-# Sample rbenv/chruby/other setup:
-#
-#    env_scripts <path_to_version_manager_script>
-#
-# If you need to source a file for your non-rvm version manager to
-# you can do that with env_scripts. You should also remove the
-# rvm/rvm_scripts options above.
-
-env_scripts '/etc/profile.d/rbenv.sh'
-
-# Sample recipe setup:
-#
-#     recipe <recipe_name>, [options]
-#
-# The given recipe will be called with the provided options. Refer to each
-# recipe's documentation for available options. Options provided here
-# may be overridden by target specific options.
-# Recipes will be executed in the order they are defined!yy
-
-recipe :precompile_assets, :recipe_specific_option => 'bar'
+```
+Commands:
+  blazing goto [TARGET]    # Open ssh session on target. Use -c to specify a command to be run
+  blazing help [COMMAND]   # Describe available commands or one specific command
+  blazing init             # Generate a sample blazing config file
+  blazing setup [TARGET]   # Setup local and remote repository/repositories for deployment
+  blazing update [TARGET]  # Re-Generate and upload hook based on current configuration
+  blazing version          # Show the blazing version
+```
 
+**Always remember to update your hooks after updating blazing**
 
-# Sample rake file config:
-#
-#     rake <task>, [environment variables]
-#
-# The provided rake task will be run after all recipes have run.
-# Note: you can only call a single rake task. If you need to run several
-# tasks just create one task that wrapps all the others.
+### Configuration (blazing DSL)
 
-rake :post_deploy, 'RAILS_ENV=production'
-```
+Run blazing init in your project to generate a config file or look at
+[the sample config
+template](https://github.com/effkay/blazing/blob/master/lib/blazing/templates/config.erb)
 
-#### Deploying
+### Deploying
 
 Just push to your remote… so if you set up a target named `production`, use `git push production master` to deploy your master branch there.
 
 Recipes
 -------
 
-Blazing only offers a small set of core features. However, it is extendable by recipes.
-
-#### Available Recipes
-
-* [blazing-passenger](https://github.com/effkay/blazing-passenger)
-* [blazing-rails](https://github.com/effkay/blazing-rails)
-
-#### Creating a blazing Recipe
-
-Creating a blazing recipe is very easy. There are some ground rules:
-
-* recipes should live in gems called `blazing-<somename>`
-* blazing converts the symbol given in the config to the class name and calls run on it. So if you have `recipe :passenger_restart` blazing will try to run `Blazing::Recipe::PassengerRestart.run` with the options provided.
-* Recipes should live in the `Blazing::Recipe` namespace and inherit from `Blazing::Recipe` as well
-* Recipes are run in the order they are specified in the config, so there is no way to handle inter-recipe dependencies yet.
-* Make sure your recipe classes are loaded when the recipe gem itself is
-  loaded
-* A minimal recipe implementation might look like this:
-
-```ruby
-class Blazing::Recipe::Example < Blazing::Recipe
-  def run(target_options = {})
-    super target_options
-    # do some stuff
-    # access options with @options[:key]
-  end
-end
-```
-Please have a look at [blazing-passenger](https://github.com/effkay/blazing-passenger) to get an idea of how to implement your recipe.
+Recipes have been removed from blazing.
 
 Authors
 -------
 
-Felipe Kaufmann ([@effkay][])
+* Felipe Kaufmann ([@effkay][])
+* Alexander Adam ([@alexanderadam][])
 
 License
 -------
@@ -199,3 +76,4 @@ License
 See the [MIT-LICENSE file](https://github.com/effkay/blazing/blob/master/MIT-LICENCE)
 
 [@effkay]: https://github.com/effkay
+[@alexanderadam]: https://github.com/alexanderadam