calyx 0.11.1 → 0.11.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 75811b39e9ca016645eb82dea083ff50612f8e2b
-  data.tar.gz: af905efd81c6b0e679e2ed333f571fdad65ee8a8
+  metadata.gz: dc594e0fddc6c14df3cd938cc1ab458f7ffc490f
+  data.tar.gz: 68f4c73ef62ae94daea3194b11d3c7e0e5df7904
 SHA512:
-  metadata.gz: 97a47ba2a0dcf0d658641ba1f67b3237731132ca0500c92053b86f54a60b2eba7f3181daef54c43f94d40c725915c39a2ae2898d6a639a0399f3910a4d01116f
-  data.tar.gz: 57341f9c8428917d56b33dedd219dd904bca3252b9f2a7d240bcab1a050f8209f7b61ab26d9402b69f029be53d7ffcfcd29b8342777e2de62733e408607af872
+  metadata.gz: c9e136e726881b1847690a290565125546fd7a41f90f7bbd4320542eaee82be2df9796acbf11d53cb71c77d2b82e97e29d228f050ac765d688bc36ac1c672a75
+  data.tar.gz: 9290522a14840247671d1c76228b0e515687b97713890e4b303fe10f128cf1e7c7d5b061775dd060534ad67e7e98143b398ae9ab5cba74289c25bab8c4adebfd

data/README.md

@@ -417,7 +417,8 @@ Rough plan for stabilising the API and features for a `1.0` release.
 | `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 |
+| `0.12`  | indirection (allow output of a rule to be used as the name for another rule) |
+| `1.0`   | ~~API documentation~~ |
 
 ## Credits
 

data/lib/calyx/format.rb

@@ -7,7 +7,7 @@ module Calyx
     # Accepts a JSON or YAML file path, identified by its extension (`.json`
     # or `.yml`).
     #
-    # @param filename [String]
+    # @param [String] filename
     # @return [Calyx::Grammar]
     def self.load(filename)
       file = File.read(filename)
@@ -23,7 +23,7 @@ module Calyx
 
     # Converts the given string of YAML data to a grammar instance.
     #
-    # @param data [String]
+    # @param [String] data
     # @return [Calyx::Grammar]
     def self.load_yml(data)
       require 'yaml'
@@ -32,7 +32,7 @@ module Calyx
 
     # Converts the given string of JSON data to a grammar instance.
     #
-    # @param data [String]
+    # @param [String] data
     # @return [Calyx::Grammar]
     def self.load_json(data)
       require 'json'

data/lib/calyx/grammar.rb

@@ -23,7 +23,7 @@ module Calyx
       # Accepts a JSON or YAML file path, identified by its extension (`.json`
       # or `.yml`).
       #
-      # @param filename [String]
+      # @param [String] filename
       # @return [Calyx::Grammar]
       def load(filename)
         Format.load(filename)
@@ -31,22 +31,22 @@ module Calyx
 
       # DSL helper method for registering a modifier module with the grammar.
       #
-      # @param module_name [Module]
+      # @param [Module] module_name
       def modifier(module_name)
         registry.modifier(module_name)
       end
 
       # DSL helper method for registering a paired mapping regex.
       #
-      # @param name [Symbol]
-      # @param pairs [Hash<Regex,String>]
+      # @param [Symbol] name
+      # @param [Hash<Regex,String>] pairs
       def mapping(name, pairs)
         registry.mapping(name, pairs)
       end
 
       # DSL helper method for registering the given block as a string filter.
       #
-      # @param name [Symbol]
+      # @param [Symbol] name
       # @block block with a single string argument returning a modified string.
       def filter(name, &block)
         registry.mapping(name, &block)
@@ -56,8 +56,8 @@ module Calyx
       #
       # Not usually used directly, as the method missing API is less verbose.
       #
-      # @param name [Symbol]
-      # @param productions [Array]
+      # @param [Symbol] name
+      # @param [Array] productions
       def rule(name, *productions)
         registry.rule(name, *productions)
       end
@@ -68,8 +68,8 @@ module Calyx
       # This must be bypassed by calling `#rule` directly if the name of the
       # desired rule clashes with an existing helper method.
       #
-      # @param name [Symbol]
-      # @param productions [Array]
+      # @param [Symbol] name
+      # @param [Array] productions
       def method_missing(name, *productions)
         registry.rule(name, *productions)
       end
@@ -77,7 +77,7 @@ module Calyx
       # Hook for combining the registry of a parent grammar into the child that
       # inherits from it.
       #
-      # @param child_registry [Calyx::Registry]
+      # @param [Calyx::Registry] child_registry
       def inherit_registry(child_registry)
         registry.combine(child_registry) unless child_registry.nil?
       end
