fable 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 348d754ded39e5e54b960b19da8b893e562a93e0725700b5b6099a97bca47ab4
+  data.tar.gz: b3afee4ea96023091455c61bddd380fb6aff0fc105550990b409744ee98bbf8e
+SHA512:
+  metadata.gz: ac9fbe59c86847d34e3852ab472a82feb0836b7741736283386bdbb0e8f28c5c326a877626df471b0a74ba67c10f0f651706ff8f8a2df3d4e2f77d2d7a205dd2
+  data.tar.gz: fccfb6a20f17310827da5a4a7c0137b2f8959eb92d3e6a7f98aa55da57cf69cbe6a6041755ea9d999a620c3acdb73b01dc950f3b61fd396ecf5be7e1eabfcb10

data/.circleci/config.yml

@@ -0,0 +1,30 @@
+# Ruby CircleCI 2.1 configuration file
+#
+# Check https://circleci.com/docs/2.0/ruby/ for more details
+#
+version: 2.1
+
+
+orbs:
+  ruby: circleci/ruby@0.2.1 # Ruby orb registry: https://circleci.com/orbs/registry/orb/circleci/ruby
+
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:2.6.5
+    steps:
+      - checkout
+      - run:
+          name: Install Bundler 2.1.4
+          command: gem install bundler:2.1.4
+      - run:
+          name: Which bundler?
+          command: bundle -v
+      - ruby/install-deps
+      - ruby/save-cache
+      - run:
+          name: Tests
+          command: bin/test
+
+# What to do next? Set up a test job. Please see
+# https://circleci.com/docs/2.0/configuration-reference/, for more  info on how to get started.

data/.gitignore

@@ -0,0 +1,57 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+*.sublime-workspace
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/.ruby-version

