step-up 0.5.0 → 0.6.0

data/README.md

@@ -1,5 +1,8 @@
 # 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).
+StepUp is a tool to manage versioning.
+That means you can bump the version of your project, for example, from v3.0.11 to v4.0.0, check the current version, summarize all the history of versions in a changelog and more.
+
+StepUp is based on source control management features (i.e. tags, branches, commits, notes etc), so it doesn't need to keep files with the current version (but it supports it, if you want), it has visibility of all history of changes and versions (doesn't matter if they are spread in many different branches), which adds a variety of possibilities in terms of management, depending on your project needs.
 
 ## Prerequisite
 Git version 1.7.1 and above.
@@ -14,32 +17,26 @@ With that said, run
 
     stepup init
 
-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
-### Checking out the current version
-
-    stepup version 
-
-or just
-
-    stepup
+### Current project version
 
-This will tell you the current application version. 
+    stepup [version]
 
-One example of output would be
+An example of output would be
 
-    v0.2.0+1
+    v0.2.0+3
 
-The "+1" part means the project has one commit since last version.
+The "+3" 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 more detail later.
 
-### Creating new version
+### Stepping up a version
 
     stepup version create [--level LEVEL_NAME]
 
-where **LEVEL_NAME**  
+where **LEVEL_NAME**, by default, could be  
 
 * major
 * minor

data/lib/step-up/cli.rb

@@ -13,6 +13,7 @@ module StepUp
     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
+    method_options %w(masks) => :string # stepup version show --masks
     VERSION_ACTIONS = %w[show create help]
     def version(action = nil, commit_base = nil)
       unless VERSION_ACTIONS.include?(action)
@@ -45,13 +46,15 @@ module StepUp
     desc "changelog --top=<num> --format={default|wiki|html}", "show changelog from each version tag"
     method_options %w[top -n] => :numeric
     method_options %w[format -f] => :string
+    method_options %w(mask -M) => :string # stepup changelog --mask development_hudson_build_0
     def changelog
       log = []
       method_name = "changelog_format_#{ options[:format] }"
       method_name = "changelog_format_default" unless respond_to?(method_name)
+      driver = driver(options[:mask])
       driver.all_version_tags.each_with_index do |tag, index|
         break if options[:top] && index >= options[:top]
-        log << send(method_name, tag)
+        log << send(method_name, tag, driver.version_tag_info(tag))
       end
       puts log.join("\n\n")
     end
@@ -59,7 +62,9 @@ module StepUp
     desc "notes ACTION [base_object] [OPTIONS]", "show notes for the next version"
     method_options :clean => :boolean, :steps => :boolean, :"-m" => :string, :since => :string, :after => :string, :upto => :string
     method_options :fetch => :boolean
+    method_options :"with-commit" => :boolean
     method_options %w[section -s] => :string
+    method_options :sections => :array
     def notes(action = "show", commit_base = nil)
       unless %w[show add remove help].include?(action)
         commit_base ||= action
@@ -81,14 +86,12 @@ module StepUp
 
     protected
 
-    def changelog_format_default(tag)
-      tag_info = driver.version_tag_info(tag)
+    def changelog_format_default(tag, tag_info)
       created_at = tag_info[:date].strftime("%b/%d %Y %H:%M %z")
     "\033[0;33m#{tag} (#{created_at} by #{tag_info[:tagger]})\033[0m\n\n#{ tag_info[:message] }"
     end
 
-    def changelog_format_html(tag)
-      tag_info = driver.version_tag_info(tag)
+    def changelog_format_html(tag, tag_info)
       created_at = tag_info[:date].strftime("%b/%d %Y %H:%M %z")
       log = []
       log << "<h3 class=\"changelog_header\">#{tag} (#{created_at} by #{tag_info[:tagger]})</h3>"
@@ -99,8 +102,7 @@ module StepUp
       log.join("\n")
     end
 
-    def changelog_format_wiki(tag)
-      tag_info = driver.version_tag_info(tag)
+    def changelog_format_wiki(tag, tag_info)
       created_at = tag_info[:date].strftime("%b/%d %Y %H:%M %z")
       log = []
       log << "== #{tag} (#{created_at} by #{tag_info[:tagger]}) ==\n"
