rake_commit 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ea1f63f9545e05c6ac0a8ea9da6c7bc97748667
-  data.tar.gz: 7850c7d442419a515964e4e47cbcff9f64d85cbc
+  metadata.gz: dab391ea20c75c033c4428c8cc93c3a46925831b
+  data.tar.gz: d33a3fa4b68229d9382b9a0660e0a9707eedc369
 SHA512:
-  metadata.gz: c5241e7795d91d35c00ed80c63bc78e96682c4be76fc7944d00f641e4da72a1af2ffe1147b23b2f1713fe8e64239e12d0c641906ca6527ecebc4eb1d08521cef
-  data.tar.gz: 910b3d3d580b38e8f13f4287d1dac46ff04e1b91f97521ebd41c0200cdebb9d26fb9f4261324f1bc42df26c15e6fccfb6f055ea3fcc1ba50ba0279df96855de8
+  metadata.gz: 6cb506b14ed438f93e4a9fe3968555006be3f7bf5768e6a64f276c4d6cda0559cd37fde3cbac3933b6ddd2357a46c799b917eb7e3ae27a43dd57f644c505a99f
+  data.tar.gz: cfa603c49218a9c05cc4e87f711df28c9404465bb3461709d6d23588e2d421343857f7a8b4d356b130250f0f82b2a1bc55b3e26a126ce5271adf3163b4fcd7bd

data/lib/rake_commit/commit.rb

@@ -19,7 +19,9 @@ module RakeCommit
         :collapse_commits => true,
         :incremental => false,
         :prompt_exclusions => [],
-        :build_command => "rake"
+        :build_command => "rake",
+        :commit_message_wrap => nil, # integer or nil
+        :commit_message_type => CommitMessage::MessageType::MESSAGE
       }
 
       if File.exists?(".rake_commit")
@@ -31,7 +33,7 @@ module RakeCommit
       if git_svn?
         RakeCommit::GitSvn.new(options[:prompt_exclusions]).commit
       elsif git?
-        RakeCommit::Git.new(options[:build_command], options[:collapse_commits], options[:rebase_only], options[:incremental], options[:prompt_exclusions], options[:precommit]).commit
+        RakeCommit::Git.new(options[:build_command], options[:collapse_commits], options[:rebase_only], options[:incremental], options[:prompt_exclusions], options[:precommit], options[:commit_message_wrap], options[:commit_message_type]).commit
       else
         RakeCommit::Svn.new(options[:prompt_exclusions]).commit
       end
@@ -63,6 +65,12 @@ module RakeCommit
         opts.on("-b", "--build-command SCRIPT", "the command that verifies the commit, defaults to rake") do |command|
           options[:build_command] = command
         end
+        opts.on("--word-wrap [80]", "word wrap the commit message (default no wrap)") do |commit_message_wrap|
+          options[:commit_message_wrap] = commit_message_wrap.to_i
+        end
+        opts.on("-m", "--message-type [MESSAGE|WHATWHY]", "the type of commit message to prompt for (only works on Git)") do |commit_message_type|
+          options[:commit_message_type] = commit_message_type.downcase
+        end
       end
 
       parser.parse(args)

data/lib/rake_commit/commit_message.rb

@@ -1,16 +1,60 @@
+require 'word_wrap'
+
 module RakeCommit
   class CommitMessage
+    module MessageType
+      MESSAGE = "message"
+      WHAT_AND_WHY = "whatwhy"
+    end
+
+    SUBJECT_MAX_LENGTH = 50
 
     attr_reader :author, :feature, :message
 
-    def initialize(prompt_exclusions = [])
+    def initialize(prompt_exclusions = [], type = MessageType::MESSAGE)
       @author = RakeCommit::PromptLine.new("author", prompt_exclusions).prompt
       @feature = RakeCommit::PromptLine.new("feature", prompt_exclusions).prompt
-      @message = RakeCommit::PromptLine.new("message", prompt_exclusions).prompt
+      @message = case type
+        when MessageType::MESSAGE
+          RakeCommit::PromptLine.new("message", prompt_exclusions).prompt
+        when MessageType::WHAT_AND_WHY
+          what = RakeCommit::PromptLine.new("what", prompt_exclusions).prompt
+          why = RakeCommit::PromptLine.new("why", prompt_exclusions).prompt
+
+          subject_space_remaining = SUBJECT_MAX_LENGTH - @feature.length
+          truncated_what = what[0...subject_space_remaining]
+          subject = RakeCommit::PromptLine.new("subject", prompt_exclusions, truncated_what).prompt
+
+          create_message_with_subject_what_and_why(subject, what, why)
+        end
+    end
+
+    def joined_message(wrap = nil)
+      message = [@feature, @message].compact.join(' - ')
+      message = WordWrap.ww(message, wrap) if wrap
+      message
+    end
+
+    def joined_message_with_author(wrap = nil)
+      message = [@author, @feature, @message].compact.join(' - ')
+      message = WordWrap.ww(message, wrap) if wrap
+      message
     end
 
-    def joined_message
-      [@author, @feature, @message].compact.join(' - ')
+    private
+
+    def create_message_with_subject_what_and_why(subject, what, why)
+      <<-EOS
+#{subject}
+
+What
+===
+#{what}
+
+Why
+===
+#{why}
+EOS
     end
   end
 end

