git-commit 0.1.0.pre → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c962bdc20906869649fc58eb1e34b344985ad7bd
-  data.tar.gz: 822bc9a2f343a037e03ae2fead49937a3d096add
+  metadata.gz: e849002bae64f9743ce916140e26d398a0070969
+  data.tar.gz: 9f27d45a96c913ad1ed92f979c7634caff5d8740
 SHA512:
-  metadata.gz: e3889e842b9b099549e33eae3dc17bf972b097ddcbaf3cca7ab7eff954eb6db43c21711ceae08d55231cb4597af6ed22d1df7db968d0e03caea20472f0a7f393
-  data.tar.gz: fdb6362da6a5b1daf270a65320beadff9f6e4ebfac3babb6ba4d45e4e0c5a6fc448b70811903f325aeb1043a58f9cb2968e9cd254bd99234a19f9889b7ed9e6c
+  metadata.gz: 7a3f8c75c3d99b452cb81baa5613b19ed59ea47bf1a262f1becf3e2ddc3ca535766e64f6d7a89c2adaf4dc9a2a99f2bcd48fb52eaf89aab3b3c923522e5d3302
+  data.tar.gz: b40a8fd6328c02b3fcd40499a0bd1cd42e566333eed76fcb0dceda55bf6e4299c8d75f8a94b1ab8beb037eef9e4368ce09467111e908f3f61e5ee0909aa577dc

data/README.md

@@ -20,7 +20,15 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```
+git.commit help
+Commands:
+  git.commit help [COMMAND]      # Describe available commands or one specific command
+  git.commit validate [COMMAND]  # Validate Commit message or commit file content
+  git.commit validate angularjs <git commit message or file path>  # validate commit message or file content by angularjs commit conventions
+```
+
+I use this for enfoce angularJS git commit convention in commit-msg hook 
 
 ## Development
 

data/exe/git.commit

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+lib_folder = File.join(File.dirname(__FILE__), '..', 'lib')
+$LOAD_PATH.unshift(lib_folder) if Dir.exists?(lib_folder)
+
+require 'git/commit'
+Git::Commit::CLI.start(ARGV)

data/git-commit.gemspec

@@ -22,4 +22,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"
 
+  spec.add_dependency "thor"
+
 end

data/lib/git/commit.rb

@@ -1,7 +1,8 @@
-require "git/commit/version"
+Git = Module.new unless defined?(Git)
+module Git::Commit
 
-module Git
-  module Commit
-    # Your code goes here...
-  end
-end
+  require 'git/commit/version'
+  require 'git/commit/format'
+  require 'git/commit/cli'
+
+end

data/lib/git/commit/cli.rb

@@ -0,0 +1,14 @@
+require 'thor'
+class Git::Commit::CLI < Thor
+
+  require 'git/commit/cli/command'
+
+  ObjectSpace.each_object(Class).select { |klass| klass < Git::Commit::CLI::Command }.each do |command|
+
+    subcommand_name = command.to_s.split('::').last.downcase
+    desc("#{subcommand_name} [COMMAND]",command.get_class_description)
+    subcommand(subcommand_name, command)
+
+  end
+
+end

data/lib/git/commit/cli/command.rb

@@ -0,0 +1,19 @@
+class Git::Commit::CLI::Command < Thor
+
+  class << self
+
+    def get_class_description
+      @class_description
+    end
+
+    protected
+
+    def class_description(description)
+      @class_description = description
+    end
+
+  end
+
+  require 'git/commit/cli/command/validate'
+
+end

data/lib/git/commit/cli/command/validate.rb

@@ -0,0 +1,21 @@
+class Git::Commit::CLI::Command::Validate < Git::Commit::CLI::Command
+
+  class_description 'Validate Commit message or commit file content'
+
+  desc 'angularjs <git commit message or file path>',
+       'validate commit message or file content by angularjs commit conventions'
+
+  def angularjs_format(commit_message)
+
+    commit_message = File.read(commit_message) if File.exists?(commit_message)
+
+    begin
+      Git::Commit::Format::AngularJS::Validator.new(commit_message).validate
+    rescue Git::Commit::Format::Error => ex
+      $stderr.puts(ex.message,"\n",commit_message)
+      exit(1)
+    end
+
+  end
+
+end

