conventional-changelog 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f0dba23ec731da9e6232f288559d0e9ef5985c94
+  data.tar.gz: 589d787a3d640e259ee87e2bb349248cc3301c8a
+SHA512:
+  metadata.gz: 1d33fcf2c24912cfe6c5b011221ebf5e8e87c2dc22aa25d4fe1bb0dbab8dfcdfdf0992b7cabf065298dea628e435628b54a2da01eed7e8fdd44787be42007344
+  data.tar.gz: fdc03d6823f5abb87ac7f29852670c19c73cb393bd2783b26d03ea38b5edcc75b7896a470ed1efe4595821fcc6f68f04d0e23ab9b4ec2beb45df47b7f0574229

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in conventional-changelog.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Diego Carrion
+
+MIT License
+
+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,71 @@
+# Conventional::Changelog
+
+Generates a CHANGELOG.md file from Git metadata using the AngularJS commit conventions.
+
+- [AngularJS Git Commit Message Conventions](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/)
+
+
+## Installation
+
+    $ gem install conventional-changelog
+
+
+## Usage
+
+    $ conventional-changelog
+
+or programatically:
+
+```ruby
+require 'conventional_changelog'
+ConventionalChangelog::Generator.new.generate!
+```
+
+## Examples
+
+Converts this:
+
+    2015-03-30 feat(admin): increase reports ranges
+    2015-03-30 fix(api): fix annoying bug
+    2015-03-28 feat(api): add cool service
+    2015-03-28 feat(api): add cool feature
+    2015-03-28 feat(admin): add page to manage users
+
+into this:
+
+    <a name="2015-03-30"></a>
+    ### 2015-03-30
+    
+    
+    #### Features
+    
+    * **admin**
+      * increase reports ranges (4303fd4)
+    
+    
+    #### Bug Fixes
+    
+    * **api**
+      * fix annoying bug (4303fd5)
+    
+    
+    <a name="2015-03-28"></a>
+    ### 2015-03-28
+    
+    
+    #### Features
+    
+    * **api**
+      * add cool service (4303fd6)
+      * add cool feature (4303fd7)
+    
+    * **admin**
+      * add page to manage users (4303fd8)
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/conventional-changelog/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)

data/bin/conventional-changelog

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'conventional_changelog'
+ConventionalChangelog::Generator.new.generate!

data/conventional-changelog.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'conventional_changelog'
+
+Gem::Specification.new do |spec|
+  spec.name          = "conventional-changelog"
+  spec.version       = ConventionalChangelog::VERSION
+  spec.authors       = ["Diego Carrion"]
+  spec.email         = ["dc.rec1@gmail.com"]
+  spec.summary       = %q{Ruby binary to generate a conventional changelog — Edit}
+  spec.description   = %q{}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", ">= 3.2"
+  spec.add_development_dependency "fakefs"
+end

data/lib/conventional_changelog.rb

@@ -0,0 +1,6 @@
+require "conventional_changelog/generator"
+require "conventional_changelog/git"
+
+module ConventionalChangelog
+  VERSION = "1.0.0"
+end

data/lib/conventional_changelog/generator.rb

@@ -0,0 +1,49 @@
+module ConventionalChangelog
+  class Generator
+    def generate!
+      File.open("CHANGELOG.md", "w") do |file|
+        write_new_lines_to file
+        file.puts previous_body
+      end
+    end
+
+    private
+
+    def write_new_lines_to(f)
+      Git.commits(since: last_date).group_by { |commit| commit[:date] }.sort.reverse.each do |date, commits|
+        f.puts version_header(date)
+        append_changes f, commits, "feat", "Features"
+        append_changes f, commits, "fix", "Bug Fixes"
+      end
+    end
+
+    def last_date
+      previous_body == "" ? nil : previous_body.split("\n")[0].to_s.match(/"(.*)"/)[1]
+    end
+
+    def previous_body
+      @previous_body ||= File.open("CHANGELOG.md", "a+").read
+    end
+
+    def version_header(date)
+      <<-HEADER
+<a name="#{date}"></a>
+### #{date}
+
+
+      HEADER
+    end
+
+    def append_changes(f, commits, type, title)
+      unless (type_commits = commits.select { |commit| commit[:type] == type }).empty?
+        f.puts "#### #{title}", ""
+        type_commits.group_by { |commit| commit[:component] }.each do |component, commits|
+          f.puts "* **#{component}**"
+          commits.each { |commit| f.puts "  * #{commit[:change]} (#{commit[:id]})" }
+          f.puts ""
+        end
+        f.puts ""
+      end
+    end
+  end
+end

