capistrano-tags 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,22 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+gem "capistrano", "~> 2.5.0"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.0"
+  gem "rcov", ">= 0"
+  gem "mocha"
+  gem 'autotest-standalone'
+  gem 'autotest-rails-pure'
+  gem 'zentest-without-autotest'
+  if RUBY_PLATFORM.downcase.include?("darwin") # I'm on Mac
+    gem 'autotest-fsevent'
+    gem 'autotest-growl'
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Fabio Napoleoni
+
+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.markdown

@@ -0,0 +1,94 @@
+# capistrano-tags
+
+Capistrano recipe for deploying svn or git tags with no need to edit the deploy file
+
+## Installation
+
+    gem install capistrano-tags
+
+## Usage
+
+In your deploy file require the capistrano-tags file after setting your variables with
+
+    require 'capistrano-tags'
+
+### Subversion usage
+
+You MUST set the `repository_root` variable in your config file, then you can use one of the
+following strategies to change the deployed tag when invoking `cap` command (assuming you have set
+`:repository_root` to `http://svn.example.org`)
+
+1. Set the ENV variable `SVN_TAG` when invoking capistrano
+
+        $ SVN_TAG=1.0 cap:deploy # this will deploy http://svn.example.org/tags/1.0
+
+2. Set the `:branch` variable to something i.e.
+
+        set :branch, '1.0.2'           # this will deploy http://svn.example.org/tags/1.0.2
+        set :branch, 'branches/stable' # this will deploy http://svn.example.org/branches/stable
+
+3. Set the ENV variable `ASK_FOR_TAG` to anything, by doing this you'll be prompted for tag to deploy
+
+        $ ASK_FOR_TAG=1 cap deploy
+        Tag to deploy (leave it blank to deploy from trunk or use branches/xxx to deploy that branch): 1.0.3
+        # this will deploy http://svn.example.org/tags/1.0.3
+        $ ASK_FOR_TAG=1 cap deploy
+        Tag to deploy (leave it blank to deploy from trunk or use branches/xxx to deploy that branch): branches/stable
+        # this will deploy http://svn.example.org/branches/stable
+        $ ASK_FOR_TAG=1 cap deploy
+        Tag to deploy (leave it blank to deploy from trunk or use branches/xxx to deploy that branch):
+        # this will deploy http://svn.example.org/trunk
+
+4. Set the `:ask_for_tag` variable to true in your config, you'll be prompted for the tag as above
+
+As you may have seen, when you set the `:branch` variable in any of the given way, if its value is empty,
+it will be defaulted to `trunk`, so keep in mind that. Moreover if the `:branch` variable content starts with
+`branches/` then a branch (instead of a tag) will be deployed. There's no need to prepend the variable with `tags`
+if you just want to deploy a tag.
+
+### Git usage
+
+In this case there's no need to set the `:repository_root` variable, because git supports the `:branch`
+variable. So you can deploy a branch or a tag by setting the `:repository` variable and then you can do
+one of the following
+
+1. Set the ENV variable `GIT_TAG` when invoking capistrano
+
+        $ GIT_TAG=1.0 cap:deploy # this will deploy refs/tags/1.0
+
+2. Set the `:branch` variable to something i.e.
+
+        set :branch, '1.0.2'    # this will deploy refs/tags/1.0.2
+        set :branch, 'stable'   # this will deploy refs/heads/stable
+
+3. Set the ENV variable `ASK_FOR_TAG` to anything, by doing this you'll be prompted for tag to deploy
+
+        $ ASK_FOR_TAG=1 cap deploy
+        Enter tag (or branch) to deploy: 1.0.3
+        # this will deploy refs/tags/1.0.3
+        $ ASK_FOR_TAG=1 cap deploy
+        Enter tag (or branch) to deploy: stable
+        # this will deploy refs/heads/stable
+        $ ASK_FOR_TAG=1 cap deploy
+        Enter tag (or branch) to deploy:
+        # this will deploy refs/heads/master
+
+4. Set the `:ask_for_tag` variable to true in your config, you'll be prompted for the tag as above
+
+In this case if the `:branch` variable is empty then the `master` branch will be deployed.
+
+## Contributing to capistrano-tags
+ 
+* 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.
+
+## Copyright
+
+Copyright (c) 2011 Fabio Napoleoni. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,40 @@
+# 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-tags"
+  gem.homepage = "http://github.com/fabn/capistrano-tags"
+  gem.license = "MIT"
+  gem.summary = %Q{Capistrano recipe to deploy svn and git tags}
+  gem.description = %Q{Use this recipe if you want to be able to deploy scm tags (or branches) with no need to edit your main deploy.rb file. You can choose the deployed tag using ENV variables or interactively decide which is the tag to deploy. }
+  gem.email = "f.napoleoni@gmail.com"
+  gem.authors = ["Fabio Napoleoni"]
+  # 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
+  spec.rcov_opts = '--exclude /gems/,/Library/,/usr/,lib/tasks,.bundle,config,/lib/rspec/,/lib/rspec-'
+end
+
+task :default => :spec

data/VERSION

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

data/lib/capistrano-tags.rb

@@ -0,0 +1,51 @@
+unless Capistrano::Configuration.respond_to?(:instance)
+  abort "capistrano-tags requires Capistrano 2"
+end
+
+Capistrano::Configuration.instance.load do
+
+  def _cset(name, *args, &block)
+    unless exists?(name)
+      set(name, *args, &block)
+    end
+  end
+
+  # if you include this file in your deploy.rb, you can use one of the following strategies
+  # to change your deploy tag without editing the deploy.rb file
+  # Git behavior
+  if fetch(:scm) == :git
+    # * set the :branch variable in your deploy.rb (normal workflow)
+    # * set the GIT_TAG environment variable (it will override the branch variable)
+    set(:branch, ENV['GIT_TAG']) if ENV['GIT_TAG'] and !ENV['GIT_TAG'].empty?
+    if ENV['ASK_FOR_TAG'] or fetch(:ask_for_tag, false)
+      # * set the :ask_for_tag or the ASK_FOR_TAG environment variable to true to be prompted for a tag
+      set(:branch) do
+        tag = Capistrano::CLI.ui.ask "Enter tag (or branch) to deploy:"
+        tag.empty? ? 'HEAD' : tag
+      end
+    end
+  end
+  # Subversion behavior
+  if fetch(:scm) == :subversion
+    # * set the :branch variable in your deploy.rb (normal workflow)
+    # * set the SVN_TAG environment variable (it will override the branch variable)
+    set(:branch, ENV['SVN_TAG']) if ENV['SVN_TAG']
+    # * set the :ask_for_tag variable to true to be prompted for a tag
+    # * set the ASK_FOR_TAG environment variable to be prompted for a tag
+    if ENV['ASK_FOR_TAG'] or fetch(:ask_for_tag, false)
+      set(:branch) { Capistrano::CLI.ui.ask "Tag to deploy (leave it blank to deploy from trunk or use branches/xxx to deploy that branch): " }
+    end
+    # ensure repository root is set if using the recipe
+    _cset(:repository_root) { abort "You must set your :repository_root to use this recipe" }
+    # build the repository url
+    set(:repository) do
+      branch = fetch(:branch, '')
+      branch = 'trunk' if branch.empty?
+      branch = "tags/#{branch}" unless branch == 'trunk' or branch.start_with? 'branches/'
+      File.join(fetch(:repository_root), branch)
+    end
+  end
+
+  # task for querying svn tags
+  # task for querying svn branches
+end

data/spec/capistrano-tags_spec.rb

