Empact-rails-plugin-package-task 0.1

data/MIT-LICENSE

@@ -0,0 +1,17 @@
+Copyright (c) 2006 by Zak Mandhro
+
+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/README.rdoc

@@ -0,0 +1,43 @@
+= Rails Plug-in Package Task
+
+RailsPluginPackageTask is a rake task designed to automate the publishing of
+Ruby on Rails plug-ins. The Rails plug-in installer _RecursiveHTTPFetcher_ makes
+certain assumptions about the web servers that does not hold through from
+server to server, for example:
+
+* Server generates an index page with links
+* All links to plug-in files are relative links
+* Folder links end with a forward slash (used to recurse)
+ 
+RubyForge web server is an example of where these assupmtions don't hold
+true. As a result, you can not simply copy your files to a web server
+and expect Rails HTTP plugin installer to just work.
+
+This Rake task helps fill the gap by complying to the plug-in scripts assumptions.
+Following the Rake package task conventions, it defines the "rails_plugin" task
+that recurses through your _package_files_, generates compliant index.html for
+each folder (that contains a file), and creates a directory structure that you
+can publish as a set for your plugin.
+
+== Example
+
+The following example uses the Rake::RailsPluginPackageTask to create
+the package. It then uses the Rake::SshDirPublisher to publish the plugin
+directory to RubyForge.
+
+   Rake::RailsPluginPackageTask.new(ProjectInfo[:name], ProjectInfo[:version]) do |p|
+     p.package_files = PluginPackageFiles
+     p.plugin_files = FileList["rails_plugin/**/*"]
+     p.extra_links = {"Project page"=>ProjectInfo[:homepage],
+       "Author: #{ProjectInfo[:author_name]}"=>ProjectInfo[:author_link]}
+     p.verbose = true
+   end
+   task :rails_plugin=>:clobber
+   
+   desc "Publish Ruby on Rails plug-in on RubyForge"
+   task :release_plugin=>:rails_plugin do |task|
+     pub = Rake::SshDirPublisher.new("#{RubyForgeConfig[:user_name]}@rubyforge.org",
+      "/var/www/gforge-projects/#{RubyForgeConfig[:unix_name]}",
+      "pkg/rails_plugin")
+     pub.upload()
+   end

data/Rakefile

@@ -0,0 +1,15 @@
+require 'rake/gempackagetask'
+require "rake/rdoctask"
+
+spec = eval(IO.read("rails-plugin-package-task.gemspec"))
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+Rake::RDocTask.new do |rd|
+  rd.rdoc_dir = "doc"
+  rd.rdoc_files.include("lib/**/*.rb")
+  rd.rdoc_files.include(spec.extra_rdoc_files)
+  rd.options = spec.rdoc_options
+end

data/lib/rails_plugin_package_task.rb