data/lib/conventional_changelog/git.rb

@@ -0,0 +1,16 @@
+module ConventionalChangelog
+  class Git
+    DELIMITER = "/////"
+
+    def self.commits(since:)
+      log.split("\n").map { |commit| commit.split DELIMITER }.select { |commit| since.nil? or commit[1] > since }.map do |commit|
+        comment = commit[2].match(/(.*)\((.*)\): (.*)/)
+        { id: commit[0], date: commit[1], type: comment[1], component: comment[2], change: comment[3] }
+      end
+    end
+
+    def self.log
+      `git log --pretty=format:'%h#{DELIMITER}%ad#{DELIMITER}%s%x09' --date=short --grep='^(feat|fix)\\(' -E`
+    end
+  end
+end

data/spec/generator_spec.rb

@@ -0,0 +1,108 @@
+require 'spec_helper'
+
+describe ConventionalChangelog::Generator do
+  describe "#generate!" do
+    context "with no commits" do
+      before :each do
+        allow(ConventionalChangelog::Git).to receive(:log).and_return ""
+      end
+
+      it 'creates an empty changelog when no commits' do
+        subject.generate!
+        expect(File.open("CHANGELOG.md").read).to eql "\n"
+      end
+    end
+
+    context "with multiple commits" do
+      before :each do
+        log = <<-LOG
+4303fd4/////2015-03-30/////feat(admin): increase reports ranges
+4303fd5/////2015-03-30/////fix(api): fix annoying bug
+4303fd6/////2015-03-28/////feat(api): add cool service
+4303fd7/////2015-03-28/////feat(api): add cool feature
+4303fd8/////2015-03-28/////feat(admin): add page to manage users
+        LOG
+        allow(ConventionalChangelog::Git).to receive(:log).and_return log
+      end
+
+      it 'parses simple lines into dates' do
+        subject.generate!
+        body = <<-BODY
+<a name="2015-03-30"></a>
+### 2015-03-30
+
+
+#### Features
+
+* **admin**
+  * increase reports ranges (4303fd4)
+
+
+#### Bug Fixes
+
+* **api**
+  * fix annoying bug (4303fd5)
+
+
+<a name="2015-03-28"></a>
+### 2015-03-28
+
+
+#### Features
+
+* **api**
+  * add cool service (4303fd6)
+  * add cool feature (4303fd7)
+
+* **admin**
+  * add page to manage users (4303fd8)
+
+
+
+        BODY
+        expect(File.open("CHANGELOG.md").read).to eql body
+      end
+
+      it 'preserves previous changes' do
+        previous_body = <<-BODY
+<a name="2015-03-28"></a>
+### 2015-03-28
+
+
+#### Features
+
+* **api**
+  * add cool service (4303fd6)
+  * add cool feature (4303fd7)
+
+* **admin**
+  * add page to manage users (4303fd8)
+
+        BODY
+        File.open("CHANGELOG.md", "w") { |f| f.puts previous_body }
+        body = <<-BODY
+<a name="2015-03-30"></a>
+### 2015-03-30
+
+
+#### Features
+
+* **admin**
+  * increase reports ranges (4303fd4)
+
+
+#### Bug Fixes
+
+* **api**
+  * fix annoying bug (4303fd5)
+
+
+#{previous_body}
+
+        BODY
+        subject.generate!
+        expect(File.open("CHANGELOG.md").read).to eql body
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'conventional_changelog'
+require 'pp'
+require 'fakefs'
+FakeFS.activate!

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: conventional-changelog
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Diego Carrion
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: fakefs
+  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: ''
+email:
+- dc.rec1@gmail.com
+executables:
+- conventional-changelog
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/conventional-changelog
+- conventional-changelog.gemspec
+- lib/conventional_changelog.rb
+- lib/conventional_changelog/generator.rb
+- lib/conventional_changelog/git.rb
+- spec/generator_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby binary to generate a conventional changelog — Edit
+test_files:
+- spec/generator_spec.rb
+- spec/spec_helper.rb