gamefic-commodities 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '08a734e8585509d12f97f384bcd5e7ff9081ee6500ea4f3eaaae6337bbaf0d98'
+  data.tar.gz: 7c83ac167edba79d950397f919faeffe7c12ef76c0f0e82e4b4fbe8cda3d288a
+SHA512:
+  metadata.gz: ff83060ddb98824b01c98a229697834e5d3448d4ceb8c22f8de11939439c48fae7cdda371c79dd5cc94f2347edc51dc98fca623d1f42ca7a14152e136756f440
+  data.tar.gz: ada7030b38061a939c7ee47b010f67dbd039645f8bf2464a9a71658568fd9144a7c4f9072806d3fc377398aaa28e07c36eb4c3a12e9f770cfbafd42024da69ec

data/.rspec

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

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 0.1.0 - October 5, 2024
+- First release

data/README.md

@@ -0,0 +1,73 @@
+# Gamefic::Commodities
+
+A groupable Gamefic entity.
+
+Commodities are grouped by default. When a commodity gets added to a parent
+that already contains a commodity with the same class and name, they get
+combined, i.e., the existing commodity's quantity is increased by the new
+commodity's quantity, and the other commodity is destroyed.
+
+Players can specify quantities in commands, e.g., `take 1 coin`.
+
+## Installation
+
+Add the library to your Gamefic project's Gemfile:
+
+```
+gem 'gamefic-commodities'
+```
+
+Run `bundle install`.
+
+Add the requirement to your project's code (typically in `main.rb`):
+
+```
+require 'gamefic-commodities'
+```
+
+## Usage
+
+The `Commodity` entity and related actions are automatically imported into `Gamefic::Standard`.
+
+Example of adding a commodity:
+
+```ruby
+class Example::Plot < Gamefic::Plot
+  include Gamefic::Standard
+
+  attr_seed :room, Room,
+            name: 'room'
+
+  make_seed Commodity,
+            name: 'coin',
+            quantity: 2,
+            parent: _attr(:room)
+
+  introduction do |actor|
+    actor.parent = room
+  end
+end
+```
+
+Example gameplay:
+
+    > look
+    You see 2 coins.
+    > take coin
+    You take 2 coins.
+    > drop 1 coin
+    You drop a coin.
+    > look
+    You see a coin.
+    > inventory
+    You're carrying a coin.
+
+## 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-commodity.

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-commodities.gemspec

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative 'lib/gamefic/commodities/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'gamefic-commodities'
+  spec.version = Gamefic::Commodities::VERSION
+  spec.authors = ['Fred Snyder']
+  spec.email = ['fsnyder@castwide.com']
+
+  spec.summary = 'A Commodity entity for Gamefic.'
+  # 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.7.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_dependency 'gamefic-standard', '~> 3.0'
+
+  spec.add_development_dependency 'opal', '~> 1.7'
+  spec.add_development_dependency 'opal-rspec', '~> 1.0'
+  spec.add_development_dependency 'opal-sprockets', '~> 1.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov', '~> 0.14'
+
+  # 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/commodities/actions.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module Gamefic
+  module Commodities
+    module Actions
+      extend Gamefic::Scriptable
+
+      respond :look, ::Commodity do |actor, thing|
+        actor.proceed
+        next unless thing.plural?
+
+        if thing.parent == actor
+          actor.tell "You have #{thing.quantity} of them."
+        else
+          actor.tell "There are #{thing.quantity} of them in #{the thing.parent}."
+        end
+      end
+
+      respond :take, siblings(::Commodity) do |actor, _|
+        actor.proceed
+      end
+
+      respond :place, siblings(::Commodity), available do |actor, _|
+        actor.proceed
+      end
+
+      respond :place, children(::Commodity), available do |actor, _|
+        actor.proceed
+      end
+
+      respond :insert, siblings(::Commodity), available do |actor, _|
+        actor.proceed
+      end
+
+      respond :insert, children(::Commodity), available do |actor, _|
+        actor.proceed
+      end
+
+      respond :take, available(::Commodity, ambiguous: true) do |actor, comms|
+        comms = comms.reject { |com| com.parent == actor }
+        if comms.one?
+          actor.execute :take, comms.first
+        else
+          filtered = comms.reject { |ent| actor.flatten.include?(ent) }
+          if filtered.one?
+            actor.execute :take, filtered.first
+          else
+            places = filtered.map { |object| object.parent.definitely }
+            actor.tell "Where do you want to take one from, #{places.join_or}?"
+            actor.ask_for_what "take #{filtered.first.name} from __what__"
+          end
+        end
+      end
+
+      respond :collect, available(::Commodity, ambiguous: true) do |actor, comms|
+        comms.reject { |com| com.parent == actor }
+             .each { |com| actor.perform "take #{com.plural_name} from #{com.parent}" }
+      end
+      interpret 'collect all', 'take all'
+      interpret 'collect :thing', 'take :thing'
+      interpret 'collect all :commodity', 'collect :commodity'
+      interpret 'collect all of :commodity', 'collect :commodity'
+      interpret 'collect every :commodity', 'collect :commodity'
+      interpret 'collect each :commodity', 'collect :commodity'
+      interpret 'take all :commodity', 'collect :commodity'
+      interpret 'take all of :commodity', 'collect :commodity'
+      interpret 'take every :commodity', 'collect :commodity'
+      interpret 'take each :commodity', 'collect :commodity'
+
+      meta nil, plaintext do |actor, text|
+        words = text.keywords
+        verb = words.shift
+        next actor.proceed if words.empty? || words.first =~ /[^\d]+/
+
+        number = words.shift.to_i
+        Utils.try_quantity(actor, number, "#{verb} #{words.join(' ')}")
+      end
+
+      on_update do
+        entities.that_are(::Commodity)
+                .reject(&:parent)
+                .each { |entity| destroy entity }
+      end
+    end
+  end
+end