@@ -162,12 +164,16 @@ module StepUp
     end
 
     def notes_add
-      message = options[:m] 
+      message = options[:m]
       message = nil if options[:m] =~ /^(|m)$/
 
+      last_commit = driver.commit_history(commit_object, 1, :with_messages => true).first
+      if last_commit.nil?
+        puts "This repository has no commit history"
+        exit 1
+      end
       unless message
-        last_commit = driver.commit_history(commit_object, 1, :with_messages => true).first
-        message = last_commit.last if last_commit
+        message = last_commit.last
         message << <<-TEXT
 
 
@@ -177,7 +183,7 @@ module StepUp
         message = edit_message(driver.class::NOTE_MESSAGE_FILE_PATH, message)
       end
       
-      unless message.empty?
+      unless message.nil? || message.empty?
         section = options[:section] || choose(CONFIG.notes_sections.names, "Choose a section to add the note:")
         if section.nil? || ! CONFIG.notes_sections.names.include?(section)
           puts "Aborting due to invalid section"
@@ -194,6 +200,17 @@ module StepUp
         version_levels.each  do |level|
           puts " - #{level}"
         end
+      elsif options[:masks]
+        all_tags = driver.tags.scan(/[^\r\n]+/)
+        all_masks = all_tags.map{ |tag| tag.gsub(/\d+/, '0') }.uniq.sort
+        masks = []
+        prev = nil
+        all_masks.each do |mask|
+          next unless mask =~ /\d$/
+          mask = masks.pop + mask[prev.size..-1].gsub(/0/, '9') if prev && mask.start_with?(prev.gsub(/9/, '0'))
+          masks << (prev = mask)
+        end
+        puts masks.join("\n") if masks.any?
       else
         mask = options[:mask]
         mask = nil if mask !~ /0/
@@ -324,8 +341,6 @@ module StepUp
             f.write content
           end
         end
-      else
-        say_status :ignore, "Ignoring creation of lib/tasks/versioning.rake", :yellow
       end
     end
 
@@ -361,12 +376,32 @@ module StepUp
       File.open(temp_file, "w"){ |f| f.write initial_content }
       editor = driver.editor_name
       if editor =~ /\w/
+        init_time = Time.now
         if editor =~ /^vim?\b/
           system "#{ editor } #{ temp_file }"
         else
           `#{ editor } #{ temp_file } && wait $!`
         end
