gamefic 1.6.0 → 2.0.3

data/lib/gamefic/world/players.rb

@@ -0,0 +1,37 @@
+module Gamefic
+  module World
+    module Players
+      include Gamefic::World::Entities
+      include Gamefic::World::Commands
+
+      # An array of entities that are currently connected to users.
+      #
+      # @return [Array<Gamefic::Actor>]
+      def players
+        @players ||= []
+      end
+
+      def player_class cls = nil
+        STDERR.puts "Modifying player_class this way is deprecated. Use set_player_class instead" unless cls.nil?
+        @player_class = cls unless cls.nil?
+        @player_class ||= Gamefic::Actor
+      end
+
+      # @param cls [Class]
+      def set_player_class cls
+        unless cls < Gamefic::Active && cls <= Gamefic::Entity
+          raise ArgumentError, "Player class must be an active entity"
+        end
+        @player_class = cls
+      end
+
+      # Make a character that a player will control on introduction.
+      #
+      # @return [Gamefic::Actor]
+      def make_player_character
+        cast player_class, name: 'yourself', synonyms: 'self myself you me', proper_named: true
+      end
+      alias get_player_character make_player_character
+    end
+  end
+end

data/lib/gamefic/world/scenes.rb

@@ -0,0 +1,226 @@
+module Gamefic
+  module World
+    module Scenes
+      # @return [Class<Gamefic::Scene::Activity>]
+      def default_scene
+        @default_scene ||= Scene::Activity
+      end
+
+      # @return [Class<Gamefic::Scene::Conclusion>]
+      def default_conclusion
+        @default_conclusion ||= Scene::Conclusion
+      end
+
+      # Add a block to be executed when a player is added to the game.
+      # Each Plot can only have one introduction. Subsequent calls will
+      # overwrite the existing one.
+      #
+      # @example Welcome the player to the game
+      #   introduction do |actor|
+      #     actor.tell "Welcome to the game!"
+      #   end
+      #
+      # @yieldparam [Gamefic::Actor]
+      def introduction(&proc)
+        @introduction = proc
+      end
+
+      # Introduce a player to the game.
+      # This method is typically called by the Engine that manages game execution.
+      #
+      # @param [Gamefic::Actor]
+      def introduce(player)
+        player.playbooks.push playbook unless player.playbooks.include?(playbook)
+        player.cue default_scene
+        players.push player
+        @introduction.call(player) unless @introduction.nil?
+        # @todo Find a better way to persist player characters
+        # Gamefic::Index.stick
+      end
+
+      # Create a multiple-choice scene.
+      # The user will be required to make a valid choice to continue.
+      #
+      # @example
+      #   @scene = multiple_choice 'Go to work', 'Go to school' do |actor, scene|
+      #     # Assuming user selected the first choice:
+      #     scene.selection #=> 'Go to work'
+      #     scene.index     #=> 0
+      #     scene.number    #=> 1
+      #   end
+      #
+      # @yieldparam [Gamefic::Actor]
+      # @yieldparam [Gamefic::Scene::MultipleChoice]
+      # @return [Class<Gamefic::Scene::MultipleChoice>]
+      def multiple_choice *choices, &block
+        s = Scene::MultipleChoice.subclass do |actor, scene|
+          scene.options.concat choices
+          scene.on_finish &block
+        end
+        scene_classes.push s
+        s
+      end
+
+      # Create a yes-or-no scene.
+      # The user will be required to answer Yes or No to continue.
+      #
+      # @example
+      #   @scene = yes_or_no 'What is your answer?' do |actor, scene|
+      #     if scene.yes?
+      #       actor.tell "You said yes."
+      #     else
+      #       actor.tell "You said no."
+      #     end
+      #   end
+      #
+      # @param prompt [String]
+      # @yieldparam [Gamefic::Actor]
+      # @yieldparam [Gamefic::Scene::YesOrNo]
+      # @return [Class<Gamefic::Scene::YesOrNo>]
+      def yes_or_no prompt = nil, &block
+        s = Scene::YesOrNo.subclass do |actor, scene|
+          scene.prompt = prompt
+          scene.on_finish &block
+        end
+        scene_classes.push s
+        s
+      end
+
+      # Create a scene with custom processing on user input.
+      #
+      # @example Echo the user's response
+      #   @scene = question 'What do you say?' do |actor, scene|
+      #     actor.tell "You said #{scene.input}"
+      #   end
+      #
+      # @param prompt [String]
+      # @yieldparam [Gamefic::Actor]
+      # @yieldparam [Gamefic::Scene::Custom]
+      # @return [Class<Gamefic::Scene::Custom>]
+      def question prompt = 'What is your answer?', &block
+        s = Scene::Custom.subclass do |actor, scene|
+          scene.prompt = prompt
+          scene.on_finish &block
+        end
+        scene_classes.push s
+        s
+      end
+
+      # Create a scene that pauses the game.
+      # This scene will execute the specified block and wait for input from the
+      # the user (e.g., pressing Enter) to continue.
+      #
+      # @example
+      #   @scene = pause 'Continue' do |actor|
+      #     actor.tell "After you continue, you will be prompted for a command."
+      #     actor.prepare default_scene
+      #   end
+      #
+      # @param prompt [String] The text to display when prompting the user to continue.
+      # @yieldparam [Gamefic::Actor]
+      # @return [Class<Gamefic::Scene::Pause>]
+      def pause prompt = nil, &block
+        s = Scene::Pause.subclass do |actor, scene|
+          scene.prompt = prompt unless prompt.nil?
+          block.call(actor, scene) unless block.nil?
+        end
+        scene_classes.push s
+        s
+      end
+
+      # Create a conclusion.
+      # The game (or the character's participation in it) will end after this
+      # scene is complete.
+      #
+      # @example
+      #   @scene = conclusion do |actor|
+      #     actor.tell 'Game over'
+      #   end
+      #
+      # @yieldparam [Gamefic::Actor]
+      # @return [Class<Gamefic::Scene::Conclusion>]
+      def conclusion &block
+        s = Scene::Conclusion.subclass &block
+        scene_classes.push s
+        s
+      end
+
+      # Create a custom scene.
+      #
+      # Custom scenes should always specify the next scene to be cued or
+      # prepared. If not, the scene will get repeated on the next turn.
+      #
+      # This method creates a Scene::Custom by default. You can customize other
+      # scene types by specifying the class to create.
+      #
+      # @example Ask the user for a name
+      #   @scene = custom do |scene|
+      #     data.prompt = "What's your name?"
+      #     scene.on_finish do |actor, data|
+      #       actor.name = data.input
+      #       actor.tell "Hello, #{actor.name}!"
+      #       actor.cue :active
+      #     end
+      #   end
+      #
+      # @param cls [Class] The class of scene to be instantiated.
+      # @yieldparam [Gamefic::Actor]
+      # @return [Class<Gamefic::Scene::Custom>]
+      def custom cls = Scene::Custom, &block
+        s = cls.subclass &block
+        scene_classes.push s
+        s
+      end
+
+      # Choose a new scene based on a list of options.
+      # This is a specialized type of multiple-choice scene that determines
+      # which scene to cue based on a Hash of choices and scene keys.
+      #
+      # @example Select a scene
+      #   scene_one = pause do |actor|
+      #     actor.tell "You went to scene one"
+      #   end
+      #
+      #   scene_two = pause do |actor|
+      #     actor.tell "You went to scene two"
+      #   end
+      #
+      #   select_one_or_two = multiple_scene "One" => scene_one, "Two" => scene_two
+      #
+      #   introduction do |actor|
+      #     actor.cue select_one_or_two # The actor will be prompted to select "one" or "two" and get sent to the corresponding scene
+      #   end
+      #
+      # @example Customize options
+      #   scene_one = pause # do...
+      #   scene_two = pause # do...
+      #
+      #   # Some event in the game sets actor[:can_go_to_scene_two] to true
+      #
+      #   select_one_or_two = multiple_scene do |actor, scene|
+      #     scene.map "Go to scene one", scene_one
+      #     scene.map "Go to scene two", scene_two if actor[:can_go_to_scene_two]
+      #   end
+      #
+      # @param map [Hash] A Hash of options and associated scenes.
+      # @yieldparam [Gamefic::Actor]
+      # @yieldparam [Gamefic::Scene::MultipleScene]
+      # @return [Class<Gamefic::Scene::MultipleScene>]
+      def multiple_scene map = {}, &block
+        s = Scene::MultipleScene.subclass do |actor, scene|
+          map.each_pair { |k, v|
+            scene.map k, v
+          }
+          block.call actor, scene unless block.nil?
+        end
+        scene_classes.push s
+        s
+      end
+
+      # @return [Array<Class<Gamefic::Scene::Base>>]
+      def scene_classes
+        @scene_classes ||= []
+      end
+    end
+  end
+end

