rulex 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b837fec66c1b803f2637a4a8158437c68cb463cd
-  data.tar.gz: 85fa266b72812926f6a4f1e4b1f73c674e44636c
+  metadata.gz: d4415c9c1a3b0a1b94e0a8227b9baa9e3dfd8ca6
+  data.tar.gz: 934a03920ea1d907f2544a5545a6456d1aedb5d8
 SHA512:
-  metadata.gz: dc75afa077337de174796be17e7f34fb07b633cda9a7ee9aa19f0021956db8e5134e837cb23399b634a4b45b327a435eb1c08de2cebb90298a57b20fbc4f6e2a
-  data.tar.gz: 65bec4fdc03d4869418162d50380595ac45705d346bff3868b46b1a9cdb2032c29050ad0f047ed2161ab25e1506b44df349b1dd1a5a152b35211b72f722bb90c
+  metadata.gz: 841a5ce7e54eb466677677639f643b0eb8dfc17ae0903fa7fa3d6fa8f441f58c8c99e8d98ad2e746d2e42df26ba1200b2c44da5ac7e002bae9823f32589d578a
+  data.tar.gz: 5ba3f8afe690b1b242f4954c6318291f3957ab261ec3f056f8c78322cf898e0d1cd22b58bf838a7133c37efbff827c06420e1b8c4525fdbe1dfce9092fa02c66

data/README.md

@@ -20,33 +20,58 @@ Or install it yourself as:
 
 ## Usage
 
-**Everything is still very experimental, and might break at any point!**
-
 *For detailed documentation, please refer to the code, mainly `/spec/rulex_spec.rb`. There are a few examples as well in `/examples/`.*
 