+        elapsed_time = Time.now - init_time
+        if elapsed_time < 1.0
+          puts "Premature termination of the text editor."
+          puts "Make sure of having set the editor as appropriate."
+          exit 1
+        end
         File.read(temp_file).gsub(/^\#.*/m, '').rstrip
+      else
+        puts <<-TEXT
+No editor found.
+
+  You can specify the editor by the following ways:
+  - By git-config
+    $ git config --global core.editor 'mate -w'
+  - By environment variables
+    $ export $GIT_EDITOR='mate -w'`
+    #or
+    $ export $EDITOR='mate -w'
+TEXT
+        exit 1
       end
     end
 
@@ -386,7 +421,7 @@ module StepUp
         
         initial_tag = sanitize_tag_version(initial_tag)
         final_tag = sanitize_tag_version(final_tag)
-        @ranged_notes = StepUp::RangedNotes.new(driver, initial_tag, final_tag, :exclude_initial_tag_notes => options[:after])
+        @ranged_notes = StepUp::RangedNotes.new(driver, initial_tag, final_tag, :exclude_initial_tag_notes => options[:after], :notes_sections => options[:sections])
       end
       @ranged_notes
     end
@@ -397,9 +432,9 @@ module StepUp
 
     def get_notes(clean = options[:clean], custom_message = nil)
       notes_options = {}
-      notes_options[:mode] = :with_objects unless clean
+      notes_options[:mode] = :with_objects unless clean || clean.nil? && ! options[:"with-commit"]
       notes_options[:custom_message] = custom_message
-      notes_hash = (options[:since].nil? && options[:after].nil? ? driver.cached_detached_notes_as_hash(commit_object || "HEAD") : ranged_notes.all_notes.as_hash)
+      notes_hash = (options[:since].nil? && options[:after].nil? ? driver.cached_detached_notes_as_hash(commit_object || "HEAD", options["sections"]) : ranged_notes.all_notes.as_hash)
       notes_hash.to_changelog(notes_options)
     end
 
@@ -459,8 +494,9 @@ module StepUp
     end
 
     def check_notes_config
+      return true if driver.cached_fetched_remotes.empty?
       remotes_with_notes = driver.fetched_remotes('notes')
-      unfetched_remotes = driver.fetched_remotes - remotes_with_notes
+      unfetched_remotes = driver.cached_fetched_remotes - remotes_with_notes
       cmds = []
       unless remotes_with_notes.any? || unfetched_remotes.empty?
         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]:")

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

@@ -10,7 +10,12 @@ module StepUp
         new.last_version_tag
       end
 
+      def empty_repository?
+        `git branch`.empty?
+      end
+
       def commit_history(commit_base, *args)
+        return [] if empty_repository?
         options = args.last.is_a?(Hash) ? args.pop : {}
         top = args.shift
         top = "-n#{ top }" unless top.nil?
@@ -32,17 +37,13 @@ module StepUp
       end
 
       def objects_with_notes_of(ref)
-        `git notes --ref=#{ ref } list`.gsub(/^\w+\s(\w+)$/, '\1').split(/\n/)
+        `git notes --ref=#{ ref } list`.scan(/\w+$/)
       end
 
       def note_message(ref, commit)
         `git notes --ref=#{ ref } show #{ commit }`
       end
 
-      def notes_messages(objects_with_notes)
-        objects_with_notes.messages
-      end
-
       def all_version_tags
         @version_tags ||= tags.scan(mask.regex).map{ |tag| tag.collect(&:to_i) }.sort.map{ |tag| mask.format(tag) }.reverse
       end
@@ -56,10 +57,10 @@ module StepUp
         {: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
+      def detached_notes_as_hash(commit_base = "HEAD", notes_sections = nil)
+        tag = all_version_tags.any? ? cached_last_version_tag(commit_base) : nil
+        tag = tag.sub(/\+$/, '') unless tag.nil?
+        RangedNotes.new(self, tag, commit_base, :notes_sections => notes_sections).notes.as_hash
       end
 
       def steps_to_increase_version(level, commit_base = "HEAD", message = nil)
@@ -68,9 +69,9 @@ module StepUp
         new_tag = mask.increase_version(tag, level)
         notes = cached_detached_notes_as_hash(commit_base)
         commands = []
-        commands << "git fetch"
+        commands << "git fetch" if cached_fetched_remotes.any?
         commands << "git tag -a -m \"#{ (message || notes.to_changelog).gsub(/([\$\\"`])/, '\\\\\1') }\" #{ new_tag } #{ commit_base }"
-        commands << "git push #{cached_fetched_remotes("notes").first} refs/tags/#{new_tag}"
+        commands << "git push #{cached_fetched_remotes("notes").first} refs/tags/#{new_tag}" if cached_fetched_remotes.any?
         commands + steps_for_archiving_notes(notes, new_tag)
       end
 
@@ -107,7 +108,7 @@ module StepUp
       end
 
       def zero_version(commit_base = "HEAD", count_commits = false)
-        "%s+%s" % [mask.blank, "#{ commit_history(commit_base).size if count_commits }"]
+        "%s+%s" % [mask.blank, "#{ tags.empty? ? '0' : commit_history(commit_base).size if count_commits }"]
       end
     end
   end

data/lib/step-up/git_extensions.rb

@@ -14,17 +14,17 @@ module StepUp
 
       def steps_for_add_notes(section, message, commit_base = nil)
         commands = []
-        commands << "git fetch"
+        commands << "git fetch" if cached_fetched_remotes.any?
         commands << "git notes --ref=#{ section } add -m \"#{ message.gsub(/([\$\\"`])/, '\\\\\1') }\" #{ commit_base }"
-        commands << "git push #{ notes_remote } refs/notes/#{ section }"
+        commands << "git push #{ notes_remote } refs/notes/#{ section }" if cached_fetched_remotes.any?
         commands
       end
 
       def steps_to_remove_notes(section, commit_base)
         commands = []
