calyx 0.15.0 → 0.15.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba09252aa5dedcc03c190a14c68be4eb446fc01c
-  data.tar.gz: cf7c1287f4dcfbc35682d74a1f83d3f7eeb8b2a4
+  metadata.gz: 5b983f729355f2a8ee4266d2d2564c041f4d3fd5
+  data.tar.gz: 2815d2887cefe608c285537b8ef1cd9d34204497
 SHA512:
-  metadata.gz: 670da35d3148a5aaaba3eb81edd7ba9635f3667cc2c1f6288b64cf2f79cafbc2649f752799911e8156609887f9fa260a95bb29765e9342b23bf5ca4f1fa87bca
-  data.tar.gz: 013ab7c2761b8db39e3748fd80602cecbcefe547c1802ccf703a4e459f880d54c0104b502c0798bb9048bcee63e7cf380bf1e6f4d434a04c2bf422e72bfd4200
+  metadata.gz: f0a44222fd6aed60b2ae457e4e0b3cf3b9cae69c7433853f198420a4b9fd2091199a1d379c9c3e64eff281cc0dc39bb61ada8d366304f25319ddb12a5a2319f0
+  data.tar.gz: 565bfb3335ef9c3c87c2769da6c7f1276432998bcd2b6cf273eda62536f8dcd62123005f4a1aaf5d1cc55882a0119c8fb682df1d0717fad07a8344662e0c08a0

data/lib/calyx.rb

@@ -1,4 +1,5 @@
 require 'calyx/version'
+require 'calyx/options'
 require 'calyx/rule'
 require 'calyx/grammar'
 require 'calyx/errors'

data/lib/calyx/grammar.rb

@@ -99,40 +99,36 @@ module Calyx
     # evaluated.
     #
     # @param [Numeric, Random, Hash] options
-    def initialize(options={}, &block)
-      unless options.is_a?(Hash)
+    def initialize(opts={}, &block)
+      unless opts.is_a?(Hash)
         config_opts = {}
-        if options.is_a?(Numeric)
+        if opts.is_a?(Numeric)
           warn [
             "NOTE: Passing a numeric seed arg directly is deprecated. ",
             "Use the options hash instead: `Calyx::Grammar.new(seed: 1234)`"
           ].join
-          config_opts[:seed] = options
-        elsif options.is_a?(Random)
+          config_opts[:seed] = opts
+        elsif opts.is_a?(Random)
           warn [
             "NOTE: Passing a Random object directly is deprecated. ",
             "Use the options hash instead: `Calyx::Grammar.new(rng: Random.new)`"
           ].join
-          config_opts[:rng] = options
+          config_opts[:rng] = opts
         end
       else
-        config_opts = options.dup
+        config_opts = opts
       end
 
-      @random = if config_opts.key?(:seed)
-        Random.new(config_opts[:seed])
-      elsif config_opts.key?(:rng)
-        config_opts[:rng]
-      else
-        Random.new
-      end
+      @options = Options.new(config_opts)
 
       if block_given?
-        @registry = Registry.new(config_opts)
+        @registry = Registry.new
         @registry.instance_eval(&block)
       else
         @registry = self.class.registry
       end
+
+      @registry.options(@options)
     end
 
     # Produces a string as an output of the grammar.
@@ -144,7 +140,7 @@ module Calyx
     def generate(*args)
       start_symbol, rules_map = map_default_args(*args)
 
-      @registry.evaluate(start_symbol, @random, rules_map).flatten.reject do |obj|
+      @registry.evaluate(start_symbol, rules_map).flatten.reject do |obj|
         obj.is_a?(Symbol)
       end.join
     end
@@ -158,7 +154,7 @@ module Calyx
     def evaluate(*args)
       start_symbol, rules_map = map_default_args(*args)
 
-      @registry.evaluate(start_symbol, @random, rules_map)
+      @registry.evaluate(start_symbol, rules_map)
     end
 
     private

data/lib/calyx/options.rb

