vandamme 0.0.1 → 0.0.2

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/Changelog.md

@@ -1,3 +1,10 @@
+# 2013-01-06 0.0.2
+
+* Fix gem dependencies (to githup-markup)
+* Allow users to specify :match_group for dirty changelogs
+* Improved documentation
+* ```:version_header_exp``` can be a real Regexp now
+
 # 2013-01-02 0.0.1
 
 Initial release

data/Gemfile

@@ -2,6 +2,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in vandamme.gemspec
 gemspec
-gem 'rspec'
-gem 'github-markup'
-gem 'redcarpet'

data/README.md

@@ -1,6 +1,7 @@
 # Vandamme
 
 [![Dependency Status](https://gemnasium.com/tech-angels/vandamme.png)](https://gemnasium.com/tech-angels/vandamme)
+[![Build Status](https://travis-ci.org/tech-angels/vandamme.png?branch=master)](https://travis-ci.org/tech-angels/vandamme)
 
 Vandamme is a changelog parser gem, used in the [Gemnasium project](https://gemnasium.com)
 
@@ -24,7 +25,44 @@ The Parser initializer will use 3 options:
 
 * **:changelog**: full raw content of the changelog file
 * **:version_header_exp**: regexp to match the versions lines in changelog
-* **:format** (*optional*): if you want to use the html converter, you must provide the original format of the changelog
+* **:format** (*optional*): if you want to use the html converter, you must provide the original format of the changelog. (default: 'raw')
+* **:group_match** (*optional*): Number of the match group is used for version matching. (default: 0)
+
+### Regex format
+
+**version_header_exp** will be converted to a new Regex object if it wasn't one.
+Therefore, 
+
+    Vandamme::Parser.new(changelog: changelog, version_header_exp: '\d{4}-\d{2}-\d{2} \((\d\.\d+\.\d+)\)')
+
+is equivalent to:
+
+    Vandamme::Parser.new(changelog: changelog, version_header_exp: /\d{4}-\d{2}-\d{2} \((\d\.\d+\.\d+)\)/)
+
+Be careful with how ruby is handling escaped caracters in a string: ```"\d"``` if different from ```'\d'```!
+
+### Version Matching
+
+By default, the first match of the Regexp will be considered as the version number.
+ie:
+
+    'Release (\d+\.\d+\.\d+)'
+
+will match lines like:
+
+    Release 1.3.5
+
+and '1.3.5' will be used as a key in the Hash returned by the ```parse``` method.
+Starting Vandamme 0.0.2, it's possible to specify which match group must be
+used for the version number, by passing the option **:match_group** to the
+initializer:
+
+    Vandamme::Parser.new([...], :matching_group => 1)
+
+The default match group is 0: this is the first group matched (0 being the
+original string), because we are using ```String#scan``` instead of
+```Regexp.match```.
+
 
 ## Examples
 
@@ -52,3 +90,10 @@ Vandamme is bundled with Redcarpet by default (for markdown), you must add the n
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## Credits
+
+  Philippe Lafoucrière @ Tech-angels - http://www.tech-angels.com/
+
+  [![Tech-Angels](http://media.tumblr.com/tumblr_m5ay3bQiER1qa44ov.png)](http://www.tech-angels.com)
+

data/lib/vandamme/parser.rb

@@ -7,26 +7,32 @@ module Vandamme
     # Create a new changelog parser
     #
     # Options:
-    # * +changelog+: uri of file to be parsed
-    # * +version_header_exp+: regexp to match the starting line of version
-    # * +format+: (optional). One of "raw", "markdown", "rdoc"
+    # * +changelog+:: Changelog content as a +String+.
+    # * +version_header_exp+:: regexp to match the starting line of version.
+    # * +format+ (optional):: One of "raw", "markdown", "rdoc"
     #
+    # 
     def initialize(options={})
       @changelog          = options.fetch :changelog
-      @version_header_exp = Regexp.new(/#{options.fetch :version_header_exp}/)
+      regexp              = options.fetch :version_header_exp
+      @version_header_exp = regexp.is_a?(Regexp) ? regexp : Regexp.new(/#{regexp}/)
+      @match_group        = options[:match_group] || 0
       @format             = options[:format] || :raw
       @changelog_hash     = {}
     end
 
+    # call-seq:
+    #   parse => aHash
+    #
     # Parse changelog file, filling +@changelog_hash+ with
     # versions as keys, and version changelog as content.
     #
     def parse
-      @changelog.scan(@version_header_exp) do
+      @changelog.scan(@version_header_exp) do |match|
         version_content = $~.post_match
         changelog_scanner = StringScanner.new(version_content)
         changelog_scanner.scan_until(@version_header_exp)
-        @changelog_hash[$1]= (changelog_scanner.pre_match || version_content).gsub(/^\n+/, '')
+        @changelog_hash[match[@match_group]]= (changelog_scanner.pre_match || version_content).gsub(/^\n+/, '')
       end
       @changelog_hash
     end

data/lib/vandamme/version.rb

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

data/spec/vandamme/parser_spec.rb

@@ -68,4 +68,44 @@ describe Vandamme::Parser do
       expect(@parser.to_html).to eq(changelog_as_html_hash)
     end
   end
+
+  context "with changelog changing convention (md)" do
+    let(:changelog_file) { 
+      <<-eos
+# Version 1.0.0 - 2013-01-06
+
+* First stable version.
+
+# Release 0.9.9
+
+* Last Beta before stable.
+      eos
+      }
+    let(:changelog_as_hash) {
+      {
+        "1.0.0" => "* First stable version.\n",
+        "0.9.9" => "* Last Beta before stable.\n"
+      }
+    }
+
+    let(:changelog_as_html_hash) {
+      {
+        "1.0.0" => "<ul>\n<li>First stable version.</li>\n</ul>\n",
+        "0.9.9" => "<ul>\n<li>Last Beta before stable.</li>\n</ul>\n"
+      }
+    }
+
+    before do
+      @parser = Vandamme::Parser.new(changelog: changelog_file, version_header_exp: '# (Version|Release) (\d.\d+\.\d+)( - \d{4}-\d{2}-\d{2})?', format: 'md', match_group: 1)
+      @changelog_parsed = @parser.parse
+    end
+
+    it "should parse file and fill changelog hash" do
+      expect(@changelog_parsed).to eq(changelog_as_hash)
+    end
+
+    it "should provide html content" do
+      expect(@parser.to_html).to eq(changelog_as_html_hash)
+    end
+  end
 end

data/vandamme.gemspec

@@ -16,4 +16,10 @@ Gem::Specification.new do |gem|
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
+
+  gem.add_development_dependency 'rspec','~> 2.12.0'
+  gem.add_development_dependency 'rake','~> 10.0.2'
+
+  gem.add_dependency 'github-markup', '~> 0.7.5'
+  gem.add_dependency 'redcarpet', '~> 2.2.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vandamme
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,72 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-02 00:00:00.000000000 Z
-dependencies: []
+date: 2013-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.2
+- !ruby/object:Gem::Dependency
+  name: github-markup
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.5
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.2
 description: Vandamme is aware of files content, and will be mostly used to parse
   changelog files and extract relevant content.
 email:
@@ -20,6 +84,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Changelog.md
 - Gemfile
 - LICENSE.txt