-        commands << "git fetch"
+        commands << "git fetch" if cached_fetched_remotes.any?
         commands << "git notes --ref=#{ section } remove #{ commit_base }"
-        commands << "git push #{ notes_remote } refs/notes/#{ section }"
+        commands << "git push #{ notes_remote } refs/notes/#{ section }" if cached_fetched_remotes.any?
         commands
       end
 
@@ -46,7 +46,7 @@ module StepUp
             end
             unless removed_notes.empty?
               commands += removed_notes
-              commands << "git push #{ driver.notes_remote } refs/notes/#{ section }"
+              commands << "git push #{ driver.notes_remote } refs/notes/#{ section }" if driver.cached_fetched_remotes.any?
             end
           end
           commands
@@ -69,7 +69,7 @@ module StepUp
               end
             end
           end
-          commands << "git push #{ driver.notes_remote } refs/notes/#{ CONFIG.notes.after_versioned.section }" unless objects.empty?
+          commands << "git push #{ driver.notes_remote } refs/notes/#{ CONFIG.notes.after_versioned.section }" unless objects.empty? || driver.cached_fetched_remotes.empty?
           commands
         end
       end

data/lib/step-up/ranged_notes.rb

@@ -7,6 +7,7 @@ module StepUp
 
     def initialize(driver, first_commit = nil, last_commit = "HEAD", options={})
       @include_initial_tag_notes = !options[:exclude_initial_tag_notes]
+      @notes_sections = notes_sections(options[:notes_sections])
       @driver = driver
       @last_commit = driver.commit_history(last_commit, 1).first
       first_commit = driver.commit_history(first_commit, 1).first unless first_commit.nil?
@@ -69,7 +70,7 @@ module StepUp
     def all_visible_notes
       unless defined? @all_visible_notes
         notes = []
-        CONFIG.notes_sections.names.each do |section|
+        @notes_sections.names.each do |section|
           all_notes_of_section(section, all_commits).each{ |note| notes << note }
         end
         @all_visible_notes = notes
@@ -94,9 +95,9 @@ module StepUp
     end
 
     def scoped_commit_notes
-      prefixes = CONFIG.notes_sections.prefixes
-      sections = CONFIG.notes_sections.names
-      tags = CONFIG.notes_sections.tags
+      prefixes = @notes_sections.prefixes
+      sections = @notes_sections.names
+      tags = @notes_sections.tags
       notes = []
       scoped_commits.each do |commit|
         message = commit.last
@@ -129,6 +130,30 @@ module StepUp
     def include_initial_tag_notes?
       @include_initial_tag_notes
     end
+    
+    def notes_sections(notes_sections_names)
+      notes_sections = []
+      
+      if notes_sections_names
+        notes_sections_names.each do |note_section_name|
+          sections_found = CONFIG.notes_sections.select { |ns| ns["name"] == note_section_name }
+          
+          if sections_found.empty?
+            raise ArgumentError, "Invalid section: #{note_section_name}"
+          else
+            notes_sections << sections_found.first
+          end
+        end
+        
+        class << notes_sections
+          include StepUp::ConfigSectionsExt
+        end
+      else
+        notes_sections = CONFIG.notes_sections
+      end
+      
+      notes_sections
+    end
 
   end
 

data/spec/lib/step-up/ranged_notes_spec.rb

@@ -17,13 +17,14 @@ describe StepUp::RangedNotes do
 
   context "testing notes" do
     before do
-      notes_sections = %w[test_changes test_bugfixes test_features]
+      notes_sections = [{"name"=>"test_changes"}, {"name"=>"test_bugfixes"}, {"name"=>"test_features"}]
       class << notes_sections
         include StepUp::ConfigSectionsExt
       end
       StepUp::CONFIG.stubs(:notes_sections).returns(notes_sections)
       StepUp::CONFIG.notes.after_versioned.stubs(:section).returns("test_versioning")
     end
+
     context "until object f4cfcc2" do
       before do
         @notes = StepUp::RangedNotes.new(@driver, nil, "f4cfcc2")
@@ -136,5 +137,106 @@ describe StepUp::RangedNotes do
         @notes.notes.as_hash.to_changelog.should be == changelog
       end
     end