@@ -0,0 +1,169 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+require 'capistrano/configuration'
+require 'capistrano/cli'
+
+describe "CapistranoTags" do
+
+  def load_gem_code
+    load File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'capistrano-tags.rb'))
+  end
+
+  def stub_cli_response answer
+    Capistrano::CLI.ui.stubs(:ask).returns(answer)
+  end
+
+  before(:each) do
+    @config = Capistrano::Configuration.new
+    Capistrano::Configuration.stubs(:instance).returns(@config)
+  end
+
+  after(:each) do
+    # reset ENV variable used for test
+    ENV['SVN_TAG'] = nil
+    ENV['ASK_FOR_TAG'] = nil
+  end
+
+  describe "capistrano instance validation" do
+
+    it "should validate presence of :repository_root variable" do
+      Capistrano::Configuration.stubs(:respond_to?).returns(false)
+      STDERR.stubs(:write) # avoid errors output for the labmda
+      lambda { load_gem_code }.should raise_error SystemExit, "capistrano-tags requires Capistrano 2"
+    end
+  end
+
+  describe "svn behavior" do
+
+    describe "variables validation" do
+
+      it "should validate presence of :repository_root variable" do
+        @config.unset(:repository_root)
+        load_gem_code
+        STDERR.stubs(:write) # avoid errors output for the labmda
+        lambda { @config.fetch(:repository, false)}.should raise_error SystemExit, "You must set your :repository_root to use this recipe"
+      end
+    end
+
+    before(:each) do
+      @root = 'http://svn.example.org'
+      @config.set(:scm, :subversion)
+      @config.set(:repository_root, 'http://svn.example.org')
+    end
+
+    it "should deploy trunk with no configuration" do
+      load_gem_code
+      @config.fetch(:repository).should == File.join(@root, 'trunk')
+    end
+
+    it "should deploy the given tag when :branch is set" do
+      @config.set(:branch, '1.0')
+      load_gem_code
+      @config.fetch(:repository).should == File.join(@root, 'tags', '1.0')
+    end
+
+    it "should deploy the given branch when :branch starts with branches/" do
+      @config.set(:branch, 'branches/stable')
+      load_gem_code
+      @config.fetch(:repository).should == File.join(@root, 'branches', 'stable')
+    end
+
+    it "should deploy the given tag when ENV['SVN_TAG'] is set" do
+      ENV['SVN_TAG'] = '1.0'
+      load_gem_code
+      @config.fetch(:repository).should == File.join(@root, 'tags', '1.0')
+    end
+
+    it "should deploy the given branch when ENV['SVN_TAG'] starts with 'branches/'" do
+      ENV['SVN_TAG'] = 'branches/stable'
+      load_gem_code
+      @config.fetch(:repository).should == File.join(@root, 'branches', 'stable')
+    end
+
+    it "should ask for tag when ENV['ASK_FOR_TAG'] is set" do
+      ENV['ASK_FOR_TAG'] = '1'
+      stub_cli_response '1.0.2'
+      load_gem_code
+      @config.fetch(:repository).should == File.join(@root, 'tags', '1.0.2')
+    end
+
+    it "should deploy the given branch location when answer starts with 'branches/'" do
+      ENV['ASK_FOR_TAG'] = '1'
+      stub_cli_response 'branches/stable'
+      load_gem_code
+      @config.fetch(:repository).should == File.join(@root, 'branches', 'stable')
+    end
+
+    it "should deploy trunk location when cli answer is empty" do
+      ENV['ASK_FOR_TAG'] = '1'
+      stub_cli_response ''
+      load_gem_code
+      @config.fetch(:repository).should == File.join(@root, 'trunk')
+    end
+
+    it "should ask for tag when ask_for_tag is set to true" do
+      @config.set(:ask_for_tag, true)
+      stub_cli_response '1.0.2'
+      load_gem_code
+      @config.fetch(:repository).should == File.join(@root, 'tags', '1.0.2')
+    end
+  end
+
+  describe "git behavior" do
+
+    require 'capistrano/recipes/deploy/scm/git'
+    class TestSCM < Capistrano::Deploy::SCM::Git
+      default_command "git"
+    end
+
+    before(:each) do
+      @config.set(:scm, :git)
+      @config.set(:repository, 'git://github.com/fabn/capistrano-tags.git')
+      @source = TestSCM.new(@config)
+    end
+
+    it "should deploy HEAD branch with no configuration" do
+      load_gem_code
+      TestSCM.new(@config).head.should == 'HEAD'
+    end
+
+    it "should deploy the given tag (or branch) when :branch is set" do
+      @config.set(:branch, '1.0')
+      load_gem_code
+      TestSCM.new(@config).head.should == '1.0'
+    end
+
+    it "should deploy the given tag (or branch) when ENV['GIT_TAG'] is set" do
+      ENV['GIT_TAG'] = '1.0'
+      load_gem_code
+      TestSCM.new(@config).head.should == '1.0'
+    end
+
+    it "should deploy HEAD when ENV['GIT_TAG'] is empty" do
+      ENV['GIT_TAG'] = ''
+      load_gem_code
+      TestSCM.new(@config).head.should == 'HEAD'
+    end
+
+    it "should ask for tag (or branch) when ENV['ASK_FOR_TAG'] is set" do
+      ENV['ASK_FOR_TAG'] = '1'
+      stub_cli_response '1.0.2'
+      load_gem_code
+      TestSCM.new(@config).head.should == '1.0.2'
+    end
+
+    it "should deploy HEAD when cli answer is empty" do
+      ENV['ASK_FOR_TAG'] = '1'
+      stub_cli_response ''
+      load_gem_code
+      TestSCM.new(@config).head.should == 'HEAD'
+    end
+
+    it "should ask for tag when ask_for_tag is set to true" do
+      @config.set(:ask_for_tag, true)
+      stub_cli_response '1.0.2'
+      load_gem_code
+      TestSCM.new(@config).head.should == '1.0.2'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+
+# 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|
+  config.mock_with :mocha
+end

metadata

@@ -0,0 +1,236 @@
+--- !ruby/object:Gem::Specification 
+name: capistrano-tags
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Fabio Napoleoni
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-04 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: capistrano
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 2
+        - 5
+        - 0
+        version: 2.5.0
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: rspec
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: bundler
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: jeweler
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 6
+        - 0
+        version: 1.6.0
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: rcov
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id005
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: mocha
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id006
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: autotest-standalone
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id007
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: autotest-rails-pure
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id008
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: zentest-without-autotest
+  version_requirements: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id009
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: autotest-fsevent
+  version_requirements: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id010
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: autotest-growl
+  version_requirements: &id011 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id011
+description: "Use this recipe if you want to be able to deploy scm tags (or branches) with no need to edit your main deploy.rb file. You can choose the deployed tag using ENV variables or interactively decide which is the tag to deploy. "
+email: f.napoleoni@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.markdown
+files: 
+- .document
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.markdown
+- Rakefile
+- VERSION
+- lib/capistrano-tags.rb
+- spec/capistrano-tags_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/fabn/capistrano-tags
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+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"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Capistrano recipe to deploy svn and git tags
+test_files: []
+