rulex 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5a4320567471b4e3e59824ba257532d95c470aa8
-  data.tar.gz: 425acc9636e13862d28f563a8251f62d55c08f0d
+  metadata.gz: 615cc7d413292fbe99bd79cb0cdaee48d9e6ca91
+  data.tar.gz: 32dfee7e649b5f48c60d1f5e0e2d59e37c01b382
 SHA512:
-  metadata.gz: fd20d78fd564ec24c2bc9c0252a09d847369da9de5cc55bd41a7ae1cc47ba47d2a5822c41032497e7993513dd9f84ec2a341a571a9f5f3f4e091da37b9157ef7
-  data.tar.gz: 5f1a2eec6be5e5bcbe17e656fd72c6682a4051853e4725229e007708e7f0f22dcb3d56a16ba61796087dc6bff495287b8accd0c04a2a6bd60ee14c83a004a77f
+  metadata.gz: d506ff5ad0e7037afa8498884f06b4c591de5074b5de206480b21ca90b2e1db5011e36d517993eeb3f89334861e0918e6e0bc184c818b0d9eeda35a34107ccee
+  data.tar.gz: d4f609a790eb152cc056ec6fb26a0bdbb27711e719616dd6d003f5b629689510188f152348d0fbede1513714fcd259ffcda0c4644395ca7c5b02aca46c9c7fc8

data/README.md

@@ -4,7 +4,16 @@ Rulex is a rubygem allowing you to use Ruby while writing LaTex files. It reads
 
 ## Installation
 
-Add this line to your application's Gemfile:
+To start using Rulex, you'll first need Ruby and Rubygems (here for a Debian-like, though I recommend rvm):
+
+    $ apt-get install ruby && apt-get install rubygems
+
+and then install the gem as 
+
+    $ gem install rulex
+
+
+To use it in your own project, add this line to your application's Gemfile:
 
 ```ruby
 gem 'rulex'
@@ -14,9 +23,6 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
-
-    $ gem install rulex
 
 ## Usage
 
@@ -29,14 +35,11 @@ Or install it yourself as:
 ### Example 
 
 ```ruby
-# 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.
+# 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}`.
+# 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.
@@ -44,20 +47,14 @@ 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:
+# 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 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}`.
+# 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
@@ -69,13 +66,17 @@ 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)
+# 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;
+  # At any time, you can prefix a method call with `pure_`. This will return the LaTeX text
+  # (`String`) that would have been produced, instead of writing the command to the
+  # document tree. For instance, we want to write the whole text "Good job, ... " to the
+  # document tree, while referencing the next section; we don't want to write the reference
+  # to the tree on top of that!
+  raw "Good job, now off to section #{pure_ref :acks}\n" 
 
   section "Acknowledgements"
   label :acks
@@ -94,7 +95,6 @@ end
 Run `rulex example.rex > example.tex` to get
 
 ```latex
-% example.tex
 \documentclass{article}
 \begin{document}
 \section{A Short Lecture on How to Count}
@@ -121,6 +121,7 @@ Let's try to count.\begin{itemize}
 \item{20}
 \end{itemize}
 Good job, now off to section \ref{acks}
+
 \section{Acknowledgements}
 \label{acks}
 Finally I would like to thank 
@@ -139,13 +140,20 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
+### I want no business with Ruby.
+
+Rulex is very young, and everything is very likely to break down. Just use it, and open an issue if something goes wrong. You can also contact me.
+
+### I want no business with LaTeX.
+
+That's the point. Seriously, the code might need some refactoring, and can always use cool tricks.
+
 1. Fork it ( https://github.com/Nicowcow/rulex/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
 
-
 ### What can I do?
 
 * `Rulex::Tex::Grammar::Document` is a big misnommer! It should be changed to something that reflects better what its role is.
@@ -154,3 +162,5 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 * 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
+* Another coffee if you also write a Rake task.
+* There should be some special delimiters like Ruby's `#{...}` (maybe `#< ... >`) which would translate all method calls to `pure_` method calls. That would make inlining method calls in strings much easier.

data/examples/count.rex

@@ -34,7 +34,12 @@ document do
   count_from (1..5)
   count_from (10..20)
 
-  raw "Good job, now off to section #{pure_ref :acks}\n" # #{pure_ref :acks}\n"
+  # At any time, you can prefix a method call with `pure_`. This will return the LaTeX text
+  # (`String`) that would have been produced, instead of writing the command to the
+  # document tree. For instance, we want to write the whole text "Good job, ... " to the
+  # document tree, while referencing the next section; we don't want to write it to the 
+  # tree on top of that!
+  raw "Good job, now off to section #{pure_ref :acks}\n" 
 
   section "Acknowledgements"
   label :acks

data/lib/rulex/rex/reader.rb

@@ -8,18 +8,33 @@ module Rulex
         @latex_reader = Rulex::Tex::Reader.new
       end
 
-      alias_method :read, :instance_eval
+      def read *args, &block
+        if args.length == 1
+          read_rex args.first
+        elsif block
+          instance_eval &block
+        end
+      end
+
+      def read_rex str
+        instance_eval rex_to_ruby str
+      end
 
-      def add_to_content node
+      # There are a few characters ('\\', '\[' and '\]') that %q[] escapes anyway
+      def rex_to_ruby str
+        str.gsub(/<##(((?!##>).)+)##>/) { |m| "raw %q[" + $1.gsub("\\","\\\\\\\\") + "]"}
+      end
+
+      def add_node_to_content node
         @content_stack.last << node
       end
 
       def raw str
-        add_to_content(type: :text, text: str)
+        add_node_to_content(type: :text, text: str)
       end
 
       def tex str
-        add_to_content(type: :tex, children: @latex_reader.read(str))
+        add_node_to_content(type: :tex, children: @latex_reader.read(str))
       end
 
       def import filepath
@@ -50,31 +65,31 @@ module Rulex
       end
 
       def tex_command(name, params)
-        add_to_content build_tex_command name, params
+        add_node_to_content build_tex_command name, params
       end
 
       def depth
         @content_stack.length - 1
       end
 
-      def tex_environment(name, args, block)
+      def tex_environment(name, *args, &block)
         new_node = {type: :environment, name: name, arguments: args}
         @content_stack.push []
         read &block
         new_node.merge!(children: @content_stack.pop)
-        add_to_content new_node
+        add_node_to_content new_node
       end
 
       def method_missing(m_id, *args, &block) 
         if block
-          tex_environment(m_id, args, block)
+          tex_environment(m_id, *args, &block)
         elsif /pure_([a-zA-Z]+)/.match(m_id)
           Rulex::Tex::Writer.to_str(build_tex_command($1,args))
-          #"\\#{$1}{1}{2}"
         else
           tex_command(m_id, args)
         end
       end
+
     end
   end
 end

data/lib/rulex/tex/writer.rb

@@ -26,8 +26,12 @@ module Rulex
           end
           res = str += "\\end{#{item[:name]}}\n"
         else
-          str = ""
-          res = str += item[:children].inject(""){|acc, c| acc += Rulex::Tex::Writer.to_str c} if item[:children]
+          if item[:children]
+            str = ""
+            res = str += item[:children].inject(""){|acc, c| acc += Rulex::Tex::Writer.to_str c} if item[:children] else 
+            ""
+            end
+
         end
       end
 

data/lib/rulex/version.rb

@@ -1,3 +1,3 @@
 module Rulex
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rulex
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Nicolas Mattia
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-06-24 00:00:00.000000000 Z
+date: 2015-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: treetop