xforge 0.1.9 → 0.2.0

data/CHANGES

@@ -1,5 +1,13 @@
 = XForge Changelog
 
+== Version 0.2.0
+
+First stable release of the XForge QRS.
+
+* Renamed Project.name to Project.unix_name
+* Wrote better documentation
+* Included CVS tagging in the Rakefile
+
 == Version 0.1.9
 
 This release adds more functionality for news publishing

data/README

@@ -1,17 +1,20 @@
 = XForge
 
-This package contains XForge, a simple library to interact with RubyForge,
-SourceForge, GForge or other SourceForge clones.
+XForge is a Quick Release System (QRS) for RubyForge, SourceForge and other SourceForge clones. XForge also allows users to query SCM information and other metadata about hosted projects.
 
 XForge has the following features:
 
 * Look up projects by unix name (no need to worry about group_id or package_id).
 
-* Upload new releases (with multiple files if desired).
+* Create/Upload new releases (with multiple files if desired).
 
-* Rake integration.
+* Rake integration (use XForge from Rake scripts).
 
-* Automatically create RSCM (http://rscm.rubyforge.org) objects from projects.
+* Query SCM meta information (using RSCM - http://rscm.rubyforge.org).
+
+* Publish news items about a project.
+
+* Query home page URLs for a project.
 
 == Download/Installation
 
@@ -27,7 +30,7 @@ Download and install XForge with the following.
 
 == Usage
 
-See XForge and Rake::XForge::Release.
+See XForge, Rake::XForge::Release and Rake::XForge::NewsPublisher.
 
 ---
 

data/Rakefile

@@ -24,7 +24,7 @@ require 'rake/rdoctask'
 #
 # REMEMBER TO KEEP PKG_VERSION IN SYNC WITH CHANGELOG
 PKG_NAME = "xforge"
-PKG_VERSION = "0.1.9"
+PKG_VERSION = "0.2.0"
 PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
 PKG_FILES = FileList[
   '[A-Z]*',
@@ -117,7 +117,7 @@ task :todo do
   egrep /#.*(FIXME|TODO|TBD)/
 end
 
-task :release => [:release_files, :publish_doc, :publish_news]
+task :release => [:release_files, :publish_doc, :publish_news, :tag]
 
 task :publish_doc => [:rdoc] do
   publisher = Rake::RubyForgePublisher.new(PKG_NAME, ENV['RUBYFORGE_USER'])
@@ -152,3 +152,10 @@ task :publish_news => [:gem] do
     news.password = ENV['RUBYFORGE_PASSWORD']
   end
 end
+
+desc "Tag all the CVS files with the latest release number (REL=x.y.z)"
+task :tag do
+  reltag = "REL_#{PKG_VERSION.gsub(/\./, '_')}"
+  puts "Tagging CVS with [#{reltag}]"
+  sh %{cvs tag #{reltag}}
+end

data/lib/rake/contrib/xforge/base.rb

@@ -5,8 +5,8 @@ module Rake
     class Base
       attr_writer :user_name, :password
 
-      def initialize(project_name, host=::XForge::RubyForge.new)
-        @project_name = project_name
+      def initialize(project_unix_name, host=::XForge::RubyForge.new)
+        @project_unix_name = project_unix_name
         @host = host
 
         set_defaults

data/lib/rake/contrib/xforge/news_publisher.rb

@@ -27,7 +27,7 @@ module Rake
       end
 
       def execute
-        project = @host.project(@project_name)
+        project = @host.project(@project_unix_name)
         u = user_name
         session = project.login(u, password)
         session.publish_news(@subject, @details)

data/lib/rake/contrib/xforge/release.rb

@@ -71,7 +71,7 @@ module Rake
       end
       
       def execute
-        project = @host.project(@project_name)
+        project = @host.project(@project_unix_name)
         u = user_name
         session = project.login(u, password)
         session.release(@release_name, @files, @release_notes, @release_changes)

data/lib/scm_web/view_cvs.rb

@@ -20,7 +20,7 @@ module ScmWeb
               unless(mod == "CVSROOT")
                 scm = RSCM::Cvs.new
                 scm.root = ":pserver:anonymous@#{project.host.cvs_host_name}:#{project.host.cvs_path}/#{mod}"
-                scm.mod = project.name
+                scm.mod = project.unix_name
                 @scms << scm
               end
             end
@@ -40,7 +40,7 @@ module ScmWeb
       uri_spec = @uri_specs[type]
       raise "No uri_spec for #{type}" unless uri_spec
 
-      project_name = project.name
+      project_unix_name = project.unix_name
       revision = options[:revision]
       eval("\"#{uri_spec}\"", binding)
     end

data/lib/xforge/host.rb

@@ -1,16 +1,26 @@
 module XForge
-  # A Host represents a proxy to a server
+  # A Host represents a proxy to a server. Most of the time
+  # you don't want to use this class directly, but rather one
+  # of its subclasses. Example:
+  #
+  #   require 'xforge'
+  #
+  #   rubyforge = XForge::RubyForge.new
+  #   xforge = rubyforge.project('xforge')
+  #   session = xforge.login(my_user, my_password)
+  #   session.release(["pkg/xforge-0.1.gem"], "XForge-0.1")
+  #  
   class Host
     attr_reader :name
 
-    # Create a new Host proxy located at +name+.
+    # Create a new Host proxy located at IP +name+.
     def initialize(name)
       @name = name
     end
 
-    # Get access to 
-    def project(name)
-      Project.new(self, name)
+    # Returns the Project with the given +unix_name+.
+    def project(unix_name)
+      Project.new(self, unix_name)
     end
   end
 end

data/lib/xforge/project.rb

@@ -7,17 +7,18 @@ module XForge
   # A Project is an interface to a hosted project.
   class Project
 
-    attr_reader :host, :name
+    attr_reader :host, :unix_name
 
-    def initialize(host, name)
+    def initialize(host, unix_name)
       @host = host
-      @name = name
+      @unix_name = unix_name
     end
 
     # Logs in and returns a Session
     def login(user_name, password)
       http = Net::HTTP.new(@host.name, host.login_port)
       
+      # Can't get this to work, so login doesn't work on SourceForge yet!
       # http://www.ruby-lang.org/ja/man/index.cgi?cmd=view;name=net%2Fhttps.rb
       if(host.login_port == 443)
         http.use_ssl = true
@@ -57,7 +58,7 @@ module XForge
     end
     
     def project_uri
-      "http://#{@host.name}/projects/#{@name}/"
+      "http://#{@host.name}/projects/#{@unix_name}/"
     end
     
     # The home page of this project

data/lib/xforge/rubyforge.rb

@@ -1,7 +1,7 @@
 module XForge
   class RubyForge < Host
     VIEW_CVS = "http://rubyforge.org/cgi-bin/viewcvs.cgi/"
-    PATH_CVSROOT = "\#{path}?cvsroot=\#{project_name}"
+    PATH_CVSROOT = "\#{path}?cvsroot=\#{project_unix_name}"
     PATH_CVSROOT_REV = "#{PATH_CVSROOT}&rev=\#{revision}"
     
     OVERVIEW = "#{VIEW_CVS}#{PATH_CVSROOT}"
@@ -25,7 +25,7 @@ module XForge
     end
 
     def scm_web(project)
-      module_regexp = /href=\"(\w+)\/\?cvsroot=#{project.name}/
+      module_regexp = /href=\"(\w+)\/\?cvsroot=#{project.unix_name}/
       ::ScmWeb::ViewCvs.new({:overview => OVERVIEW, :raw => RAW, :html => HTML}, project, module_regexp)
     end
 

data/lib/xforge/session.rb

@@ -117,9 +117,16 @@ module XForge
           raise("Couldn't get release id") unless release_id
         end
       end
+      puts "Done!"
     end
     
     def publish_news(subject, details)
+      puts "About to publish news"
+      puts "Subject: '#{subject}'"
+      puts "Details:"
+      puts details
+      puts ""
+      
       release_response = Net::HTTP.start(@host.name, 80) do |http|
         query_hash = {
           "group_id" => @project.group_id,
@@ -134,7 +141,9 @@ module XForge
           "Content-Type" => "multipart/form-data"
         )
         http.post(target + query(query_hash), "", headers)
+
       end
+      puts "Done!"
     end
 
   private

data/lib/xforge/sourceforge.rb

@@ -1,7 +1,7 @@
 module XForge
   class SourceForge < Host
     VIEW_CVS = "http://cvs.sourceforge.net/viewcvs.py/"
-    PROJECT_PATH = "\#{project_name}/\#{path}"
+    PROJECT_PATH = "\#{project_unix_name}/\#{path}"
     REV = "rev=\#{revision}"
 
     OVERVIEW = "#{VIEW_CVS}#{PROJECT_PATH}"
@@ -25,7 +25,7 @@ module XForge
     end
 
     def scm_web(project)
-      module_regexp = /viewcvs\.py\/#{project.name}\/(\w+)\//
+      module_regexp = /viewcvs\.py\/#{project.unix_name}\/(\w+)\//
       ::ScmWeb::ViewCvs.new({:overview => OVERVIEW, :raw => RAW, :html => HTML}, project, module_regexp)
     end
 

metadata

@@ -3,7 +3,7 @@ rubygems_version: 0.8.8
 specification_version: 1
 name: xforge
 version: !ruby/object:Gem::Version 
-  version: 0.1.9
+  version: 0.2.0
 date: 2005-08-14
 summary: Ruby based make-like utility.
 require_paths: