LiterateRuby 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a83fe70c28d8a6cb8cc3405ad8d4a74a7524e76e
-  data.tar.gz: 836191dec59cbd069d3071b67c2b5c88b60b17c0
+  metadata.gz: 1ea055a2a41a4063b6e6c5606af470102f4b6f23
+  data.tar.gz: 9f7b160248668541eeb3252512c3194900df1436
 SHA512:
-  metadata.gz: 3e74933ae262fd7a7457b972bea899a2e078d37b7e38a1c38fb46fe945193c9fe067c5f9671777cc539bff8c68199b6d35f988dc16277c205d7c80e1e92c6e67
-  data.tar.gz: bcc1add2ddc784458b8f5b7071de7b5b2a6b6c2defbd166c3fe01942c7fa78da5eba66c67962370608f91e6615442f452efe0bd4ebea6ab886990651970515e9
+  metadata.gz: 72b5e0e705f045d115e4ac8474f4b7aa158386d6b962a891d212bd3b96fc9036258e4b76479f087e9a233b402c5b520fc7e82141853e700760916e2aaf15ebe8
+  data.tar.gz: f6f37d59ffea3690b9dee5b061bc61503f5d81395c139bb5e560c8fbf6f05262cdea250d25920e0683321426bc3f7769f456ba347560765483e4b0f7b4b0f536

data/README.md

@@ -22,6 +22,7 @@ and here is some more commentary.
 >  end
 >  # if you want to 
 > end 
+```
 
 This is called bird style. There are specs on it
 [here](https://wiki.haskell.org/Literate_programming#Bird_Style).

data/lib/literate-ruby/file.rb

@@ -1,8 +1,18 @@
 module LiterateRuby
+  # This class is the file class for literate ruby.
+  # It mostly just inherits from Ruby's default File class.
+  #
+  # The method in this class that is added is `parse`. This method
+  # parses a literate ruby file (extension `.lrb`).
   class File < File
+    # This method parses a literate ruby file, (which should have the
+    # extension `.lrb`), to a normal ruby file (which will have the 
+    # extension `.rb`). 
+    #
+    # @return [String] the file_path to the normal ruby file.
     def parse
       base = File.basename(path, '.*')
-      `touch #{File.basename(path, '.*')}.rb`
+      `touch #{base}.rb`
       file = read
       File.open("#{base}.rb", 'w') do |f|
         file.each_line do |line|
@@ -11,5 +21,38 @@ module LiterateRuby
       end
       "#{base}.rb"
     end
+
+    # This method parses a literate ruby file, (which should have the
+    # extension `.lrb`), to a markdown file (which will have the 
+    # extension `.md`). 
+    #
+    # @param [Boolean] ghfm if true then it will be written in github
+    # flavored markdown. Otherwise it will be in a more traditional
+    # markdown format.
+    # @return [String] the file_path to the markdown file.
+    def to_markdown(ghfm = false)
+      base = File.basename(path, '.*')
+      `touch #{base}.md`
+      file = read
+      File.open("#{base}.md", 'w') do |f|
+        code_block = false
+        file.each_line do |line|
+          if line[0...2] == '> ' && code_block && !ghfm
+            f.write("    #{line[2..-1]}")
+          elsif line[0...2] == '> ' && code_block
+            f.write("#{line[2..-1]}")
+          elsif code_block
+            code_block = false
+            f.write("\n#{line}")
+          elsif line =~ /^\s+$/
+            code_block = true
+            f.write(line)
+          else
+            f.write(line)
+          end
+        end
+      end
+      "#{base}.md"
+    end
   end
 end

data/lib/literate-ruby.rb

@@ -1,4 +1,5 @@
 require 'literate-ruby/file'
 
+# This is the general module for the gem literate ruby.
 module LiterateRuby
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: LiterateRuby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Eli Sadoff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-10 00:00:00.000000000 Z
+date: 2017-01-11 00:00:00.000000000 Z
 dependencies: []
 description: "This gem is hightly inspired by literate haskell. It currently will
   support \n\"bird style\" which is described in full [here](https://wiki.haskell.org/Literate_programming#Bird_Style).\n"