auto_tagger 0.1.5 → 0.2.0

data/.gitignore

@@ -4,4 +4,7 @@ rdoc/*
 .DS_Store
 test_files/*
 .idea/*
-.bundle/*
+.bundle/*
+.rvmrc
+junk.*
+.auto_tagger

data/CHANGELOG

@@ -1,3 +1,27 @@
+2010-08-10
+
+- Added the following commands
+  - help
+  - version
+  - create STAGE
+  - list STAGE
+  - cleanup STAGE
+  - delete_locally STAGE
+  - delete_on_remote STAGE
+- Added the following options to autotag
+  --date-separator - the character used to separate parts of the timestamp
+  --fetch-refs - whether to fetch refs before creating or listing them
+  --push-refs - whether to push refs after creating them
+  --remote - specify a custom remote (defaults to "origin")
+  --ref-path - use a different ref directory, other than "tags"
+  --stages - specify all of the stages
+  --offline - don't push or fetch refs (is ignored with delete_on_remote command)
+  --dry-run - don't execute anything, but print the commands
+  --verbose - prints all commands as they run
+  --refs-to-keep - when using any clean commans, specify how many refs to keep
+  --executable - specify the full path to the git executable
+  --opts-file - the location of an additional opts file
+
 2010-05-15
 
 - Fixed the exit status in autotag executable (thank you Sarah Mei)
@@ -19,7 +43,7 @@
 
 2009-04-20
 
-- `release_tagger:create_tag` creates a production tag if you don't set any stages
+- `release_tagger:create_ref` creates a production tag if you don't set any stages
 
 2009-04-05
 
@@ -31,7 +55,7 @@
 
 - Capistrano bases new tags off of old tags from the previous environment when tagging if there is a tag from the previous environment
 - Added the following cap tasks:
-  - print_latest_tags
+  - print_latest_refs
   - read_tag_from_shared
   - write_tag_to_shared
 

data/Gemfile

@@ -1,8 +1,8 @@
 source :gemcutter
 
-gem "cucumber", "0.6.4"
+gem "rake", "0.8.7"
+gem "rspec", "2.0.0.beta.19"
+gem "cucumber", "0.8.5"
 gem "capistrano", "2.5.18"
 gem "capistrano-ext", "1.2.1"
-gem "rspec", "1.3.0"
-gem "rr", "0.8.1"
-gem "activesupport", "2.3.5"
+gem "jeweler", "1.4.0"

data/Gemfile.lock

@@ -0,0 +1,60 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    builder (2.1.2)
+    capistrano (2.5.18)
+      highline
+      net-scp (>= 1.0.0)
+      net-sftp (>= 2.0.0)
+      net-ssh (>= 2.0.14)
+      net-ssh-gateway (>= 1.0.0)
+    capistrano-ext (1.2.1)
+      capistrano (>= 1.0.0)
+    cucumber (0.8.5)
+      builder (~> 2.1.2)
+      diff-lcs (~> 1.1.2)
+      gherkin (~> 2.1.4)
+      json_pure (~> 1.4.3)
+      term-ansicolor (~> 1.0.4)
+    diff-lcs (1.1.2)
+    gemcutter (0.6.1)
+    gherkin (2.1.5)
+      trollop (~> 1.16.2)
+    git (1.2.5)
+    highline (1.6.1)
+    jeweler (1.4.0)
+      gemcutter (>= 0.1.0)
+      git (>= 1.2.5)
+      rubyforge (>= 2.0.0)
+    json_pure (1.4.3)
+    net-scp (1.0.2)
+      net-ssh (>= 1.99.1)
+    net-sftp (2.0.4)
+      net-ssh (>= 2.0.9)
+    net-ssh (2.0.23)
+    net-ssh-gateway (1.0.1)
+      net-ssh (>= 1.99.1)
+    rake (0.8.7)
+    rspec (2.0.0.beta.19)
+      rspec-core (= 2.0.0.beta.19)
+      rspec-expectations (= 2.0.0.beta.19)
+      rspec-mocks (= 2.0.0.beta.19)
+    rspec-core (2.0.0.beta.19)
+    rspec-expectations (2.0.0.beta.19)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.0.beta.19)
+    rubyforge (2.0.4)
+      json_pure (>= 1.1.7)
+    term-ansicolor (1.0.5)
+    trollop (1.16.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  capistrano (= 2.5.18)
+  capistrano-ext (= 1.2.1)
+  cucumber (= 0.8.5)
+  jeweler (= 1.4.0)
+  rake (= 0.8.7)
+  rspec (= 2.0.0.beta.19)

data/README.md

@@ -24,31 +24,56 @@ You can use the `autotag` command to tag releases on your CI box, then use the c
 
 ## The autotag executable
 
-Installing the gem creates an executable file named autotag, which takes two arguments: the stage, and optionally the path to the git repo:
-
-    $ autotag demo  # => creates a tag like demo/200804041234 in the current directory
-    $ autotag demo . # => same as above
-    $ autotag demo /Users/me/foo # => cd's to /Users/me/foo before creating the tag
-
-Running autotag does the following:
-
-    $ git fetch origin --tags
-    $ git tag <stage>/<timestamp>
-    $ git push origin --tags
+Installing the gem creates an executable file named autotag, which takes the stage, optionally the path to the git repo, and options:
+
+    $ autotag create demo  # => creates a tag like demo/200804041234 in the current directory
+    $ autotag create demo . # => same as above
+    $ autotag create demo /Users/me/foo # => cd's to /Users/me/foo before creating the tag
+
+By default, running autotag does the following:
+
+    $ git fetch origin refs/tags/*:refs/tags/*
+    $ git update-ref refs/tags/demo/20100910051459 1242b283208d06661b2a916097c41c046510af68
+    $ git push origin refs/tags/*:refs/tags/*
+
+The autotag executable has the following commands:
+
+    help
+    version
+    create STAGE
+    list STAGE
+    cleanup STAGE
+    delete_locally STAGE
+    delete_on_remote STAGE
+
+The autotag executable accepts the following options:
+
+    --date-separator - the character used to separate parts of the timestamp
+    --fetch-refs - whether to fetch refs before creating or listing them
+    --push-refs - whether to push refs after creating them
+    --remote - specify a custom remote (defaults to "origin")
+    --ref-path - use a different ref directory, other than "tags"
+    --stages - specify all of the stages
+    --offline - don't push or fetch refs (is ignored with delete_on_remote command)
+    --dry-run - don't execute anything, but print the commands
+    --verbose - prints all commands as they run
+    --refs-to-keep - when using any clean commans, specify how many refs to keep
+    --executable - specify the full path to the git executable
+    --opts-file - the location of a custom options file
 
 ## Capistrano Integration
 
 AutoTagger comes with 2 capistrano tasks: 
 
-  * `release_tagger:set_branch` tries to set the branch to the last tag from the previous environment.
-  * `release_tagger:create_tag` runs autotag for the current stage
+  * `auto_tagger:set_branch` tries to set the branch to the last tag from the previous environment.
+  * `auto_tagger:create_ref` runs autotag for the current stage
 
 Example `config/deploy.rb` file:
 
-    require 'release_tagger'
+    require 'auto_tagger/recipes'
 
-    # The :autotagger_stages variable is required
-    set :autotagger_stages, [:ci, :staging, :production]
+    # The :auto_tagger_stages variable is required
+    set :auto_tagger_stages, [:ci, :staging, :production]
 
     # The :working_directory variable is optional, and defaults to Dir.pwd
     # :working_directory can be an absolute or relative path
@@ -56,32 +81,47 @@ Example `config/deploy.rb` file:
 
     task :production do
       # In each of your environments that need auto-branch setting, you need to set :stage
-      set :stage, :production
+      set :auto_tagger_stage, :production
     end
 
     task :staging do
       # If you do not set stage, it will not auto-set your branch
-      # set :stage, :staging
+      # set :auto_tagger_stage, :staging
     end
 
     # You need to add the before/ater callbacks yourself
-    before "deploy:update_code", "release_tagger:set_branch"
-    after  "deploy", "release_tagger:create_tag"
-    after  "deploy", "release_tagger:write_tag_to_shared"
-    after  "deploy", "release_tagger:print_latest_tags"
+    before "deploy:update_code", "auto_tagger:set_branch"
+    after  "deploy", "auto_tagger:create_ref"
+    after  "deploy", "auto_tagger:write_tag_to_shared"
+    after  "deploy", "auto_tagger:print_latest_refs"
 
-### Cpistano-ext multistage support
+### Capistano-ext multistage support
 
 If you use capistano-ext multistage, you can use auto_tagger.
 
-    set :autotagger_stages, [:ci, :staging, :production]
+    set :auto_tagger_stages, [:ci, :staging, :production]
     set :stages, [:staging, :production]
     set :default_stage, :staging
     require 'capistrano/ext/multistage'
 
-When you deploy, autotagger will auto-detect your current stage.
+When you deploy, auto_tagger will auto-detect your current stage.
+
+You can specify the following capistrano variables that correspond to the autotag options:
+
+    :auto_tagger_date_separator
+    :auto_tagger_push_refs
+    :auto_tagger_fetch_refs
+    :auto_tagger_remote
+    :auto_tagger_ref_path
+    :auto_tagger_offline
+    :auto_tagger_dry_run
+    :auto_tagger_verbose
+    :auto_tagger_refs_to_keep
+    :auto_tagger_executable
+    :auto_tagger_opts_file
+    :auto_tagger_working_directory
 
-### release_tagger:set_branch
+### auto_tagger:set_branch
 
 This task sets the git branch to the latest tag from the previous stage.  Assume you have the following tags in your git repository:
 
@@ -91,7 +131,7 @@ This task sets the git branch to the latest tag from the previous stage.  Assume
 
 And the following stages in your capistrano file:
 
-    set :autotagger_stages, [:ci, :staging, :production]
+    set :auto_tagger_stages, [:ci, :staging, :production]
 
 The deployments would look like this:
 
@@ -109,29 +149,29 @@ If you add `before "deploy:update_code", "release_tagger:set_branch"`, you can j
     
 and the branch will be set for you automatically.
 
-### release_tagger:create_tag
+### release_tagger:create_ref
 
 This cap task creates a new tag, based on the latest tag from the previous environment.  
 
 If there is no tag from the previous stage, it creates a new tag from the latest commit in your _working directory_.
 
-If you don't specify any `autotagger_stages`, autotagger will create a tag that starts with "production".
+If you don't specify any `auto_tagger_stages`, auto_tagger will create a tag that starts with "production".
 
-### release_tagger:print_latest_tags
+### release_tagger:print_latest_refs
 
 This task reads the git version from the text file in shared:
 
     cap staging release_tagger:read_tag_from_shared
 
-### release_tagger:print_latest_tags
+### release_tagger:print_latest_refs
 
 This task takes the latest tag from each environment and prints it to the screen.  You can add it to your deploy.rb like so:
 
-    after  "deploy", "release_tagger:print_latest_tags"
+    after  "deploy", "release_tagger:print_latest_refs"
 
 Or call it directly, like:
 
-    cap production release_tagger:print_latest_tags
+    cap production release_tagger:print_latest_refs
     
 This will produce output like:
 
@@ -140,6 +180,14 @@ This will produce output like:
      ** staging    staging/20090331050908         8031807feb5f4f99dd83257cdc07081fa6080cba some commit message
      ** production production/20090331050917      8031807feb5f4f99dd83257cdc07081fa6080cba some commit message
 
+## Configuration
+
+You can store options in an options file, which is .auto_tagger by default.  You can set options in this file like so:
+
+    --date-separator=-
+    --ref-path=autotags
+    --refs-to-keep=5
+
 ## Running tests:
 
 You must be able to ssh into your box via localhost (remote login).  To make this easier, add your own key to your own account:
@@ -152,13 +200,18 @@ To ensure that this has worked, try this:
     
 If it asks you for a password, you've done something wrong.
 
-To run the specs, execute:
+To run the specs, first make sure you have the required gems:
+
+    gem install bundler
+    bundle install
+
+Then execute:
 
-    spec spec/
+    rspec spec
     
 To run the cucumber features, execute:
 
-    cucumber features/
+    cucumber features
 
 ## Acknowledgments
 
@@ -169,6 +222,7 @@ Special thanks to:
  * Chad Wooley for his feature ideas
  * Tim Holahan for his QA
  * Pat Nakajima for making auto_tagger a better ruby citizen
+ * Josh Susser for recommending the date format changes
 
 ## Links
 

data/Rakefile

@@ -13,34 +13,9 @@ begin
     gem.require_paths = ["lib"]
     gem.executables = ["autotag"]
     gem.default_executable = %q{autotag}
-    gem.date = %q{2010-04-25}
+    gem.date = %q{2010-09-10}
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
 end
-
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.spec_files = FileList['spec/**/*_spec.rb']
-end
-
-Spec::Rake::SpecTask.new(:rcov) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-end
-
-
-task :default => :spec
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "the-perfect-gem #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/VERSION

