rulex 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6509b0f600b1236371fcd853fe2274722aaab361
-  data.tar.gz: b90f15e2ef9fc81756f53e83ebfdf8eb89f25e32
+  metadata.gz: 48ab31fba5ef554feb4384f82952d3c4a5d862f2
+  data.tar.gz: 4a3c7fdb779b6699113bbe24a4a2a508a3f5707a
 SHA512:
-  metadata.gz: 45cb58fb9b7bcbe2703f454259d11e667e7d0ac5db71c3730ed266275f191ea569cc2243a40ccbf46f096127dd5a18d8f33adfce75ffc0f8e0601b6b10379b32
-  data.tar.gz: e73756f0138589d1b6b6abe1cd4bd02be5b80667570ff74fedf8fb774ab27a421a8587d32bab75214640b1c69276bd153b9b2cd5c81252bd008a022966bd2551
+  metadata.gz: e8539de0be9ecdfad57d95f911e8c892de3eaead4e46e0f78db35785147b963898b38c6a88b6d6751ab90240ae5f724463baf5b3fbab88ee76984cc8e2c0c7bc
+  data.tar.gz: 7ffb697045a62a4cba6ee8ea0e9057c8110dfef505ffdd26280a0af1c527533c267fab8e606f8a20966aca07fdaeaf48e2c5ebd5a912f8f84f9352ceadd43aa7

data/.travis.yml

@@ -1,3 +1,6 @@
 language: ruby
 rvm:
   - 2.1.5
+addons:
+  code_climate:
+    repo_token: 236a607824aa9a84b7972793736ffeefaf810123c25373568a0b3dba0b436817

data/Gemfile

@@ -1,4 +1,6 @@
 source 'https://rubygems.org'
 
+gem "codeclimate-test-reporter", group: :test, require: nil
+
 # Specify your gem's dependencies in rulex.gemspec
 gemspec

data/README.md

@@ -1,5 +1,9 @@
 # Rulex
 
+![Travis-CI badge](https://api.travis-ci.org/Nicowcow/rulex.svg)
+[![Code Climate](https://codeclimate.com/github/Nicowcow/rulex/badges/gpa.svg)](https://codeclimate.com/github/Nicowcow/rulex)
+[![Test Coverage](https://codeclimate.com/github/Nicowcow/rulex/badges/coverage.svg)](https://codeclimate.com/github/Nicowcow/rulex/coverage)
+[![Inline docs](http://inch-ci.org/github/Nicowcow/rulex.svg?branch=master)](http://inch-ci.org/github/Nicowcow/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

data/lib/rulex/rex/reader.rb

@@ -8,12 +8,18 @@ module Rulex
         @latex_reader = Rulex::Tex::Reader.new
       end
 
+      # Feeds instructions, either as a [String] or Rulex instructions (parsed and then interpreted
+      # with instance_eval) or as a block (it must be either or). All the functions of 
+      # Rulex::Rex::Reader are available.
+      # @param either a [String] or a [Block]
+      # @return self (the Rulex::Rex::Reader)
       def read *args, &block
         if args.length == 1
           read_rex args.first
         elsif block
           instance_eval &block
         end
+        self
       end
 
       def read_rex str
@@ -29,12 +35,20 @@ module Rulex
         @content_stack.last << node
       end
 
+      def append_nodes_to_content arr
+        @content_stack.last.concat arr
+      end
+
       def raw str
         add_node_to_content(type: :text, text: str)
       end
 
+      def md str
+        raise RuntimeError, "not implemented"
+      end
+
       def tex str
-        add_node_to_content(type: :tex, children: @latex_reader.read(str))
+        append_nodes_to_content @latex_reader.read(str).to_a
       end
 
       def import filepath

data/lib/rulex/tex/latex.treetop

@@ -1,6 +1,6 @@
 grammar Latex
-    rule document
-        (environment/command/text)* <Rulex::Tex::Grammar::Document>
+    rule latex_content
+        (environment/command/text)* <Rulex::Tex::Grammar::LatexContent>
     end
 
     rule environment
@@ -8,12 +8,7 @@ grammar Latex
     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}
-        #[^\\]*
+        latex_content
     end
 
 

data/lib/rulex/tex/node_extensions.rb

@@ -3,12 +3,32 @@ module Rulex
     module Grammar
 
       class Treetop::Runtime::SyntaxNode
+
+
+        # Goes through all its SyntaxNode children to build a Hash and Array based tree
+        # of the parsed document. A node_content is a Hash, containing a :type, and maybe 
+        # containing :children. If node_content contains :children, they must form an Array.
+        # That is:
+        #  * node_content MUST be a Hash that
+        #    * MUST contain an entry :type of type Symbol or String
+        #    * MAY contain an entry :children, which then MUST be of type Array
+        #    * MAY contain any other kind of entries 
+        #
+        # The before it is returned, the node_content is merged with the result from #content.
+        # @return the Hash object of the node's content
         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
+
+        # Build an Array of its children and returns it. Each children is a Hash (description in #node_content).
+        # @return [Array] the Array of children
+        def to_a
+          elements.map{|e| e.node_content} if elements 
+        end
+
         def content
           {}
         end
@@ -17,9 +37,10 @@ module Rulex
       class CustomNode < Treetop::Runtime::SyntaxNode
       end
 
-      class Document < CustomNode
+      class LatexContent < CustomNode
         def content
-          {type: :document}
+          #elements.map{|e| e.node_content} if elements && !elements.empty?
+          {type: :node}
         end
       end
 

data/lib/rulex/tex/reader.rb

@@ -15,14 +15,21 @@ module Rulex
         @content = []
       end
 
-
+      # Exports the Reader's content
+      # @return [Array] the Reader's content
       def to_a
         @content
       end
       alias_method :export, :to_a
 
+      # Takes a string of LaTeX contents, parses it to a Rulex tree, and sets that tree as
+      # the Reader's content
+      # @param str [String] the LaTeX contents as a String
+      # @return [Array] The new content
       def read str
-        @content = @parser.parse(str).node_content
+        new_content = @parser.parse(str).to_a
+        raise TypeError, "content should be an Array" unless new_content and Array === new_content
+        @content = new_content
       end
     end
   end

data/lib/rulex/version.rb

@@ -1,3 +1,3 @@
 module Rulex
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

data/rulex.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "treetop"
 
-  spec.add_development_dependency "bundler", "~> 1.9"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rulex
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Nicolas Mattia
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-06-27 00:00:00.000000000 Z
+date: 2015-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: treetop
@@ -28,30 +28,30 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement