gamefic-ideas 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a6a85bbe24df7b150d4370b087501deae84ece6a592db730b50e54e5a984a355
+  data.tar.gz: 287ff150610eaa46772a775c2cbf554104e3dfa5fac1a1f2e63afe63c1cd1881
+SHA512:
+  metadata.gz: 4e91cba001a74e75afffef28dda793e063c5c1438621650223a10eeeb596cf106a682a83b319c76ee1ddc74fd19b7ad050fcb8318024969384ebf2809533d121
+  data.tar.gz: ee61073fbb4d969c8222d2f63c9dfeda61a56bed1efe382d36522ad4195f9f7c81411a51373c1fb265b4f8a1f19145a283772daf9fe90562e53dc541a2913498

data/.rspec

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

data/README.md

@@ -0,0 +1,82 @@
+# Gamefic::Ideas
+
+A Gamefic extension for queryable abstract ideas.
+
+An `Idea` is a pseudo-entity that can be queried by the command parser but does not have a physical presence in the game world.
+It has `name`, `synonyms`, and `description` attributes, but it does not have a `parent` or `children`.
+
+## Installation
+
+Add the library to your Gamefic project's Gemfile:
+
+```
+gem 'gamefic-ideas'
+```
+
+Run `bundle install`.
+
+Add the requirement to your project's code (typically in `main.rb`):
+
+```
+require 'gamefic-ideas'
+```
+
+If you want to include the library's actions, include `Gamefic::Ideas` in your project's Plot:
+
+```ruby
+module Example
+  class Plot < Gamefic::Plot
+    include Gamefic::Ideas
+  end
+end
+```
+
+## Usage
+
+The process to `make` new ideas is similar to making standard entities:
+
+```ruby
+module Example
+  class Plot < Gamefic::Plot
+    include Gamefic::Ideas # Default commands for ideas like `think`
+
+    attr_seed :food_idea, Idea,
+              name: 'food',
+              synonyms: 'eating meals',
+              description: "A meal would hit the spot right now."
+  end
+end
+```
+
+If you included `Gamefic::Ideas`, players can access the idea's description with the `think` command:
+
+    > think about food
+
+    A meal would hit the spot right now.
+
+You can also implement your own commands by accessing the idea with the `anywhere` query:
+
+```ruby
+module Example
+  class Plot < Gamefic::Plot
+    attr_seed :food_idea, Idea,
+              name: 'food',
+              synonyms: 'eating meals',
+              description: "A meal would hit the spot right now."
+
+    respond :contemplate, anywhere(Idea) do |actor, idea|
+      actor.tell idea.description
+    end
+  end
+end
+```
+
+## 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/[USERNAME]/gamefic-ideas.

data/Rakefile

@@ -0,0 +1,17 @@
+# 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'
+  config.default_path = 'spec'
+  config.pattern = 'spec/**/*_spec.rb'
+  config.requires = ['opal_helper']
+end

data/gamefic-ideas.gemspec

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative 'lib/gamefic/ideas/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'gamefic-ideas'
+  spec.version = Gamefic::Ideas::VERSION
+  spec.authors = ['Fred Snyder']
+  spec.email = ['fsnyder@castwide.com']
+
+  spec.summary = 'A Gamefic extension for queryable abstract ideas.'
+  # spec.description = 'TODO: Write a longer description or delete this line.'
+  # spec.homepage = "TODO: Put your gem's website or public repo URL here."
+  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'] = spec.homepage
+  # spec.metadata['source_code_uri'] = "TODO: Put your gem's public repo URL here."
+  # 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(__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.5'
+
+  spec.add_development_dependency 'opal-rspec', '~> 1.0'
+  spec.add_development_dependency 'opal-sprockets', '~> 1.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.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/ideas/idea.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Gamefic
+  module Ideas
+    # A pseudo-entity for queryable abstract ideas.
+    #
+    # An Idea can have a name, description, and synonyms, but it does not have
+    # a parent or children.
+    #
+    class Idea
+      include Gamefic::Describable
+
+      def initialize **args
+        args.each_pair { |k, v| send "#{k}=", v }
+      end
+
+      def parent
+        nil
+      end
+
+      def children
+        []
+      end
+
+      def flatten
+        []
+      end
+
+      def parent=
+        raise RuntimeError, 'Ideas cannot have parents'
+      end
+    end
+  end
+end
+
+Idea = Gamefic::Ideas::Idea

data/lib/gamefic/ideas/version.rb

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

data/lib/gamefic/ideas.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'gamefic'
+require 'gamefic/ideas/version'
+require 'gamefic/ideas/idea'
+
+module Gamefic
+  # A Gamefic extension for queryable abstract ideas.
+  #
+  module Ideas
+    extend Gamefic::Scriptable
+
+    respond :think, anywhere(Idea) do |actor, idea|
+      actor.tell idea.description
+    end
+    interpret 'consider :idea', 'think :idea'
+    interpret 'ponder :idea', 'think :idea'
+    interpret 'remember :idea', 'think :idea'
+    interpret 'think about :idea', 'think :idea'
+    interpret 'think of :idea', 'think :idea'
+    interpret 'think on :idea', 'think :idea'
+    interpret 'wonder :idea', 'think :idea'
+    interpret 'wonder about :idea', 'think :idea'
+  end
+end

data/lib/gamefic-ideas.rb

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

data/sig/gamefic/ideas.rbs

@@ -0,0 +1,6 @@
+module Gamefic
+  module Ideas
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: gamefic-ideas
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Fred Snyder
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-10-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gamefic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.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"
+- README.md
+- Rakefile
+- gamefic-ideas.gemspec
+- lib/gamefic-ideas.rb
+- lib/gamefic/ideas.rb
+- lib/gamefic/ideas/idea.rb
+- lib/gamefic/ideas/version.rb
+- sig/gamefic/ideas.rbs
+homepage:
+licenses: []
+metadata: {}
+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 extension for queryable abstract ideas.
+test_files: []