@@ -1 +1 @@
-0.1.5
+0.2.0

data/auto_tagger.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{auto_tagger}
-  s.version = "0.1.5"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jeff Dean", "Brian Takita", "Mike Grafton", "Bruce Krysiak", "Pat Nakajima", "Jay Zeschin", "Mike Barinek", "Sarah Mei"]
-  s.date = %q{2010-05-15}
+  s.date = %q{2010-09-10}
   s.default_executable = %q{autotag}
   s.email = %q{jeff@zilkey.com}
   s.executables = ["autotag"]
@@ -21,6 +21,7 @@ Gem::Specification.new do |s|
      ".gitignore",
      "CHANGELOG",
      "Gemfile",
+     "Gemfile.lock",
      "MIT-LICENSE",
      "README.md",
      "Rakefile",
@@ -36,35 +37,44 @@ Gem::Specification.new do |s|
      "features/templates/cap_ext_deploy.erb",
      "features/templates/deploy.erb",
      "features/templates/stage.erb",
-     "geminstaller.yml",
      "lib/auto_tagger.rb",
      "lib/auto_tagger/base.rb",
      "lib/auto_tagger/capistrano_helper.rb",
+     "lib/auto_tagger/command_line.rb",
      "lib/auto_tagger/commander.rb",
+     "lib/auto_tagger/configuration.rb",
+     "lib/auto_tagger/deprecator.rb",
+     "lib/auto_tagger/git/ref.rb",
+     "lib/auto_tagger/git/ref_set.rb",
+     "lib/auto_tagger/git/repo.rb",
+     "lib/auto_tagger/options.rb",
      "lib/auto_tagger/recipes.rb",
