calyx 0.18.0 → 0.22.0

data/lib/calyx/rule.rb

@@ -2,20 +2,41 @@ module Calyx
   # Represents a named rule connected to a tree of productions that can be
   # evaluated and a trace which represents where the rule was declared.
   class Rule
-    attr_reader :name, :productions, :trace
+    def self.build_ast(productions, registry)
+      if productions.first.is_a?(Hash)
+        # TODO: test that key is a string
+
+        if productions.first.first.last.is_a?(String)
+          # If value of the production is a strings then this is a
+          # paired mapping production.
+          Production::AffixTable.parse(productions.first, registry)
+        else
+          # Otherwise, we assume this is a weighted choice declaration and
+          # convert the hash to an array
+          Syntax::WeightedChoices.parse(productions.first.to_a, registry)
+        end
+      elsif productions.first.is_a?(Enumerable)
+        # TODO: this needs to change to support attributed/tagged grammars
+        Syntax::WeightedChoices.parse(productions, registry)
+      else
+        Syntax::Choices.parse(productions, registry)
+      end
+    end
+
+    attr_reader :name, :tree, :trace
 
     def initialize(name, productions, trace)
       @name = name.to_sym
-      @productions = productions
+      @tree = productions
       @trace = trace
     end
 
     def size
-      productions.size
+      tree.size
     end
 
     def evaluate(options)
-      productions.evaluate(options)
+      tree.evaluate(options)
     end
   end
 end

data/lib/calyx/{production → syntax}/choices.rb

@@ -1,7 +1,7 @@
 module Calyx
   # A type of production rule representing a list of possible rules, one of
   # which will chosen each time the grammar runs.
-  module Production
+  module Syntax
     class Choices
       # Parse a list of productions and return a choice node which is the head
       # of a syntax tree of child nodes.

data/lib/calyx/{production → syntax}/concat.rb

@@ -1,12 +1,12 @@
 module Calyx
-  module Production
+  module Syntax
     # A type of production rule representing a string combining both template
     # substitutions and raw content.
     class Concat
-      EXPRESSION = /(\{[A-Za-z0-9_@$\.]+\})/.freeze
+      EXPRESSION = /(\{[A-Za-z0-9_@$<>\.]+\})/.freeze
+      DEREF_OP = /([<>\.])/.freeze
       START_TOKEN = '{'.freeze
       END_TOKEN = '}'.freeze
-      DEREF_TOKEN = '.'.freeze
 
       # Parses an interpolated string into fragments combining terminal strings
       # and non-terminal rules.
@@ -16,21 +16,14 @@ module Calyx
       # @param [String] production
       # @param [Calyx::Registry] registry
       def self.parse(production, registry)
-        expansion = production.split(EXPRESSION).map do |atom|
+        expressions = production.split(EXPRESSION).map do |atom|
           if atom.is_a?(String)
             if atom.chars.first == START_TOKEN && atom.chars.last == END_TOKEN
-              head, *tail = atom.slice(1, atom.length-2).split(DEREF_TOKEN)
-              if head[0] == Memo::SIGIL
-                rule = Memo.new(head, registry)
-              elsif head[0] == Unique::SIGIL
-                rule = Unique.new(head, registry)
+              head, *tail = atom.slice(1, atom.length-2).split(DEREF_OP)
+              if tail.any?
+                ExpressionChain.parse(head, tail, registry)
               else
-                rule = NonTerminal.new(head, registry)
-              end
-              unless tail.empty?
-                Expression.new(rule, tail, registry)
-              else
-                rule
+                Expression.parse(head, registry)
               end
             else
               Terminal.new(atom)
@@ -38,28 +31,31 @@ module Calyx
           end
         end
 
-        self.new(expansion)
+        self.new(expressions)
       end
 
       # Initialize the concat node with an expansion of terminal and
       # non-terminal fragments.
       #
       # @param [Array] expansion
-      def initialize(expansion)
-        @expansion = expansion
+      def initialize(expressions)
+        @expressions = expressions
       end
 
