LiterateRuby 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b08338d5e80fbb76ac865adee47d0806f117b5c0
-  data.tar.gz: b9b722beadec98f4ec61129b27f48ba1837136b6
+  metadata.gz: e447d2337768c6fd301b6187acdc96ab2bfad880
+  data.tar.gz: 48cf19a95f428bc1e423abd3b05ec51f62cd97b8
 SHA512:
-  metadata.gz: 483c41a6bfcb163c678a6f80f2c743b7b4bb7c51f0bdf22ad03c1a8d289a533ace263d8d0f164269093442c56f4b6f2dbbf21c545e6672a9fc1a3f3226adf042
-  data.tar.gz: a56c1ecd7fb721ce91f4d89155f323bd8240d36d144ad94a0614cbc4c51cfb40ad62b84e14510db44d9e018c12a130d82f2ddb2843c5c1c76acc0feb0a2920bb
+  metadata.gz: 850ad55aacad8835c4884902349635d6fea355bda572637cfbbda296b9615a1e292ceb93ecac20dab88b194bc43e408b8972204544595cb86b9ef36dbf8f50be
+  data.tar.gz: 5fbe2061d2155277d0f672f9699ddc1bbfc20e004ed9c1f03b248a73f57a1b10401d17b9052843d93724f1b4a5851a60e8ba29abe3082ea415750c28319f962b

data/README.md

@@ -5,6 +5,21 @@ Version](https://badge.fury.io/rb/LiterateRuby.svg)](https://badge.fury.io/rb/Li
 ## Name
 The name is inspired by Literate Haskell.
 
+## Installation
+This gem can be install using `gem` as follows:
+
+```bash
+gem install LiterateRuby
+```
+
+## Executable
+
+The executable for this is called `lruby`. It can be used as such
+
+```bash
+lruby file.lrb
+```
+
 ## Usage
 
 A file like this

data/Rakefile

@@ -12,6 +12,11 @@ task :clean do
   `rm *.gem`
 end
 
+task :install do
+  `gem build literate-ruby.gemspec`
+  `gem install *.gem`
+end
+
 task :build do
   `gem build literate-ruby.gemspec`
 end

data/bin/lruby

@@ -4,10 +4,17 @@ require 'literate-ruby'
 outputs = []
 exit_status = 0
 
+flags = ARGV.select { |i| i[0] == '-' }
+eval_flag = flags.include?('-e')
+ARGV.reject! { |i| i[0] == '-' }
+
 ARGV.each do |f|
   if f[-4..-1] != '.lrb'
     STDERR.puts "Error: #{f} is not a literate ruby file."
     exit_status = 1
+  elsif eval_flag
+    j = LiterateRuby::File.new(f)
+    outputs << j.to_eval_markdown
   else
     j = LiterateRuby::File.new(f)
     outputs << j.parse
@@ -16,6 +23,6 @@ ARGV.each do |f|
   end
 end
 
-puts "Files created:"
-outputs.each{|i| puts "  x - #{i}"}
+puts 'Files created:'
+outputs.each { |i| puts "  x - #{i}" }
 exit exit_status

data/lib/literate-ruby/file.rb

@@ -1,58 +1,89 @@
+require 'stringio'
+
 module LiterateRuby
-  # This class is the file class for literate ruby.
-  # It mostly just inherits from Ruby's default File class.
+  # This class is the file class for literate ruby. It extends Ruby's
+  # +File+ class.
   #
-  # The method in this class that is added is `parse`. This method
-  # parses a literate ruby file (extension `.lrb`).
+  # @attr base [String] the base name of the file
   class File < File
+    attr_accessor :base
+
+    # The constructor for +LiterateRuby::File+
+    #
+    # @param *args the arguments that are passed to super.
+    def initialize(*args)
+      super(*args)
+      @base = File.basename(path, '.*')
+    end
+
     # This method parses a literate ruby file, (which should have the
-    # extension `.lrb`), to a normal ruby file (which will have the 
-    # extension `.rb`). 
+    # 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 #{base}.rb`
       file = read
       File.open("#{base}.rb", 'w') do |f|
         file.each_line do |line|
-          f.write(line[2..-1]) if line[0...2] == '> '
+          f.write(line[2..-1]) if line[0..1] == '> '
         end
       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`). 
+    # 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
+    def to_markdown
+      f = File.new("#{base}.md", 'w')
+      block = false
+      read.each_line { |l| block = to_markdown_helper(l, f, block) }
+      "#{base}.md"
+    end
+
+    def to_eval_markdown
+      f = File.new("#{base}.md", 'w+')
+      tmp_f = File.new("#{base}_tmp.rb", 'w+')
+      block = false
+      read.each_line { |l| block = to_eval_helper(l, f, tmp_f, block) }
+      `yes | rm #{base}_tmp.rb`
       "#{base}.md"
     end
+
+    private
+
+    def to_markdown_helper(l, f, block)
+      if l[0..1] == '> ' && block then f.write("    #{l[2..-1]}")
+      elsif block then block = !f.write("\n#{l}")
+      elsif l =~ /^\s+$/ then block = !f.write(l).nil?
+      else f.write(l)
+      end
+      block
+    end
+
+    def to_eval_helper(l, f, tmp_f, block)
+      if l[0..1] == '> ' && block then tmp_f.write(l[2..-1].to_s)
+      elsif block
+        block = eval_string(tmp_f, f)
+        $stdout = STDOUT
+      elsif l =~ /^\s+$/ then block = !f.write(l).nil?
+      else f.write(l)
+      end
+      block
+    end
+
+    def eval_string(tmp_f, f)
+      s = ''
+      IO.popen('ruby', 'w+') do |i|
+        i.write(tmp_f.read)
+        i.close_write
+        s = i.read
+      end
+      f.puts "    #{s}"
+      false
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: LiterateRuby
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Eli Sadoff
@@ -10,8 +10,10 @@ bindir: bin
 cert_chain: []
 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"
+description: |
+  This gem is hightly inspired by literate haskell. It currently will support
+  "bird style" which is described in full <a href="https://wiki.haskell.org/Literate_programming#Bird_Style">here</a>
+  Note: The <pre>lruby -e</pre> feature does not yet work.
 email: snood1205@gmail.com
 executables:
 - lruby