-     "lib/auto_tagger/repository.rb",
-     "lib/auto_tagger/stage_manager.rb",
-     "lib/auto_tagger/tag.rb",
      "spec/auto_tagger/base_spec.rb",
      "spec/auto_tagger/capistrano_helper_spec.rb",
+     "spec/auto_tagger/command_line_spec.rb",
      "spec/auto_tagger/commander_spec.rb",
-     "spec/auto_tagger/repository_spec.rb",
-     "spec/auto_tagger/stage_manager_spec.rb",
-     "spec/auto_tagger/tag_spec.rb",
+     "spec/auto_tagger/configuration_spec.rb",
+     "spec/auto_tagger/git/ref_set_spec.rb",
+     "spec/auto_tagger/git/ref_spec.rb",
+     "spec/auto_tagger/git/repo_spec.rb",
+     "spec/auto_tagger/options_spec.rb",
      "spec/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/zilkey/auto_tagger}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{Helps you automatically create tags for each stage in a multi-stage deploment and deploy from the latest tag from the previous environment}
   s.test_files = [
     "spec/auto_tagger/base_spec.rb",
      "spec/auto_tagger/capistrano_helper_spec.rb",
+     "spec/auto_tagger/command_line_spec.rb",
      "spec/auto_tagger/commander_spec.rb",
-     "spec/auto_tagger/repository_spec.rb",
-     "spec/auto_tagger/stage_manager_spec.rb",
-     "spec/auto_tagger/tag_spec.rb",
+     "spec/auto_tagger/configuration_spec.rb",
+     "spec/auto_tagger/git/ref_set_spec.rb",
+     "spec/auto_tagger/git/ref_spec.rb",
+     "spec/auto_tagger/git/repo_spec.rb",
+     "spec/auto_tagger/options_spec.rb",
      "spec/spec_helper.rb"
   ]
 
