gamefic 2.3.0 → 3.0.0

data/lib/gamefic/syntax.rb

@@ -1,72 +1,72 @@
+# frozen_string_literal: true
+
+require 'gamefic/syntax/template'
+
 module Gamefic
+  # Syntaxes provide rules for matching input patterns to existing responses.
+  # Common uses are to provide synonyms for response verbs and allow for
+  # variations in sentence structure.
+  #
+  # The template and command patterns use words beginning with a colon (e.g.,
+  # `:thing`) to identify phrases that should be tokenized into arguments.
+  #
+  # @example All of these syntaxes will translate input into a command of the
+  #   form "look thing container"
+  #
+  #     Syntax.new('examine :thing in :container', 'look :thing :container')
+  #     Syntax.new('look at :thing inside :container', 'look :thing :container')
+  #     Syntax.new('search :container for :thing', 'look :thing :container')
+  #
   class Syntax
-    attr_reader :token_count, :first_word, :verb, :template, :command
+    # The pattern that matching input is expected to follow.
+    #
+    # @return [Template]
+    attr_reader :template
+
+    # The pattern that will be used to tokenize the input into a command.
+    #
+    # @return [String]
+    attr_reader :command
+
+    # The response verb to which the command will be translated.
+    #
+    # @example
+    #   syntax = Syntax.new('examine :thing', 'look :thing')
+    #   syntax.verb #=> :look
+    #
+    # @return [Symbol]
+    attr_reader :verb
 
+    # @param template [Template, String]
+    # @param command [String]
     def initialize template, command
-      words = template.split_words
-      @token_count = words.length
-      command_words = command.split_words
-      @verb = nil
-      if words[0][0] == ':'
-        @token_count -= 1
-        @first_word = ''
-      else
-        @first_word = words[0].to_s
-        @verb = command_words[0].to_sym
-      end
-      @command = command_words.join(' ')
-      @template = words.join(' ')
-      tokens = []
-      variable_tokens = []
-      last_token_is_reg = false
-      words.each { |w|
-        if w.match(/^:[a-z0-9_]+$/i)
-          variable_tokens.push w
-          if last_token_is_reg
-            next
-          else
-            tokens.push '([\w\W\s\S]*?)'
-            last_token_is_reg = true
-          end
-        else
-          tokens.push w
-          last_token_is_reg = false
-        end
-      }
-      subs = []
-      index = 0
-      command_words.each { |t|
-        if t[0] == ':'
-          index = variable_tokens.index(t) + 1
-          subs.push "{$#{index}}"
-        else
-          subs.push t
-        end
-      }
-      @replace = subs.join(' ')
-      @regexp = Regexp.new("^#{tokens.join(' ')}$", Regexp::IGNORECASE)
+      @template = Template.to_template(template)
+      @command = command.normalize
+      @verb = Syntax.literal_or_nil(@command.keywords[0])
+      @replace = parse_replace
+    end
+
+    # A symbol for the first word in the template. Used by rulebooks to
+    # classify groups of related syntaxes.
+    #
+    # @example
+    #   syntax = Syntax.new('examine :thing', 'look :thing')
+    #   syntax.synonym #=> :examine
+    #
+    # @return [Symbol]
+    def synonym
+      template.verb
     end
 
     # Convert a String into a Command.
     #
     # @param text [String]
-    # @return [Gamefic::Command]
+    # @return [Command, nil]
     def tokenize text
-      m = text.match(@regexp)
-      return nil if m.nil?
-      arguments = []
-      b = @verb.nil? ? 0 : 1
-      xverb = @verb
-      @replace.to_s.split_words[b..-1].each { |r|
-        if r.match(/^\{\$[0-9]+\}$/)
-          arguments.push m[r[2..-2].to_i]
-        elsif arguments.empty? && xverb.nil?
-          xverb = r.to_sym
-        else
-          arguments.push r
-        end
-      }
-      Command.new xverb, arguments
+      match = text&.match(template.regexp)
+      return nil unless match
+
+      Command.new(verb, match_to_args(match))
     end
 
     # Determine if the specified text matches the syntax's expected pattern.