@@ -0,0 +1 @@
+2.7.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at tcannon00@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in fable.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: .
+  specs:
+    fable (0.5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (11.1.1)
+    highline (2.0.3)
+    minitest (5.14.0)
+    minitest-line (0.6.5)
+      minitest (~> 5.0)
+    pretty-diffs (1.0.2)
+    rake (12.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug
+  fable!
+  highline
+  minitest (~> 5.0)
+  minitest-line
+  pretty-diffs
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Thomas Cannon
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,2 @@
+# fable
+A Ruby parser for Ink

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fable"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/test

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle exec rake test
+
+# Do any other automated setup that you need to do here

data/fable.gemspec

@@ -0,0 +1,34 @@
+require_relative 'lib/fable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fable"
+  spec.version       = Fable::VERSION
+  spec.authors       = ["Thomas Cannon"]
+  spec.email         = ["hello@thomascannon.me"]
+
+  spec.summary       = %q{An Ink runtime for Ruby}
+  # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/tcannonfodder/fable"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/tcannonfodder/fable"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "highline"
+  spec.add_development_dependency "minitest-line"
+  spec.add_development_dependency "pretty-diffs"
+end

data/fable.sublime-project

@@ -0,0 +1,8 @@
+{
+	"folders":
+	[
+		{
+			"path": "."
+		}
+	]
+}

data/lib/fable.rb

@@ -0,0 +1,49 @@
+module Fable
+  class Error < StandardError; end
+
+  class StoryError < Error
+    attr_accessor :use_end_line_number
+    alias_method :use_end_line_number?, :use_end_line_number
+  end
+
+  def assert!(conditional, error_message = "")
+    if !conditional
+      raise Error, error_message
+    end
+  end
+end
+
+
+require "fable/version"
+require 'fable/runtime_object'
+require "fable/void"
+
+require 'fable/call_stack'
+require 'fable/choice'
+require 'fable/choice_point'
+require 'fable/container'
+require 'fable/control_command'
+require 'fable/debug_metadata'
+require 'fable/divert'
+require 'fable/glue'
+require 'fable/ink_list'
+require 'fable/list_definition'
+require 'fable/list_definitions_origin'
+require 'fable/native_function_operations'
+require 'fable/native_function_call'
+require 'fable/observer'
+require 'fable/path'
+require 'fable/pointer'
+require 'fable/profiler'
+require 'fable/push_pop_type'
+require 'fable/search_result'
+require "fable/serializer"
+require "fable/state_patch"
+require 'fable/story'
+require 'fable/variables_state'
+require 'fable/story_state'
+require 'fable/tag'
+require 'fable/value'
+require 'fable/variable_assignment'
+require 'fable/variable_reference'
+

data/lib/fable/call_stack.rb

@@ -0,0 +1,351 @@
+module Fable
+  class CallStack
+    attr_accessor :threads, :thread_counter, :start_of_root
+
+    def initialize(story_context_or_call_stack)
+      if story_context_or_call_stack.is_a?(Story)
+        start_of_root = Pointer.start_of(story_context_or_call_stack.root_content_container)
+        reset!
+      elsif story_context_or_call_stack.is_a?(CallStack)
+        call_stack_to_copy = story_context_or_call_stack
+        self.threads = []
+
+        call_stack_to_copy.threads.each do |thread|
+          self.threads << thread.copy
+        end
+
+        self.thread_container = call_stack_to_copy.thread_counter
+        self.start_of_root = call_stack_to_copy.start_of_root
+      end
+    end
+
+    def reset!
+      new_thread = Thread.new
+      new_thread.call_stack << Element.new(:tunnel, self.start_of_root)
+      self.threads = [new_thread]
+      self.thread_counter = 0
+    end
+
+    def elements
+      call_stack
+    end
+
+    def depth
+      elements.size
+    end
+
+    def current_element
+      thread = threads.last
+      thread.call_stack.last
+    end
+
+    def current_element_index
+      call_stack.size - 1
+    end
+
+    def current_thread
+      threads.last
+    end
+
+    def current_thread=(value)
+      if threads.size != 1
+        raise StoryError, "Shouldn't be directly setting the current thread when we have a stack of them"
+      end
+
+      threads.clear
+      threads << value
+    end
+
+    def can_pop_thread?
+      threads.size > 1 && !element_is_evaluate_from_game?
+    end
+
+    def element_is_evaluate_from_game?
+      current_element.type == PushPopType::TYPES[:function_evaluation_from_game]
+    end
+
+    def push(type, options = {external_evaluation_stack_height: 0, output_stream_length_when_pushed: 0})
+      external_evaluation_stack_height = options[:external_evaluation_stack_height] || 0
+      output_stream_length_when_pushed = options[:output_stream_length_when_pushed] || 0
+      # When pushing to callstack, maintain the current content path, but jump
+      # out of expressions by default
+      element = Element.new(type, current_element.current_pointer, in_expression_evaluation: false)
+      element.evaluation_stack_height_when_pushed = external_evaluation_stack_height
+      element.function_start_in_output_stream = output_stream_length_when_pushed
+
+      self.call_stack << element
+    end
+
+    def can_pop?(type = nil)
+      return false if call_stack.size <= 1
+      return true if type.nil?
+      return current_element.type == type
+    end
+
+    def pop!(type=nil)
+      if can_pop?(type)
+        call_stack.pop
+      else
+        raise Error, "Mismatched push/pop in Callstack"
+      end
+    end
+
+    # Get variable value, dereferencing a variable pointer if necessary
+    def get_temporary_variable_with_name(name, context_index = -1)
+      if context_index == -1
+        context_index = current_element_index + 1
+      end
+
+      context_element = call_stack[context_index - 1]
+
+      return context_element.temporary_variables[name]
+    end
+
+    def set_temporary_variable(name, value, declare_new, context_index = -1)
+      if context_index == -1
+        context_index = current_element_index + 1
+      end
+
+      context_element = call_stack[context_index - 1]
+
+      if !declare_new && !context_element.temporary_variables.has_key?(name)
+        raise Error, "Could not find temporary variable to set: #{name}"
+      end
+
+      if context_element.temporary_variables.has_key?(name)
+        old_value = context_element.temporary_variables[name]
+        ListValue.retain_list_origins_for_assignment(old_value, value)
+      end
+
+      context_element.temporary_variables[name] = value
+    end
+
+    # Find the most appropriate context for this variable. Are we referencing
+    # a temporary or global variable? Note that the compiler will have warned
+    # us about possible conflicts, so anything that happens here should be safe
+    def context_for_variable_named(name)
+      # Current temporary context?
+      # (Shouldn't attempt to access contexts higher in the callstack)
+      if current_element.temporary_variables.has_key?(name)
+        return current_element_index + 1
+      else
+        # Global
+        return 0
+      end
+    end
+
+    def thread_with_index(index)
+      threads.find{|thread| thread.thread_index == index}
+    end
+
+    def call_stack
+      current_thread.call_stack
+    end
+
+    def push_thread!
+      new_thread = current_thread.copy
+      self.thread_counter += 1
+      self.threads << new_thread
+    end
+
+    def fork_thread!
+      forked_thread = current_thread.copy
+      self.thread_counter += 1
+      forked_thread.thread_index = self.thread_counter
+
+      return forked_thread
+    end
+
+    def pop_thread!
+      if can_pop_thread?
+        threads.delete(current_thread)
+      else
+        raise Error, "Can't pop thread"
+      end
+    end
+
+    def from_hash!(hash_to_use, story_context)
+      self.threads = []
+
+      hash_to_use["threads"].each do |thread_object|
+        self.threads << Thread.new(thread_object, story_context)
+      end
+
+      self.thread_counter = hash_to_use["threadCounter"]
+      self.start_of_root = Pointer.start_of(story_context.root_content_container)
+      self
+    end
+
+    def to_hash
+      export = {}
+      export["threads"] = []
+      self.threads.each do |thread|
+        export["threads"] << thread.to_hash
+      end
+
+      export["threadCounter"] = self.thread_counter
+      export
+    end
+
+    def call_stack_trace
+      result = StringIO.new
+
+      self.threads.each_with_index do |thread, i|
+        is_current_thread = thread == current_thread
+
+        result << "=== THREAD #{i}/#{threads.count} #{'(current)' if is_current_thread }\n"
+
+        thread.call_stack.each do |element|
+          case element.type
+          when :function
+            result << "  [FUNCTION] "
+          when :tunnel
+            result << "  [TUNNEL] "
+          end
+
+          pointer = element.current_pointer
+          if !pointer.null_pointer?
+            result << "<SOMEWHERE IN #{pointer.container.path.to_s}>\n"
+          end
+        end
+      end
+
+      result.rewind
+      result.read
+    end
+
+    class Element
+      attr_accessor :current_pointer, :in_expression_evaluation,
+      :temporary_variables, :type
+
+      alias_method :in_expression_evaluation?, :in_expression_evaluation
+
+      # When this callstack element is actually a function evaluation called
+      # from the game, we need to keep track of when it was called so that
+      # we know whether there was any return value
+      attr_accessor :evaluation_stack_height_when_pushed
+
+      # When functions are called, we trim whitespace from the start & end of
+      # what they generate, so we make sure we know where the function's
+      # start/end are
+      attr_accessor :function_start_in_output_stream
+
+      def initialize(type, pointer, options = {in_expression_evaluation: false})
+        self.current_pointer = pointer.dup
+        self.in_expression_evaluation = options[:in_expression_evaluation]
+        self.temporary_variables = {}
+        self.function_start_in_output_stream = 0
+        self.evaluation_stack_height_when_pushed = 0
+        self.type = type
+      end
+
+      def copy
+        copied_element = self.class.new(type, current_pointer, in_expression_evaluation: in_expression_evaluation)
+        copied_element.temporary_variables = Serializer.convert_to_runtime_objects_hash(Serializer.convert_hash_of_runtime_objects(temporary_variables))
+        copied_element.evaluation_stack_height_when_pushed = evaluation_stack_height_when_pushed
+        copied_element.function_start_in_output_stream = function_start_in_output_stream
+        copied_element
+      end
+    end
+
+    class Thread
+      attr_accessor :call_stack, :thread_index, :previous_pointer
+
+
+      def initialize(*arguments)
+        self.previous_pointer = Pointer.null_pointer
+
+        if arguments.size == 0
+          self.call_stack = []
+        else
+          self.initialize_with_thread_object_and_story_context(arguments[0], arguments[1])
+        end
+      end
+
+      def initialize_with_thread_object_and_story_context(thread_object, story_context)
+        self.call_stack = []
+        self.thread_index = thread_object["threadIndex"]
+
+        thread_object["callstack"].each do |element|
+          type = PushPopType::TYPE_LOOKUP[element["type"]]
+          pointer = Pointer.null_pointer
+
+          current_container_path_string = element["cPath"]
+
+          if current_container_path_string
+            thread_pointer_result = story_context.content_at_path(Path.new(current_container_path_string))
+            pointer.container = thread_pointer_result.container
+            pointer.index = element["idx"]
+
+            if thread_pointer_result.object.nil?
+              raise Error, "When loading state, internal story location couldn't be found: #{current_container_path_string}. Has the story changed since this save data was created?"
+            elsif thread_pointer_result.approximate?
+              story_context.warning("When loading state, internal story location couldn't be found: #{current_container_path_string}, so it wa approximated to #{pointer.container.path.to_s} to recover. Has the story changed since this save data was created?")
+            end
+          end
+
+          in_expression_evaluation = element["exp"]
+
+          new_element = Element.new(type, pointer, in_expression_evaluation: in_expression_evaluation)
+
+          if element["temp"]
+            new_element.temporary_variables = Serializer.convert_to_runtime_objects_hash(element["temp"])
+          else
+            new_element.temporary_variables = {}
+          end
+
+          self.call_stack << new_element
+        end
+
+        if thread_object["previousContentObject"]
+          previous_path = Path.new(thread_object["previousContentObject"])
+          self.previous_pointer = story_context.pointer_at_path(previous_path)
+        end
+
+        self
+      end
+
+      def copy
+        copied_thread = self.class.new
+        copied_thread.thread_index = thread_index
+        self.call_stack.each do |element|
+          copied_thread.call_stack << element.copy
+        end
+
+        copied_thread.previous_pointer = previous_pointer
+        copied_thread
+      end
+
+      def to_hash
+        export = {}
+
+        export["callstack"] = []
+
+        call_stack.each do |element|
+          element_export = {}
+          if !element.current_pointer.null_pointer?
+            element_export["cPath"] = element.current_pointer.container.path.to_s
+            element_export["idx"] = element.current_pointer.index
+          end
+
+          element_export["exp"] = element.in_expression_evaluation?
+          element_export["type"] = PushPopType::TYPES[element.type]
+
+          if element.temporary_variables.any?
+            element_export["temp"] = Serializer.convert_hash_of_runtime_objects(element.temporary_variables)
+          end
+
+          export["callstack"] << element_export
+        end
+
+        export["threadIndex"] = thread_index
+
+        if !previous_pointer.null_pointer?
+          export["previousContentObject"] = self.previous_pointer.resolve!.path.to_s
+        end
+
+        export
+      end
+    end
+  end
+end