@@ -0,0 +1,35 @@
+module Calyx
+  class Options
+    DEFAULTS = {
+      strict: true
+    }
+
+    def initialize(opts={})
+      @options = DEFAULTS.merge(opts)
+    end
+
+    def rng
+      unless @options[:rng]
+        @options[:rng] = if @options[:seed]
+          Random.new(@options[:seed])
+        else
+          Random.new
+        end
+      end
+
+      @options[:rng]
+    end
+
+    def strict?
+      @options[:strict]
+    end
+
+    def merge(opts)
+      Options.new(@options.merge(opts.to_h))
+    end
+
+    def to_h
+      @options
+    end
+  end
+end

data/lib/calyx/production/choices.rb

@@ -36,10 +36,10 @@ module Calyx
 
       # Evaluate the choice by randomly picking one of its possible options.
       #
-      # @param [Random] random
+      # @param [Calyx::Options] options
       # @return [Array]
-      def evaluate(random)
-        [:choice, @collection.sample(random: random).evaluate(random)]
+      def evaluate(options)
+        [:choice, @collection.sample(random: options.rng).evaluate(options)]
       end
     end
   end

data/lib/calyx/production/concat.rb

@@ -52,11 +52,11 @@ module Calyx
       # Evaluate all the child nodes of this node and concatenate them together
       # into a single result.
       #
-      # @param [Random] random
+      # @param [Calyx::Options] options
       # @return [Array]
-      def evaluate(random)
+      def evaluate(options)
         concat = @expansion.reduce([]) do |exp, atom|
-          exp << atom.evaluate(random)
+          exp << atom.evaluate(options)
         end
 
         [:concat, concat]

data/lib/calyx/production/expression.rb

@@ -17,10 +17,10 @@ module Calyx
       # terminal string, then passing it through the given modifier chain and
       # returning the transformed result.
       #
-      # @param [Random] random
+      # @param [Calyx::Options] options
       # @return [Array]
-      def evaluate(random)
-        terminal = @production.evaluate(random).flatten.reject { |o| o.is_a?(Symbol) }.join
+      def evaluate(options)
+        terminal = @production.evaluate(options).flatten.reject { |o| o.is_a?(Symbol) }.join
         expression = @methods.reduce(terminal) do |value, method|
           @registry.transform(method, value)
         end

data/lib/calyx/production/memo.rb

@@ -17,9 +17,9 @@ module Calyx
 
       # Evaluate the memo, using the registry to handle the expansion.
       #
-      # @param [Random] random
+      # @param [Calyx::Options] options
       # @return [Array]
-      def evaluate(random)
+      def evaluate(options)
         [@symbol, @registry.memoize_expansion(@symbol)]
       end
     end

data/lib/calyx/production/non_terminal.rb

@@ -15,10 +15,10 @@ module Calyx
 
       # Evaluate the non-terminal, using the registry to handle the expansion.
       #
-      # @param [Random] random
+      # @param [Calyx::Options] options
       # @return [Array]
-      def evaluate(random)
-        [@symbol, @registry.expand(@symbol).evaluate(random)]
+      def evaluate(options)
+        [@symbol, @registry.expand(@symbol).evaluate(options)]
       end
     end
   end

data/lib/calyx/production/terminal.rb

@@ -11,9 +11,9 @@ module Calyx
 
       # Evaluate the terminal by returning its identity directly.
       #
-      # @param [Random] random
+      # @param [Calyx::Options] options
       # @return [Array]
-      def evaluate(random)
+      def evaluate(options)
         [:atom, @atom]
       end
     end

data/lib/calyx/production/unique.rb

@@ -22,9 +22,9 @@ module Calyx
       # Evaluate the unique rule, using the registry to handle the expansion
       # and keep track of previous selections.
       #
-      # @param [Random] random
+      # @param [Calyx::Options] options
       # @return [Array]
-      def evaluate(random)
+      def evaluate(options)
         [@symbol, @registry.unique_expansion(@symbol)]
       end
     end

data/lib/calyx/production/weighted_choices.rb

@@ -40,14 +40,14 @@ module Calyx
       # The method for selecting weighted probabilities is based on a snippet
       # of code recommended in the Ruby standard library documentation.
       #
