rote 0.1.0

data/lib/rote/rotetasks.rb

@@ -0,0 +1,122 @@
+require 'rake'
+require 'rake/tasklib'
+
+require 'rote/page'
+require 'rote/dirfilelist'
+
+module Rote
+
+  #####
+  ## Rake task library that provides a set of tasks to transform documentation
+  ## using Rote. To use, create a new instance of this class in your Rakefile,
+  ## performing appropriate configuration in a block supplied to +new+. 
+  ## This will automatically register a set of tasks with names based on the
+  ## name you supply. The tasks defined are:
+  ##
+  ##   #{name}         - Transform all documentation, copy resources.
+  ##   #{name}-pages   - Transform all pages
+  ##   #{name}-res     - Copy resources
+  ##
+  class DocTask < Rake::TaskLib
+    # Default exclusion patterns for the page sources. These are
+    # applied along with the defaults from +FileList+. 
+    DEFAULT_SRC_EXCLUDES = [ /\.rb$/ ]
+    
+    # The base-name for tasks created by this instance, supplied at 
+    # instantiation.
+    attr_reader :name
+    
+    # The directory in which output will be placed.
+    attr_accessor :output_dir
+    
+    # The base directory within which layouts requested by pages will be
+    # resolved.
+    attr_accessor :layout_dir
+    
+    # A DirectoryFileList that supplies the pages to transform. You should
+    # configure the +dir+ and at least one +include+ entry in the 
+    # configuration block.
+    attr_reader :pages
+    
+    # A DirectoryFileList that supplies the resources to copy to the 
+    # output directory.
+    attr_reader :res
+    
+    # If +show_page_tasks+ is +true+, then the file tasks created for each
+    # source page will be shown in the Rake task listing from the command line.
+    attr_accessor :show_page_tasks         
+    alias :show_page_tasks? :show_page_tasks
+    
+    # Create a new DocTask, using the supplied block for configuration,
+    # and define tasks with the specified base-name within Rake.
+    def initialize(name = :site) # :yield: self if block_given?
+      @name = name
+      @output_dir = '.'      
+      @layout_dir = '.'   # layouts are looked up as needed
+      
+      @pages = DirectoryFileList.new
+      @res = DirectoryFileList.new      
+      DEFAULT_SRC_EXCLUDES.each { |excl| @pages.exclude(excl) }
+      
+      @show_page_tasks = false
+      
+      yield self if block_given?
+      
+      define
+    end    
+    
+    private
+    
+    def define
+      define_res_tasks
+      define_page_tasks
+      define_main_tasks
+      nil
+    end
+    
+    def define_res_tasks
+      desc "Copy documentation resources"
+      task "#{name}-res" do
+        res.each { |fn|           
+          unless File.directory?(fn)    # make dirs only as needed
+            tfn = fn.sub(/#{res.dir}/, output_dir)
+            dn = File.dirname(tfn)
+            mkdir_p dn unless File.exists?(dn)            
+            cp fn, tfn
+          end        
+        }
+      end #task
+    end
+
+    def define_page_tasks
+    
+      # define a task for each page
+      pages.each { |fn| 
+        unless File.directory?(fn)    # make dirs only as needed
+          tfn = fn.sub(/#{pages.dir}/, output_dir)
+          
+          desc "#{fn} => #{tfn}" if show_page_tasks?
+          file tfn => [fn] do
+            dn = File.dirname(tfn)
+            mkdir_p dn unless File.exists?(dn)
+            File.open(tfn, 'w+') { |f|
+              puts "tr #{fn} => #{tfn}"
+              f << Page.new(fn,layout_dir).render
+            }
+          end
+        end
+      }
+      
+      # this is pretty convenient ;]
+      desc "Render all documentation pages"
+      task "#{name}-pages" => pages.sub(/#{pages.dir}/, output_dir)
+    end
+    
+    def define_main_tasks
+      desc "Build the documentation"
+      task name => ["#{name}-pages", "#{name}-res"]
+    end
+    
+  end #class  
+  
+end #module

data/lib/rote.rb

@@ -0,0 +1,86 @@
+# rote.rb - main Rote module  
+# Copyright (c) 2005 Ross Bamford (and contributors)
+#
+# 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.
+#
+# See Rote for full documentation
+
+require 'net/ftp'
+require 'rubygems'
+require_gem 'rake'
+
+require 'rote/rotetasks'
+
+# Master Rote version. Manage this from the Rake release support.
+ROTEVERSION = '0.1.0'
+
+#####
+## *Rote* is a Rake (http://rake.rubyforge.org) based build tool for page-based
+## static websites that enables layout, textile formatting, and ERB to be used
+## to automatically generate your site, and can handle uploading the site 
+## to your (host's) server.
+##
+## Rote was created for my personal site, but is general enough to be applied
+## to many different types of website, including basic blog-plus sites,
+## slower-moving news and information sites, and software documentation.
+##
+## See +README+ for general usage information. +Rote::DocTask+ documents the
+## Rake task integration, while +Rote::Page+ has information useful to template
+## writers.
+##
+## Rote is (c)2005 Ross Bamford, and is licensed under an MIT license. 
+## See +LICENSE+ for details.
+module Rote
+
+  private
+
+  ####################################################
+  ## WILL BE REMOVED...                             ##
+  ##                   ...I SAID, "WILL BE REMOVED" ##
+  ####################################################
+  
+  def ftp_putdir(dir, ftp_host, ftp_user, ftp_pass = nil, ftp_root = '/')  
+    f = Net::FTP.new(ftp_host, ftp_user, ftp_pass)
+    f.passive = true
+    
+    Dir[dir + '/**/*'].sort.each { |fn|    
+      # pretty f*cking trick - it's replacing the local 'target' or whatever prefix 
+      # with remote root ;)
+      rfn = fn.dup
+      rfn[dir] = ftp_root
+      
+      if File.directory?(fn) 
+        puts "Creating remote directory #{rfn}"
+        begin
+          f.mkdir(rfn)
+        rescue
+          # forget it then, already exists prob'ly
+          # TODO maybe should raise if $! != FTP 550?
+        end
+      else
+
+        # TODO continue on error perhaps
+        puts "Uploading #{fn} => #{rfn}"
+        f.put(fn,rfn)        
+      end
+    }
+    
+    f.close   
+  end 
+end 

data/test/pages/COMMON.rb

@@ -0,0 +1 @@
+@global = 'some other text'

data/test/pages/badlayout.rb

@@ -0,0 +1 @@
+layout 'nonexistent'

data/test/pages/samedir.rb

@@ -0,0 +1 @@
+layout 'baselayout'

data/test/pages/textile.rb

@@ -0,0 +1 @@
+format_opts << :textile

data/test/pages/withcode.rb

@@ -0,0 +1,5 @@
+# config
+layout 'simple'
+
+# custom stuff
+@myvar = 'some text'

data/test/test_page.rb

@@ -0,0 +1,137 @@
+require 'test/unit'
+require 'rote/page'
+
+module Rote
+  class TestPage < Test::Unit::TestCase
+    ############## helpers #################
+    def new_test_page(basename)  
+      Page.new('test/pages/' + basename + '.txt', 'test/layouts')      
+    end
+    
+    ############## initialize #################
+    def test_initialize_with_bad_file
+      begin
+        new_test_page('NONEXISTENT')
+      rescue
+        assert true
+      end
+    end
+  
+    def test_initialize_with_bad_layout 
+      begin
+        p = new_test_page('badlayout')
+      rescue
+        assert true
+      end
+    end  
+    
+    def test_initialize_ok
+      new_test_page('justtext')    
+    end
+       
+    ############## accessors #################
+    def test_template_accessors
+      p = new_test_page('justtext')
+      assert_equal 'Just some text', p.template_text.chomp
+    end
+            
+    def test_layout_accessors
+      p = new_test_page('justtext')
+      assert_nil p.layout_text
+      
+      p = new_test_page('withcode')
+      assert_equal 'layout <%= @content_for_layout %> for a change.', p.layout_text.chomp
+    end
+    
+    def test_default_layout_params
+      p = Page.new('test/pages/samedir.txt')
+      assert_equal '<%= @global %>', p.template_text.chomp
+      assert_equal 'Lay <%= @content_for_layout %> out.', p.layout_text.chomp
+    end      
+    
+    # this is testing also that layouts can be specified in the template itself    
+    def test_custom_layout_ext
+      p = new_test_page('custext')
+      
+      # Should have no layout yet (until render)
+      assert_nil p.layout_text
+      
+      # Render will load layout, it'll be available after
+      assert_equal "layout \nsome other text for a change.", p.render.chomp
+
+      assert_equal 'layout <%= @content_for_layout %> for a change.', p.layout_text.chomp
+    end
+
+    def test_format_opts
+      p = new_test_page('justtext')
+      assert p.format_opts.empty?
+      
+      # alter array
+      p = new_test_page('textile')
+      assert_equal [:textile], p.format_opts
+      p.format_opts -= [:textile]
+      assert p.format_opts.empty?
+      
+      # replace array with single sym
+      p = new_test_page('textile')
+      assert_equal [:textile], p.format_opts
+      p.format_opts = [:markdown]
+      assert_equal [:markdown], p.format_opts
+      p.format_opts = :textile
+      # should create array for one sim
+      assert_equal [:textile], p.format_opts
+      
+    end
+    
+    ############## render #################
+    def test_render_text    
+      t = new_test_page('justtext').render.chomp
+      assert_equal 'Just some text', t
+    end    
+    
+    def test_render_textile
+      t = new_test_page('textile').render.chomp
+      assert_equal '<p><strong>This</strong> is a <em>simple</em> test of <a href="http://www.textism.org/tools/textile">Textile</a> formatting.</p>', t
+    end
+    
+    def test_render_markdown
+      t = new_test_page('markdown').render.chomp
+      assert_equal '<h1>*this* is a _test_</h1>', t
+    end
+    
+    def test_render_layout_code  
+      t = new_test_page('withcode').render.chomp
+      assert_equal 'layout some text and some other text for a change.', t
+    end    
+    
+    ############## broken render #################
+    def test_render_switch_layout_freeze
+      p = new_test_page('withcode')
+      assert_equal 'layout <%= @content_for_layout %> for a change.', p.layout_text.chomp
+
+      p.layout(nil)
+      assert_nil p.layout_text      
+            
+      assert_equal 'some text and some other text', p.render.chomp
+      
+      begin
+        p.layout('simple')        
+      rescue TypeError  # frozen
+        assert true
+      end
+    end    
+    
+    def test_render_switch_to_bad_layout
+      p = new_test_page('withcode')
+      assert_equal 'layout <%= @content_for_layout %> for a change.', p.layout_text.chomp
+
+      begin      
+        p.layout('nonexistent')
+      rescue
+        assert true
+      end        
+    end
+        
+  end
+end
+

metadata

@@ -0,0 +1,94 @@
+!ruby/object:Gem::Specification 
+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
+summary: Adds template-based doc support to Rake.
+require_paths: 
+- lib
+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: 
+default_executable: rote
+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: 
+authors: 
+- Ross Bamford
+files: 
+- install.rb
+- Rakefile
+- README
+- TODO
+- LICENSE
+- bin/rote
+- lib/rote.rb
+- lib/rote/rotetasks.rb
+- lib/rote/page.rb
+- lib/rote/app.rb
+- lib/rote/dirfilelist.rb
+- test/test_page.rb
+- test/pages/badlayout.rb
+- test/pages/samedir.rb
+- test/pages/COMMON.rb
+- test/pages/textile.rb
+- test/pages/withcode.rb
+- doc/res
+- doc/jamis.rb
+- doc/pages
+- doc/layouts
+- doc/res/images
+- doc/res/stylesheets
+- doc/res/images/rote-big.png
+- doc/res/images/rote-small.png
+- doc/res/images/rpot-tiny.png
+- doc/res/images/user-id-med.png
+- doc/res/images/document-new-med.png
+- doc/res/images/computer-med.png
+- 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
+- doc/pages/index.html
+- doc/pages/index.rb
+- doc/layouts/page.html
+test_files: []
+
+rdoc_options: 
+- --title
+- Rote -- Template-based doc support for Rake
+- --main
+- README
+- --line-numbers
+- -o
+- html/rdoc
+extra_rdoc_files: 
+- README
+- LICENSE
+- TODO
+executables: 
+- rote
+extensions: []
+
+requirements: []
+
+dependencies: []
+