literate_maruku 0.1.0

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2007-09-30
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2007 Gregor Schmidt
+
+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/Manifest.txt

@@ -0,0 +1,26 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/literate_maruku
+config/hoe.rb
+config/requirements.rb
+lib/literate_maruku.rb
+lib/literate_maruku/version.rb
+log/debug.log
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/test_document.mkd
+test/test_helper.rb
+test/test_literate_maruku.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.rhtml

data/README.txt

@@ -0,0 +1,4 @@
+= Literate Maruku
+
+See LiterateMaruku::ClassMethods for API documentation or our website for more 
+detailed usage information.

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/bin/literate_maruku

@@ -0,0 +1,62 @@
+#!/usr/bin/env ruby
+#
+#  Created by Gregor Schmidt on 2007-9-30.
+#  Copyright (c) 2007. All rights reserved.
+
+begin
+  require 'rubygems'
+rescue LoadError
+  # no rubygems to load, so we fail silently
+end
+
+require 'optparse'
+
+# NOTE: the option -p/--path= is given as an example, and should probably be replaced in your application.
+
+OPTIONS = {
+  :output_path     => nil
+}
+MANDATORY_OPTIONS = %w(  )
+
+parser = OptionParser.new do |opts|
+  opts.banner = <<BANNER
+Literate Maruku allows you to interleave your documentation and the 
+corresponding code in a style of literate programming. This is the
+command line front end of the literate_maruku gem. You may find 
+additional information on our website 
+
+http://rug-b.rubyforge.org/literate_maruku/
+
+Usage: #{File.basename($0)} [options] filename.mkd
+
+Options are:
+BANNER
+  opts.separator ""
+  opts.on("-o", "--output_path=PATH", String,
+          "The root path for the generated files",
+          "If not set, not output will be generated") { |OPTIONS[:output_path]| }
+  opts.on("-h", "--help",
+          "Show this help message.") { puts opts; exit }
+  opts.parse!(ARGV)
+
+  if MANDATORY_OPTIONS && MANDATORY_OPTIONS.find { |option| OPTIONS[option.to_sym].nil? } or ARGV[0].nil?
+    puts opts; exit
+  end
+end
+
+# do stuff
+begin
+  gem "literate_maruku"
+  require "literate_maruku"
+rescue LoadError
+  require File.dirname(__FILE__) + "/../lib/literate_maruku"
+end
+
+if OPTIONS[:output_path]
+  path = File.join(Dir.pwd, OPTIONS[:output_path])
+  puts "Generating output to \"#{OPTIONS[:output_path]}\""
+  LiterateMaruku.require(ARGV[0], :output => path)
+else
+  LiterateMaruku.require(ARGV[0])
+end
+

data/config/hoe.rb

@@ -0,0 +1,70 @@
+require 'literate_maruku/version'
+
+AUTHOR = 'Gregor Schmidt'  # can also be an array of Authors
+EMAIL = "ruby@schmidtwisser.de"
+DESCRIPTION = "Literate programming for ruby based on maruku"
+GEM_NAME = 'literate_maruku' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'rug-b' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org/#{GEM_NAME}"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = LiterateMaruku::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'literate_maruku documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.author = AUTHOR 
+  p.description = DESCRIPTION
+  p.email = EMAIL
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\\n\\n")
+  #p.extra_deps = []     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  
+end
+
+CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')

data/config/requirements.rb

@@ -0,0 +1,17 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))
+
+require 'literate_maruku'

data/lib/literate_maruku/version.rb

@@ -0,0 +1,9 @@
+module LiterateMaruku #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/literate_maruku.rb