-      # @param [Random] random
+      # @param [Calyx::Options] options
       # @return [Array]
-      def evaluate(random)
+      def evaluate(options)
         choice = @collection.max_by do |_, weight|
-          random.rand ** (1.0 / weight)
+          options.rng.rand ** (1.0 / weight)
         end.first
 
-        [:weighted_choice, choice.evaluate(random)]
+        [:weighted_choice, choice.evaluate(options)]
       end
     end
   end

data/lib/calyx/registry.rb

@@ -4,13 +4,20 @@ module Calyx
     attr_reader :rules, :transforms, :modifiers
 
     # Construct an empty registry.
-    def initialize(options={})
-      @options = {}
+    def initialize
+      @options = Options.new({})
       @rules = {}
       @transforms = {}
       @modifiers = Modifiers.new
     end
 
+    # Applies additional config options to this instance.
+    #
+    # @param [Options] opts
+    def options(opts)
+      @options = @options.merge(opts)
+    end
+
     # Attaches a modifier module to this instance.
     #
     # @param [Module] module_name
@@ -77,7 +84,15 @@ module Calyx
     # @return [Calyx::Rule]
     def expand(symbol)
       expansion = rules[symbol] || context[symbol]
-      raise Errors::UndefinedRule.new(@last_expansion, symbol) if expansion.nil?
+
+      if expansion.nil?
+        if @options.strict?
+          raise Errors::UndefinedRule.new(@last_expansion, symbol)
+        else
+          expansion = Production::Terminal.new('')
+        end
+      end
+
       @last_expansion = expansion
       expansion
     end
@@ -100,7 +115,7 @@ module Calyx
     #
     # @param [Symbol] symbol
     def memoize_expansion(symbol)
-      memos[symbol] ||= expand(symbol).evaluate(@random)
+      memos[symbol] ||= expand(symbol).evaluate(@options)
     end
 
     # Expands a unique rule symbol by evaluating it and checking that it hasn't
@@ -112,7 +127,7 @@ module Calyx
       uniques[symbol] = [] if uniques[symbol].nil?
 
       while pending
-        result = expand(symbol).evaluate(@random)
+        result = expand(symbol).evaluate(@options)
 
         unless uniques[symbol].include?(result)
           uniques[symbol] << result
@@ -142,8 +157,8 @@ module Calyx
     # @param [Random] random
     # @param [Hash] rules_map
     # @return [Array]
-    def evaluate(start_symbol=:start, random=Random.new, rules_map={})
-      reset_evaluation_context(random)
+    def evaluate(start_symbol=:start, rules_map={})
+      reset_evaluation_context
 
       rules_map.each do |key, value|
         if rules.key?(key.to_sym)
@@ -153,15 +168,14 @@ module Calyx
         define_context_rule(key, caller_locations.last, value)
       end
 
-      [start_symbol, expand(start_symbol).evaluate(random)]
+      [start_symbol, expand(start_symbol).evaluate(@options)]
     end
 
     private
 
-    attr_reader :random, :memos, :context, :uniques
+    attr_reader :memos, :context, :uniques
 
-    def reset_evaluation_context(random)
-      @random = random
+    def reset_evaluation_context
       @context = {}
       @memos = {}
       @uniques = {}

data/lib/calyx/rule.rb

@@ -10,8 +10,8 @@ module Calyx
       @trace = trace
     end
 
-    def evaluate(random)
-      productions.evaluate(random)
+    def evaluate(options)
+      productions.evaluate(options)
     end
   end
 end

data/lib/calyx/version.rb

@@ -1,3 +1,3 @@
 module Calyx
-  VERSION = '0.15.0'.freeze
+  VERSION = '0.15.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: calyx
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.15.1
 platform: ruby
 authors:
 - Mark Rickerby
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-27 00:00:00.000000000 Z
+date: 2017-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -76,6 +76,7 @@ files:
 - lib/calyx/format.rb
 - lib/calyx/grammar.rb
 - lib/calyx/modifiers.rb
+- lib/calyx/options.rb
 - lib/calyx/production/choices.rb
 - lib/calyx/production/concat.rb
 - lib/calyx/production/expression.rb