svn2rss 0.1.0

data/Changelog

@@ -0,0 +1,9 @@
+==  0.1.0 09/23/2007
+
+* Created a basic lib with two methods parse the SVN log, and create the feed.
+* Created tests to test the method.
+* Created a little example with a WEBrick server.
+* Created another example with a FTP push.
+* Tested against Google Reader.
+* Added <br/> tags in the description field to have an usable output.
+* Fixed a bug: when no diff is available, don't try to trim it to be HTML-like.

data/History.txt

@@ -0,0 +1,9 @@
+==  0.1.0 09/23/2007
+
+* Created a basic lib with two methods parse the SVN log, and create the feed.
+* Created tests to test the method.
+* Created a little example with a WEBrick server.
+* Created another example with a FTP push.
+* Tested against Google Reader.
+* Added <br/> tags in the description field to have an usable output.
+* Fixed a bug: when no diff is available, don't try to trim it to be HTML-like.

data/LICENSE

@@ -0,0 +1,204 @@
+Copyright (c) 2007 Antoine Toulme
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+ 

data/Manifest.txt

@@ -0,0 +1,10 @@
+Changelog
+History.txt
+LICENSE
+Manifest.txt
+README
+Rakefile
+lib/svn2rss.rb
+lib/svn2rss/version.rb
+README
+README.txt

data/README

@@ -0,0 +1,7 @@
+svn2rss Copyright 2007 Antoine Toulme
+
+svn2rss is a handy lib that produces a feed out of the svn commits.
+
+You can follow its activity on the mailing list: svn2rss@googlegroups.com.
+
+Hope to see you there soon!

data/README.txt

@@ -0,0 +1,7 @@
+svn2rss Copyright 2007 Antoine Toulme
+
+svn2rss is a handy lib that produces a feed out of the svn commits.
+
+You can follow its activity on the mailing list: svn2rss@googlegroups.com.
+
+Hope to see you there soon!

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/lib/svn2rss.rb

@@ -0,0 +1,95 @@
+# Copyright Antoine Toulme 2007
+
+require "rubygems"
+require  "xmlsimple"
+require "builder"
+# The Svn2rss module will contain all the needed methods to open a RSS feed and examine it.
+# 
+module Svn2rss
+ 
+  # The svn2rss current version, should be parsed from the information files.
+  require "svn2rss/version.rb"
+  ENV['SVN2RSS_VERSION'] = Svn2rss::VERSION::STRING
+ 
+  # The LogEntry class represents an entry of the log.
+  class LogEntry
+    attr_accessor "revision", "author", "date", "msg", "diff"
+  end
+
+  # Parses the SVN log located at the given URL.
+  # You cans et some options:
+  # verbose: the function will have more output
+  # limit: the number of items that should be parsed.
+  # 
+  # Example:
+  #
+  # parseSvnLog("http://svn2rss.rubyforge.org/svn2rss/svn", :verbose => true, :limit => 2) 
+  def parseSvnLog(url, limit = 10, verbose = false)
+    batchcommand = "svn log " + url
+    batchcommand += " --limit " + limit.to_s
+    batchcommand += " --xml" # easier to parse
+    puts batchcommand if verbose
+    log = XmlSimple.xml_in(%x[#{batchcommand}])
+    entries = Array.new
+    log['logentry'].each do |entry|
+      logEntry = LogEntry.new
+      logEntry.revision = entry['revision']
+      logEntry.author = entry['author'][0]
+      logEntry.date = entry['date'][0]
+      logEntry.msg = entry['msg'][0]
+      previousRevision = logEntry.revision.to_i
+      previousRevision = previousRevision - 1
+      puts "svn diff #{url} -r #{logEntry.revision}:#{previousRevision.to_s}" if verbose
+      logEntry.diff = %x[svn diff #{url} -r #{logEntry.revision}:#{previousRevision.to_s}] if previousRevision > 0
+      if (logEntry.diff)
+        logEntry.diff.gsub!(/</,"&lt;" ) # transform the current tag brackets by lt and gt so that they will be rendered with amp, and shown in the feed.
+        logEntry.diff.gsub!(/>/,"&gt;" )
+        logEntry.diff.gsub!(/\n/,"<br/>\n" ) # have the br tags with brackets, so that it will be interpreted by Google Reader.
+        puts logEntry.diff if verbose
+      end
+      entries << logEntry
+    end
+    entries 
+  end
+
+  def createRSSFeed(log, feed_url, feed_title, feed_description, language, managingEditor, webmaster, verbose = nil)
+    raise Exception("The log variable is null!") if log.nil?
+    puts "Starting..." if verbose
+    xml = Builder::XmlMarkup.new(:indent => 2)
+    xml.instruct!
+    xml.rss("version" => "2.0", "xmlns:dc" => "http://purl.org/dc/elements/1.1/") do
+      xml.channel do
+        xml.title feed_title
+        xml.link feed_url
+        xml.description feed_description
+        xml.language language
+        xml.pubDate Time.parse(Time.now.to_s).rfc822
+        xml.lastBuildDate Time.parse(Time.now.to_s).rfc822 
+        xml.docs "http://cyber.law.harvard.edu/rss/rss.html"
+        xml.generator "svn2rss #{ENV['SVN2RSS_VERSION']}"
+        xml.managingEditor managingEditor
+        xml.webMaster webmaster
+
+        guid = feed_url
+        guid << "/" if !/\/$/.match(guid)
+        puts "Created the channel" if verbose
+        for entry in log
+          xml.item do
+            xml.title "Revision #{entry.revision} by #{entry.author}: #{entry.msg}"
+            xml.link guid + "#" + entry.revision
+            if entry.diff 
+              xml.description entry.diff
+            else
+              xml.description "No diff available" 
+            end
+            xml.pubDate Time.parse(entry.date).rfc822
+            xml.guid guid + "#" + entry.revision
+            puts "Created an entry" if verbose
+          end
+        end
+      end
+    end
+    puts xml.target! if verbose
+    xml.target!
+  end
+end

data/lib/svn2rss/version.rb

@@ -0,0 +1,9 @@
+module Svn2rss #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.4
+specification_version: 1
+name: svn2rss
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+date: 2007-09-23 00:00:00 -07:00
+summary: Svn2Rss, rssifying your svn commits.
+require_paths: 
+- lib
+email: antoine@lunar-ocean.com
+homepage: http://svn2rss.rubyforge.org
+rubyforge_project: svn2rss
+description: Svn2Rss, rssifying your svn commits.
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Antoine Toulme
+files: 
+- Changelog
+- History.txt
+- LICENSE
+- Manifest.txt
+- README
+- Rakefile
+- lib/svn2rss.rb
+- lib/svn2rss/version.rb
+- README.txt
+test_files: []
+
+rdoc_options: 
+- --main
+- README.txt
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+