vandamme 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Changelog.md

@@ -0,0 +1,3 @@
+# 2013-01-02 0.0.1
+
+Initial release

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Philippe Lafoucrière
+
+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

@@ -0,0 +1,54 @@
+# Vandamme
+
+[![Dependency Status](https://gemnasium.com/tech-angels/vandamme.png)](https://gemnasium.com/tech-angels/vandamme)
+
+Vandamme is a changelog parser gem, used in the [Gemnasium project](https://gemnasium.com)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'vandamme'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install vandamme
+
+## Usage
+
+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
+
+## Examples
+
+```ruby
+require 'rubygems'
+require 'vandamme'
+require 'open-uri'
+changelog = open('https://raw.github.com/flori/json/master/CHANGES').read
+parser = Vandamme::Parser.new(changelog: changelog, version_header_exp: '\d{4}-\d{2}-\d{2} \((\d\.\d+\.\d+)\)', format: 'markdown')
+parser.parse
+```
+will return a hash with each version as keys, and version content as value.
+The hash can be converted to html (using the [github-markup](https://github.com/github/markup) gem):
+
+```ruby
+parser.to_html
+```
+
+Vandamme is bundled with Redcarpet by default (for markdown), you must add the necessary gems to your bundle if you want to handle more formats.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+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

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec

data/lib/vandamme.rb

@@ -0,0 +1,6 @@
+require "vandamme/version"
+require "vandamme/parser"
+
+module Vandamme
+  # Your code goes here...
+end

data/lib/vandamme/parser.rb

@@ -0,0 +1,45 @@
+require 'open-uri'
+require 'github/markup'
+
+module Vandamme
+  class Parser
+
+    # 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"
+    #
+    def initialize(options={})
+      @changelog          = options.fetch :changelog
+      @version_header_exp = Regexp.new(/#{options.fetch :version_header_exp}/)
+      @format             = options[:format] || :raw
+      @changelog_hash     = {}
+    end
+
+    # Parse changelog file, filling +@changelog_hash+ with
+    # versions as keys, and version changelog as content.
+    #
+    def parse
+      @changelog.scan(@version_header_exp) do
+        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+/, '')
+      end
+      @changelog_hash
+    end
+
+    # Convert @changelog_hash content to html using GitHub::Markup.
+    # The +@format+ is used to determine the input format (should be one of:
+    # "rdoc", "md", 'markdown", "raw", etc.)
+    # See https://github.com/github/markup/blob/master/lib/github/markups.rb
+    # for more formats. The corresponding gem must be bundled.
+    def to_html
+      self.parse if @changelog_hash.empty?
+      # GitHub Markup API is really weird, we MUST pass a file name for format detection:
+      @changelog_hash.inject({}) { |h,(k,v)| h[k] = GitHub::Markup.render(".#{@format}", v); h }
+    end
+  end
+end

data/lib/vandamme/version.rb

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

data/spec/fixtures/json.md

@@ -0,0 +1,8 @@
+2012-11-29 (1.7.6)
+  * Add GeneratorState#merge alias for JRuby, fix state accessor methods. Thx to
+   jvshahid@github.
+  * Increase hash likeness of state objects.
+2012-08-17 (1.7.5)
+  * Fix compilation of extension on older rubies.
+2012-07-26 (1.7.4)
+  * Fix compilation problem on AIX, see https://github.com/flori/json/issues/142

data/spec/fixtures/postmark-gem.rdoc

@@ -0,0 +1,27 @@
+= Changelog
+
+== 0.9.15
+
+* Save a received MessageID in message headers.
+
+== 0.9.14
+
+* Parse Subject and MessageID from the Bounce API response.
+
+== 0.9.13
+
+* Added error_code to DeliveryError
+* Added retries for Timeout::Error
+
+== 0.9.12
+
+* Fixed a problem of attachments processing when using deliver! method on Mail object.
+* Removed activesupport dependency for Postmark::AttachmentsFixForMail.
+* Added specs for AttachmentFixForMail.
+
+== 0.9.11
+
+* Replaced Jeweler by Bundler.
+* Updated RSpec to 2.8.
+* Fixed specs.
+* Refactored the codebase.

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+
+Dir[File.expand_path(File.join(File.dirname(__FILE__), "../lib/**/*.rb"))].each {|f| require f}
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

data/spec/vandamme/parser_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe Vandamme::Parser do
+  context "with json gem changelog" do
+    let(:changelog_file) { File.read("spec/fixtures/json.md") }
+    let(:changelog_as_hash) {
+      {
+        "1.7.6"=> "  * Add GeneratorState#merge alias for JRuby, fix state accessor methods. Thx to\n   jvshahid@github.\n  * Increase hash likeness of state objects.\n",
+        "1.7.5"=> "  * Fix compilation of extension on older rubies.\n",
+        "1.7.4"=> "  * Fix compilation problem on AIX, see https://github.com/flori/json/issues/142\n"
+      }
+    }
+
+    let(:changelog_as_html_hash) {
+      {
+        "1.7.6"=> "<ul>\n<li>Add GeneratorState#merge alias for JRuby, fix state accessor methods. Thx to\njvshahid@github.</li>\n<li>Increase hash likeness of state objects.</li>\n</ul>\n",
+        "1.7.5"=> "<ul>\n<li>Fix compilation of extension on older rubies.</li>\n</ul>\n",
+        "1.7.4"=> "<ul>\n<li>Fix compilation problem on AIX, see https://github.com/flori/json/issues/142</li>\n</ul>\n"
+      }
+    }
+
+    before do
+      @parser = Vandamme::Parser.new(changelog: changelog_file, version_header_exp: '\d{4}-\d{2}-\d{2} \((\d\.\d+\.\d+)\)', format: 'markdown')
+      @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
+
+  context "with postmark-gem changelog (rdoc)" do
+    let(:changelog_file) { File.read("spec/fixtures/postmark-gem.rdoc") }
+    let(:changelog_as_hash) {
+      {
+        "0.9.15" => "* Save a received MessageID in message headers.\n",
+        "0.9.14" => "* Parse Subject and MessageID from the Bounce API response.\n",
+        "0.9.13" => "* Added error_code to DeliveryError\n* Added retries for Timeout::Error\n",
+        "0.9.12" => "* Fixed a problem of attachments processing when using deliver! method on Mail object.\n* Removed activesupport dependency for Postmark::AttachmentsFixForMail.\n* Added specs for AttachmentFixForMail.\n",
+        "0.9.11" => "* Replaced Jeweler by Bundler.\n* Updated RSpec to 2.8.\n* Fixed specs.\n* Refactored the codebase.\n"
+      }
+    }
+
+    let(:changelog_as_html_hash) {
+      {
+        "0.9.15" => "<ul><li>\n<p>Save a received MessageID in message headers.</p>\n</li></ul>\n",
+        "0.9.14" => "<ul><li>\n<p>Parse Subject and MessageID from the Bounce API response.</p>\n</li></ul>\n",
+        "0.9.13" => "<ul><li>\n<p>Added error_code to DeliveryError</p>\n</li><li>\n<p>Added retries for Timeout::Error</p>\n</li></ul>\n",
+        "0.9.12" => "<ul><li>\n<p>Fixed a problem of attachments processing when using deliver! method on\nMail object.</p>\n</li><li>\n<p>Removed activesupport dependency for Postmark::AttachmentsFixForMail.</p>\n</li><li>\n<p>Added specs for AttachmentFixForMail.</p>\n</li></ul>\n",
+        "0.9.11" => "<ul><li>\n<p>Replaced Jeweler by Bundler.</p>\n</li><li>\n<p>Updated RSpec to 2.8.</p>\n</li><li>\n<p>Fixed specs.</p>\n</li><li>\n<p>Refactored the codebase.</p>\n</li></ul>\n"
+      }
+    }
+
+    before do
+      @parser = Vandamme::Parser.new(changelog: changelog_file, version_header_exp: '== (\d.\d+\.\d+)', format: 'rdoc')
+      @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

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vandamme/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "vandamme"
+  gem.version       = Vandamme::VERSION
+  gem.authors       = ["Philippe Lafoucrière"]
+  gem.email         = ["philippe.lafoucriere@tech-angels.com"]
+  gem.description   = %q{Vandamme is aware of files content, and will be mostly used to parse changelog files and extract relevant content.}
+  gem.summary       = %q{Be aware of changelogs content}
+  gem.homepage      = "https://github.com/tech-angels/vandamme"
+
+  gem.files         = `git ls-files`.split($/)
+  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"]
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: vandamme
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Philippe Lafoucrière
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-02 00:00:00.000000000 Z
+dependencies: []
+description: Vandamme is aware of files content, and will be mostly used to parse
+  changelog files and extract relevant content.
+email:
+- philippe.lafoucriere@tech-angels.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Changelog.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/vandamme.rb
+- lib/vandamme/parser.rb
+- lib/vandamme/version.rb
+- spec/fixtures/json.md
+- spec/fixtures/postmark-gem.rdoc
+- spec/spec_helper.rb
+- spec/vandamme/parser_spec.rb
+- vandamme.gemspec
+homepage: https://github.com/tech-angels/vandamme
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Be aware of changelogs content
+test_files:
+- spec/fixtures/json.md
+- spec/fixtures/postmark-gem.rdoc
+- spec/spec_helper.rb
+- spec/vandamme/parser_spec.rb