step-up 0.3.1 → 0.4.0

data/.stepuprc

@@ -23,6 +23,15 @@ notes:
       tag: "deploy_step"
 versioning:
   version_mask: "v0.0.0.9"
+  auto_increment:
+    sections_level:
+      minor:
+        - features
+        - deploy_steps
+      patch:
+        - bugfixes
+      tiny:
+        - changes
   version_levels:
     - major
     - minor

data/README.md

@@ -1,10 +1,11 @@
-# StepUp: a project to 'step up' your projects
-StepUp is a tool to manage versioning based on source control management features (i.e. tags and notes of Git). That is, you don't need to keep track of your application version in a file anymore !!!
+# StepUp: a project to step up your projects
+StepUp is a tool to manage versioning based on source control management features (i.e. tags and notes of Git).
 
 ## Prerequisite
-This is temporary but for now StepUp just works with Git version 1.7.1 and above.
+Git version 1.7.1 and above.
 
 ## Installation
+
     gem install step-up
 
 ## First of all
@@ -12,44 +13,69 @@ Have in mind that StepUp has only Git support for now (more to come soon!!), so
 With that said, run
 
     stepup init
-This will prepare your repository to use one of the coolest feature of StepUp called ***notes***
-Besides that it will create a file in your project called **.stepuprc** 
+
+It will create a file in your project called **.stepuprc** 
 We'll cover more about this in the next sections.
 
 ## The Basics
-### Check out the version
-    stepup version
-This will tell you the application version based on Git tag.
-Currently the result of this command on StepUp project itself will be
+### Checking out the current version
+
+    stepup version 
+
+or just
+
+    stepup
+
+This will tell you the current application version. 
+
+One example of output would be
 
     v0.2.0+1
+
 The "+1" part means the project has one commit since last version.
-The format of the version is totally customizable through **.stepuprc** which we will cover in the next sections.
+The format of the version is totally customizable through **.stepuprc** which we will cover in more detail later.
+
+### Creating new version
 
-### Create new version
     stepup version create --level LEVEL_NAME
-where **LEVEL_NAME** can be 
+
+where **LEVEL_NAME**  
 
 * major
 * minor
-* tiny
 * patch
-* rc
+* tiny
+
+This command will ask user to input a message for the version and will increment the version number accordingly.
+
+Each level corresponds to a position in the version mask.
+Considering default settings of .stepuprc, this means:
+
+    v0.0.0.0 => vMAJOR.MINOR.PATCH.TINY
 
-This command will ask user for a message for the version and will increment the version number accordingly
+The versioning increment is based on the last version tag found in the repository, and works as follows:
 
-### Check out the history
-    stepup changelog --top N
-where **N** is the number of versions that will be displayed from newer to older ones
+    v0.5.3.2 => v0.5.3.3 (TINY increment)
+    v0.5.3.2 => v0.5.4   (PATCH increment)
+    v0.5.3.2 => v0.6.0   (MINOR increment)
+    v0.5.3.2 => v1.0.0   (MAJOR increment)
+
+### Checking out the changelog
+
+    stepup changelog
 
 ## StepUp beyond basics
 ***Comming soon***
 
-## Report bugs and suggestions
+## Project
+* https://github.com/kawamanza/step-up
 
