calyx 0.8.3 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b3e641762dd894b48936eb9e945531b94be732b4
-  data.tar.gz: 0875b1def9d94ae12c2685f92a1fabd418b27853
+  metadata.gz: 679eb1cd31045fb4f4603dc28566d7d833486c62
+  data.tar.gz: ba1a2640bc31bfc67d5b354576444e901eb1280f
 SHA512:
-  metadata.gz: 735ff80c2e8c154c07aa3344c4717c91212a5734ae79c03289d7b741b87e0b60a1c813fa5294733db6697e96fb443b2dce7938565893ab9744bbfb721aebd00b
-  data.tar.gz: abcfc630585f97fb81753f9fd77fbba90e3cc1399a396626c468d3ab30fe50dcb70829525962e527212ee174f60005aa2dc3fed440f5c82934f8b9dd4de4d823
+  metadata.gz: 1ad76734b34a1e5483b8da959ec2b8d9658c20e174f86cf1f000d2db0a958e7261519731b2bc46059406d38b540c372f278b619fb78c2cc6c77e288a38d059e1
+  data.tar.gz: 85d7f3bfd3236406c0a27c075a427527c8dc48c7d2c212187b5af386227ff39138215b58d7b9284959838461a2d5d37d4cfacbe24d633b040f142641474f424d

data/README.md

@@ -236,7 +236,26 @@ greeting = AppGreeting.new
 greeting.generate(context)
 ```
 
-__Note: This feature is still experimental, and the API may morph and change a bit as we try to figure out the best patterns for merging and combining grammars.__
+__Note: The API may morph and change a bit as we try to figure out the best patterns for merging and combining grammars.__
+
+### Accessing the Raw Generated Tree
+
+Calling `#evaluate` on the grammar instance will give you access to the raw generated tree structure before it gets flattened into a string.
+
+The tree is encoded as an array of nested arrays, with the leading symbols labeling the choices and rules selected, and the trailing terminal leaves encoding string values.
+
+This may not make a lot of sense unless you’re familiar with the concept of [s-expressions](https://en.wikipedia.org/wiki/S-expression). It’s a fairly speculative feature at this stage, but it leads to some interesting possibilities.
+
+```ruby
+grammar = Calyx::Grammar.new do
+  start 'Riddle me ree.'
+end
+
+grammar.evaluate
+# => [:start, [:term, "Riddle me ree."]]
+```
+
+__Note: This feature is still experimental. The tree structure is likely to change so it’s probably best not to rely on it for anything big at this stage.__
 
 ## Roadmap
 
@@ -247,7 +266,7 @@ Rough plan for stabilising the API and features for a `1.0` release.
 | `0.6`   | ~~block constructor~~ |
 | `0.7`   | ~~support for template context map passed to generate~~ |
 | `0.8`   | ~~method missing metaclass API~~ |
-| `0.9`   | return grammar tree from evaluate/generate, with to_s being separate |
+| `0.9`   | ~~return grammar tree from `#evaluate`, with flattened string from `#generate` being separate~~ |
 | `0.10`  | inject custom string functions for parameterised rules, transforms and mappings |
 | `0.11`  | support YAML format (and JSON?) |
 | `1.0`   | API documentation |

data/lib/calyx/grammar.rb

@@ -35,6 +35,22 @@ module Calyx
     end
 
     def generate(*args)
+      start_symbol, rules_map = map_default_args(*args)
+
+      @registry.evaluate(start_symbol, rules_map).flatten.reject do |obj|
+        obj.is_a?(Symbol)
+      end.join(''.freeze)
+    end
+
+    def evaluate(*args)
+      start_symbol, rules_map = map_default_args(*args)
+
+      @registry.evaluate(start_symbol, rules_map)
+    end
+
+    private
+
+    def map_default_args(*args)
       start_symbol = :start
       rules_map = {}
 
@@ -43,9 +59,7 @@ module Calyx
         rules_map = arg if arg.class == Hash
       end
 
-      @registry.evaluate(start_symbol, rules_map).flatten.reject do |obj|
-        obj.is_a?(Symbol)
-      end.join(''.freeze)
+      [start_symbol, rules_map]
     end
   end
 end

data/lib/calyx/version.rb

@@ -1,3 +1,3 @@
 module Calyx
-  VERSION = '0.8.3'.freeze
+  VERSION = '0.9.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: calyx
 version: !ruby/object:Gem::Version
-  version: 0.8.3
+  version: 0.9.0
 platform: ruby
 authors:
 - Mark Rickerby
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-07 00:00:00.000000000 Z
+date: 2016-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler