minecraft 0.2.0 → 0.2.1

data/CHANGES.md

@@ -1,8 +1,16 @@
+0.2.1 (2011-08-22)
+------------------
+
+* Fixed `!points` and `!board`
+* Bugfix on `call_command`
+* Added more test suites.
+* A `!help` command suitable for new privilege system.
+
 0.2.0 (2011-08-21)
 ------------------
 
 * Added configuration file capability.
-* Added `!points`, `!board`, `!kickvote`, `!vote`, `!cancelvote`, `!kickvotes`, `!roulette`, `change_time`, `!om`, `!dehop`, `!op`
+* Added `!points`, `!board`, `!kickvote`, `!vote`, `!cancelvote`, `!kickvotes`, `!roulette`, `change_time`, `!om`, `!dehop`, `!hop`
 * Added time changes (morning, night, dawn, etc...)
 * Separated half-op and op privileges.
 * `!property` now lists properties if none specified.

data/lib/minecraft/commands.rb

@@ -7,35 +7,40 @@ module Minecraft
     # Gives a user a specific amount of points, the quantity is capped
     # depending on the privileges of the user.
     #
-    # @params [String] user The requesting user.
-    # @params [String] target_user The target user to give points to.
-    # @params [Integer] points Quantity of points to give.
+    # @param [String] user The requesting user.
+    # @param [String] target_user The target user to give points to.
+    # @param [Integer] points Quantity of points to give.
     # @example
     #   points("basicxman", "mike_n_7")
     #   points("basicxman", "mike_n_7", "50")
     def points(user, target_user, num_points = 1)
+      if user.downcase == target_user.downcase
+        @server.puts "say Did you just try to give yourself points? Sure, minus twenty."
+        @userpoints[target_user] ||= 0
+        @userpoints[target_user] -= 20
+      end
       num_points = [num_points.to_i, cap_points(user)].min
-      @points[target_user] ||= 0
-      @points[target_user] += num_points
-      @server.puts "say #{user} has given #{target_user} #{num_points} points for a total of #{@points[target_user]}."
+      @userpoints[target_user] ||= 0
+      @userpoints[target_user] += num_points
+      @server.puts "say #{user} has given #{target_user} #{num_points} points for a total of #{@userpoints[target_user]}."
     end
 
     # Checks a users points or displays the leaderboard.
     #
-    # @params [String] user The requesting user.
-    # @params [String] target_user The user to check points of.
+    # @param [String] user The requesting user.
+    # @param [String] target_user The user to check points of.
     # @example
     #   board("basicxman")
     #   board("basicxman", "mike_n_7")
     def board(user, target_user = nil)
       if target_user.nil?
         leaderboard = {}
-        @points.each do |u, p|
+        @userpoints.each do |u, p|
           leaderboard[p] ||= []
           leaderboard[p] << u
         end
         num_to_display = 5
-        leaderboard.keys.sort.each do |points|
+        leaderboard.keys.sort.reverse.each do |points|
           leaderboard[points].each do |u|
             return unless num_to_display >= 1
             @server.puts "say #{u}: #{points}"
@@ -43,8 +48,8 @@ module Minecraft
           end
         end
       else
-        if @points.has_key? target_user
-          @server.puts "say #{u}: #{@points[u]}"
+        if @userpoints.has_key? target_user
+          @server.puts "say #{u}: #{@userpoints[u]}"
         end
       end
     end
@@ -65,8 +70,8 @@ module Minecraft
     # regular connected players cannot kick users they can initiate a vote
     # instead.
     #
-    # @params [String] user The requesting user.
-    # @params [String] target_user The target user to be kicked if the vote
+    # @param [String] user The requesting user.
+    # @param [String] target_user The target user to be kicked if the vote
     # succeeds.
     # @example
     #   kickvote("basicxman", "blizzard4U")
@@ -88,7 +93,7 @@ module Minecraft
 
     # Votes for the last initiated kickvote.
     #
-    # @params [String] user The requesting user.
+    # @param [String] user The requesting user.
     # @example
     #   vote("basicxman")
     def vote(user)