-  * [Issue Tracker](https://github.com/kawamanza/step-up/issues)
+## Report bugs and suggestions
+* [Issue Tracker](https://github.com/kawamanza/step-up/issues)
 
 ## Authors
-
  * [Eric Fer](https://github.com/ericfer)
- * [Marcelo Manzan](https://github.com/kawamanza)
+ * [Marcelo Manzan](https://github.com/kawamanza) 
+ 
+## Collaborators
+ * [Lucas Fais](https://github.com/lucasfais)

data/Rakefile

@@ -21,19 +21,21 @@ end
 
 desc "Build the gem"
 task :build do
+  gem_name = 'step-up'
   opers = Dir.glob('*.gem')
   opers = ["rm #{ opers.join(' ') }"] unless opers.empty?
-  opers << ["gem build step-up.gemspec"]
+  opers << ["gem build #{gem_name}.gemspec"]
   sh opers.join(" && ")
 end
 
 desc "Build and install the gem, removing old installation"
 task :install => :build do
   gem = Dir.glob('*.gem').first
+  gem_name = 'step-up'
   if gem.nil?
     puts "could not install the gem"
   else
-    sh "gem uninstall --ignore-dependencies --executables step-up; gem install #{ gem }"
+    sh "gem uninstall --ignore-dependencies --executables #{gem_name}; gem install #{ gem }"
   end
 end
 

data/bin/stepup

@@ -4,6 +4,9 @@ require 'step-up/cli'
 
 begin
   StepUp::CLI.start
+rescue SystemExit => e
+  raise e
 rescue Exception => e
-  puts e.message
+  puts "StepUp Exception: #{e.message}"
+  exit 1
 end

data/lib/step-up/cli.rb

@@ -3,18 +3,23 @@ require 'step-up'
 
 module StepUp
   class CLI < Thor
+    attr_reader :commit_object
     include Thor::Actions
     map %w(--version -v) => :gem_version  # $ stepup [--version|-v]
     
     default_task :version
 
-    desc "version ACTION [OPTIONS]", "manage versions of your project"
+    desc "version ACTION [base_object] [OPTIONS]", "manage versions of your project"
     method_options %w(levels -L) => :boolean # $ stepup version [--levels|-L]
     method_options %w(level -l) => :string, %w(steps -s) => :boolean, %w(message -m) => :string, :'no-editor' => :boolean  # $ stepup version create [--level|-l <level-name>] [--steps|-s] [--message|-m <comment-string>] [--no-editor]
     method_options %w(mask -M) => :string # stepup version show --mask development_hudson_build_0
     VERSION_ACTIONS = %w[show create help]
-    def version(action = nil)
-      action = "show" unless VERSION_ACTIONS.include?(action)
+    def version(action = nil, commit_base = nil)
+      unless VERSION_ACTIONS.include?(action)
+        commit_base ||= action
+        action = "show"
+      end
+      @commit_object = commit_base
       if self.respond_to?("version_#{action}")
         send("version_#{action}")
       else
@@ -144,15 +149,17 @@ module StepUp
       puts log.join("\n\n")
     end
 
-    desc "notes ACTION [object] [OPTIONS]", "show notes for the next version"
+    desc "notes ACTION [base_object] [OPTIONS]", "show notes for the next version"
     method_options :clean => :boolean, :steps => :boolean, :"-m" => :string, :since => :string
+    method_options :fetch => :boolean
     def notes(action = "show", commit_base = nil)
       unless %w[show add remove help].include?(action)
         commit_base ||= action
         action = "show"
       end
+      @commit_object = commit_base
       if self.respond_to?("notes_#{action}")
-        check_notes_config && send("notes_#{action}", commit_base)
+        check_notes_config && send("notes_#{action}")
       else
         puts "invalid action: #{action}"
       end
@@ -188,21 +195,24 @@ module StepUp
       created_at = tag_info[:date].strftime("%b/%d %Y %H:%M %z")
       log = []
       log << "== #{tag} (#{created_at} by #{tag_info[:tagger]}) ==\n"
-      log << tag_info[:message].gsub(/^(\s+)-/, '\1*')
+      log << tag_info[:message].gsub(/^(?:\t\t|\s\s\s\s)-\s/, "** ").gsub(/^(?:\t|\s\s)-\s/, "* ")
       log.join("\n")
     end
 
-    def notes_show(commit_base = nil)
+    def notes_show
       message = []
-      message << "Showing notes since #{ options[:since] }#{ " (including notes of tags: #{ ranged_notes.scoped_tags.join(", ")})" if ranged_notes.scoped_tags.any? }" unless options[:since].nil?
+      unless options[:since].nil?
+        message_header = "Showing notes since #{ options[:since] }"
+        message_header << " (including notes of tags: #{ ranged_notes.scoped_tags.join(", ")})" if ranged_notes.scoped_tags.any?
+        message << message_header
+      end
       message << "---"
       message << get_notes
       puts message.join("\n")
     end
 
-    def notes_remove(commit_base)
-      commit_base = "HEAD" if commit_base.nil?
-      ranged_notes = StepUp::RangedNotes.new(driver, nil, commit_base)
+    def notes_remove
+      ranged_notes = StepUp::RangedNotes.new(driver, nil, commit_object || "HEAD")
       notes = ranged_notes.notes_of(ranged_notes.last_commit).as_hash
       sections = notes.keys
       if sections.empty?
@@ -219,14 +229,14 @@ module StepUp
       end
     end
 
-    def notes_add(commit_base = nil)
+    def notes_add
       message = options[:m] 
       message = nil if options[:m] =~ /^(|m)$/
       message ||= get_message("Note message:\n>>", " >")
       unless message.empty?
         section = choose(CONFIG.notes_sections.names, "Choose a section to add the note:")
         return if section.nil? || ! CONFIG.notes_sections.names.include?(section)
-        steps = driver.steps_for_add_notes(section, message, commit_base)
+        steps = driver.steps_for_add_notes(section, message, commit_object)
         print_or_run(steps, options[:steps])
       end
     end
@@ -240,25 +250,36 @@ module StepUp
       else
         mask = options[:mask]
         mask = nil if mask !~ /0/
-        puts driver(mask).last_version_tag("HEAD", true)
+        puts driver(mask).last_version_tag(commit_object || "HEAD", true)
       end
     end
 
     def version_create
-      level = options[:level] || version_levels.last
+      level = options[:level] || "auto"
       message = get_notes(true, get_custom_message)
       message = edit_message(driver.class::VERSION_MESSAGE_FILE_PATH, message) unless options[:'no-editor']
 
       if message.strip.empty?
         puts "\ninvalid version message: too short"
-        return
+        exit(1)
+      end
+
+      if level == "auto" && CONFIG.versioning["auto_increment"].is_a?(Hash)
+        detached_notes = driver.cached_detached_notes_as_hash(commit_object || "HEAD")
+        level = version_levels.last
+        version_levels.reverse.each do |name|
+          sections = CONFIG.versioning.auto_increment.sections_level[name]
+          next if sections.nil?
+          level = name if detached_notes.any?{ |section, notes| sections.include?(section) && notes.any? }
+        end
       end
 
       if version_levels.include? level
-        steps = driver.steps_to_increase_version(level, "HEAD", message)
+        steps = driver.steps_to_increase_version(level, commit_object || "HEAD", message)
         print_or_run(steps, options[:steps])
       else
         puts "invalid version create option: #{level}"
+        exit(1)
       end
     end
     
@@ -284,23 +305,23 @@ module StepUp
 
     def ranged_notes
       unless defined? @ranged_notes
-        tag = options[:since] || driver.last_version_tag
-        if tag =~ /[1-9]/
-          tag = tag.gsub(/\+\d*$/, '')
+        initial_tag = options[:since] || driver.cached_last_version_tag(commit_object || "HEAD")
+        if initial_tag =~ /[1-9]/
+          initial_tag = initial_tag.gsub(/\+\d*$/, '')
         else
-          tag = nil
+          initial_tag = nil
         end
-        @ranged_notes = StepUp::RangedNotes.new(driver, tag, "HEAD")
+        @ranged_notes = StepUp::RangedNotes.new(driver, initial_tag, commit_object || "HEAD")
       end
       @ranged_notes
     end
 
     def get_notes(clean = options[:clean], custom_message = nil)
-      changelog_options = {}
-      changelog_options[:mode] = :with_objects unless clean
-      changelog_options[:custom_message] = custom_message
-      notes = (options[:since].nil? ? ranged_notes.notes : ranged_notes.all_notes)
-      notes.as_hash.to_changelog(changelog_options)
+      notes_options = {}
+      notes_options[:mode] = :with_objects unless clean
+      notes_options[:custom_message] = custom_message
+      notes_hash = (options[:since].nil? ? driver.cached_detached_notes_as_hash(commit_object || "HEAD") : ranged_notes.all_notes.as_hash)
+      notes_hash.to_changelog(notes_options)
     end
 
     def choose(list, statement)
@@ -337,7 +358,7 @@ module StepUp
     end
 
     def version_levels
-      CONFIG["versioning"]["version_levels"]
+      CONFIG.versioning.version_levels
     end
     
     def print_or_run(steps, print)
@@ -361,8 +382,9 @@ module StepUp
     def check_notes_config
       remotes_with_notes = driver.fetched_remotes('notes')
       unfetched_remotes = driver.fetched_remotes - remotes_with_notes
+      cmds = []
       unless remotes_with_notes.any? || unfetched_remotes.empty?
-        answer = raw_ask("To perform this operation you need some additional fetch instruction on your git-config file.\nMay stepup add the missing instruction for you? [yes/no]:")
+        answer = options[:fetch] ? "yes" : raw_ask("To perform this operation you need some additional fetch instruction on your git-config file.\nMay stepup add the missing instruction for you? [yes/no]:")
         return false unless answer == "yes"
         if unfetched_remotes.size > 1
           remote = choose(unfetched_remotes, "Which remote would you like to fetch notes?")
@@ -370,9 +392,10 @@ module StepUp
         else
           remote = unfetched_remotes.first
         end
-        cmds = ["git config --add remote.#{remote}.fetch +refs/notes/*:refs/notes/*", "git fetch #{remote}"]
-        print_or_run(cmds, false)
+        cmds << "git config --add remote.#{remote}.fetch +refs/notes/*:refs/notes/*" unless remote.nil?
       end
+      cmds << "git fetch #{remote}" if options[:fetch] || cmds.any?
+      print_or_run(cmds, false) unless cmds.empty?
       true
     end
     

data/lib/step-up/config/step-up.yml

@@ -1,7 +1,6 @@
 notes:
   after_versioned:
-    #strategy: "remove"
-    strategy: "keep"
+    strategy: "keep" # Valid options: "keep" or "remove"
     section: "versioning"
     changelog_message: "available on {version}"
   sections:
@@ -23,6 +22,15 @@ notes:
       tag: "deploy_step"
 versioning:
   version_mask: "v0.0.0.9"
+  auto_increment:
+    sections_level:
+      minor:
+        - features
+        - deploy_steps
+      patch:
+        - bugfixes
+      tiny:
+        - changes
   version_levels:
     - major
     - minor

data/lib/step-up/driver/git.rb

@@ -1,13 +1,9 @@
 module StepUp
   module Driver
-    class Git
+    class Git < Base
       VERSION_MESSAGE_FILE_PATH = ".git/TAG_EDITMSG"
       
       include GitExtensions::Notes
-      attr_reader :mask
-      def initialize(mask = nil)
-        @mask = Parser::VersionMask.new(mask || CONFIG.versioning.version_mask)
-      end
 
       def self.last_version
         new.last_version_tag
@@ -52,20 +48,27 @@ module StepUp
 
       def version_tag_info(tag)
         full_message = `git show #{ tag }`
-        tag_message = full_message[/\A.*?\n\n(.*)\n\ncommit\s\w{40}\n/m, 1]
+        tag_pattern = tag.gsub(/\./, '\\.')
+        tag_message = full_message[/^tag\s#{tag_pattern}.*?\n\n(.*?)\n\n(?:tag\s[^\s]+|commit\s\w{40})\n/m, 1] || ""
         tagger = full_message[/\A.*?\nTagger:\s(.*?)\s</m, 1]
         date = Time.parse(full_message[/\A.*?\nDate:\s+(.*?)\n/m, 1])
         {:message => tag_message, :tagger => tagger, :date => date}
       end
 
+      def detached_notes_as_hash(commit_base = "HEAD")
+        tag = cached_last_version_tag(commit_base)
+        tag = tag.sub(/\+$/, '')
+        RangedNotes.new(self, tag, commit_base).notes.as_hash
+      end
+
       def steps_to_increase_version(level, commit_base = "HEAD", message = nil)
-        tag = last_version_tag(commit_base)
+        tag = cached_last_version_tag(commit_base)
         tag = tag.sub(/\+$/, '')
         new_tag = mask.increase_version(tag, level)
-        notes = RangedNotes.new(self, tag, commit_base).notes.as_hash
+        notes = cached_detached_notes_as_hash(commit_base)
         commands = []
         commands << "git fetch"
-        commands << "git tag -a -m \"#{ (message || notes.to_changelog).gsub(/([\$\\"])/, '\\\\\1') }\" #{ new_tag }"
+        commands << "git tag -a -m \"#{ (message || notes.to_changelog).gsub(/([\$\\"])/, '\\\\\1') }\" #{ new_tag } #{ commit_base }"
         commands << "git push --tags"
         commands + steps_for_archiving_notes(notes, new_tag)
       end