+**Everything is still very experimental, and might break at any point!** Consider using a specific version, and sticking to it if it works.
+
+
 
 ### Example 
 
 ```ruby
-# example.rex
-documentclass :article
+# First thing to note, your rex file must follow the TeX document structure. 
+# You will start with a `\documentclass` call, then wrap your document in a 
+# `document` environment by calling `\begin{document}` and `\end{document}`. 
+# The only difference here is that most of this process is wrapped in Ruby.
+
+
+# Just call `documentclass` to set the document class. This for instance will
+# be translated to `\documentclass{article}`.
+documentclass :article 
 
+# You can define your own Ruby functions.
 def count_from range
   first = range.first
   last = range.last
 
+# Any function call, like `functionname("arg1", "arg2",...)`, will be 
+# translated to `\functionname{arg1}{arg2}{...}`.  That way, you can start 
+# a subsection as follows:
   subsection "how to count from #{first} to #{last}"
+
+# Raw is a special `rex` function. It writes its argument as text in the rex 
+# tree (and subsequently in the TeX file) without parsing it. Note that the 
+# fact that it is not writing a `\raw` function is exceptional, because `raw` 
+# is a `rex` reserved function name. To use `raw` like you would use 
+# `subsection` call `tex_command :raw`.
   raw "Let's try to count."
 
+# If you pass a command a bloc, it will start a TeX environment. The 
+# following `itemize do ... end` is equivalent to `\begin{itemize} ... \end{itemize}`.
   itemize do
     range.each do |n|
       item n.to_s
     end
   end
 end
+
 document do
   section "A Short Lecture on How to Count"
 
+
+# You can of course call the functions you defined (AND NOT BE LIMITED TO 
+# 9 ******* ARGUMENTS)
+
   count_from (1..5)
   count_from (10..20)
 
@@ -58,6 +83,7 @@ document do
   raw "Finally I would like to thank \n"
 
   enumerate do
+# You can of course use just any kind of Ruby goodness you like.
     %w[Donald\ Knuth Yukihiro\ Matsumoto].each do |name|
       item "Mr. #{name}"
     end
@@ -127,3 +153,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 * Add markdown support to `Rulex::Rex::Reader` through Pandoc
 * The parser needs some beefin-up (not sure what it does with spaces, especially with command options)
 * Maybe add some syntax for LaTeX commands to output text directly rather than store the command in the tree
+* Coffee is on me if you write a Vim plugin

data/examples/count.rex

@@ -0,0 +1,50 @@
+# First thing to note, your rex file must follow the TeX document structure. You will start
+# with a `\documentclass` call, then wrap your document in a `document` environment by calling `\begin{document}` and `\end{document}`. The only difference here is that most of this process is wrapped in Ruby.
+
+
+# Just call `documentclass` to set the document class. This for instance will be translated to `\documentclass{article}`.
+documentclass :article 
+
+# You can define your own Ruby functions.
+def count_from range
+  first = range.first
+  last = range.last
+
+# Any function call, like `functionname("arg1", "arg2",...)`, will be translated to `\functionname{arg1}{arg2}{...}`. 
+# That way, you can start a subsection as follows:
+  subsection "how to count from #{first} to #{last}"
+
+# Raw is a special `rex` function. It writes its argument as text in the rex tree (and subsequently in the TeX file) without parsing it. Note that the fact that it is not writing a `\raw` function is exceptional, because `raw` is a `rex` reserved function name. To use `raw` like you would use `subsection` call `tex_command :raw`.
+  raw "Let's try to count."
+
+# If you pass a command a bloc, it will start a TeX environment. The following `itemize do ... end` is equivalent to `\begin{itemize} ... \end{itemize}`.
+  itemize do
+    range.each do |n|
+      item n.to_s
+    end
+  end
+end
+
+document do
+  section "A Short Lecture on How to Count"
+
+
+# You can of course call the functions you defined (AND NOT BE LIMITED TO 9 ******* ARGUMENTS)
+
+  count_from (1..5)
+  count_from (10..20)
+
+  raw "Good job, now off to section "; ref :acks;
+
+  section "Acknowledgements"
+  label :acks
+
+  raw "Finally I would like to thank \n"
+
+  enumerate do
+# You can of course use just any kind of Ruby goodness you like.
+    %w[Donald\ Knuth Yukihiro\ Matsumoto].each do |name|
+      item "Mr. #{name}"
+    end
+  end
+end

data/examples/count.tex

@@ -0,0 +1,34 @@
+\documentclass{article}
+\begin{document}
+\section{A Short Lecture on How to Count}
+\subsection{how to count from 1 to 5}
+Let's try to count.\begin{itemize}
+\item{1}
+\item{2}
+\item{3}
+\item{4}
+\item{5}
+\end{itemize}
+\subsection{how to count from 10 to 20}
+Let's try to count.\begin{itemize}
+\item{10}
+\item{11}
+\item{12}
+\item{13}
+\item{14}
+\item{15}
+\item{16}
+\item{17}
+\item{18}
+\item{19}
+\item{20}
+\end{itemize}
+Good job, now off to section \ref{acks}
+\section{Acknowledgements}
+\label{acks}
+Finally I would like to thank 
+\begin{enumerate}
+\item{Mr. Donald Knuth}
+\item{Mr. Yukihiro Matsumoto}
+\end{enumerate}
+\end{document}

data/lib/rulex/rex/reader.rb

@@ -1,6 +1,7 @@
 module Rulex
   module Rex
     class Reader
+
       def initialize
         @content = []
         @content_stack = [@content]
@@ -15,8 +16,6 @@ module Rulex
 
       def raw str
         add_to_content(type: :text, text: str)
-        #new_node = {type: :text, text: str }
-        #@content << new_node
       end
 
       def tex str
@@ -31,8 +30,18 @@ module Rulex
         @content
       end
 
-      def tex_command(name, args)
-        add_to_content(type: :command, name: name, arguments: args)
+      def tex_command(name, params)
+        if params.length == 1
+          add_to_content(type: :command, name: name, arguments: params)
+        elsif params.length == 2
+          opts = params[0]
+          args = params[1]
+          add_to_content(type: :command, name: name, arguments: args, options: opts)
+        end
+      end
+
+      def depth
+        @content_stack.length - 1
       end
 
       def tex_environment(name, args, block)
@@ -40,12 +49,6 @@ module Rulex
         @content_stack.push []
         read &block
         new_node.merge!(children: @content_stack.pop)
-
-        #new_node = {type: :environment, name: name, arguments: args}
-        #deeper_parser = Rulex::Rex::Reader.new 
-        #deeper_parser.read &block
-        #new_node.merge!(children: deeper_parser.export)
-
         add_to_content new_node
       end
 

data/lib/rulex/tex/writer.rb

@@ -13,6 +13,9 @@ module Rulex
           case item[:type]
           when :command
             @content += "\\#{item[:name]}"
+            if opts = item[:options]
+              @content += '[' + opts.join(',') + ']'
+            end
             item[:arguments].each do |arg|
               @content += "{#{arg}}"
             end

data/lib/rulex/version.rb

@@ -1,3 +1,3 @@
 module Rulex
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/rulex.gemspec

@@ -17,10 +17,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  #if spec.respond_to?(:metadata)
-    #spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com' to prevent pushes to rubygems.org, or delete to allow pushes to any server."
-  #end
-
   spec.add_runtime_dependency "treetop"
 
   spec.add_development_dependency "bundler", "~> 1.9"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rulex
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Nicolas Mattia
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-06-23 00:00:00.000000000 Z
+date: 2015-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: treetop
@@ -83,6 +83,8 @@ files:
 - bin/console
 - bin/setup
 - examples/bracket_bloc.tex
+- examples/count.rex
+- examples/count.tex
 - examples/hello_world.rex
 - examples/hello_world.tex
 - examples/simple.tex