spreadtheword 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b676601f96251a4526b79a395e3a7b93a7d83e253d2f7897c2648cf1d529e4ad
+  data.tar.gz: 983c4020d19cb4ffa9d2e2ce7f1cbc94454184301294306b548ff12b16eb94d9
+SHA512:
+  metadata.gz: ce7082cff5b1ec90ff41d0002af108010abdc2616f034c44bf6cc86715d72dfd90bd42c604ab15b5d55c9f81bf9367ac4967130832360664b1122a73f097565c
+  data.tar.gz: 6c36e551114b0557c5c57182491835e4eac5ae1eb25669c42cd68b65fb26090b67d9bafd385bb8da692bf5b3e838f8cfef3c864e3fab1b80b9b3e155a71d3ecf

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in spreadtheword.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,112 @@
+PATH
+  remote: .
+  specs:
+    spreadtheword (1.0.0)
+      activesupport (~> 5.2)
+      gitlab (~> 4.3.0)
+      google-cloud-translate (~> 1.2)
+      nokogiri (~> 1.8)
+      pry (~> 0.11.3)
+      wrike3 (~> 0.4.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    coderay (1.1.2)
+    concurrent-ruby (1.0.5)
+    faraday (0.15.2)
+      multipart-post (>= 1.2, < 3)
+    gitlab (4.3.0)
+      httparty
+      terminal-table
+    google-cloud-core (1.2.1)
+      google-cloud-env (~> 1.0)
+    google-cloud-env (1.0.2)
+      faraday (~> 0.11)
+    google-cloud-translate (1.2.0)
+      faraday (~> 0.13)
+      google-cloud-core (~> 1.2)
+      googleauth (~> 0.6.2)
+    googleauth (0.6.2)
+      faraday (~> 0.12)
+      jwt (>= 1.4, < 3.0)
+      logging (~> 2.0)
+      memoist (~> 0.12)
+      multi_json (~> 1.11)
+      os (~> 0.9)
+      signet (~> 0.7)
+    httparty (0.13.7)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    i18n (1.0.1)
+      concurrent-ruby (~> 1.0)
+    json (1.8.6)
+    jwt (2.1.0)
+    little-plugger (1.1.4)
+    logging (2.2.2)
+      little-plugger (~> 1.1)
+      multi_json (~> 1.10)
+    memoist (0.16.0)
+    metaclass (0.0.4)
+    method_source (0.9.0)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
+    mocha (1.5.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.13.1)
+    multi_xml (0.6.0)
+    multipart-post (2.0.0)
+    nokogiri (1.8.3)
+      mini_portile2 (~> 2.3.0)
+    nokogiri (1.8.3-x64-mingw32)
+      mini_portile2 (~> 2.3.0)
+    os (0.9.6)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (3.0.2)
+    rake (10.5.0)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.2.2)
+    shoulda-matchers (2.8.0)
+      activesupport (>= 3.0.0)
+    signet (0.8.1)
+      addressable (~> 2.3)
+      faraday (~> 0.9)
+      jwt (>= 1.5, < 3.0)
+      multi_json (~> 1.10)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.4.0)
+    wrike3 (0.4.0)
+      httparty (~> 0.13.7)
+      mime-types
+      mocha (~> 1.1)
+      shoulda (~> 3.5)
+
+PLATFORMS
+  ruby
+  x64-mingw32
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  spreadtheword!
+
+BUNDLED WITH
+   1.16.2

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Minqi Pan
+
+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,87 @@
+<h1 align="center" style="border-bottom: none;">Spread the Word</h1>
+<h3 align="center">Automatically generate a release-note document based on git commit messages</h3>
+<p align="center">
+<a href="https://travis-ci.org/pmq20/spreadtheword">
+  <img alt="Build Status" src="https://travis-ci.org/pmq20/spreadtheword.svg?branch=master" />
+</a>
+<a href="https://ci.appveyor.com/project/pmq20/spreadtheword/branch/master">
+  <img alt="Build Status" src="https://ci.appveyor.com/api/projects/status/xdb4p03gvrjr0m6m?svg=true" />
+</a>
+<a href="https://codecov.io/gh/pmq20/spreadtheword">
+  <img alt="codecov" src="https://codecov.io/gh/pmq20/spreadtheword/branch/master/graph/badge.svg" />
+</a>
+<a href="https://snyk.io/test/github/pmq20/spreadtheword">
+  <img src="https://snyk.io/test/github/pmq20/spreadtheword/badge.svg" alt="Known Vulnerabilities" data-canonical-src="https://snyk.io/test/github/pmq20/spreadtheword?targetFile=Frontend%2Fpackage.json" style="max-width:100%;">
+</a>
+<a href="http://isitmaintained.com/project/pmq20/spreadtheword">
+  <img alt="Average time to resolve an issue" src="http://isitmaintained.com/badge/resolution/pmq20/spreadtheword.svg" />
+</a>
+<a href="http://isitmaintained.com/project/pmq20/spreadtheword">
+  <img alt="Percentage of issues still open" src="http://isitmaintained.com/badge/open/pmq20/spreadtheword.svg" />
+</a>
+</p>
+
+## Features
+
+* Multiple projects are supported, which means git messages from multiple repositories can be merged to produce a unified release document
+* Multiple output formats are supported, e.g. LaTeX
+* Integrates with Wrike and GitLab to fetch developement task titles
+* Integrates with Google Translate to automatically translate messages to English
+
+## Commit Message Conventions
+
+- `{W1}` menas Wrike task `XXX` as in Wrike's permalink `https://www.wrike.com/open.htm?id=XXX`. Eg. `{W4123780} fix config files`
+- `{#1}` means issue #1 of Gitlab. Eg. `{#63} add backend code for fields`
+- `{prj#1}` means issue #1 of Gitlab project `prj`. Eg. `{UI#1} add code for forms`
+
+## Install
+
+    gem install spreadtheword
+
+## Usage
+
+    spreadtheword [PROJECT 1] [PROJECT 2]...[PROJECT N] [OPTION 1] [OPTION 2]...[OPTION N]
+          --author=STRING              Specifies the author of the output document. Default: user.name of git config
+          --console                    If present, start the console after spreadtheword initializes.
+          --google-translate-key=STRING
+                                      Specifies a Google Translate API access key and translate commit messages that contain non-ASCII characters to English.
+      -h, --help                       Prints this help and exit
+          --gitlab-endpoint=URL        Specifies GitLab API endpoint URL.
+          --gitlab-token=STRING        Specifies the OAuth access token of your GitLab.
+          --quiet                      If present, spreadtheword would not output anything to stderr.
+          --since=TAG/COMMIT-SHA1      Specifies the begining from which the git commits will be fetched. Default: the first commit
+          --title=STRING               Specifies the title of the output document. Default: "Relase Notes"
+      -v, --version                    Prints the version of spreadtheword and exit
+          --wrike-token=STRING         Specifies the access token of your Wrike API app.
+
+## Notes
+
+* If no projects were provided, the current directory would be used as the sole project directory;
+* If multiple projects were provided, the git commit messages of those projects would be merged;
+* If no options were specified, their default (see below) will be used.
+
+## Example
+
+    spreadtheword                                     \
+      /projects/X                                     \
+      /projects/Y                                     \
+      --since=v1.5                                    \
+      --title="Your Project v1.6 Release Notes"       \
+      --author="Your Company, Inc."                   \
+      --google-translate-key="XXX"                    \
+      --gitlab-endpoint="https://example.net/api/v4"  \
+      --gitlab-token="XXX"                            \
+      --wrike-token="XXX"                             \
+      > v1.6.tex
+
+Hint: you might need to set environment variable `LANG=en_US.UTF-8` to support wide characters of git log messages.
+
+## License
+
+MIT
+
+## See Also
+
+- [gitlab](https://github.com/narkoz/gitlab): Ruby client and CLI for GitLab API.
+- [wrike3](https://github.com/morshedalam/wrike3): Ruby client for the Wrike API V3.
+- [google-cloud-translate](https://github.com/GoogleCloudPlatform/google-cloud-ruby/tree/master/google-cloud-translate): the official library for Google Cloud Translation API.

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 "spreadtheword"
+
+# 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/spreadtheword

@@ -0,0 +1,101 @@
+#!/usr/bin/env ruby
+
+# Copyright (c) 2018 Minqi Pan <pmq2001@gmail.com>
+# 
+# This file is part of spreadtheword, distributed under the MIT License
+# For full terms see the included LICENSE file
+
+require 'bundler/setup'
+require 'optparse'
+require 'ostruct'
+require 'pry'
+require 'spreadtheword'
+
+USAGE = %Q{
+Spread the Word (spreadtheword) v#{::Spreadtheword::VERSION}
+Automatically generate a release-note document based on git commit messages.
+Notes
+  * If no projects were provided, the current directory would be used as the sole project directory;
+  * If multiple projects were provided, the git commit messages of those projects would be merged;
+  * If no options were specified, their default (see below) will be used.
+Usage
+  spreadtheword [PROJECT 1] [PROJECT 2]...[PROJECT N] [OPTION 1] [OPTION 2]...[OPTION N]
+}.strip
+
+projects = []
+ARGV.keep_if do |x|
+  if '-' == x[0]
+    true
+  else
+    projects << x.dup
+    false
+  end
+end
+
+options = OpenStruct.new
+
+outer_opts = nil
+
+usage = lambda do |out|
+  out.puts outer_opts
+end
+
+OptionParser.new do |opts|
+  opts.banner = USAGE
+
+  opts.on("--author=STRING", "Specifies the author of the output document. Default: user.name of git config") do |x|
+    options.author = x
+  end
+
+  opts.on("--console", "If present, start the console after spreadtheword initializes.") do
+    options.console = true
+  end
+
+  opts.on("--google-translate-key=STRING", "Specifies a Google Translate API access key and translate commit messages that contain non-ASCII characters to English.") do |x|
+    options.googleTranslateKey = x
+  end
+
+  opts.on("-h", "--help", "Prints this help and exit") do
+    usage.call(STDOUT)
+    STDOUT.puts
+    exit 0
+  end
+
+  opts.on("--gitlab-endpoint=URL", "Specifies GitLab API endpoint URL.") do |x|
+    options.gitlabEndpoint = x
+  end
+
+  opts.on("--gitlab-token=STRING", "Specifies the OAuth access token of your GitLab.") do |x|
+    options.gitlabToken = x
+  end
+
+  opts.on("--quiet", "If present, spreadtheword would not output anything to stderr.") do
+    options.quiet = true
+  end
+
+  opts.on("--since=TAG/COMMIT-SHA1", 'Specifies the begining from which the git commits will be fetched. Default: the first commit') do |x|
+    options.since = x
+  end
+
+  opts.on("--title=STRING", 'Specifies the title of the output document. Default: "Relase Notes"') do |x|
+    options.title = x
+  end
+
+  opts.on("-v", "--version", "Prints the version of spreadtheword and exit") do
+    puts ::Spreadtheword::VERSION
+    exit 0
+  end
+  
+  opts.on("--wrike-token=STRING", "Specifies the access token of your Wrike API app.") do |x|
+    options.wrikeToken = x
+  end
+
+  outer_opts = opts
+end.parse!
+
+instance = ::Spreadtheword.new projects, options
+if options.console
+  binding.pry
+end
+instance.run!
+

data/exe/spreadtheword.bat

@@ -0,0 +1,2 @@
+@echo off
+ruby %~dp0\spreadtheword %*

data/lib/spreadtheword/latex.rb

@@ -0,0 +1,142 @@
+require 'nokogiri'
+
+class Spreadtheword::LaTeX
+  def initialize title, author, topics, getTranslation
+    @title = title
+    @author = author
+    @topics = topics
+    @getTranslation = getTranslation
+  end
+
+  def write!
+    puts %Q_
+% !TEX TS-program = pdflatex
+% !TEX encoding = UTF-8 Unicode
+
+\\documentclass[11pt]{article} % use larger type; default would be 10pt
+\\usepackage{hyperref}
+\\usepackage[utf8]{inputenc} % set input encoding (not needed with XeLaTeX)
+\\usepackage{geometry} % to change the page dimensions
+\\geometry{a4paper} % or letterpaper (US) or a5paper or....
+\\usepackage{graphicx} % support the \\includegraphics command and options
+\\usepackage{booktabs} % for much better looking tables
+\\usepackage{array} % for better arrays (eg matrices) in maths
+\\usepackage{paralist} % very flexible & customisable lists (eg. enumerate/itemize, etc.)
+\\usepackage{verbatim} % adds environment for commenting out blocks of text & for better verbatim
+\\usepackage{subfig} % make it possible to include more than one captioned figure/table in a single float
+\\usepackage{fancyhdr} % This should be set AFTER setting up the page geometry
+\\pagestyle{fancy} % options: empty , plain , fancy
+\\renewcommand{\\headrulewidth}{0pt} % customise the layout...
+\\lhead{}\\chead{}\\rhead{}
+\\lfoot{}\\cfoot{\\thepage}\\rfoot{}
+\\usepackage[nottoc,notlof,notlot]{tocbibind} % Put the bibliography in the ToC
+\\usepackage[titles,subfigure]{tocloft} % Alter the style of the Table of Contents
+\\renewcommand{\\cftsecfont}{\\rmfamily\\mdseries\\upshape}
+\\renewcommand{\\cftsecpagefont}{\\rmfamily\\mdseries\\upshape} % No bold!
+\\title{#{@title}}
+\\author{#{@author}}
+\\begin{document}
+\\maketitle
+\\setcounter{tocdepth}{1}
+\\tableofcontents
+\\newpage
+#{sections}
+\\end{document}
+    _
+  end
+
+  def sections
+    ret = ''
+    @topics.each do |k,v|
+      next if k.nil?
+      first = v[0]
+      title = k
+      description = ''
+      url = ''
+      if :gitlab == first[:origin]
+        title = first[:title]
+        description = first[:payload].description
+        url = first[:payload].web_url
+      elsif :wrike == first[:origin]
+        title = first[:title]
+        description = Nokogiri::HTML(first[:payload]['description'].gsub('<br />', "\n\n")).text
+        url = first[:payload][:spreadthewordPermalink]
+      end
+      ret += %Q_
+\\section{#{escape title}}
+
+\\subsection{Background}
+
+\\url{#{escape url}}
+_
+
+      if description.present?
+        ret += %Q_
+\\subsection{Description}
+
+#{escape description}
+
+_
+      end
+
+      ret += printDevelopers(v)
+      ret += %Q_
+\\newpage
+      _
+    end
+    if @topics[nil]
+      ret += %Q_
+\\section{Others}
+      _
+      ret += printDevelopers(@topics[nil])
+    end
+    ret
+  end
+
+  def printDevelopers(values)
+    developers = {}
+    values.each do |x|
+      developers[x[:commit].author] ||= []
+      developers[x[:commit].author] << x
+    end
+    ret = %Q_
+\\subsection{Developers}
+
+\\begin{enumerate}
+_
+    developers.each do |k,v|
+      ret += %Q_
+      \\item #{escape k} ($#{v.size*100 / values.size}\\%$)
+      _
+    end
+    ret += %Q_
+\\end{enumerate}
+    _
+    developers.each do |k,v|
+      ret += %Q_
+\\subsection{#{escape k}'s Commit Messages}
+\\begin{enumerate}
+      _
+      uniqM = v.map do |x|
+        x[:commit].msg
+      end.uniq
+      uniqM.each do |x|
+        ret += %Q_
+\\item #{escape x}
+        _
+      end      
+      ret += %Q_
+\\end{enumerate}
+      _
+    end
+    ret
+  end
+
+  def escape str
+    return 'N/A' unless str.present?
+    if @getTranslation && str =~ Spreadtheword::NONASCII
+      str = @getTranslation.call(str)
+    end
+    str.gsub(Spreadtheword::NONASCII, '').gsub('\\', '\\textbackslash ').gsub('&', '\\\&').gsub('%', '\\%').gsub('$', '\\$').gsub('#', '\\#').gsub('_', '\\_').gsub('{', '\\{').gsub('}', '\\}').gsub('~', '\\textasciitilde ').gsub('^', '\\textasciicircum ')
+  end
+end

data/lib/spreadtheword/utils.rb

@@ -0,0 +1,12 @@
+class Spreadtheword::Utils
+  def initialize(options)
+    @options = options
+  end
+
+  def say(something)
+    unless @options.quiet
+      STDERR.print something
+      STDERR.flush
+    end
+  end
+end

data/lib/spreadtheword/version.rb

@@ -0,0 +1,3 @@
+class Spreadtheword
+  VERSION = "1.0.0"
+end

data/lib/spreadtheword.rb

@@ -0,0 +1,203 @@
+require 'uri'
+require 'ostruct'
+require 'active_support/all'
+require 'wrike3'
+require 'gitlab'
+require 'spreadtheword/version'
+require 'spreadtheword/utils'
+require 'spreadtheword/latex'
+require 'google/cloud/translate'
+
+class Spreadtheword
+  CONNECTOR = '__spreadtheword__'
+  NONASCII = /[^\u0000-\u007F]+/
+
+  def initialize(projects, options)
+    @projects = projects.any? ? projects : [Dir.pwd]
+    @title = options.title ? options.title : 'Relase Notes'
+    @author = options.author ? options.author : gitUserName
+    @since = options.since
+
+    configureGitlab(options) if options.gitlabToken
+    configureWrike(options) if options.wrikeToken
+    configureGoogleTranslate(options) if options.googleTranslateKey
+
+    @utils = Utils.new(options)
+    @logs = []
+    @topics = {}
+  end
+
+  def configureGitlab(options)
+    Gitlab.configure do |config|
+      config.endpoint       = options.gitlabEndpoint
+      config.private_token  = options.gitlabToken
+    end
+    @gitlab = URI(options.gitlabEndpoint)
+    @gitlabCurrentProject = nil
+    @gilabProjects = {}
+    @gitlabCache = {}
+  end
+
+  def configureWrike(options)
+    Wrike3.configure do |config|
+      config.access_token  = options.wrikeToken
+    end
+    @wrike = Wrike3()
+    @wrikeCache = {}
+  end
+
+  def configureGoogleTranslate(options)
+    @translate = Google::Cloud::Translate.new(key: options.googleTranslateKey)
+    translateCache = {}
+    @getTranslation = lambda { |sentence|
+    unless translateCache[sentence]
+      @utils.say "Translating\n-> #{sentence}\n"
+      translateCache[sentence] = @translate.translate(sentence, to: "en").text
+      @utils.say "<- #{translateCache[sentence]}\n"
+    end
+    translateCache[sentence]
+  }
+  end
+
+  def getGitlab(projectId, issueNumber)
+    unless @gitlabCache[projectId] && @gitlabCache[projectId][issueNumber]
+      @gitlabCache[projectId] ||= {}
+      @gitlabCache[projectId][issueNumber] = Gitlab.issue(projectId, issueNumber)
+    end
+    return @gitlabCache[projectId][issueNumber]
+  end
+
+  def getWrike(wId)
+    unless @wrikeCache[wId]
+      permalink = "https://www.wrike.com/open.htm?id=#{wId}"
+      @utils.say "Fetching Wrike task #{permalink}"
+      tasks = @wrike.task.list nil, nil, permalink: permalink
+      @utils.say "."
+      taskId = tasks['data'][0]['id']
+      task = @wrike.task.details taskId
+      @utils.say "."
+      @wrikeCache[wId] = task['data'][0]
+      @wrikeCache[wId][:spreadthewordPermalink] = permalink
+      @utils.say "\n"
+    end
+    return @wrikeCache[wId]
+  end
+
+  def run!
+    fetchAllLogs
+    parseTopics
+    writer = Spreadtheword::LaTeX.new(@title, @author, @topics, @getTranslation)
+    writer.write!
+  end
+
+  def gitlabSetCurrentProject
+    remotes = `git remote -v`
+    remotes.to_s.split("\n").each do |line|
+      if line.include?(@gitlab.host)
+        lines = line.split(@gitlab.host)
+        liness = lines[1].split('/')
+        @gitlabCurrentProject = {
+          namespace: liness[1],
+          project: liness[2].split('.git')[0],
+        }
+        return
+      end
+    end
+  end
+
+  def fetchAllLogs
+    @projects.each do |project|
+      @utils.say "Fetching git commit logs from #{project}\n"
+      Dir.chdir(project) do
+        gitlabSetCurrentProject if @gitlab
+        fetchLogs
+      end
+    end
+  end
+
+  def fetchLogs
+    cmd = %Q{git log --pretty=format:"%an__spreadtheword__%s"}
+    if @since
+      cmd = %Q{#{cmd} #{@since}..master}
+    end
+    logs = `#{cmd}`.to_s.split("\n")
+    logs.delete_if do |x|
+      x.nil? || '' == x.to_s.strip
+    end
+    logs.map! do |x|
+      contents = x.split(CONNECTOR)
+      if contents[1].nil? || '' == contents[1].to_s.strip
+        contents[1] = ''
+      end
+      OpenStruct.new.tap do |y|
+        y.author = contents[0]
+        y.origMsg = contents[1]
+        if @translate && y.origMsg =~ NONASCII
+          y.msg = @getTranslation.call(contents[1])
+        else
+          y.msg = y.origMsg
+        end
+        if @gitlab
+          y.gitlabProject = @gitlabCurrentProject
+        end
+      end
+    end
+    @logs.concat logs
+  end
+
+  def parseTopics
+    @logs.each do |x|
+      origin = :plain
+      identifier = nil
+      payload = nil
+      title = 'Others'
+      begin
+        if x.origMsg =~ /\{W(\d+)\}/
+          origin = :wrike
+          identifier = "W#{$1}"
+          payload = getWrike($1)
+          title = payload['title']
+          x.msg = x.msg.gsub(/\{W\d+\}/, '')
+        elsif x.origMsg =~ /\{#(\d+)\}/
+          origin = :gitlab
+          targetProjectId = "#{x.gitlabProject[:namespace]}/#{x.gitlabProject[:project]}"
+          identifier = "#{targetProjectId}##{$1}"
+          payload = getGitlab(targetProjectId, $1)
+          title = payload.title
+          x.msg = x.msg.gsub(/\{#\d+\}/, '')
+        elsif x.origMsg =~ /\{(.+)#(\d+)\}/
+          origin = :gitlab
+          if $1.include?('/')
+            targetProjectId = $1.dup
+          else
+            targetProjectId = "#{x.gitlabProject[:namespace]}/#{$1}"
+          end
+          identifier = "#{targetProjectId}##{$2}"
+          payload = getGitlab(targetProjectId, $2)
+          title = payload.title
+          x.msg = x.msg.gsub(/\{.+#\d+\}/, '')
+        end
+      rescue => e
+        STDERR.puts "!!! Exception when parsing topic !!! #{e}"
+        origin = :plain
+        identifier = nil
+        payload = nil
+        title = 'Others'
+      end
+      if @translate && title =~ NONASCII
+        title = @getTranslation.call(title)
+      end
+      @topics[identifier] ||= []
+      @topics[identifier] << {
+        origin: origin,
+        commit: x,
+        payload: payload,
+        title: title,
+      }
+    end
+  end
+
+  def gitUserName
+    `git config --get user.name`.to_s.strip
+  end
+end

data/spreadtheword.gemspec

@@ -0,0 +1,33 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "spreadtheword/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "spreadtheword"
+  spec.version       = Spreadtheword::VERSION
+  spec.authors       = ["Minqi Pan"]
+  spec.email         = ["pmq2001@gmail.com"]
+
+  spec.summary       = %q{Automatically generate a release-note document based on git commit messages.}
+  spec.description   = %q{Automatically generate a release-note document based on git commit messages.}
+  spec.homepage      = "https://github.com/pmq20/spreadtheword"
+  spec.license       = "MIT"
+
+  # 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_dependency 'gitlab', '~> 4.3.0'
+  spec.add_dependency 'wrike3', '~> 0.4.0'
+  spec.add_dependency 'google-cloud-translate', '~> 1.2'
+  spec.add_dependency 'activesupport', '~> 5.2'
+  spec.add_dependency 'nokogiri', '~> 1.8'
+  spec.add_dependency 'pry', '~> 0.11.3'
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: spreadtheword
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Minqi Pan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gitlab
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.3.0
+- !ruby/object:Gem::Dependency
+  name: wrike3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: google-cloud-translate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+description: Automatically generate a release-note document based on git commit messages.
+email:
+- pmq2001@gmail.com
+executables:
+- spreadtheword
+- spreadtheword.bat
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/spreadtheword
+- exe/spreadtheword.bat
+- lib/spreadtheword.rb
+- lib/spreadtheword/latex.rb
+- lib/spreadtheword/utils.rb
+- lib/spreadtheword/version.rb
+- spreadtheword.gemspec
+homepage: https://github.com/pmq20/spreadtheword
+licenses:
+- MIT
+metadata: {}
+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.7.7
+signing_key: 
+specification_version: 4
+summary: Automatically generate a release-note document based on git commit messages.
+test_files: []