rulex 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b837fec66c1b803f2637a4a8158437c68cb463cd
+  data.tar.gz: 85fa266b72812926f6a4f1e4b1f73c674e44636c
+SHA512:
+  metadata.gz: dc75afa077337de174796be17e7f34fb07b633cda9a7ee9aa19f0021956db8e5134e837cb23399b634a4b45b327a435eb1c08de2cebb90298a57b20fbc4f6e2a
+  data.tar.gz: 65bec4fdc03d4869418162d50380595ac45705d346bff3868b46b1a9cdb2032c29050ad0f047ed2161ab25e1506b44df349b1dd1a5a152b35211b72f722bb90c

data/.gitignore

@@ -0,0 +1,37 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+.ruby-version
+.ruby-gemset
+Gemfile.lock
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+
+# PDFs might be generated
+/**/*.pdf
+
+# Vim's crap
+/**/*.swp

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rulex.gemspec
+gemspec

data/README.md

@@ -0,0 +1,129 @@
+# Rulex
+
+Rulex is a rubygem allowing you to use Ruby while writing LaTex files. It reads rulex `.rex` files, and converts them into LaTex `.tex` files. A `.rex` file is a Ruby file; you can use (almost) everything the way you would in a Ruby script. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rulex'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rulex
+
+## 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/`.*
+
+
+### Example 
+
+```ruby
+# example.rex
+documentclass :article
+
+def count_from range
+  first = range.first
+  last = range.last
+
+  subsection "how to count from #{first} to #{last}"
+  raw "Let's try to count."
+
+  itemize do
+    range.each do |n|
+      item n.to_s
+    end
+  end
+end
+document do
+  section "A Short Lecture on How to Count"
+
+  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
+    %w[Donald\ Knuth Yukihiro\ Matsumoto].each do |name|
+      item "Mr. #{name}"
+    end
+  end
+end
+```
+
+Run `rulex example.rex > example.tex` to get
+
+```latex
+% example.tex
+\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}
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+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.
+* `Rulex::Rex::Reader#raw` might not be the best name either. Maybe change it to text.
+* 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

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rulex"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/bracket_bloc.tex

@@ -0,0 +1,13 @@
+\documentclass{article}
+
+\begin{document}
+
+Hello, { bracket bloc! }
+
+
+Hello, math env!$\frac{1}{34}$
+
+
+Hello, space between arg blocs!$\frac{1} {34}$
+
+\end{document}

data/examples/hello_world.rex

@@ -0,0 +1,4 @@
+documentclass :article
+document do
+raw "Hello, World!\n"
+end

data/examples/hello_world.tex

@@ -0,0 +1,4 @@
+\documentclass{article}
+\begin{document}
+Hello, World!
+\end{document}

data/examples/simple.tex

@@ -0,0 +1,4 @@
+\documentclass{article}
+\begin{document}
+Hello, world!
+\end{document}

data/exe/rulex

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "rulex"
+
+
+rex_reader = Rulex::Rex::Reader.new
+tex_writer = Rulex::Tex::Writer.new
+
+rex_reader.read File.open(ARGV[0]).read
+tex_writer.import rex_reader.export
+puts tex_writer.export

data/lib/rulex/rex/reader.rb

@@ -0,0 +1,61 @@
+module Rulex
+  module Rex
+    class Reader
+      def initialize
+        @content = []
+        @content_stack = [@content]
+        @latex_reader = Rulex::Tex::Reader.new
+      end
+
+      alias_method :read, :instance_eval
+
+      def add_to_content node
+        @content_stack.last << node
+      end
+
+      def raw str
+        add_to_content(type: :text, text: str)
+        #new_node = {type: :text, text: str }
+        #@content << new_node
+      end
+
+      def tex str
+        add_to_content(type: :tex, children: @latex_reader.read(str))
+      end
+
+      def import filepath
+        read File.open(filepath).read
+      end
+
+      def export
+        @content
+      end
+
+      def tex_command(name, args)
+        add_to_content(type: :command, name: name, arguments: args)
+      end
+
+      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)
+
+        #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
+
+      def method_missing(m_id, *args, &block) 
+        if block
+          tex_environment(m_id, args, block)
+        else
+          tex_command(m_id, args)
+        end
+      end
+    end
+  end
+end

data/lib/rulex/tex/latex.treetop