data/lib/gamefic/commodities/commodity.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module Gamefic
+  module Commodities
+    # A groupable Gamefic entity.
+    #
+    # Commodities are grouped by default. When a commodity gets added to a parent
+    # that already contains a commodity with the same class and name, they get
+    # combined, i.e., the existing commodity's quantity is increased by the new
+    # commodity's quantity, and the other commodity is destroyed.
+    #
+    class Commodity < Item
+      class CommodityError < ArgumentError; end
+
+      # @return [Integer]
+      attr_writer :quantity
+
+      # @return [String]
+      attr_writer :plural_name
+
+      def quantity
+        @quantity ||= 1
+      end
+
+      def name
+        plural? ? plural_name : super
+      end
+
+      def indefinite_article
+        plural? ? quantity : super
+      end
+
+      def plural?
+        quantity > 1
+      end
+
+      # @return [String]
+      def plural_name
+        @plural_name ||= "#{@name}s"
+      end
+
+      # @param amount [Integer]
+      # @return [Commodity]
+      def except(amount)
+        validate_split(amount)
+        split(quantity - amount)
+      end
+
+      # @param amount [Integer]
+      # @return [Commodity]
+      def split(amount)
+        validate_split(amount)
+        return nil if amount.zero?
+
+        dup.tap do |other|
+          self.quantity -= amount
+          other.quantity = amount
+          other.parent = nil
+        end
+      end
+
+      def parent=(other)
+        extant = other&.children&.that_are&.find { |ent| same?(ent) }
+        if extant
+          extant.quantity += quantity
+          super(nil)
+        else
+          super
+        end
+      end
+
+      def same?(other)
+        other.class == self.class && other.plural_name == plural_name
+      end
+
+      def keywords
+        super + plural_name.keywords
+      end
+
+      def counted?
+        @counted ||= false
+      end
+
+      def count(number)
+        raise CommodityError, "You need to specify 1 or more #{plural_name}" if number.zero?
+        return unless block_given?
+
+        @counted = true
+        rest = except(number)
+        from = parent
+        yield
+        rest&.parent = from if rest&.quantity&.positive?
+        @counted = false
+      end
+
+      def validate_split(amount)
+        raise CommodityError, "There #{maybe_plural('is', 'are')} only #{quantity} #{name}." unless amount <= quantity
+
+        raise CommodityError, "You can't specify a negative number of #{plural_name}." unless amount >= 0
+      end
+    end
+  end
+end
+
+Commodity = Gamefic::Commodities::Commodity

data/lib/gamefic/commodities/utils.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Gamefic
+  module Commodities
+    module Utils
+      module_function
+
+      # @param actor [Gamefic::Actor]
+      # @param number [Integer]
+      # @param input [String]
+      def try_quantity(actor, number, input)
+        command = Gamefic::Command.compose(actor, input)
+        return actor.proceed unless command.arguments.first.is_a?(Commodity)
+
+        command.arguments.first.count(number) do
+          actor.execute command.verb, *command.arguments
+        end
+      rescue Commodity::CommodityError => e
+        actor.tell e.message
+      end
+    end
+  end
+end

data/lib/gamefic/commodities/version.rb

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

data/lib/gamefic/commodities.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'gamefic'
+require 'gamefic-standard'
+
+module Gamefic
+  module Commodities
+    require 'gamefic/commodities/version'
+    require 'gamefic/commodities/commodity'
+    require 'gamefic/commodities/utils'
+    require 'gamefic/commodities/actions'
+  end
+end
+
+Gamefic::Standard.include Gamefic::Commodities::Actions

data/lib/gamefic-commodities.rb

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

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: gamefic-commodities
+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: 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
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: 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.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+description:
+email:
+- fsnyder@castwide.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- README.md
+- Rakefile
+- gamefic-commodities.gemspec
+- lib/gamefic-commodities.rb
+- lib/gamefic/commodities.rb
+- lib/gamefic/commodities/actions.rb
+- lib/gamefic/commodities/commodity.rb
+- lib/gamefic/commodities/utils.rb
+- lib/gamefic/commodities/version.rb
+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.7.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 Commodity entity for Gamefic.
+test_files: []