@@ -99,8 +104,8 @@ module Minecraft
 
     # Cancels a kickvote initiation for a specific user.
     #
-    # @params [String] user The requesting user.
-    # @params [String] target_user The user which currently has a kickvote.
+    # @param [String] user The requesting user.
+    # @param [String] target_user The user which currently has a kickvote.
     # @example
     #   cancelvote("basicxman", "blizzard4U")
     def cancelvote(user, target_user)
@@ -114,7 +119,7 @@ module Minecraft
 
     # Displays all current kickvote initiations.
     #
-    # @params [String] user The requesting user.
+    # @param [String] user The requesting user.
     # @example
     #   kickvotes("basicxman")
     def kickvotes(user)
@@ -125,8 +130,8 @@ module Minecraft
 
     # Submits a kickvote.
     #
-    # @params [String] user The requesting user who is voting.
-    # @params [String] target_user The user being voted against.
+    # @param [String] user The requesting user who is voting.
+    # @param [String] target_user The user being voted against.
     # @return [Boolean] Returns true if the kickvote has been initiated yet.
     # @example
     #   submit_vote("basicxman", "blizzard4U")
@@ -175,7 +180,6 @@ module Minecraft
     # Checks to see if any kickvotes are expired.
     def expire_kickvotes
       @kickvotes.each do |target_user, data|
-        puts "Checking #{Time.now} against #{data[:start] + @vote_expiration}}"
         if Time.now > data[:start] + @vote_expiration
           @server.puts "say The kickvote for #{target_user} has expired."
           @kickvotes.delete(target_user)
@@ -471,20 +475,23 @@ module Minecraft
       @server.puts "say Shortcuts for #{user}: #{labels}."
     end
 
-    # Prints the help contents.
+    # Prints the available commands for the user.
     #
+    # @param [String] user The requesting user.
     # @example
-    #   help()
-    def help(*args)
-      @server.puts <<-eof
-say !tp target_user
-say !kit kit_name
-say !give item quantity
-say !nom
-say !list
-say !addtimer item frequency
-say !deltimer item
-      eof
+    #   help("basicxman")
+    def help(user)
+      commands = @commands.keys.inject([]) { |arr, key|
+        priv = @commands[key][:ops]
+        if is_op? user
+          arr << key
+        elsif is_hop? user
+          priv == :op ? arr : arr << key
+        else
+          priv == :none ? arr << key : arr
+        end
+      }.map { |s| "!" + s.to_s }
+      @server.puts "say Commands: #{commands.join(", ")}"
     end
 
     # Prints the list of available kits to the connected players.

data/lib/minecraft/extensions.rb

@@ -16,7 +16,7 @@ module Minecraft
       get_json :timers
       get_json :shortcuts
       get_json :userlog
-      get_json :points
+      get_json :userpoints
       @users = []
       @counter = 0
       @logon_time = {}
@@ -32,38 +32,38 @@ module Minecraft
 
       # Command set.
       @commands = {}
