literate_maruku 0.1.0 → 0.1.1

data/History.txt

@@ -1,4 +1,13 @@
-== 0.0.1 2007-09-30
+== 0.1.1 2007-10-05
+
+* minor enhancement:
+  * Removed global variable to fetch the root binding, use class variable 
+    instead
+  * Configurable default values for execute, attach_output and hide
+  * looking for the file to load in current directory as well
+  * updated docs
+
+== 0.1.0 2007-09-30
 
 * 1 major enhancement:
   * Initial release

data/lib/literate_maruku.rb

@@ -10,27 +10,47 @@ module LiterateMaruku
   # 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.
+  # attach the result to the generated document. If you need to execute code
+  # that should not be rendered attach <tt>{: execute hide}</tt>.
   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.
+    # This accessor stores the binding, in which the code will be executed. By
+    # default, this is the root context. Use the setter to change it, if you 
+    # would like to have all your code in a special context, a module for 
+    # example.
+    attr_accessor :binding
+
+    # <tt>file</tt> has to have a <tt>.mkd</tt> extension. The 
+    # <tt>LOAD_PATH</tt> 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.
+    #
+    # Additionally default values, that influence the code generation and 
+    # execution may be set.
+    #
+    #   LiterateMaruku.require("file.mkd", :output => ".",
+    #                                      :attributes => {:execute => true})
+    #
+    # will enable execution for all code block per default, for example. Other
+    # options are <tt>:attach_output</tt> and <tt>:hide</tt>.
     def require(file, options = {})
       document = generate_output(file)
-      store_in_file(File.basename(file, ".mkd"), document, options[:output])
-      document 
+
+      document.attributes.merge!(options[:attributes] || {})
+      content = options[:inline] ? document.to_html : document.to_html_document
+      store_in_file(File.basename(file, ".mkd"), content, options[:output])
+
+      content
     end
 
     private
     def generate_output(file)
-      Maruku.new(markdown_string(file)).to_html_document
+      Maruku.new(markdown_string(file))
     end
 
     def markdown_string(file)
-      dir = $:.find { |load_dir| File.exists?(File.join(load_dir, file)) }
+      dir = $:.find{ |load_dir| File.exists?(File.join(load_dir, file)) } || "."
       File.open(File.join(dir, file)){|f| f.readlines.join}
     end
 
@@ -46,7 +66,7 @@ module LiterateMaruku
   extend ClassMethods
 end
 
-$literate_maruku_binding = binding
+LiterateMaruku.binding = binding
 
 # This is the basic module provided by Maruku, but Literate Maruku added three
 # parameters to configure its behaviour.
@@ -58,6 +78,9 @@ $literate_maruku_binding = binding
 # 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>.
+#
+# *Note*: These settings may also be configured on an instance basis, when
+# calling <tt>LiterateMaruku#require</tt> with an attributes Hash.
 module MaRuKu
   Globals[:execute] = false
   Globals[:attach_output] = false
@@ -67,17 +90,22 @@ module MaRuKu
     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)
+          if is_true?(:execute)
+            value = eval(source, LiterateMaruku.binding)
+            source += "\n>> " + value.inspect if is_true?(:attach_output)
           end
-          to_html_code_using_pre_without_literate(source) if !get_setting(:hide)
+          to_html_code_using_pre_without_literate(source) if !is_true?(: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
+
+        private
+        def is_true?(key)
+          get_setting(key) && get_setting(key) != "false"
+        end
       end
     end
   end

data/lib/literate_maruku/version.rb

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

data/website/index.html

@@ -33,7 +33,7 @@
     <h1>literate_maruku</h1>
     <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/literate_maruku"; return false'>
       <p>Get Version</p>
-      <a href="http://rubyforge.org/projects/literate_maruku" class="numbers">0.1.0</a>
+      <a href="http://rubyforge.org/projects/literate_maruku" class="numbers">0.1.1</a>
     </div>
     <h1>&#x2192; &#8216;literate_maruku&#8217;</h1>
 

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: literate_maruku
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
-date: 2007-09-30 00:00:00 +02:00
+  version: 0.1.1
+date: 2007-10-05 00:00:00 +02:00
 summary: Literate programming for ruby based on maruku
 require_paths: 
 - lib