@@ -87,7 +87,7 @@ module Calyx
       #
       # This is automatically called by the Ruby engine.
       #
-      # @param subclass [Class]
+      # @param [Class] subclass
       def inherited(subclass)
         subclass.inherit_registry(registry)
       end
@@ -98,7 +98,7 @@ module Calyx
     # Grammar rules can be constructed on the fly when the passed-in block is
     # evaluated.
     #
-    # @param seed [Number]
+    # @param [Number] seed
     def initialize(seed=nil, &block)
       @seed = seed || Random.new_seed
       srand(@seed)
@@ -113,8 +113,9 @@ module Calyx
 
     # Produces a string as an output of the grammar.
     #
-    # @param start_symbol [Symbol]
-    # @param rules_map [Hash]
+    # @overload
+    #   @param [Symbol] start_symbol
+    #   @param [Hash] rules_map
     # @return [String]
     def generate(*args)
       start_symbol, rules_map = map_default_args(*args)
@@ -126,8 +127,9 @@ module Calyx
 
     # Produces a syntax tree of nested list nodes as an output of the grammar.
     #
-    # @param start_symbol [Symbol]
-    # @param rules_map [Hash]
+    # @overload
+    #   @param [Symbol] start_symbol
+    #   @param [Hash] rules_map
     # @return [Array]
     def evaluate(*args)
       start_symbol, rules_map = map_default_args(*args)

data/lib/calyx/modifiers.rb

@@ -8,8 +8,8 @@ module Calyx
     #
     # If an invalid modifier function is given, returns the raw input string.
     #
-    # @param name [Symbol]
-    # @param value [String]
+    # @param [Symbol] name
+    # @param [String] value
     # @return [String]
     def transform(name, value)
       if respond_to?(name)

data/lib/calyx/production/choices.rb

@@ -6,8 +6,8 @@ module Calyx
       # Parse a list of productions and return a choice node which is the head
       # of a syntax tree of child nodes.
       #
-      # @param productions [Array]
-      # @param registry [Calyx::Registry]
+      # @param [Array] productions
+      # @param [Calyx::Registry] registry
       def self.parse(productions, registry)
         choices = productions.map do |choice|
           if choice.is_a?(String)
@@ -27,7 +27,7 @@ module Calyx
 
       # Initialize a new choice with a list of child nodes.
       #
-      # @param collection [Array]
+      # @param [Array] collection
       def initialize(collection)
         @collection = collection
       end

data/lib/calyx/production/concat.rb

@@ -13,8 +13,8 @@ module Calyx
       #
       # Returns a concat node which is the head of a tree of child nodes.
       #
-      # @param production [String]
-      # @param registry [Calyx::Registry]
+      # @param [String] production
+      # @param [Calyx::Registry] registry
       def self.parse(production, registry)
         expansion = production.split(EXPRESSION).map do |atom|
           if atom.is_a?(String)
@@ -42,7 +42,7 @@ module Calyx
       # Initialize the concat node with an expansion of terminal and
       # non-terminal fragments.
       #
-      # @param expansion [Array]
+      # @param [Array] expansion
       def initialize(expansion)
         @expansion = expansion
       end

data/lib/calyx/production/expression.rb

@@ -4,9 +4,9 @@ module Calyx
     class Expression
       # Constructs a node representing a single template substitution.
       #
-      # @param production [#evaluate]
-      # @param methods [Array]
-      # @param registry [Calyx::Registry]
+      # @param [#evaluate] production
+      # @param [Array] methods
+      # @param [Calyx::Registry] registry
       def initialize(production, methods, registry)
         @production = production
         @methods = methods.map { |m| m.to_sym }

data/lib/calyx/production/memo.rb

@@ -8,8 +8,8 @@ module Calyx
       # Construct a memoized rule, given the symbol to lookup and the registry
       # to look it up in.
       #
-      # @param symbol [Symbol]
-      # @param registry [Calyx::Registry]
+      # @param [Symbol] symbol
+      # @param [Calyx::Registry] registry
       def initialize(symbol, registry)
         @symbol = symbol.slice(1, symbol.length-1).to_sym
         @registry = registry

data/lib/calyx/production/non_terminal.rb

@@ -6,8 +6,8 @@ module Calyx
       # Construct a non-terminal node, given the symbol to lookup and the
       # registry to look it up in.
       #
-      # @param symbol [Symbol]
-      # @param registry [Calyx::Registry]
+      # @param [Symbol] symbol
+      # @param [Calyx::Registry] registry
       def initialize(symbol, registry)
         @symbol = symbol.to_sym
         @registry = registry

