step-up 0.4.0 → 0.5.0

data/README.md

@@ -37,7 +37,7 @@ The format of the version is totally customizable through **.stepuprc** which we
 
 ### Creating new version
 
-    stepup version create --level LEVEL_NAME
+    stepup version create [--level LEVEL_NAME]
 
 where **LEVEL_NAME**  
 
@@ -65,6 +65,28 @@ The versioning increment is based on the last version tag found in the repositor
     stepup changelog
 
 ## StepUp beyond basics
+
+### Working with notes
+
+With StepUp we are able to attach additional comments on existing commit objects.
+The great goal of this Gem is giving to developers an easy way to manage these notes.
+The note was created with the following command:
+
+    $ stepup notes add --section bugfixes -m "support for old installations"
+
+Still with this example we can check the created note with the following command:
+
+    $ stepup notes
+    ---
+    Bugfixes:
+
+      - support for old installations
+
+The command above fetches the entire commit history, gets each note and organizes them in sections.
+Found notes are displayed as a big changelog message.
+
+### Creating rich changelogs
+
 ***Comming soon***
 
 ## Project
@@ -78,4 +100,4 @@ The versioning increment is based on the last version tag found in the repositor
  * [Marcelo Manzan](https://github.com/kawamanza) 
  
 ## Collaborators
- * [Lucas Fais](https://github.com/lucasfais)
+ * [Lucas Fais](https://github.com/lucasfais)

data/lib/step-up/cli.rb

@@ -27,111 +27,18 @@ module StepUp
       end
     end
 
-    desc "init", "adds .stepuprc to your project and prepare your local repository to use notes"
+    desc "init", "Prepare your project to use stepup"
     method_options :update => :boolean
+    method_options :gemfile => :boolean
+    method_options :version_file_support => :boolean
     def init
-      # creates .stepuprc file
-      content = File.read(File.expand_path("../config/step-up.yml", __FILE__))
-      if options[:update] || ! File.exists?(".stepuprc")
-        say_status File.exists?(".stepuprc") ? :update : :create, ".stepuprc", :green
-        File.open(".stepuprc", "w") do |f|
-          f.write content
-        end
-      else
-        say_status :skip, "Creating .stepuprc", :yellow
-      end
-      # Changing Gemfile
-      if File.exists?("Gemfile")
-        gem_file = File.read("Gemfile")
-        if gem_file =~ /\bstep-up\b/
-          regex = /^(\s*gem\s+(?:'step-up'|"step-up")\s*,\s*['"])((?:~>|=>|=)\s*.*?)(['"])/
-          if gem_file =~ regex && ! $2.end_with?(StepUp::VERSION)
-            say_status :update, "Updating dependency to step-up on Gemfile", :green
-            File.open("Gemfile", "w") do |f|
-              f.write gem_file.gsub(regex, '\1~> '+StepUp::VERSION+'\3')
-            end
-          else
-            say_status :skip, "Adding dependency to step-up on Gemfile", :yellow
-          end
-        else
-          say_status :update, "Adding dependency to step-up on Gemfile", :green
-          content = File.read(File.expand_path(File.join(__FILE__, '..', '..', '..', 'templates', 'default', 'Gemfile')))
-          stepup_dependency = template_render(content)
-          File.open("Gemfile", "w") do |f|
-            f.write gem_file
-            f.write "\n" unless gem_file.end_with?("\n")
-            f.write stepup_dependency
-          end
-        end
-      else
-        say_status :skip, "Gemfile not found", :yellow
-      end
-      # Creating lib/version.rb
-      content = File.read(File.expand_path(File.join(__FILE__, '..', '..', '..', 'templates', 'default', 'lib', 'version.rb')))
-      new_version_rb = template_render(content)
-      Dir.mkdir('lib') unless File.exists?('lib')
-      if File.exists?("lib/version.rb")
-        version_rb = File.read("lib/version.rb")
-        if version_rb =~ /\bStepUp\b/
-          say_status :skip, "Creating lib/version.rb", :yellow
-        else
-          say_status :update, "Appending to lib/version.rb", :green
-          File.open("lib/version.rb", "w") do |f|
-            f.write version_rb
-            f.write "\n" unless version_rb.end_with?("\n")
-            f.write new_version_rb
-          end
-        end
-      else
-        say_status :create, "Creating lib/version.rb", :green
-        File.open("lib/version.rb", "w") do |f|
-          f.write new_version_rb
-        end
-      end
-      # Updating Rakefile
-      if File.exists?("Rakefile")
-        content = File.read(File.expand_path(File.join(__FILE__, '..', '..', '..', 'templates', 'default', 'Rakefile')))
-        content = template_render(content)
-        if File.exists?("lib/tasks/versioning.rake") && File.read("lib/tasks/versioning.rake") =~ /\bstep-up\b/
-          content = File.read("lib/tasks/versioning.rake")
-          say_status :remove, "Removing lib/tasks/versioning.rake", :blue
-          `rm lib/tasks/versioning.rake`
-        end
-        rake_file = File.read("Rakefile")
-        if rake_file =~ /\bstep-up\b/
-          say_status :skip, "Appending to Rakefile", :yellow
-        else
-          say_status :update, "Appending to Rakefile", :green
-          File.open("Rakefile", "w") do |f|
-            f.write rake_file
-            f.write "\n" unless rake_file.end_with?("\n")
-            f.write content
-          end
-        end
-      else
-        say_status :ignore, "Ignoring creation of lib/tasks/versioning.rake", :yellow
-      end
-      # Updating Capfile
-      if File.exists?("Capfile") && File.exists?("Rakefile")
-        content = File.read(File.expand_path(File.join(__FILE__, '..', '..', '..', 'templates', 'default', 'Capfile')))
-        content = template_render(content)
-        cap_file = File.read("Capfile")
-        if cap_file =~ /\bstepup\b/
-          say_status :skip, "Appending to Capfile", :yellow
-        else
-          say_status :update, "Appending to Capfile", :green
-          File.open("Capfile", "w") do |f|
-            f.write cap_file
-            f.write "\n" unless cap_file.end_with?("\n")
-            f.write content
-          end
-        end
-      end
-      # Appending .gitignore
-      unless File.exists?(".gitignore") && File.read(".gitignore") =~ /^#{gsub_params['version_file']}$/
-        run "echo #{gsub_params['version_file']} >> .gitignore"
-      else
-        say_status :skip, "Adding #{gsub_params['version_file']} to .gitignore", :yellow
+      init_create_stepuprc
+      init_update_gemfile if options[:gemfile]
+      if options[:version_file_support]
+        init_update_version_helper
+        init_update_rakefile
+        init_update_capfile
+        init_update_gitignore
       end
     end
 
@@ -150,8 +57,9 @@ module StepUp
     end
 
     desc "notes ACTION [base_object] [OPTIONS]", "show notes for the next version"
-    method_options :clean => :boolean, :steps => :boolean, :"-m" => :string, :since => :string
+    method_options :clean => :boolean, :steps => :boolean, :"-m" => :string, :since => :string, :after => :string, :upto => :string
     method_options :fetch => :boolean
+    method_options %w[section -s] => :string
     def notes(action = "show", commit_base = nil)
       unless %w[show add remove help].include?(action)
         commit_base ||= action
@@ -162,6 +70,7 @@ module StepUp
         check_notes_config && send("notes_#{action}")
       else
         puts "invalid action: #{action}"
+        exit(1)
       end
     end
     
@@ -200,12 +109,29 @@ module StepUp
     end
 
     def notes_show
+      if options[:since] && options[:after]
+        puts "conflict of options: --since and --after cannot be used together\n"
+        exit(1)
+      end
+
+      initial_tag = options[:since] || options[:after]
+      if initial_tag && options[:upto] && initial_tag > options[:upto]
+        puts "conflict of options: --since value #{initial_tag} is greater than --after value #{options[:upto]}\n"
+        exit(1)
+      end
+
       message = []
-      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?
+      if initial_tag || options[:upto]
+        message_header = "Showing notes "
+        if initial_tag
+          option = options[:since] ? "since" : "after"
+          message_header << "#{option} #{ initial_tag } "
+        end
+        message_header <<  "up to #{  options[:upto] } " if  options[:upto]
+        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")
@@ -217,25 +143,46 @@ module StepUp
       sections = notes.keys
       if sections.empty?
         puts "No notes found"
-      else
+        exit(1)
+      end
+      section = options[:section]
+      if section.nil?
         if sections.size > 1
           section = choose(sections, "Which section you want to remove notes?")
-          return unless sections.include?(section)
         else
           section = sections.first
         end
-        steps = driver.steps_to_remove_notes(section, ranged_notes.last_commit)
-        print_or_run(steps, options[:steps])
       end
+      unless sections.include?(section)
+        puts "Aborting due to invalid section"
+        exit(1)
+      end
+      steps = driver.steps_to_remove_notes(section, ranged_notes.last_commit)
+      print_or_run(steps, options[:steps])
     end
 
     def notes_add
       message = options[:m] 
       message = nil if options[:m] =~ /^(|m)$/
-      message ||= get_message("Note message:\n>>", " >")
+
+      unless message
+        last_commit = driver.commit_history(commit_object, 1, :with_messages => true).first
+        message = last_commit.last if last_commit
+        message << <<-TEXT
+
+
+# Please enter the note message for your changes. Lines starting
+# with '#' will be ignored, and an empty message aborts the operation.
+        TEXT
+        message = edit_message(driver.class::NOTE_MESSAGE_FILE_PATH, message)
+      end
+      
       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)
+        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"
+          exit(1)
+        end
         steps = driver.steps_for_add_notes(section, message, commit_object)
         print_or_run(steps, options[:steps])
       end
@@ -257,12 +204,6 @@ module StepUp
     def version_create
       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"
-        exit(1)
-      end
 
       if level == "auto" && CONFIG.versioning["auto_increment"].is_a?(Hash)
         detached_notes = driver.cached_detached_notes_as_hash(commit_object || "HEAD")
@@ -275,6 +216,21 @@ module StepUp
       end
 
       if version_levels.include? level
+        unless options[:'no-editor']
+          message << <<-TEXT
+
+
+# Please enter the log message for your tag. Lines starting
+# with '#' will be ignored, and an empty message aborts the operation.
+# You are about to increase the '#{level}' version level.
+          TEXT
+          message = edit_message(driver.class::VERSION_MESSAGE_FILE_PATH, message)
+        end
+
+        if message.strip.empty?
+          puts "Aborting due to empty log message"
+          exit(1)
+        end
         steps = driver.steps_to_increase_version(level, commit_object || "HEAD", message)
         print_or_run(steps, options[:steps])
       else
@@ -283,6 +239,122 @@ module StepUp
       end
     end
     
+    
+    def init_create_stepuprc
+      content = File.read(File.expand_path("../config/step-up.yml", __FILE__))
+      if options[:update] || ! File.exists?(".stepuprc")
+        say_status File.exists?(".stepuprc") ? :update : :create, ".stepuprc", :green
+        File.open(".stepuprc", "w") do |f|
+          f.write content
+        end
+      else
+        say_status :skip, "Creating .stepuprc", :yellow
+      end      
+    end
+    
+    def init_update_gemfile
+      if File.exists?("Gemfile")
+        gem_file = File.read("Gemfile")
+        if gem_file =~ /\bstep-up\b/
+          regex = /^(\s*gem\s+(?:'step-up'|"step-up")\s*,\s*['"])((?:~>|=>|=)\s*.*?)(['"])/
+          if gem_file =~ regex && ! $2.end_with?(StepUp::VERSION)
+            say_status :update, "Updating dependency to step-up on Gemfile", :green
+            File.open("Gemfile", "w") do |f|
+              f.write gem_file.gsub(regex, '\1~> '+StepUp::VERSION+'\3')
+            end
+          else
+            say_status :skip, "Adding dependency to step-up on Gemfile", :yellow
+          end
+        else
+          say_status :update, "Adding dependency to step-up on Gemfile", :green
+          content = File.read(File.expand_path(File.join(__FILE__, '..', '..', '..', 'templates', 'default', 'Gemfile')))
+          stepup_dependency = template_render(content)
+          File.open("Gemfile", "w") do |f|
+            f.write gem_file
+            f.write "\n" unless gem_file.end_with?("\n")
+            f.write stepup_dependency
+          end
+        end
+      else
+        say_status :skip, "Gemfile not found", :yellow
+      end      
+    end
+    
+    def init_update_version_helper
+      content = File.read(File.expand_path(File.join(__FILE__, '..', '..', '..', 'templates', 'default', 'lib', 'version.rb')))
+      new_version_rb = template_render(content)
+      Dir.mkdir('lib') unless File.exists?('lib')
+      if File.exists?("lib/version.rb")
+        version_rb = File.read("lib/version.rb")
+        if version_rb =~ /\bStepUp\b/
+          say_status :skip, "Creating lib/version.rb", :yellow
+        else
+          say_status :update, "Appending to lib/version.rb", :green
+          File.open("lib/version.rb", "w") do |f|
+            f.write version_rb
+            f.write "\n" unless version_rb.end_with?("\n")
+            f.write new_version_rb
+          end
+        end
+      else
+        say_status :create, "Creating lib/version.rb", :green
+        File.open("lib/version.rb", "w") do |f|
+          f.write new_version_rb
+        end
+      end
+    end
+
+    def init_update_rakefile
+      if File.exists?("Rakefile")
+        content = File.read(File.expand_path(File.join(__FILE__, '..', '..', '..', 'templates', 'default', 'Rakefile')))
+        content = template_render(content)
+        if File.exists?("lib/tasks/versioning.rake") && File.read("lib/tasks/versioning.rake") =~ /\bstep-up\b/
+          content = File.read("lib/tasks/versioning.rake")
+          say_status :remove, "Removing lib/tasks/versioning.rake", :blue
+          `rm lib/tasks/versioning.rake`
+        end
+        rake_file = File.read("Rakefile")
+        if rake_file =~ /\bstep-up\b/
+          say_status :skip, "Appending to Rakefile", :yellow
+        else
+          say_status :update, "Appending to Rakefile", :green
+          File.open("Rakefile", "w") do |f|
+            f.write rake_file
+            f.write "\n" unless rake_file.end_with?("\n")
+            f.write content
+          end
+        end
+      else
+        say_status :ignore, "Ignoring creation of lib/tasks/versioning.rake", :yellow
+      end
+    end
+
+    def init_update_capfile
+      if File.exists?("Capfile") && File.exists?("Rakefile")
+        content = File.read(File.expand_path(File.join(__FILE__, '..', '..', '..', 'templates', 'default', 'Capfile')))
+        content = template_render(content)
+        cap_file = File.read("Capfile")
+        if cap_file =~ /\bstepup\b/
+          say_status :skip, "Appending to Capfile", :yellow
+        else
+          say_status :update, "Appending to Capfile", :green
+          File.open("Capfile", "w") do |f|
+            f.write cap_file
+            f.write "\n" unless cap_file.end_with?("\n")
+            f.write content
+          end
+        end
+      end
+    end
+
+    def init_update_gitignore
+      unless File.exists?(".gitignore") && File.read(".gitignore") =~ /^#{gsub_params['version_file']}$/
+        run "echo #{gsub_params['version_file']} >> .gitignore"
+      else
+        say_status :skip, "Adding #{gsub_params['version_file']} to .gitignore", :yellow
+      end
+    end
+    
     private
 
     def edit_message(temp_file, initial_content)
@@ -294,7 +366,7 @@ module StepUp
         else
           `#{ editor } #{ temp_file } && wait $!`
         end
-        File.read(temp_file).rstrip
+        File.read(temp_file).gsub(/^\#.*/m, '').rstrip
       end
     end
 
@@ -305,22 +377,29 @@ module StepUp
 
     def ranged_notes
       unless defined? @ranged_notes
-        initial_tag = options[:since] || driver.cached_last_version_tag(commit_object || "HEAD")
-        if initial_tag =~ /[1-9]/
-          initial_tag = initial_tag.gsub(/\+\d*$/, '')
-        else
-          initial_tag = nil
+        initial_tag = options[:since] || options[:after] || driver.cached_last_version_tag(commit_object || "HEAD")
+        final_tag = options[:upto] || commit_object || "HEAD"
+        
+        if options[:upto] && !(options[:since] || options[:after])
+          initial_tag = driver.all_version_tags.last
         end
-        @ranged_notes = StepUp::RangedNotes.new(driver, initial_tag, commit_object || "HEAD")
+        
+        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])
       end
       @ranged_notes
     end
 
+    def sanitize_tag_version(tag)
+      tag =~ /[1-9]/ ? tag.gsub(/\+\d*$/, '') : nil
+    end
+
     def get_notes(clean = options[:clean], custom_message = nil)
       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 = (options[:since].nil? && options[:after].nil? ? driver.cached_detached_notes_as_hash(commit_object || "HEAD") : ranged_notes.all_notes.as_hash)
       notes_hash.to_changelog(notes_options)
     end
 

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

@@ -2,6 +2,7 @@ module StepUp
   module Driver
     class Git < Base
       VERSION_MESSAGE_FILE_PATH = ".git/TAG_EDITMSG"
+      NOTE_MESSAGE_FILE_PATH = ".git/NOTE_EDITMSG"
       
       include GitExtensions::Notes
 
@@ -68,8 +69,8 @@ module StepUp
         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 } #{ commit_base }"
-        commands << "git push --tags"
+        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 + steps_for_archiving_notes(notes, new_tag)
       end
 
@@ -102,7 +103,7 @@ module StepUp
       end
 
       def editor_name
-        ENV["EDITOR"] || `git config core.editor`.chomp
+        ENV["GIT_EDITOR"] || ENV["EDITOR"] || `git config core.editor`.chomp
       end
 
       def zero_version(commit_base = "HEAD", count_commits = false)

data/lib/step-up/git_extensions.rb

@@ -15,7 +15,7 @@ module StepUp
       def steps_for_add_notes(section, message, commit_base = nil)
         commands = []
         commands << "git fetch"
-        commands << "git notes --ref=#{ section } add -m \"#{ message.gsub(/([\$"])/, '\\\\\1') }\" #{ commit_base }"
+        commands << "git notes --ref=#{ section } add -m \"#{ message.gsub(/([\$\\"`])/, '\\\\\1') }\" #{ commit_base }"
         commands << "git push #{ notes_remote } refs/notes/#{ section }"
         commands
       end

data/lib/step-up/ranged_notes.rb

@@ -5,7 +5,8 @@ module StepUp
 
     attr_reader :driver, :first_commit, :last_commit
 
-    def initialize(driver, first_commit = nil, last_commit = "HEAD")
+    def initialize(driver, first_commit = nil, last_commit = "HEAD", options={})
+      @include_initial_tag_notes = !options[:exclude_initial_tag_notes]
       @driver = driver
       @last_commit = driver.commit_history(last_commit, 1).first
       first_commit = driver.commit_history(first_commit, 1).first unless first_commit.nil?
@@ -43,9 +44,10 @@ module StepUp
             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
+          if !tags.empty? && include_initial_tag_notes?
+            initial_tag_version_position = all_version_tags.index(tags.last).next
+            initial_tag_version = all_version_tags[initial_tag_version_position]
+            tags << initial_tag_version if initial_tag_version
           end
         end
         @scoped_tags = tags
@@ -124,6 +126,10 @@ module StepUp
       notes
     end
 
+    def include_initial_tag_notes?
+      @include_initial_tag_notes
+    end
+
   end
 
   module NotesHash

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

@@ -117,7 +117,7 @@ describe StepUp::Driver::Git do
         
           - sorting tags according to the mask parser" v0.1.0 f4cfcc2
 
-        git push --tags
+        git push origin refs/tags/v0.1.0
 
         git notes --ref=test_changes remove 8299243c7dac8f27c3572424a348a7f83ef0ce28
 
@@ -156,7 +156,7 @@ describe StepUp::Driver::Git do
         
           - sorting tags according to the mask parser" v0.1.0 f4cfcc2
 
-        git push --tags
+        git push origin refs/tags/v0.1.0
 
         git notes --ref=test_versioning add -m "available on v0.1.0" 8299243c7dac8f27c3572424a348a7f83ef0ce28
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: step-up
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 11
   prerelease: false
   segments: 
   - 0
-  - 4
+  - 5
   - 0
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Marcelo Manzan
@@ -16,8 +16,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-23 00:00:00 -03:00
-default_executable: stepup
+date: 2011-04-28 00:00:00 -03:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: thor