adventure 0.17.7.pre.pre

data/lib/adventure/building.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Adventure
+  # Defines and creates general buildings, such as houses and stores.
+  class Building
+    attr_reader :id, :name, :location, :desc, :type, :owner, :quests, :wares
+
+    # Creates a new building, be it a house, a tavern, or a store.
+    #
+    # @param name [String] The name of the house, tavern or store.
+    # @param location [String] Where the building is located in the village.
+    # @param desc [String] A description of the appearence of the building.
+    # @param type [String] What kind of building this is (_e.g._ house).
+    # @param owner [Actor] An {Actor} instance to own the building.
+    # @param quests [Array] Either nil for no quest or an array of {Quest}s.
+    # @param wares [Array] Either nil for no wares or an array, each element of
+    #   it being a two-element Array, the first the name of the ware, the second
+    #   the price of the ware (the price must be a String with the currency).
+    def initialize(name, location, desc, type, owner, quests = nil, wares = nil)
+      @id = ('building-' + name).slugify
+      @name = name
+      @location = location
+      @desc = desc
+      @type = type
+
+      process_case
+      check_owner(owner)
+      check_quests(quests)
+      check_wares(wares)
+    end
+
+    # Returns the full description of the building, with owner information.
+    #
+    # @return [String] A full description of the building.
+    def description
+      "This is #{@type.indefinitize} on #{@location}.\n\n#{@name} is owned by "\
+      "#{@owner.name}, #{@owner.description}\n\n#{@desc.chomp('.')}."
+    end
+
+    private
+
+    def process_case
+      @name = @name.capitalize
+      @location = @location.downcase
+      @desc = @desc.downcase
+      @type = @type.downcase
+    end
+
+    def check_owner(owner)
+      raise ArgumentError, 'Owner must be an Actor' unless owner.is_a? Actor
+
+      @owner = owner
+    end
+
+    def check_quests(quests)
+      unless quests.nil?
+        msg = 'Quests must be an Array or nil'
+        raise ArgumentError, msg unless quests.is_a?(Array)
+
+        raise ArgumentError, 'Quests must be a non-empty Array' if quests.empty?
+
+        msg = 'Each element of the quests array must be a Quest instance'
+        quests.each do |quest|
+          raise ArgumentError, msg unless quest.is_a? Quest
+        end
+      end
+
+      @quests = quests
+    end
+
+    def check_wares(wares)
+      unless wares.nil?
+        raise ArgumentError, 'Wares must be an Array' unless wares.is_a? Array
+      end
+
+      @wares = wares
+    end
+  end
+end

data/lib/adventure/dungeon.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Adventure
+  # Defines and creates a dungeon, which is actually a category for Rooms.
+  class Dungeon
+    attr_reader :name, :first
+
+    # Creates a new instance of a Dungeon, which is a category for {Room}s and
+    # sets an entry point.
+    #
+    # @param name [String] The name of the dungeon.
+    def initialize(name)
+      @name = name.capitalize
+    end
+
+    # Sets the entry point {Room} to the dungeon.
+    #
+    # @param room [Room] The entry {Room}.
+    def first=(room)
+      raise TypeError, 'Must be a Room' unless room.is_a? Room
+
+      @first = room
+    end
+  end
+end

data/lib/adventure/encounter.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Adventure
+  # Defines a singleton encounter (one that happens and finishes in a single
+  # page).
+  class Encounter
+    attr_reader :name, :before, :enemies, :after, :exp, :gold, :items
+
+    # Creates a new Encounter.
+    #
+    # @param name [String] The name of the Encounter.
+    # @param enemies [Array] An Array of arrays, each of which must be comprised
+    #   of three elements: Creature name, quantity and commentaries. _E.g._:
+    #     [
+    #     ...
+    #       ['Goblin', 3, 'See MM pg.166'],
+    #     ...
+    #     ]
+    # @param reward [Array] An Array that must contain three elements: the XP
+    #   points, the gold coins and any items earned upon winning. Leave an empty
+    #   array or 0 if none.
+    # @param before [String] If anything can be done before the encounter (_e.g.
+    #   _ trying to stealth to gain a surprise round), describe it here.
+    # @param after [String] If anything can be done after the encounter (_e.g._
+    #   the goblins had a painting and you may try to identify it with a History
+    #   check), describe it here.
+    def initialize(name, enemies, reward, before = '', after = '')
+      @name = name.capitalize
+      @before = before
+      @after = after
+
+      check_enemies(enemies)
+      check_reward(reward)
+    end
+
+    private
+
+    def check_enemies(enemies)
+      msg = 'Enemies must be an Array of arrays'
+      raise ArgumentError, msg unless enemies.is_a? Array
+
+      msg = 'Each enemy must be an array of itself'
+      enemies.each do |enemy|
+        raise ArgumentError, msg unless enemy.is_a? Array
+      end
+
+      @enemies = enemies
+    end
+
+    def check_reward(reward)
+      msg = 'Reward must be an Array'
+      raise ArgumentError, msg unless reward.is_a? Array
+
+      msg = 'Reward must be an Array with three elements'
+      raise ArgumentError, msg unless reward.length == 3
+
+      @exp, @gold, @items = reward
+    end
+  end
+end

