conventional-changelog 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f0dba23ec731da9e6232f288559d0e9ef5985c94
-  data.tar.gz: 589d787a3d640e259ee87e2bb349248cc3301c8a
+  metadata.gz: 82e232d316b2991fe1ab21738840de315b4947d2
+  data.tar.gz: 2c1cf594ac555f73d854a05aa42cc35f4a29e598
 SHA512:
-  metadata.gz: 1d33fcf2c24912cfe6c5b011221ebf5e8e87c2dc22aa25d4fe1bb0dbab8dfcdfdf0992b7cabf065298dea628e435628b54a2da01eed7e8fdd44787be42007344
-  data.tar.gz: fdc03d6823f5abb87ac7f29852670c19c73cb393bd2783b26d03ea38b5edcc75b7896a470ed1efe4595821fcc6f68f04d0e23ab9b4ec2beb45df47b7f0574229
+  metadata.gz: 030486a4cd67efcf2551c4ddfd9a32fa3d59b0994798ca45a402a0bb1b125cd9887df81f276bc72b08c4d731fa3ab2240b9532c67a9db916e89aa41dfca6f38c
+  data.tar.gz: 235950400c1240ee2c29fa5f5b5393e485b1b3fc9bb6a53e5e34c9d35cde6725babadf4675c7c8a4ef9587b952df42f30dd2a4e68231c3b4f271c710ca0d5d66

data/.travis.yml

@@ -0,0 +1,8 @@
+addons:
+  code_climate:
+    repo_token: 70c8e7caf52d56ab9ea35d2d9f30c4ab28431647b05d35edbe889eaec8803056
+language: ruby
+rvm:
+  - "2.1.5"
+  - "2.2.1"
+script: bundle exec rake spec

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+<a name="1.0.0"></a>
+### 1.0.0 (2015-03-28)
+
+
+#### Features
+
+* **api**
+  * Generator#generate! generates a changelog programatically	 ([9738c30](/../../commit/9738c30))
+
+* **bin**
+  * add a conventional-changelog binary	 ([af6be02](/../../commit/af6be02))
+
+
+

data/README.md