data/lib/git/commit/format.rb

@@ -0,0 +1,5 @@
+module Git::Commit::Format
+  require 'git/commit/format/error'
+
+  require 'git/commit/format/angular_js'
+end

data/lib/git/commit/format/angular_js.rb

@@ -0,0 +1,23 @@
+module Git::Commit::Format::AngularJS
+
+  TYPES = {
+      feat: 'A new feature',
+      fix: 'A bug fix',
+      docs: 'Documentation only changes',
+      style: 'Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)',
+      refactor: 'A code change that neither fixes a bug nor adds a feature',
+      perf: 'A code change that improves performance',
+      test: 'Adding missing tests',
+      chore: 'Changes to the build process or auxiliary tools and libraries such as documentation generation'
+  }
+
+  SCOPE = 'The scope could be anything specifying place of the commit change.'
+
+  require 'git/commit/format/angular_js/builder'
+  require 'git/commit/format/angular_js/validator'
+
+  def self.type_help_text
+    TYPES.map{|k,v| "\t#{k}:\t#{v}" }.join("\n")
+  end
+
+end

data/lib/git/commit/format/angular_js/builder.rb

@@ -0,0 +1,11 @@
+class Git::Commit::Format::AngularJS::Builder
+
+
+
+  protected
+
+  def initialize
+
+  end
+
+end

data/lib/git/commit/format/angular_js/validator.rb

@@ -0,0 +1,112 @@
+# Accepted AngularJS commit format
+#
+# <type>(<scope>): <subject>
+# <BLANK LINE>
+# <body>
+# <BLANK LINE>
+# <footer>
+class Git::Commit::Format::AngularJS::Validator
+
+  def validate
+    validate_mandatory_type
+    validate_mandatory_subject
+    validate_optional_scope
+    validate_optional_body
+  end
+
+  def validate_mandatory_type
+
+    types = fetch_by(/^(\w+)/)[0]
+
+    if types.empty?
+      raise_format_error('missing type from the commit!')
+    end
+
+    type_sym = types.first.to_sym
+    unless Git::Commit::Format::AngularJS::TYPES.keys.include?(type_sym)
+      raise_format_error(
+          "invalid type given in the commit: #{type_sym}",
+          "use the following types: \n#{Git::Commit::Format::AngularJS.type_help_text}"
+      )
+    end
+
+  end
+
+  def validate_mandatory_subject
+
+    subjects = @commit_message.to_s.split("\n")[0].scan(/^[^:]+:\s+(.*?)$/)[0]
+
+    if subjects.nil? or [*subjects].select{|str| not str.to_s.empty? }.empty?
+      raise_format_error('missing subject from the commit!')
+    end
+
+    subject = subjects[0]
+    if subject =~ /\b(changed|changes)\b/i
+      raise_format_error('use the imperative, present tense: "change" not "changed" nor "changes"')
+    end
+
+    if subject =~ /^[A-Z]\w*/
+      raise_format_error("Don't capitalize first letter")
+    end
+
+    if subject =~ /\.\s*$/
+      raise_format_error('No dot (.) at the end')
+    end
+
+  end
+
+  def validate_optional_scope
+
+    scope_begins = fetch_by(/^\w+(\()/)
+
+    if not scope_begins.empty? and not scope_begins[0].empty? and scope_content.nil?
+      raise_format_error('scope is malformed!')
+    end
+
+    first_line_scope_strs = scope_content
+
+    return if first_line_scope_strs.nil?
+
+    scope_str = first_line_scope_strs[0]
+    if not scope_str.nil? and scope_str.to_s.length == 0
+      raise_format_error('scope is too short!')
+    end
+
+  end
+
+
+  def validate_optional_body
+
+    body_content_lines = fetch_by(/^.*$/)[1..-1].select { |str| !(str =~ /^\s*$/) }
+    given_a_blank_line = @commit_message.split("\n")[1].to_s.empty?
+
+    if not given_a_blank_line and not body_content_lines.empty?
+      raise_format_error('body must be placed after a blank line!')
+    end
+
+  end
+
+  def validate_optional_footer
+  end
+
+  protected
+
+  def initialize(commit_message)
+    @commit_message = commit_message.to_s.dup.strip
+  end
+
+  def fetch_by(regular_expression)
+    @commit_message.scan(regular_expression)
+  end
+
+  def raise_format_error(*messages)
+    raise(Git::Commit::Format::Error, messages.join("\n"))
+  end
+
+  private
+
+  def scope_content
+    fetch_by(/^\w+\(([^\)]*)\)/)[0]
+  end
+
+end

