cinch-dicebag 0.0.2 → 1.0.0

data/.travis.yml

@@ -0,0 +1,5 @@
+nguage: ruby
+rvm:
+  - ruby-head
+  - 1.9.2
+  - 1.9.3

data/README.md

@@ -1,4 +1,10 @@
-# Cinch::Plugins::Dicebag
+#Cinch::Plugins::Dicebag
+
+[![Gem Version](https://badge.fury.io/rb/cinch-dicebag.png)](http://badge.fury.io/rb/cinch-dicebag)
+[![Dependency Status](https://gemnasium.com/bhaberer/cinch-dicebag.png)](https://gemnasium.com/bhaberer/cinch-dicebag)
+[![Build Status](https://travis-ci.org/bhaberer/cinch-dicebag.png?branch=master)](https://travis-ci.org/bhaberer/cinch-dicebag)
+[![Coverage Status](https://coveralls.io/repos/bhaberer/cinch-dicebag/badge.png?branch=master)](https://coveralls.io/r/bhaberer/cinch-dicebag?branch=master)
+[![Code Climate](https://codeclimate.com/github/bhaberer/cinch-dicebag.png)](https://codeclimate.com/github/bhaberer/cinch-dicebag)
 
 Cinch Plugin to allow users to roll dice in channels.
 

data/Rakefile

@@ -1 +1,7 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/cinch-dicebag.gemspec

@@ -17,8 +17,13 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency 'cinch', '>= 2.0.0'
-  gem.add_dependency 'time-lord', '1.0.1'
-  gem.add_dependency 'cinch-cooldown'
-  gem.add_dependency 'cinch-storage'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'coveralls'
+
+  gem.add_dependency 'cinch',           '>= 2.0.0'
+  gem.add_dependency 'time-lord',       '~> 1.0.1'
+  gem.add_dependency 'cinch-cooldown',  '>= 1.0.0'
+  gem.add_dependency 'cinch-storage',   '~> 0.0.2'
+  gem.add_dependency 'cinch-toolbox',   '~> 0.0.5'
 end

data/lib/cinch/plugins/dicebag/dicebag.rb

@@ -11,118 +11,99 @@ module Cinch::Plugins
 
     enforce_cooldown
 
-    self.help = "Roll a random bag of dice with .dicebag, you can also use .roll (dice count)d(sides) to roll specific dice (e.g. '.roll 4d6 3d20')"
+    attr_accessor :storage
 
-    class Score < Struct.new(:nick, :score, :time)
-      def to_yaml
-        { :nick => nick, :score => score, :time => time }
-      end
-    end
+    self.help = "Roll a random bag of dice with .dicebag, you can also use .roll (dice count)d(sides) to roll specific dice (e.g. '.roll 4d6 3d20')"
 
-    match /dicebag/,    method: :roll_bag
-    match /roll (.*)/,  method: :roll_specific
+    match /dicebag/
+    match /roll (.*)/
 
     def initialize(*args)
       super
       @storage = CinchStorage.new(config[:filename] || 'yaml/dice.yml')
     end
 
-    def roll_bag(m)
-      if m.channel.nil?
-        m.user.msg "You must use that command in the main channel."
-        return
-      end
+    def execute(m, dice = nil)
+      m.reply (dice.nil? ? roll_dicebag(m.user.nick, m.channel) : roll(m.user.nick, dice))
+    end
 
-      dice = { :d4 => rand(250), :d6 => rand(500), :d10 => rand(750), :d20 => rand(1000) }
-      result = roll_dice(dice.map { |die, count| "#{count}#{die}" })
-
-      total = dice.values.inject(:+)
-      size =  case total
-              when 0..100
-                'tiny'
-              when 101..500
-                'small'
-              when 501..1000
-                'medium'
-              when 1001..1500
-                'large'
-              when 1501..2000
-                'hefty'
-              else
-                'huge'
-              end
-
-      m.reply "#{m.user.nick} rolls a #{size} bag of dice totalling #{result[:total]}."
-
-      channel = m.channel.name
-      nick    = m.user.nick.downcase
-
-      unless @storage.data.key?(channel)
-        @storage.data[channel] = Hash.new
-      end
+    def roll_dicebag(nick, channel)
+      return "You must use that command in the main channel." if channel.nil?
 
-      unless @storage.data[channel].key?(nick)
-        @storage.data[channel][nick] = { :score => result[:total], :time => Time.now }
-      end
+      dice  = { :d4 => rand(250), :d6 => rand(500), :d10 => rand(750), :d20 => rand(1000) }
 
-      if @storage.data[channel][nick][:score] < result[:total]
-        old = @storage.data[channel][nick]
-        @storage.data[channel][nick] = { :score => result[:total], :time => Time.now }
+      total = roll_dice(dice.map { |die, count| "#{count}#{die}" })
+      size  = get_bag_size(dice.values.inject(:+))
 
-        m.reply "This is a new high score, their old score was #{old[:score]}, #{old[:time].ago.to_words}."
-      end
+      message = "#{nick} rolls a #{size} bag of dice totalling #{total}. " +
+                score_check(nick.downcase, channel.name, total)
 
-      synchronize(:dice_save) do
-        @storage.save
-      end
+      return message
     end
 
-    def roll_specific(m, bag)
-      result = roll_dice(bag.split(' '))
-      if result.nil?
-        m.reply "I'm sorry that's not the right way to roll dice.", true
-      else
-        m.reply "#{m.user.nick} rolls #{result[:rolls].join(', ')} totalling #{result[:total]}"
-      end
+    def roll(nick, dice)
+      return nil if dice.nil? || nick.nil?
+
+      result = roll_dice(dice.split(' '))
+
+      return "#{nick} rolls #{dice} totalling #{result}" unless result.nil?
     end
 
-    private
+    def roll_die(sides, count)
+      return 0 if sides < 1 || count < 1
+      total = 0
+      count.times { total += rand(sides) + 1 }
+      return total
+    end
 
     def roll_dice(dice)
-      rolls = []
+      # Clean out anything invalid
+      dice.delete_if { |d| d.match(/\d*d\d+/).nil? }
+
       total = 0
 
-      # Clean out anything invalid
-      dice.delete_if { |d| d.match(/\d+d\d+/).nil? }
+      # Roll each group and total up the returned value
       dice.each do |die|
-        if die.match(/\d+d\d+/)
-          count = die.match(/(\d+)d\d+/)[1].to_i rescue 0
-          sides = die.match(/\d+d(\d+)/)[1].to_i rescue 0
-        elsif die.match(/d\d+/)
-          count = 1
-          sides = die.match(/d(\d+)/)[1].to_i rescue 0
-        end
+        count = die[/(\d+)d\d+/, 1] || 1
+        sides = die[/\d?d(\d+)/, 1]
         unless count.nil? || sides.nil?
-          roll = roll_dice_type(sides, count)
-          unless roll.nil?
-            rolls << roll[:text]
-            total += roll[:total]
-          end
+          total += roll_die(sides.to_i, count.to_i)
         end
       end
-      if rolls.empty? || total.zero?
-        return nil
+
+      return total
+    end
+
+    def get_bag_size(size)
+      case size
+      when 0..100
+        'tiny'
+      when 101..500
+        'small'
+      when 501..1000
+        'medium'
+      when 1001..1500
+        'large'
+      when 1501..2000
+        'hefty'
       else
-        return { :rolls => rolls, :total => total }
+        'huge'
       end
     end
 
-    def roll_dice_type(sides, count)
-      unless sides < 1 || count < 1
-        rolls = []
-        count.times { rolls << rand(sides) + 1 }
-        return {:total => rolls.inject(:+),
-                :text => "#{count}d#{sides}" }
+    def score_check(nick, channel, score)
+      # If the chennel or nick are not already initialized, spin them up
+      @storage.data[channel] ||= Hash.new
+      @storage.data[channel][nick] ||= { :score => score, :time => Time.now }
+
+      # Check and see if this is a higher score.
+      old = @storage.data[channel][nick]
+      if @storage.data[channel][nick][:score] < score
+        @storage.data[channel][nick] = { :score => score, :time => Time.now }
+        @storage.synced_save(@bot)
+        return "A new high score! Their old high roll was #{old[:score]}, #{old[:time].ago.to_words}."
+      else
+        return ''
       end
     end
   end

data/lib/cinch/plugins/dicebag/version.rb

@@ -1,5 +1,5 @@
 module Cinch
   module Dicebag
-    VERSION = "0.0.2"
+    VERSION = "1.0.0"
   end
 end

data/spec/cinch-dicebag_spec.rb

@@ -0,0 +1,126 @@
+require 'spec_helper'
+
+describe Cinch::Plugins::Dicebag do
+
+  before(:all) do
+    @plugin = Cinch::Plugins::Dicebag.new
+  end
+
+  describe 'rolling specific dice' do
+    it "should return a string from rolling multiple dice" do
+      @plugin.roll('thom', '3d3').should_not be_nil
+    end
+
+    it "should return a string from rolling mixes of dice" do
+      @plugin.roll('thom', '3d3 d7 3d25').should_not be_nil
+    end
+
+    it "should return a string from rolling a single die" do
+      @plugin.roll('thom', 'd3').should_not be_nil
+    end
+
+    it "should not return a string from rolling dice without a name" do
+      @plugin.roll(nil, '3d3').should be_nil
+    end
+
+    it "should not return a string from rolling dice without a name" do
+      @plugin.roll('joe', nil).should be_nil
+    end
+
+    it "should return a string describing the dice that were rolled" do
+      text = @plugin.roll('thom', '3d3')
+      text.match(/rolls\s3d3\stotalling\s\d+/).should_not be_nil
+    end
+  end
+
+  describe 'roll_dicebag' do
+    it "should return a string" do
+      @plugin.roll_dicebag('user', Cinch::Channel.new('foo', fake_bot)).should_not be_nil
+    end
+
+    it "should return an error if the user is not in a channel" do
+      @plugin.roll_dicebag('user', nil).
+        should be_eql("You must use that command in the main channel.")
+    end
+
+    it "should return a string describing the user's bag roll" do
+      text = @plugin.roll_dicebag('user', Cinch::Channel.new('foo', fake_bot))
+      text.match(/user rolls a [a-z]+ bag of dice totalling \d+/).should_not be_nil
+    end
+
+    it "should announce a high score if the old score is higher" do
+      @plugin.storage.data['foo']['brian'] = { :score => 1, :time => Time.now }
+      text = @plugin.roll_dicebag('brian', Cinch::Channel.new('foo', fake_bot))
+      text.match(/A new high score/).should_not be_nil
+      text.match(/Their old high roll was \d+/).should_not be_nil
+    end
+  end
+
+  describe 'roll_dice' do
+    it "should return zero if the dice list is empty" do
+      @plugin.roll_dice([]).should be_zero
+    end
+
+    it "should return a non zero total on a normal dice list" do
+      @plugin.roll_dice(['3d3', '4d5']).should_not be_zero
+    end
+
+    it "should clear out any invalid dice rolls" do
+      @plugin.roll_dice(['33']).should be_zero
+    end
+  end
+
+  describe "roll_die" do
+    it "should return an acceptable value for a given roll" do
+      @plugin.roll_die(1, 1).should == 1
+      (5..15).should include(@plugin.roll_die(3, 5))
+    end
+
+    it "should return 0 for any negetive values" do
+      @plugin.roll_die(-1,  1).should == 0
+      @plugin.roll_die( 1, -1).should == 0
+      @plugin.roll_die(-1, -1).should == 0
+    end
+  end
+
+  describe "get_bag_size" do
+    it "should return 'huge' for out of bounds queries" do
+      @plugin.get_bag_size(50000).should == 'huge'
+    end
+
+    it "should return the proper size for tiny range" do
+      @plugin.get_bag_size(0).should            == 'tiny'
+      @plugin.get_bag_size(rand(100)).should    == 'tiny'
+      @plugin.get_bag_size(100).should          == 'tiny'
+    end
+
+    it "should return the proper size for small range" do
+      @plugin.get_bag_size(101).should              == 'small'
+      @plugin.get_bag_size(rand(399) + 101).should  == 'small'
+      @plugin.get_bag_size(500).should              == 'small'
+    end
+
+    it "should return the proper size for medium range" do
+      @plugin.get_bag_size(501).should              == 'medium'
+      @plugin.get_bag_size(rand(499) + 501).should  == 'medium'
+      @plugin.get_bag_size(1000).should             == 'medium'
+    end
+
+    it "should return the proper size for large range" do
+      @plugin.get_bag_size(1001).should              == 'large'
+      @plugin.get_bag_size(rand(499) + 1001).should  == 'large'
+      @plugin.get_bag_size(1500).should              == 'large'
+    end
+
+    it "should return the proper size for hefty range" do
+      @plugin.get_bag_size(1501).should              == 'hefty'
+      @plugin.get_bag_size(rand(499) + 1501).should  == 'hefty'
+      @plugin.get_bag_size(2000).should              == 'hefty'
+    end
+
+    it "should return the proper size for huge range" do
+      @plugin.get_bag_size(2001).should              == 'huge'
+      @plugin.get_bag_size(20001).should             == 'huge'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+require 'coveralls'
+Coveralls.wear!
+require 'cinch-dicebag'
+
+def fake_bot
+  bot = Cinch::Bot.new do
+    configure do |c|
+      c.plugins.options[Cinch::Plugins::Dicebag][:filename] = '/dev/null'
+    end
+  end
+  bot.loggers.level = :fatal
+  bot
+  return bot
+end
+
+module Cinch
+  module Plugin
+    def initialize(opts = {})
+      @bot = fake_bot
+      @handlers = []
+      @timers   = []
+      # Don't init the bot
+      # __register
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cinch-dicebag
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,56 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-04 00:00:00.000000000 Z
+date: 2013-06-07 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: cinch
   requirement: !ruby/object:Gem::Requirement
@@ -32,7 +80,7 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.0.1
   type: :runtime
@@ -40,7 +88,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.0.1
 - !ruby/object:Gem::Dependency
@@ -50,7 +98,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,23 +106,39 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: cinch-storage
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.2
+- !ruby/object:Gem::Dependency
+  name: cinch-toolbox
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.5
 description: Cinch Plugin that allows uses in the channel to roll specific dice or
   roll a random assortment of dice to compete for high scores.
 email:
@@ -84,6 +148,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -92,6 +157,8 @@ files:
 - lib/cinch-dicebag.rb
 - lib/cinch/plugins/dicebag/dicebag.rb
 - lib/cinch/plugins/dicebag/version.rb
+- spec/cinch-dicebag_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/bhaberer/cinch-dicebag
 licenses: []
 post_install_message: 
@@ -116,4 +183,6 @@ rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: ! 'Cinch Plugin: Dicebag and Dice rolls'
-test_files: []
+test_files:
+- spec/cinch-dicebag_spec.rb
+- spec/spec_helper.rb