data/lib/rake_commit/git.rb

@@ -3,13 +3,15 @@ require 'shellwords'
 module RakeCommit
   class Git
 
-    def initialize(build_command, collapse_commits = true, rebase_only = false, incremental = false, prompt_exclusions = [], precommit = nil)
+    def initialize(build_command, collapse_commits = true, rebase_only = false, incremental = false, prompt_exclusions = [], precommit = nil, commit_message_wrap = nil, commit_message_type = MessageType::MESSAGE)
       @build_command = build_command
       @collapse_commits = collapse_commits
       @rebase_only = rebase_only
       @incremental = incremental
       @prompt_exclusions = prompt_exclusions
       @precommit = precommit
+      @commit_message_wrap = commit_message_wrap
+      @commit_message_type = commit_message_type
     end
 
     def commit
@@ -23,8 +25,10 @@ module RakeCommit
         if collapse_git_commits?
           return unless collapse_git_commits
         elsif rebase_only?
-          add
-          incremental_commit unless nothing_to_commit?
+          unless nothing_to_commit?
+            puts "You have uncommitted changes. Please amend, stash, or clean and retry."
+            exit 1
+          end
           pull_rebase rescue return false
         end
         RakeCommit::Shell.system(@build_command)
@@ -73,11 +77,11 @@ module RakeCommit
     end
 
     def incremental_commit
-      commit_message = RakeCommit::CommitMessage.new(@prompt_exclusions)
+      commit_message = RakeCommit::CommitMessage.new(@prompt_exclusions, @commit_message_type)
       unless commit_message.author.nil?
         RakeCommit::Shell.system("git config user.name #{Shellwords.shellescape(commit_message.author)}")
       end
-      message = [commit_message.feature, commit_message.message].compact.join(" - ")
+      message = commit_message.joined_message(@commit_message_wrap)
       RakeCommit::Shell.system("git commit -m #{Shellwords.shellescape(message)}")
     end
 

data/lib/rake_commit/git_svn.rb

@@ -17,7 +17,7 @@ module RakeCommit
     end
 
     def git_svn_commit_with_message
-      message = RakeCommit::CommitMessage.new(@prompt_exclusions).joined_message
+      message = RakeCommit::CommitMessage.new(@prompt_exclusions).joined_message_with_author
       RakeCommit::Shell.system "git commit -m #{message.inspect}"
     end
 

data/lib/rake_commit/prompt_line.rb

@@ -5,21 +5,29 @@ module RakeCommit
   class PromptLine
     include Readline
 
-    def initialize(attribute, prompt_exclusions = [])
+    def initialize(attribute, prompt_exclusions = [], default_value = nil)
       @attribute = attribute
       @prompt_exclusions = prompt_exclusions
+      @default_value = default_value
     end
 
     def prompt
       return nil if @prompt_exclusions.include?(@attribute)
+
+      puts "\n"
+      puts "previous #{@attribute}: #{previous_input}" if previous_input
+
+      set_readline_default_input(@default_value) if @default_value
+      set_readline_history
+
       input = nil
       loop do
-        input = readline(message).chomp
+        input = readline("#{@attribute}: ").chomp
         break unless (input.empty? && !previous_input)
       end
 
       unless input.empty?
-        save_history(input)
+        append_history(input)
         return input
       end
 
@@ -27,18 +35,20 @@ module RakeCommit
       return previous_input
     end
 
-    def message
-      previous_message = "\n"
-      previous_message += "previous #{@attribute}: #{previous_input}\n" if previous_input
-      puts previous_message
-      "#{@attribute}: "
-    end
+    private
 
-    def save_history(input)
+    def append_history(input)
       File.open(history_file, "a") { |f| f.puts(input) }
     end
 
-    private
+    def set_readline_default_input(default_input)
+      Readline.pre_input_hook = lambda do
+        Readline.insert_text(default_input)
+        Readline.redisplay
+        Readline.pre_input_hook = nil
+      end
+    end
+
     def previous_input
       @previous_input ||= history.last
     end
@@ -47,13 +57,12 @@ module RakeCommit
       @history ||= load_history
     end
 
-    def load_history
+    def set_readline_history
       HISTORY.pop until HISTORY.empty?
-      HISTORY.push(*saved_history)
-      HISTORY.to_a
+      HISTORY.push(*history)
     end
 
-    def saved_history
+    def load_history
       File.exists?(history_file) ? File.read(history_file).split("\n") : []
     end
 

data/lib/rake_commit/svn.rb

@@ -10,7 +10,7 @@ module RakeCommit
 
     def commit
       if files_to_check_in?
-        message = RakeCommit::CommitMessage.new(@prompt_exclusions).joined_message
+        message = RakeCommit::CommitMessage.new(@prompt_exclusions).joined_message_with_author
         RakeCommit::Shell.system(@precommit) unless @precommit.nil?
         add
         delete

metadata

@@ -1,15 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: rake_commit
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Paul Gross
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-18 00:00:00.000000000 Z
-dependencies: []
+date: 2016-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '11'
+- !ruby/object:Gem::Dependency
+  name: word_wrap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.5
 description: See http://github.com/pgr0ss/rake_commit
 email: pgross@gmail.com
 executables:
@@ -39,17 +107,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: rake_commit
-rubygems_version: 2.4.6
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: A gem which helps with checking in code