+
+    context "until object f4cfcc2 with specific notes sections" do
+      before do
+        @notes = StepUp::RangedNotes.new(@driver, nil, "f4cfcc2", {:notes_sections => ["test_changes", "test_features"]})
+      end
+      it "should get all detached notes" do
+        @notes.notes.should be == [
+          [5, "test_changes", 1, "8299243c7dac8f27c3572424a348a7f83ef0ce28",
+           "removing files from gemspec\n  .gitignore\n  lastversion.gemspec\n"],
+          [1, "test_changes", 1, "2fb8a3281fb6777405aadcd699adb852b615a3e4",
+           "loading default configuration yaml\n\nloading external configuration yaml\n"]
+        ]
+      end
+      it "should get a hash of distinct notes" do
+        @notes.notes.should respond_to :as_hash
+        @notes.notes.as_hash.should be == {
+          "test_changes" => [
+            ["8299243c7dac8f27c3572424a348a7f83ef0ce28",
+             "removing files from gemspec\n  .gitignore\n  lastversion.gemspec\n", 1],
+            ["2fb8a3281fb6777405aadcd699adb852b615a3e4",
+             "loading default configuration yaml\n\nloading external configuration yaml\n", 1]
+          ]
+        }
+      end
+      it "should get the changelog message without objects" do
+        @notes.notes.as_hash.should respond_to :to_changelog
+        changelog = <<-EOF
+        Test changes:
+        
+          - removing files from gemspec
+            - .gitignore
+            - lastversion.gemspec
+          - loading default configuration yaml
+          - loading external configuration yaml
+        EOF
+        changelog.gsub!(/^\s{8}/, '')
+        changelog = changelog.rstrip
+        @notes.notes.as_hash.to_changelog.should be == changelog
+      end
+      it "should get the changelog message with objects" do
+        @notes.notes.as_hash.should respond_to :to_changelog
+        changelog = <<-EOF
+        Test changes:
+        
+          - removing files from gemspec (8299243c7dac8f27c3572424a348a7f83ef0ce28)
+            - .gitignore
+            - lastversion.gemspec
+          - loading default configuration yaml (2fb8a3281fb6777405aadcd699adb852b615a3e4)
+          - loading external configuration yaml
+        EOF
+        changelog.gsub!(/^\s{8}/, '')
+        changelog = changelog.rstrip
+        @notes.notes.as_hash.to_changelog(:mode => :with_objects).should be == changelog
+      end
+      it "should get the changelog message with custom message" do
+        @notes.notes.as_hash.should respond_to :to_changelog
+        changelog = <<-EOF
+        Custom message:
+        
+          - New version create feature
+          - Removed old version create feature
+        
+        Test changes:
+        
+          - removing files from gemspec
+            - .gitignore
+            - lastversion.gemspec
+          - loading default configuration yaml
+          - loading external configuration yaml
+        EOF
+        changelog.gsub!(/^\s{8}/, '')
+        changelog = changelog.rstrip
+        message_option = {:custom_message => "New version create feature\n\nRemoved old version create feature"}
+        @notes.notes.as_hash.to_changelog(message_option).should be == changelog
+      end
+      it "should get the changelog message without custom message" do
+        @notes.notes.as_hash.should respond_to :to_changelog
+        changelog = <<-EOF
+        Test changes:
+        
+          - removing files from gemspec
+            - .gitignore
+            - lastversion.gemspec
+          - loading default configuration yaml
+          - loading external configuration yaml
+        EOF
+        changelog.gsub!(/^\s{8}/, '')
+        changelog = changelog.rstrip
+        @notes.notes.as_hash.to_changelog.should be == changelog
+      end
+    end
+    
+    context "with specific notes section that doesn't exists" do
+      it "should raise an exception" do
+        block = lambda do
+          StepUp::RangedNotes.new(@driver, nil, "f4cfcc2", {:notes_sections => ["invalid_note_section"]})
+        end
+        
+        block.should raise_error(ArgumentError)
+      end
+    end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: step-up
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 7
   prerelease: false
   segments: 
   - 0
-  - 5
+  - 6
   - 0
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors: 
 - Marcelo Manzan
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-28 00:00:00 -03:00
+date: 2011-05-20 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency