livetext 0.7.3 → 0.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7873c802d4f88635f100bd1ed2f4e13774080c5e
-  data.tar.gz: 4be645e416bf86faaf51e72834e1fdb2cdf247ae
+  metadata.gz: a235fb59eb7ecf6f6de1a4768e864635ce61fa6d
+  data.tar.gz: dfdde9d1220b0b9b2d6d610aaebccbff1127f8ad
 SHA512:
-  metadata.gz: 92388a9a7c2808a0fc8a2d4053230fd72a37ba7717ee15d9192ec44201519823aef0f9df6f3417549c907f70a9b9d09546ad317bc31cf592329adf80b4588298
-  data.tar.gz: 24c677998c9966b0801c0f067ee6a3892a9651bedc889127ef9abb994d22a366bcf35da35c7c1be152c407b4f06b5aee177413199f495da8193c1d2d4c758275
+  metadata.gz: 93c9ed90b618afe54bf7a4c20e12cacd078673c51e2366ebc7fade962d74c5c5c4233ad6540214bd49e78cd8b6cdcf7a2155f24900d2c8c2ca6d30ae30b77c24
+  data.tar.gz: 3886234064afad88f2f7aa560806b60e58ff471b334715e5ad7f16f55451d5c2cd3eff7bf6f3babbb130353be34920662a03f186ac6c2319b3ba0864153fcb94

data/README.ltx

@@ -1,27 +1,27 @@
 .mixin dsl/tutorial
 .title Livetext: A smart processor for text
 
-.p Livetext is simply a tool for transforming text from one format into another. The source file
+Livetext is simply a tool for transforming text from one format into another. The source file
 has commands embedded in it, and the output is dependent on those commands.  
 
-.p Why is this special? It's very flexible, very extensible, and it's extensible _(in Ruby).  
+Why is this special? It's very flexible, very extensible, and it's extensible _(in Ruby).  
 
 .section Why Livetext?
 
-.p Livetext grew out of several motivations. One was a desire for a markup language that would permit
+Livetext grew out of several motivations. One was a desire for a markup language that would permit
 me to write articles (and even books) in my own way and on my own terms. I've done this more
 than once (and I know others who have, as well).   
 
-.p I liked Softcover, but I found it to be very complex. I never liked Markdown much -- it is very
+I liked Softcover, but I found it to be very complex. I never liked Markdown much -- it is very
 dumb and not extensible at all.  
 
-.p I wanted something that had the basic functionality of all my ad hoc solutions but allowed 
+I wanted something that had the basic functionality of all my ad hoc solutions but allowed 
 extensions. Then my old solutions would be like subsets of the new format. This was a generalization
 similar to the way we began several years ago to view HTML as a subset of XML.  
 
 .section What is Livetext really?
 
-.p Here goes:
+Here goes:
 .list
 It's a text transformer
 It's Ruby-based (later on, more language agnostic)
@@ -40,76 +40,76 @@ It could possibly augment markdown, softcover, others
 
 .section How does it work?
 
-.p A Livetext file is simply a text file which may have commands interspersed. A command is
+A Livetext file is simply a text file which may have commands interspersed. A command is
 simply a period followed by a name and optional parameters (at the beginning of a line).  
 
-.p The period is configurable if you want to use another character. The names are (for now)
+The period will be configurable later if you want to use another character. The names are (for now)
 actual Ruby method names, so names such as `to_s and `inspect are currently not allowed.  
 
-.p Currently I am mostly emitting "dumb HTML" or Markdown as output. In theory, you can write
+At present, I am mostly emitting "dumb HTML" or Markdown as output. In theory, you can write
 code (or use someone else's) to manipulate text in any way and output any format. Technically,
 you could even emit PDF, PNG, or SVG formats.
 
 . Idea: Make an RMagick DSL as an example.
 
-.p It's possible to embed comments in the text, or even to pass them through to the output 
+It's possible to embed comments in the text, or even to pass them through to the output 
 in commented form.  
 
-.p The command `.end is special, marking the end of a body of text. Some commands may operate on
+The command `.end is special, marking the end of a body of text. Some commands may operate on
 a block of lines rather than just a few parameters. (A text block is like a here-document.)
 There is no method name corresponding to the `.end command.
 
-.p The file extension I've chosen is `.ltx (though this may change). *Note: The source for this 
+The file extension I've chosen is `.ltx (though this may change). *Note: The source for this 
 README is a `.ltx file which uses its own little _(ad hoc) library (called `(readme.rb)). Refer to
 the repo to see these.
 
 .section Syntax, comments, and more
 
-.p At first, my idea was to provide predefined commands and allow user-defined commands (to be 
+At first, my idea was to provide predefined commands and allow user-defined commands (to be 
 distinguished by a leading `. or `.. markers). So the single and double dots are both legal. 
 
 However, my concept at present is that the double dots (currently unused) will be used for 
 subcommmands.
 
-.p User-defined commands may be added to the standard namespace marked with a period. They may
+User-defined commands may be added to the standard namespace marked with a period. They may
 also be preceded by a specified character other than the period and thus stored in their own
 namespace. More on that later.
 
-.p When a leading period (or double period) is followed by a space, that line is a comment.
+When a leading period (or double period) is followed by a space, that line is a comment.
 When it is follwed by a name, that name is typically understood to be a method name. Any 
 remaining text on the line is treated as a parameter list to be accessed by that method.
 Some methods accept multiple lines of text, terminated by a `.end tag.
 
 .section Boldface and italics
 
-.p Very commonly we want to format short words or phrases in italics, boldface, or a monospaced
+Very commonly we want to format short words or phrases in italics, boldface, or a monospaced
 (fixed width) font. The Markdown spec provides ways to do this that are fairly intuitive; but I
 personally don't like them. My own notation works a different way.
 
-.p First of all, note that these don't work across source lines; they're strictly intra-line.
+First of all, note that these don't work across source lines; they're strictly intra-line.
 You may need (for example) an italicized phrase that spans across a newline; at present, you'll
 need a workaround for that.
 
-.p I find that most short items I want to format are single tokens. Therefore I use a prefixed
+I find that most short items I want to format are single tokens. Therefore I use a prefixed
 character in front of such a token: Underscore for italics, asterisk for boldface, and backtick
 for "code font." The formatting ends when the first blank space is encountered, without any 
 kind of suffixed character. (This behavior may change to include certain punctuation marks as
 terminators.)
 
-.p Of course, there are cases where this won't work; a formatted string may contain spaces, or it
+Of course, there are cases where this won't work; a formatted string may contain spaces, or it
 may exclude characters before the blank space. In this case, we can use an opening parenthesis 
 after the prefix and a closing parenthesis at the end of the string.
 
-.p This means that it can be difficult to include a left paren inside a formatted token. I'm thinking
+This means that it can be difficult to include a left paren inside a formatted token. I'm thinking
 about that. It also means that a "literal" prefix character must be escaped.
 
-.p This is all summarized in this example (taken from one of the testcases):
+This is all summarized in this example (taken from one of the testcases):
 
 .testcase basic_formatting
 
 .section Standard methods
 
-.p The module `Livetext::Standard contains the set of standard or predefined methods. Their 
+The module `Livetext::Standard contains the set of standard or predefined methods. Their 
 names are essentially the same as the names of the dot-commands, with occasional exceptions.
 (For example, it is impractical to use the name `def as a method name, so we use `_def instead.)
 Here is the current list:
@@ -117,14 +117,22 @@ Here is the current list:
 .dlist
  `comment ~~ Start a comment block
  `errout ~~ Write an error message to STDERR
- `sigil ~~ Change the default sigil from `. to some other character (*(removed for now))
- `_def ~~ Define a new method inline
+ `def ~~ Define a new method inline
  `set ~~ Assign values to variables for later interpolation
  `include ~~ Include an outside text file (to be interpreted as Livetext)
  `mixin ~~ Mix this file of Ruby methods into the standard namespace
  `copy ~~ Copy this input file verbatim (no interpretation)
  `r ~~ Pass a single line through without processing
  `raw ~~ Pass this special text block (terminated with `(__EOF__)) directly into output without processing 
+`func ~~ Define a function to be invoked inline
+`say ~~ Print a message to the screen
+`banner ~~ Print a "noticeable" message to the screen
+`quit ~~ End processing and exit
+`nopass ~~ Don't pass lines through (just honor commands)
+`include ~~ Read and process another file (typically a `.ltx file)
+`debug ~~ Turn on debugging
+`nopara ~~ Turn off the "blank line implies new paragraph" switch
+`newpage ~~ Start a new output page
 .end
 
 .section Examples from the tests
@@ -133,7 +141,6 @@ Here are some tests from the suite. The file name reflects the general purpose o
 
 .testcase hello_world
 .testcase comments_ignored_1
-.testcase sigil_can_change
 .testcase block_comment
 .testcase def_method
 .testcase simple_vars
@@ -145,11 +152,11 @@ Here are some tests from the suite. The file name reflects the general purpose o
 
 .section Writing custom methods
 
-.p Suppose you wanted to write a method called `chapter that would simply
+Suppose you wanted to write a method called `chapter that would simply
 output a chapter number and title with certain heading tags and a
 horizontal rule following. There is more than one way to do this.
 
-.p The simplest way is just to define a method inline with the rest of 
+The simplest way is just to define a method inline with the rest of 
 the text. Here's an example.
 
 .code
@@ -177,7 +184,7 @@ the text. Here's an example.
   were striking thirteen.
 .end
 
-.p What can we see from this example? First of all, notice that the part
+What can we see from this example? First of all, notice that the part
 between `.def and `.end (the body of the method) really is just Ruby
 code. The method takes no parameters because parameter passing is 
 handled inside the Livetext engine and the instance variable `@_args is
@@ -187,15 +194,15 @@ initialized to the contents of this array. We usually refer to the
 The `_args method is also an iterator. If a block is attached, that block
 will be called for every argument.
 
-.p We then create a string using these parameters and call it using the
+We then create a string using these parameters and call it using the
 `_puts method. This really does do a `puts call, but it applies it to
 wherever the output is currently being sent (defaulting to STDOUT).
 
-.p All the "helper" methods start with an underscore so as to avoid name
+All the "helper" methods start with an underscore so as to avoid name
 collisions. These are all stored in the `Livetext::Helpers module
 (which also has some methods you will never use).
 
-.p Here is the HTML output of the previous example:
+Here is the HTML output of the previous example:
 
 .code
   <h3>Chapter 1</h3>
@@ -205,7 +212,7 @@ collisions. These are all stored in the `Livetext::Helpers module
   were striking thirteen.
 .end
 
-.p What are some other helper methods? Here's a list.
+What are some other helper methods? Here's a list.
 
 .dlist
 `_args ~~ Returns an array of arguments for the method (or an enumerator for that array)
@@ -218,26 +225,26 @@ collisions. These are all stored in the `Livetext::Helpers module
 `_passthru ~~ Feed a line directly into output after transforming and substituting
 .end
 
-.p Note that the last three methods are typically _not called in your own code. They could be,
+Note that the last three methods are typically _not called in your own code. They could be,
 but it remains to be seen whether something that advanced is useful.
 
 .section More examples
 
-.p Suppose you wanted to take a list of words, more than one per line, and alphabetize them.
+Suppose you wanted to take a list of words, more than one per line, and alphabetize them.
 Let's write a method called `alpha for that. This exercise and the next one are implemented 
 in the test suite.
 
 .testcase example_alpha
 
-.p I'll let that code stand on its own. Now suppose you wanted to allow columnar output. Let's
+I'll let that code stand on its own. Now suppose you wanted to allow columnar output. Let's
 have the user specify a number of columns (from 1 to 5, defaulting to 1).
 
 .testcase example_alpha2
 
-.p What if we wanted to store the code outside the text file? There is more than one way to 
+What if we wanted to store the code outside the text file? There is more than one way to 
 do this.
 
-.p Let's assume we have a file called `mylib.rb in the same directory as the file we're processing.
+Let's assume we have a file called `mylib.rb in the same directory as the file we're processing.
 (Issues such as paths and security have not been addressed yet.) We'll stick the actual Ruby code
 in here (and nothing else).
 
@@ -259,7 +266,7 @@ def alpha
 end
 .end
 
-.p Now the `.ltx file can be written this way:
+Now the `.ltx file can be written this way:
 
 .code
  .mixin mylib
@@ -275,9 +282,9 @@ end
  I hope that worked a second time.
 .end
 
-.p The output, of course, is the same.
+The output, of course, is the same.
 
-.p There is an important feature that has not yet been implemented (the
+There is an important feature that has not yet been implemented (the
 `require method). Like Ruby's `(require), it will grab Ruby code and 
 load it; however, unlike `(mixin), it will load it into a customized
 object and associate a new sigil with it. So for example, the command
@@ -288,7 +295,7 @@ on that new custom object. I will implement this soon.
 
 .section Issues, open questions, and to-do items
 
-.p This list is not prioritized yet.
+This list is not prioritized yet.
 
 .nlist
 Add versioning information 

data/dsl/pyggish.rb

@@ -1,6 +1,5 @@
 require 'pygments'
 
-# noinspection ALL
 module PygmentFix   # Remove CSS for Jutoh
   Styles = {
     :c  => "#408080-i",  # Comment
@@ -104,7 +103,7 @@ end
 
 # Was in 'bookish':
 
-include PygmentFix
+# include PygmentFix
 
 def _process_code(text)
   lines = text.split("\n")

data/dsl/tutorial.rb

@@ -1,11 +1,11 @@
 require 'cgi'
 
 def title
-  puts "<center><h2>#{_data}</h2></center>"
+  puts "<center><h2>#{@_data}</h2></center>"
 end
 
 def section
-  puts "<br>" * 2 + "<b><font size=+1>#{_data}</font></b>" + "<br>"
+  puts "<br>" * 2 + "<b><font size=+1>#{@_data}</font></b>" + "<br>"
 end
 
 def code
@@ -35,7 +35,7 @@ def dlist
   _puts "<table>"
   _body do |line|
 # @tty.puts "Line = #{line}"
-    line = OLD_formatting(line)
+    line = _formatting(line)
 # @tty.puts "Line = #{line}\n "
     term, defn = line.split(delim)
     _puts "<tr>"
@@ -45,11 +45,6 @@ def dlist
   _puts "</table>"
 end
 
-def p
-# puts "<p>"
-  _passthru(_data)
-end
-
 def inout
   src, out = _args
   t1 = ::File.readlines(src) rescue (abort "t1 = #{src}")
@@ -80,10 +75,39 @@ def inout
   HTML
 end
 
+def put_table(src, exp)
+  t1 = ::File.readlines(src) rescue (abort "t1 = #{src}")
+  t2 = ::File.readlines(exp) rescue (abort "t2 = #{out}")
+  t1 = t1.map {|x| " " + x.sub(/ +$/,"").gsub(/_/, "\\_") }.join
+  t2 = t2.map {|x| " " + x.sub(/ +$/,"").gsub(/_/, "\\_") }.join
+
+  puts <<-HTML
+    <center>
+    <table width=80% cellpadding=4>
+    <tr>
+      <td width=50%><b>Input</b></td>
+      <td width=50%><b>Output</b></td>
+    </tr>
+    <tr>
+      <td width=50% bgcolor=#fec0fe valign=top>
+        <pre>#{t1}</pre>
+      </td>
+      <td width=50% bgcolor=lightgray valign=top>
+        <pre>#{t2}</pre>
+      </td>
+    </tr>
+    </table>
+    </center>
+  HTML
+end
+
 def testcase
   name = _args.first
-  _puts "\n<b>Test: <tt>#{name.gsub(/_/, "\\_")}</tt></b><br>"
+# _puts "\n<b>Test: <tt>#{name.gsub(/_/, "\\_")}</tt></b><br>"
+  _puts "\n<font size=+1><b>Test: </font><font size=+2><tt>#{name}</tt></font></b></h3><br>"
   src, exp = "test/testfiles/#{name}/source.ltx", "test/testfiles/#{name}/expected-output.txt"
   @_args = [src, exp]   # Better way to do this??
-  inout                 # Weird - only place I've done this yet.
+# inout                 # Weird - only place I've done this yet.
+  put_table(src, exp)
+  _puts "<br>"
 end

data/lib/functions.rb

@@ -0,0 +1,9 @@
+class Livetext::Functions    # Functions will go here... user-def AND pre-def??
+  def date
+    Time.now.strftime("%F")
+  end
+
+  def time
+    Time.now.strftime("%F")
+  end
+end

data/lib/livetext.rb

@@ -1,10 +1,10 @@
 class Livetext
-  VERSION = "0.7.3"
+  VERSION = "0.7.4"
 end
 
 require 'fileutils'
 
-$: << "/Users/Hal/Desktop/Personal/Dropbox/files/livetext/lib"
+$: << "./lib"
 
 require 'functions'
 require 'userapi'
@@ -14,7 +14,7 @@ Plugins = File.expand_path(File.join(File.dirname(__FILE__), "../dsl"))
 
 TTY = ::File.open("/dev/tty", "w")
 
-require_relative "#{Plugins}/pyggish"
+# require_relative "#{Plugins}/pyggish"
 
 
 class Livetext

data/livetext.gemspec

@@ -1,5 +1,7 @@
 require 'date'
-require_relative "./lib/livetext"
+
+$: << "."
+require "lib/livetext"
 
 Gem::Specification.new do |s|
   system("rm -f *.gem")
@@ -15,6 +17,7 @@ Gem::Specification.new do |s|
                      ./bin/livetext
                      ./lib
                      ./lib/livetext.rb
+                     ./lib/functions.rb
                      ./dsl
                      ./dsl/bookish.rb
                      ./dsl/calibre.rb
@@ -62,10 +65,6 @@ Gem::Specification.new do |s|
                      ./test/testfiles/example_alpha2/expected-output.txt
                      ./test/testfiles/example_alpha2/source.ltx
                      ./test/testfiles/fixit
-                     ./test/testfiles/functions
-                     ./test/testfiles/functions/expected-error.txt
-                     ./test/testfiles/functions/expected-output.txt
-                     ./test/testfiles/functions/source.ltx
                      ./test/testfiles/hello_world
                      ./test/testfiles/hello_world/expected-error.txt
                      ./test/testfiles/hello_world/expected-output.txt

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: livetext
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.7.4
 platform: ruby
 authors:
 - Hal Fulton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-20 00:00:00.000000000 Z
+date: 2017-03-25 00:00:00.000000000 Z
 dependencies: []
 description: A smart text processor extensible in Ruby
 email: rubyhacker@gmail.com
@@ -27,6 +27,7 @@ files:
 - "./dsl/markdown.rb"
 - "./dsl/pyggish.rb"
 - "./dsl/tutorial.rb"
+- "./lib/functions.rb"
 - "./lib/livetext.rb"
 - "./livetext.gemspec"
 - "./notes.txt"
@@ -55,9 +56,6 @@ files:
 - "./test/testfiles/example_alpha2/expected-output.txt"
 - "./test/testfiles/example_alpha2/source.ltx"
 - "./test/testfiles/fixit"
-- "./test/testfiles/functions/expected-error.txt"
-- "./test/testfiles/functions/expected-output.txt"
-- "./test/testfiles/functions/source.ltx"
 - "./test/testfiles/hello_world/expected-error.txt"
 - "./test/testfiles/hello_world/expected-output.txt"
 - "./test/testfiles/hello_world/source.ltx"
@@ -102,9 +100,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.2
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A smart processor for text
 test_files: []
-has_rdoc: 

data/test/testfiles/functions/expected-output.txt

@@ -1,8 +0,0 @@
-Testing out
-some functions 
-here...
-<p>
-
-I am calling Eureka! here...
-Let's see 
-what happens.

data/test/testfiles/functions/source.ltx

@@ -1,11 +0,0 @@
-Testing out
-some functions 
-here...
-
-.func myfunc
-"Eureka!"
-.end
-
-I am calling $$myfunc here...
-Let's see 
-what happens.