dokkit 0.1.0 → 0.1.1

data/CHANGES

@@ -0,0 +1,12 @@
+= Dokkit Changelog
+
+== Version 0.1.1
+
+This release add the implementation of a configuration system for project models based on YAML.
+
+* First implementation of configuration system based on YAML.
+* Added release support with MetaProject.
+
+== Version 0.1.0
+
+This is the first release of dokkit a Ruby Documentation ToolKit.

data/Rakefile

@@ -8,55 +8,126 @@ rescue LoadError
   nil # optional
 end
 
-require 'rake'
+$:.unshift('lib')
+require 'meta_project'
+require 'rake/gempackagetask'
+require 'rake/contrib/rubyforgepublisher'
+require 'rake/contrib/xforge'
 require 'rake/clean'
 require 'rake/testtask'
 require 'rake/rdoctask'
-require 'rake/gempackagetask'
 
-CLOBBER.include('html')
-CLOBBER.include('tex')
+# Versioning scheme: MAJOR.MINOR.PATCH
+# MAJOR bumps when API is broken backwards
+# MINOR bumps when the API is broken backwards in a very slight/subtle (but not fatal) way
+# -OR when a new release is made and propaganda is sent out.
+# PATCH is bumped for every API addition and/or bugfix (ideally for every commit)
+# Later DamageControl can bump PATCH automatically.
+#
+# REMEMBER TO KEEP PKG_VERSION IN SYNC WITH THE CHANGES FILE!
+PKG_NAME = "dokkit"
+PKG_VERSION = "0.1.1"
+PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
+PKG_FILES = FileList['lib/**/*', 'bin/*', '[A-Z]*', 'tests/*', 'tests/**/**'].exclude(/alca/).to_a
+
 
-Rake::RDocTask.new do |rd|
+task :default => [:gem]
+
+rd = Rake::RDocTask.new do |rd|
   rd.main = "README"
   rd.rdoc_files.include("README", "lib/**/*.rb", "tests/*.rb")
   rd.rdoc_dir = "apidoc"
   rd.options.push('-d').push('-F')
 end	
 
-desc "Run basic tests"
-Rake::TestTask.new("test_units") { |t|
-  t.pattern = 'tests/ts_*.rb'
-  t.verbose = true
-  #t.warning = true
-}
+# ====================================================================
+# Create a task that will package the Rake software into distributable
+# tar, zip and gem files.
 
 spec = Gem::Specification.new do |s|
-  s.platform = Gem::Platform::RUBY
-  s.summary = "Ruby Documentation ToolKit."
-  s.name = 'dokkit'
-  s.version = '0.1.0'
-
-  s.add_dependency('deplate', '>= 0.8')
-  s.add_dependency('rote', '>= 0.3.2.2')
-  s.add_dependency('rake')
-  s.add_dependency('syntax')
+  
+  #### Basic information.
 
-  s.has_rdoc = true
-  s.test_file = 'tests/gem_tests.rb'
+  s.name = PKG_NAME
+  s.version = PKG_VERSION
+  s.summary = "Ruby Documentation ToolKit"
+  s.description = <<-EOF
+    dokkit is an open source documentation environment based on ruby.
+  EOF
 
+  s.files = PKG_FILES.to_a
   s.require_path = 'lib'
   s.autorequire = 'dokkit'
-  s.bindir = 'bin'
-  s.executables << 'dokkit'
-  s.extra_rdoc_files << 'README'	
-  s.files = FileList['lib/**/*', 'bin/*', '[A-Z]*', 'tests/*', 'tests/**/**'].exclude(/alca/).to_a
-  s.description = <<-EOF
-    Dokkit is a documentation toolkit based on Rote.
-  EOF
+
+  #### Documentation and testing.
+
+  s.has_rdoc = true
+  s.extra_rdoc_files = rd.rdoc_files.reject { |fn| fn =~ /\.rb$/ }.to_a
+  s.rdoc_options <<
+    '--title' <<  'Dokkit' <<
+    '--main' << 'README' <<
+    '--line-numbers'
+
+  #### Author and project details.
+
+  s.author = "Andrea Fazzi"
+  s.email = "andrea.fazzi@alca.le.it"
+  s.homepage = "http://dokkit.rubyforge.org"
+  s.rubyforge_project = "dokkit"
 end
 
