dmtool 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a1aead2702873fef5a13a94eac855e3849ace58d
+  data.tar.gz: 0785e86c6a66e28b275da398ee145aeddadb0402
+SHA512:
+  metadata.gz: ace519fffa7a679beade46b9f1cc56ca1fb556242a979910979e14d84d4074085f070124925eda32cfb4d152c857c7ddbcd06400074789a850e2bc7e9be24058
+  data.tar.gz: b62c3d97177edcbf75b5fbe1ec2cab06283cd451ca3ab11e33581bacd94e282922e580dacb42e4a3e6e1d6ff384871e1c26458b2e30db5fd082ffb652643fcb5

data/.codeclimate.yml

@@ -0,0 +1,6 @@
+engines:
+  rubocop:
+    enabled: true
+ratings:
+   paths:
+   - "**.rb"

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+*.secret

data/.pryrc

@@ -0,0 +1,6 @@
+if defined?(PryDebugger)
+  Pry.commands.alias_command 'c', 'continue'
+  Pry.commands.alias_command 's', 'step'
+  Pry.commands.alias_command 'n', 'next'
+  Pry.commands.alias_command 'f', 'finish'
+end

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.2
+script: bundle exec rspec

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'codeclimate-test-reporter'
+  gem 'simplecov'
+end

data/README.md