data/lib/git/commit/format/error.rb

@@ -0,0 +1,2 @@
+class Git::Commit::Format::Error < StandardError
+end

data/lib/git/commit/version.rb

@@ -1,5 +1,2 @@
-module Git
-  module Commit
-    VERSION = "0.1.0.pre"
-  end
-end
+require 'git/commit'
+Git::Commit::VERSION = "0.1.0"

data/spike/gistfile1.txt

@@ -0,0 +1,56 @@
+#!/usr/bin/env ruby -w
+## Using ruby's standard OptionParser to get subcommand's in command line arguments
+## Note you cannot do: opt.rb help command
+## other options are commander, main, GLI, trollop...
+
+# run it as
+# ruby opt.rb --help
+# ruby opt.rb foo --help
+# ruby opt.rb foo -q
+# etc
+
+require 'optparse'
+
+options = {}
+
+subtext = <<HELP
+Commonly used command are:
+   foo :     does something awesome
+   baz :     does something fantastic
+
+See 'opt.rb COMMAND --help' for more information on a specific command.
+HELP
+
+global = OptionParser.new do |opts|
+  opts.banner = "Usage: opt.rb [options] [subcommand [options]]"
+  opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
+    options[:verbose] = v
+  end
+  opts.separator ""
+  opts.separator subtext
+end
+#end.parse!
+
+subcommands = { 
+  'foo' => OptionParser.new do |opts|
+      opts.banner = "Usage: foo [options]"
+      opts.on("-f", "--[no-]force", "force verbosely") do |v|
+        options[:force] = v
+      end
+   end,
+   'baz' => OptionParser.new do |opts|
+      opts.banner = "Usage: baz [options]"
+      opts.on("-q", "--[no-]quiet", "quietly run ") do |v|
+        options[:quiet] = v
+      end
+   end
+ }
+
+ global.order!
+ command = ARGV.shift
+ subcommands[command].order!
+
+ puts "Command: #{command} "
+ p options
+ puts "ARGV:"
+ p ARGV

data/spike/git_hook.txt

@@ -0,0 +1 @@
+.git/hooks/commit-msg

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git-commit
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre
+  version: 0.1.0
 platform: ruby
 authors:
 - Adam Luzsi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-26 00:00:00.000000000 Z
+date: 2015-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,10 +52,25 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Git Commit helper.
 email:
 - adamluzsi@gmail.com
-executables: []
+executables:
+- git.commit
 extensions: []
 extra_rdoc_files: []
 files:
@@ -69,9 +84,20 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- exe/git.commit
 - git-commit.gemspec
 - lib/git/commit.rb
+- lib/git/commit/cli.rb
+- lib/git/commit/cli/command.rb
+- lib/git/commit/cli/command/validate.rb
+- lib/git/commit/format.rb
+- lib/git/commit/format/angular_js.rb
+- lib/git/commit/format/angular_js/builder.rb
+- lib/git/commit/format/angular_js/validator.rb
+- lib/git/commit/format/error.rb
 - lib/git/commit/version.rb
+- spike/gistfile1.txt
+- spike/git_hook.txt
 homepage: https://github.com/adamluzsi/git-commit
 licenses: []
 metadata: {}
@@ -86,9 +112,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.2