+desc "Build Gem"
 Rake::GemPackageTask.new(spec) do |pkg|
   pkg.need_zip = true
   pkg.need_tar = true
-end
+end
+
+# Support Tasks ------------------------------------------------------
+
+desc "Look for TODO and FIXME tags in the code"
+task :todo do
+  Pathname.new(File.dirname(__FILE__)).egrep(/#.*(FIXME|TODO|TBD|DEPRECATED)/) do |match|
+    puts match
+  end
+end
+
+task :release => [:verify_env_vars, :release_files, :publish_doc, :publish_news]
+
+task :verify_env_vars do
+  raise "RUBYFORGE_USER environment variable not set!" unless ENV['RUBYFORGE_USER']
+  raise "RUBYFORGE_PASSWORD environment variable not set!" unless ENV['RUBYFORGE_PASSWORD']
+end
+
+task :publish_doc do
+  publisher = Rake::RubyForgePublisher.new('dokkit', ENV['RUBYFORGE_USER'])
+  publisher.upload
+end
+
+desc "Release files on RubyForge"
+task :release_files => [:gem] do
+  release_files = FileList[
+    "pkg/#{PKG_FILE_NAME}.gem"
+  ]
+
+  Rake::XForge::Release.new(MetaProject::Project::XForge::RubyForge.new('dokkit')) do |release|
+    # Never hardcode user name and password in the Rakefile!
+    release.user_name = ENV['RUBYFORGE_USER']
+    release.password = ENV['RUBYFORGE_PASSWORD']
+    release.files = release_files.to_a
+    release.release_name = "#{PKG_NAME} #{PKG_VERSION}"
+    # The rest of the options are defaults (among others, release_notes and release_changes, parsed from CHANGES)
+  end
+end
+
+desc "Publish news on RubyForge"
+task :publish_news => [:gem] do
+  release_files = FileList[
+    "pkg/#{PKG_FILE_NAME}.gem"
+  ]
+
+  Rake::XForge::NewsPublisher.new(MetaProject::Project::XForge::RubyForge.new('dokkit')) do |news|
+    # Never hardcode user name and password in the Rakefile!
+    news.user_name = ENV['RUBYFORGE_USER']
+    news.password = ENV['RUBYFORGE_PASSWORD']
+  end
+end

data/Rakefile.old

@@ -0,0 +1,62 @@
+# Standard Rakefile for custom Dokkit build
+#
+# 
+
+begin 
+  require 'rubygems'
+rescue LoadError
+  nil # optional
+end
+
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+
+CLOBBER.include('html')
+CLOBBER.include('tex')
+
+Rake::RDocTask.new do |rd|
+  rd.main = "README"
+  rd.rdoc_files.include("README", "lib/**/*.rb", "tests/*.rb")
+  rd.rdoc_dir = "apidoc"
+  rd.options.push('-d').push('-F')
+end	
+
+desc "Run basic tests"
+Rake::TestTask.new("test_units") { |t|
+  t.pattern = 'tests/ts_*.rb'
+  t.verbose = true
+  #t.warning = true
+}
+
+spec = Gem::Specification.new do |s|
+  s.platform = Gem::Platform::RUBY
+  s.summary = "Ruby Documentation ToolKit."
+  s.name = 'dokkit'
+  s.version = '0.1.0'
+
+  s.add_dependency('deplate', '>= 0.8')
+  s.add_dependency('rote', '>= 0.3.2.2')
+  s.add_dependency('rake')
+  s.add_dependency('syntax')
+
+  s.has_rdoc = true
+  s.test_file = 'tests/gem_tests.rb'
+
+  s.require_path = 'lib'
+  s.autorequire = 'dokkit'
+  s.bindir = 'bin'
+  s.executables << 'dokkit'
+  s.extra_rdoc_files << 'README'	
+  s.files = FileList['lib/**/*', 'bin/*', '[A-Z]*', 'tests/*', 'tests/**/**'].exclude(/alca/).to_a
+  s.description = <<-EOF
+    Dokkit is a documentation toolkit based on Rote.
+  EOF
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar = true
+end

data/lib/dokkit/dokkittasks.rb

@@ -29,7 +29,7 @@ module Rote
           begin
             File.open(tfn, 'w+') do |f|
               # new page, run extension block, render out, throw away
-              f << Page.new(fn,pages.dir,layout_dir,config_dir,&blk).render
+              f << Page.new(fn,pages.dir,layout_dir,config_dir || pages.dir,&blk).render
             end
           rescue => e
             # Oops... Unlink file and dump backtrace

data/lib/dokkit/projects/invoice/lib/invoice.rb

@@ -13,7 +13,7 @@ module Rote
 
   class Page
 
-    alias dokkitpage_initialize initialize
+    alias old_initialize initialize
 
     def initialize(template_name, pages_dir = '.', layout_dir = pages_dir, config_dir = pages_dir, &block)
       
@@ -29,7 +29,7 @@ module Rote
       @total_price = 0
       @vat_price = 0
 
-      dokkitpage_initialize(template_name, pages_dir, layout_dir, config_dir, &block)
+      old_initialize(template_name, pages_dir, layout_dir, config_dir, &block)
       calc_prices
     end
 

data/lib/dokkit/projects/tech_report/doc/config/tech_report.yaml

@@ -1,3 +1,3 @@
-title: Techinical Report
-author: john Doe
+title: Technical Report
+author: John Doe
 

data/lib/dokkit/projects/website/Rakefile

@@ -47,22 +47,22 @@ ws = Rote::DocTask.new(:doc) do |site|
   
   site.ext_mapping(/thtml|textile/, 'html') do |page|
     page.extend Format::HTML
-    page.page_filter Filters::RedCloth.new
+    page.page_filter Rote::Filters::RedCloth.new
   end    
   
   site.ext_mapping(/mhtml|markdown/, 'html') do |page|
     page.extend Format::HTML
-    page.page_filter Filters::BlueCloth.new
+    page.page_filter Rote::Filters::BlueCloth.new
   end      
   
   site.ext_mapping(/rdhtml|rdoc/, 'html') do |page|
     page.extend Format::HTML
-    page.page_filter Filters::RDoc.new
+    page.page_filter Rote::Filters::RDoc.new
   end      
   
   site.ext_mapping(/dplhtml/, 'html') do |page|
     page.extend Format::HTML
-    page.page_filter Dokkit::Filters::Deplate.new('html-snippet')
+    page.page_filter Dokkit::Filters::Deplate.new('html-notemplate')
   end
 
   site.ext_mapping(/html/, 'html') do |page|

metadata

@@ -3,15 +3,15 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: dokkit
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 date: 2006-12-07 00:00:00 +01:00
-summary: Ruby Documentation ToolKit.
+summary: Ruby Documentation ToolKit
 require_paths: 
 - lib
-email: 
-homepage: 
-rubyforge_project: 
-description: Dokkit is a documentation toolkit based on Rote.
+email: andrea.fazzi@alca.le.it
+homepage: http://dokkit.rubyforge.org
+rubyforge_project: dokkit
+description: dokkit is an open source documentation environment based on ruby.
 autorequire: dokkit
 default_executable: 
 bindir: bin
@@ -25,8 +25,8 @@ required_ruby_version: !ruby/object:Gem::Version::Requirement
 platform: ruby
 signing_key: 
 cert_chain: 
-authors: []
-
+authors: 
+- Andrea Fazzi
 files: 
 - lib/dokkit
 - lib/dokkit.rb
@@ -99,7 +99,6 @@ files:
 - lib/dokkit/projects/website/doc
 - lib/dokkit/projects/website/Rakefile
 - lib/dokkit/projects/website/README
-- lib/dokkit/projects/website/html
 - lib/dokkit/projects/website/doc/pages
 - lib/dokkit/projects/website/doc/res
 - lib/dokkit/projects/website/doc/layouts
@@ -110,10 +109,6 @@ files:
 - lib/dokkit/projects/website/doc/res/images
 - lib/dokkit/projects/website/doc/res/images/rote-tiny.png
 - lib/dokkit/projects/website/doc/layouts/normal.thtml
-- lib/dokkit/projects/website/html/index.html
-- lib/dokkit/projects/website/html/deplate.html
-- lib/dokkit/projects/website/html/images
-- lib/dokkit/projects/website/html/images/rote-tiny.png
 - lib/dokkit/deplate/fmt
 - lib/dokkit/deplate/fmt/latex-notemplate.rb
 - lib/dokkit/deplate/fmt/html-notemplate.rb
@@ -124,54 +119,25 @@ files:
 - README
 - Rakefile
 - TODO
+- Rakefile.old
+- CHANGES
 - tests/gem_tests.rb
 - tests/test_filters.rb
-test_files: 
-- tests/gem_tests.rb
-rdoc_options: []
+test_files: []
 
+rdoc_options: 
+- --title
+- Dokkit
+- --main
+- README
+- --line-numbers
 extra_rdoc_files: 
 - README
-executables: 
-- dokkit
+executables: []
+
 extensions: []
 
 requirements: []
 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: deplate
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0.8"
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: rote
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 0.3.2.2
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: rake
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
-    requirements: 
-    - - ">"
-      - !ruby/object:Gem::Version 
-        version: 0.0.0
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: syntax
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
-    requirements: 
-    - - ">"
-      - !ruby/object:Gem::Version 
-        version: 0.0.0
-    version: 
+dependencies: []
+

data/lib/dokkit/projects/website/html/deplate.html

@@ -1,21 +0,0 @@
-<div id="Table_of_Contents">
-<div id="Table_of_ContentsBlock" class="toc">
-<h1 class="toc">Table of Contents</h1>
-<ul class="toc">
-    <li class="toc">
-        <a href="#hd001" class="toc">1 Introduzione</a>
-    </li>
-</ul>
-</div></div>
-
-<h1 id="hd001">1&nbsp;Introduzione</h1>
-
-Lista:
-<ul class="Itemize">
-    <li class="Itemize dash">
-        item 1
-    </li>
-    <li class="Itemize dash">
-        item 2
-    </li>
-</ul>

data/lib/dokkit/projects/website/html/index.html

@@ -1,37 +0,0 @@
-
-<html>
-  <head>
-    
-    <title>A sample page - My site</title>
-  </head>
-
-  <body>
-    <h1>A sample page</h1>
-
-    
-    <p>This is a <strong>sample</strong> page.</p>
-
-
-	<p>It has a very small image:
-<img src="images/rote-tiny.png" alt="" /></p>
-
-
-	<p>(Which is the same as the one at the bottom)</p>
-
-
-	<ul>
-	<li>You should</li>
-		<li>Replace this</li>
-		<li>With your doc.</li>
-	</ul>
-
-    <p align='center'><hr width='80%'></p>
-    <p align='right'>
-    <span style='font-size: 8pt; color: #7c7c90'>Generated with</span><br/>
-
-      
-      <a href='http://rote.rubyforge.org/' target='_blank'><img src='images/rote-tiny.png' alt='Rote'/></a>
-    </p>    
-  </body>
-</html>
-