metadata

@@ -1,55 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: gamefic
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 2.0.3
 platform: ruby
 authors:
 - Fred Snyder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-31 00:00:00.000000000 Z
+date: 2020-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: thor
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.19'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.19.4
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.19'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.19.4
-- !ruby/object:Gem::Dependency
-  name: rubyzip
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '12.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.0
-  type: :runtime
+        version: '12.3'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '12.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -71,102 +51,66 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 3.5.0
 - !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '11.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 11.3.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '11.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 11.3.0
-- !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '0.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '0.14'
 description: An adventure game and interactive fiction framework
 email: fsnyder@gamefic.com
-executables:
-- gamefic
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- bin/gamefic
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".solargraph.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- gamefic.gemspec
 - lib/gamefic.rb
 - lib/gamefic/action.rb
-- lib/gamefic/character.rb
-- lib/gamefic/character/state.rb
+- lib/gamefic/active.rb
+- lib/gamefic/actor.rb
 - lib/gamefic/command.rb
 - lib/gamefic/core_ext/array.rb
 - lib/gamefic/core_ext/string.rb
 - lib/gamefic/describable.rb
-- lib/gamefic/engine.rb
-- lib/gamefic/engine/base.rb
-- lib/gamefic/engine/tty.rb
+- lib/gamefic/element.rb
 - lib/gamefic/entity.rb