@@ -0,0 +1,84 @@
+$:.unshift File.dirname(__FILE__)
+
+require "rubygems"
+gem "maruku"
+require "maruku"
+
+module LiterateMaruku
+  # The public interface to Literate Maruku
+  #
+  # Besides these methods, maruku itself is exented to handle the new meta-data
+  # keywords. In your Markdown code use <tt>{: execute}</tt> to evaluate the 
+  # code block and <tt>{: execute attach_output}</tt> to evaluate the code and 
+  # attach the result to the generated document. See our website or the tests 
+  # for further examples.
+  module ClassMethods
+    # <tt>file</tt> has to have a <tt>.mkd</tt> extension. The LOAD_PATH will 
+    # be used to find the file. It will be simply executed. If called with 
+    # <tt>:output => dir</tt> html generated from the markdown document will 
+    # be stored in the given directory. The resulting file name will include 
+    # the basename of <tt>file</tt> and the <tt>.html</tt> file extension.
+    def require(file, options = {})
+      document = generate_output(file)
+      store_in_file(File.basename(file, ".mkd"), document, options[:output])
+      document 
+    end
+
+    private
+    def generate_output(file)
+      Maruku.new(markdown_string(file)).to_html_document
+    end
+
+    def markdown_string(file)
+      dir = $:.find { |load_dir| File.exists?(File.join(load_dir, file)) }
+      File.open(File.join(dir, file)){|f| f.readlines.join}
+    end
+
+    def store_in_file(file_base_name, string, directory)
+      if directory
+        File.open(File.join(directory, file_base_name + ".html"), "w") do |f|
+          f.puts(string)
+        end
+      end
+    end
+  end
+
+  extend ClassMethods
+end
+
+$literate_maruku_binding = binding
+
+# This is the basic module provided by Maruku, but Literate Maruku added three
+# parameters to configure its behaviour.
+#
+# Set <tt>MaRuKu::Globals[:execute]</tt> to true, if you like to execute code 
+# block by default. To disable the execution for single blocks, add 
+# <tt>{: execute=false}</tt>.
+#
+# Set <tt>MaRuKu::Globals[:attach_output]</tt> to true, if you like to attach 
+# the results of code blocks by default. To disable this option for single 
+# blocks, add <tt>{: attach_output=false}</tt>.
+module MaRuKu
+  Globals[:execute] = false
+  Globals[:attach_output] = false
+  Globals[:hide] = false
+
+  module Out # :nodoc: all
+    module HTML
+      unless instance_methods.include? "to_html_code_using_pre_with_literate"
+        def to_html_code_using_pre_with_literate(source)
+          if get_setting(:execute)
+            value = eval(source, $literate_maruku_binding)
+            source += "\n>> " + value.inspect if get_setting(:attach_output)
+          end
+          to_html_code_using_pre_without_literate(source) if !get_setting(:hide)
+        end
+
+        alias_method :to_html_code_using_pre_without_literate,
+                     :to_html_code_using_pre
+        alias_method :to_html_code_using_pre,
+                     :to_html_code_using_pre_with_literate
+      end
+    end
+  end
+end

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.join(File.dirname(__FILE__), '..')
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.join(File.dirname(__FILE__), '..')
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/script/txt2html

@@ -0,0 +1,74 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+begin
+  require 'newgem'
+rescue LoadError
+  puts "\n\nGenerating the website requires the newgem RubyGem"
+  puts "Install: gem install newgem\n\n"
+  exit(1)
+end
+require 'redcloth'
+require 'syntax/convertors/html'
+require 'erb'
+require File.dirname(__FILE__) + '/../lib/literate_maruku/version.rb'
+
+version  = LiterateMaruku::VERSION::STRING
+download = 'http://rubyforge.org/projects/literate_maruku'
+
+class Fixnum
+  def ordinal
+    # teens
+    return 'th' if (10..19).include?(self % 100)
+    # others
+    case self % 10
+    when 1: return 'st'
+    when 2: return 'nd'
+    when 3: return 'rd'
+    else    return 'th'
+    end
+  end
+end
+
+class Time
+  def pretty
+    return "#{mday}#{mday.ordinal} #{strftime('%B')} #{year}"
+  end
+end
+
+def convert_syntax(syntax, source)
+  return Syntax::Convertors::HTML.for_syntax(syntax).convert(source).gsub(%r!^<pre>|</pre>$!,'')
+end
+
+if ARGV.length >= 1
+  src, template = ARGV
+  template ||= File.join(File.dirname(__FILE__), '/../website/template.rhtml')
+  
+else
+  puts("Usage: #{File.split($0).last} source.txt [template.rhtml] > output.html")
+  exit!
+end
+
+template = ERB.new(File.open(template).read)
+
+title = nil
+body = nil
+File.open(src) do |fsrc|
+  title_text = fsrc.readline
+  body_text = fsrc.read
+  syntax_items = []
+  body_text.gsub!(%r!<(pre|code)[^>]*?syntax=['"]([^'"]+)[^>]*>(.*?)</\1>!m){
+    ident = syntax_items.length
+    element, syntax, source = $1, $2, $3
+    syntax_items << "<#{element} class='syntax'>#{convert_syntax(syntax, source)}</#{element}>"
+    "syntax-temp-#{ident}"
+  }
+  title = RedCloth.new(title_text).to_html.gsub(%r!<.*?>!,'').strip
+  body = RedCloth.new(body_text).to_html
+  body.gsub!(%r!(?:<pre><code>)?syntax-temp-(\d+)(?:</code></pre>)?!){ syntax_items[$1.to_i] }
+end
+stat = File.stat(src)
+created = stat.ctime
+modified = stat.mtime
+
+$stdout << template.result(binding)