@@ -72,7 +82,7 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<capistrano>, [">= 2.5.3"])
     else
       s.add_dependency(%q<capistrano>, [">= 2.5.3"])

data/bin/autotag

@@ -1,35 +1,20 @@
 #!/usr/bin/env ruby
 require File.expand_path(File.join(File.dirname(__FILE__), "..", "lib", "auto_tagger"))
-require 'getoptlong'
 
-def usage
-  puts
-  puts "USAGE: #{File.basename($0)} <stage> [<repository>]"
-  puts
-  puts '    where:    stage       sets the tag prefix'
-  puts '              repository  sets the repository to act on - defualts to the current directory'
-  puts
-  puts '    examples: autotag'
-  puts '              autotag .'
-  puts '              autotag ../'
-  puts '              autotag /data/myrepo'
-  puts '              autotag demo'
-  puts
-  puts
-  exit 0
-end
-
-if ARGV[0] && ["-h", "--help", "-?", "--?"].include?(ARGV[0])
-  usage
-elsif ARGV[0]
-  begin
-    AutoTagger::Runner.new(ARGV[0], ARGV[1]).create_tag
-  rescue Exception => e
-    puts "Error occured: #{e}"
-    exit 1
+begin
+  success, message = AutoTagger::CommandLine.new(ARGV.dup).execute
+  if success
+    puts message
+    Kernel.exit 0
   else