@@ -73,7 +76,7 @@ module StepUp
       def last_version_tag(commit_base = "HEAD", count_commits = false)
         all_versions = all_version_tags
         unless all_versions.empty?
-          commits = commit_history(commit_base)
+          commits = cached_commit_history(commit_base)
           all_versions.each do |tag|
             commit_under_the_tag = commit_history(tag, 1).first
             index = commits.index(commit_under_the_tag)

data/lib/step-up/driver.rb

@@ -0,0 +1,31 @@
+module StepUp
+  module Driver
+    autoload :Git, 'step-up/driver/git.rb'
+    class Base
+      attr_reader :mask
+      attr_reader :cache
+      def initialize(mask = nil)
+        @mask = Parser::VersionMask.new(mask || CONFIG.versioning.version_mask)
+        @cache = {}
+      end
+
+      def method_missing(called_method, *args, &block)
+        if called_method.to_s =~ /^cached_(.+)$/
+          method = $1
+          if respond_to?(method)
+            if block_given?
+              send(method, *args, &block)
+            else
+              cache[method] ||= {}
+              cache[method][args] ||= send(method, *args)
+            end
+          else
+            super
+          end
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/step-up/ranged_notes.rb

@@ -18,7 +18,7 @@ module StepUp
     end
 
     def all_notes
