rote 0.1.0 → 0.1.2

data/README

@@ -2,14 +2,13 @@
 
 == What is this?
 
-Rote is a simple page-based template system for your static website that was 
-written to make it easier to author and maintain non-dynamic websites and 
-offline documentation. Rote provides a simple commandline or 
-Rake [http://rake.rubyforge.org] based build for your pages, with page 
-rendering (optionally supporting Textile and Markdown with 
-RedCloth [http://redcloth.rubyforge.org/] and ruby code with
-ERB [http://www.ruby-doc.org/stdlib/libdoc/erb/rdoc/classes/ERB.html]), layout,
-and general documentation / website build tasks.
+Rote is a simple page-based template system that was written to make it
+easier to author and maintain non-dynamic websites and offline documentation. 
+Rote provides a simple commandline or Rake [http://rake.rubyforge.org] based 
+build for your pages, with page rendering (optionally supporting Textile, 
+Markdown, and embedded Ruby code with RedCloth [http://redcloth.rubyforge.org/]
+and ERB [http://www.ruby-doc.org/stdlib/libdoc/erb/rdoc/classes/ERB.html]), 
+layout, and general documentation / website build tasks.
 
 == Should I download it?
 
@@ -51,43 +50,53 @@ Rote uses the following (versions are as per my development environment,
 you may find you can use older versions, you may not).
 	
 * Ruby 1.8.3 ('yum install ruby' on Fedora 4)
-* RubyGems 0.8.11 (http://rubyforge.org/frs/?group_id=126)
 * Rake 0.6.2 ('gem install rake')
 * RedCloth 3.0.4 ('gem install RedCloth')
 
-== How do I install it?
+RubyGems (http://rubyforge.org/frs/?group_id=126) is *highly recommended*,
+and makes for not only an easier install but a cleaner library path.
+Rote is tested with Gems 0.8.11.
 
-Set it up somewhere warm. At the moment, the standard install.rb is broken,
-and so disabled - you will need to install Rote into it's own directory
-(I know, I know). DONT modify your path - it's what symlinks are for.
-If you use a symlink you'll probaby need to point ROTE_HOME to the install
-directory as well. With that done, you should be able to run 
+== How do I install it ... 
 
-	rote --version
+=== ... with RubyGems?
+
+If you have RubyGems, you can install Rote by simply issuing the command:
+
+	gem install rote 
+	
+Which should download the latest version and install it, including
+the 'rote' wrapper script and man pages.	If you experience problems,
+or wish to perform an offline installation, then simply download the 
+.gem file from the FRS, and execute the gem command from within the same
+directory.
+
+=== ... using install.rb?
+
+If you don't have RubyGems, you can install from one of the tarball or zip
+packages, using the following command:
+
+	ruby install.rb
 	
-to verify that the command-line wrapper is working. If you wish to use the 
-tasks in your own Rakefiles, you will need to modify the library load path. 
-This can be done using the --libdir option to Rake, or alternatively by adding
-something like the following _before_ the +require+ '+rote+' line:
+from the unpacked root directory. This will copy the libaries to the 
+appropriate	place, and set up the rote wrapper script and so on.
+
+=== ... in my own way?
+
+If you're one of those people who just has to be different, then you'll be
+pleased to know you can carry on that tradition, and place the files
+pretty much where you like. Simply point an environment variable, 
+ROTE_LIB, at the top-level lib directory (where rote.rb is found), and
+ensure rote (or a symlink) is visible in your path. 
 
-	$: << "#{ENV['ROTE_HOME']}/lib"
+=== Did it work?
+
+With that done, you should be able to run 
+
+	rote --version
 	
-This line does of course place restrictions on the build environment, in that
-Rote will have to be properly installed and configured with the ROTE_HOME
-environment variable.
-
-Obviously once we get into releases, Rote will of course be distributed via
-RubyGems, allowing much of this to be transparent for the user if you have
-Gems. Fixing the proper installation is a priority, and will come soon. 
-
-*Note*: Currently, the +rote+ script supports usage with custom Rakefiles as
-well as the built-in command-line setup. If +rote+ is run from a directory 
-that contains an existing Rakefile, it will use that instead of the built-in
-one. It will *not* search parent directories for a Rakefile.
-
-This feature exists to support custom Rakefiles without libpath twiddling,
-but should be considered a hack that will probably disappear from a (not
-too distant) future version.
+to verify that the command-line wrapper is working. You should of course see
+the version number of your Rote installation.
  
 == How do I use it?
 
@@ -137,7 +146,7 @@ Now try:
 
 	rote --tasks
 	
-to get a list of valid tasks, or 
+to get a list of valid tasks, or:
 	
 	rote --usage
 	
@@ -151,7 +160,7 @@ your own (existing) +Rakefile+. Fortunately, this is very easy to do. Try
 something like:
 
 	# Rakefile
-	include 'rote'
+	require 'rote'
 	
 	ws = Rote::DocTask.new(:doc) { |site| 
 	  site.site_dir = 'html'

data/Rakefile

@@ -6,7 +6,7 @@
 # This Rakefile is heavily based on Rake's own Rakefile.
 # Portions copyright (c)2003, 2004 Jim Weirich (jim <AT> weirichhouse.org)
 #
-# $Id: Rakefile,v 1.3 2005/11/25 01:24:39 roscopeco Exp $
+# $Id: Rakefile,v 1.4 2005/11/26 01:36:52 roscopeco Exp $
 #
 
 begin
@@ -25,6 +25,7 @@ require 'rote'
 
 CLEAN.include('testdata')
 CLOBBER.include('TAGS')
+CLOBBER.include('html')
 
 def announce(msg='')
   STDERR.puts msg
@@ -110,9 +111,7 @@ rd = Rake::RDocTask.new("rdoc") { |rdoc|
 }
 
 # Create a task build the website / docs
-CLOBBER.include('html')
-
-ws = Rote::DocTask.new("doc") { |site| 
+ws = Rote::DocTask.new(:doc) { |site| 
   site.output_dir = 'html'
   site.layout_dir = 'doc/layouts'
 
@@ -133,18 +132,20 @@ task :doc => [:rdoc]
 # Create a task that will package the Rote software into distributable
 # tar, zip and gem files.
 
+# don't include rendered website and all that Jazz 
 PKG_FILES = FileList[
   'install.rb',
   '[A-Z]*',
   'bin/**/*', 
   'lib/**/*.rb', 
-  'test/**/*.rb',
-  'test/**/*.rf',
-  'test/**/*.mf',
-  'test/**/Rakefile',
+  'lib/rote/builtin.rf', 
+  'test/**/*',
   'doc/**/*'
 ]
 
+# don't want GIMP originals
+PKG_FILES.exclude('**/*.xcf')
+
 if ! defined?(Gem)
   puts "Package Target requires RubyGEMs"
 else
@@ -163,16 +164,16 @@ else
 
     #### Dependencies and requirements.
 
-    #s.add_dependency('log4r', '> 1.0.4')
+    s.add_dependency('RedCloth', '> 3.0')
+    s.add_dependency('rake', '> 0.6')
     #s.requirements << ""
 
-    #### Which files are to be included in this gem?  Everything!  (Except CVS directories.)
+    #### Which files are to be included in this gem? 
 
     s.files = PKG_FILES.to_a
 
-    #### C code extensions.
-
-    #s.extensions << "ext/rmagic/extconf.rb"
+    #### Install Manpages (abuse C extension feature a bit)
+    #s.extensions << "post-install.rb"
 
     #### Load-time details: library and application (you will need one or both).
 
@@ -181,6 +182,8 @@ else
     s.bindir = "bin"                               # Use these for applications.
     s.executables = ["rote"]
     s.default_executable = "rote"
+    
+    s.autorequire = 'rote'
 
     #### Documentation and testing.
 
@@ -190,7 +193,9 @@ else
       '--title' <<  'Rote -- Template-based doc support for Rake' <<
       '--main' << 'README' <<
       '--line-numbers' << 
-      '-o' << 'html/rdoc'
+      '--inline-source' <<
+      '--template' << 'doc/jamis.rb'
+      '-o' << 'html'      
 
     #### Author and project details.
 

data/bin/rote

@@ -1,14 +1,53 @@
-#!/usr/bin/ruby
 #
 # Commandline launcher for Rote, (c)2005 Ross Bamford
 #
-# This is a real mess, and next on the list for an overhaul.
-# I'll get proper install working, don't panic...
+# Get set up with library paths, however we're installed.
 
-ROTE_HOME = ENV['ROTE_HOME'] || File.dirname(File.dirname($0))
-$: << "#{ROTE_HOME}/lib"
+def croak
+	puts "Cannot locate Rote libraries - Do you need to set $ROTE_LIB ?"
+	exit(1)
+end
 
-require 'rote'
-require 'rote/app'
+begin 
+	require 'rubygems'
+	require_gem 'rote'
+rescue LoadError
+	# just ignore, don't use gems
+end
+
+fail = false
+rote_lib = nil
+
+begin
+	require 'rote'
+	require 'rote/app'
+		
+	# find this later
+	rote_lib = nil
+rescue LoadError
+	unless fail || !(rote_lib = ENV['ROTE_LIB'])	
+		$: << rote_lib		
+		# at least we can know this now...
+		builtin = File.join(rote_lib,'rote/builtin.rf')
+		fail = true		# next time.
+		retry
+	else
+		puts "Cannot execute Rote - Do you need to set $ROTE_LIB ?"
+		exit(1)
+	end 
+end
+
+# If we're loaded via RubyGems or some such we need to locate
+# the builtin rakefile.
+unless rote_lib
+  $:.each { |it|
+    if File.exists?(File.join(it,'rote/builtin.rf'))
+      rote_lib = it
+      break
+    end
+  }  
+end
+
+croak unless rote_lib
 	
-Rote::Application.new("#{ROTE_HOME}/bin","#{ROTE_HOME}/lib").run
+Rote::Application.new(rote_lib).run

data/doc/pages/COMMON.rb

@@ -9,10 +9,12 @@ format_opts << :textile
 @navigation = [
 					{:title => 'Home',
 					 :url => '/index.html'},
+					{:title => 'Download',
+					 :url => 'http://rubyforge.org/frs/?group_id=1120'},					 
 					{:title => 'RDoc',
 					 :url => 'rdoc/'},					 
 					{:title => 'Project home',
 					 :url => 'http://rubyforge.org/projects/rote'},					 
 					{:title => 'Browse CVS',
-					 :url => 'http://rubyforge.org/cgi-bin/viewcvs.cgi/?cvsroot=rote'}
+					 :url => 'http://rubyforge.org/cgi-bin/viewcvs.cgi/?cvsroot=rote'}					 
 					]

data/doc/pages/index.html

@@ -1,7 +1,7 @@
 h2. Rote - A static website build tool for Ruby
 
-*Rote is a simple page-based template system for your static website that was 
-written to make it easier to author and maintain non-dynamic websites and 
+*Rote is a simple page-based template system that was written to make it 
+easier to author and maintain non-dynamic websites and 
 offline documentation.* Rote provides a simple commandline or 
 "Rake":http://rake.rubyforge.org based build for your pages, with page 
 rendering (optionally supporting Textile and Markdown with 
@@ -9,6 +9,12 @@ rendering (optionally supporting Textile and Markdown with
 "ERB":http://www.ruby-doc.org/stdlib/libdoc/erb/rdoc/classes/ERB.html), layout,
 and general documentation / website build tasks.
 
+Rote is somewhat similar to (though simpler than) 
+"WebGen":http://webgen.rubyforge.org , which provides a richer environment
+geared more toward websites and content publishing (whereas Rote's
+implementation as an extension to Rake reflects a bias toward software 
+documentation).
+
 h3. Features
 
 Rote offers the following major features:

data/install.rb

@@ -1,11 +1,3 @@
-puts <<-EOM
-NOT YET SUPPORTED
-
-Please copy 'bin' and 'lib' to a new directory, and set ROTE_HOME to 
-point there. Standard installation is not yet supported.
-EOM
-
-__END__
 require 'rbconfig'
 require 'find'
 require 'ftools'
@@ -17,7 +9,7 @@ $ruby = CONFIG['ruby_install_name']
 ##
 # Install a binary file. We patch in on the way through to
 # insert a #! line. If this is a Unix install, we name
-# the command (for example) 'rake' and let the shebang line
+# the command (for example) 'rote' and let the shebang line
 # handle running it. Under windows, we add a '.rb' extension
 # and let file associations to their stuff
 #
@@ -39,7 +31,7 @@ def installBIN(from, opfile)
   File.open(from) do |ip|
     File.open(tmp_file, "w") do |op|
       ruby = File.join($realbindir, $ruby)
-      op.puts "#!#{ruby} -w"
+      op.puts "#!#{ruby}"
       op.write ip.read
     end
   end
@@ -62,15 +54,18 @@ unless $sitedir
 end
 
 $bindir =  CONFIG["bindir"]
-
+$mandir = CONFIG['mandir']
 $realbindir = $bindir
+$realmandir = $mandir
 
 bindir = CONFIG["bindir"]
 if (destdir = ENV['DESTDIR'])
   $bindir  = destdir + $bindir
+  $mandir = destdir + $mandir
   $sitedir = destdir + $sitedir
   
   File::makedirs($bindir)
+  File::makedirs($mandir)
   File::makedirs($sitedir)
 end
 
@@ -80,8 +75,7 @@ File::chmod(0755, rote_dest)
 
 # The library files
 
-files = Dir.chdir('lib') { Dir['**/*.rb'] }
-
+files = Dir.chdir('lib') { Dir['**/*.rb'] + Dir['**/*.rf'] }
 for fn in files
   fn_dir = File.dirname(fn)
   target_dir = File.join($sitedir, fn_dir)
@@ -92,5 +86,4 @@ for fn in files
 end
 
 # and the executable
-
 installBIN("bin/rote", "rote")

data/lib/rote.rb

@@ -28,7 +28,7 @@ require_gem 'rake'
 require 'rote/rotetasks'
 
 # Master Rote version. Manage this from the Rake release support.
-ROTEVERSION = '0.1.0'
+ROTEVERSION = '0.1.2'
 
 #####
 ## *Rote* is a Rake (http://rake.rubyforge.org) based build tool for page-based

data/lib/rote/app.rb

@@ -4,7 +4,6 @@ module Rote
 
   # Command-line launcher for Rote.
   class Application
-    attr_accessor :rote_bin
     attr_accessor :rote_lib
     attr_accessor :debug
     attr_accessor :tasks
@@ -18,17 +17,18 @@ module Rote
     # Create a new Application instance, processing command-line arguments,
     # optionally passing +self+ to the supplied block for further 
     # configuration.
-    def initialize(rote_bin, rote_lib) # :yield: self if block_given?
+    def initialize(rote_lib) # :yield: self if block_given?
       # init vars
-      @rote_bin = rote_bin
-      @rote_lib = rote_lib || rote_bin
+      @rote_lib = rote_lib
       @debug = false
       @tasks = false
       @trace = false
       @usage = false
       @version = false    
       
-      @rakefile = File.exists?('Rakefile') ? 'Rakefile' : "#{rote_lib}/builtin.rf"
+      @rakefile = "#{rote_lib}/rote/builtin.rf"
+      raise "Missing builtin.rf (expected at '#{@rakefile}')!" unless File.exists?(@rakefile)
+      
       @rakeopts = ENV['RAKE_OPTS'] || ''
       @rake = ENV['RAKE_CMD'] || 'rake'
       
@@ -38,7 +38,7 @@ module Rote
     end
       
     # Run the application with the current options.
-    def run            
+    def run    
       if @version
         print "rote, version #{ROTEVERSION}\n"
        
@@ -61,46 +61,17 @@ module Rote
     
     private
     
-    # Display help text
-    def show_usage
-      print <<-EOM
-      Usage: rote [options] [task1] .. [taskN]
-    
-      Where [taskN] is a valid task or target name for the current project. 
-      Rite generates targets for each page source, and also defines a number
-      of top-level tasks for various things. Use the '--tasks' option to get
-      a list of valid tasks.
-    
-      Recognised options are:
-    
-        --tasks     -T     Display a list of tasks in this project.
-        --debug     -d     Enable debugging information.
-        --trace     -t     Enables verbose debugging information.    
-        --usage     -u     Display this help message and quit
-        --help      -h     Synonym for --usage
-        --version   -v     Display Rote's version and quit
-    
-      The 'rote' command is implemented as a wrapper around Rake, and 
-      requires the 'rake' command be in your path. You can circumvent this
-      by setting the RAKE_CMD environment variable appropriately.
-      Additional options can be passed to Rake via the RAKE_OPTS variable.
-      
-      Depending on your environment, you may need to set ROTE_HOME to point
-      to the installation directory. 
-      EOM
-    end
-    
     # Process commandline
     def process_args
       GetoptLong.new(
-        [ "--debug",   "-d", GetoptLong::NO_ARGUMENT ],
+        [ "--verbose", "-v", GetoptLong::NO_ARGUMENT ],
         [ "--tasks",   "-T", GetoptLong::NO_ARGUMENT ],
-        [ "--trace",   "-x", GetoptLong::NO_ARGUMENT ],
+        [ "--trace",   "-t", GetoptLong::NO_ARGUMENT ],
         [ "--usage",   "-u", GetoptLong::NO_ARGUMENT ],
         [ "--help",    "-h", GetoptLong::NO_ARGUMENT ],
-        [ "--version", "-v", GetoptLong::NO_ARGUMENT ]
+        [ "--version", "-V", GetoptLong::NO_ARGUMENT ]
       ).each { |opt,arg|
-        @debug = true if opt == '--debug'
+        @debug = true if opt == '--verbose'
         @trace = true if opt == '--trace'
         @tasks = true if opt == '--tasks'
         @usage = true if opt == '--usage' || opt == '--help'
@@ -108,5 +79,35 @@ module Rote
       }    
     end
     
+    # Display help text
+    def show_usage
+      print <<-EOM
+Usage: rote [options] [task1] .. [taskN]
+
+Where [taskN] is a valid task or target name for the current project. 
+Rite generates targets for each page source, and also defines a number
+of top-level tasks for various things. Use the '--tasks' option to get
+a list of valid tasks.
+
+Recognised options are:
+
+  --tasks     -T     Display a list of tasks in this project.
+  --verbose   -v     Enable verbose output.
+  --trace     -t     Enables trace-level output (debugging).
+  --usage     -u     Display this help message and quit
+  --help      -h     Synonym for --usage
+  --version   -V     Display Rote's version and quit
+
+The 'rote' command is implemented as a wrapper around Rake, and 
+requires the 'rake' command be in your path. You can circumvent this
+by setting the RAKE_CMD environment variable appropriately.
+Additional options can be passed to Rake via the RAKE_OPTS variable.
+  
+In non-standard environments, it may be necessary to set the ROTE_LIB 
+variable to point to the location of Rote's libraries.
+  
+EOM
+    end
+        
   end # Application
 end # Rote

data/lib/rote/builtin.rf

@@ -0,0 +1,27 @@
+#
+# Built-in Rakefile for Rote, (c)2005 Ross Bamford
+
+require 'rake'
+require 'rake/clean'
+require 'rote'
+
+CLEAN.include('html')
+
+# Create a task build the website / docs
+ws = Rote::DocTask.new("doc") { |site| 
+  site.output_dir = 'html'
+  site.layout_dir = 'doc/layouts'
+
+  site.pages.dir = 'doc/pages'
+  site.pages.include('**/*')  
+  
+  site.res.dir = 'doc/res/'
+  site.res.include('**/*.png')
+  site.res.include('**/*.gif')
+  site.res.include('**/*.jpg')
+  site.res.include('**/*.css')
+}
+
+task :default => [:doc]
+
+import 'publish.rf' if File.exists?('publish.rf')

data/test/layouts/simple.txt

@@ -0,0 +1 @@
+layout <%= @content_for_layout %> for a change.

data/test/layouts/withext.ext

@@ -0,0 +1 @@
+layout <%= @content_for_layout %> for a change.

data/test/pages/badlayout.txt

@@ -0,0 +1 @@
+To err is human; to forgive, divine

data/test/pages/baselayout.txt

@@ -0,0 +1 @@
+Lay <%= @content_for_layout %> out.

data/test/pages/custext.txt

@@ -0,0 +1,2 @@
+<% layout 'withext.ext' %>
+<%= @global %>

data/test/pages/justtext.txt

@@ -0,0 +1 @@
+Just some text

data/test/pages/markdown.txt

@@ -0,0 +1,4 @@
+<% format_opts << :markdown %>
+*this* is a _test_
+==================
+

data/test/pages/samedir.txt

@@ -0,0 +1 @@
+<%= @global %>

data/test/pages/textile.txt

@@ -0,0 +1 @@
+*This* is a _simple_ test of "Textile":http://www.textism.org/tools/textile formatting.

data/test/pages/withcode.txt

@@ -0,0 +1 @@
+<%= @myvar %> and <%= @global %>

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: rote
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
-date: 2005-11-25 00:00:00 +00:00
+  version: 0.1.2
+date: 2005-11-26 00:00:00 +00:00
 summary: Adds template-based doc support to Rake.
 require_paths: 
 - lib
@@ -12,7 +12,7 @@ email: ross@roscopeco.co.uk
 homepage: http://rote.rubyforge.org
 rubyforge_project: rote
 description: Rote is a set of Rake task libraries and utilities that enable easy rendering of textual documentation formats (like HTML) for websites and offline documentation.
-autorequire: 
+autorequire: rote
 default_executable: rote
 bindir: bin
 has_rdoc: true
@@ -39,12 +39,25 @@ files:
 - lib/rote/page.rb
 - lib/rote/app.rb
 - lib/rote/dirfilelist.rb
+- lib/rote/builtin.rf
 - test/test_page.rb
+- test/pages
+- test/layouts
+- test/pages/samedir.txt
+- test/pages/baselayout.txt
+- test/pages/markdown.txt
 - test/pages/badlayout.rb
 - test/pages/samedir.rb
 - test/pages/COMMON.rb
 - test/pages/textile.rb
+- test/pages/custext.txt
+- test/pages/textile.txt
 - test/pages/withcode.rb
+- test/pages/justtext.txt
+- test/pages/badlayout.txt
+- test/pages/withcode.txt
+- test/layouts/withext.ext
+- test/layouts/simple.txt
 - doc/res
 - doc/jamis.rb
 - doc/pages
@@ -60,10 +73,7 @@ files:
 - doc/res/images/go-home-med.png
 - doc/res/images/rpot-sml.png
 - doc/res/images/rote-med.png
-- doc/res/images/rpot-large-x.xcf
-- doc/res/images/rote-logo.xcf
 - doc/res/images/dialog-information-med.png
-- doc/res/images/rpot-large.xcf
 - doc/res/images/rpot-big.png
 - doc/res/stylesheets/normal.css
 - doc/pages/COMMON.rb
@@ -78,8 +88,9 @@ rdoc_options:
 - --main
 - README
 - --line-numbers
-- -o
-- html/rdoc
+- --inline-source
+- --template
+- doc/jamis.rb
 extra_rdoc_files: 
 - README
 - LICENSE
@@ -90,5 +101,22 @@ extensions: []
 
 requirements: []
 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: RedCloth
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: "3.0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: "0.6"
+    version: