literate-programming 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0579c7998d6a577731d88aaf496b921958e1c6c7
-  data.tar.gz: 9e080bfd77245430a9cf245526651510d308c0c9
+  metadata.gz: 0e9b0f7406805966440cc4ae3043db64a8d08add
+  data.tar.gz: 67c2cc7eee3a515cb6d75a371c5e3dc79a17f4e1
 SHA512:
-  metadata.gz: ef5992afcf34d3bfcf24608850b4d0d5f6cb9eab9989315fb22ebf3c739bbae6ed2f84c0ea8ef60b38f8c87d565b32b62e05743e9ea07f4b198a293991b31d37
-  data.tar.gz: a54eb1c3414d1d6a74dffde4897dd9d898a6362d564acfcaecb8224502f2ee7a33f89b6a1090a30a2fa4b12befed28e5aa118a6a48cfd30aaa7873637a06090f
+  metadata.gz: 9742cc495c710c0737f81104f6c0c299b17670f1a7f4529d0ad2e390afc119237248f5cf719cfd6f60c6ad65ab42701902f5a80ce669b22d72e358f5899b263a
+  data.tar.gz: 976a254e9595a2ad8e89a463cd7a2efbf9a7aa4cf8d795fee37bab841588e6b37c49b7da9056b78fdbb1ee77f427409a9be30c3618816fef790c9e86627ca35d

data/README.md

@@ -37,8 +37,7 @@ $ rweave example.wrb # to get example.md
 ```
 
 ## Examples
-- Hello, world!
-
+### Hello, world!
 First, write hellow.wrb
 ```
 First, define the Hello, world!
@@ -70,6 +69,77 @@ end
 main
 ```
 
+### 99 Bottles
+This gem provides the Template Meta Programming.
+For example, below code is an implementation of the 99-bottles.
+
+```
+First, define the main function and it sings a song ''99 bottles of beer''.
+[[*]] =
+  def main
+    [[bottles:100]]
+  end
+
+General case, sing below
+If the label-name end with ':@', the rtangle accepts the codes as a general template.
+In the general template code,
+- if '@'-mark followed by a number, the rtangle replaces it with an argument.
+- if '@@'-mark followed by parents, the rtangle replaces it with return value of the insides.
+[[bottles:@]] =
+  puts '@0 bottles of beer on the wall, @0 bottles of beer.'
+  puts 'Take one down and pass it around, @@(@0 - 1) bottles of beer on the wall.'
+  [[bottles:@@(@0 - 1)]]
+
+The template code is also able to specialize.
+If the rtangle does not find the specialized one,
+it specializes from general template code like above.
+When number of bottles == 2
+[[bottles:2]] =
+  puts '2 bottles of beer on the wall, 2 bottles of beer.'
+  puts 'Take one down and pass it around, 1 bottle of beer on the wall.'
+  [[bottles:1]]
+
+When number of bottles == 1
+[[bottles:1]] =
+  puts '1 bottle of beer on the wall, 1 bottle of beer.'
+  puts 'Take one down and pass it around, no more bottles of beer on the wall.'
+  [[bottles:0]]
+
+When no rest bottles...
+[[bottles:0]] =
+  puts 'No more bottles of beer on the wall, no more bottles of beer.'
+  puts 'Go to the store and buy some more, 99 bottles of beer on the wall.'
+
+Finally, call the main function.
+[[*]] +=
+  main
+```
+
+### More Meta Method
+This gem also provides lisp-like macro. Use *before* label to define functions
+that returns eval-able string.
+
+```
+If you want to do something that requires many sentence,
+you can use *before* label;
+It will be expanded and be evaluated by rtangle to help to write.
+[[*]] =
+  def main
+    @@(helper_function)
+  end
+
+For example, *before* label likes below;
+Note: the *before*before* label, the *before*before*before* label, and so on, are also exists.
+[[*before*]] =
+  def helper_function
+    return "p 'Hello, world!'"
+  end
+
+Finally, call the main function.
+[[*]] +=
+  main
+```
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/example/labels-before.wrb

@@ -0,0 +1,18 @@
+If you want to do something that requires many sentence,
+you can use *before* label;
+It will be expanded and be evaluated by rtangle to help to write.
+[[*]] =
+  def main
+    @@(helper_function)
+  end
+
+For example, *before* label likes below;
+Note: the *before*before* label, the *before*before*before* label, and so on, are also exists.
+[[*before*]] =
+  def helper_function
+    return "p 'Hello, world!'"
+  end
+
+Finally, call the main function.
+[[*]] +=
+  main

data/lib/literate/programming/version.rb

@@ -1,5 +1,5 @@
 module Literate
   class Programming
-    VERSION = "1.0.0"
+    VERSION = "1.1.0"
   end
 end

data/lib/literate/programming.rb

@@ -5,6 +5,12 @@ module Literate
     def initialize(src = "", source: nil, tabstop: 2)
       @source = source || src
       @tabstop = tabstop
+      @eval_context = BasicObject.new
+      @eval_context.instance_eval <<-EOC
+        def gensym
+          return (0 .. 20).collect { ('a' .. 'z')[rand(26)] }.join
+        end
+      EOC
     end
 
     def to_ruby
@@ -81,12 +87,13 @@ module Literate
         md << '```' << $/
       end
       table['*'] ||= ''