-      (visible_detached_notes + scoped_attached_notes + scoped_commit_notes).sort.reverse.extend NotesArray
+      (visible_detached_notes + scoped_commit_notes + scoped_attached_notes).sort.reverse.extend NotesArray
     end
 
     def notes_of(commit)
@@ -37,9 +37,16 @@ module StepUp
       unless defined? @scoped_tags
         tags = []
         commits = scoped_commits.collect(&:first)
-        driver.all_version_tags.each do |version_tag|
-          object = driver.commit_history(version_tag, 1).first
-          tags << version_tag if commits.include?(object)
+        all_version_tags = driver.all_version_tags
+        unless all_version_tags.empty?
+          all_version_tags.each do |version_tag|
+            object = driver.commit_history(version_tag, 1).first
+            tags << version_tag if commits.include?(object)
+          end
+          unless tags.empty?
+            last_tag_version = all_version_tags[(all_version_tags.index(tags.last).next)]
+            tags << last_tag_version if last_tag_version
+          end
         end
         @scoped_tags = tags
       end

data/lib/step-up/version.rb

@@ -1,6 +1,6 @@
 module StepUp
   version = nil
-  version = $1 if ::File.expand_path('../..', __FILE__) =~ /\/step-up-([\w\.\-]+)/
+  version = $1 if ::File.expand_path('../..', __FILE__) =~ /\/step-up-(\d[\w\.]+)/
   version = Driver::Git.new.last_version_tag if version.nil? && ::File.exists?(::File.expand_path('../../../.git', __FILE__))
   VERSION = version.gsub(/^v?([^\+]+)\+?\d*$/, '\1')
 end