-      add_command(:give,       :ops => :hop,  :all => true, :all_message => "is putting out.")
-      add_command(:tp,         :ops => :hop,  :all => true, :all_message => "is teleporting all users to their location.")
-      add_command(:kit,        :ops => :hop,  :all => true, :all_message => "is providing kits to all.")
-      add_command(:kitlist,    :ops => :hop,  :all => false)
-      add_command(:help,       :ops => :none, :all => false)
-      add_command(:rules,      :ops => :none, :all => false)
-      add_command(:nom,        :ops => :hop,  :all => true, :all_message => "is providing noms to all.")
-      add_command(:om,         :ops => :hop,  :all => true, :all_message => "is noming everybody, gross.")
-      add_command(:list,       :ops => :none, :all => false)
-      add_command(:s,          :ops => :hop,  :all => false)
-      add_command(:shortcuts,  :ops => :hop,  :all => false)
-      add_command(:hop,        :ops => :op,   :all => false)
-      add_command(:dehop,      :ops => :op,   :all => false)
-      add_command(:uptime,     :ops => :none, :all => false)
-      add_command(:addtimer,   :ops => :hop,  :all => false)
-      add_command(:deltimer,   :ops => :hop,  :all => false)
-      add_command(:printtimer, :ops => :hop,  :all => false)
-      add_command(:printtime,  :ops => :op,   :all => false)
-      add_command(:property,   :ops => :op,   :all => false)
-      add_command(:morning,    :ops => :op,   :all => false)
-      add_command(:evening,    :ops => :op,   :all => false)
-      add_command(:day,        :ops => :op,   :all => false)
-      add_command(:night,      :ops => :op,   :all => false)
-      add_command(:dawn,       :ops => :op,   :all => false)
-      add_command(:dusk,       :ops => :op,   :all => false)
-      add_command(:roulette,   :ops => :op,   :all => false)
-      add_command(:kickvote,   :ops => :none, :all => false)
-      add_command(:vote,       :ops => :none, :all => false)
-      add_command(:cancelvote, :ops => :op,   :all => false)
-      add_command(:kickvotes,  :ops => :op,   :all => false)
-      add_command(:points,     :ops => :none, :all => false)
-      add_command(:board,      :ops => :none, :all => false)
+      add_command :give,       :ops => :hop,  :all => true, :all_message => "is putting out."
+      add_command :tp,         :ops => :hop,  :all => true, :all_message => "is teleporting all users to their location."
+      add_command :kit,        :ops => :hop,  :all => true, :all_message => "is providing kits to all."
+      add_command :kitlist,    :ops => :hop,  :all => false
+      add_command :help,       :ops => :none, :all => false
+      add_command :rules,      :ops => :none, :all => false
+      add_command :nom,        :ops => :hop,  :all => true, :all_message => "is providing noms to all."
+      add_command :om,         :ops => :hop,  :all => true, :all_message => "is noming everybody, gross."
+      add_command :list,       :ops => :none, :all => false
+      add_command :s,          :ops => :hop,  :all => false
+      add_command :shortcuts,  :ops => :hop,  :all => false
+      add_command :hop,        :ops => :op,   :all => false
+      add_command :dehop,      :ops => :op,   :all => false
+      add_command :uptime,     :ops => :none, :all => false
+      add_command :addtimer,   :ops => :hop,  :all => false
+      add_command :deltimer,   :ops => :hop,  :all => false
+      add_command :printtimer, :ops => :hop,  :all => false
+      add_command :printtime,  :ops => :op,   :all => false
+      add_command :property,   :ops => :op,   :all => false
+      add_command :morning,    :ops => :op,   :all => false
+      add_command :evening,    :ops => :op,   :all => false
+      add_command :day,        :ops => :op,   :all => false
+      add_command :night,      :ops => :op,   :all => false
+      add_command :dawn,       :ops => :op,   :all => false
+      add_command :dusk,       :ops => :op,   :all => false
+      add_command :roulette,   :ops => :op,   :all => false
+      add_command :kickvote,   :ops => :none, :all => false
+      add_command :vote,       :ops => :none, :all => false
+      add_command :cancelvote, :ops => :op,   :all => false
+      add_command :kickvotes,  :ops => :op,   :all => false
+      add_command :points,     :ops => :none, :all => false
+      add_command :board,      :ops => :none, :all => false
     end
 
     # Sets an instance variable with it's corresponding data file or a blank hash.
@@ -82,7 +82,7 @@ module Minecraft
       save_file :timers
       save_file :shortcuts
       save_file :hops
-      save_file :points
+      save_file :userpoints
     end
 
     # Save an instance hash to it's associated data file.
@@ -116,7 +116,7 @@ module Minecraft
       return send(root, user, *args) unless @commands.include? root
 
       # Any `all` suffixed command requires ops.
-      if @commands[root][:ops] == :ops or (is_all and @commands[root][:all])
+      if @commands[root][:ops] == :op or (is_all and @commands[root][:all])
         return unless validate_ops(user, command)
       elsif @commands[root][:ops] == :hop
         return unless validate_ops(user, command, false) or validate_hops(user, command)

data/lib/minecraft/version.rb