-      # Evaluate all the child nodes of this node and concatenate them together
-      # into a single result.
+      # Evaluate all the child nodes of this node and concatenate each expansion
+      # together into a single result.
       #
       # @param [Calyx::Options] options
       # @return [Array]
       def evaluate(options)
-        concat = @expansion.reduce([]) do |exp, atom|
+        expansion = @expressions.reduce([]) do |exp, atom|
           exp << atom.evaluate(options)
         end
 
-        [:concat, concat]
+        #[:expansion, expansion]
+        # TODO: fix this along with a git rename
+        # Commented out because of a lot of tests depending on :concat symbol
+        [:concat, expansion]
       end
     end
   end

data/lib/calyx/syntax/expression.rb

@@ -0,0 +1,87 @@
+module Calyx
+  module Syntax
+    # A symbolic expression representing a single template substitution.
+    class Expression
+      def self.parse(symbol, registry)
+        if symbol[0] == Memo::SIGIL
+          Memo.new(symbol, registry)
+        elsif symbol[0] == Unique::SIGIL
+          Unique.new(symbol, registry)
+        else
+          NonTerminal.new(symbol, registry)
+        end
+      end
+    end
+
+    class Modifier < Struct.new(:type, :name, :map_dir)
+      def self.filter(name)
+        new(:filter, name, nil)
+      end
+
+      def self.map_left(name)
+        new(:map, name, :left)
+      end
+
+      def self.map_right(name)
+        new(:map, name, :right)
+      end
+    end
+
+    # Handles filter chains that symbolic expressions can pass through to
+    # generate a custom substitution.
+    class ExpressionChain
+      def self.parse(production, production_chain, registry)
+        modifier_chain = production_chain.each_slice(2).map do |op_token, target|
+          rule = target.to_sym
+          case op_token
+          when Token::EXPR_FILTER then Modifier.filter(rule)
+          when Token::EXPR_MAP_LEFT then Modifier.map_left(rule)
+          when Token::EXPR_MAP_RIGHT then Modifier.map_right(rule)
+          else
+            # Should not end up here because the regex excludes it but this
+            # could be a place to add a helpful parse error on any weird
+            # chars used by the expression—current behaviour is to pass
+            # the broken expression through to the result as part of the
+            # text, as if that is what the author meant.
+            raise("unreachable")
+          end
+        end
+
+        expression = Expression.parse(production, registry)
+
+        self.new(expression, modifier_chain, registry)
+      end
+
+      # @param [#evaluate] production
+      # @param [Array] modifiers
+      # @param [Calyx::Registry] registry
+      def initialize(production, modifiers, registry)
+        @production = production
+        @modifiers = modifiers
+        @registry = registry
+      end
+
+      # Evaluate the expression by expanding the non-terminal to produce a
+      # terminal string, then passing it through the given modifier chain and
+      # returning the transformed result.
+      #
+      # @param [Calyx::Options] options
+      # @return [Array]
+      def evaluate(options)
+        expanded = @production.evaluate(options).flatten.reject { |o| o.is_a?(Symbol) }.join
+        chain = []
+
+        expression = @modifiers.reduce(expanded) do |value, modifier|
+          case modifier.type
+          when :filter
+            @registry.expand_filter(modifier.name, value)
+          when :map
+            @registry.expand_map(modifier.name, value, modifier.map_dir)
+          end
+        end
+
+        [:expression, expression]
+      end
+    end
+  end
+end

data/lib/calyx/{production → syntax}/memo.rb

@@ -1,5 +1,5 @@
 module Calyx
-  module Production
+  module Syntax
     # A type of production rule representing a memoized subsitution which
     # returns the first value selected on all subsequent lookups.
     class Memo

data/lib/calyx/{production → syntax}/non_terminal.rb

@@ -1,5 +1,5 @@
 module Calyx
-  module Production
+  module Syntax
     # A type of production rule that represents a non-terminal expansion,
     # linking one rule to another.
     class NonTerminal

data/lib/calyx/syntax/paired_mapping.rb