@@ -74,47 +74,66 @@ module Gamefic
     # @param text [String]
     # @return [Boolean]
     def accept? text
-      !text.match(@regexp).nil?
+      !!text.match(template.regexp)
     end
 
     # Get a signature that identifies the form of the Syntax.
     # Signatures are used to compare Syntaxes to each other.
     #
     def signature
-      [@regexp, @replace]
+      [template.regexp, replace]
     end
 
     def ==(other)
-      return false unless other.is_a?(Syntax)
-      signature == other.signature
-    end
-
-    def eql?(other)
-      self == other
+      signature == other&.signature
     end
 
-    def hash
-      signature.hash
-    end
-
-    # Tokenize an Array of Commands from the specified text. The resulting
-    # array is in descending order of specificity, i.e., most to least matched
+    # Tokenize an array of commands from the specified text. The resulting
+    # array is in descending order of precision, i.e., most to least matched
     # tokens.
     #
     # @param text [String] The text to tokenize.
-    # @param syntaxes [Array<Gamefic::Syntax>] The Syntaxes to use.
-    # @return [Array<Gamefic::Command>] The tokenized commands.
+    # @param syntaxes [Array<Syntax>] The syntaxes to use.
+    # @return [Array<Command>] The tokenized commands.
     def self.tokenize text, syntaxes
       syntaxes
         .map { |syn| syn.tokenize(text) }
-        .reject(&:nil?)
-        .sort do |a, b|
-          if a.arguments.length == b.arguments.length
-            b.verb.to_s <=> a.verb.to_s
-          else
-            b.arguments.length <=> a.arguments.length
-          end
-        end
+        .compact
+        .sort { |syn, other_syn| syn.compare other_syn }
+    end
+
+    # Compare two syntaxes for the purpose of ordering them in rulebooks.
+    #
+    def compare other
+      template.compare other.template
+    end
+
+    # @param string [String]
+    # @return [String, nil]
+    def self.literal_or_nil string
+      string.start_with?(':') ? nil : string.to_sym
+    end
+
+    private
+
+    # @return [String]
+    attr_reader :replace
+
+    def parse_replace
+      command.keywords.map do |word|
+        next word unless word.start_with?(':')
+
+        index = template.params.index(word) ||
+                raise(ArgumentError, "syntax command references undefined parameter `#{word}`")
+        "{$#{index + 1}}"
+      end.join(' ')
+    end
+
+    def match_to_args match
+      start = replace.start_with?('{') ? 0 : 1
+      replace.keywords[start..].map do |str|
+        str.match?(/^\{\$[0-9]+\}$/) ? match[str[2..-2].to_i] : str
+      end
     end
   end
 end

data/lib/gamefic/vault.rb

@@ -0,0 +1,50 @@
+module Gamefic
+  # An array wrapper that exposes a protected interface. The array is always
+  # returned frozen. It can only be modified through #add and #delete. The
+  # vault can be "locked" to prevent existing elements from being deleted.
+  #
+  class Vault
+    def initialize
+      @set = Set.new
+      @array = []
+      @lock_index = nil
+    end
+
+    # @return [Array]
+    def array
+      @array.freeze
+    end
+
+    # @param object [Object]
+    def add object
+      @array = @set.add(object).to_a
+      object
+    end
+
+    # @param object [Object]
+    # @return [Boolean] True if object was deleted
+    def delete object
+      return false unless deletable?(object) && @set.delete?(object)
+
+      @array = @set.to_a.freeze
+      true
+    end
+
+    # Lock the current elements in the vault.
+    #
+    # After the vault is locked, calling #delete on a locked element will leave
+    # the element in the array and return false. Elements added after the lock
+    # can be deleted.
+    #
+    def lock
+      return @lock_index if @lock_index
+
+      @lock_index = @array.length
+    end
+
+    # @return [Boolean] True if the object is deletable (i.e., not locked).
+    def deletable? object
+      @lock_index.to_i <= @array.find_index(object).to_i
+    end
+  end
+end