@@ -0,0 +1,32 @@
+# DMTool
+[![Build Status](https://travis-ci.org/ffleming/dmtool.svg?branch=master)](https://travis-ci.org/ffleming/dogsay)
+[![Code Climate](https://codeclimate.com/github/ffleming/dmtool/badges/gpa.svg)](https://codeclimate.com/github/ffleming/dogsay)
+[![Test Coverage](https://codeclimate.com/github/ffleming/dmtool/badges/coverage.svg)](https://codeclimate.com/github/ffleming/dogsay)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dmtool'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dmtool
+
+## Usage
+
+Use the classes as you see fit, or use the command-line tools.
+
+## Contributing
+
+1. Fork it ( https://github.com/ffleming/dmtool/fork )
+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. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/dmtool

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+require 'dmtool'
+
+trap 'SIGINT' do
+  exit
+end
+
+def parse_opts!
+  options = {}
+  opt_parser = OptionParser.new do |opts|
+    opts.program_name = "dmtool"
+    opts.banner = "#{opts.program_name} [options]"
+    opts.on('-v', '--version', 'Print version information') do
+      puts "#{opts.program_name} #{DMTool::VERSION}"
+      exit true
+    end
+    opts.on('-h', '--help', 'Display this screen') do
+      puts opts
+      exit true
+    end
+  end
+  begin
+    opt_parser.parse!
+  rescue OptionParser::InvalidOption => e
+    puts e.message
+    exit false
+  end
+end
+
+parse_opts!
+DMTool::CLI.start

data/bin/roll

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+require 'dmtool'
+require 'optparse'
+
+def opts_from_cli
+  options = {}
+  opt_parser = OptionParser.new do |opts|
+    opts.program_name = File.basename(__FILE__)
+    opts.banner = "#{opts.program_name} [options]"
+    opts.on('-r', '--raw', 'Display raw results (ignores +/- modifiers)') { options[:raw] = true }
+    opts.on('-v', '--version', 'Print version information') do
+      puts "#{File.basename(__FILE__)} #{DMTool::VERSION}"
+      exit true
+    end
+    opts.on('-h', '--help', 'Display this screen') do
+      puts opts
+      exit true
+    end
+  end
+  begin
+    opt_parser.parse!
+  rescue OptionParser::InvalidOption => e
+    puts e.message
+    exit false
+  end
+  options
+end
+
+def results_from(options)
+  parser = DMTool::Parser.new
+  input = ARGV.join(' ')
+  command = options[:raw] ? 'raw' : 'roll'
+  parser.parse("#{command} #{input}")
+end
+
+puts results_from(opts_from_cli)

data/dmtool.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dmtool/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'dmtool'
+  spec.version       = DMTool::VERSION
+  spec.authors       = ['Forrest Fleming']
+  spec.email         = ['ffleming@gmail.com']
+
+  spec.summary       = %q{Suite of tools for RPGs}
+  spec.description   = %q{Suite of tools for RPGs.  An excuse to create a fun little parser.}
+  spec.homepage      = 'http://github.com/ffleming/dmtool'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'activesupport', '~> 3'
+  spec.add_development_dependency 'bundler', '~> 1', '>= 1.6.5'
+  spec.add_development_dependency 'rspec', '~> 3'
+  spec.add_development_dependency 'pry', '~> 0.10'
+  spec.add_development_dependency 'byebug', '~> 4'
+  spec.add_development_dependency 'pry-byebug', '~> 3.1'
+end

data/lib/core_extensions/string/prep.rb

@@ -0,0 +1,9 @@
+module CoreExtensions
+  module String
+    module Prep
+      def prep
+        self.strip.squeeze(', ')
+      end
+    end
+  end
+end

data/lib/dmtool.rb

@@ -0,0 +1,20 @@
+require 'pry'
+require 'byebug'
+require 'pry-byebug'
+require 'active_support'
+require 'active_support/core_ext'
+require 'optparse'
+
+require 'core_extensions/string/prep'
+require 'dmtool/version'
+require 'dmtool/result'
+require 'dmtool/errors'
+require 'dmtool/die'
+require 'dmtool/parser'
+require 'dmtool/parser/die_directive'
+require 'dmtool/parser/dice_string'
+require 'dmtool/roller'
+require 'dmtool/cli'
+String.include CoreExtensions::String::Prep
+module DMTool
+end

data/lib/dmtool/cli.rb

@@ -0,0 +1,41 @@
+module DMTool::CLI
+  class << self
+    def start
+      @parser = DMTool::Parser.new
+      ui_loop
+      true
+    end
+
+    private
+
+    def input
+      @input ||= $stdin
+    end
+
+    def output
+      @output ||= $stdout
+    end
+
+    def ui_loop
+      prompt do
+        while str = input.gets.chomp rescue ''
+          break if str.blank?
+          begin
+            output.puts @parser.parse(str)
+          rescue SystemExit => e
+            output.puts 'Goodbye'
+            break
+          rescue => e
+            output.puts "#{e.class} #{e.message}"
+          end
+          prompt
+        end
+      end
+    end
+
+    def prompt
+      output.print 'dmtool > '
+      yield if block_given?
+    end
+  end
+end

data/lib/dmtool/die.rb

@@ -0,0 +1,30 @@
+class DMTool::Die
+  attr_reader :sides, :explodes, :history
+
+  def initialize(sides: 6, explodes: false)
+    raise ArgumentError.new("Invalid sides: #{sides}") unless sides.is_a?(Fixnum) && sides > 1
+    @sides = sides
+    @explodes = explodes
+    @history = []
+  end
+
+  def value
+    @history.last
+  end
+
+  def roll
+    result = rand_roll
+    result += rand_roll while explodes? && result % sides == 0
+    history.push result
+    result
+  end
+
+  alias explodes? explodes
+  alias roll! roll
+
+  private
+
+  def rand_roll
+    rand(1..sides)
+  end
+end

data/lib/dmtool/errors.rb

@@ -0,0 +1,6 @@
+class ParserError < StandardError
+end
+class DiceStringError < ParserError
+end
+class DirectiveError < ParserError
+end

data/lib/dmtool/parser.rb

@@ -0,0 +1,73 @@
+class DMTool::Parser
+  attr_reader :history
+  def initialize
+    @history = []
+  end
+
+  def parse!(input)
+    history.push input
+    command, remainder = input.split(/ /, 2).map(&:prep)
+    dice_string, directives_string = remainder.to_s.split(',', 2).map(&:prep)
+
+    if respond_to?("cmd_#{command}", true)
+      ret = send("cmd_#{command}", dice_string, directives_string)
+      ret = "[#{ret.join ', '}]" if ret.is_a? Array
+      return "#{ret}"
+    end
+    raise ParserError.new "Command #{command} not found"
+  end
+
+  alias parse parse!
+
+  private
+
+  def cmd_roll(dice_string, directives_string=nil)
+    dice = DMTool::Parser::DiceString.new(dice_string)
+    directives = directives_from(directives_string, dice)
+    result = DMTool::Roller.sum(dice.dice, directives)
+    dice.modifier.call(result)
+  end
+
+  def cmd_raw(dice_string, directives_string=nil)
+    dice = DMTool::Parser::DiceString.new(dice_string)
+    directives = directives_from(directives_string, dice)
+    DMTool::Roller.roll(dice.dice, directives).map(&:value)
+  end
+
+  def cmd_help(*args)
+    <<-EOS
+    dmtool v#{DMTool::VERSION} help
+    dmtool> <command> <dice>, <directives>
+
+    <commands>
+      roll: sums output
+      raw:  displays individual die values (ignores +/- modifiers)
+
+    <dice>
+      e.g. 3d6 for three six-sided dice
+      3d6+2 to add 2 to the result of rollng 3d6
+      3df for 3 Fudge dice
+
+    <directives>
+
+    Examples:
+      roll 2d6
+      roll d20+5
+      roll d10-2
+      roll 3d6, reroll 1-2
+    EOS
+  end
+
+  def cmd_exit(*args)
+    exit
+  end
+
+  def directives_from(directives_string, dice)
+    directives_string = '' if directives_string.nil?
+    directives = directives_string.split ','
+    directives.map! { |str| DMTool::Parser::DieDirective.new(str) }
+    directives += dice.directives
+    directives.select! {|d| d.text != 'roll' } if directives.length > 1
+    directives
+  end
+end

data/lib/dmtool/parser/dice_string.rb

@@ -0,0 +1,69 @@
+class DMTool::Parser::DiceString
+  attr_reader :string, :type, :number, :sides, :modifier
+  def initialize(string)
+    @string = string
+    validate_format!
+    parse_string
+  end
+
+  def dice
+    (1..number).map { DMTool::Die.new(sides: sides)}
+  end
+
+  def directives
+    [DIRECTIVES[type]].compact
+  end
+
+  private
+
+  SYMBOLS = {
+    d:  :standard,
+    df: :fudge,
+    f:  :fudge,
+    e:  :exploding
+  }
+
+  DIRECTIVES = {
+    fudge: DMTool::Parser::DieDirective.new('fudge'),
+    standard: DMTool::Parser::DieDirective.new('roll'),
+    exploding: DMTool::Parser::DieDirective.new('explode')
+  }
+
+  def parse_string
+    num_str, type_str, sides_str, mod_string = regex.match(string).captures
+    @number   = number_from num_str
+    @type     = type_from type_str
+    @sides    = sides_from sides_str
+    @modifier = modifier_from mod_string
+  end
+
+  def number_from(string)
+    return 1 if string.blank?
+    string.to_i
+  end
+
+  def sides_from(string)
+    return 6 if type == :fudge
+    string.to_i
+  end
+
+  def type_from(string)
+    SYMBOLS.fetch(string.downcase.to_sym)
+  end
+
+  def modifier_from(string)
+    return Proc.new { |arg| arg } if string.blank?
+    method = string[0].to_sym
+    mod    = string[1..-1].to_i
+    Proc.new { |arg| arg.send(method, mod) }
+  end
+
+  def validate_format!
+    raise DiceStringError.new("#{@string} doesn't match /#{regex}/") unless @string =~ regex
+  end
+
+  def regex
+    @regex ||= /^(\d*)(d|e|f|df)(\d*)\s*([-+]\s*\d+)?$/i
+  end
+
+end

data/lib/dmtool/parser/die_directive.rb

@@ -0,0 +1,65 @@
+class DMTool::Parser::DieDirective
+  attr_reader :text
+
+  def initialize(text='roll')
+    @text = text
+    build_proc_from text
+  end
+
+  def process(die)
+    @proc.call(die, proc_opts)
+  end
+
+  private
+
+  attr_reader :proc, :proc_opts
+
+  def build_proc_from(text)
+    keyword, remainder = text.split(/ /)
+    raise DirectiveError.new("Invalid directive: #{text}") if keyword.blank?
+    method = METHODS.fetch(keyword.to_sym, nil)
+    raise DirectiveError.new("Invalid directive: #{text}") if method.nil?
+    @proc = method
+    @proc_opts = remainder
+  end
+
+  def self.reroll
+    Proc.new do |die, on|
+      min, max = on.split('-').map(&:to_i)
+      max = min if max.nil?
+      die.roll
+      die.roll while (min..max).include? die.value
+      die.value
+    end
+  end
+
+  def self.roll
+    Proc.new do |die|
+      die.history.push die.roll
+    end
+  end
+
+  def self.explode
+    Proc.new do |die|
+      result = die.roll
+      result += die.roll while result % die.sides == 0
+      die.history.push result
+    end
+  end
+
+  def self.fudge
+    Proc.new do |die|
+      index = die.roll % 3
+       res = [DMTool::Result::Success, DMTool::Result::NilResult, DMTool::Result::Failure][index]
+       die.history.push res
+    end
+  end
+
+  METHODS = {
+    reroll:  DMTool::Parser::DieDirective.reroll,
+    roll:    DMTool::Parser::DieDirective.roll,
+    explode: DMTool::Parser::DieDirective.explode,
+    fudge:   DMTool::Parser::DieDirective.fudge
+  }
+
+end

data/lib/dmtool/result.rb

@@ -0,0 +1,59 @@
+class DMTool::Result
+  include Comparable
+
+  def initialize(success: false, failure: false, critical: false, symbol: :nil_result)
+    @success = success
+    @failure = failure
+    @critical = critical
+    @symbol = symbol
+  end
+
+  public
+
+  Success         = DMTool::Result.new(success: true, failure: false, critical: false, symbol: :success)
+  Failure         = DMTool::Result.new(success: false, failure: true, critical: false, symbol: :failure)
+  NilResult       = DMTool::Result.new(success: false, failure: false, critical: false, symbol: :nil_result)
+  CriticalSuccess = DMTool::Result.new(success: true, failure: false, critical: true, symbol: :critical_success)
+  CriticalFailure = DMTool::Result.new(success: false, failure: true, critical: true, symbol: :critical_failure)
+
+  attr_reader :success, :failure, :critical, :symbol
+
+  def critical_success
+    critical? && success?
+  end
+
+  def critical_failure
+    critical? && failure?
+  end
+
+  def to_s
+    "#{to_sym}"
+  end
+
+  def to_i
+    val = 0
+    val += 1 if success?
+    val -=1 if failure?
+    val *=2 if critical?
+    val
+  end
+
+  def coerce(other)
+    [other, self.to_i]
+  end
+
+  def +(other)
+    self.to_i + other.to_i
+  end
+
+  def <=>(other)
+    self.to_i <=> other.to_i
+  end
+
+  alias success? success
+  alias failure? failure
+  alias critical? critical
+  alias critical_failure? critical_failure
+  alias critical_success? critical_success
+  alias to_sym symbol
+end

data/lib/dmtool/roller.rb

@@ -0,0 +1,14 @@
+module DMTool::Roller
+  def self.roll(dice, directives)
+    ret_val = dice.map do |die|
+      directives.each_with_object(die) do |directive, ret|
+        directive.process(ret)
+      end
+    end
+    ret_val
+  end
+
+  def self.sum(dice, directives)
+    roll(dice, directives).map(&:value).inject(0, :+)
+  end
+end

data/lib/dmtool/version.rb

@@ -0,0 +1,3 @@
+module DMTool
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: dmtool
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Forrest Fleming
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.5
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: Suite of tools for RPGs.  An excuse to create a fun little parser.
+email:
+- ffleming@gmail.com
+executables:
+- dmtool
+- roll
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".pryrc"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/dmtool
+- bin/roll
+- dmtool.gemspec
+- lib/core_extensions/string/prep.rb
+- lib/dmtool.rb
+- lib/dmtool/cli.rb
+- lib/dmtool/die.rb
+- lib/dmtool/errors.rb
+- lib/dmtool/parser.rb
+- lib/dmtool/parser/dice_string.rb
+- lib/dmtool/parser/die_directive.rb
+- lib/dmtool/result.rb
+- lib/dmtool/roller.rb
+- lib/dmtool/version.rb
+homepage: http://github.com/ffleming/dmtool
+licenses:
+- MIT
+metadata: {}
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.7
+signing_key: 
+specification_version: 4
+summary: Suite of tools for RPGs
+test_files: []