gamefic-overlookable 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1d34800f5435fde01526243b4afab76c49afda7ab897d30d18f14863c86aa77f
+  data.tar.gz: 531614b78db5b10c3f4c8c4cfb535aa666e42f788a6eebcf90fc3ddb41272a84
+SHA512:
+  metadata.gz: 7fc86bae56c7b3db1b660abef4c3950771910014b55d231ee36a690cae72ece8f2aede83dd96b6f6a2839ca9ebbf77a3940b43bcb1e6cd4de20a93bdcbcbb5db
+  data.tar.gz: 38efa05328c17c4f868680b45133ee1465688d15c2a43ced27d348229634e88a3fd2944ef4051fde2318c183291267f0e80bca2f547fa11fe89d83527bfd8f86

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 1.0.0
+- First release

data/README.md

@@ -0,0 +1,94 @@
+# gamefic-overlookable
+
+A Gamefic library for easy implementation of insignificant entities.
+
+It's good practice to implement nouns that players receive in descriptions, even if they're irrelevant to the game.
+
+Bad:
+
+    > look around
+
+    You're in a room with four walls.
+
+    > examine walls
+
+    I recognize "examine" as a verb but don't know what you mean by "walls."
+
+Better:
+
+    > examine walls
+
+    There's nothing special about the four walls.
+
+The `gamefic-overlookable` library simplifies the process of creating `Scenery` entities that provide a default response to unimplemented nouns.
+
+## Installation
+
+Add the library to your Gamefic project's Gemfile:
+
+```
+gem 'gamefic-overlookable'
+```
+
+Run `bundle install`.
+
+Add the requirement to your project's code (typically in `main.rb`):
+
+```
+require 'gamefic-overlookable'
+```
+
+## Usage
+
+Entities gain an `overlook` method that lets you easily add scenery with a default description.
+
+```ruby
+MyGame.seed do
+    @room = make Room, name: 'room', description: "You're in a room with four walls."
+    @room.overlook 'four walls'
+end
+```
+
+    > look around
+
+    You're in a room with four walls.
+
+    > examine walls
+
+    There's nothing special about the four walls.
+
+The `overlook` method can also accept multiple names:
+
+```ruby
+MyGame.seed do
+    @room = make Room, name: 'room', description: 'A room with a tall ceiling and a wooden floor.'
+    @room.overlook 'tall ceiling', 'wooden floor'
+end
+```
+
+Separate names from synonyms with two slashes:
+
+```ruby
+MyGame.seed do
+    @room = make Room, name: 'room', description: 'A room with a tall ceiling and a dark wooden floor.'
+    @room.overlook 'ceiling//tall', 'floor//dark wooden'
+end
+```
+
+You can also add overlookable entities with the `rubble` and `scenery` parameters in `make`:
+
+```ruby
+make Room, name: 'room', description: 'A room with a tall ceiling.', scenery: ['ceiling//tall']
+
+make Thing, name: 'dining set', description: 'A plate and a fork.', rubble: ['plate', 'fork']
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/castwide/gamefic-overlookable.

data/Rakefile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require 'opal/rspec/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+Opal::RSpec::RakeTask.new(:opal) do |_, config|
+  Opal.append_path File.join(__dir__, 'lib')
+  Opal.use_gem 'gamefic'
+  Opal.use_gem 'gamefic-standard'
+  config.default_path = 'spec'
+  config.pattern = 'spec/**/*_spec.rb'
+  config.requires = ['opal_helper']
+end

data/gamefic-overlookable.gemspec

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative "lib/gamefic/overlookable/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "gamefic-overlookable"
+  spec.version = Gamefic::Overlookable::VERSION
+  spec.authors = ["Fred Snyder"]
+  spec.email = ["fsnyder@castwide.com"]
+
+  spec.summary = "A Gamefic library for easy implementation of insignificant entities."
+  # spec.description = "TODO: Write a longer description or delete this line."
+  spec.homepage = "https://gamefic.com"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  spec.metadata["homepage_uri"] = 'https://gamefic.com'
+  spec.metadata["source_code_uri"] = 'https://github.com/castwide/gamefic-overlookable'
+  spec.metadata["changelog_uri"] = 'https://github.com/castwide/gamefic-overlookable/blob/master/CHANGELOG.md'
+
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency 'gamefic', '~> 3.0'
+  spec.add_dependency 'gamefic-standard', '~> 3.0'
+
+  spec.add_development_dependency 'opal-rspec', '~> 1.0'
+  spec.add_development_dependency 'opal-sprockets', '~> 1.0'
+  spec.add_development_dependency 'simplecov', '~> 0.22'
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/gamefic/overlookable/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Gamefic
+  module Overlookable
+    VERSION = '1.0.0'
+  end
+end

data/lib/gamefic/overlookable.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require 'gamefic'
+require 'gamefic-standard'
+
+require_relative 'overlookable/version'
+
+module Gamefic
+  # A mixin for implementing nouns as Scenery with a default description.
+  #
+  module Overlookable
+    # Create Scenery that provides a default description for unimplemented words.
+    # Names can include two slashes (//) to add a list of synonyms.
+    #
+    # The type of overlookable entity can be modified with the `type` parameter.
+    # For compatibility with the gamefic-standard library, it is recommended to
+    # use either `Scenery` or `Rubble`.
+    #
+    # @example
+    #   thing = make Thing, name: 'table', description: 'A table with cups and white china plates.'
+    #   thing.overlook 'cups', 'plates//white china'
+    #
+    #   # > look table
+    #   #
+    #   # A table with cups and white china plates.
+    #   #
+    #   # > look cups
+    #   #
+    #   # There's nothing special about the cups.
+    #   #
+    #   # > look china
+    #   #
+    #   # There's nothing special about the plates.
+    #
+    # @param names [Array<String>] Names or name/synonym arrays
+    # @param type [Class<Entity>] The type of overlookable entity (default is Scenery)
+    # @return [Array<Entity>]
+    def overlook *names, type: Scenery
+      names.map do |input|
+        parts = input.split('//')
+        name = parts[0].to_s.strip
+        synonyms = parts[1].to_s.strip
+        type.new(name: name, synonyms: synonyms, parent: self)
+      end
+    end
+
+    # A shortcut to overlookable Scenery that can be called from `make` parameters.
+    #
+    # @example
+    #   make Thing, name: 'table',
+    #               description: 'A table with a checkered design.',
+    #               scenery: ['checkered design']
+    #
+    # @param [Array<String>]
+    # @return [void]
+    def scenery= names
+      overlook(*names, type: Scenery)
+    end
+
+    # A shortcut to overlookable Rubble that can be called from `make` parameters.
+    #
+    # @example
+    #   make Thing, name: 'table',
+    #               description: 'A table with a plate on it.',
+    #               rubble: ['plate']
+    #
+    # @param [Array<String>]
+    # @return [void]
+    def rubble= names
+      overlook(*names, type: Rubble)
+    end
+  end
+end
+
+Gamefic::Entity.include Gamefic::Overlookable

data/lib/gamefic-overlookable.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'gamefic/overlookable'

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: gamefic-overlookable
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Fred Snyder
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-08-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gamefic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: gamefic-standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !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: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+description:
+email:
+- fsnyder@castwide.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- README.md
+- Rakefile
+- gamefic-overlookable.gemspec
+- lib/gamefic-overlookable.rb
+- lib/gamefic/overlookable.rb
+- lib/gamefic/overlookable/version.rb
+homepage: https://gamefic.com
+licenses: []
+metadata:
+  homepage_uri: https://gamefic.com
+  source_code_uri: https://github.com/castwide/gamefic-overlookable
+  changelog_uri: https://github.com/castwide/gamefic-overlookable/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: A Gamefic library for easy implementation of insignificant entities.
+test_files: []