gamefic-grammar 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 10008329b01a95915decf94ff527edfc8517ff482c65ae88acda2dd742d7f87a
+  data.tar.gz: 3ba359d9beea9c2ae52f2ddfc82688e5867c784cff3d08eee7a8aee09303e47c
+SHA512:
+  metadata.gz: c294e15930f57094f6225b76bfaba7eda92eb277c4e4a0aebb82064a79b0b53ba0f620c82d91f0f17dcc6a0c7d272b8aa2e4dd566ed6a3d03a7f5843b41071a8
+  data.tar.gz: 51d6b790ff732baba0271624cace49fba93c4144798d39a6689fdf8c2ff9adb9b61549695e5c6f5e2399ef7525bde0d7e2d10e7a2e4a0ac8184bc9f9cdee738e

data/.rspec

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

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 1.0.0 - September 30, 2024
+- First release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Fred Snyder
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,50 @@
+# Gamefic::Grammar
+
+English grammar rules for Gamefic entities.
+
+## Installation
+
+**If your project uses gamefic-standard, gamefic-grammar is already included.**
+
+Add the library to your Gamefic project's Gemfile:
+
+```
+gem 'gamefic-grammar'
+```
+
+Run `bundle install`.
+
+Add the requirement to your project's code (typically in `main.rb`):
+
+```
+require 'gamefic-grammar'
+
+## Usage
+
+An entity's `gender` attribute can be `:male`, `:female`, `:neutral`, or `:other`. Default is `:neutral`.
+
+```ruby
+woman = Gamefic::Entity.new(name: 'woman', gender: :female)
+woman.subjective #=> "she"
+woman.objective  #=> "her"
+woman.possessive #=> "her"
+woman.reflexive  #=> "herself"
+```
+
+An entity's `plural?` attribute is boolean. Default is false.
+
+```ruby
+shoes = Gamefic::Entity.new(name: 'shoes', plural: true)
+shoes.plural? #=> true
+"The #{shoes.name} #{shoes.maybe_plural('is', 'are')} red." #=> "The shoes are red."
+```
+
+## 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-grammar.

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative 'lib/gamefic/grammar/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'gamefic-grammar'
+  spec.version = Gamefic::Grammar::VERSION
+  spec.authors = ['Fred Snyder']
+  spec.email = ['fsnyder@castwide.com']
+
+  spec.summary = 'English grammar rules for Gamefic 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'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/castwide/gamefic-grammar'
+  spec.metadata['changelog_uri'] = 'https://github.com/castwide/gamefic-grammar/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_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/grammar/attributes.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+module Gamefic
+  module Grammar
+    # A collection of attributes that enable grammar features for entities, such
+    # as selecting their correct pronouns.
+    #
+    module Attributes
+      # @see #gender
+      attr_writer :gender
+
+      # @see #plural?
+      attr_writer :plural
+
+      # The gender of the object. Supported values are :male, :female, :neutral,
+      # and :other. Use :neutral for objects that don't have a gender (i.e.,
+      # "it"). Use :other for people or characters that have an unspecified or
+      # non-binary gender (i.e., "they").
+      #
+      # @return [Symbol]
+      def gender
+        @gender ||= :neutral
+      end
+
+      # True if the object should be referred to in the plural, e.g., "they"
+      # instead of "it."
+      # @return [Boolean]
+      #
+      def plural?
+        @plural ||= false
+      end
+
+      # For now, the object's person is always assumed to be third
+      # (he/she/it/they). A future version of this library might support first
+      # (I/me) and second (you).
+      def person
+        3
+      end
+
+      # @param singular_text [String]
+      # @param plural_text [String]
+      # @return [String]
+      def maybe_plural(singular_text, plural_text = "#{singular_text}s")
+        plural? ? plural_text : singular_text
+      end
+
+      def objective
+        Pronoun.objective self
+      end
+      alias him objective
+      alias them objective
+
+      def objective_
+        Pronoun.objective_ self
+      end
+      alias him_ objective_
+      alias them_ objective_
+      alias Him objective_
+      alias Them objective_
+
+      def subjective
+        Pronoun.subjective self
+      end
+      alias he subjective
+      alias she subjective
+      alias they subjective
+
+      def subjective_
+        Pronoun.subjective_ self
+      end
+      alias he_ subjective_
+      alias she_ subjective_
+      alias they_ subjective_
+      alias He subjective_
+      alias She subjective_
+      alias They subjective_
+
+      def possessive
+        Pronoun.possessive self
+      end
+      alias his possessive
+      alias their possessive
+      alias its possessive
+
+      def possessive_
+        Pronoun.possessive_ self
+      end
+      alias his_ possessive_
+      alias their_ possessive_
+      alias its_ possessive_
+      alias His possessive_
+      alias Their possessive_
+      alias Its possessive_
+
+      def reflexive
+        Pronoun.reflexive self
+      end
+      alias himself reflexive
+      alias herself reflexive
+      alias itself reflexive
+      alias themselves reflexive
+      alias themself reflexive
+
+      def reflexive_
+        Pronoun.reflexive_ self
+      end
+      alias himself_ reflexive_
+      alias herself_ reflexive_
+      alias itself_ reflexive_
+      alias themselves_ reflexive_
+      alias themself_ reflexive_
+      alias Himself reflexive_
+      alias Herself reflexive_
+      alias Itself reflexive_
+      alias Themselves reflexive_
+      alias Themself reflexive_
+    end
+  end
+end

data/lib/gamefic/grammar/pronoun.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module Gamefic
+  module Grammar
+    # Methods to select pronouns based on an entity's attributes, such as
+    # gender.
+    #
+    module Pronoun
+      module_function
+
+      MAP_KEYS = %i[subjective objective possessive reflexive].freeze
+
+      MAPS = {
+        [1, :singular] => Hash[MAP_KEYS.zip(%w[I me my myself])],
+        [2, :singular] => Hash[MAP_KEYS.zip(%w[you you your yourself])],
+        [3, :singular] => Hash[MAP_KEYS.zip(%w[it it its itself])],
+        [3, :singular, :male] => Hash[MAP_KEYS.zip(%w[he him his himself])],
+        [3, :singular, :female] => Hash[MAP_KEYS.zip(%w[she her her herself])],
+        [3, :singular, :other] => Hash[MAP_KEYS.zip(%w[they them their themselves])],
+        [3, :singular, :neutral] => Hash[MAP_KEYS.zip(%w[it it its itself])],
+        [1, :plural] => Hash[MAP_KEYS.zip(%w[we us our ourselves])],
+        [2, :plural] => Hash[MAP_KEYS.zip(%w[you you your yourselves])],
+        [3, :plural] => Hash[MAP_KEYS.zip(%w[they them their themselves])]
+      }.freeze
+
+      # @param entity [#person, #plural?, #gender]
+      # @return [String]
+      def subjective(entity)
+        prounoun_map(entity)[:subjective]
+      end
+      alias they subjective
+      alias he subjective
+      alias she subjective
+
+      # @param entity [#person, #plural?, #gender]
+      # @return [String]
+      def subjective_(entity)
+        subjective(entity).cap_first
+      end
+      alias they_ subjective_
+      alias he_ subjective_
+      alias she_ subjective_
+
+      # @param entity [#person, #plural?, #gender]
+      # @return [String]
+      def objective(entity)
+        prounoun_map(entity)[:objective]
+      end
+      alias them objective
+
+      # @param entity [#person, #plural?, #gender]
+      # @return [String]
+      def objective_(entity)
+        objective(entity).cap_first
+      end
+      alias them_ objective_
+
+      # @param entity [#person, #plural?, #gender]
+      # @return [String]
+      def possessive(entity)
+        prounoun_map(entity)[:possessive]
+      end
+      alias their possessive
+
+      # @param entity [#person, #plural?, #gender]
+      # @return [String]
+      def possessive_(entity)
+        possessive(entity).cap_first
+      end
+      alias their_ possessive_
+
+      # @param entity [#person, #plural?, #gender]
+      # @return [String]
+      def reflexive(entity)
+        prounoun_map(entity)[:reflexive]
+      end
+      alias themselves reflexive
+      alias themself reflexive
+
+      # @param entity [#person, #plural?, #gender]
+      # @return [String]
+      def reflexive_(entity)
+        reflexive(entity).cap_first
+      end
+      alias themselves_ reflexive_
+      alias themself_ reflexive_
+
+      # @param entity [#person, #plural?, #gender]
+      # @return [Hash]
+      def prounoun_map(entity)
+        plurality = (entity.plural? ? :plural : :singular)
+        MAPS[[entity.person || 3, plurality, entity.gender]] ||
+          MAPS[[entity.person || 3, plurality]]
+      end
+    end
+  end
+end

data/lib/gamefic/grammar/version.rb

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

data/lib/gamefic/grammar.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'gamefic'
+
+module Gamefic
+  module Grammar
+    require 'gamefic/grammar/version'
+    require 'gamefic/grammar/attributes'
+    require 'gamefic/grammar/pronoun'
+  end
+end
+
+module Gamefic
+  class Entity
+    include Grammar::Attributes
+  end
+end

data/lib/gamefic-grammar.rb

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

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: gamefic-grammar
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Fred Snyder
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-09-30 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: 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"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- gamefic-grammar.gemspec
+- lib/gamefic-grammar.rb
+- lib/gamefic/grammar.rb
+- lib/gamefic/grammar/attributes.rb
+- lib/gamefic/grammar/pronoun.rb
+- lib/gamefic/grammar/version.rb
+homepage: https://gamefic.com
+licenses: []
+metadata:
+  homepage_uri: https://gamefic.com
+  source_code_uri: https://github.com/castwide/gamefic-grammar
+  changelog_uri: https://github.com/castwide/gamefic-grammar/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: English grammar rules for Gamefic entities.
+test_files: []