-    exit 0
+    puts "Error occured: #{message}"
+    Kernel.exit 1
   end
-else
-  usage
+rescue SystemExit => e
+  Kernel.exit(e.status)
+rescue Exception => e
+  STDERR.puts("Error occured:")
+  STDERR.puts("  #{e.message} (#{e.class})")
+  STDERR.puts(e.backtrace.join("\n  "))
+  Kernel.exit(1)
 end

data/features/autotag.feature

@@ -9,7 +9,7 @@ Feature: Deployment
     And I should see "USAGE:"
     And no tags should be created
     And exit code should be 0
-    
+
   Scenario: user runs autotag with "--help"
     Given a repo
     When I run autotag with "--help"
@@ -31,21 +31,62 @@ Feature: Deployment
     And no tags should be created
     And exit code should be 0
 
+  @deprecated
   Scenario: user runs autotag with "demo"
     Given a repo
     When I run autotag with "demo"
     Then a "demo" tag should be created
     And exit code should be 0
 
+  @deprecated
   Scenario: user runs autotag with "demo ."
     Given a repo
     When I run autotag with "demo"
     Then a "demo" tag should be created
     And exit code should be 0
 
+  @deprecated
   Scenario: autotag cannot successfully complete
     Given a repo
     When I run autotag with "demo /no/such/path"
     Then I should see "Error occured:"
     And exit code should be 1
-    And no tags should be created
+    And no tags should be created
+
+  @deprecated
+  Scenario: path is incorrect
+    Given a repo
+    When I run autotag with "create demo /no/such/path"
+    Then I should see "Error occured:"
+    And exit code should be 1
+    And no tags should be created
+
+  @1.0.0
+  Scenario: user runs autotag with "help"
+    Given a repo
+    When I run autotag with "help"
+    And I should see "USAGE:"
+    And no tags should be created
+    And the exit code should be 0
+
+  @1.0.0
+  Scenario: user runs autotag with "version"
+    Given a repo
+    When I run autotag with "version"
+    And I should see "AutoTagger version"
+    And no tags should be created
+    And the exit code should be 0
+
+  @1.0.0
+  Scenario: user runs autotag with "create demo . --date-separator -"
+    Given a repo
+    When I run autotag with "create demo --date-separator -"
+    Then a hyphen-delimited "demo" tag should be created
+    And the exit code should be 0
+
+  @1.0.0
+  Scenario: user runs autotag with "cleanup" with no stage
+    Given a repo
+    When I run autotag with "cleanup"
+    Then I should see "Error occured: You must provide a stage"
+    And the exit code should be 1

data/features/deployment.feature

@@ -3,18 +3,21 @@ Feature: Deployment
   As a ruby and git ninja
   I want cap to do all the work for me
 
+  @0.1.5
   Scenario: user deploys with single file deploy.rb with 3 stages
     Given a three-stage app using single deploy file
     And a ci tag
     When I deploy to staging
     Then a tag should be added to git
 
+  @0.1.5
   Scenario: user deploys with single file deploy.rb with no stages
     Given a one-stage app using single deploy file with the following environments:
       |production  |
     When I deploy
     Then a "production" tag should be added to git
 
+  @0.1.5
   Scenario: user deploys with single file deploy.rb stages with dashes in the name
     Given a one-stage app using single deploy file with the following environments:
       |staging            |
@@ -22,6 +25,7 @@ Feature: Deployment
     When I deploy to secret-production
     Then a "secret-production" tag should be added to git
 
+  @0.1.5
   Scenario: user deploys with cap-ext multistage
     Given a three-stage app using cap-multistage
     And a ci tag