pimpmychangelog 0.0.2 → 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 437b82b2e0edcee6e194382cb19a9733dd907564351aab59a9c4d30d1c2068a8
+  data.tar.gz: 236fd3beaccb0458a4500ce0efa6913ee3311181637a1e23918a720a69480ea6
+SHA512:
+  metadata.gz: 3bd0471c3b529d85a2a87e06616e41704b6946a3e3093648121bebf66332e4cd8fa21475138c4edb791b2a534fa2dc8badeb1c1496bb72da75c8be90a908bd35
+  data.tar.gz: e2f9f90d6501b955cce7908674d6aba84c3965409c49f6be742c3e5ac0a33b42de5ee232e9dad8d5cd813020c9e99e3414a56e1595bec48804e5f7ea504ff6f4

data/.gitignore

@@ -2,3 +2,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+tmp

data/CHANGELOG.md

@@ -1,15 +1,52 @@
 # Changelog
 
+## Version 0.1.3
+
+* Retrieve git-remote from local configuration PR [#17][] by [@marcotc][].
+
+## Version 0.1.2
+
+* Add support for changelogs without extra new line at the end of file.
+PR [#6][] by [@arangamani][].
+
+## Version 0.1.1
+
+* Add support for usernames with hyphens. Closes issue [#4][] reported by
+[@miketheman][].
+
+## Version 0.1.0
+
+* Add support for git repos with HTTPS urls. PR [#3][] by
+[@Maher4Ever][].
+
+## Version 0.0.3
+
+* Add support for Github nicknames with dashes. PR [#2][] by [@rymai][].
+
 ## Version 0.0.2
 
 * CLI does not accept any options anymore
 * Github user and projects are extracted from the origin remote fetch
   url
-* CHANGELOG.md is overwritten instead of printed out. #1
+* CHANGELOG.md is overwritten instead of printed out. [#1][]
 
 
 ## Version 0.0.1
 
-* Initial version by @pcreux
+* Initial version by [@pcreux][]
 * Usage: `pimpmychangelog gregbell activeadmin CHANGELOG.md`
 This would output the pimped version of the changelog.
+
+<!--- The following link definition list is generated by PimpMyChangelog --->
+[#1]: https://github.com/pcreux/pimpmychangelog/issues/1
+[#2]: https://github.com/pcreux/pimpmychangelog/issues/2
+[#3]: https://github.com/pcreux/pimpmychangelog/issues/3
+[#4]: https://github.com/pcreux/pimpmychangelog/issues/4
+[#6]: https://github.com/pcreux/pimpmychangelog/issues/6
+[#17]: https://github.com/pcreux/pimpmychangelog/issues/17
+[@Maher4Ever]: https://github.com/Maher4Ever
+[@arangamani]: https://github.com/arangamani
+[@marcotc]: https://github.com/marcotc
+[@miketheman]: https://github.com/miketheman
+[@pcreux]: https://github.com/pcreux
+[@rymai]: https://github.com/rymai

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Philippe Creux
+
+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

@@ -2,6 +2,9 @@
 
 Add links to users and issues in your CHANGELOG.md.
 
+[![Build
+Status](https://travis-ci.org/pcreux/pimpmychangelog.png?branch=master)](https://travis-ci.org/pcreux/pimpmychangelog)
+
 ### Example:
 
 > Add Travis-CI support. (@pcreux, #181)

data/Rakefile

@@ -1 +1,7 @@
 require 'bundler/gem_tasks'
+
+task :default => :test
+
+task :test do
+  system "bundle exec rspec spec --color --format documentation"
+end

data/lib/pimpmychangelog/git_remote.rb

@@ -1,8 +1,20 @@
 class GitRemote
-  def initialize
-    match = fetch_url.match(/(\w+)\/(\w+)/)
-    @user = match[1]
-    @project = match[2]
+
+  REPOSITORY_PATTERN = %r{
+    # Define recurring patterns
+    (?<part> [\w\d-]+ ){0}
+
+    (?<user>\g<part>)/(?<repo>\g<part>)(.git)?$
+  }x
+
+  def initialize(url = nil)
+    @url = url || fetch_url
+
+    match = @url.match(REPOSITORY_PATTERN)
+
+    @user = match[:user]
+    @project = match[:repo]
+
     unless @user && @project
       raise "Can't extract github user and project from origin remote"
     end
@@ -17,6 +29,6 @@ class GitRemote
   end
 
   def run_command
-   `git remote show origin | grep "Fetch URL"`
+    `git config --get remote.origin.url`
   end
 end

data/lib/pimpmychangelog/parser.rb

@@ -21,7 +21,7 @@ module PimpMyChangelog
     # @return [Array] ordered array of contributors found in the changelog
     #   Example: ['gregbell', 'pcreux', 'samvincent']
     def contributors
-      changelog.scan(/@(\w+)/).flatten.uniq.sort
+      changelog.scan(/@([\w-]+)/).flatten.uniq.sort
     end
   end
 end

data/lib/pimpmychangelog/pimper.rb

@@ -18,7 +18,11 @@ module PimpMyChangelog
     def better_changelog
       parsed_changelog = Parser.new(changelog)
 
-      linkify_changelog(parsed_changelog.content) +
+      # If the file doesn't have an extra newline at the end the separator gets rendered
+      # as part of the changelog. So add an extra newline in that case.
+      extra_newline_if_required = parsed_changelog.content.match(/\n\n\Z/) ? "" : "\n"
+
+      linkify_changelog(parsed_changelog.content) + extra_newline_if_required +
         links_definitions(parsed_changelog.issues, parsed_changelog.contributors)
     end
 
@@ -38,7 +42,7 @@ module PimpMyChangelog
     # The following regexp ensure that the issue or contributor is
     # not wrapped between brackets (aka: is a link)
     ISSUE_NUMBER_REGEXP = /(^|[^\[])#(\d+)($|[^\]])/
-    CONTRIBUTOR_REGEXP = /(^|[^\[])@(\w+)($|[^\]])/
+    CONTRIBUTOR_REGEXP = /(^|[^\[])@([\w-]+)($|[^\]])/
 
     # @param [Array] issues An array of issue numbers
     # @param [Array] contributors An array of contributors github ids

data/lib/pimpmychangelog/version.rb

@@ -1,3 +1,3 @@
 module PimpMyChangelog
-  VERSION = "0.0.2"
+  VERSION = "0.1.3"
 end

data/pimpmychangelog.gemspec

@@ -5,6 +5,7 @@ require "pimpmychangelog/version"
 Gem::Specification.new do |s|
   s.name        = "pimpmychangelog"
   s.version     = PimpMyChangelog::VERSION
+  s.license     = 'MIT'
   s.authors     = ["Philippe Creux"]
   s.email       = ["pcreux@gmail.com"]
   s.homepage    = "https://github.com/pcreux/pimpmychangelog"
@@ -19,5 +20,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_development_dependency "rspec"
+  s.add_development_dependency "rspec-its"
   s.add_development_dependency "guard-rspec"
+  s.add_development_dependency "rake"
 end

data/spec/git_remote_spec.rb

@@ -1,8 +1,26 @@
 require 'spec_helper'
 
 describe GitRemote do
-  context "when working on pcreux/pimpmychangelog" do
+  context "when passed a SSH url to a repo" do
+    subject { described_class.new('git@github.com:pcreux/pimpmychangelog.git') }
+
+    its(:user) { should == 'pcreux' }
+    its(:project) { should == 'pimpmychangelog' }
+  end
+
+  context "when passed a HTTPS url to a repo" do
+    subject { described_class.new('https://github.com/pcreux/pimpmychangelog.git') }
+
     its(:user) { should == 'pcreux' }
     its(:project) { should == 'pimpmychangelog' }
   end
+
+  context "when no URL is passed" do
+    subject { described_class.new }
+
+    # We can't match an exact user, as this depends on who
+    # has checked out this repository.
+    its(:user) { should be_a(String) }
+    its(:project) { should == 'pimpmychangelog' }
+  end
 end

data/spec/parser_spec.rb

@@ -49,8 +49,8 @@ EOS
 
   describe "#contributors" do
     it "should return a sorted list of unique contributors" do
-      Parser.new("@samvincent @pcreux @gregbell @pcreux").contributors.
-        should == ['gregbell', 'pcreux', 'samvincent']
+      Parser.new("@samvincent @pcreux @gregbell @pcreux @dash-and_underscore").contributors.
+        should == ['dash-and_underscore', 'gregbell', 'pcreux', 'samvincent']
     end
   end
 end

data/spec/pimper_spec.rb

@@ -18,8 +18,16 @@ describe Pimper do
 
     subject { better_changelog }
 
-    context "when the changelog does not contain any reference to issues or users" do
-      let(:changelog) { 'ChangeLog' }
+    context "when the changelog does not contain any reference to issues or users and no extra newline" do
+      let(:changelog) { "ChangeLog\n" }
+
+      it "should return the original changelog with an extra newline" do
+        better_changelog.should == changelog + "\n"
+      end
+    end
+
+    context "when the changelog already includes an extra newline" do
+      let(:changelog) { "ChangeLog\n\n" }
 
       it "should return the original changelog" do
         better_changelog.should == changelog
@@ -39,14 +47,14 @@ describe Pimper do
     end
 
     context "when the changelog contains a contributor" do
-      let(:changelog) { 'New feature by @pcreux' }
+      let(:changelog) { 'New feature by @pc-re_ux' }
 
       it "should wrap the issue number to make a link" do
-        better_changelog.should include("[@pcreux][]")
+        better_changelog.should include("[@pc-re_ux][]")
       end
 
       it "should append the link definition at the end of the changelog" do
-        better_changelog.split("\n").last.should == "[@pcreux]: https://github.com/pcreux"
+        better_changelog.split("\n").last.should == "[@pc-re_ux]: https://github.com/pc-re_ux"
       end
     end
 

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+require 'rspec/its'
+
 require File.expand_path('../../lib/pimpmychangelog', __FILE__)
 
 include PimpMyChangelog

metadata

@@ -1,64 +1,85 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: pimpmychangelog
-version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 2
-  version: 0.0.2
+version: !ruby/object:Gem::Version
+  version: 0.1.3
 platform: ruby
-authors: 
+authors:
 - Philippe Creux
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-
-date: 2011-12-12 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2021-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-description: Linkify issue numbers (#123) and github users (@gregbell) in markdown changelogs.
-email: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Linkify issue numbers (#123) and github users (@gregbell) in markdown
+  changelogs.
+email:
 - pcreux@gmail.com
-executables: 
+executables:
 - pimpmychangelog
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- .gitignore
+files:
+- ".gitignore"
 - CHANGELOG.md
 - Gemfile
 - Guardfile
+- LICENSE
 - README.md
 - Rakefile
 - bin/pimpmychangelog
@@ -75,37 +96,31 @@ files:
 - spec/pimper_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/pcreux/pimpmychangelog
-licenses: []
-
-post_install_message: 
+licenses:
+- MIT
+metadata: {}
+post_install_message:
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: 
-rubygems_version: 1.8.11
-signing_key: 
-specification_version: 3
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
 summary: Pimp your CHANGELOG.md
-test_files: []
-
+test_files:
+- spec/cli_spec.rb
+- spec/git_remote_spec.rb
+- spec/parser_spec.rb
+- spec/pimper_spec.rb
+- spec/spec_helper.rb