@@ -1,5 +1,5 @@
 # Global Minecraft module.
 module Minecraft
   # Yay, keep these versions coming!
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/test/commands_test.rb

@@ -3,6 +3,8 @@ require "minecraft"
 
 class CommandsTest < Test
   include Minecraft::Commands
+
+  # Item resolution and quantifiers testing.
   test "should properly check quantifiers" do
     assert is_quantifier? "1"
     assert is_quantifier? "10"
@@ -50,6 +52,7 @@ class CommandsTest < Test
     assert_nil resolve_item("asdf")
   end
 
+  # Give command testing.
   test "give command should give a single slot worth" do
     @server = StringIO.new
     give("foo", "cobblestone", "64")
@@ -77,4 +80,151 @@ give foo 4 32
 eof
     assert_equal result, @server.string
   end
+
+  # User points system testing.
+  sandbox_test "should give a user points" do
+    @ext = Minecraft::Extensions.new(StringIO.new, {})
+    @ext.users = ["basicxman", "mike_n_7", "blizzard4U", "Ian_zers"]
+    @ext.ops  = ["basicxman"]
+    @ext.hops = ["mike_n_7"]
+    @ext.call_command("basicxman", "points", "Ian_zers", "1001")
+    assert_equal 1000, @ext.userpoints["Ian_zers"]
+    @ext.call_command("mike_n_7", "points", "Ian_zers", "501")
+    assert_equal 1500, @ext.userpoints["Ian_zers"]
+    @ext.call_command("blizzard4U", "points", "Ian_zers", "2")
+    assert_equal 1501, @ext.userpoints["Ian_zers"]
+  end
+
+  sandbox_test "should not a let a user give herself points" do
+    @ext = Minecraft::Extensions.new(StringIO.new, {})
+    @ext.users = ["basicxman"]
+    @ext.userpoints = { "basicxman" => 0 }
+    @ext.call_command("basicxman", "points", "basicxman")
+    assert @ext.userpoints["basicxman"] < 0
+  end
+
+  sandbox_test "should print a users points" do
+    @ext = Minecraft::Extensions.new(StringIO.new, {})
+    @ext.userpoints = { "basicxman" => 50 }
+    @ext.call_command("basicxman", "board")
+    assert_match "basicxman", @ext.server.string
+    assert_match "50", @ext.server.string
+  end
+
+  sandbox_test "should print a leaderboard" do
+    @ext = Minecraft::Extensions.new(StringIO.new, {})
+    @ext.userpoints = {
+      "basicxman" => 150,
+      "mike_n_7" => 150,
+      "blizzard4U" => 20,
+      "Ian_zers" => 90,
+      "horsmanjarrett" => 50,
+      "someguy" => 10
+    }
+    @ext.board("basicxman")
+    leaderboard = @ext.server.string.split("\n")
+    assert_match "150", leaderboard[0]
+    assert_match "150", leaderboard[1]
+    assert_match "Ian_zers", leaderboard[2]
+    assert_match "horsmanjarrett", leaderboard[3]
+    assert_match "blizzard4U", leaderboard[4]
+  end
+
+  # Kickvote testing.
+  sandbox_test "should initiate a kickvote against a user" do
+    @ext = Minecraft::Extensions.new(StringIO.new, {})
+    @ext.users = ["basicxman", "mike_n_7", "blizzard4U", "Ian_zers"]
+    @ext.ops  = ["basicxman"]
+    @ext.hops = ["mike_n_7"]
+    @ext.call_command("basicxman", "kickvote", "blizzard4U")
+    assert_equal 3, @ext.kickvotes["blizzard4U"][:tally]
+    assert_equal "blizzard4U", @ext.last_kick_vote
+  end
+
+  sandbox_test "should expire a kickvote against a user" do
+    @ext = Minecraft::Extensions.new(StringIO.new, {})
+    @ext.users = ["basicxman", "blizzard4U"]
+    @ext.call_command("basicxman", "kickvote", "blizzard4U")
+    @ext.counter = 9
+    @ext.kickvotes["blizzard4U"][:start] = Time.now - 300
+    @ext.periodic
+    assert_match "expire", @ext.server.string
+  end
+
+  sandbox_test "should add the correct number of votes per user type" do
+    @ext = Minecraft::Extensions.new(StringIO.new, {})
+    @ext.users = ["basicxman", "mike_n_7", "blizzard4U", "Ian_zers"]
+    @ext.ops  = ["basicxman"]
+    @ext.hops = ["mike_n_7"]
+    @ext.vote_threshold = 7
+    @ext.call_command("Ian_zers", "kickvote", "blizzard4U")
+    assert_equal 1, @ext.kickvotes["blizzard4U"][:tally]
+    @ext.call_command("mike_n_7", "vote")
+    assert_equal 3, @ext.kickvotes["blizzard4U"][:tally]
+    @ext.call_command("basicxman", "vote")
+    assert_equal 6, @ext.kickvotes["blizzard4U"][:tally]
+  end
+
+  sandbox_test "should kick a user who has enough votes" do
+    @ext = Minecraft::Extensions.new(StringIO.new, {})
+    @ext.users = ["basicxman", "mike_n_7", "blizzard4U", "Ian_zers"]
+    @ext.ops  = ["basicxman"]
+    @ext.hops = ["mike_n_7"]
+    @ext.call_command("basicxman", "kickvote", "Ian_zers")
+    @ext.call_command("mike_n_7", "vote")
+    assert_match "kick Ian_zers", @ext.server.string
+  end
+
+  # Time commands.
+  sandbox_test "should change time with time commands" do
+    @ext = Minecraft::Extensions.new(StringIO.new, {})
+    @ext.ops = ["basicxman"]
+    %w( morning evening night dawn dusk day ).each do |time|
+      @ext.call_command("basicxman", time)
+      assert_match "time set #{Minecraft::Data::TIME[time.to_sym]}", @ext.server.string
+      @ext.server.string = ""
+    end
+  end
+
+  # Half op privileges and !list.
+  sandbox_test "should revoke and add half op privileges" do
+    @ext = Minecraft::Extensions.new(StringIO.new, {})
+    @ext.users = ["basicxman", "blizzard4U", "mike_n_7"]
+    @ext.ops = ["basicxman"]
+    @ext.call_command("basicxman", "hop", "blizzard4U")
+    @ext.call_command("basicxman", "hop", "mike_n_7")
+    @ext.call_command("basicxman", "dehop", "blizzard4U")
+    @ext.call_command("basicxman", "list")
+    assert_match "[@basicxman], blizzard4U, %mike_n_7", @ext.server.string.split("\n").last
+  end
+
+  # Help command.
+  sandbox_test "should display help contents for regular users" do
+    @ext = Minecraft::Extensions.new(StringIO.new, {})
+    @ext.users = ["blizzard4U"]
+    @ext.call_command("blizzard4U", "help")
+    assert_match "rules", @ext.server.string
+    assert_match "list", @ext.server.string
+    refute_match "give", @ext.server.string
+  end
+
+  sandbox_test "should display help contents for half ops" do
+    @ext = Minecraft::Extensions.new(StringIO.new, {})
+    @ext.users = ["mike_n_7"]
+    @ext.hops  = ["mike_n_7"]
+    @ext.call_command("mike_n_7", "help")
+    assert_match "rules", @ext.server.string
+    assert_match "give", @ext.server.string
+    refute_match "morning", @ext.server.string
+  end
+
+  sandbox_test "should display help contents for ops" do
+    @ext = Minecraft::Extensions.new(StringIO.new, {})
+    @ext.users = ["basicxman"]
+    @ext.ops   = ["basicxman"]
+    @ext.call_command("basicxman", "help")
+    assert_match "rules", @ext.server.string
+    assert_match "give", @ext.server.string
+    assert_match "morning", @ext.server.string
+  end
 end

