calyx 0.9.4 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bde85e189408ceafef6e5e3c4904a2ee8fb8afde
-  data.tar.gz: 6e806f06faea71b4faf8b5022179a1d4ddafbd0e
+  metadata.gz: c30774b8a6567532e9ee613185e1f4505665e197
+  data.tar.gz: fd92cdc99522713e076ae9161d855c18eb42058f
 SHA512:
-  metadata.gz: c134603b50bdee4656209002a7f967a4e76b5c81ba300bbd36996274ae07f1c2e12bfa26a0a1d003dd1472f8dbb14d5b9ac163a4b264ef03190ebde1ab99496a
-  data.tar.gz: 7e5f60627784213ecfe65b1ba7f3009e1ce282736ee5c2ca0f8510537825ac3c7241304738233da8a1124482c654ee954bacb0aa0e0348fcd870983891ea16cc
+  metadata.gz: de2c0e4685357546aeda4474c5b16be15c1461c517d4c1ca0210ce21a85e191eeb23be760ac7660a48518b764e4c12c88f8a8e61e5487440a6d5d40f848784e7
+  data.tar.gz: 459fcb3685caeb784df815592ad1e0da37d82bbf29def422c27e90b90d7ccf9e8168115f6e484b6a99c835fa7106268b8c4171c10bd3f7af3bc194e1c7cc0798

data/.gitignore

