calyx 0.12.1 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5ef3b96315fd2ed6eb9352e21a11a4fe650c06cb
-  data.tar.gz: d5c9cb27ee6626cdae2fe30ceef5c6bdb369e260
+  metadata.gz: b083064b7b93a5747ec7833b4e3ca46394f8f45b
+  data.tar.gz: d87854cd9b134257987fef4febfae492a7665d3d
 SHA512:
-  metadata.gz: 97709bec536e1f1ea619ec7f882184b4e4ec45c32b29371cd1c2ba30a88bbbcb0c637cce3d52ac5ebc6c37d642c8c51ff9fb47785a8c9775ffee0490d91bcdcd
-  data.tar.gz: 927d4e0ee0380e58299b97f6cffaae351575fbd15fa99e446c48c7a16dff9b90055625460862a533a02476748809aeb9840ce2b872549d0917f19b618b7ccc46
+  metadata.gz: 267238c9ed8dedc16de8096c53fc362d16f77a25f60ac5f0eb475c304740a44a1530fa236a9cb30f2175da7e39b20729555376b9c18af5118ea83f01711e86ef
+  data.tar.gz: 1dabb4bc4cd57d42e2887039ced705b9e10c6347e22714414103a737e52c4096ac378db9a6320a6902ab5036691d341a68c13b781bdc8a10062c0ddfd2ef31e4

data/.travis.yml

@@ -2,9 +2,9 @@ language: ruby
 rvm:
   - 2.1
   - 2.2
-  - 2.3.0
-  - rbx-2
+  - 2.3.1
+  - 2.4.0-preview1
+  - ruby-head
   - jruby-9
-  - jruby-head
 before_install: gem install bundler -v 1.10.6
 script: bundle exec rspec

data/README.md

@@ -397,7 +397,7 @@ end
 
 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.
+The `@` sigil 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
@@ -425,6 +425,24 @@ end
 
 Note that the memoization symbol can only be used on the right hand side of a production rule.
 
+### Unique Rules
+
+Rule expansions can be marked as ‘unique’, meaning that multiple references to the same rule always return a different value. This is useful for situations where the same result appearing twice would appear awkward and messy.
+
+Unique rules are marked by the `$` sigil.
+
+```ruby
+grammar = Calyx::Grammar.new do
+  start "{$medal}, {$medal}, {$medal}"
+  medal 'Gold', 'Silver', 'Bronze'
+end
+
+grammar.generate
+# => Silver, Bronze, Gold
+```
+
+**Note: this is a new and experimental feature and the API may change as kinks are ironed out from testing and exploration.**
+
 ### 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/production/choices.rb

@@ -17,6 +17,8 @@ module Calyx
           elsif choice.is_a?(Symbol)
             if choice[0] == Memo::SIGIL
               Memo.new(choice, registry)
+            elsif choice[0] == Unique::SIGIL
+              Unique.new(choice, registry)
             else
               NonTerminal.new(choice, registry)
             end

data/lib/calyx/production/concat.rb

@@ -3,7 +3,7 @@ module Calyx
     # 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
       START_TOKEN = '{'.freeze
       END_TOKEN = '}'.freeze
       DEREF_TOKEN = '.'.freeze
@@ -22,6 +22,8 @@ module Calyx
               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)
               else
                 rule = NonTerminal.new(head, registry)
               end

data/lib/calyx/production/unique.rb

@@ -0,0 +1,32 @@
+module Calyx
+  module Production
+    # 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
+    # and the list grows smaller.
+    #
+    # TODO: handle wraparound
+    class Unique
+      SIGIL = '$'.freeze
+
+      # Construct a unique rule, given the symbol to lookup and the registry
+      # to look it up in.
+      #
+      # @param [Symbol] symbol
+      # @param [Calyx::Registry] registry
+      def initialize(symbol, registry)
+        @symbol = symbol.slice(1, symbol.length-1).to_sym
+        @registry = registry
+      end
+
+      # Evaluate the unique rule, using the registry to handle the expansion
+      # and keep track of previous selections.
+      #
+      # @param [Random] random
+      # @return [Array]
+      def evaluate(random)
+        [@symbol, @registry.unique_expansion(@symbol)]
+      end
+    end
+  end
+end

data/lib/calyx/registry.rb

@@ -81,6 +81,26 @@ module Calyx
       memos[symbol] ||= expand(symbol).evaluate(@random)
     end
 
+    # Expands a unique rule symbol by evaluating it and checking that it hasn't
+    # previously been selected.
+    #
+    # @param [Symbol] symbol
+    def unique_expansion(symbol)
+      pending = true
+      uniques[symbol] = [] if uniques[symbol].nil?
+
+      while pending
+        result = expand(symbol).evaluate(@random)
+
+        unless uniques[symbol].include?(result)
+          uniques[symbol] << result
+          pending = false
+        end
+      end
+
+      result
+    end
+
     # Merges the given registry instance with the target registry.
     #
     # This is only needed at compile time, so that child classes can easily
@@ -91,8 +111,6 @@ module Calyx
       @rules = rules.merge(registry.rules)
     end
 
-
-
     # Evaluates the grammar defined in this registry, combining it with rules
     # from the passed in context.
     #
@@ -128,12 +146,13 @@ module Calyx
 
     private
 
-    attr_reader :random, :memos, :context
+    attr_reader :random, :memos, :context, :uniques
 
     def reset_evaluation_context(random)
       @random = random
       @context = {}
       @memos = {}
+      @uniques = {}
     end
 
     def construct_mapping(pairs)

data/lib/calyx/version.rb

@@ -1,3 +1,3 @@
 module Calyx
-  VERSION = '0.12.1'.freeze
+  VERSION = '0.13.0'.freeze
 end

data/lib/calyx.rb

@@ -5,6 +5,7 @@ require 'calyx/format'
 require 'calyx/registry'
 require 'calyx/modifiers'
 require 'calyx/production/memo'
+require 'calyx/production/unique'
 require 'calyx/production/choices'
 require 'calyx/production/concat'
 require 'calyx/production/expression'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: calyx
 version: !ruby/object:Gem::Version
-  version: 0.12.1
+  version: 0.13.0
 platform: ruby
 authors:
 - Mark Rickerby
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-03 00:00:00.000000000 Z
+date: 2017-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -82,6 +82,7 @@ files:
 - 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/registry.rb
 - lib/calyx/version.rb