step-up 0.6.0 → 0.7.0

data/GEM_VERSION

@@ -0,0 +1 @@
+v0.7.0

data/README.md

@@ -1,27 +1,21 @@
 # StepUp: a project to step up your projects
+
 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.
-
 ## Installation
 
     gem install step-up
 
 ## First of all
-Have in mind that StepUp has only Git support for now (more to come soon!!), so any StepUp command must be performed inside a git repository path.
-With that said, run
 
-    stepup init
-
-It will create a file in your project called **.stepuprc**.
-We'll cover more about this in the next sections.
+Your installed git-scm version must be v1.7.1 or higher.
 
 ## The Basics
-### Current project version
+
+### Checking current project version
 
     stepup [version]
 
@@ -29,12 +23,13 @@ An example of output would be
 
     v0.2.0+3
 
-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.
+Consider that your project has a tag named "v0.2.0".
+The "+3" part of the output above means the project has three commits since last version tag.
+The format of the version is totally customizable, and we will cover in more detail later.
 
 ### Stepping up a version
 
-    stepup version create [--level LEVEL_NAME]
+    stepup version create [--level LEVEL_NAME] [--no-editor]
 
 where **LEVEL_NAME**, by default, could be  
 
@@ -46,9 +41,9 @@ where **LEVEL_NAME**, by default, could be
 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:
+Considering default settings, this means:
 
-    v0.0.0.0 => vMAJOR.MINOR.PATCH.TINY
+    v0.0.0.9 => vMAJOR.MINOR.PATCH.TINY
 
 The versioning increment is based on the last version tag found in the repository, and works as follows:
 
@@ -57,20 +52,25 @@ The versioning increment is based on the last version tag found in the repositor
     v0.5.3.2 => v0.6.0   (MINOR increment)
     v0.5.3.2 => v1.0.0   (MAJOR increment)
 
+As you can see, the TINY level is omitted when its value is zero.
+The mask allows you to configure the less relevant levels this way.
+
 ### Checking out the changelog
 
-    stepup changelog
+    stepup changelog [--top=N]
 
 ## 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:
+*The great goal of this Gem is giving to developers an easy way to manage these notes*.
+
+The note is created with a command as the example below:
 
     $ stepup notes add --section bugfixes -m "support for old installations"
 
+It's possible to use the same command with no paramenters. This way an wizard will guide through the process.
 Still with this example we can check the created note with the following command:
 
     $ stepup notes
@@ -80,11 +80,33 @@ Still with this example we can check the created note with the following command
       - 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.
+Found notes are displayed as a changelog message.
 
 ### Creating rich changelogs
 
-***Comming soon***
+With a culture of notating all the relevant developments, its possible to retrieve a summary of a range of versions besides that specifying what kind of information will be retrieved.
+For example, imagine that you want to see all the features implemented in your application since the version v1.10.1 up to v2.0.0
+
+    stepup notes --since v1.10.1 upto v2.0.0 --sections pre_deploy pos_deploy
+    
+The result would be something like the following:
+
+    Showing notes since v1.10.1 up to v2.0.0 (including notes of tags: v1.10.1, v1.10.2, v1.51.0, v2.0.0)
+    ---
+    Pre-Deploy:
+
+      - dependency of version v10 of project XYZ
+      - it needed to rename the following file
+        - config/environment_variables.yml.sample -> config/environment_variables.yml
+      - rake articles:index
+
+    Pos-Deploy:
+
+      - Reindex articles
+        - rake articles:index
+      - rake db:seed
+      - rake categories:reload
+
 
 ## Project
 * https://github.com/kawamanza/step-up

data/lib/step-up.rb

@@ -4,6 +4,7 @@ module StepUp
   autoload :Driver, 'step-up/driver.rb'
   autoload :GitExtensions, 'step-up/git_extensions.rb'
   autoload :RangedNotes, 'step-up/ranged_notes.rb'
+  autoload :NotesUtil, 'step-up/notes_util.rb'
   module Parser
     autoload :VersionMask, 'step-up/parser/version_mask.rb'
   end

data/lib/step-up/cli.rb

@@ -179,17 +179,48 @@ module StepUp
 
 # Please enter the note message for your changes. Lines starting
 # with '#' will be ignored, and an empty message aborts the operation.
+#
+# We recommend that the note message has a short sentence, or try to
+# transform your message in a topic. Example:
+#
+#   New field for Account model
+#     Last access date
+#
+# The breakline and two-spaces indentation will be converted as follows:
+#
+#     - New field for Account model
+#       - Last access date
+#
+# Thus, the note becomes easier to read, instead of using big sentences.
+#
+# If you still need to describe the change in one big sentence, you may
+# use one-space indentation to indicates the sentence continues in the
+# next line. Example:
+#
+#   The Account model receives a new field named "last_access_date",
+#    and his value changes every sign-in made by user on website.
+#
+# The one-space indentation will be converted as follows:
+#
+#     - The Account model receives a new field named "last_access_date",
+#       and his value changes every sign-in made by user on website.
+#
+# You can make several combinations of one-space or two-spaces indentation
+# if you need. We hope this helps you to improve your release notes.
         TEXT
         message = edit_message(driver.class::NOTE_MESSAGE_FILE_PATH, message)
       end
       
       unless message.nil? || message.empty?
-        section = options[:section] || choose(CONFIG.notes_sections.names, "Choose a section to add the note:")
+        puts "Your note will be displayed as follows:"
+        puts NotesUtil.parse_message(message)
+        section = options[:section] || choose(CONFIG.notes_sections.names, "---\nChoose a section to add the note:")
         if section.nil? || ! CONFIG.notes_sections.names.include?(section)
           puts "Aborting due to invalid section"
