railslog 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in railslog.gemspec
+gemspec

data/README.md

@@ -0,0 +1,31 @@
+# Railslog
+
+API for working with Rails CHANGELOG files. It grabs Rails CHANGELOGs from teh githubs and parses it to give you a Changelog object which has many Releases, which have many Entries.
+
+## Install
+
+    gem install railslog
+
+## Use
+
+    require 'railslog'
+
+    changelog = Railslog.fetch('activerecord') # => <Railslog::Changelog releases:77>
+
+    release = changelog.releases[1] # => <Railslog::Release version:3.0.7 date:2011-04-18>
+    release.date # => #<Date: 2011-04-18 (4911339/2,0,2299161)>
+
+    entry = release.entries.first # => <Railslog::Entry author:Durran Jordan text:Destroying records via nes...>
+    entry.author # => "Durran Jordan"
+    entry.text # => "Destroying records via nested attributes works independent of reject_if LH #6006 [Durran Jordan]\n"
+
+## License
+
+Copyright © 2011 Maxim Chernyak
+
+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/Rakefile

@@ -0,0 +1,13 @@
+#!/usr/bin/env rake
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/test*.rb']
+end
+
+task :default => :test

data/lib/railslog.rb

@@ -0,0 +1,107 @@
+require 'date'
+require 'open-uri'
+
+module Railslog
+
+  module_function
+
+  def fetch(package)
+    Changelog.new(open("https://github.com/rails/rails/raw/master/#{package}/CHANGELOG").read)
+  end
+
+  module Helper
+    module_function
+
+    def normalize(text)
+      text.strip.gsub(/(?:^\s*\*|\s*\*$)/, '').strip
+    end
+  end
+
+  class Changelog
+    attr_reader :releases
+
+    def initialize(text)
+      @releases = []
+
+      current_release = nil
+      current_entry = nil
+
+      text.each_line do |line|
+        if Release.recognize?(line)
+          current_release = Release.new(line)
+          @releases << current_release
+        elsif Entry.recognize?(line)
+          current_entry = Entry.new(line)
+          current_release ||= Release.new('Unreleased')
+          current_release.add_entry(current_entry)
+        elsif !current_entry.nil?
+          current_entry.add_line(line)
+        end
+      end
+    end
+
+    def to_s
+      "<#{self.class} releases:#{@releases.size}>"
+    end
+  end
+
+  class Release
+    attr_reader :title, :version, :date, :entries
+
+    def self.recognize?(line)
+      line =~ /^\*\S/
+    end
+
+    def initialize(release_title)
+      @title = Helper.normalize(release_title)
+      @version = @title[/\d+\.\d+(?:\.\d+)?/]
+      @date = Date.parse(@title[/\(([^\)]+)\)/, 1]) rescue nil
+    end
+
+    def add_entry(entry)
+      @entries ||= []
+      @entries << entry
+    end
+
+    def to_s
+      "<#{self.class} version:#{@version} date:#{@date}>"
+    end
+  end
+
+  class Entry
+    attr_reader :text, :author
+
+    def self.recognize?(line)
+      line =~ /^\*\s+/
+    end
+
+    def initialize(entry_text)
+      @text = Helper.normalize(entry_text)
+      @author = parse_author(entry_text)
+    end
+
+    def add_line(text)
+      text.gsub!(/[\r\n]/, '')
+      @text << "\n#{text}"
+      @author = parse_author(text) || @author
+    end
+
+    def to_s
+      "<#{self.class} author:#{@author} text:#{truncated_text}>"
+    end
+
+    private
+    def parse_author(line)
+      line[/\[([^#\:\?]+)\][^\]]*$/, 1].strip rescue nil
+    end
+
+    def truncated_text
+      if @text.size > 30
+        "#{@text[0, 26]}..."
+      else
+        @text
+      end
+    end
+  end
+
+end

data/lib/railslog/version.rb

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

data/railslog.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "railslog/version"
+
+Gem::Specification.new do |s|
+  s.name        = "railslog"
+  s.version     = Railslog::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Maxim Chernyak"]
+  s.email       = ["max@bitsonnet.com"]
+  s.homepage    = "http://github.com/maxim/railslog"
+  s.summary     = %q{A simple client for Rails CHANGELOG files stored on github.}
+  s.description = %q{Provides a convenient API for accessing Rails CHANGELOG files.}
+
+  s.rubyforge_project = "railslog"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency 'turn'
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'test/unit'
+require 'railslog'
+require 'turn'

data/test/test_railslog.rb

@@ -0,0 +1,203 @@
+require 'test_helper'
+
+
+module Railslog
+
+  class TestChangelog < Test::Unit::TestCase
+    def setup
+      @changelog = Changelog.new <<-TEXT
+*1.3.2* (February 5th, 2007)
+
+* Deprecate server_settings renaming it to smtp_settings,  add sendmail_settings to allow you to override the arguments to and location of the sendmail executable. [Michael Koziarski]
+
+
+*1.3.1* (January 16th, 2007)
+
+* Depend on Action Pack 1.13.1
+
+
+*1.3.0* (January 16th, 2007)
+
+* Make mime version default to 1.0. closes #2323 [ror@andreas-s.net]
+
+* Make sure quoted-printable text is decoded correctly when only portions of the text are encoded. closes #3154. [jon@siliconcircus.com]
+
+* Make sure DOS newlines in quoted-printable text are normalized to unix newlines before unquoting. closes #4166 and #4452. [Jamis Buck]
+
+    foo bar baz
+    testing multiline entry
+
+* Fixed that iconv decoding should catch InvalidEncoding #3153 [jon@siliconcircus.com]
+      TEXT
+    end
+
+    def test_parses_releases
+      assert_equal 3, @changelog.releases.size
+      assert_equal 1, @changelog.releases[0].entries.size
+      assert_equal 1, @changelog.releases[1].entries.size
+      assert_equal 4, @changelog.releases[2].entries.size
+    end
+
+    def test_returns_pretty_to_s
+      assert_equal '<Railslog::Changelog releases:3>', @changelog.to_s
+    end
+  end
+
+  class TestRelease < Test::Unit::TestCase
+    def setup
+      @release = Release.new('*Rails 3.0.4 (February 8, 2011)*')
+    end
+
+    def test_normalizes_release_title
+      assert_equal 'Rails 3.0.4 (February 8, 2011)', @release.title
+    end
+
+    def test_parses_version_from_release_title
+      assert_equal '3.0.4', @release.version
+    end
+
+    def test_parses_date_from_release_title
+      assert_equal Date.parse('2011-02-08'), @release.date
+    end
+
+    def test_sets_date_to_nil_if_cant_parse
+      assert_nil Release.new('*Rails 3.0.4*').date
+    end
+
+    def test_maintains_array_of_entries
+      @release.add_entry(entry = Entry.new('foo'))
+      assert_includes @release.entries, entry
+    end
+
+    def test_recognizes_a_release_line
+      assert Release.recognize?('*Rails 3.0.4 (February 8, 2011)*')
+      assert Release.recognize?('*1.3.1* (January 16th, 2007)')
+    end
+
+    def test_does_not_recognize_an_entry_line
+      refute Release.recognize?('* Don\'t allow i18n to change the minor version, version now set to ~> 0.5.0 [Santiago Pastorino]')
+      refute Release.recognize?('* Don\'t allow i18n to change the minor version, version now set to ~> 0.5.0')
+    end
+
+    def test_returns_pretty_to_s
+      assert_equal '<Railslog::Release version:3.0.4 date:2011-02-08>', @release.to_s
+    end
+  end
+
+  class TestEntry < Test::Unit::TestCase
+    def setup
+      @entry = Entry.new('* Don\'t allow i18n to change the minor version, version now set to ~> 0.5.0 [Santiago Pastorino]')
+    end
+
+    def test_normalizes_entry_text
+      assert_equal 'Don\'t allow i18n to change the minor version, version now set to ~> 0.5.0 [Santiago Pastorino]', @entry.text
+    end
+
+    def test_parses_entry_author
+      assert_equal 'Santiago Pastorino', @entry.author
+    end
+
+    def test_parses_entry_author_in_another_line
+      @entry.add_line('[foo bar]')
+      assert_equal 'foo bar', @entry.author
+    end
+
+    def test_sets_author_to_nil_if_missing
+      entry = Entry.new('* Don\'t allow i18n to change the minor version, version now set to ~> 0.5.0 ')
+      assert_nil entry.author
+    end
+
+    def test_recognizes_an_entry_start_line
+      assert Entry.recognize?('* foobar')
+    end
+
+    def test_does_not_recognize_a_release_line
+      refute Entry.recognize?('*1.3.1* (January 16th, 2007)')
+    end
+
+    def test_does_not_recognize_an_entry_body_line
+      refute Entry.recognize?('    def iso_charset(recipient')
+    end
+
+    def test_adds_line_to_entry
+      @entry.add_line('foobar')
+      assert_equal <<-TEXT.strip, @entry.text
+Don\'t allow i18n to change the minor version, version now set to ~> 0.5.0 [Santiago Pastorino]
+foobar
+      TEXT
+    end
+
+    def test_returns_pretty_to_s
+      assert_equal '<Railslog::Entry author:Santiago Pastorino text:Don\'t allow i18n to change...>', @entry.to_s
+    end
+
+    def test_normalizes_multiline_entry_text
+      @entry = Entry.new <<-TEXT
+* Added support for charsets for both subject and body. The default charset is now UTF-8 #673 [Jamis Buck]. Examples:
+
+    def iso_charset(recipient)
+      @recipients = recipient
+      @subject    = "testing iso charsets"
+      @from       = "system@loudthinking.com"
+      @body       = "Nothing to see here."
+      @charset    = "iso-8859-1"
+    end
+
+    def unencoded_subject(recipient)
+      @recipients = recipient
+      @subject    = "testing unencoded subject"
+      @from       = "system@loudthinking.com"
+      @body       = "Nothing to see here."
+      @encode_subject = false
+      @charset    = "iso-8859-1"
+    end
+      TEXT
+
+      assert_equal <<-TEXT.strip, @entry.text
+Added support for charsets for both subject and body. The default charset is now UTF-8 #673 [Jamis Buck]. Examples:
+
+    def iso_charset(recipient)
+      @recipients = recipient
+      @subject    = "testing iso charsets"
+      @from       = "system@loudthinking.com"
+      @body       = "Nothing to see here."
+      @charset    = "iso-8859-1"
+    end
+
+    def unencoded_subject(recipient)
+      @recipients = recipient
+      @subject    = "testing unencoded subject"
+      @from       = "system@loudthinking.com"
+      @body       = "Nothing to see here."
+      @encode_subject = false
+      @charset    = "iso-8859-1"
+    end
+      TEXT
+    end
+
+    def test_parses_multiline_entry_author
+      @entry = Entry.new <<-TEXT
+* Added support for charsets for both subject and body. The default charset is now UTF-8 #673 [Jamis Buck]. Examples:
+
+    def iso_charset(recipient)
+      @recipients = recipient
+      @subject    = "testing iso charsets"
+      @from       = "system@loudthinking.com"
+      @body       = "Nothing to see here."
+      @charset    = "iso-8859-1"
+    end
+
+    def unencoded_subject(recipient)
+      @recipients = recipient
+      @subject    = "testing unencoded subject"
+      @from       = "system@loudthinking.com"
+      @body       = "Nothing to see here."
+      @encode_subject = false
+      @charset    = "iso-8859-1"
+    end
+      TEXT
+
+      assert_equal 'Jamis Buck', @entry.author
+    end
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: railslog
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Maxim Chernyak
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-24 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: turn
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: Provides a convenient API for accessing Rails CHANGELOG files.
+email: 
+- max@bitsonnet.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/railslog.rb
+- lib/railslog/version.rb
+- railslog.gemspec
+- test/test_helper.rb
+- test/test_railslog.rb
+has_rdoc: true
+homepage: http://github.com/maxim/railslog
+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: railslog
+rubygems_version: 1.6.0
+signing_key: 
+specification_version: 3
+summary: A simple client for Rails CHANGELOG files stored on github.
+test_files: 
+- test/test_helper.rb
+- test/test_railslog.rb