gamefic 2.0.3 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ac7da649347939f4c5baadc676151b8a8c73714552c48a290de75bd072bb801
-  data.tar.gz: 6d83150ed62df24a4056e3e54ff5b499bc5f7a69ebe8d5cfaddb261f64573af4
+  metadata.gz: ad70329086d7b1e9dd06a8459c5b1ee95952ab5453f63afd4e7a87df6ba90e69
+  data.tar.gz: 443a8642312dd1da33612a78ce1598723a9336b46e55b840636c2f41804eb8c5
 SHA512:
-  metadata.gz: e068317caa9fbfb1f8a73bde4725f5df3f3bcad95ba87d44c8f973759cdc991e0fbbcea874fd451eacbd6ffd2ea2ade9144e61f2d358f31fec6a7f1e97ca3a10
-  data.tar.gz: 1ab813a5cb14307bc844c42424c9503bae6f73a48d12979a5369812619e5a2e80dfab2ac6181401045511286743fc20f35968bd46e5071cf24f296e3c1c20e36
+  metadata.gz: 6c207722b0d00906579e9a221d0f8fad831a8f35694ac2252569d427d2846e113beda49c3e160083013284e6f5c85354f9959b49fceb4383100c451de61dc882
+  data.tar.gz: 899b4605d74e236a6904d80a6218c6c607c78594357124bb2b36ea12557bee1c485e76bde2eb8ed1f29359f7d6a6f32ca1d7c2294b0d56f9d1109ad195f7c890

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 2.1.0 - June 21, 2021
+- Remove redundant MultipleChoice prompt
+- Deprecate Scene::Custom
+
 # 2.0.3 - December 14, 2020
 - Remove unused Index class
 - Active#conclude accepts data argument

data/lib/gamefic/scene/base.rb

@@ -1,6 +1,8 @@
 module Gamefic
-  # The Base Scene is not intended for instantiation. Other Scene classes
-  # should inherit from it.
+  # An abstract class for building different types of scenes. It can be
+  # extended either through concrete subclasses or by creating anonymous
+  # subclasses through a scene helper method like
+  # `Gamefic::World::Scenes#custom`.
   #
   class Scene::Base
     include Gamefic::Serialize

data/lib/gamefic/scene/conclusion.rb

@@ -1,7 +1,7 @@
 module Gamefic
   # A Conclusion ends the Plot (or the character's participation in it).
   #
-  class Scene::Conclusion < Scene::Custom
+  class Scene::Conclusion < Scene::Base
     def type
       @type ||= 'Conclusion'
     end

data/lib/gamefic/scene/multiple_choice.rb

@@ -6,7 +6,7 @@ module Gamefic
   # The finish block's input parameter receives a MultipleChoice::Input object
   # instead of a String.
   #
-  class Scene::MultipleChoice < Scene::Custom
+  class Scene::MultipleChoice < Scene::Base
     # The zero-based index of the selected option.
     #
     # @return [Integer]
@@ -33,7 +33,6 @@ module Gamefic
       get_choice
       if selection.nil?
         actor.tell invalid_message
-        tell_options
       else
         super
       end
@@ -77,14 +76,5 @@ module Gamefic
         }
       end
     end
-
-    def tell_options
-      list = '<ol class="multiple_choice">'
-      options.each { |o|
-        list += "<li><a href=\"#\" rel=\"gamefic\" data-command=\"#{o}\">#{o}</a></li>"
-      }
-      list += "</ol>"
-      actor.tell list
-    end
   end
 end

data/lib/gamefic/scene/pause.rb

@@ -1,7 +1,7 @@
 module Gamefic
   # Pause for user input.
   #
-  class Scene::Pause < Scene::Custom
+  class Scene::Pause < Scene::Base
     def post_initialize
       self.type = 'Pause'
       self.prompt = 'Press enter to continue...'

data/lib/gamefic/scene/yes_or_no.rb

@@ -4,7 +4,7 @@ module Gamefic
   # block. After the scene is finished, the :active scene will be cued if no
   # other scene has been prepared or cued.
   #
-  class Scene::YesOrNo < Scene::Custom
+  class Scene::YesOrNo < Scene::Base
     attr_writer :invalid_message
 
     def post_initialize

data/lib/gamefic/version.rb

@@ -1,3 +1,3 @@
 module Gamefic
-  VERSION = '2.0.3'
+  VERSION = '2.1.0'
 end

data/lib/gamefic/world/scenes.rb

@@ -95,10 +95,10 @@ module Gamefic
       #
       # @param prompt [String]
       # @yieldparam [Gamefic::Actor]
-      # @yieldparam [Gamefic::Scene::Custom]
-      # @return [Class<Gamefic::Scene::Custom>]
+      # @yieldparam [Gamefic::Scene::Base]
+      # @return [Class<Gamefic::Scene::Base>]
       def question prompt = 'What is your answer?', &block
-        s = Scene::Custom.subclass do |actor, scene|
+        s = Scene::Base.subclass do |actor, scene|
           scene.prompt = prompt
           scene.on_finish &block
         end
@@ -150,23 +150,23 @@ module Gamefic
       # 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
+      # This method creates a Scene::Base 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
+      #   @scene = custom do |actor, scene|
+      #     scene.prompt = "What's your name?"
+      #     scene.on_finish do
+      #       actor.name = scene.input
       #       actor.tell "Hello, #{actor.name}!"
-      #       actor.cue :active
+      #       actor.cue default_scene
       #     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
+      # @return [Class<Gamefic::Scene::Base>]
+      def custom cls = Scene::Base, &block
         s = cls.subclass &block
         scene_classes.push s
         s

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gamefic
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.1.0
 platform: ruby
 authors:
 - Fred Snyder
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-14 00:00:00.000000000 Z
+date: 2021-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -113,7 +113,6 @@ files:
 - lib/gamefic/scene/activity.rb
 - lib/gamefic/scene/base.rb
 - lib/gamefic/scene/conclusion.rb
-- lib/gamefic/scene/custom.rb
 - lib/gamefic/scene/multiple_choice.rb
 - lib/gamefic/scene/multiple_scene.rb
 - lib/gamefic/scene/pause.rb
@@ -134,7 +133,7 @@ homepage: http://gamefic.com
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -149,8 +148,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Gamefic
 test_files: []

data/lib/gamefic/scene/custom.rb

@@ -1,7 +0,0 @@
-module Gamefic
-  # A Custom Scene allows for complete configuration of its behavior upon
-  # instantiation. It is suitable for direct instantiation or subclassing.
-  #
-  class Scene::Custom < Scene::Base
-  end
-end