data/lib/adventure/quest.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Adventure
+  # Defines and creates NPCs.
+  class Quest
+    attr_reader :name, :description, :goal, :reward
+    attr_accessor :dungeon
+
+    # Creates a new instance of Quest.
+    #
+    # @param name [String] The name of the Quest.
+    # @param description [String] The description and history of the Quest.
+    # @param goal [String] The goal of the Quest.
+    # @param reward [String] The reward or rewards of completing the Quest.
+    # @param dungeon [Dungeon] The dungeon where the Quest takes place.
+    def initialize(name, description, goal, reward, dungeon)
+      @name = name.capitalize
+      @description = description
+      @goal = goal
+      @reward = reward
+
+      check_dungeon(dungeon)
+    end
+
+    # Returns the first {Room} of the {Dungeon} where the Quest takes place.
+    #
+    # @return [Room] The entry point of the {Dungeon} for this Quest.
+    def begin
+      @dungeon.first
+    end
+
+    private
+
+    def check_dungeon(dungeon)
+      msg = 'Dungeon must be a Dungeon'
+      raise ArgumentError, msg unless dungeon.is_a? Dungeon
+
+      msg = 'Dungeon must have a first Room'
+      raise ArgumentError, msg unless dungeon.first.is_a? Room
+
+      @dungeon = dungeon
+    end
+  end
+end

data/lib/adventure/room.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module Adventure
+  # Defines and creates rooms for dungeons and encounters.
+  class Room
+    attr_reader :id, :name, :lit, :description, :encounter
+    attr_reader :north, :south, :east, :west, :up, :down
+
+    # Creates a new room.
+    #
+    # @param name [String] The name of the Room.
+    # @param description [String] The description of the Room.
+    # @param encounter [Encounter or nil] A {Encounter} instance or nil if no
+    #   encounter happens on this Room.
+    # @param dungeon [Dungeon] The {Dungeon} to which this room belongs.
+    # @param lit [Boolean] If the room has a light source and is lit by it.
+    def initialize(name, description, encounter, dungeon, lit = true)
+      @id = ('room-' + name).slugify
+      @name = name.capitalize
+      @description = description
+      @lit = lit
+
+      check_encounter(encounter)
+      check_dungeon(dungeon)
+    end
+
+    def north=(room)
+      check_room(room)
+      @north = room
+    end
+
+    def south=(room)
+      check_room(room)
+      @south = room
+    end
+
+    def east=(room)
+      check_room(room)
+      @east = room
+    end
+
+    def west=(room)
+      check_room(room)
+      @west = room
+    end
+
+    def up=(room)
+      check_room(room)
+      @up = room
+    end
+
+    def down=(room)
+      check_room(room)
+      @down = room
+    end
+
+    private
+
+    def check_encounter(encount)
+      msg = 'Encounter must be an Encounter instance'
+      raise ArgumentError, msg unless encount.is_a?(Encounter) || encount.nil?
+
+      @encounter = encounter
+    end
+
+    def check_dungeon(dungeon)
+      msg = 'Dungeon must be a Dungeon instance'
+      raise ArgumentError, msg unless dungeon.is_a? Dungeon
+
+      @dungeon = dungeon
+    end
+
+    def check_room(room)
+      msg = 'Room must be a Room instance or nil'
+      raise ArgumentError, msg unless room.is_a?(Room) || room.nil?
+    end
+  end
+end

