history 0.2.0 → 0.3.0

data/.ruby

@@ -54,7 +54,7 @@ title: History
 created: '2010-02-19'
 organization: Rubyworks
 summary: HISTORY and CHANGELOG parser
-version: 0.2.0
+version: 0.3.0
 description: ! 'History is a HISTORY file parser. It can parse common HISTORY file
   layouts
 
@@ -63,4 +63,4 @@ description: ! 'History is a HISTORY file parser. It can parse common HISTORY fi
   a number of things, in particular it can be used to generate tag messages
 
   and add pre-release change lists to release announcements.'
-date: '2012-05-25'
+date: '2012-05-27'

data/DEMO.md

@@ -68,7 +68,7 @@ The initializer takes the root directory for the project
 and looks for a file called +HISTORY+, optionally ending
 in an extension such as +.txt+ or +.rdoc+, etc.
 
-    history = History.find('tmp/example')
+    history = History.at('tmp/example')
 
 Now we should have an enumeration of each release entry in
 the HISTORY file.

data/HISTORY.md

@@ -1,5 +1,15 @@
 # RELEASE HISTORY
 
+## 0.3.0 / 2012-05-27
+
+New release makes the constructor interface more flexible, in part
+by making use of the Pathname library.
+
+Changes:
+
+* Improves constructor interface.
+
+
 ## 0.2.0 / 2012-05-25
 
 This the first usable release. There's actual code now ;)

data/demo/01_history.md

@@ -61,7 +61,7 @@ The initializer takes the root directory for the project
 and looks for a file called +HISTORY+, optionally ending
 in an extension such as +.txt+ or +.rdoc+, etc.
 
-    history = History.find('tmp/example')
+    history = History.at('tmp/example')
 
 Now we should have an enumeration of each release entry in
 the HISTORY file.

data/lib/history.rb

@@ -1,4 +1,4 @@
-#require 'history/core_ext'
+require 'pathname'
 require 'history/release'
 
 # The History class is a HISTORY file parser. It parses HISTORY files
@@ -38,25 +38,40 @@ class History
   # Convenience constant for `File::FNM_CASEFOLD`.
   CASEFOLD = File::FNM_CASEFOLD
 
-  #
-  def self.parse(text, opts={})
-    opts[:text] = text
-    new(opts[:file], opts)
+  # Parse history from given text.
+  def self.parse(text)
+    new(text.to_s)
   end
 
-  def self.text(text, opts={})
-    parse(text, opts)
+  # Read and parse history from given file.
+  def self.read(file)
+    new(Pathname.new(file))
   end
 
-  #
-  def self.file(file)
-    new(file)
+  # Lookup history file given a project root directory.
+  # If a history file is not present, assume a default
+  # file name of `HISTORY`.
+  def self.at(root=Dir.pwd)
+    if file = Dir.glob(File.join(root, DEFAULT_FILE), CASEFOLD).first
+      new(Pathname.new(file))
+    else
+      file = File.join(root, 'HISTORY')
+      new(:file=>file)
+    end
   end
 
-  #
+  # Alias for #at.
   def self.find(root=Dir.pwd)
-    file = Dir.glob(File.join(root, DEFAULT_FILE), CASEFOLD).first
-    new(file)
+    at(root)
+  end
+
+  # Does a HISTORY file exist?
+  def self.exist?(path=Dir.pwd)
+    if File.directory?(path)
+      Dir.glob(File.join(path, DEFAULT_FILE), CASEFOLD).first
+    else
+      File.exist?(path) ? path : false
+    end
   end
 
   # HISTORY file's path.
@@ -69,46 +84,50 @@ class History
   attr :releases
 
   # New History.
-  def initialize(file=nil, opts={})
-    if Hash === file
+  def initialize(io=nil, opts={})
+    if Hash === io
       opts = file
-      file = nil
+      io   = nil
     end
 
-    @file = file
-    @text = opts[:text]
+    @releases = []
 
-    if @file
-      # if file is given but no text, raise error if file not found
-      raise "file not found" unless File.exist?(@file) unless @text
+    case io
+    when String
+      parse(io)
+    when Pathname
+      @file = io
+      parse(io.read)
+    when File
+      @file = io.path
+      parse(io.read)
     else
-      @file = Dir.glob(DEFAULT_FILE, CASEFOLD).first || 'HISTORY'
+      parse(io.read)
     end
 
-    unless @text
-      @text = File.read(@file) if File.exist?(@file)
-    end
+    @file = opts[:file] if opts.key?(:file)
+  end
 
-    parse
+  # Does history file exist?
+  def exist?
+    File.file?(@file)
   end
 
-  # Read and parse the Histoy file.
-  def parse
-    @releases = []
-    entry = nil
-
-    if text
-      text.each_line do |line|
-        if HEADER_RE =~ line
-          @releases << Release.new(entry) if entry
-          entry = line
-        else
-          next unless entry
-          entry << line
-        end
+  # Parse History text.
+  def parse(text)
+    return unless text
+    releases, entry = [], nil
+    text.each_line do |line|
+      if HEADER_RE =~ line
+        releases << Release.new(entry) if entry
+        entry = line
+      else
+        next unless entry
+        entry << line
       end
-      @releases << Release.new(entry)
     end
+    releases << Release.new(entry)
+    @releases = releases
   end
 
   # Lookup release by version.
@@ -116,7 +135,7 @@ class History
     releases.find{ |r| r.version == version }
   end
 
-  # Returns first entry in releases list.
+  # Returns first entry in release list.
   def release
     releases.first
   end

data/lib/history.yml

@@ -54,7 +54,7 @@ title: History
 created: '2010-02-19'
 organization: Rubyworks
 summary: HISTORY and CHANGELOG parser
-version: 0.2.0
+version: 0.3.0
 description: ! 'History is a HISTORY file parser. It can parse common HISTORY file
   layouts
 
@@ -63,4 +63,4 @@ description: ! 'History is a HISTORY file parser. It can parse common HISTORY fi
   a number of things, in particular it can be used to generate tag messages
 
   and add pre-release change lists to release announcements.'
-date: '2012-05-25'
+date: '2012-05-27'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: history
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-25 00:00:00.000000000 Z
+date: 2012-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: detroit
-  requirement: &16961460 !ruby/object:Gem::Requirement
+  requirement: &16873300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16961460
+  version_requirements: *16873300
 - !ruby/object:Gem::Dependency
   name: qed
-  requirement: &16983160 !ruby/object:Gem::Requirement
+  requirement: &16871960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16983160
+  version_requirements: *16871960
 - !ruby/object:Gem::Dependency
   name: ae
-  requirement: &16979640 !ruby/object:Gem::Requirement
+  requirement: &16868240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16979640
+  version_requirements: *16868240
 description: ! 'History is a HISTORY file parser. It can parse common HISTORY file
   layouts