changelog 0.0.1

data/lib/changelog.rb

@@ -0,0 +1,88 @@
+# encoding: utf-8
+
+class CHANGELOG
+  # @param [String] path Path to your CHANGELOG file
+  # @raise [ArgumentError] if given path doesn't exist
+  # @author Jakub Stastny aka Botanicus
+  # @since 0.0.1
+  def initialize(path = "CHANGELOG")
+    raise ArgumentError, "Path '#{path}' doesn't exist!" unless File.exist?(path)
+    @path = path
+  end
+
+  # @return [Array<String>] List of all the available versions
+  # @author Jakub Stastny aka Botanicus
+  # @since 0.0.1
+  def versions
+    self.parse.keys
+  end
+
+  # @return [String, nil]
+  #   Name of the last available version or nil if the changelog is empty
+  # @author Jakub Stastny aka Botanicus
+  # @since 0.0.1
+  def last_version_name
+    self.versions.last
+  end
+
+  # @return [Array<String>, nil]
+  #   List of changes in the last version or nil if the changelog is empty
+  # @author Jakub Stastny aka Botanicus
+  # @since 0.0.1
+  def last_version_changes
+    self.parse[self.versions.last]
+  end
+
+  # @param [String, Regexp] version Full name of the version or pattern matching the version.
+  # @raise [StandardError] if pattern matched more than one version
+  # @return [Array<String>, nil]
+  #   List of changes in the given version or nil if given version doesn't exist
+  # @example changelog["Version 0.1"]
+  # @author Jakub Stastny aka Botanicus
+  # @since 0.0.1
+  def [](version)
+    if version.is_a?(String)
+      self.parse[version]
+    else
+      versions = self.select(version).keys
+      if versions.length > 1
+        raise StandardError, "More than one version was matched: #{versions.inspect}"
+      elsif versions.empty?
+        return nil
+      else
+        self[versions.first]
+      end
+    end
+  end
+
+  # @param [String, Regexp] version Pattern we want to match in version.
+  # @return [Hash] Hash of `{version => changes}` for matched versions.
+  # @example changelog.select(/^Version 0.1.\d+$/)
+  # @author Jakub Stastny aka Botanicus
+  # @since 0.0.1
+  def select(pattern)
+    self.parse.select do |version, changes|
+      version.match(pattern)
+    end
+  end
+
+  # @return [Hash] Hash of `{version => changes}` for the whole changelog.
+  # @author Jakub Stastny aka Botanicus
+  # @since 0.0.1
+  def parse
+    @result ||= begin
+      lines = File.readlines(@path)
+      lines.inject([nil, Hash.new]) do |pair, line|
+        version, hash = pair
+        if line.match(/^=/)
+          version = line.chomp.sub(/^= /, "")
+          hash[version] = Array.new
+        elsif line.match(/^\s+\* /)
+          hash[version].push(line.chomp.sub(/^\s+\* /, ""))
+        else # skip empty lines
+        end
+        [version, hash]
+      end.last
+    end
+  end
+end

data/spec/changelog_spec.rb

@@ -0,0 +1,67 @@
+# encoding: utf-8
+
+require_relative "../lib/changelog"
+
+describe CHANGELOG do
+  before(:each) do
+    path = File.join(File.dirname(__FILE__), "data.txt")
+    @changelog = CHANGELOG.new(path)
+  end
+
+  describe ".new" do
+    it "should raise ArgumentError if given path doesn't exist" do
+      lambda { CHANGELOG.new("/a/b/c/d") }.should raise_error(ArgumentError)
+    end
+  end
+
+  describe "#versions" do
+    it "should returns all versions described in the CHANGELOG" do
+      versions = ["Version 0.0.1 Miracle Born",
+        "Version 0.1", "Version 0.1.1", "Version 0.1.2",
+        "Version 0.2.0", "Version 0.2.1"]
+      @changelog.versions.should eql(versions)
+    end
+  end
+
+  describe "#last_version_name" do
+    it "should returns name of the last version" do
+      @changelog.last_version_name.should eql("Version 0.2.1")
+    end
+  end
+
+  describe "#last_version_changes" do
+    it "should returns changes in the last version" do
+      @changelog.last_version_changes.should eql(["Cucumber Integration"])
+    end
+  end
+
+  describe "#[]" do
+    it "should returns changes for given version" do
+      @changelog["Version 0.2.1"].should eql(["Cucumber Integration"])
+    end
+
+    it "should returns changes for given pattern if only version is matched" do
+      @changelog[/Version 0.2.[12]/].should eql(["Cucumber Integration"])
+    end
+
+    it "should raise StandardError if more than one version is matched" do
+      lambda { @changelog[/Version 0.2.\d/] }.should raise_error(StandardError)
+    end
+  end
+
+  describe "#select" do
+    it "should be able to returns {version => [changes]} hash for all the versions matching given pattern" do
+      versions = ["Version 0.1", "Version 0.1.1", "Version 0.1.2"]
+      @changelog.select(/^Version 0.1/).keys.should eql(versions)
+    end
+  end
+
+  describe "#parse" do
+    it "should be able to parse CHANGELOG to {version => [changes]}" do
+      @changelog.parse.each do |key, value|
+        key.should be_kind_of(String)
+        value.should be_kind_of(Array)
+      end
+    end
+  end
+end

data/spec/data.txt

@@ -0,0 +1,27 @@
+= Version 0.0.1 Miracle Born
+  * Just basics
+
+= Version 0.1
+  * [FEATURE] environments support
+  * [SPECS]   All specs passing
+  * SimpleTemplater, RubyExts & CLI
+  * [FEATURE] Bundler Support
+  * [FEATURE] Rack-mount support
+
+= Version 0.1.1
+  * Tilt support
+  * Reworked generic views
+  * ImplicitRendering and ExplicitRendering mixins for using locals
+    vs. rendering in context of current controller instance
+
+= Version 0.1.2
+  * Sequel support
+  * Project generator renamed to stack generator
+  * Removed app and bigapp generators
+
+= Version 0.2.0
+  * Template helpers can work with paths relative to current template via ./path.html resp. ../path.html. All other paths are relative to the template paths.
+  * Use simple-logger as a default logger or standar logger if the simple-logger isn't installed.
+
+= Version 0.2.1
+  * Cucumber Integration

data/spec/spec.opts

@@ -0,0 +1,5 @@
+--colour
+--format
+progress
+--loadby
+mtime

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification 
+name: changelog
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- "Jakub \xC5\xA0\xC5\xA5astn\xC3\xBD aka Botanicus"
+autorequire: 
+bindir: bin
+cert_chain: 
+date: 2009-12-25 00:00:00 +00:00
+default_executable: 
+dependencies: []
+
+description: ""
+email: knava.bestvinensis@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/changelog.rb
+- spec/changelog_spec.rb
+- spec/data.txt
+- spec/spec.opts
+has_rdoc: true
+homepage: http://github.com/botanicus/changelog
+licenses: []
+
+post_install_message: |-
+  === Changes in the last version of CHANGELOG ===
+    - Basic functionality
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: changelog
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Simple CHANGELOG parser
+test_files: []
+