-      return {rb: indent_code(expand(table)), md: indent_text(md)}
+      return {rb: indent_code(expand(table, '*')), md: indent_text(md)}
     end
 
-    def expand(table)
+    def expand(table, label)
+      @eval_context.instance_eval(expand(table, label + 'before*')) if table.member? label + 'before*'
       processed = ''
-      processing = '[[*]]'
+      processing = "[[#{label}]]"
       while processing.match /^((?:[^\[]|\[[^\[])*)\[\[([^\]]+)\]\]/m
         processed << $1
         expanding = $2
@@ -121,7 +128,7 @@ module Literate
           if follow.match /^(?<paren>\((?:[^()]|\g<paren>)*\))/m then
             # @@(expr) -> eval(expr)
             post_match = $~.post_match
-            expanding = eval(expand_template $1, args)
+            expanding = @eval_context.instance_eval(expand_template $1, args)
             processed << expanding.to_s
             processing = post_match
           else

data/spec/lib/literate/programming_spec.rb

@@ -492,6 +492,61 @@ end
 Finally, instanciate Main and run it!
 ```ruby:* append
 Main.new.run
+```
+    EOC
+  end
+
+  it '*before* label' do
+    inst = Literate::Programming.new <<-EOM
+If you want to do something that requires many sentence,
+you can use *before* label;
+It will be expanded and be evaluated by rtangle to help to write.
+[[*]] =
+  def main
+    @@(helper_function)
+  end
+
+For example, *before* label likes below;
+Note: the *before*before* label, the *before*before*before* label, and so on, are also exists.
+[[*before*]] =
+  def helper_function
+    return "p 'Hello, world!'"
+  end
+
+Finally, call the main function.
+[[*]] +=
+  main
+    EOM
+
+    expect(inst.to_ruby).to eq <<-EOC
+def main
+  p 'Hello, world!'
+end
+
+main
+    EOC
+
+    expect(inst.to_md).to eq <<-EOC
+If you want to do something that requires many sentence,
+you can use *before* label;
+It will be expanded and be evaluated by rtangle to help to write.
+```ruby:*
+def main
+  @@(helper_function)
+end
+```
+
+For example, *before* label likes below;
+Note: the *before*before* label, the *before*before*before* label, and so on, are also exists.
+```ruby:*before*
+def helper_function
+  return "p 'Hello, world!'"
+end
+```
+
+Finally, call the main function.
+```ruby:* append
+main
 ```
     EOC
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: literate-programming
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - pixie-grasper
@@ -67,6 +67,7 @@ files:
 - Rakefile
 - bin/rtangle
 - bin/rweave
+- example/labels-before.wrb
 - example/simple-1.wrb
 - example/simple-2.wrb
 - example/simple-3.wrb