@@ -1,3 +1,7 @@
+[![Build Status](https://travis-ci.org/dcrec1/conventional-changelog-ruby.svg?branch=master)](https://travis-ci.org/dcrec1/conventional-changelog-ruby)
+[![Code Climate](https://codeclimate.com/github/dcrec1/conventional-changelog-ruby/badges/gpa.svg)](https://codeclimate.com/github/dcrec1/conventional-changelog-ruby)
+[![Test Coverage](https://codeclimate.com/github/dcrec1/conventional-changelog-ruby/badges/coverage.svg)](https://codeclimate.com/github/dcrec1/conventional-changelog-ruby)
+
 # Conventional::Changelog
 
 Generates a CHANGELOG.md file from Git metadata using the AngularJS commit conventions.

data/bin/conventional-changelog

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
 require 'rubygems'
 require 'conventional_changelog'
-ConventionalChangelog::Generator.new.generate!
+require 'conventional_changelog/cli'
+ConventionalChangelog::CLI.execute ARGV

data/conventional-changelog.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'conventional_changelog'
+require 'conventional_changelog/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "conventional-changelog"
@@ -22,4 +22,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", ">= 3.2"
   spec.add_development_dependency "fakefs"
+  spec.add_development_dependency "codeclimate-test-reporter"
 end

data/lib/conventional_changelog.rb

@@ -1,6 +1,9 @@
 require "conventional_changelog/generator"
 require "conventional_changelog/git"
+require "conventional_changelog/version"
+require "conventional_changelog/writer"
+require "conventional_changelog/by_date_writer"
+require "conventional_changelog/by_version_writer"
 
 module ConventionalChangelog
-  VERSION = "1.0.0"
 end

data/lib/conventional_changelog/by_date_writer.rb

@@ -0,0 +1,19 @@
+module ConventionalChangelog
+  class ByDateWriter < Writer
+    private
+
+    def filter_key
+      :since_date
+    end
+
+    def write_new_lines(options)
+      commits.group_by { |commit| commit[:date] }.sort.reverse.each do |date, commits|
+        write_section commits, date
+      end
+    end
+
+    def version_header_title(id)
+      id
+    end
+  end
+end

data/lib/conventional_changelog/by_version_writer.rb

@@ -0,0 +1,17 @@
+module ConventionalChangelog
+  class ByVersionWriter < Writer
+    private
+
+    def filter_key
+      :since_version
+    end
+
+    def write_new_lines(options)
+      write_section commits, options[:version]
+    end
+
+    def version_header_title(id)
+      "#{id} (#{commits[0][:date]})"
+    end
+  end
+end

data/lib/conventional_changelog/cli.rb

@@ -0,0 +1,12 @@
+module ConventionalChangelog
+  class CLI
+    def self.execute(params)
+      Generator.new.generate! parse(params)
+    end
+
+    private
+    def self.parse(params)
+      Hash[*params.map { |param| param.split("=") }.map { |key, value| [key.to_sym, value] }.flatten]
+    end
+  end
+end

data/lib/conventional_changelog/generator.rb

@@ -1,49 +1,13 @@
 module ConventionalChangelog
   class Generator
-    def generate!
-      File.open("CHANGELOG.md", "w") do |file|
-        write_new_lines_to file
-        file.puts previous_body
-      end
+    def generate!(options = {})
+      writer(options).new("CHANGELOG.md").write! options
     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
+    def writer(options)
+      options[:version] ? ByVersionWriter : ByDateWriter
     end
   end
 end

data/lib/conventional_changelog/git.rb

@@ -2,15 +2,21 @@ 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|
+    def self.commits(options)
+      log(options).split("\n").map { |commit| commit.split DELIMITER }.select { |commit| options[:since_date].nil? or commit[1] > options[:since_date] }.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`
+    private
+
+    def self.log(options)
+      `git log --pretty=format:'%h#{DELIMITER}%ad#{DELIMITER}%s%x09' --date=short --grep='^(feat|fix)\\(' -E #{version_filter(options)}`
+    end
+
+    def self.version_filter(options)
+      options[:since_version] ? "#{options[:since_version]}..HEAD" : ""
     end
   end
 end

data/lib/conventional_changelog/version.rb

@@ -0,0 +1,3 @@
+module ConventionalChangelog
+  VERSION = "1.1.0"
+end

data/lib/conventional_changelog/writer.rb

@@ -0,0 +1,50 @@
+module ConventionalChangelog
+  class Writer < File
+    def initialize(file_name)
+      @previous_body = File.open(file_name, "a+").read
+      super file_name, "w"
+    end
+
+    def write!(options)
+      write_new_lines options
+      self.puts @previous_body
+    end
+
+    private
+
+    def version_header(id)
+      <<-HEADER
+<a name="#{id}"></a>
+### #{version_header_title(id)}
+
+
+      HEADER
+    end
+
+    def commits
+      @commits ||= Git.commits filter_key => last_id
+    end
+
+    def append_changes(commits, type, title)
+      unless (type_commits = commits.select { |commit| commit[:type] == type }).empty?
+        puts "#### #{title}", ""
+        type_commits.group_by { |commit| commit[:component] }.each do |component, commits|
+          puts "* **#{component}**"
+          commits.each { |commit| puts "  * #{commit[:change]} ([#{commit[:id]}](/../../commit/#{commit[:id]}))" }
+          puts ""
+        end
+        puts ""
+      end
+    end
+
+    def write_section(commits, id)
+      puts version_header(id)
+      append_changes commits, "feat", "Features"
+      append_changes commits, "fix", "Bug Fixes"
+    end
+
+    def last_id
+      @previous_body.to_s == "" ? nil : @previous_body.split("\n")[0].to_s.match(/"(.*)"/)[1]
+    end
+  end
+end

data/spec/cli_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+require 'conventional_changelog/cli'
+
+describe ConventionalChangelog::CLI do
+  describe ".execute" do
+    it 'runs clean' do
+      expect { ConventionalChangelog::CLI.execute [] }.to_not raise_exception  
+    end
+
+    context "with empty arguments" do
+      it 'generates a changelog' do
+        expect_any_instance_of(ConventionalChangelog::Generator).to receive(:generate!).with({})
+        ConventionalChangelog::CLI.execute []
+      end
+    end
+
+    context "with version=x.y.z" do
+      it 'generates a changelog with the version' do
+        expect_any_instance_of(ConventionalChangelog::Generator).to receive(:generate!).with version: "x.y.z"
+        ConventionalChangelog::CLI.execute ["version=x.y.z"]
+      end
+    end
+  end
+end

data/spec/generator_spec.rb

@@ -2,6 +2,14 @@ require 'spec_helper'
 
 describe ConventionalChangelog::Generator do
   describe "#generate!" do
+    before :each do
+      FileUtils.rm "CHANGELOG.md", force: true
+    end
+
+    it 'runs clean' do
+      expect { subject.generate! }.to_not raise_exception  
+    end
+
     context "with no commits" do
       before :each do
         allow(ConventionalChangelog::Git).to receive(:log).and_return ""
@@ -15,19 +23,22 @@ describe ConventionalChangelog::Generator do
 
     context "with multiple commits" do
       before :each do
-        log = <<-LOG
+        allow(ConventionalChangelog::Git).to receive(:log).and_return log
+      end
+
+      context "without a version param" do
+        let(:log) do <<-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
+          LOG
+        end
 
-      it 'parses simple lines into dates' do
-        subject.generate!
-        body = <<-BODY
+        it 'parses simple lines into dates' do
+          subject.generate!
+          body = <<-BODY
 <a name="2015-03-30"></a>
 ### 2015-03-30
 
@@ -35,13 +46,13 @@ describe ConventionalChangelog::Generator do
 #### Features
 
 * **admin**
-  * increase reports ranges (4303fd4)
+  * increase reports ranges ([4303fd4](/../../commit/4303fd4))
 
 
 #### Bug Fixes
 
 * **api**
-  * fix annoying bug (4303fd5)
+  * fix annoying bug ([4303fd5](/../../commit/4303fd5))
 
 
 <a name="2015-03-28"></a>
@@ -51,20 +62,20 @@ describe ConventionalChangelog::Generator do
 #### Features
 
 * **api**
-  * add cool service (4303fd6)
-  * add cool feature (4303fd7)
+  * add cool service ([4303fd6](/../../commit/4303fd6))
+  * add cool feature ([4303fd7](/../../commit/4303fd7))
 
 * **admin**
-  * add page to manage users (4303fd8)
+  * add page to manage users ([4303fd8](/../../commit/4303fd8))
 
 
 
-        BODY
-        expect(File.open("CHANGELOG.md").read).to eql body
-      end
+          BODY
+          expect(File.open("CHANGELOG.md").read).to eql body
+        end
 
-      it 'preserves previous changes' do
-        previous_body = <<-BODY
+        it 'preserves previous changes' do
+          previous_body = <<-BODY
 <a name="2015-03-28"></a>
 ### 2015-03-28
 
@@ -72,15 +83,14 @@ describe ConventionalChangelog::Generator do
 #### Features
 
 * **api**
-  * add cool service (4303fd6)
+  * add cool service modified (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
+          BODY
+          File.open("CHANGELOG.md", "w") { |f| f.puts previous_body }
+          body = <<-BODY
 <a name="2015-03-30"></a>
 ### 2015-03-30
 
@@ -88,20 +98,67 @@ describe ConventionalChangelog::Generator do
 #### Features
 
 * **admin**
-  * increase reports ranges (4303fd4)
+  * increase reports ranges ([4303fd4](/../../commit/4303fd4))
 
 
 #### Bug Fixes
 
 * **api**
-  * fix annoying bug (4303fd5)
+  * fix annoying bug ([4303fd5](/../../commit/4303fd5))
 
 
 #{previous_body}
+          BODY
+          subject.generate!
+          expect(File.open("CHANGELOG.md").read + "\n").to eql body
+        end
+      end
 
-        BODY
-        subject.generate!
-        expect(File.open("CHANGELOG.md").read).to eql body
+      context "with a version param" do
+        let(:log) do <<-LOG
+4303fd4/////2015-03-30/////feat(admin): increase reports ranges
+4303fd5/////2015-03-29/////fix(api): fix annoying bug
+          LOG
+        end
+
+        it 'preserves previous changes' do
+          previous_body = <<-BODY
+<a name="0.1.0"></a>
+### 0.1.0 (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="0.2.0"></a>
+### 0.2.0 (2015-03-30)
+
+
+#### Features
+
+* **admin**
+  * increase reports ranges ([4303fd4](/../../commit/4303fd4))
+
+
+#### Bug Fixes
+
+* **api**
+  * fix annoying bug ([4303fd5](/../../commit/4303fd5))
+
+
+#{previous_body}
+          BODY
+          subject.generate! version: '0.2.0'
+          expect(File.open("CHANGELOG.md").read + "\n").to eql body
+        end
       end
     end
   end

data/spec/spec_helper.rb

@@ -1,4 +1,10 @@
-require 'conventional_changelog'
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
 require 'pp'
 require 'fakefs'
-FakeFS.activate!
+require 'conventional_changelog'
+
+RSpec.configure do |config|
+  config.before(:all) { FakeFS.activate! }
+  config.after(:all) { FakeFS.deactivate! }
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: conventional-changelog
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Diego Carrion
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-28 00:00:00.000000000 Z
+date: 2015-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  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
@@ -75,6 +89,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -82,8 +98,14 @@ files:
 - bin/conventional-changelog
 - conventional-changelog.gemspec
 - lib/conventional_changelog.rb
+- lib/conventional_changelog/by_date_writer.rb
+- lib/conventional_changelog/by_version_writer.rb
+- lib/conventional_changelog/cli.rb
 - lib/conventional_changelog/generator.rb
 - lib/conventional_changelog/git.rb
+- lib/conventional_changelog/version.rb
+- lib/conventional_changelog/writer.rb
+- spec/cli_spec.rb
 - spec/generator_spec.rb
 - spec/spec_helper.rb
 homepage: ''
@@ -111,5 +133,6 @@ signing_key:
 specification_version: 4
 summary: Ruby binary to generate a conventional changelog — Edit
 test_files:
+- spec/cli_spec.rb
 - spec/generator_spec.rb
 - spec/spec_helper.rb