data/test/extensions_test.rb

@@ -0,0 +1,64 @@
+require "helper"
+require "minecraft"
+
+class ExtensionsTest < Test
+  # call_comamnd testing.
+  sandbox_test "should call a command for a regular user" do
+    @ext = Minecraft::Extensions.new(StringIO.new, {})
+    @ext.users = ["basicxman"]
+    @ext.call_command("basicxman", "list")
+    assert_equal 0, @ext.server.string.index("say")
+  end
+
+  sandbox_test "should not call an all command for a regular user" do
+    @ext = Minecraft::Extensions.new(StringIO.new, {})
+    @ext.users = ["basicxman"]
+    @ext.call_command("basicxman", "giveall", "cobblestone")
+    assert_match "not a", @ext.server.string
+  end
+
+  sandbox_test "should not let regular users run privileged commands" do
+    @ext = Minecraft::Extensions.new(StringIO.new, {})
+    @ext.users = ["blizzard4U"]
+    @ext.call_command("blizzard4U", "give", "cobblestone")
+    assert_match "not a", @ext.server.string
+  end
+
+  sandbox_test "should not call an all command if not available" do
+    @ext = Minecraft::Extensions.new(StringIO.new, {})
+    @ext.users = ["basicxman", "blizzard4U", "mike_n_7"]
+    @ext.ops = ["basicxman"]
+    @ext.call_command("basicxman", "rouletteall")
+    assert_equal 2, @ext.server.string.split("\n").length
+  end
+
+  sandbox_test "should let ops execute an all command" do
+    @ext = Minecraft::Extensions.new(StringIO.new, {})
+    @ext.users = ["basicxman", "blizzard4U", "mike_n_7"]
+    @ext.ops = ["basicxman"]
+    @ext.call_command("basicxman", "giveall", "cobblestone")
+    assert_match "basicxman is", @ext.server.string
+  end
+
+  sandbox_test "should not let hops or execute an all command" do
+    @ext = Minecraft::Extensions.new(StringIO.new, {})
+    @ext.users = ["basicxman", "blizzard4U", "mike_n_7"]
+    @ext.hops = ["mike_n_7"]
+    @ext.call_command("mike_n_7", "giveall", "cobblestone")
+    assert_match "not a", @ext.server.string
+  end
+
+  sandbox_test "should not let hops run op commands" do
+    @ext = Minecraft::Extensions.new(StringIO.new, {})
+    @ext.hops = ["mike_n_7"]
+    @ext.call_command("mike_n_7", "morning")
+    assert_match "not a", @ext.server.string
+  end
+
+  sandbox_test "should let ops run op privileged commands" do
+    @ext = Minecraft::Extensions.new(StringIO.new, {})
+    @ext.ops = ["basicxman"]
+    @ext.call_command("basicxman", "morning")
+    refute_match "not a", @ext.server.string
+  end
+end