data/lib/gamefic/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gamefic
-  VERSION = '2.3.0'
+  VERSION = '3.0.0'
 end

data/lib/gamefic.rb

@@ -1,22 +1,33 @@
-require 'gamefic/version'
+# frozen_string_literal: true
 
-require 'gamefic/keywords'
+require 'json'
+require 'gamefic/version'
+require 'gamefic/logging'
 require 'gamefic/core_ext/array'
 require 'gamefic/core_ext/string'
-
+require 'gamefic/syntax'
+require 'gamefic/response'
+require 'gamefic/rulebook'
+require 'gamefic/query'
+require 'gamefic/scanner'
+require 'gamefic/scope'
+require 'gamefic/command'
+require 'gamefic/action'
+require 'gamefic/props'
+require 'gamefic/scene'
+require 'gamefic/scriptable'
+require 'gamefic/block'
+require 'gamefic/stage'
+require 'gamefic/vault'
+require 'gamefic/narrative'
+require 'gamefic/plot'
+require 'gamefic/subplot'
+require 'gamefic/snapshot'
+require 'gamefic/node'
 require 'gamefic/describable'
-require 'gamefic/serialize'
-require 'gamefic/element'
+require 'gamefic/messenger'
 require 'gamefic/entity'
+require 'gamefic/dispatcher'
 require 'gamefic/active'
+require 'gamefic/active/cue'
 require 'gamefic/actor'
-require "gamefic/scene"
-require "gamefic/query"
-require "gamefic/action"
-require "gamefic/syntax"
-require "gamefic/command"
-require "gamefic/dispatcher"
-require 'gamefic/world'
-require 'gamefic/scriptable'
-require 'gamefic/plot'
-require 'gamefic/subplot'

data/spec-opal/spec_helper.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'gamefic'
+require 'ostruct'
+
+RSpec.configure do |config|
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  # config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  # Kernel.srand config.seed
+
+  config.after :each do
+    Gamefic::Narrative.blocks.clear
+    Gamefic::Plot.blocks.clear
+    Gamefic::Subplot.blocks.clear
+  end
+end

metadata

@@ -1,15 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: gamefic
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Fred Snyder
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-25 00:00:00.000000000 Z
+date: 2024-01-27 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: opal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: opal-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: opal-sprockets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -70,8 +112,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/rspec.yml"
 - ".gitignore"
 - ".rspec"
+- ".rspec-opal"
 - ".rubocop.yml"
 - ".solargraph.yml"
 - CHANGELOG.md
@@ -79,58 +123,77 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- bin/console
+- bin/setup
 - gamefic.gemspec
 - lib/gamefic.rb
 - lib/gamefic/action.rb
 - lib/gamefic/active.rb
+- lib/gamefic/active/cue.rb
+- lib/gamefic/active/epic.rb
+- lib/gamefic/active/messaging.rb
+- lib/gamefic/active/take.rb
 - lib/gamefic/actor.rb
+- lib/gamefic/block.rb
 - lib/gamefic/command.rb
 - lib/gamefic/core_ext/array.rb
 - lib/gamefic/core_ext/string.rb
 - lib/gamefic/describable.rb
 - lib/gamefic/dispatcher.rb
-- lib/gamefic/element.rb
 - lib/gamefic/entity.rb
-- lib/gamefic/keywords.rb
-- lib/gamefic/messaging.rb
+- lib/gamefic/logging.rb
+- lib/gamefic/messenger.rb
+- lib/gamefic/narrative.rb
 - lib/gamefic/node.rb
 - lib/gamefic/plot.rb