@@ -0,0 +1,53 @@
+module Calyx
+  module Syntax
+    # A type of production rule representing a bidirectional dictionary of
+    # mapping pairs that can be used as a substitution table in template
+    # expressions.
+    class PairedMapping
+      def self.parse(productions, registry)
+        # TODO: handle wildcard expressions
+        self.new(productions)
+      end
+
+      # %es
+      # prefix: nil, suffix: 'es'
+      # match: 'buses' -> ends_with(suffix)
+
+      # %y
+      # prefix: nil, suffix: 'ies'
+
+      def initialize(mapping)
+        @lhs_index = PrefixTree.new
+        @rhs_index = PrefixTree.new
+
+        @lhs_list = mapping.keys
+        @rhs_list = mapping.values
+
+        @lhs_index.add_all(@lhs_list)
+        @rhs_index.add_all(@rhs_list)
+      end
+
+      def value_for(key)
+        match = @lhs_index.lookup(key)
+        result = @rhs_list[match.index]
+
+        if match.captured
+          result.sub("%", match.captured)
+        else
+          result
+        end
+      end
+
+      def key_for(value)
+        match = @rhs_index.lookup(value)
+        result = @lhs_list[match.index]
+
+        if match.captured
+          result.sub("%", match.captured)
+        else
+          result
+        end
+      end
+    end
+  end
+end

data/lib/calyx/{production → syntax}/terminal.rb

@@ -1,5 +1,5 @@
 module Calyx
-  module Production
+  module Syntax
     # A type of production rule that terminates with a resulting string atom.
     class Terminal
       # Construct a terminal node with the given value.

data/lib/calyx/syntax/token.rb

@@ -0,0 +1,9 @@
+module Calyx
+  module Syntax
+    module Token
+      EXPR_MAP_LEFT = "<"
+      EXPR_MAP_RIGHT = ">"
+      EXPR_FILTER = "."
+    end
+  end
+end

data/lib/calyx/{production → syntax}/unique.rb

@@ -1,5 +1,5 @@
 module Calyx
-  module Production
+  module Syntax
     # A type of production rule representing a unique substitution which only
     # returns values that have not previously been selected. The probability
     # that a given rule will be selected increases as more selections are made

data/lib/calyx/{production → syntax}/weighted_choices.rb

@@ -1,5 +1,5 @@
 module Calyx
-  module Production
+  module Syntax
     # A type of production rule representing a map of possible rules with
     # associated weights that define the expected probability of a rule
     # being chosen.
@@ -12,7 +12,7 @@ module Calyx
       #
       # @param [Array<Array>, Hash<#to_s, Float>] productions
       # @param [Calyx::Registry] registry
-      # @return [Calyx::Production::WeightedChoices]
+      # @return [Calyx::Syntax::WeightedChoices]
       def self.parse(productions, registry)
         if productions.first.last.is_a?(Range)
           range_max = productions.max { |a,b| a.last.max <=> b.last.max }.last.max
@@ -63,6 +63,13 @@ module Calyx
         @collection = collection
       end
 
+      # The number of possible choices available for this rule.
+      #
+      # @return [Integer]
+      def size
+        @collection.size
+      end
+
       # Evaluate the choice by randomly picking one of its possible options,
       # balanced according to the given weights.
       #

data/lib/calyx/version.rb

@@ -1,3 +1,3 @@
 module Calyx
-  VERSION = '0.18.0'.freeze
+  VERSION = '0.22.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: calyx
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.22.0
 platform: ruby
 authors:
 - Mark Rickerby
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-07-30 00:00:00.000000000 Z
+date: 2021-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -60,8 +60,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
-- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - Gemfile
@@ -69,98 +69,40 @@ files:
 - README.md
 - SYNTAX.md
 - calyx.gemspec
-- docs/404.html
-- docs/CNAME
-- docs/_config.yml
-- docs/_data/breadcrumbs.yml
-- docs/_data/docs.yml
-- docs/_data/examples.yml
-- docs/_includes/breadcrumbs.html
-- docs/_includes/contents.html
-- docs/_includes/icon-github.html
-- docs/_includes/icon-rubygems.html
-- docs/_includes/navbar.html
-- docs/_includes/pagebar.html
-- docs/_layouts/default.html
-- docs/_layouts/docs.html
-- docs/_layouts/home.html
-- docs/_layouts/page.html
-- docs/_posts/2017-09-14-welcome-to-jekyll.markdown
-- docs/_posts/2017-09-21-0.17.0-released.md
-- docs/_styles/card.scss
-- docs/_styles/colors.scss
-- docs/_styles/content.scss
-- docs/_styles/cta.scss
-- docs/_styles/grid.scss
-- docs/_styles/media.scss
-- docs/_styles/menu.scss
-- docs/_styles/modifiers.scss
-- docs/_styles/navbar.scss
-- docs/_styles/pagebar.scss
-- docs/_styles/reset.scss
-- docs/_styles/scale.scss
-- docs/_styles/spread.scss
-- docs/_styles/styleguide.scss
-- docs/_styles/syntax.scss
-- docs/_styles/typography.scss
-- docs/_styles/yard.scss
-- docs/api.html
-- docs/assets/calyx-docs.css
-- docs/assets/calyx-flower-outline.svg
-- docs/assets/calyx-flower-reverse.svg
-- docs/assets/calyx-flower.svg
-- docs/assets/logo-small.png
-- docs/assets/logos/calyx-flower-1.svg
-- docs/assets/logos/calyx-flower-2.svg
-- docs/content/documentation.html
-- docs/content/examples.html
-- docs/content/examples/any-gradient.md
-- docs/content/examples/faker.md
-- docs/content/examples/tiny-woodland-bot.md
-- docs/content/guides/context.md
-- docs/content/guides/expressions.md
-- docs/content/guides/features.md
-- docs/content/guides/formats.md
-- docs/content/guides/installation.md
-- docs/content/guides/random.md
-- docs/content/guides/results.md
-- docs/content/index.html
-- docs/content/introduction.md
-- docs/content/introduction/concepts.md
-- docs/content/introduction/contributing.md
-- docs/content/introduction/tutorial.md
-- docs/content/styleguide.html
-- docs/docs.scss
-- docs/index.html
-- docs/package-lock.json
-- docs/package.json
 - examples/any_gradient.rb
+- examples/faker.json
 - examples/faker.rb
-- examples/faker.yml
 - examples/tiny_woodland_bot.rb
 - lib/calyx.rb
 - lib/calyx/errors.rb
 - lib/calyx/format.rb
 - lib/calyx/grammar.rb
+- lib/calyx/mapping.rb
 - lib/calyx/modifiers.rb
 - lib/calyx/options.rb
-- lib/calyx/production/choices.rb
-- lib/calyx/production/concat.rb
-- lib/calyx/production/expression.rb
-- lib/calyx/production/memo.rb
-- lib/calyx/production/non_terminal.rb
-- lib/calyx/production/terminal.rb
-- lib/calyx/production/unique.rb
-- lib/calyx/production/weighted_choices.rb
+- lib/calyx/prefix_tree.rb
+- lib/calyx/production/affix_table.rb
+- lib/calyx/production/uniform_branch.rb
+- lib/calyx/production/weighted_branch.rb
 - lib/calyx/registry.rb
 - lib/calyx/result.rb
 - lib/calyx/rule.rb
+- lib/calyx/syntax/choices.rb
+- lib/calyx/syntax/concat.rb
+- lib/calyx/syntax/expression.rb
+- lib/calyx/syntax/memo.rb
+- lib/calyx/syntax/non_terminal.rb
+- lib/calyx/syntax/paired_mapping.rb
+- lib/calyx/syntax/terminal.rb
+- lib/calyx/syntax/token.rb
+- lib/calyx/syntax/unique.rb
+- lib/calyx/syntax/weighted_choices.rb
 - lib/calyx/version.rb
 homepage: https://github.com/maetl/calyx
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -175,9 +117,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Generate text with declarative recursive grammars
 test_files: []