dungeon_master_tools 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: abeadea328ca3cdea58323ac4c87a8a0af0cdf534c3c6eb5c54ab85d4f136356
+  data.tar.gz: 122cf3e4d9505b8f48d953024fd508b19c72f0a61c90c00c164ea0e540e73235
+SHA512:
+  metadata.gz: 9139ca7852d657839f326cc555a99f32a4e48634e143b2630018d452f73e22525910180cee8079a737f35d6c445841b6f59f63ccf3e117e10e6b8cf593aef9b7
+  data.tar.gz: ff399482430f240cfaf0129229ba7ea4e6e58d8711e6dd12a46071526a5742ec2676e889dfbd50317a848eb7000b7bf15aff7ef09855a4a40c4239b010462346

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in dmcli.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "rubocop", "~> 1.7"

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    dmcli (0.1.1)
+      nokogiri (~> 1.11.4)
+      thor (~> 1.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.4.4)
+    minitest (5.14.4)
+    nokogiri (1.11.4-x86_64-darwin)
+      racc (~> 1.4)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
+    racc (1.5.2)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.15.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.5.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.5.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    thor (1.1.0)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  dmcli!
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  rspec (~> 3.2)
+  rubocop (~> 1.7)
+
+BUNDLED WITH
+   2.2.16

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Shane Rainville
+
+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,65 @@
+# Dmcli
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/dmcli`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dmcli'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install dmcli
+
+## Usage
+
+### Spells
+
+List all spells
+
+```ruby
+dmcli spells [-f PATH]
+```
+
+List spells for specific class
+
+```ruby
+dmcli spells -c [cleric|druid|magic-user] [-f PATH]
+```
+
+List spells for a specific level
+
+```ruby
+dmcli spells -l LEVEL [-f PATH]
+```
+
+List spells for a specific class and specific level
+
+```ruby
+dmcli spells -c [cleric|druid|magic-user] -l LEVEL [-f PATH]
+```
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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]/dmcli.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "dmcli"
+
+# 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/dmcli

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "dmcli"
+
+Dmcli::CLI.start

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/dmcli.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative "lib/dmcli/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "dungeon_master_tools"
+  spec.version       = Dmcli::VERSION
+  spec.authors       = ["Shane Rainville"]
+  spec.email         = ["shane.rainville@gmail.com"]
+
+  spec.summary       = "Dungeon Master utility"
+  spec.description   = "Command-line tool for Dungeons and Dragons data files"
+  spec.homepage      = "https://www.shanerainville.com"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.0.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/serainville/dmcli"
+  spec.metadata["changelog_uri"] = "https://github.com/serainville/dmcli"
+
+  # 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 { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir = "bin"
+  spec.executables << "dmcli"
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
+
+  spec.add_dependency "nokogiri", "~> 1.11.4"
+  spec.add_dependency "thor", "~> 1.1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/dmcli.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative "dmcli/cli"
+require_relative "dmcli/version"
+require_relative "dmcli/dnd_data_loader"
+require_relative "dmcli/spell"
+require_relative "dmcli/spell_list"
+require_relative "dmcli/xml_exporter"
+
+module Dmcli
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/dmcli/cli.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "thor"
+
+module Dmcli
+  # CLI
+  # Command-line options and commands are set in the CLI class
+  class CLI < Thor
+    class_options %i[filepath f] => :string
+
+    package_name "dmcli"
+    desc "spells", "List spells"
+    method_options %i[caster c] => :string, %i[level l] => :number, %i[edition e] => :string
+
+    def spells
+      caster = options.caster? ? options.caster : "any"
+      level = options.level? ? options.level : "any"
+      @filepath = options.filepath? ? options.filepath : "."
+
+      loader = DndDataLoader.new
+      puts loader.load_spells(@filepath, "BECMI", caster, level)
+    end
+
+    desc "monsters", "List monsters"
+    method_options :edition => :string, :level => :number
+
+    def monsters
+      puts "Not implemented"
+    end
+
+    desc "package", "Package xml"
+    method_options %i[output o] => :string
+
+    def package
+      xml = XmlExporter.new
+      output = options.output? ? options.output : "output.xml"
+      filepath = options.filepath? ? options.filepath : "."
+
+      xml.builder(filepath, output)
+    end
+
+    desc "version", "dmcli version"
+    def version
+      puts "dmcli version #{VERSION}"
+    end
+  end
+end

data/lib/dmcli/dnd_data_loader.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require "nokogiri"
+
+module Dmcli
+  # DndDataLoader
+  # Utility class for parsing and writing XML data files
+  class DndDataLoader
+    @spells_directory = "../../spells/*.xml"
+    @docs = []
+
+    def load(directory)
+      # directory = "../../spells/*.xml"
+      puts "Loading spells..."
+
+      @docs = []
+      files = 0
+
+      starting = Process.clock_gettime(Process::CLOCK_MONOTONIC, :millisecond)
+      Dir["#{directory}/*"].each do |file|
+        if File.extname(file).strip.downcase[1..-1] == "xml"
+          doc = Nokogiri::XML(File.open(file)) do |config|
+            config.options = Nokogiri::XML::ParseOptions::STRICT | Nokogiri::XML::ParseOptions::NOBLANKS
+          end
+          @docs.push(doc)
+          files += 1
+        end
+      end
+      ending = Process.clock_gettime(Process::CLOCK_MONOTONIC, :millisecond)
+      elapsed = ending - starting
+
+      puts "Found #{@docs.size} spells"
+      puts "Processed #{files} files in #{format("%0.0f", elapsed)} ms"
+      puts
+    end
+
+    def load_spells(
+      filepath,
+      edition = "any",
+      spell_class = "any",
+      level = "any"
+    )
+
+      puts "Loading data files from #{filepath}"
+      load(filepath)
+
+      @spell_list = SpellList.new
+      @spells = []
+
+      @docs.each do |doc|
+        name = doc.xpath("//a:spell/a:name", { "a" => "dungeon" }).text
+        doc_spell_class = doc.xpath("//a:spell/a:editions/a:edition#{edition}/a:class", { "a" => "dungeon" }).text.strip
+        doc_spell_level = doc.xpath("//a:spell/a:editions/a:edition#{edition}/a:level", { "a" => "dungeon" }).text.strip
+        range = doc.xpath("//a:spell/a:editions/a:edition#{edition}/a:range", { "a" => "dungeon" }).text.strip
+        duration = doc.xpath("//a:spell/a:editions/a:edition#{edition}/a:duration", { "a" => "dungeon" }).text.strip
+        effect = doc.xpath("//a:spell/a:editions/a:edition#{edition}/a:effect", { "a" => "dungeon" }).text.strip
+        reversible = doc.xpath("//a:spell/a:editions/a:edition#{edition}/a:isReversible", { "a" => "dungeon" }).text.strip
+        description_text = doc.xpath("//a:spell/a:editions/a:edition#{edition}/a:description", { "a" => "dungeon" }).text.strip.split("\n")
+
+        name += " *" if reversible == "true"
+
+        if add_spell?(spell_class, doc_spell_class, level, doc_spell_level)
+          @spell_list.add Spell.new(name, reversible, doc_spell_class, doc_spell_level, range, duration, effect, description_text)
+        end
+      end
+
+      @spell_list.sort
+
+      @spell_list.spells
+    end
+
+    def add_spell?(
+      spell_class,
+      doc_spell_class,
+      level,
+      doc_spell_level
+    )
+
+      case spell_class
+      when "any"
+        return true
+      else
+        if spell_class == doc_spell_class
+          case level
+          when "any"
+            return true
+          else
+            if level.to_i == doc_spell_level.to_i
+              return true
+            end
+          end
+        end
+      end
+      false
+    end
+  end
+end

data/lib/dmcli/spell.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Dmcli
+  # Spell
+  # Defines a spell object for storing Dungeons and Dragons spells
+  class Spell
+    attr_reader :name, :is_reversible, :spell_level, :spell_class, :range, :duration, :effect, :description_text
+
+    def initialize(
+      name,
+      is_reversible,
+      spell_class,
+      spell_level,
+      range,
+      duration,
+      effect,
+      description_text
+    )
+      @name = name
+      @is_reversible = is_reversible
+      @spell_class = spell_class
+      @spell_level = spell_level
+      @range = range
+      @duration = duration
+      @effect = effect
+      @description_text = description_text
+    end
+
+    def to_s
+      "#{@name.ljust(35)} #{@spell_class.ljust(13).capitalize} #{@spell_level.ljust(4)} #{@range.ljust(30)} #{@duration.ljust(45)} #{@effect}"
+    end
+  end
+end

data/lib/dmcli/spell_list.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Dmcli
+  # SpellList
+  # Stores a list of Spell objects
+  class SpellList
+    attr_reader :spells
+
+    def initialize
+      @spells = []
+    end
+
+    def add(spell)
+      @spells.push(spell)
+    end
+
+    def sort
+      @spells.sort_by! { |spell| [spell.spell_level, spell.spell_class, spell.name] }
+    end
+
+    def list
+      puts "#{"Name".ljust(35)} #{"Class".ljust(13)} #{"Lvl".ljust(4)} #{"Range".ljust(30)} #{"Duration".ljust(45)} Effect"
+      puts "----------------------------------------------------------------------------------------------------------------------------------------------------------"
+      @spells.each do |spell|
+        puts spell.to_s
+      end
+    end
+  end
+end

data/lib/dmcli/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Dmcli
+  VERSION = "0.1.1"
+end

data/lib/dmcli/xml_exporter.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "nokogiri"
+
+module Dmcli
+  # XmlExporter
+  # Utility class for exporting data to a XML file. Used to compile a large number of individual XML
+  # files into one large XML file.
+  class XmlExporter
+    def builder(
+      target,
+      output
+    )
+
+      loader = DndDataLoader.new
+      spells = loader.load_spells(target, "BECMI", "any", "any")
+
+      xml_contents = Nokogiri::XML::Builder.new do |xml|
+        xml.spellList("xmlns" => "dungeon", "xmlns:xsi" => "http://www.w3.org/2001/XMLSchema-instance", "xsi:schemaLocation" => "dungeon spells.xsd") do
+          spells.each do |s|
+            xml.spell do
+              xml.name s.name
+              xml.editions do
+                xml.editionBECMI do
+                  xml.is_reversible s.is_reversible
+                  xml.class_ s.spell_class
+                  xml.level s.spell_level
+                  xml.range s.range
+                  xml.duration s.range
+                  xml.effect s.effect
+                  xml.description s.description_text
+                  xml.sources do
+                    xml.source "Dungeons and Dragons Rules Cyclopedia, p42"
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+
+      puts "Exporting to #{output}"
+      File.open(output, "w") do |f|
+        f.write(xml_contents.to_xml)
+      end
+
+      filesize = File.size(output) / 1024
+      puts "#{filesize} kb written"
+    end
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: dungeon_master_tools
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Shane Rainville
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-05-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.4
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+description: Command-line tool for Dungeons and Dragons data files
+email:
+- shane.rainville@gmail.com
+executables:
+- dmcli
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/dmcli
+- bin/setup
+- dmcli.gemspec
+- lib/dmcli.rb
+- lib/dmcli/cli.rb
+- lib/dmcli/dnd_data_loader.rb
+- lib/dmcli/spell.rb
+- lib/dmcli/spell_list.rb
+- lib/dmcli/version.rb
+- lib/dmcli/xml_exporter.rb
+homepage: https://www.shanerainville.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://www.shanerainville.com
+  source_code_uri: https://github.com/serainville/dmcli
+  changelog_uri: https://github.com/serainville/dmcli
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.17
+signing_key:
+specification_version: 4
+summary: Dungeon Master utility
+test_files: []