gitlog-md 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZmE5NGZlZTI4Y2I0NWI1MmEyYTFiODM0YzE0YmE4OGVjNTZiMGNlMw==
+  data.tar.gz: !binary |-
+    ZmVhMzljMjA2MDQ2NTRkMmI2OWYzMWUyZmZkYThhOGU4ZGEyZGE1Yg==
+SHA512:
+  metadata.gz: !binary |-
+    MDk3ZDZhMjEwYzJiNjM1ZWYyZWVjNTM4YWYzNjFmMmUzMGU1ZGQwZmUwODQy
+    NzljYzZiNGE5YTRjNmQxNmYzOGY0MmU5NjQ1YmIzNWIyMDJiODM1ZjY4NGM4
+    NzVhMzI0MjViMDllNmU0YzgxNzk1N2Q3ZTg2ODQ2ZjJlZDhmNjk=
+  data.tar.gz: !binary |-
+    YzJiNTg2YjY2ZTA4MGJmNmRiZWU2ZDE2MmViMjg3ZTgyNDhlYjUyNDBhMmVj
+    YzJkZDFlMTk0NWNhMDRhYTEwN2FjMTk2ZWZjNDg4MGJiOWZkYTg0M2NkZWZl
+    NzUzZDhmZTU4Y2Y3NWFiNTRmMTI2ZTZlOWFmOGY5ODdiMzZjNDg=

data/.gitignore

@@ -0,0 +1,34 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.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,3 @@
+source ENV['GEM_SOURCE'] || "https://rubygems.org"
+
+gemspec

data/HISTORY.md