-- lib/gamefic/plot/darkroom.rb
-- lib/gamefic/plot/host.rb
-- lib/gamefic/plot/snapshot.rb
+- lib/gamefic/props.rb
+- lib/gamefic/props/default.rb
+- lib/gamefic/props/multiple_choice.rb
+- lib/gamefic/props/pause.rb
+- lib/gamefic/props/yes_or_no.rb
 - lib/gamefic/query.rb
 - lib/gamefic/query/base.rb
-- lib/gamefic/query/children.rb
-- lib/gamefic/query/descendants.rb
-- lib/gamefic/query/external.rb
-- lib/gamefic/query/family.rb
-- lib/gamefic/query/itself.rb
-- lib/gamefic/query/matches.rb
-- lib/gamefic/query/parent.rb
-- lib/gamefic/query/siblings.rb
+- lib/gamefic/query/general.rb
+- lib/gamefic/query/result.rb
+- lib/gamefic/query/scoped.rb
 - lib/gamefic/query/text.rb
-- lib/gamefic/query/tree.rb
+- lib/gamefic/response.rb
+- lib/gamefic/rulebook.rb
+- lib/gamefic/rulebook/calls.rb
+- lib/gamefic/rulebook/events.rb
+- lib/gamefic/rulebook/hooks.rb
+- lib/gamefic/rulebook/scenes.rb
+- lib/gamefic/scanner.rb
 - lib/gamefic/scene.rb
 - lib/gamefic/scene/activity.rb
-- lib/gamefic/scene/base.rb
 - lib/gamefic/scene/conclusion.rb
+- lib/gamefic/scene/default.rb
 - lib/gamefic/scene/multiple_choice.rb
-- lib/gamefic/scene/multiple_scene.rb
 - lib/gamefic/scene/pause.rb
 - lib/gamefic/scene/yes_or_no.rb
+- lib/gamefic/scope.rb
+- lib/gamefic/scope/base.rb
+- lib/gamefic/scope/children.rb
+- lib/gamefic/scope/family.rb
+- lib/gamefic/scope/myself.rb
+- lib/gamefic/scope/parent.rb
+- lib/gamefic/scope/siblings.rb
 - lib/gamefic/scriptable.rb
-- lib/gamefic/serialize.rb
+- lib/gamefic/scriptable/actions.rb
+- lib/gamefic/scriptable/entities.rb
+- lib/gamefic/scriptable/events.rb
+- lib/gamefic/scriptable/proxy.rb
+- lib/gamefic/scriptable/queries.rb
+- lib/gamefic/scriptable/scenes.rb
+- lib/gamefic/snapshot.rb
+- lib/gamefic/stage.rb
 - lib/gamefic/subplot.rb
 - lib/gamefic/syntax.rb
+- lib/gamefic/syntax/template.rb
+- lib/gamefic/vault.rb
 - lib/gamefic/version.rb
-- lib/gamefic/world.rb
-- lib/gamefic/world/callbacks.rb
-- lib/gamefic/world/commands.rb
-- lib/gamefic/world/entities.rb
-- lib/gamefic/world/playbook.rb
-- lib/gamefic/world/players.rb
-- lib/gamefic/world/scenes.rb
-homepage: http://gamefic.com
+- spec-opal/spec_helper.rb
+homepage: https://gamefic.com
 licenses:
 - MIT
 metadata: {}
@@ -142,7 +205,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/gamefic/element.rb