+          puts "The note you was about to add is still available into file #{driver.class::NOTE_MESSAGE_FILE_PATH}"
           exit(1)
         end
-        steps = driver.steps_for_add_notes(section, message, commit_object)
+        steps = driver.steps_for_add_notes(section, message, last_commit.first)
         print_or_run(steps, options[:steps])
       end
     end
@@ -219,6 +250,10 @@ module StepUp
     end
 
     def version_create
+      unless check_notes_config
+        say_status(:fail, "Abort version increment. Could not retrieve the notes", :red)
+        exit 1
+      end
       level = options[:level] || "auto"
       message = get_notes(true, get_custom_message)
 
@@ -494,6 +529,10 @@ TEXT
     end
 
     def check_notes_config
+      if fail_banner = driver.cached_unsupported_scm_banner
+        puts fail_banner
+        exit 1
+      end
       return true if driver.cached_fetched_remotes.empty?
       remotes_with_notes = driver.fetched_remotes('notes')
       unfetched_remotes = driver.cached_fetched_remotes - remotes_with_notes

data/lib/step-up/driver.rb

@@ -26,6 +26,10 @@ module StepUp
           super
         end
       end
+
+      def unsupported_scm_banner
+        "Unsupported installed SCM version"
+      end
     end
   end
 end

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

@@ -6,6 +6,22 @@ module StepUp
       
       include GitExtensions::Notes
 
+      def unsupported_scm_banner
+        if `git --version`.chomp =~ /\d\.[^\s]+/
+          v = $&
+          if Gem::Version.correct?(v)
+            if Gem::Version.new("1.7.1") > Gem::Version.new(v)
+              "Unsupported installed GIT version: #{v}\n" +
+              "Please install version 1.7.1 or newer"
+            end
+          else
+            "Installed GIT version unknown: #{v}"
+          end
+        else
+          super
+        end
+      end
+
       def self.last_version
         new.last_version_tag
       end
@@ -90,7 +106,7 @@ module StepUp
               return tag
             end
           end
-          no_tag_version_in_commit_history = nil
+          count_commits == true ? zero_version(commit_base, true) : nil
         else
           zero_version(commit_base, count_commits)
         end
@@ -108,7 +124,7 @@ module StepUp
       end
 
       def zero_version(commit_base = "HEAD", count_commits = false)
-        "%s+%s" % [mask.blank, "#{ tags.empty? ? '0' : commit_history(commit_base).size if count_commits }"]
+        "%s+%s" % [mask.blank, "#{ commit_history(commit_base).size if count_commits }"]
       end
     end
   end

data/lib/step-up/notes_util.rb

@@ -0,0 +1,12 @@
+module StepUp
+  module NotesUtil
+    def parse_message(message)
+      message = message.rstrip.gsub(/^((?:  )*)( )?([^ \-\n])/){ "%s  %s %s" % [$1, $2 || '-', $3] }
+      begin
+        changed = message.sub!(/^(\s*-\s.*?\n)(?:\s*\n)+(\s*-\s)/, '\1\2')
+      end until changed.nil?
+      message
+    end
+    extend self
+  end
+end

data/lib/step-up/ranged_notes.rb

@@ -183,11 +183,7 @@ module StepUp
     private
 
     def parse_message(message)
-      message = message.rstrip.gsub(/^(\s\s)?([^\s\-])/, '\1  - \2')
-      begin
-        changed = message.sub!(/^(\s*-\s.*?\n)\n+(\s*-\s)/, '\1\2')
-      end until changed.nil?
-      message
+      NotesUtil.parse_message(message)
     end
   end
 

data/lib/step-up/version.rb

@@ -1,6 +1,10 @@
 module StepUp
   version = nil
-  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_file = ::File.expand_path('../../../GEM_VERSION', __FILE__)
+  version = File.read(version_file) if ::File.exists?(version_file)
+  if version.nil? && ::File.exists?(::File.expand_path('../../../.git', __FILE__))
+    version = Driver::Git.new.last_version_tag("HEAD", true) rescue "v0.0.0+0"
+    ::File.open(version_file, "w"){ |f| f.write version }
+  end
   VERSION = version.gsub(/^v?([^\+]+)\+?\d*$/, '\1')
 end

data/templates/default/Gemfile

@@ -1 +1 @@
-gem 'step-up', "~> {{stepup_version}}", :group => [:preparing]
+gem 'step-up', "~> {{stepup_version}}", :group => [:source]

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: step-up
 version: !ruby/object:Gem::Version 
-  hash: 7
-  prerelease: false
+  hash: 3
+  prerelease: 
   segments: 
   - 0
-  - 6
+  - 7
   - 0
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors: 
 - Marcelo Manzan
@@ -16,8 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-20 00:00:00 -03:00
-default_executable: 
+date: 2011-10-19 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: thor
@@ -85,6 +84,7 @@ files:
 - lib/step-up/driver.rb
 - lib/step-up/driver/git.rb
 - lib/step-up/git_extensions.rb
+- lib/step-up/notes_util.rb
 - lib/step-up/parser/version_mask.rb
 - lib/step-up/ranged_notes.rb
 - lib/step-up/version.rb
@@ -92,12 +92,12 @@ files:
 - templates/default/Gemfile
 - templates/default/Rakefile
 - templates/default/lib/version.rb
+- GEM_VERSION
 - spec/lib/config_spec.rb
 - spec/lib/step-up/driver/git_spec.rb
 - spec/lib/step-up/parser/version_mask_spec.rb
 - spec/lib/step-up/ranged_notes_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: https://github.com/kawamanza/step-up
 licenses: []
 
@@ -129,7 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: step-up
-rubygems_version: 1.3.7
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: The best way to manage your project's versioning