@@ -0,0 +1,8 @@
+# gitlog-md - History
+## Tags
+* [LATEST - 26 Mar, 2015 (683ca8a0)](#LATEST)
+
+## Details
+### <a name = "LATEST">LATEST - 26 Mar, 2015 (683ca8a0)
+
+* Initial release.

data/LICENSE

@@ -0,0 +1,202 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/README.md

@@ -0,0 +1,2 @@
+# gitlog-md
+Generate a HISTORY.md from your git log.  Assumes versions/releases are tagged.  Always generates from scratch (from first commit to last).  Use for making a readable Markdown file as part of your release process.

data/bin/gitlog-md

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'rubygems' unless defined?(Gem)
+require 'gitlog-md'
+
+GitlogMD::CLI.new.execute

data/gitlog-md.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+require 'gitlog-md/version'
+
+Gem::Specification.new do |s|
+  s.name        = "gitlog-md"
+  s.version     = GitlogMD::Version::STRING
+  s.authors     = ["Puppetlabs"]
+  s.email       = ["qe-team@puppetlabs.com"]
+  s.homepage    = "https://github.com/puppetlabs/gitlog-md"
+  s.summary     = %q{Let's generate a HISTORY.md file!}
+  s.description = %q{Puppetlabs tools for creating markdown HISTORY.md from git log}
+  s.license     = 'Apache2'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # Testing dependencies
+  s.add_development_dependency 'rspec', '~> 3.0'
+  s.add_development_dependency 'rspec-its'
+  s.add_development_dependency 'fakefs', '~> 0.6'
+  s.add_development_dependency 'rake', '~> 10.1'
+  s.add_development_dependency 'simplecov'
+
+  # Documentation dependencies
+  s.add_development_dependency 'yard'
+
+  # Run time dependencies
+  s.add_development_dependency 'gitlab-grit'
+end

data/lib/gitlog-md/argument_parser.rb

@@ -0,0 +1,75 @@
+require 'optparse'
+
+module GitlogMD
+
+  class ArgumentParser
+
+    DEFAULTS = { :output_file => 'HISTORY.md',
+                 :branch      => 'master',
+                 :repo_dir    => '.',
+    }
+
+    def initialize
+      @cmd_options = {}
+
+      @optparse = OptionParser.new do | opts |
+        # Set a banner
+        opts.banner = "Usage: #{File.basename($0)} [options...]"
+
+        opts.on "-o", "--output-file FILE",
+                "File to write MarkDown output to",
+                "(default #{DEFAULTS[:output_file]})"  do |file|
+          @cmd_options[:output_file] = file
+        end
+
+        opts.on "-b", "--branch BRANCH",
+                "Branch to read git log history from",
+                "(default #{DEFAULTS[:branch]})"  do |file|
+          @cmd_options[:branch] = file
+        end
+
+        opts.on "-r", "--repo-dir DIR",
+                "Path to github repo",
+                "(default #{DEFAULTS[:repo_dir]})"  do |file|
+          @cmd_options[:repo_dir] = file
+        end
+
+        opts.on("--version", "Report currently running version of GitlogMD" ) do
+          @cmd_options[:version] = true
+        end
+
+        opts.on("--help", "Display this screen" ) do
+          @cmd_options[:help] = true
+        end
+      end
+
+    end
+
+    # Parse an array of arguments into a Hash of options, use default values for
+    # unset arguments
+    # @param [Array] args The array of arguments to consume
+    #
+    # @example
+    #   args = ['--option', 'value', '--option2', 'value2', '--switch']
+    #   parser = ArgumentParser.new
+    #   parser.parse(args) == {:option => 'value, :options2 => value, :switch => true}
+    #
+    # @return [Hash] Return the Hash of options
+    def parse( args = ARGV )
+      @optparse.parse(args)
+      DEFAULTS.merge(@cmd_options)
+    end
+
+    # Generate a string representing the supported arguments
+    #
+    # @example
+    #    parser = ArgumentParser.new
+    #    parser.usage = "Options:  ..."
+    #
+    # @return [String] Return a string representing the available arguments
+    def usage
+      @optparse.help
+    end
+
+  end
+end

data/lib/gitlog-md/cli.rb

@@ -0,0 +1,41 @@
+module GitlogMD
+  class CLI
+       VERSION_STRING = "
+                          _________
+                         {_________}
+                          )=======(
+                         /         \\
+        GitlogMD        | _________ |
+            %10s  ||   _     ||
+                        ||  |_)    ||
+                        ||  | \\/   ||
+                  __    ||    /\\   ||
+             __  (_|)   |'---------'|
+            (_|)        `-.........-'
+"
+
+    def initialize
+      @arg_parser = GitlogMD::ArgumentParser.new
+      @options = @arg_parser.parse
+      @run = true
+
+      if @options[:help]
+        puts @arg_parser.usage
+        @run = false
+        return
+      end
+      if @options[:version]
+        puts VERSION_STRING % GitlogMD::Version::STRING
+        @run = false
+        return
+      end
+    end
+
+    def execute
+      if @run
+        GitlogMD::Parser.new.make_md(@options)
+      end
+    end
+
+  end
+end

data/lib/gitlog-md/parser.rb

@@ -0,0 +1,58 @@
+require 'grit'
+
+module GitlogMD
+  class Parser
+    def make_md options
+      output_file = options[:output_file]
+      repo_dir    = options[:repo_dir]
+      branch      = options[:branch]
+
+      puts "Using output file: #{output_file}"
+      puts "Repository: #{repo_dir}, branch: #{branch}"
+
+      output = "# #{File.basename(File.absolute_path(repo_dir))} - History\n"
+
+      repo = Grit::Repo.new(repo_dir)
+      head = Grit::Tag.new(repo.commits(branch).first.sha, repo, repo.commits(branch).first.id)
+      tags = repo.tags + [head]
+      tags.sort! {|x,y| y.commit.authored_date <=> x.commit.authored_date}
+
+      output << "## Tags\n"
+      tags.each do |tag|
+        tag_name = tag.name
+        if tag == tags.first
+          tag_name = 'LATEST'
+        end
+        output << "* [#{tag_name} - #{tag.commit.authored_date.strftime("%-d %b, %Y")} (#{tag.commit.sha[0,8]})](##{tag_name})\n"
+      end
+
+      output << "\n## Details\n"
+      tagcount = 0
+      tags.each do |tag|
+        tag_name = tag.name
+        if tag == tags.first
+          tag_name = 'LATEST'
+        end
+        output << "### <a name = \"#{tag_name}\">#{tag_name} - #{tag.commit.authored_date.strftime("%-d %b, %Y")} (#{tag.commit.sha[0,8]})\n\n"
+        if (tagcount != tags.size - 1)
+          commit_set = repo.commits_between(tags[tagcount + 1].name, tag.name)
+          commit_set.sort! {|x,y| y.authored_date <=> x.authored_date }
+          commit_set.each do |c|
+            output << "* #{c.short_message} (#{c.sha[0,8]})\n\n"
+            if c.short_message != c.message
+              output << "\n```\n#{c.message.gsub(/```/, "\n")}\n```\n"
+            end
+          end
+        else
+          output << "* Initial release.\n"
+        end
+        tagcount += 1
+      end
+
+      File.open(output_file, 'w') { |f| f.write(output) }
+
+      puts "Success, Markdown output sent to #{output_file}"
+    end
+  end
+
+end

data/lib/gitlog-md/version.rb

@@ -0,0 +1,5 @@
+module GitlogMD
+  module Version
+    STRING = '0.0.1'
+  end
+end

data/lib/gitlog-md.rb

@@ -0,0 +1,12 @@
+require 'rubygems' unless defined?(Gem)
+module GitlogMD
+
+  %w( version parser argument_parser cli ).each do |lib|
+    begin
+      require "gitlog_md/#{lib}"
+    rescue LoadError
+      require File.expand_path(File.join(File.dirname(__FILE__), 'gitlog-md', lib))
+    end
+  end
+
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: gitlog-md
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Puppetlabs
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gitlab-grit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Puppetlabs tools for creating markdown HISTORY.md from git log
+email:
+- qe-team@puppetlabs.com
+executables:
+- gitlog-md
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- HISTORY.md
+- LICENSE
+- README.md
+- bin/gitlog-md
+- gitlog-md.gemspec
+- lib/gitlog-md.rb
+- lib/gitlog-md/argument_parser.rb
+- lib/gitlog-md/cli.rb
+- lib/gitlog-md/parser.rb
+- lib/gitlog-md/version.rb
+homepage: https://github.com/puppetlabs/gitlog-md
+licenses:
+- Apache2
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Let's generate a HISTORY.md file!
+test_files: []