-- lib/gamefic/grammar.rb
-- lib/gamefic/grammar/conjugator.rb
-- lib/gamefic/grammar/gender.rb
-- lib/gamefic/grammar/person.rb
-- lib/gamefic/grammar/plural.rb
-- lib/gamefic/grammar/pronouns.rb
-- lib/gamefic/grammar/tense.rb
-- lib/gamefic/grammar/verb_set.rb
-- lib/gamefic/grammar/verbs.rb
-- lib/gamefic/grammar/word_adapter.rb
-- lib/gamefic/matchable.rb
+- lib/gamefic/keywords.rb
 - lib/gamefic/messaging.rb
 - lib/gamefic/node.rb
 - lib/gamefic/plot.rb
-- lib/gamefic/plot/articles.rb
-- lib/gamefic/plot/callbacks.rb
-- lib/gamefic/plot/commands.rb
-- lib/gamefic/plot/entities.rb
+- lib/gamefic/plot/darkroom.rb
 - lib/gamefic/plot/host.rb
-- lib/gamefic/plot/playbook.rb
-- lib/gamefic/plot/players.rb
-- lib/gamefic/plot/scenes.rb
 - lib/gamefic/plot/snapshot.rb
-- lib/gamefic/plot/theater.rb
-- lib/gamefic/plot/you_mount.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/text.rb
+- lib/gamefic/query/tree.rb
 - lib/gamefic/scene.rb
-- lib/gamefic/scene/active.rb
+- lib/gamefic/scene/activity.rb
 - lib/gamefic/scene/base.rb
 - lib/gamefic/scene/conclusion.rb
 - lib/gamefic/scene/custom.rb
@@ -174,29 +118,18 @@ files:
 - lib/gamefic/scene/multiple_scene.rb
 - lib/gamefic/scene/pause.rb
 - lib/gamefic/scene/yes_or_no.rb
-- lib/gamefic/script.rb
-- lib/gamefic/script/base.rb
-- lib/gamefic/script/file.rb
-- lib/gamefic/script/text.rb
-- lib/gamefic/shell.rb
-- lib/gamefic/source.rb
-- lib/gamefic/source/base.rb
-- lib/gamefic/source/file.rb
-- lib/gamefic/source/text.rb
+- lib/gamefic/scriptable.rb
+- lib/gamefic/serialize.rb
 - lib/gamefic/subplot.rb
 - lib/gamefic/syntax.rb
-- lib/gamefic/tester.rb
-- lib/gamefic/text.rb
-- lib/gamefic/text/ansi.rb
-- lib/gamefic/text/html.rb
-- lib/gamefic/text/html/conversions.rb
-- lib/gamefic/text/html/entities.rb
-- lib/gamefic/tty.rb
-- lib/gamefic/user.rb
-- lib/gamefic/user/base.rb
-- lib/gamefic/user/buffer.rb
-- lib/gamefic/user/tty.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
 licenses:
 - MIT
@@ -216,8 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Gamefic