@@ -1,46 +0,0 @@
-module Gamefic
-  # The simplest class that can compose an object for use in a plot.
-  # Most game objects, especially tangible items in the game, should derive
-  # from the Entity class. Elements, on the other hand, can be used for
-  # abstractions and ideas that don't have a physical presence but still might
-  # need to be referenced in a command.
-  #
-  class Element
-    include Gamefic::Describable
-    include Gamefic::Serialize
-
-    def initialize(args = {})
-      klass = self.class
-      defaults = {}
-      while klass <= Element
-        defaults = klass.default_attributes.merge(defaults)
-        klass = klass.superclass
-      end
-      defaults.merge(args).each_pair do |k, v|
-        public_send "#{k}=", v
-      end
-      post_initialize
-      yield self if block_given?
-    end
-
-    def post_initialize
-      # raise NotImplementedError, "#{self.class} must implement post_initialize"
-    end
-
-    class << self
-      # Set or update the default values for new instances.
-      #
-      # @param attrs [Hash] The attributes to be merged into the defaults.
-      def set_default attrs = {}
-        default_attributes.merge! attrs
-      end
-
-      # A hash of default values for attributes when creating an instance.
-      #
-      # @return [Hash]
-      def default_attributes
-        @default_attributes ||= {}
-      end
-    end
-  end
-end

data/lib/gamefic/keywords.rb

@@ -1,52 +0,0 @@
-module Gamefic
-  module Keywords
-    SPLIT_REGEXP = /[\s]+/
-
-    # Get an array of keywords associated with this object.
-    # The default implementation splits the value of self.to_s into an array.
-    #
-    # @return [Array<String>]
-    def keywords
-      self.to_s.downcase.split(SPLIT_REGEXP).uniq
-    end
-
-    # Determine if this object matches the provided description.
-    # In a regular match, every word in the description must be a keyword.
-    # Fuzzy matches accept words if a keyword starts with it, e.g., "red"
-    # would be a fuzzy match for "reddish."
-    #
-    # @example
-    #   dog = "big red dog"
-    #   dog.extend Gamefic::Matchable
-    #
-    #   dog.specified?("red dog")  #=> true
-    #   dog.specified?("gray dog") #=> false
-    #   dog.specified?("red do")   #=> false
-    #
-    #   dog.specified?("re do", fuzzy: true)  #=> true
-    #   dog.specified?("red og", fuzzy: true) #=> false
-    #
-    # @param description [String] The description to be compared
-    # @param fuzzy [Boolean] Use fuzzy matching (default is false)
-    # @return [Boolean]
-    def specified? description, fuzzy: false
-      words = description.split(SPLIT_REGEXP)
-      return false if words.empty?
-      matches = 0
-      available = keywords
-      words.each { |w|
-        if fuzzy
-          available.each { |k|
-            if k.gsub(/[^a-z0-9]/, '').start_with?(w.downcase.gsub(/[^a-z0-9]/, ''))
-              matches +=1
-              break
-            end
-          }
-        else
-          matches +=1 if available.include?(w.downcase)
-        end
-      }
-      matches == words.length
-    end
-  end
-end

data/lib/gamefic/messaging.rb

@@ -1,43 +0,0 @@
-module Gamefic
-  module Messaging
-    # Send a message to the entity.
-    # This method will automatically wrap the message in HTML paragraphs.
-    # To send a message without paragraph formatting, use #stream instead.
-    #
-    # @param message [String]
-    def tell(message)
-      @messages = @messages.to_s + format(message)
-    end
-
-    # Send a message to the Character as raw text.
-    # Unlike #tell, this method will not wrap the message in HTML paragraphs.
-    #
-    # @param message [String]
-    def stream(message)
-      @messages = @messages.to_s + message
-    end
-
-    # Get all the currently buffered messages consolidated in a single string.
-    #
-    # @return [String]
-    def messages
-      @messages ||= ''
-    end
-
-    # Clear the buffered messages.
-    #
-    def flush
-      @messages = ''
-    end
-
-    private
-
-    def format message
-      "<p>#{message.strip}</p>"
-        .gsub(/[ \t\r]*\n[ \t\r]*\n[ \t\r]*/, "</p><p>")
-        .gsub(/[ \t]*\n[ \t]*/, ' ')
-        .gsub(/<p>[\s]*<p>/, '<p>')
-        .gsub(/<\/p>[\s]*<\/p>/, '</p>')
-    end
-  end
-end