@@ -0,0 +1,150 @@
+#!/usr/bin/env ruby
+
+require 'rake'
+require 'rake/tasklib'
+
+module Rake
+  # RailsPluginPackageTask defines the "rails_plugin" task
+  # that recurses through your _package_files_, generates compliant index.html for
+  # each folder (that contains a file), and creates a directory structure that you
+  # can publish as a set for your plugin.
+  # 
+  # Noteworthy attributes:
+  # 
+  # [package_dir]  Directory to store the package. Default 'pkg/rails_plugin'
+  #   
+  # [package_dir]  Files to include in the plugin.
+  #   
+  # [extra_links]  Links to put on every generated index page. Can be a hash, e.g.
+  #                {"Home"=>"http://roxml.rubyforge.org"}, an array of strings or
+  #                a single string.
+  #                  
+  # [plugin_files]  Files to be placed in the root folder of the plug-in, e.g.
+  #                 init.rb. All files that are in the root of _package_dir_
+  #                 will also be placed in the root of the plug-in.
+  #                   
+  class RailsPluginPackageTask < TaskLib
+    # Name of plug-in or application
+    attr_accessor :name
+    # Version of plugin - distribution folder will be name_version
+    attr_accessor :version
+    # Directory used to store the package files (default is 'pkg/rails_plugin').
+    attr_accessor :package_dir
+    # Files to be stored in the package
+    attr_accessor :package_files
+    # Files to go into the root of the plug-in folder (e.g. init.rb)
+    attr_accessor :plugin_files
+    # Homepage for more information
+    attr_accessor :extra_links
+    # Verbose [true | false]
+    attr_accessor :verbose
+
+    # Create the "rails_plugin" task
+    def initialize(name=nil, version=nil)
+      init(name, version)
+      yield self if block_given?
+      define unless name.nil?
+    end
+
+    # Initialize with defaults
+    def init(name, version)
+      @name = name
+      @version = version
+      @extra_links = nil
+      @package_files = Rake::FileList.new
+      @plugin_files = Rake::FileList.new
+      @package_dir = 'pkg/rails_plugin'
+      @folders = {}
+      @verbose = false
+    end
+    
+    # Define the rails_plugin task
+    def define
+      desc "Create Ruby on Rails plug-in package"
+      task :rails_plugin do
+        @dest = "#@package_dir/#{@name}_#{@version}"
+        makedirs(@dest,:verbose=>false)
+        @plugin_files.each do |fn|
+          cp(fn, @dest,:verbose=>false)
+          add_file(File.basename(fn))
+        end
+        
+        @package_files.each do |fn|
+          puts ". #{fn}" if verbose
+          f = File.join(@dest, fn)
+          fdir = File.dirname(f)
+          unless File.exist?(fdir)
+            mkdir_p(fdir,:verbose=>false)
+            add_folder("#{fdir}/")
+          end
+          if File.directory?(fn)
+            mkdir_p(f,:verbose=>false)
+            add_folder("#{fn}/")
+          else
+            cp(fn, f, :verbose=>false)
+            add_file(fn)
+          end
+        end
+        
+        generate_index_files()
+      end
+    end
+
+    # Generate the index.html files
+    def generate_index_files
+      @folders.each do |folder, files|
+        puts " + Creating #{@dest}/#{folder}/index.html" if @verbose
+        File.open("#{@dest}/#{folder}/index.html", "w") do |index|
+          title = "Rails Plug-in for #@name #@version"
+          index.write("<html><head><title>#{title}</title></head>\n")
+          index.write("<body>\n")
+          index.write("<h2>#{title}</h2>\n")
+          extra_links = create_extra_links()
+          index.write("<p>#{extra_links}</p>\n") if extra_links          
+          files.each { |fn|
+            puts("  - Adding #{fn}") if @verbose
+            index.write("&nbsp;&nbsp;<a href=\"#{fn}\">#{fn}</a><br/>\n")
+          }
+          index.write("<hr size=\"1\"/><p style=\"font-size: x-small\">Generated with RailsPluginPackageTask<p>")
+          index.write("</body>\n")
+          index.write("</html>\n")
+        end
+      end
+    end
+            
+  private
+    # Add a file to the folders hash
+    def add_file(filename)
+      dir = File.dirname(filename).gsub("#{@dest}",".")
+      fn = File.basename(filename)
+      folder = @folders[dir] || @folders[dir]=[]
+      folder << fn
+    end
+
+    # Add a folder to the folders hash
+    def add_folder(folder_name)
+      dir = File.dirname(folder_name).gsub("#{@dest}",".").gsub("./","")
+      fn = File.basename(folder_name) + "/"
+      folder = @folders[dir] || @folders[dir]=[]
+      folder << fn
+    end
+    
+    # Create the anchor tag for extra links
+    def create_extra_links
+      return nil unless @extra_links
+      x_links = ""
+      if (@extra_links.class==Hash)
+        @extra_links.each do |k,v|
+          x_links << "<a href=\"#{v}\">#{k}</a>&nbsp;"
+        end
+      elsif (@extra_links.class==Array)
+        @extra_links.each do |link|
+          x_links << "<a href=\"#{link}\">#{link}</a>&nbsp;"
+        end      
+      else
+        x_links = "<a href=\"#{@extra_links.to_s}\">#{@extra_links.to_s}</a>"
+      end
+      return x_links
+    end
+  end
+end

data/rails-plugin-package-task.gemspec

@@ -0,0 +1,21 @@
+Gem::Specification.new do |s|
+  s.name     = "rails-plugin-package-task"
+  s.version  = "0.1"
+  s.date     = "2008-08-27"
+  s.summary  = "Automates the publishing of Rail plug-ins"
+  s.email    = "mandhro@yahoo.com"
+  s.homepage = "http://roxml.rubyforge.org/"
+  s.description = "Designed to automate the publishing of Rail plug-ins. Extracted from ROXML CVS."
+  s.has_rdoc = true
+  s.author   = "Zak Mandhro"
+  s.files    = ["MIT-LICENSE",
+        "Rakefile",
+        "README.rdoc", 
+        "rails-plugin-package-task.gemspec", 
+        "lib/rails_plugin_package_task.rb"]
+  s.require_path = 'lib'
+  s.extra_rdoc_files = ["README.rdoc", 'MIT-LICENSE']
+  s.rdoc_options << '--line-numbers' << '--inline-source' <<
+                    '--title' << 'Rails Plug-in Package Task' <<
+                    '--main' << 'README.rdoc'
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: Empact-rails-plugin-package-task
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+platform: ruby
+authors: 
+- Zak Mandhro
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-08-27 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Designed to automate the publishing of Rail plug-ins. Extracted from ROXML CVS.
+email: mandhro@yahoo.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- MIT-LICENSE
+files: 
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+- rails-plugin-package-task.gemspec
+- lib/rails_plugin_package_task.rb
+has_rdoc: true
+homepage: http://roxml.rubyforge.org/
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Rails Plug-in Package Task
+- --main
+- README.rdoc
+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: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Automates the publishing of Rail plug-ins
+test_files: []
+