data/test/helper.rb

@@ -4,11 +4,30 @@ unless Object.const_defined? 'Minecraft'
 end
 
 require "minitest/autorun"
+require "fileutils"
 require "stringio"
 require "turn"
 
+module Minecraft
+  class Extensions
+    attr_accessor :commands, :users, :ops, :hops, :counter, :server, :kickvotes, :last_kick_vote, :uptime, :timers, :shortcuts, :userlog, :userpoints, :vote_threshold
+  end
+end
+
 class Test < MiniTest::Unit::TestCase
   def self.test(name, &block)
     define_method("test_#{name.gsub(/\W/, '_')}", block)
   end
+
+  def self.sandbox_test(name, &block)
+    p = Proc.new do
+      FileUtils.mkdir("mc") unless File.exists? "mc"
+      FileUtils.cd("mc") do
+        FileUtils.touch("ops.txt")
+        FileUtils.touch("server.properties")
+        instance_eval(&block)
+      end
+    end
+    define_method("test_#{name.gsub(/\W/, '_')}", p)
+  end
 end

metadata

@@ -2,7 +2,7 @@
 name: minecraft
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - Andrew Horsman
@@ -51,6 +51,7 @@ files:
 - lib/minecraft/version.rb
 - minecraft.gemspec
 - test/commands_test.rb
+- test/extensions_test.rb
 - test/helper.rb
 - test/tools_test.rb
 has_rdoc: true