adventure 0.17.7.pre.pre

data/CODE-OF-CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when
+an individual is representing the project or its community in public spaces.
+Examples of representing a project or community include using an official
+project e-mail address, posting via an official social media account, or acting
+as an appointed representative at an online or offline event. Representation of
+a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [igorpadoim@gmail.com](mailto:igorpadoim@gmail.com). All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

data/CONTRIBUTING.md

@@ -0,0 +1,22 @@
+# Contributing Guidelines
+
+When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
+
+Please note we have a [code of conduct](CODE-OF-CONDUCT.md), please follow it in all your interactions with the project.
+
+## Pull Request Checklist
+
+Before sending your pull requests, make sure you followed this list.
+
+1. Read [contributing guidelines](CONTRIBUTING.md).
+2. Read [Code of Conduct](CODE-OF-CONDUCT.md).
+3. Increase the version numbers in any examples files, the [ruby gem version](lib/adventure/version.rb) file, and the [ReadMe file badge](README.md) to the new version that this Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
+4. You may merge the Pull Request in once you have the approval of the project owner.
+
+## Reporting a Bug & Requesting Features
+
+For both actions, this project uses GitHub templates, please use the adequate template when either reporting a bug or requesting a new feature.
+
+## Licensing and copyright
+
+Please note that accepted contributions are included in the repository and hence added under the same [license](LICENSE.md) as the repository to which it was contributed.

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'rubocop', '~> 0.74.0', require: false
+gem 'simplecov', '~> 0.17.0', require: false
+gem 'yard', '~> 0.9.20', require: false
+
+# Specify your gem's dependencies in Adventure.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,84 @@
+PATH
+  remote: .
+  specs:
+    adventure (0.17.7-pre)
+      indefinite_article (~> 0.2.4)
+      jekyll_slugify (~> 0.4.2)
+      random_name_generator (~> 1.0.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.1, >= 2.1.8)
+    ast (2.4.0)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    indefinite_article (0.2.4)
+      activesupport
+    jaro_winkler (1.5.3)
+    jekyll_slugify (0.4.2)
+      i18n (~> 1.6.0)
+    json (2.2.0)
+    minitest (5.11.3)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    random_name_generator (1.0.3)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    rubocop (0.74.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    simplecov (0.17.0)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.6.0)
+    yard (0.9.20)
+    zeitwerk (2.1.10)
+
+PLATFORMS
+  ruby
+  x64-mingw32
+
+DEPENDENCIES
+  adventure!
+  bundler (~> 2.0)
+  rake (~> 12.3)
+  rspec (~> 3.8.0)
+  rubocop (~> 0.74.0)
+  simplecov (~> 0.17.0)
+  yard (~> 0.9.20)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.md

@@ -0,0 +1,25 @@
+The MIT License (MIT)
+=====================
+
+Copyright © `2019` `Igor Padoim`
+
+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/OGL.md

