elvarg 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67e2cce699cff36e9c3449c7c89db0da859d702a3d464e75f78b491636aa1014
-  data.tar.gz: b5da4d18227f1233ba51e7605aa5d51dc245e2a7209528aeaa6aaa675efc4911
+  metadata.gz: 3118f2f2f8a4592ebe5e1bbd48e54165fc4119344dd395fb05f4418f924a685f
+  data.tar.gz: 3b24d648e84bf24139b8667ea5f024b2f2079f355ae6763ad3e131b801a024d9
 SHA512:
-  metadata.gz: 59a1de2cd781d6b452c4db7d0497fcd2abc30d6cfa23dd8e1eb0bc3013a15e5cba415d0693c9050652945f910fca00ddb593a8102ba25b8a4e2ea28b48990fda
-  data.tar.gz: 264f3d2466a0780ddff14fcc53f01449d03ce8a1eba2f7fa4d8b94b992ef957f1c982cab3f79ff1565ec19dcdc89f9e7356e1c60064c7edebb5b0493eadc9fb8
+  metadata.gz: 38cb35cd448c88b6adef48f938abb9668cc3aa383cef6cc3b6eb508003edb02b84ef024ddd862d48f9456b1ad740acb9a8e02accc462975b7a136b6a4c004042
+  data.tar.gz: d3f00779a83fe02ab7f428bc50af1a4a7806bbc14a183eb2b9bb979d3c71a99eca54b37c7fb1afac0afc4d27f0669749bb4c531e513c779a56ca8ff9eb28ebc7

data/lib/hiscores/player.rb

@@ -8,8 +8,13 @@ module Elvarg #:nodoc:
     # Represents a Player on the Hiscores
     class Player
       include Elvarg::Stats
+      # The Player's username
       attr_reader :username
+      # The Hiscore's mode.
+      # This can be :default, :ironman, :ultimate, etc.
+      # @see Hiscores::MODES for complete list
       attr_reader :mode
+      # A Hash of all Stats available in OldSchool Runescape's Hiscores
       attr_reader :skills
 
       ##
@@ -34,6 +39,58 @@ module Elvarg #:nodoc:
         parse_data(Hiscores.search_for(username, mode))
       end
 
+      ##
+      # Determines if this Player is/was a member at one point in time.
+      #
+      # @example The player, "Ruby", has trained member's only skills
+      #   player = Elvarg::Hiscores::Player.new 'Ruby'
+      #   player.member? #=> true
+      #
+      # @note This methods determines member status based on if the Player
+      #       has trained any member skills.
+      # @see free?
+      # @return [true] if the Player has trained member's only skills.
+      # @return [false] if the Player only trained free-to-play skills.
+      def member?
+        @skills.each { |_, skill| return true if skill.xp > 0 && skill.member? }
+        false
+      end
+
+      ##
+      # Determines if this Player is a free-to-play player.
+      #
+      # @example The player, "Ruby", has trained member's only skills
+      #   player = Elvarg::Hiscores::Player.new 'Ruby'
+      #   player.free? #=> false
+      #
+      # @note This is the inverse of #member?
+      # @see member?
+      # @return [true] if the Player only trained free-to-play skills.
+      # @return [false] if the Player has trained member's only skills.
+      def free?
+        !member?
+      end
+
+      ##
+      # Determines if this Player is a skiller (combat level 3).
+      #
+      # If a Player has any combat level > 1 (with the exception of 10 hitpoints)
+      # that Player is classified as a Skiller.
+      #
+      # @example The player, "Ruby", is not a skiller
+      #   player = Elvarg::Hiscores::Player.new 'Ruby'
+      #   player.skiller? #=> false
+      #
+      # @return [true]
+      # @return [false]
+      def skiller?
+        @skills.each do |key, skill|
+          next if key == :hitpoints && skill.level <= 10
+          return false if skill.level > 1 && skill.combat?
+        end
+        true
+      end
+
       private
 
       ##

data/lib/hiscores/skill.rb

@@ -5,15 +5,24 @@ module Elvarg #:nodoc:
     ##
     # Represents a Skill on the Hiscores
     class Skill < Stats::Skill
-      # TODO
+      # The rank of the Skill the Player has on the Hiscores
       attr_reader :rank
-      # TODO
+      # The level of the Skill the Player has on the Hiscores
       attr_reader :level
-      # TODO
+      # The experience of the Skill the Player has on the Hiscores
       attr_reader :exp
 
       ##
-      # TODO
+      # Creates a Hiscores Skill object
+      #
+      # @see Stats::SKILLS
+      # @see Stats::Skill#initialize
+      # @param symbol [Symbol] the Symbol of the Skill (required)
+      #        see Stats::SKILLS for complete list
+      # @param id [Integer] the unique id of the Skill (default) 0
+      # @param rank [Integer] the Player's rank in this Skill (default) -1
+      # @param level [Integer] the Player's level in this Skill (default) 1
+      # @param exp [Integer] the Player's experience in this Skill (default) 0
       def initialize(symbol, id = 0, rank = -1, level = 1, exp = 0)
         super(symbol, id)
         @rank = rank

data/lib/stats/skill.rb

@@ -45,22 +45,22 @@ module Elvarg #:nodoc:
       # Determines if this Skill is a member's only skill.
       #
       # @example Slayer is a member's only skill.
-      #   Elvarg::Stats::Skill.new(:hunter).members? #=> true
+      #   Elvarg::Stats::Skill.new(:hunter).member? #=> true
       # @example Runecraft is a free-to-play skill.
-      #   Elvarg::Stats::Skill.new(:runecraft).members? #=> false
+      #   Elvarg::Stats::Skill.new(:runecraft).member? #=> false
       # @return [true] if this Skill is a member's only skill.
       # @return [false] if this Skill is free-to-play.
-      def members?
+      def member?
         MEMBER_SKILLS.include? @symbol
       end
 
       ##
       # Determines if this Skill is a free-to-play skill.
       #
-      # @note This is the inverse of `members?`
-      # @see members?
+      # @note This is the inverse of #member?
+      # @see member?
       def free?
-        !members?
+        !member?
       end
 
       ##

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elvarg
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Marcello A. Sabino
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-27 00:00:00.000000000 Z
+date: 2018-12-29 00:00:00.000000000 Z
 dependencies: []
 description: A Ruby Gem that provides useful methods for OldSchool RuneScape related
   applications.