vandamme 0.0.4 → 0.0.5

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 0.0.5 / unreleased
+
+* Fix default regexp for trailing chars in version number. (@nzwsch)
+
 # 0.0.4 / 2013-03-28
 
 * The parser constructor parameter "version_header_exp" is now optional, and will default to changelog convention regexp.

data/README.md

@@ -142,13 +142,30 @@ Example in Markdown:
 + {{version_number}} **SHOULD** follow the [semver](http://semver.org/) convention.
 + {{version_number}} **MUST** contain at least a dot (ex: "1.2").
 
+### Keywords
+
+Usage of keywords is strongly recommanded, as it helps to identify the nature of each change.
+Keywords should be a one-word tag, in caps, preceding each change line:
+
+```markdown
+# 1.2.4 / Unreleased
+
+* [BUGFIX] Fix bug #2
+* [FEATURE] Add github oauth login
+* [PERFORMANCE] Now 25% faster!
+```
+
++ Keyword, if present, **MUST** be in caps, at beginning of line, and surrounded with square brackets.
++ Keyword **SHOULD** be preferably among: "SECURITY", "BUGFIX", "FEATURE", "ENHANCEMENT", "PERFORMANCE"
+
+
 ### Note
 
 Changelogs following these rules will be automatically included in Gemnasium.
 The regexp used is 
 
 ```
-^#{1,2} ([\w\d\.-]+\.[\w\d\.-]+) ?\/? ?(\d{4}-\d{2}-\d{2}|\w+)?
+^#{0,3} ?([\w\d\.-]+\.[\w\d\.-]+[a-zA-Z0-9])( \/ (\d{4}-\d{2}-\d{2}|\w+))?\n?[=-]*
 ```
 
 Check your changelog using Rubular if you want to be sure:

data/lib/vandamme/parser.rb

@@ -4,7 +4,7 @@ require 'github/markup'
 module Vandamme
   class Parser
 
-    DEFAULT_REGEXP = Regexp.new('^#{1,2} ([\w\d\.-]+\.[\w\d\.-]+) ?\/? ?(\d{4}-\d{2}-\d{2}|\w+)?')
+    DEFAULT_REGEXP = Regexp.new('^#{0,3} ?([\w\d\.-]+\.[\w\d\.-]+[a-zA-Z0-9])( \/ (\d{4}-\d{2}-\d{2}|\w+))?\n?[=-]*')
 
     # Create a new changelog parser
     #

data/lib/vandamme/version.rb

@@ -1,3 +1,3 @@
 module Vandamme
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/spec/vandamme/parser_spec.rb

@@ -136,6 +136,47 @@ describe Vandamme::Parser do
     }
 
 
+    before do
+      @parser = Vandamme::Parser.new(changelog: changelog_file)
+      @changelog_parsed = @parser.parse
+    end
+
+    it "should parse file and fill changelog hash" do
+      expect(@changelog_parsed).to eq(changelog_as_hash)
+    end
+  end
+
+  context "Alternative markdown headers syntax" do
+    let(:changelog_file) { 
+      <<-eos
+Changelog
+=========
+
+X.Y.Z / Unreleased
+------------------
+
+* Update API 
+* Fix bug #1
+
+1.2.3-pre.1 / 2013-02-14
+------------------------
+
+* Update API 
+
+1.0.0-x.7.z.92
+--------------
+      eos
+      }
+
+    let(:changelog_as_hash) {
+      {
+        "X.Y.Z"           => "* Update API \n* Fix bug #1",
+        "1.2.3-pre.1"     => "* Update API ",
+        "1.0.0-x.7.z.92"  => ""
+      }
+    }
+
+
     before do
       @parser = Vandamme::Parser.new(changelog: changelog_file)
       @changelog_parsed = @parser.parse

data/vandamme.gemspec

@@ -21,5 +21,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rake','~> 10.0.2'
 
   gem.add_dependency 'github-markup', '~> 0.7.5'
-  gem.add_dependency 'redcarpet', '~> 2.2.2'
+  gem.add_dependency 'redcarpet', '3.0.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vandamme
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-28 00:00:00.000000000 Z
+date: 2013-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -64,17 +64,17 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - '='
       - !ruby/object:Gem::Version
-        version: 2.2.2
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - '='
       - !ruby/object:Gem::Version
-        version: 2.2.2
+        version: 3.0.0
 description: Vandamme is aware of files content, and will be mostly used to parse
   changelog files and extract relevant content.
 email:
@@ -112,7 +112,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1723865160074823590
+      hash: 371014573655272997
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -121,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1723865160074823590
+      hash: 371014573655272997
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24