gitlog 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 212e5916fc447695e650d6d3ff2c4944bb505231
+  data.tar.gz: 2427bfd25ee7c189428aacd9da3b5799d6ffb039
+SHA512:
+  metadata.gz: 21d58e41d6f55bd1e71605d7bfe67cdef6a039ae5282bbf57991f02d8a7dd051936690cbfe09b9ddd3d72c9efff18be2c64f01d899072f324c154487fab67b12
+  data.tar.gz: bffdd70c56f92b4083edd7d1f403653d9055fd2138223fe5e07bd9dada2eacdcc76099379edcc82ee33f1639f8eee0c297f1d23393839c351a5f3a1548aba6ce

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at soni@nickelfox.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1 @@
+source "https://rubygems.org"

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    gitlog (0.1.0)
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    thor (0.20.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  gitlog!
+  rake (~> 10.0)
+  rspec (~> 3.2)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Ravindra Soni
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# GitLog
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/gitlog`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gitlog'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gitlog
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/gitlog. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Gitlogs project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/gitlog/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "gitlog"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/gitlog

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'gitlog/cli'
+
+GitLog::CLI.start

data/gitlog.gemspec

@@ -0,0 +1,35 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "gitlog/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "gitlog"
+  spec.version       = GitLog::VERSION
+  spec.authors       = ["Ravindra Soni"]
+  spec.email         = ["soni@nickelfox.com"]
+
+  spec.summary       = %q{Generate formatted logs from git commits.}
+  spec.description   = %q{Generate formatted logs from git commits.}
+  spec.homepage      = "http://github.com/ravindrasoni/gitlog"
+  spec.license       = "MIT"
+
+  # spec.metadata["allowed_push_host"] = "http://nickelfox.com"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "http://github.com/ravindrasoni/gitlog"
+  spec.metadata["changelog_uri"] = "http://github.com/ravindrasoni/gitlog"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_dependency "thor"
+end

data/lib/gitlog/cli.rb

@@ -0,0 +1,56 @@
+require 'thor'
+require 'gitlog'
+
+module GitLog
+  class CLI < Thor
+	desc "my", "Generate my commit logs. Ex. gitlog my --date 2019-06-07 --scope-wise --current-branch"
+	method_option :date, aliases: "-d", :desc => "provide date in yyyy-MM-dd format"
+	method_option :scopewise, aliases: "-s", :type => :boolean, :desc => "if you want log to be grouped scope wise"
+	method_option :typewise, aliases: "-t", :type => :boolean, :desc => "if you want log to be grouped type wise"
+	method_option :current_branch, aliases: "-c", :type => :boolean, :desc => "if you want logs from current branch only"
+	def my
+		grouping = :type_wise
+	    if options[:scopewise]
+	    	grouping = :scope_wise
+	    end
+	    puts GitLog::Log.generate_log(options[:date], grouping, nil, options[:current_branch])
+	end
+
+	desc "all", "Generate all commit logs. Ex. gitlog all --date 2019-06-07 --scope-wise --current-branch"
+	method_option :date, aliases: "-d", :desc => "provide date in yyyy-MM-dd format"
+	method_option :author, aliases: "-a", :desc => "email id of the author whose logs you want"
+	method_option :scopewise, aliases: "-s", :type => :boolean, :desc => "if you want log to be grouped scope wise"
+	method_option :typewise, aliases: "-t", :type => :boolean, :desc => "if you want log to be grouped type wise"
+	method_option :current_branch, aliases: "-c", :type => :boolean, :desc => "if you want logs from current branch only"
+	def all
+		grouping = :type_wise
+	    if options[:scopewise]
+	    	grouping = :scope_wise
+	    end
+	    puts GitLog::Log.generate_log(options[:date], grouping, options[:author], options[:current_branch])
+	end
+
+	desc "range", "Generate all logs between 2 commits. It prompts for the commit hashes. Ex. gitlog range --from 2958885 --to 2f96f24 --author a@b.co --scope-wise"
+	method_option :from, :type => :string, :desc => "From Commit"
+	method_option :to, :type => :string, :desc => "To Commit"
+	method_option :author, aliases: "-a", :desc => "email id of the author whose logs you want"
+	method_option :scopewise, aliases: "-s", :type => :boolean, :desc => "if you want log to be grouped scope wise"
+	method_option :typewise, aliases: "-t", :type => :boolean, :desc => "if you want log to be grouped type wise"
+	def range
+		from = options[:from]
+		if from.nil?
+	      from = ask('From Commit:')
+	    end
+	    to = options[:to]
+	    if to.nil?
+	      to = ask('To Commit:')
+	    end
+
+	    grouping = :type_wise
+	    if options[:scopewise]
+	    	grouping = :scope_wise
+	    end
+		puts GitLog::Log.log_between_commits(to, from, grouping, options[:author])
+	end
+  end
+end

data/lib/gitlog/log.rb

@@ -0,0 +1,242 @@
+require 'date'
+
+def git_format_selectors()
+  git_format_selectors = {
+    'message' => '%s',
+  }
+  return git_format_selectors
+end
+
+def type_keywords()
+  type_keywords = {
+    'feat' => {
+      name: 'New Features',
+    },
+    'fix' => {
+      name: 'Bug Fixes',
+    },
+    'perf' => {
+      name: 'Performance Enhancements',
+    },
+    'refactor' => {
+      name: 'Refactorings',
+      dev: true,
+    },
+    'docs' => {
+      name: 'Documentation Changes',
+      dev: true,
+    },
+    'test' => {
+      name: 'Test Changes',
+      dev: true,
+    },
+    'style' => {
+      name: 'Style Changes',
+      dev: true,
+    },
+    'chore' => {
+      name: 'Configuration Updates',
+      dev: true,
+    },
+    $other_type => {
+      name: 'Other Changes',
+      dev: true,
+    }
+  }
+  return type_keywords
+end 
+
+$other_type = 'other'
+$type_keywords = type_keywords()
+$type_keywords_index_helper = $type_keywords.map { |key, value| key }
+$git_format_info = git_format_selectors().map { |key, value| key }
+
+
+
+def git_log_on_date(specific_date = nil, author = nil, current_branch_only = false)
+  command = Array["git log"]
+  command << "--pretty=\"%s\""
+  command << "--all" if !current_branch_only
+  command << "--author=\"#{author.chomp}\"" if author
+  command << "--after=\"#{specific_date.chomp} 00:00\" --before=\"#{specific_date.chomp} 23:59\"" if specific_date
+  command << "--no-merges"
+  # puts command.compact.join(' ')
+  return `#{command.compact.join(' ')}`
+  rescue
+  nil
+end
+
+def git_log_between_commits(from, to, author = nil)
+  command = Array['git log --branches']
+  command << "--pretty=\"%s\""
+  command << "--author=\"#{author.chomp}\"" if author
+  # command << '--ancestry-path'
+  command << "#{from.chomp} ^#{to.chomp}^"
+  command << "--no-merges"
+  puts command.compact.join(' ')
+  return `#{command.compact.join(' ')}`
+  rescue
+  nil
+end
+
+
+def git_formatted_log(logs, log_style, dev = true)
+
+  # print_log('Raw Logs', logs)
+
+  return "No Changelogs \n" unless logs && !logs.empty?
+
+  categorized_line_info = {}
+  logs.each_line { |line|
+    line_info = {}
+    line = line.strip.split("\t")
+    $git_format_info.each_with_index { |value, index|
+      line_info[value] = line[index]
+    }
+
+    message_format_regex = /([^\(:]+)(?:\(([^\)]*)\))?[[:space:]]*:?[[:space:]]*(.*)/
+    match_data = line_info['message'].match(message_format_regex)
+    if match_data
+      if match_data[3].empty?
+        $type_keywords.each { |key, value|
+          if line_info['message'].downcase.include? key
+            line_info['type'] = key
+            break
+          end
+        }
+      else
+        line_info['type'] = match_data[1]
+        line_info['scope'] = match_data[2]
+        line_info['message'] = match_data[3]
+      end
+    end
+
+    line_info['type'] = (line_info['type'] || '').downcase
+
+    unless $type_keywords[line_info['type']]
+      line_info['type'] = $other_type
+    end
+
+    line_info['message'] = (line_info['message'][0, 1].upcase + line_info['message'][1..-1]).chomp(".")
+
+    style = 'type'
+    case log_style
+     when :type_wise
+       style = 'type'
+     when :scope_wise
+       style = 'scope'
+    end
+
+    categorized_line_info[line_info[style]] ||= []
+    categorized_line_info[line_info[style]] << line_info
+  }
+
+    case log_style
+     when :type_wise
+      return git_formatted_log_type(categorized_line_info)
+     when :scope_wise
+      return git_formatted_log_scope(categorized_line_info)
+    end
+end
+
+def git_formatted_log_type_markdown(categorized_line_info, dev = true)
+  categorized_line_info = categorized_line_info.sort_by { |key, value| $type_keywords_index_helper.index(key) || $type_keywords_index_helper.index($other_type) }
+
+  # print_log('categorized_line_info', categorized_line_info)
+
+  changelog_lines = []
+  categorized_line_info.each { |key, value|
+    next if $type_keywords[key][:dev] && !dev
+    changelog_lines << "#### #{$type_keywords[key][:name]}"
+    changelog_lines << ''
+    value.each { |line_info|
+      scope_string = (dev && line_info['scope']) ? " #{line_info['scope']}" : ''
+      dev_string = dev ?  (scope_string.empty? ? '' : "**-#{scope_string}:** ") : ''
+      changelog_lines << "#{dev_string}#{line_info['message']}"
+      changelog_lines << ''
+    }
+    changelog_lines << ''
+  }
+  return changelog_lines.join("\n")
+end
+
+def git_formatted_log_type(categorized_line_info, dev = true)
+  categorized_line_info = categorized_line_info.sort_by { |key, value| $type_keywords_index_helper.index(key) || $type_keywords_index_helper.index($other_type) }
+
+  # print_log('categorized_line_info', categorized_line_info)
+
+  changelog_lines = []
+  categorized_line_info.each { |key, value|
+    next if $type_keywords[key][:dev] && !dev
+    changelog_lines << "#{$type_keywords[key][:name]}"
+    value.each { |line_info|
+      scope_string = (dev && line_info['scope']) ? " #{line_info['scope']}" : ''
+      dev_string = dev ?  (scope_string.empty? ? '' : "-#{scope_string}: ") : ''
+      changelog_lines << "#{dev_string}#{line_info['message']}"
+    }
+    changelog_lines << ''
+  }
+  return changelog_lines.join("\n")
+end
+
+def git_formatted_log_scope(categorized_line_info, dev = true)
+    categorized_line_info = categorized_line_info.sort_by { |key, value| $type_keywords_index_helper.index(key)}
+
+    # print_log('categorized_line_info', categorized_line_info)
+
+    changelog_lines = []
+    categorized_line_info.each { |key, value|   
+      changelog_lines << key
+      value.each { |line_info|
+        changelog_lines << "- #{$type_keywords[line_info['type']][:name]}: #{line_info['message']}"
+      }
+      changelog_lines << ''
+    }
+    return changelog_lines.join("\n")
+end
+
+def print_log(key, value)
+  print "\n\n #{key}: \n"
+  print value
+  print "\n\n"
+end
+
+def author()
+  author = `git config user.email`
+  return author
+end
+
+
+module GitLog
+  class Log
+
+  	def self.generate_log(specific_date = nil, log_style = nil, author = nil, current_branch_only = false)
+      if specific_date.nil?
+        specific_date =  "#{DateTime.now.strftime("%Y-%m-%d")}"
+      end
+      if log_style.nil?
+        log_style = :type_wise
+      end
+      if author.nil?
+        author = author()
+      end
+      print_log("log_style", log_style)
+  	  git_logs = git_log_on_date(specific_date, author, current_branch_only)
+  	  logs = git_formatted_log(git_logs,log_style)
+  	  puts logs
+  	end
+
+  	def self.log_between_commits(from, to, log_style = nil, author = nil)
+      if log_style.nil?
+        log_style = :type_wise
+      end
+      if author.nil?
+        author = author()
+      end
+
+  	  git_logs = git_log_between_commits(from, to, author)
+  	  logs = git_formatted_log(git_logs,log_style)
+  	  puts logs
+  	end
+  end
+end

data/lib/gitlog/version.rb

@@ -0,0 +1,3 @@
+module GitLog
+  VERSION = "0.1.0"
+end

data/lib/gitlog.rb

@@ -0,0 +1,7 @@
+require "gitlog/log"
+require "gitlog/version"
+
+module GitLog
+  class Error < StandardError; end
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: gitlog
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ravindra Soni
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-08-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !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: Generate formatted logs from git commits.
+email:
+- soni@nickelfox.com
+executables:
+- gitlog
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/gitlog
+- gitlog.gemspec
+- lib/gitlog.rb
+- lib/gitlog/cli.rb
+- lib/gitlog/log.rb
+- lib/gitlog/version.rb
+homepage: http://github.com/ravindrasoni/gitlog
+licenses:
+- MIT
+metadata:
+  homepage_uri: http://github.com/ravindrasoni/gitlog
+  source_code_uri: http://github.com/ravindrasoni/gitlog
+  changelog_uri: http://github.com/ravindrasoni/gitlog
+post_install_message: 
+rdoc_options: []
+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: 
+rubygems_version: 2.5.2.3
+signing_key: 
+specification_version: 4
+summary: Generate formatted logs from git commits.
+test_files: []