pimpmychangelog 0.0.1 → 0.0.2

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+
+## 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
+
+
+## Version 0.0.1
+
+* Initial version by @pcreux
+* Usage: `pimpmychangelog gregbell activeadmin CHANGELOG.md`
+This would output the pimped version of the changelog.

data/README.md

@@ -0,0 +1,32 @@
+## Pimp My Changelog
+
+Add links to users and issues in your CHANGELOG.md.
+
+### Example:
+
+> Add Travis-CI support. (@pcreux, #181)
+
+becomes:
+
+> Add Travis-CI support. ([@pcreux][], [#181][])
+<!--- The following link definition list is generated by PimpMyChangelog --->
+[#181]: https://github.com/gregbell/active_admin/issues/181
+[@pcreux]: https://github.com/pcreux
+
+
+### Usage:
+
+Install:
+
+    gem install pimpmychangelog
+
+Go in your project directory and run:
+
+    pimpmychangelog
+      # => Your changelog is now pimped!
+
+Notes:
+
+* We assume the CHANGELOG file is `CHANGELOG.md`
+* We assume origin points to the github repository that the issues
+  belong to.

data/bin/pimpmychangelog

@@ -2,4 +2,4 @@
 
 require File.expand_path('../../lib/pimpmychangelog.rb', __FILE__)
 
-PimpMyChangelog::CLI.run!(ARGV)
+PimpMyChangelog::CLI.run!

data/lib/pimpmychangelog.rb

@@ -1,3 +1,3 @@
-%w(pimper parser cli version).each do |file|
+%w(pimper parser git_remote cli version).each do |file|
   require File.expand_path("../pimpmychangelog/#{file}.rb", __FILE__)
 end

data/lib/pimpmychangelog/cli.rb

@@ -1,24 +1,43 @@
 module PimpMyChangelog
   class CLI
-    def self.run!(args)
-      unless args.size == 3
-        puts "Usage: pimpmychangelog github_user github_project CHANGELOG.md"
-        exit 1
-      end
+    def self.run!
+      new.run
+    end
 
-      new(*args).run
+    def initialize
+      @git_remote = GitRemote.new
     end
 
-    attr_reader :user, :project, :changelog_path
+    def run
+      changelog = read_changelog
+      puts changelog
+      puts ""
+      puts "In case something goes wrong we printed out your current #{changelog_path} above"
 
-    def initialize(user, project, changelog_path)
-      @user = user
-      @project = project
-      @changelog_path = changelog_path
+      write_changelog(Pimper.new(user, project, changelog).better_changelog)
+      puts "Your changelog is now pimped!"
     end
 
-    def run
-      puts Pimper.new(user, project, File.read(changelog_path)).better_changelog
+    private
+
+    def user
+      @git_remote.user
+    end
+
+    def project
+      @git_remote.project
+    end
+
+    def changelog_path
+      "CHANGELOG.md"
+    end
+
+    def read_changelog
+      File.read(changelog_path)
+    end
+
+    def write_changelog(content)
+      File.open(changelog_path, 'w') { |f| f.write content }
     end
   end
 end

data/lib/pimpmychangelog/git_remote.rb

@@ -0,0 +1,22 @@
+class GitRemote
+  def initialize
+    match = fetch_url.match(/(\w+)\/(\w+)/)
+    @user = match[1]
+    @project = match[2]
+    unless @user && @project
+      raise "Can't extract github user and project from origin remote"
+    end
+  end
+
+  attr_reader :user, :project
+
+  private
+
+  def fetch_url
+    @fetch_url ||= run_command.split(' ').last
+  end
+
+  def run_command
+   `git remote show origin | grep "Fetch URL"`
+  end
+end

data/lib/pimpmychangelog/version.rb

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

data/spec/cli_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe CLI ,"#run"do
+
+end

data/spec/git_remote_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe GitRemote do
+  context "when working on pcreux/pimpmychangelog" do
+    its(:user) { should == 'pcreux' }
+    its(:project) { should == 'pimpmychangelog' }
+  end
+end

data/spec/pimper_spec.rb

@@ -67,7 +67,7 @@ You know what? @pcreux closed issue #300!
 You know what? [@pcreux][] closed issue [#123][].
 And this is my link, don't touch it: [Adequate][http://adequatehq.com]
 
-<!--- The following link definitions are generated by PimpMyChangelog --->
+<!--- The following link definition list is generated by PimpMyChangelog --->
 [#123]: https://github.com/gregbell/activeadmin/issues/123
 [@pcreux]: https://github.com/pcreux
 EOS
@@ -84,7 +84,7 @@ You know what? [@pcreux][] closed issue [#300][]!
 You know what? [@pcreux][] closed issue [#123][].
 And this is my link, don't touch it: [Adequate][http://adequatehq.com]
 
-<!--- The following link definitions are generated by PimpMyChangelog --->
+<!--- The following link definition list is generated by PimpMyChangelog --->
 [#123]: https://github.com/gregbell/activeadmin/issues/123
 [#300]: https://github.com/gregbell/activeadmin/issues/300
 [@pcreux]: https://github.com/pcreux

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: pimpmychangelog
 version: !ruby/object:Gem::Version 
-  hash: 29
-  prerelease: false
+  hash: 27
+  prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Philippe Creux
@@ -15,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-25 00:00:00 -07:00
-default_executable: pimpmychangelog
+date: 2011-12-12 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
@@ -57,20 +56,24 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- CHANGELOG.md
 - Gemfile
 - Guardfile
+- README.md
 - Rakefile
 - bin/pimpmychangelog
 - lib/pimpmychangelog.rb
 - lib/pimpmychangelog/cli.rb
+- lib/pimpmychangelog/git_remote.rb
 - lib/pimpmychangelog/parser.rb
 - lib/pimpmychangelog/pimper.rb
 - lib/pimpmychangelog/version.rb
 - pimpmychangelog.gemspec
+- spec/cli_spec.rb
+- spec/git_remote_spec.rb
 - spec/parser_spec.rb
 - spec/pimper_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: https://github.com/pcreux/pimpmychangelog
 licenses: []
 
@@ -100,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Pimp your CHANGELOG.md