literate_maruku 0.1.1 → 0.1.2

data/.gitignore

@@ -0,0 +1,3 @@
+doc
+pkg
+log

data/History.txt

@@ -1,3 +1,10 @@
+== 0.1.2 2009-11-28
+
+* major enhancements
+  * moved to gemcutter
+* minor enhancements
+  * removed all old cruft
+
 == 0.1.1 2007-10-05
 
 * minor enhancement:

data/README.rdoc

@@ -0,0 +1,133 @@
+= Literate Maruku
+
+Literate Maruku is a literate programming libary for ruby based on the markdown
+libary maruku. This is basically what the name say, isn't it?
+
+== The Basics
+
+There are two possible accesses to the libary. A programming API and a command 
+line interface. The first may be used to write better documented tests, 
+for example. Just write a little bit of code in your test_helper and call
+Literate Maruku there and your markdown formatted tests will be executed.
+
+The command line interface may the be used inside of a rake task, e.g. to
+generate some html files out of your test files demonstrating their usage. 
+We have used this approach in ContextR, so have a look there to get some input.
+
+
+== Demonstration of Use
+
+=== The Markdown Syntax
+
+Literate Maruku simply extends the functionality of Maruku and adds some
+methods to make standard use cases easier. You may find detailed information
+about maruku at {their project page}[http://maruku.rubyforge.org/]. They added
+some nice features to {Markdown
+formatting}[http://daringfireball.net/projects/markdown/syntax], esp. the {meta
+data syntax}[http://maruku.rubyforge.org/proposal.html] which made implementing
+literate maruku a charm.
+
+Wanna see examples? Okay, here they are:
+
+==== Markdown
+
+  This is a normal paragraph, followed by a plain old code block
+
+      literate_maruku == maruku + ruby
+
+  And the following code block will not only be rendered, but also executed.
+
+      def echo_block(string)
+        (0...(text.size)).map{|i| text[0..i]}.reverse.join(" ... ")
+      end
+  {: execute}
+
+  And, finally, the following block will be executed and its output will be 
+  rendered as well.
+
+      echo_block("hallo")
+  {: execute attach_output}
+
+
+==== HTML
+
+This is a normal paragraph, followed by a plain old code block
+
+  literate_maruku == maruku + ruby
+
+And the following code block will not only be rendered, but also executed.
+
+  def echo_block(string)
+    (0...(text.size)).map{|i| text[0..i]}.reverse.join(" ... ")
+  end
+
+And, finally, the following block will be executed and its output will be 
+rendered as well.
+
+  echo_block("hallo")
+  >> "hello ... hell ... hel ... he ... h"
+
+
+== The Command Line Interface
+
+Simply call <tt>literate_maruku filename.mkd</tt> to load your markdown
+formatted ruby files. This will execute the code but not generate any output.
+It basically works like a simpe <tt>ruby filename.rb</tt> call, but without all
+the command line parameters the +ruby+ command supports.
+
+If you like to generate some html files, append an additional parameter, which
+tells literate_maruku where to put the output. 
+<tt>literate_maruku --output_path=test filename.mkd</tt> would file the output 
+of <tt>filename.mkd</tt> to <tt>test/filename.html</tt>. That's all, folks.
+
+== The Programming Interface
+
+To use Literate Maruku in your own special way simply use the 
+<tt>LiterateMaruku#require</tt> method.
+
+  require 'literate_maruku'
+  
+  LiterateMaruku.require('filename.mkd') # or
+  LiterateMaruku.require('filename.mkd', :output => "test")
+
+These will have the same result as the command line examples.
+
+If you are unhappy with these little possibilities, no problem: You may still
+use the standard maruku interface to do with your markdown string, what you like
+after require'ing literate_maruku the maruku code base is extended for the 
+literate programming style.
+
+
+== Installing & Compatibility
+
+  gem install literate_maruku
+
+Literate Maruku is currently only tested and known to work with 
+
+* Ruby 1.8.6 and 1.8.7 (MRI)
+* Ruby 1.9.1 (YARV)
+* JRuby 1.x
+
+
+== Additional Resources
+
+* {Project's website}[http://github.com/schmidt/literate_maruku/]
+* {API doc}[http://rdoc.info/projects/schmidt/literate_maruku]
+* {Build Status on RunCodeRun}[http://runcoderun.com/schmidt/literate_maruku]
+
+
+== How to submit patches
+
+In order to submit patches, please fork the repository on GitHub, add your
+patches to your own copy and send a "Pull Request" afterwards. I will then try
+to add your submissions as soon as possible. Patches containing corresponding
+tests are always welcome.
+
+Bug reports or general feature requests should be added using GitHub Issues.
+
+
+== License
+
+This code is free to use under the terms of the MIT license. 
+
+  :include: License.txt

data/Rakefile

@@ -1,4 +1,44 @@
-require 'config/requirements'
-require 'config/hoe' # setup Hoe + all gem configuration
+require 'rake'
+require 'rake/rdoctask'
 
-Dir['tasks/**/*.rake'].each { |rake| load rake }
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "literate_maruku"
+    gemspec.summary = "Literate programming for Ruby based on Maruku."
+    gemspec.description = "Given Ruby's open classes and Maruku's powerful " + 
+      "parser architecture, literate_maruku provides a basic literate " +
+      "programming environment for Ruby."
+    gemspec.email = "ruby@schmidtwisser.de"
+    gemspec.homepage = "http://github.com/schmidt/literate_maruku"
+    gemspec.authors = ["Gregor Schmidt"]
+
+    gemspec.executable = "literate_maruku"
+
+    gemspec.add_dependency('maruku', '>= 0.6.0')
+
+    gemspec.add_development_dependency('rake')
+    gemspec.add_development_dependency('jeweler', '>= 1.4.0')
+  end
+
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler"
+end
+
+desc "Run all tests"
+task :test do 
+  require 'rake/runtest'
+  Rake.run_tests 'test/**/*_test.rb'
+end
+
+desc 'Generate documentation for the literate_maruku gem.'
+Rake::RDocTask.new(:doc) do |doc|
+  doc.rdoc_dir = 'doc'
+  doc.title = 'literate_maruku'
+  doc.options << '--line-numbers' << '--inline-source'
+  doc.rdoc_files.include('README.rdoc')
+  doc.rdoc_files.include('lib/**/*.rb')
+end
+
+task :default => :test

data/bin/literate_maruku

@@ -11,8 +11,6 @@ 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
 }
@@ -25,7 +23,7 @@ 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/
+http://github.com/schmidt/literate_maruku/
 
 Usage: #{File.basename($0)} [options] filename.mkd
 

data/lib/literate_maruku.rb

@@ -1,7 +1,7 @@
 $:.unshift File.dirname(__FILE__)
 
 require "rubygems"
-gem "maruku"
+gem "maruku", ">= 0.6.0"
 require "maruku"
 
 module LiterateMaruku
@@ -44,14 +44,21 @@ module LiterateMaruku
       content
     end
 
-    private
+  private
     def generate_output(file)
       Maruku.new(markdown_string(file))
     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}
+      if File.exist?(file)
+        filename = file
+      else
+        dir = $:.find{ |load_dir| File.exist?(File.join(load_dir, file)) }
+        raise LoadError, "no such file to load -- #{file}" if dir.nil?
+
+        filename = File.join(dir, file)
+      end
+      File.open(filename) { |f| f.readlines.join }
     end
 
     def store_in_file(file_base_name, string, directory)
@@ -102,7 +109,7 @@ module MaRuKu
         alias_method :to_html_code_using_pre,
                      :to_html_code_using_pre_with_literate
 
-        private
+      private
         def is_true?(key)
           get_setting(key) && get_setting(key) != "false"
         end

data/literate_maruku.gemspec

@@ -0,0 +1,63 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{literate_maruku}
+  s.version = "0.1.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Gregor Schmidt"]
+  s.date = %q{2009-11-28}
+  s.default_executable = %q{literate_maruku}
+  s.description = %q{Given Ruby's open classes and Maruku's powerful parser architecture, literate_maruku provides a basic literate programming environment for Ruby.}
+  s.email = %q{ruby@schmidtwisser.de}
+  s.executables = ["literate_maruku"]
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "History.txt",
+     "License.txt",
+     "README.rdoc",
+     "Rakefile",
+     "bin/literate_maruku",
+     "lib/literate_maruku.rb",
+     "literate_maruku.gemspec",
+     "test/literate_maruku_test.rb",
+     "test/test_document.mkd",
+     "test/test_helper.rb",
+     "version.yml"
+  ]
+  s.homepage = %q{http://github.com/schmidt/literate_maruku}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Literate programming for Ruby based on Maruku.}
+  s.test_files = [
+    "test/literate_maruku_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<maruku>, [">= 0.6.0"])
+      s.add_development_dependency(%q<rake>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 1.4.0"])
+    else
+      s.add_dependency(%q<maruku>, [">= 0.6.0"])
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 1.4.0"])
+    end
+  else
+    s.add_dependency(%q<maruku>, [">= 0.6.0"])
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 1.4.0"])
+  end
+end
+

data/test/{test_literate_maruku.rb → literate_maruku_test.rb}

@@ -1,70 +1,72 @@
-require File.dirname(__FILE__) + '/test_helper.rb'
-
-class TestMaRuKu < Test::Unit::TestCase
-  def test_should_not_execute_each_and_every_code_environment
-    doc = Maruku.new(%q{    THIS_CONSTANT_WILL_NOT_BE_DEFINED = true})
-
-    output = %q{
-<pre><code>THIS_CONSTANT_WILL_NOT_BE_DEFINED = true</code></pre>
-}
-
-    assert_equal output, doc.to_html 
-    assert !Object.const_defined?("THIS_CONSTANT_WILL_NOT_BE_DEFINED")
-  end
-
-  def test_should_execute_code_with_metadata
-    doc = Maruku.new(%q{
-    TEST_WORKS = true
-{: execute}})
-
-    output = %q{
-<pre><code>TEST_WORKS = true</code></pre>
-}
-
-    assert_equal output, doc.to_html 
-    assert Object.const_defined?("TEST_WORKS")
-    assert TEST_WORKS
-  end
-  
-  def test_should_attach_output_if_requested
-    doc = Maruku.new(%q{
-    1 + 1 == 2
-{: execute attach_output}})
-
-    output = %q{
-<pre><code>1 + 1 == 2
-&gt;&gt; true</code></pre>
-}
-
-    assert_equal output, doc.to_html 
-  end
-end
-
-class LiterateMarukuTest < Test::Unit::TestCase
-  def setup
-    @dirname = File.dirname(__FILE__)
-    @base_filename = "test_document"
-
-    @mkd_filename =  @base_filename + ".mkd"
-    @html_filename =  @base_filename + ".html"
-
-    @full_filename = File.join(@dirname, @html_filename)
-
-    File.delete(@full_filename) if File.exists?(@full_filename)
-  end
-
-  def teardown
-    File.delete(@full_filename) if File.exists?(@full_filename)
-  end
-
-  def test_require_should_execute_annotated_code_environments
-    LiterateMaruku.require(@mkd_filename)
-    assert $this_code_block_will_be_executed 
-  end
-
-  def test_require_should_generate_an_html_file
-    LiterateMaruku.require(@mkd_filename, :output => @dirname)
-
-    assert File.exists?(@full_filename)
-  end
-end
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class MaRuKuTest < Test::Unit::TestCase
+  def test_should_not_execute_each_and_every_code_environment
+    doc = Maruku.new(%q{    THIS_CONSTANT_WILL_NOT_BE_DEFINED = true})
+
+    output = %q{<pre><code>THIS_CONSTANT_WILL_NOT_BE_DEFINED = true</code></pre>}
+
+    assert_equal output, doc.to_html 
+    assert !Object.const_defined?("THIS_CONSTANT_WILL_NOT_BE_DEFINED")
+  end
+
+  def test_should_execute_code_with_metadata
+    doc = Maruku.new(%q{
+    TEST_WORKS = true
+{: execute}})
+
+    output = %q{<pre><code>TEST_WORKS = true</code></pre>}
+
+    assert_equal output, doc.to_html 
+    assert Object.const_defined?("TEST_WORKS")
+    assert TEST_WORKS
+  end
+  
+  def test_should_attach_output_if_requested
+    doc = Maruku.new(%q{
+    1 + 1 == 2
+{: execute attach_output}})
+
+    output = %q{<pre><code>1 + 1 == 2
+&gt;&gt; true</code></pre>}
+
+    assert_equal output, doc.to_html 
+  end
+end
+
+class LiterateMarukuTest < Test::Unit::TestCase
+  def setup
+    @dirname = File.dirname(__FILE__)
+    @base_filename = "test_document"
+
+    @mkd_filename =  File.join(@dirname, @base_filename + ".mkd")
+    @html_filename = File.join(@dirname, @base_filename + ".html")
+
+    teardown
+  end
+
+  def teardown
+    File.delete(@html_filename) if File.exists?(@html_filename)
+  end
+
+  def test_require_should_execute_annotated_code_environments
+    LiterateMaruku.require(@mkd_filename)
+    assert $this_code_block_will_be_executed 
+  end
+
+  def test_require_should_not_execute_every_code_environment
+    LiterateMaruku.require(@mkd_filename)
+    assert !$this_code_block_will_not_be_executed 
+  end
+
+  def test_require_should_generate_an_html_file
+    LiterateMaruku.require(@mkd_filename, :output => @dirname)
+    assert File.exists?(@html_filename)
+  end
+
+  def test_require_should_raise_load_error_for_missing_files
+    assert_raise(LoadError) do
+      LiterateMaruku.require("missing_file.mkd")
+    end
+  end
+end

data/version.yml

@@ -0,0 +1,4 @@
+---
+:major: 0
+:minor: 1
+:patch: 2

metadata

@@ -1,99 +1,96 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.4
-specification_version: 1
 name: literate_maruku
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
-date: 2007-10-05 00:00:00 +02:00
-summary: Literate programming for ruby based on maruku
-require_paths: 
-- lib
-email: ruby@schmidtwisser.de
-homepage: http://rug-b.rubyforge.org/literate_maruku
-rubyforge_project: rug-b
-description: Literate programming for ruby based on maruku
-autorequire: 
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  version: 0.1.2
 platform: ruby
-signing_key: 
-cert_chain: 
-- |
-  -----BEGIN CERTIFICATE-----
-  MIIDODCCAiCgAwIBAgIBADANBgkqhkiG9w0BAQUFADBCMQ0wCwYDVQQDDARydWJ5
-  MR0wGwYKCZImiZPyLGQBGRYNc2NobWlkdHdpc3NlcjESMBAGCgmSJomT8ixkARkW
-  AmRlMB4XDTA3MDkxNjEwMzkyN1oXDTA4MDkxNTEwMzkyN1owQjENMAsGA1UEAwwE
-  cnVieTEdMBsGCgmSJomT8ixkARkWDXNjaG1pZHR3aXNzZXIxEjAQBgoJkiaJk/Is
-  ZAEZFgJkZTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAOzbl83o33wh
-  veLMQ2JyEstgOulisHRBFpfbF9LbdavuS/EdoOUeEPkziWL/ZI0jvUo0MGmQ/8Of
-  F9DJbvNbhDdg0bK7BMe4R/I3Wpu49mX+7pOsdlC44nzJkVG1DQ67qWp6jx1zvDRc
-  iCoXaQKnROtsx6bCavVvm4P7XLrAQvs7l+1Ke5KLkXRtJ9xJWtAyBLRFoM4e6DeT
-  Py0DsixF9Zb5Nrb7UvK0CN8m6dulsKXNRDVQLHkFa5Zg/BEb0RI93LPmeBt8KGIE
-  eYVjk+6z+py03D18xd9KsUhOB/0lC0a5vWSZIKfZnxf1uYY9TTZVqTGGUMFi1sD4
-  k2TYBqQVsS8CAwEAAaM5MDcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0O
-  BBYEFAeq4388e2PUlF/YeemzaY8neefWMA0GCSqGSIb3DQEBBQUAA4IBAQAArQQo
-  3teQbCcYmZFTrdOzujMca6F4JVzTp+yTnOsp1/5hiBEUMc3GreCVAPh2tU9+IpuB
-  Lif+s5nLfYdI+JrpCHDzm+ecJEJ7u7gxidzUwEBPYpVuU32ALge7fuWWhQfi29JY
-  QwNZgIkGe34z3a2+r2GLBns/GY7t0Lomv6U2SvwLreLc8g7thr2hZfgEJidvcrJR
-  Q6amsFqY06NalH+I175Bp4y9rR7IArgNDS3I5Cly5/heVKK2SRm5Z+IACmKMxIXh
-  hzBK8YDsrjUvPNIJn9yl0LeEsZ5VhupI2OXr6Cqa/tVMJq0oiTsLfel3Tsb9Ph83
-  y3O9DT3o4BiyPe77
-  -----END CERTIFICATE-----
-
-post_install_message: 
 authors: 
 - Gregor Schmidt
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-28 00:00:00 +01:00
+default_executable: literate_maruku
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: maruku
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.6.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.4.0
+    version: 
+description: Given Ruby's open classes and Maruku's powerful parser architecture, literate_maruku provides a basic literate programming environment for Ruby.
+email: ruby@schmidtwisser.de
+executables: 
+- literate_maruku
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
 files: 
+- .gitignore
 - History.txt
 - License.txt
-- Manifest.txt
-- README.txt
+- README.rdoc
 - 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
+- literate_maruku.gemspec
+- test/literate_maruku_test.rb
 - 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
-test_files: 
-- test/test_helper.rb
-- test/test_literate_maruku.rb
-rdoc_options: 
-- --main
-- README.txt
-extra_rdoc_files: 
-- History.txt
-- License.txt
-- Manifest.txt
-- README.txt
-- website/index.txt
-executables: 
-- literate_maruku
-extensions: []
+- version.yml
+has_rdoc: true
+homepage: http://github.com/schmidt/literate_maruku
+licenses: []
 
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: []
 
-dependencies: []
-
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Literate programming for Ruby based on Maruku.
+test_files: 
+- test/literate_maruku_test.rb
+- test/test_helper.rb

data/Manifest.txt

@@ -1,26 +0,0 @@
-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

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