@@ -0,0 +1,35 @@
+THIS LICENSE IS APPROVED FOR GENERAL USE. PERMISSION TO DISTRIBUTE THIS LICENSE IS MADE BY WIZARDS OF THE COAST!
+
+# OPEN GAME LICENSE Version 1.0a
+
+### The following text is the property of Wizards of the Coast, Inc. and is Copyright 2000 Wizards of the Coast, Inc ("Wizards"). All Rights Reserved.
+
+1. **Definitions**: (a)"Contributors" means the copyright and/or trademark owners who have contributed Open Game Content; (b)"Derivative Material" means copyrighted material including derivative works and translations (including into other computer languages), potation, modification, correction, addition, extension, upgrade, improvement, compilation, abridgment or other form in which an existing work may be recast, transformed or adapted; (c) "Distribute" means to reproduce, license, rent, lease, sell, broadcast, publicly display, transmit or otherwise distribute; (d)"Open Game Content" means the game mechanic and includes the methods, procedures, processes and routines to the extent such content does not embody the Product Identity and is an enhancement over the prior art and any additional content clearly identified as Open Game Content by the Contributor, and means any work covered by this License, including translations and derivative works under copyright law, but specifically excludes Product Identity. (e) "Product Identity" means product and product line names, logos and identifying marks including trade dress; artifacts; creatures characters; stories, storylines, plots, thematic elements, dialogue, incidents, language, artwork, symbols, designs, depictions, likenesses, formats, poses, concepts, themes and graphic, photographic and other visual or audio representations; names and descriptions of characters, spells, enchantments, personalities, teams, personas, likenesses and special abilities; places, locations, environments, creatures, equipment, magical or supernatural abilities or effects, logos, symbols, or graphic designs; and any other trademark or registered trademark clearly identified as Product identity by the owner of the Product Identity, and which specifically excludes the Open Game Content; (f) "Trademark" means the logos, names, mark, sign, motto, designs that are used by a Contributor to identify itself or its products or the associated products contributed to the Open Game License by the Contributor (g) "Use", "Used" or "Using" means to use, Distribute, copy, edit, format, modify, translate and otherwise create Derivative Material of Open Game Content. (h) "You" or "Your" means the licensee in terms of this agreement.
+
+2. **The License**: This License applies to any Open Game Content that contains a notice indicating that the Open Game Content may only be Used under and in terms of this License. You must affix such a notice to any Open Game Content that you Use. No terms may be added to or subtracted from this License except as described by the License itself. No other terms or conditions may be applied to any Open Game Content distributed using this License.
+
+3. **Offer and Acceptance**: By Using the Open Game Content You indicate Your acceptance of the terms of this License.
+
+4. **Grant and Consideration**: In consideration for agreeing to use this License, the Contributors grant You a perpetual, worldwide, royalty-free, non-exclusive license with the exact terms of this License to Use, the Open Game Content.
+
+5. **Representation of Authority to Contribute**: If You are contributing original material as Open Game Content, You represent that Your Contributions are Your original creation and/or You have sufficient rights to grant the rights conveyed by this License.
+
+6. **Notice of License Copyright**: You must update the COPYRIGHT NOTICE portion of this License to include the exact text of the COPYRIGHT NOTICE of any Open Game Content You are copying, modifying or distributing, and You must add the title, the copyright date, and the copyright holder's name to the COPYRIGHT NOTICE of any original Open Game Content you Distribute.
+
+7. **Use of Product Identity**: You agree not to Use any Product Identity, including as an indication as to compatibility, except as expressly licensed in another, independent Agreement with the owner of each element of that Product Identity. You agree not to indicate compatibility or co-adaptability with any Trademark or Registered Trademark in conjunction with a work containing Open Game Content except as expressly licensed in another, independent Agreement with the owner of such Trademark or Registered Trademark. The use of any Product Identity in Open Game Content does not constitute a challenge to the ownership of that Product Identity. The owner of any Product Identity used in Open Game Content shall retain all rights, title and interest in and to that Product Identity.
+
+8. **Identification**: If you distribute Open Game Content You must clearly indicate which portions of the work that you are distributing are Open Game Content.
+
+9. **Updating the License**: Wizards or its designated Agents may publish updated versions of this License. You may use any authorized version of this License to copy, modify and distribute any Open Game Content originally distributed under any version of this License.
+
+10. **Copy of this License**: You MUST include a copy of this License with every copy of the Open Game Content You Distribute.
+
+11. **Use of Contributor Credits**: You may not market or advertise the Open Game Content using the name of any Contributor unless You have written permission from the Contributor to do so.
+
+12. **Inability to Comply**: If it is impossible for You to comply with any of the terms of this License with respect to some or all of the Open Game Content due to statute, judicial order, or governmental regulation then You may not Use any Open Game Material so affected.
+
+13. **Termination**: This License will terminate automatically if You fail to comply with all terms herein and fail to cure such breach within 30 days of becoming aware of the breach. All sublicenses shall survive the termination of this License.
+
+14. **Reformation**: If any provision of this License is held to be unenforceable, such provision shall be reformed only to the extent necessary to make it enforceable.
+
+15. **COPYRIGHT NOTICE**: Open Game License v 1.0 Copyright 2000, Wizards of the Coast, Inc.