data/lib/adventure/settlement.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+module Adventure
+  # Defines and creates a settlement.
+  class Settlement
+    attr_reader :id, :name, :population, :type, :wealth, :gp_limit
+    attr_reader :demographics, :environment, :stores, :houses
+
+    # Creates a new settlement, with all its contents.
+    #
+    # @param name [String] The name of the Settlement.
+    # @param population [Integer] The number of people on the Settlement,
+    #   minimum of 20 (less than that and its a large home, not a settlement).
+    # @param demographics [Array] An array in which each element must be an
+    #   array with two elements, the first a String of the race, the second an
+    #   Integer of the rough percentage this race represents. _E.g._:
+    #     [
+    #       ['humans', 90],
+    #       ['halflings', 6],
+    #       ['misc', 4]
+    #     ]
+    # @param environment [String] The environment surrounding the Settlement.
+    # @param buildings [Hash] The list of {Building}s of the Settlement, which
+    #   must be a Hash with two elements, each with a specific key: _stores_ and
+    #   _houses_. Each of this keys must contain an Array of Buildings, or an
+    #   empty Array if there are no building of that category on the Settlement.
+    def initialize(name, population, demographics, environment, buildings)
+      check_params(population, demographics)
+      check_name(name)
+
+      @population = population.to_i
+      @type, @gp_limit = type_limit
+      @wealth = wealth_calc
+      @demographics = demographics
+      @environment = environment
+
+      check_buildings(buildings)
+    end
+
+    # Returns a description of the Settlement.
+    #
+    # @return [String] A description of the Settlement.
+    def short_description
+      "#{@name} is a #{@type.downcase} of #{@population} souls, most of which"\
+      " are #{predominant_race}. The #{@type.downcase} is in a "\
+      "#{@environment.downcase}, with #{@stores.length} stores and "\
+      "#{@houses.length} houses of note."
+    end
+
+    private
+
+    def type_limit
+      if @population < 2001
+        small_settlements
+      else
+        large_settlements
+      end
+    end
+
+    def small_settlements
+      case @population
+      when 20..80
+        ['Thorp', 40]
+      when 81..400
+        ['Hamlet', 100]
+      when 401..900
+        ['Village', 200]
+      when 901..2000
+        ['Small town', 800]
+      end
+    end
+
+    def large_settlements
+      case @population
+      when 2001..5000
+        ['Large town', 3000]
+      when 5001..12_000
+        ['Small city', 15_000]
+      when 12_001..25_000
+        ['Large city', 40_000]
+      else
+        ['Metropolis', 100_000]
+      end
+    end
+
+    def wealth_calc
+      ((@gp_limit / 2) * (@population / 10)).to_i
+    end
+
+    def predominant_race
+      percent = 0
+      main_race = ''
+      @demographics.each do |pop|
+        if pop[1] > percent
+          main_race = pop[0]
+          percent = pop[1]
+        end
+      end
+
+      main_race
+    end
+
+    def check_params(pop, demo)
+      raise ArgumentError, 'Two few people (min 20)' unless pop >= 20
+      raise ArgumentError, 'Demographics must be a Hash' unless demo.is_a? Array
+    end
+
+    def check_name(name)
+      @id = ('settlement-' + name).slugify
+      @name = name
+    end
+
+    def check_buildings(buildings)
+      msg = 'Building must be a Hash with two keys, and arrays under them'
+      raise ArgumentError, msg unless buildings.is_a? Hash
+
+      check_building_category('stores', buildings)
+      check_building_category('houses', buildings)
+
+      @stores = buildings['stores']
+      @houses = buildings['houses']
+    end
+
+    def check_building_category(cat, buildings)
+      msg = "Building must contain a list of houses under the '#{cat}' key."
+      raise ArgumentError, msg unless buildings.key?(cat)
+
+      msg = "Building must contain arrays under the '#{cat}' key."
+      raise ArgumentError, msg unless buildings[cat].is_a? Array
+
+      msg = 'Each element of the arrays must be an instance of Building'
+      buildings[cat].each do |lot|
+        raise ArgumentError, msg unless lot.is_a? Building
+      end
+    end
+  end
+end

data/lib/adventure/version.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# 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
+  # Sets the current version of the gem
+  @version = '0.17.7-pre'
+
+  # Returns the Gem's current version.
+  #
+  # @return [String] The Gem's current version.
+  def self.version
+    @version
+  end
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: adventure
+version: !ruby/object:Gem::Version
+  version: 0.17.7.pre.pre
+platform: ruby
+authors:
+- Igor Padoim
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-09-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+- !ruby/object:Gem::Dependency
+  name: indefinite_article
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+- !ruby/object:Gem::Dependency
+  name: jekyll_slugify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+- !ruby/object:Gem::Dependency
+  name: random_name_generator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+description: 
+email:
+- igorpadoim@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitattributes"
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/ISSUE_TEMPLATE/user_question.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
+- ".github/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE-OF-CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- OGL.md
+- README.md
+- Rakefile
+- adventure.gemspec
+- bin/console
+- bin/setup
+- lib/adventure.rb
+- lib/adventure/actor.rb
+- lib/adventure/building.rb
+- lib/adventure/dungeon.rb
+- lib/adventure/encounter.rb
+- lib/adventure/quest.rb
+- lib/adventure/room.rb
+- lib/adventure/settlement.rb
+- lib/adventure/version.rb
+homepage: https://github.com/Nereare/Adventure
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Nereare/Adventure
+  source_code_uri: https://github.com/Nereare/Adventure
+  changelog_uri: https://github.com/Nereare/Adventure/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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: A random adventure generator for D&D 5e.
+test_files: []