capistrano-bootstrap 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,18 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem "versionomy", "~> 0.4.4"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.8.0"
+  gem "yard", "~> 0.7"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.2.0"
+  gem "jeweler", "~> 1.8.4"
+  gem "simplecov", ">= 0"
+  gem "reek", "~> 1.2.8"
+end

data/Gemfile.lock

@@ -0,0 +1,57 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    blockenspiel (0.4.5)
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.6)
+    multi_json (1.5.0)
+    rake (10.0.3)
+    rdoc (3.12)
+      json (~> 1.4)
+    reek (1.2.13)
+      ripper_ruby_parser (~> 0.0.7)
+      ruby2ruby (~> 1.2.5)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    ripper_ruby_parser (0.0.8)
+      sexp_processor (~> 3.0)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    ruby2ruby (1.2.5)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    ruby_parser (2.3.1)
+      sexp_processor (~> 3.0)
+    sexp_processor (3.2.0)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    versionomy (0.4.4)
+      blockenspiel (>= 0.4.5)
+    yard (0.8.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.2.0)
+  jeweler (~> 1.8.4)
+  rdoc (~> 3.12)
+  reek (~> 1.2.8)
+  rspec (~> 2.8.0)
+  simplecov
+  versionomy (~> 0.4.4)
+  yard (~> 0.7)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Lucas Jenss
+
+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,101 @@
+# capistrano-bootstrap
+
+This gem can be used to keep capistrano configuration synchronized between multiple projects. If you have several git repositories in which you are using the same or very similar capistrano configurations, this gem is for you.
+
+
+
+## How to set up?
+
+You'll need a new git repository containing your configuration. Lets say you currently use the following directory structure in your projects:
+
+    project/
+        Cap
+        config/
+            capistrano/
+                deploy.rb
+                util/
+                    important.rb
+                    stuff.rb
+                project.rb
+                stages/
+                    production.rb
+                    staging.rb
+        [...]
+
+Let us also assume that everything in the `util/` folder as well as `deploy.rb` is never modified, that is, the project specific configuration resides solely in `stages/` and `project.rb`. You'd now create a new git repository containing the following:
+
+    deploy.rb
+    util/
+        important.rb
+        stuff.rb
+
+Then you'd simply remove these files from your project structure, resulting in:
+
+    project/
+        Cap
+        config/
+            capistrano/
+                project.rb
+                stages/
+                    production.rb
+                    staging.rb
+        [...]
+
+Now you want to add the following lines to the beginning of your `Cap` file:
+
+    require 'capistrano-bootstrap'
+    CapistranoBootstrap.invoke(
+        "git@github.com:you-on-github/capistrano-configuration.git",
+        :config_dir => "config/capistrano",
+        :target_path => "config/.config_repo"
+    )
+
+The `invoke` method has the following optional parameters:
+
+* `:config_dir` => Where you would like to have your global capistrano config copied to.
+* `:target_path` => The directory to which the configuration repository will be cloned.
+
+The parameter values in the above `invoke` example are the default values.
+
+By default, capistrano-bootstrap will try to update the configuration repository once every 24 hours. You may overwrite that behavior (i.e. force an update) by invoking your capistrano task like this:
+
+    CAPBOOTSTRAP_FORCE=1 cap deploy
+
+For your convenience, capistrano-bootstrap also generates a `.gitignore` file in the `config_dir` which ignores all content copied from the configuration repository.
+
+
+
+## How it works
+
+capistrano-bootstrap simply clones the specified repository, checks out the latest tag (by version number!) and copies the content to the specified `config_dir`.
+
+There _must_ be at least one tag in the configuration repository, otherwise the update will fail. The version comparison/ordering is done using the [Versionomy](https://github.com/dazuma/versionomy) gem, for example:
+
+    v1.0 < v1.0.1 < v1.1 < v1.1.1 < ...
+
+
+
+## Caveats
+
+* capistrano-bootstrap does not currently **delete** any files, it only overwrites updated files or creates newly created ones.
+
+
+
+## TODO
+
+* Write spec
+* Support file deletion
+
+
+
+## Boring legal stuff (read: License)
+
+Copyright (C) 2013 Lucas Jenß
+
+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/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "capistrano-bootstrap"
+  gem.homepage = "http://github.com/x3ro/capistrano-bootstrap"
+  gem.license = "MIT"
+  gem.summary = %Q{This gem can be used to keep capistrano configuration synchronized between multiple projects.}
+  gem.description = %Q{This gem can be used to keep capistrano configuration synchronized between multiple projects. If you have several git repositories in which you are using the same or very similar capistrano configurations, this gem is for you.}
+  gem.email = "lucas@x3ro.de"
+  gem.authors = ["Lucas Jenss"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+require 'reek/rake/task'
+Reek::Rake::Task.new do |t|
+  t.fail_on_error = true
+  t.verbose = false
+  t.source_files = 'lib/**/*.rb'
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/capistrano-bootstrap.rb

@@ -0,0 +1,143 @@
+require 'fileutils'
+require 'versionomy'
+
+class CapistranoBootstrap
+  class << self
+    # Update configuration repository every day
+    UPDATE_INTERVAL = 60 * 60 * 24
+
+    def invoke(repository, args = {})
+      args[:config_dir] ||= "config/capistrano"
+      args[:target_path] ||= "config/.config_repo"
+
+      if !File.directory? args[:target_path]
+        clone_repository(repository, "./config/.config_repo")
+      elsif repository_needs_update?(args[:target_path])
+        update_repository(args[:target_path])
+      end
+
+      tags = get_repository_tags(args[:target_path]).map { |x| Versionomy.parse(x) }.sort
+      if configuration_needs_update?(args[:target_path], tags)
+        update_capistrano_configuration(args[:target_path], args[:config_dir], tags)
+      end
+    end
+
+private
+
+    def configuration_needs_update?(target_path, tags)
+      return true if !ENV["CAPBOOTSTRAP_FORCE"].nil?
+      current_tag = get_current_tag(target_path)
+      return true if current_tag.nil?
+      current_tag < tags.last
+    end
+
+    # Checks out the latest configuration tag and copies all files to the configuration
+    # directory.
+    def update_capistrano_configuration(target_path, config_dir, tags)
+      update_to = tags.last
+      tell("About to update capistrano configuration to tag '#{update_to}'")
+
+      in_dir_do(target_path) do
+        execute_command("git checkout #{update_to}")
+      end
+      set_current_tag(target_path, update_to)
+      tell("Configuration updated to '#{update_to}'")
+
+      tell("Copying updated configuration to '#{config_dir}'")
+      execute_command("cp -rf #{target_path}/* #{config_dir}")
+
+      write_gitignore(target_path, config_dir)
+
+      tell("Finished updating configuration at '#{config_dir}' to '#{update_to}'")
+    end
+
+    # Writes a .gitignore file which ignores all files copied from the capistrano
+    # configuration repository.
+    def write_gitignore(target_path, config_dir)
+      tell("Updating #{config_dir}/.gitignore")
+      files = in_dir_do(target_path) { Dir.glob("*") }
+      files.push(".gitignore")
+      in_dir_do(config_dir) do
+        File.open(".gitignore", 'w+') { |f| f.write(files.join("\n")) }
+      end
+    end
+
+    # The file that contains the currently checked out tag (that is, the last tag
+    # whose contents where copied to the configuration directory)
+    def tag_file(target_path)
+      "#{target_path}/.CAPBOOTSTRAP_TAG"
+    end
+
+    def get_current_tag(target_path)
+      dir = tag_file(target_path)
+      return nil if !File.exists?(dir)
+      lines = File.read(dir).split("\n")
+      return nil if lines.length < 1
+      Versionomy.parse(lines.first)
+    end
+
+    def set_current_tag(target_path, tag)
+      File.open(tag_file(target_path), 'w+') { |f| f.write(tag) }
+    end
+
+    # Returns an array of tags specified for the cloned configuration repository
+    def get_repository_tags(target_path)
+      in_dir_do(target_path) do
+        out = execute_command("git tag")
+        raise "Repository in path #{target_path} is not a valid Git repository" if $? != 0
+
+        tags = out.split("\n")
+        raise "Repository in path #{target_path} does not contain any tags!" if tags.length < 1
+
+        tags
+      end
+    end
+
+    def clone_repository(repository, target_path)
+      tell "Cloning repository #{repository} to #{target_path}"
+      execute_command("git clone #{repository} #{target_path}")
+    end
+
+    # Determines if the repository needs to be updated by checking when it was last
+    # touched (by the #update_repository method)
+    def repository_needs_update?(target_path)
+      return true if !ENV["CAPBOOTSTRAP_FORCE"].nil?
+      (Time.now - File.mtime(target_path)) > UPDATE_INTERVAL
+    end
+
+    # Pull the latest contents (including tags) for the repository
+    def update_repository(target_path)
+      in_dir_do(target_path) do
+        tell "Updating local configuration repository at '#{target_path}'"
+        execute_command("git checkout master")
+        execute_command("git pull origin master --tags")
+
+        head = execute_command("git rev-parse HEAD")[0,8]
+        tell("Updated local configuration repository to #{head}")
+      end
+      execute_command("touch #{target_path}")
+    end
+
+    def tell(text)
+      puts "[CapBootstrap]: #{text}"
+    end
+
+    # Switches to the specified directory, executes the given block and then
+    # switches the working directory back to where it was before.
+    def in_dir_do(target_path, &block)
+      cwd = Dir.pwd
+      Dir.chdir(target_path)
+      out = block.call
+      Dir.chdir(cwd)
+      out
+    end
+
+    # Executes the given shell command in the current working directory, and throws an
+    # exception in case the command failed (exit status != 0)
+    def execute_command(command)
+      out = `#{command} 2>&1`
+      raise "There was an error executing '#{command}'. Output: \n #{out} \n" if $? != 0
+      out
+    end
+  end
+end

data/spec/capistrano-bootstrap_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "CapistranoBootstrap" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'capistrano-bootstrap'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,192 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-bootstrap
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Lucas Jenss
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: versionomy
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.4
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.8
+description: This gem can be used to keep capistrano configuration synchronized between
+  multiple projects. If you have several git repositories in which you are using the
+  same or very similar capistrano configurations, this gem is for you.
+email: lucas@x3ro.de
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/capistrano-bootstrap.rb
+- spec/capistrano-bootstrap_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/x3ro/capistrano-bootstrap
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1517474287064682130
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: This gem can be used to keep capistrano configuration synchronized between
+  multiple projects.
+test_files: []