data/lib/calyx/production/terminal.rb

@@ -4,7 +4,7 @@ module Calyx
     class Terminal
       # Construct a terminal node with the given value.
       #
-      # @param atom [#to_s]
+      # @param [#to_s] atom
       def initialize(atom)
         @atom = atom
       end

data/lib/calyx/production/weighted_choices.rb

@@ -7,8 +7,8 @@ module Calyx
       # Parse a given list or hash of productions into a syntax tree of weighted
       # choices.
       #
-      # @param productions [Array<Array>, Hash<#to_s, Float>]
-      # @param registry [Calyx::Registry]
+      # @param [Array<Array>, Hash<#to_s, Float>] productions
+      # @param [Calyx::Registry] registry
       def self.parse(productions, registry)
         weights_sum = productions.reduce(0) do |memo, choice|
           memo += choice.last
@@ -29,7 +29,7 @@ module Calyx
 
       # Initialize a new choice with a list of child nodes.
       #
-      # @param collection [Array]
+      # @param [Array] collection
       def initialize(collection)
         @collection = collection
       end

data/lib/calyx/registry.rb

@@ -12,30 +12,30 @@ module Calyx
 
     # Hook for defining rules without explicitly calling the `#rule` method.
     #
-    # @param name [Symbol]
-    # @param productions [Array]
+    # @param [Symbol] name
+    # @param [Array] productions
     def method_missing(name, *arguments)
       rule(name, *arguments)
     end
 
     # Attaches a modifier module to this instance.
     #
-    # @param module_name [Module]
+    # @param [Module] module_name
     def modifier(name)
       modifiers.extend(name)
     end
 
     # Registers a paired mapping regex.
     #
-    # @param name [Symbol]
-    # @param pairs [Hash<Regex,String>]
+    # @param [Symbol] name
+    # @param [Hash<Regex,String>] pairs
     def mapping(name, pairs)
       transforms[name.to_sym] = construct_mapping(pairs)
     end
 
     # Registers the given block as a string filter.
     #
-    # @param name [Symbol]
+    # @param [Symbol] name
     # @block block with a single string argument returning a modified string.
     def filter(name, callable=nil, &block)
       if block_given?
@@ -47,23 +47,23 @@ module Calyx
 
     # Registers a new grammar rule.
     #
-    # @param name [Symbol]
-    # @param productions [Array]
+    # @param [Symbol] name
+    # @param [Array] productions
     def rule(name, *productions)
       rules[name.to_sym] = construct_rule(productions)
     end
 
     # Expands the given rule symbol to its production.
     #
-    # @param symbol [Symbol]
+    # @param [Symbol] symbol
     def expand(symbol)
       rules[symbol] || context[symbol]
     end
 
     # Applies the given modifier function to the given value to transform it.
     #
-    # @param name [Symbol]
-    # @param value [String]
+    # @param [Symbol] name
+    # @param [String] value
     # @return [String]
     def transform(name, value)
       if transforms.key?(name)
@@ -76,7 +76,7 @@ module Calyx
     # Expands a memoized rule symbol by evaluating it and storing the result
     # for later.
     #
-    # @param symbol [Symbol]
+    # @param [Symbol] symbol
     def memoize_expansion(symbol)
       memos[symbol] ||= expand(symbol).evaluate
     end
@@ -86,7 +86,7 @@ module Calyx
     # This is only needed at compile time, so that child classes can easily
     # inherit the set of rules decared by their parent.
     #
-    # @param registry [Calyx::Registry]
+    # @param [Calyx::Registry] registry
     def combine(registry)
       @rules = rules.merge(registry.rules)
     end
@@ -96,8 +96,8 @@ module Calyx
     #
     # Produces a syntax tree of nested list nodes.
     #
-    # @param start_symbol [Symbol]
-    # @param rules_map [Hash]
+    # @param [Symbol] start_symbol
+    # @param [Hash] rules_map
     # @return [Array]
     def evaluate(start_symbol=:start, rules_map={})
       reset_evaluation_context
@@ -135,7 +135,12 @@ module Calyx
     def construct_mapping(pairs)
       mapper = -> (input) {
         match, target = pairs.detect { |match, target| input =~ match }
-        input.gsub(match, target)
+
+        if match && target
+          input.gsub(match, target)
+        else
+          input
+        end
       }
     end
 

data/lib/calyx/version.rb

@@ -1,3 +1,3 @@
 module Calyx
-  VERSION = '0.11.1'.freeze
+  VERSION = '0.11.2'.freeze
 end

metadata

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