@@ -8,3 +8,5 @@
 /spec/reports/
 /tmp/
 /*.gem
+.DS_Store
+NOTES*

data/README.md

@@ -94,7 +94,7 @@ Nesting and hierarchy can be manipulated to balance consistency with novelty. Th
 
 ```ruby
 module HelloWorld
-  Sentiment < Calyx::Grammar
+  class Sentiment < Calyx::Grammar
     start '{happy_phrase}', '{sad_phrase}'
     rule :happy_phrase, '{happy_greeting} {happy_adj} world.'
     rule :happy_greeting, 'Hello', 'Hi', 'Hey', 'Yo'
@@ -104,7 +104,7 @@ module HelloWorld
     rule :sad_adj, 'cruel', 'miserable'
   end
 
-  Mixed < Calyx::Grammar
+  class Mixed < Calyx::Grammar
     start '{greeting} {adj} world.'
     rule :greeting, 'Hello', 'Hi', 'Hey', 'Yo', 'Goodbye', 'So long', 'Farewell'
     rule :adj, 'wonderful', 'amazing', 'bright', 'beautiful', 'cruel', 'miserable'
@@ -219,6 +219,36 @@ end
 # => "A pear."
 ```
 
+### Memoized Rules
+
+Rule expansions can be ‘memoized’ so that multiple references to the same rule return the same value. This is useful for picking a noun from a list and reusing it in multiple places within a text.
+
+The `@` symbol is used to mark memoized rules. This evaluates the rule and stores it in memory the first time it’s referenced. All subsequent references to the memoized rule use the same stored value.
+
+```ruby
+# Without memoization
+grammar = Calyx::Grammar.new do
+  start '{name} <{name.downcase}>'
+  name 'Daenerys', 'Tyrion', 'Jon'
+end
+
+3.times { grammar.generate }
+# => Daenerys <jon>
+# => Tyrion <daenerys>
+# => Jon <tyrion>
+
+# With memoization
+grammar = Calyx::Grammar.new do
+  start '{@name} <{@name.downcase}>'
+  name 'Daenerys', 'Tyrion', 'Jon'
+end
+
+3.times { grammar.generate }
+# => Tyrion <tyrion>
+# => Daenerys <daenerys>
+# => Jon <jon>
+```
+
 ### Dynamically Constructing Rules
 
 Template expansions can be dynamically constructed at runtime by passing a context map of rules to the `#generate` method:

data/lib/calyx/errors.rb

@@ -0,0 +1,3 @@
+module Calyx
+  class RuleNotFound < NoMethodError; end
+end

data/lib/calyx/file_converter.rb

@@ -26,10 +26,12 @@ module Calyx
         build_grammar(json)
       end
 
-      def build_grammar(hash)
+      private
+
+      def build_grammar(rules)
         Calyx::Grammar.new do
-          hash.each do |rule_name, rule_productions|
-            rule(rule_name, *rule_productions)
+          rules.each do |label, productions|
+            rule(label, *productions)
           end
         end
       end

data/lib/calyx/grammar.rb

@@ -5,7 +5,11 @@ module Calyx
         @registry ||= Registry.new
       end
 
-      def rule(name, *productions, &production)
+      def mapping(name, pairs)
+        registry.mapping(name, pairs)
+      end
+
+      def rule(name, *productions)
         registry.rule(name, *productions)
       end
 

data/lib/calyx/production/choices.rb

@@ -0,0 +1,30 @@
+module Calyx
+  module Production
+    class Choices
+      def self.parse(productions, registry)
+        choices = productions.map do |choice|
+          if choice.is_a?(String)
+            Concat.parse(choice, registry)
+          elsif choice.is_a?(Fixnum)
+            Terminal.new(choice.to_s)
+          elsif choice.is_a?(Symbol)
+            if choice[0] == Memo::SIGIL
+              Memo.new(choice, registry)
+            else
+              NonTerminal.new(choice, registry)
+            end
+          end
+        end
+        self.new(choices)
+      end
+
+      def initialize(collection)
+        @collection = collection
+      end
+
+      def evaluate
+        [:choice, @collection.sample.evaluate]
+      end
+    end
+  end
+end

data/lib/calyx/production/concat.rb

@@ -0,0 +1,46 @@
+module Calyx
+  module Production
+    class Concat
+      EXPRESSION = /(\{[A-Za-z0-9_@\.]+\})/.freeze
+      START_TOKEN = '{'.freeze
+      END_TOKEN = '}'.freeze
+      DEREF_TOKEN = '.'.freeze
+
+      def self.parse(production, registry)
+        expansion = 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)
+              else
+                rule = NonTerminal.new(head, registry)
+              end
+              unless tail.empty?
+                Expression.new(rule, tail, registry)
+              else
+                rule
+              end
+            else
+              Terminal.new(atom)
+            end
+          end
+        end
+
+        self.new(expansion)
+      end
+
+      def initialize(expansion)
+        @expansion = expansion
+      end
+
+      def evaluate
+        concat = @expansion.reduce([]) do |exp, atom|
+          exp << atom.evaluate
+        end
+
+        [:concat, concat]
+      end
+    end
+  end
+end

data/lib/calyx/production/expression.rb

@@ -0,0 +1,20 @@
+module Calyx
+  module Production
+    class Expression
+      def initialize(production, methods, registry)
+        @production = production
+        @methods = methods.map { |m| m.to_sym }
+        @registry = registry
+      end
+
+      def evaluate
+        terminal = @production.evaluate.flatten.reject { |o| o.is_a?(Symbol) }.join(''.freeze)
+        expression = @methods.reduce(terminal) do |value, method|
+          @registry.transform(method, value)
+        end
+
+        [:expression, expression]
+      end
+    end
+  end
+end

data/lib/calyx/production/memo.rb

@@ -0,0 +1,16 @@
+module Calyx
+  module Production
+    class Memo
+      SIGIL = '@'.freeze
+
+      def initialize(symbol, registry)
+        @symbol = symbol.slice(1, symbol.length-1).to_sym
+        @registry = registry
+      end
+
+      def evaluate
+        [@symbol, @registry.memoize_expansion(@symbol)]
+      end
+    end
+  end
+end

data/lib/calyx/production/non_terminal.rb

@@ -0,0 +1,14 @@
+module Calyx
+  module Production
+    class NonTerminal
+      def initialize(symbol, registry)
+        @symbol = symbol.to_sym
+        @registry = registry
+      end
+
+      def evaluate
+        [@symbol, @registry.expand(@symbol).evaluate]
+      end
+    end
+  end
+end

data/lib/calyx/production/terminal.rb

@@ -0,0 +1,13 @@
+module Calyx
+  module Production
+    class Terminal
+      def initialize(atom)
+        @atom = atom
+      end
+
+      def evaluate
+        [:atom, @atom]
+      end
+    end
+  end
+end

data/lib/calyx/production/weighted_choices.rb

@@ -0,0 +1,35 @@
+module Calyx
+  module Production
+    class WeightedChoices
+      def self.parse(productions, registry)
+        weights_sum = productions.reduce(0) do |memo, choice|
+          memo += choice.last
+        end
+
+        raise 'Weights must sum to 1' if weights_sum != 1.0
+
+        choices = productions.map do |choice, weight|
+          if choice.is_a?(String)
+            [Concat.parse(choice, registry), weight]
+          elsif choice.is_a?(Symbol)
+            [NonTerminal.new(choice, registry), weight]
+          end
+        end
+
+        self.new(choices)
+      end
+
+      def initialize(collection)
+        @collection = collection
+      end
+
+      def evaluate
+        choice = @collection.max_by do |_, weight|
+          rand ** (1.0 / weight)
+        end.first
+
+        [:weighted_choice, choice.evaluate]
+      end
+    end
+  end
+end

data/lib/calyx/registry.rb

@@ -0,0 +1,91 @@
+module Calyx
+  class Registry
+    attr_reader :rules, :mappings
+
+    def initialize
+      @rules = {}
+      @mappings = {}
+    end
+
+    def method_missing(name, *arguments)
+      rule(name, *arguments)
+    end
+
+    def mapping(name, pairs)
+      mappings[name.to_sym] = construct_mapping(pairs)
+    end
+
+    def rule(name, *productions)
+      rules[name.to_sym] = construct_rule(productions)
+    end
+
+    def expand(symbol)
+      rules[symbol] || context[symbol]
+    end
+
+    def transform(name, value)
+      if value.respond_to?(name)
+        value.send(name)
+      else
+        mappings[name].call(value)
+      end
+    end
+
+    def memoize_expansion(symbol)
+      memos[symbol] ||= expand(symbol).evaluate
+    end
+
+    def combine(registry)
+      @rules = rules.merge(registry.rules)
+    end
+
+    def evaluate(start_symbol=:start, rules_map={})
+      reset_evaluation_context
+
+      rules_map.each do |key, value|
+        if rules.key?(key.to_sym)
+          raise "Rule already declared in grammar: #{key}"
+        end
+
+        context[key.to_sym] = if value.is_a?(Array)
+          Production::Choices.parse(value, self)
+        else
+          Production::Concat.parse(value.to_s, self)
+        end
+      end
+
+      expansion = expand(start_symbol)
+
+      if expansion.respond_to?(:evaluate)
+        [start_symbol, expansion.evaluate]
+      else
+        raise RuleNotFound.new(start_symbol)
+      end
+    end
+
+    private
+
+    attr_reader :memos, :context
+
+    def reset_evaluation_context
+      @context = {}
+      @memos = {}
+    end
+
+    def construct_mapping(pairs)
+      mapper = -> (input) {
+        pairs.each { |match,target|
+          return input.gsub(match, target) if input =~ match
+        }
+      }
+    end
+
+    def construct_rule(productions)
+      if productions.first.is_a?(Enumerable)
+        Production::WeightedChoices.parse(productions, self)
+      else
+        Production::Choices.parse(productions, self)
+      end
+    end
+  end
+end

data/lib/calyx/version.rb

@@ -1,3 +1,3 @@
 module Calyx
-  VERSION = '0.9.4'.freeze
+  VERSION = '0.10.0'.freeze
 end

data/lib/calyx.rb

@@ -1,11 +1,12 @@
 require 'calyx/version'
 require 'calyx/grammar'
+require 'calyx/errors'
 require 'calyx/file_converter'
-require 'calyx/grammar/registry'
-require 'calyx/grammar/production/memo'
-require 'calyx/grammar/production/choices'
-require 'calyx/grammar/production/concat'
-require 'calyx/grammar/production/expression'
-require 'calyx/grammar/production/non_terminal'
-require 'calyx/grammar/production/terminal'
-require 'calyx/grammar/production/weighted_choices'
+require 'calyx/registry'
+require 'calyx/production/memo'
+require 'calyx/production/choices'
+require 'calyx/production/concat'
+require 'calyx/production/expression'
+require 'calyx/production/non_terminal'
+require 'calyx/production/terminal'
+require 'calyx/production/weighted_choices'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: calyx
 version: !ruby/object:Gem::Version
-  version: 0.9.4
+  version: 0.10.0
 platform: ruby
 authors:
 - Mark Rickerby
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-10 00:00:00.000000000 Z
+date: 2016-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -68,16 +68,17 @@ files:
 - calyx.gemspec
 - examples/tiny_woodland.rb
 - lib/calyx.rb
+- lib/calyx/errors.rb
 - lib/calyx/file_converter.rb
 - lib/calyx/grammar.rb
-- lib/calyx/grammar/production/choices.rb
-- lib/calyx/grammar/production/concat.rb
-- lib/calyx/grammar/production/expression.rb
-- lib/calyx/grammar/production/memo.rb
-- lib/calyx/grammar/production/non_terminal.rb
-- lib/calyx/grammar/production/terminal.rb
-- lib/calyx/grammar/production/weighted_choices.rb
-- lib/calyx/grammar/registry.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/weighted_choices.rb
+- lib/calyx/registry.rb
 - lib/calyx/version.rb
 homepage: https://github.com/maetl/calyx
 licenses:

data/lib/calyx/grammar/production/choices.rb

@@ -1,32 +0,0 @@
-module Calyx
-  class Grammar
-    module Production
-      class Choices
-        def self.parse(productions, registry)
-          choices = productions.map do |choice|
-            if choice.is_a?(String)
-              Concat.parse(choice, registry)
-            elsif choice.is_a?(Fixnum)
-              Terminal.new(choice.to_s)
-            elsif choice.is_a?(Symbol)
-              if choice[0] == Memo::SIGIL
-                Memo.new(choice, registry)
-              else
-                NonTerminal.new(choice, registry)
-              end
-            end
-          end
-          self.new(choices)
-        end
-
-        def initialize(collection)
-          @collection = collection
-        end
-
-        def evaluate
-          [:choice, @collection.sample.evaluate]
-        end
-      end
-    end
-  end
-end

data/lib/calyx/grammar/production/concat.rb

@@ -1,48 +0,0 @@
-module Calyx
-  class Grammar
-    module Production
-      class Concat
-        EXPRESSION = /(\{[A-Za-z0-9_@\.]+\})/.freeze
-        START_TOKEN = '{'.freeze
-        END_TOKEN = '}'.freeze
-        DEREF_TOKEN = '.'.freeze
-
-        def self.parse(production, registry)
-          expansion = 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)
-                else
-                  rule = NonTerminal.new(head, registry)
-                end
-                unless tail.empty?
-                  Expression.new(rule, tail)
-                else
-                  rule
-                end
-              else
-                Terminal.new(atom)
-              end
-            end
-          end
-
-          self.new(expansion)
-        end
-
-        def initialize(expansion)
-          @expansion = expansion
-        end
-
-        def evaluate
-          concat = @expansion.reduce([]) do |exp, atom|
-            exp << atom.evaluate
-          end
-
-          [:concat, concat]
-        end
-      end
-    end
-  end
-end

data/lib/calyx/grammar/production/expression.rb

@@ -1,21 +0,0 @@
-module Calyx
-  class Grammar
-    module Production
-      class Expression
-        def initialize(production, methods)
-          @production = production
-          @methods = methods.map { |m| m.to_sym }
-        end
-
-        def evaluate
-          terminal = @production.evaluate.flatten.reject { |o| o.is_a?(Symbol) }.join(''.freeze)
-          expression = @methods.reduce(terminal) do |value,method|
-            value.send(method)
-          end
-
-          [:expression, expression]
-        end
-      end
-    end
-  end
-end

data/lib/calyx/grammar/production/memo.rb

@@ -1,18 +0,0 @@
-module Calyx
-  class Grammar
-    module Production
-      class Memo
-        SIGIL = '@'.freeze
-
-        def initialize(symbol, registry)
-          @symbol = symbol.slice(1, symbol.length-1).to_sym
-          @registry = registry
-        end
-
-        def evaluate
-          [@symbol, @registry.memoize_expansion(@symbol)]
-        end
-      end
-    end
-  end
-end

data/lib/calyx/grammar/production/non_terminal.rb

@@ -1,16 +0,0 @@
-module Calyx
-  class Grammar
-    module Production
-      class NonTerminal
-        def initialize(symbol, registry)
-          @symbol = symbol.to_sym
-          @registry = registry
-        end
-
-        def evaluate
-          [@symbol, @registry.expand(@symbol).evaluate]
-        end
-      end
-    end
-  end
-end

data/lib/calyx/grammar/production/terminal.rb

@@ -1,15 +0,0 @@
-module Calyx
-  class Grammar
-    module Production
-      class Terminal
-        def initialize(atom)
-          @atom = atom
-        end
-
-        def evaluate
-          [:atom, @atom]
-        end
-      end
-    end
-  end
-end

data/lib/calyx/grammar/production/weighted_choices.rb

@@ -1,37 +0,0 @@
-module Calyx
-  class Grammar
-    module Production
-      class WeightedChoices
-        def self.parse(productions, registry)
-          weights_sum = productions.reduce(0) do |memo, choice|
-            memo += choice.last
-          end
-
-          raise 'Weights must sum to 1' if weights_sum != 1.0
-
-          choices = productions.map do |choice, weight|
-            if choice.is_a?(String)
-              [Concat.parse(choice, registry), weight]
-            elsif choice.is_a?(Symbol)
-              [NonTerminal.new(choice, registry), weight]
-            end
-          end
-
-          self.new(choices)
-        end
-
-        def initialize(collection)
-          @collection = collection
-        end
-
-        def evaluate
-          choice = @collection.max_by do |_, weight|
-            rand ** (1.0 / weight)
-          end.first
-
-          [:weighted_choice, choice.evaluate]
-        end
-      end
-    end
-  end
-end

data/lib/calyx/grammar/registry.rb

@@ -1,64 +0,0 @@
-module Calyx
-  class Grammar
-    class Registry
-      attr_reader :rules, :memos
-
-      def initialize
-        @rules = {}
-      end
-
-      def method_missing(name, *arguments)
-        rule(name, *arguments)
-      end
-
-      def rule(name, *productions, &production)
-        @rules[name.to_sym] = construct_rule(productions)
-      end
-
-      def expand(symbol)
-        @rules[symbol] || @context[symbol]
-      end
-
-      def memoize_expansion(symbol)
-        memos[symbol] ||= expand(symbol).evaluate
-      end
-
-      def combine(registry)
-        @rules = rules.merge(registry.rules)
-      end
-
-      def evaluate(start_symbol=:start, rules_map={})
-        reset_state
-
-        rules_map.each do |key, value|
-          if rules.key?(key.to_sym)
-            raise "Rule already declared in grammar: #{key}"
-          end
-
-          @context[key.to_sym] = if value.is_a?(Array)
-            Production::Choices.parse(value, self)
-          else
-            Production::Concat.parse(value.to_s, self)
-          end
-        end
-
-        [start_symbol, expand(start_symbol).evaluate]
-      end
-
-      private
-
-      def reset_state
-        @context = {}
-        @memos = {}
-      end
-
-      def construct_rule(productions)
-        if productions.first.is_a?(Enumerable)
-          Production::WeightedChoices.parse(productions, self)
-        else
-          Production::Choices.parse(productions, self)
-        end
-      end
-    end
-  end
-end