data/lib/step-up.rb

@@ -1,9 +1,7 @@
 module StepUp
   autoload :CONFIG, 'step-up/config.rb'
   autoload :VERSION, 'step-up/version.rb'
-  module Driver
-    autoload :Git, 'step-up/driver/git.rb'
-  end
+  autoload :Driver, 'step-up/driver.rb'
   autoload :GitExtensions, 'step-up/git_extensions.rb'
   autoload :RangedNotes, 'step-up/ranged_notes.rb'
   module Parser

data/spec/lib/step-up/driver/git_spec.rb

@@ -3,7 +3,7 @@ require 'time'
 
 describe StepUp::Driver::Git do
   before do
-    @driver = StepUp::Driver::Git.new
+    @driver = StepUp::Driver::Git.new("v0.0.0.9.rc9")
   end
 
 
@@ -115,7 +115,7 @@ describe StepUp::Driver::Git do
         
         Test bugfixes:
         
-          - sorting tags according to the mask parser" v0.1.0
+          - sorting tags according to the mask parser" v0.1.0 f4cfcc2
 
         git push --tags
 
@@ -154,7 +154,7 @@ describe StepUp::Driver::Git do
         
         Test bugfixes:
         
-          - sorting tags according to the mask parser" v0.1.0
+          - sorting tags according to the mask parser" v0.1.0 f4cfcc2
 
         git push --tags
 

metadata

@@ -1,22 +1,22 @@
 --- !ruby/object:Gem::Specification 
 name: step-up
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 15
   prerelease: false
   segments: 
   - 0
-  - 3
-  - 1
-  version: 0.3.1
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Marcelo Manzan
-- Eric Adrien Fer
+- Eric Fer
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2011-02-10 00:00:00 -02:00
+date: 2011-03-23 00:00:00 -03:00
 default_executable: stepup
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -82,6 +82,7 @@ files:
 - lib/step-up/cli.rb
 - lib/step-up/config.rb
 - lib/step-up/config/step-up.yml
+- lib/step-up/driver.rb
 - lib/step-up/driver/git.rb
 - lib/step-up/git_extensions.rb
 - lib/step-up/parser/version_mask.rb