data/README.md

@@ -0,0 +1,63 @@
+# Adventure
+
+[![Gem](https://img.shields.io/gem/v/Adventure)](https://github.com/Nereare/Adventure)
+[![Version](https://img.shields.io/badge/version-0.17.7--pre-yellowgreen)](https://github.com/Nereare/Adventure/releases)
+[![GitHub License](https://img.shields.io/github/license/Nereare/Adventure)](LICENSE.md)
+[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v1.4%20adopted-ff69b4.svg)](CODE-OF-CONDUCT.md)
+
+[![Build Status](https://travis-ci.org/Nereare/Adventure.svg?branch=master)](https://travis-ci.org/Nereare/Adventure)
+[![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability/Nereare/Adventure)](https://codeclimate.com/github/Nereare/Adventure)
+[![Code Climate coverage](https://img.shields.io/codeclimate/coverage/Nereare/Adventure)](https://codeclimate.com/github/Nereare/Adventure)
+[![Libraries.io dependency status for GitHub repo](https://img.shields.io/librariesio/github/Nereare/Adventure)](https://libraries.io/github/Nereare/Adventure)
+
+A random adventure generator for D&D 5e.
+
+## Running
+
+1. Get [the code](https://github.com/Nereare/Adventure/archive/master.zip);
+2. Have these installed:
+    1. [Ruby](https://www.ruby-lang.org);
+    2. [Gem](https://rubygems.org/).
+3. Install [Bundler](https://bundler.io/) with `gem install bundler`;
+4. Install the dependencies with `bundle install`;
+5. Running not yet done, sorry... :cry:
+
+### Testing
+
+```shell
+rubocop -a
+bundle exec rspec spec
+yardoc
+```
+
+These commands run the syntax checks (via [RuboCop](https://github.com/rubocop-hq/rubocop)), the [RSpec](https://rspec.info/) checks and outputs the documentation (via [YARD](https://yardoc.org/)).
+
+## Contributing
+
+1. Fork it!
+2. Create your feature branch: `git checkout -b my-new-feature`
+3. Commit your changes: `git commit -am 'Add some feature'`
+4. Push to the branch: `git push origin my-new-feature`
+5. Submit a pull request :tada:
+
+Please, also read our [Contributing Guidelines](CONTRIBUTING.md).
+
+### Code of Conduct
+
+Please note that this project is released with a [Contributor Code of Conduct](CODE-OF-CONDUCT.md). By participating in this project you agree to abide by its terms.
+
+## History & Versioning
+
+See the [Change Log](CHANGELOG.md) for further history.
+
+This project uses [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/Nereare/Adventure/tags).
+
+## Legal Stuff
+
+[![MIT License](https://i.imgur.com/Ze3dFob.png)](LICENSE.md)
+
+This project is available under the [MIT License](https://opensource.org/licenses/MIT)
+
+[![d20 Logo](https://i.imgur.com/8CG0VEv.png)](OGL.md)
+
+`d20 System` and the `d20 System` logo are trademarks of Wizards of the Coast, Inc. and are used according to the terms of the d20 System License. A copy of this License can be found at [www.wizards.com](https://dnd.wizards.com/articles/features/systems-reference-document-srd).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/adventure.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'adventure/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'adventure'
+  spec.version       = Adventure.version
+  spec.authors       = ['Igor Padoim']
+  spec.email         = ['igorpadoim@gmail.com']
+  spec.license       = 'MIT'
+
+  spec.summary       = 'A random adventure generator for D&D 5e.'
+  spec.homepage      = 'https://github.com/Nereare/Adventure'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = 'https://github.com/Nereare/Adventure/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(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 12.3'
+  spec.add_development_dependency 'rspec', '~> 3.8.0'
+
+  spec.add_dependency 'indefinite_article', '~> 0.2.4'
+  spec.add_dependency 'jekyll_slugify', '~> 0.4.2'
+  spec.add_dependency 'random_name_generator', '~> 1.0.3'
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'Adventure'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/adventure.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'indefinite_article'
+require 'jekyll_slugify'
+
+require 'adventure/version'
+
+require 'adventure/actor'
+require 'adventure/building'
+require 'adventure/dungeon'
+require 'adventure/encounter'
+require 'adventure/quest'
+require 'adventure/room'
+require 'adventure/settlement'
+
+# This is the main module of this Gem. It defines each component of an
+# Adventure. The export of such adventure is located elsewhere.
+module Adventure; end

data/lib/adventure/actor.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module Adventure
+  # Defines and creates NPCs.
+  class Actor
+    attr_reader :name, :gender, :race, :align, :hair, :eyes, :skin, :personality
+    attr_reader :equipment, :reference
+
+    # Creates a new Actor (NPC) instance.
+    #
+    # @param name [String] The name of the NPC.
+    # @param gender [String] One of 'female', 'male' or others.
+    # @param race [String] The race of the NPC.
+    # @param align [String] The alignment of the character (both moral and
+    #   ethical)
+    # @param desc [Array] An array of strings, in the order: hair color, eye
+    #   color, skin color and personality.
+    # @param equipment [Array] An array of strings, each element being one worn
+    #   item.
+    # @param ref [String or false] Either a reference to the SRD, WotC books or
+    #   other source with further information.
+    def initialize(name, gender, race, align, desc, equipment, ref = false)
+      @name = name
+      @gender = gender
+      @race = race
+      @align = align
+
+      @reference = ref
+
+      check_desc(desc)
+      process_case
+      process_equipment(equipment)
+    end
+
+    # Constructs the description of the NPC in human-readable format.
+    #
+    # @param upcase [Boolean] If the description must begin capitalized.
+    # @return [String] The description of the NPC.
+    def description(upcase = false)
+      "#{pronoum(upcase)} is #{@align.indefinitize} #{@gender} #{@race}, whose"\
+      " hair is #{@hair}, with #{@eyes} eyes and #{@skin} skin. "\
+      "#{pronoum(true)} uses #{inventory}. #{@name} is "\
+      "#{@personality.chomp '.'}."
+    end
+
+    # Returns the inventory of the NPC in human-readable format.
+    #
+    # @return [String] The inventory of the NPC.
+    def inventory
+      case @equip.length
+      when 0
+        'nothing'
+      when 1
+        @equip[0].to_s
+      when 2
+        @equip.join ' and '
+      else
+        [@equip[0, @equip.length - 1].join(', '), @equip[-1]].join ', and '
+      end
+    end
+
+    private
+
+    def pronoum(capitalize = false)
+      r = case @gender
+          when 'male'
+            'he'
+          when 'female'
+            'she'
+          else
+            'they'
+          end
+      r = r.capitalize if capitalize
+
+      r
+    end
+
+    def process_case
+      @name = @name.capitalize
+      @gender = @gender.downcase
+      @race = @race.downcase
+      @align = @align.downcase
+
+      @hair = @hair.downcase
+      @eyes = @eyes.downcase
+      @skin = @skin.downcase
+      @personality = @personality.downcase
+    end
+
+    def process_equipment(equipment)
+      msg = 'Equipment must be an array'
+      raise ArgumentError, msg unless equipment.is_a? Array
+
+      @equip = equipment
+      @equip.compact!
+      @equip.each_with_index do |item, i|
+        @equip[i] = item.downcase.indefinitize
+      end
+    end
+
+    def check_desc(desc)
+      msg = 'Desc must be an Array'
+      raise ArgumentError, msg unless desc.is_a? Array
+
+      msg = 'Desc must have exactly four elements'
+      raise ArgumentError, msg unless desc.length == 4
+
+      @hair, @eyes, @skin, @personality = desc
+    end
+  end
+end