@@ -0,0 +1,53 @@
+grammar Latex
+    rule document
+        (environment/command/text)* <Rulex::Tex::Grammar::Document>
+    end
+
+    rule environment
+        "\\begin{" environment_name "}" environment_text  "\\end{" environment_name &{ |seq|  seq[1].text_value == seq[5].text_value } "}" <Rulex::Tex::Grammar::Environment>
+    end
+
+    rule environment_text
+        #document &{ |s| puts s[0].text_value; true}
+        #( document) !"\\end{" &{ |s| puts s[0].text_value; true}
+        document
+
+        #[^\\]* &{ |s| puts s[0].text_value; true}
+        #[^\\]*
+    end
+
+
+    rule environment_name
+        [^}\s]+
+    end
+
+    rule command
+       "\\" command_name ('[' command_option (',' command_option)* ']')? ('{' command_argument '}')* <Rulex::Tex::Grammar::Command>
+    end
+
+    rule command_option
+        (![\s,] [a-z0-9])+ # With the neg. lookahead we make sure we don't consume the next command
+    end
+
+    rule command_name
+        !"begin" # First, we make sure it is not the beginning of an environment
+        (!"end"  # Then, we make sure it won't consume the end of an environment
+        ([^\[{\s]+)) # Finally, we don't want to consume the options or args of the command
+    end
+
+    rule command_argument
+        [^}]+
+    end
+
+    rule text
+        (spaces? word spaces?)+ <Rulex::Tex::Grammar::Text>
+    end
+
+    rule word
+        ([^\s\\])+
+    end
+
+    rule spaces
+        [\s\n]+
+    end
+end

data/lib/rulex/tex/node_extensions.rb

@@ -0,0 +1,60 @@
+module Rulex
+  module Tex 
+    module Grammar
+
+      class Treetop::Runtime::SyntaxNode
+        def node_content
+          h = {type: :node} #, log: elements.to_s}
+          h.merge!(:children => elements.map{|e| e.node_content}) if elements && !elements.empty?
+          h.merge!(log: text_value)
+          h.merge! content
+        end
+        def content
+          {}
+        end
+      end
+
+      class CustomNode < Treetop::Runtime::SyntaxNode
+      end
+
+      class Document < CustomNode
+        def content
+          {type: :document}
+        end
+      end
+
+      class Text < CustomNode
+        def content
+          {type: :text, text: text_value} 
+        end
+      end
+
+      class Command < CustomNode
+        def content
+          h = {type: :command, name: elements[1].text_value}
+          if opts_maybe = elements[2].elements
+            opts = []
+            opts << opts_maybe[1].text_value
+
+            if opts_kleene_s = opts_maybe[2].elements
+              opts += opts_kleene_s.map{|e| e.elements[1].text_value}
+            end
+
+            h.merge!(options: opts)
+          end
+          if args_kleene_s = elements[3]
+            h.merge!(arguments: args_kleene_s.elements.map{|e| e.elements[1].text_value}) 
+          end
+
+          h
+        end
+      end 
+
+      class Environment < CustomNode
+        def content
+          {type: :environment, name: elements[1].text_value, children: elements[3].elements.map{|e| e.content }}
+        end
+      end
+    end
+  end
+end

data/lib/rulex/tex/reader.rb

@@ -0,0 +1,29 @@
+require 'treetop'
+require_relative 'node_extensions'
+
+grammar_path = File.join(File.dirname(File.expand_path(__FILE__)),
+                         'latex.treetop')
+Treetop.load grammar_path
+
+
+module Rulex
+  module Tex
+    class Reader
+
+      def initialize
+        @parser = LatexParser.new
+        @content = []
+      end
+
+
+      def to_a
+        @content
+      end
+      alias_method :export, :to_a
+
+      def read str
+        @content = @parser.parse(str).node_content
+      end
+    end
+  end
+end

data/lib/rulex/tex/writer.rb

@@ -0,0 +1,38 @@
+module Rulex
+  module Tex
+    class Writer
+
+      def initialize
+        @content = ''
+      end
+
+      def import arr
+        return unless arr
+        arr.each do |item|
+
+          case item[:type]
+          when :command
+            @content += "\\#{item[:name]}"
+            item[:arguments].each do |arg|
+              @content += "{#{arg}}"
+            end
+            @content += "\n"
+          when :text
+            @content += item[:text]
+          when :environment
+            @content += "\\begin{#{item[:name]}}\n"
+            import item[:children]
+            @content += "\\end{#{item[:name]}}\n"
+          else
+            import item[:children] if item[:children]
+          end
+        end
+      end
+
+      def to_s
+        @content
+      end
+      alias_method :export, :to_s
+    end
+  end
+end

data/lib/rulex/version.rb

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

data/lib/rulex.rb

@@ -0,0 +1,7 @@
+require "rulex/version"
+require "rulex/tex/reader"
+require "rulex/tex/writer"
+require "rulex/rex/reader"
+
+module Rulex
+end

data/rulex.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rulex/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rulex"
+  spec.version       = Rulex::VERSION
+  spec.authors       = ["Nicolas Mattia"]
+  spec.email         = ["nicowcowo@gmail.com"]
+
+  spec.summary       = %q{A gem for easily wrapping LaTeX code in Ruby}
+  spec.homepage      = "https://www.github.com/Nicowcow/rulex"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  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"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: rulex
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nicolas Mattia
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-06-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: treetop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- nicowcowo@gmail.com
+executables:
+- rulex
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/bracket_bloc.tex
+- examples/hello_world.rex
+- examples/hello_world.tex
+- examples/simple.tex
+- exe/rulex
+- lib/rulex.rb
+- lib/rulex/rex/reader.rb
+- lib/rulex/tex/latex.treetop
+- lib/rulex/tex/node_extensions.rb
+- lib/rulex/tex/reader.rb
+- lib/rulex/tex/writer.rb
+- lib/rulex/version.rb
+- rulex.gemspec
+homepage: https://www.github.com/Nicowcow/rulex
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: A gem for easily wrapping LaTeX code in Ruby
+test_files: []