deckstrings 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 165dd18189a80411f1cf056c839300f4740ad9e2
-  data.tar.gz: b075f96b17e110de658cd794de55ba3a4fc81f13
+  metadata.gz: 80a4c98e3e84f0390bac22795833f6b07e87668b
+  data.tar.gz: aac1b9bb8f72e78dc1c37ce7d800b21b9bfea124
 SHA512:
-  metadata.gz: 1e3853e3128d65fcba0b474bb7cc6dc35b0421605cb207a44d7d129e1b73b4272c2d7de71b2089d6f8ff2c77fabe4acab1bbdc3eb1d25376a9beeff0fc04b30e
-  data.tar.gz: a9a27f25681cd2a616b11c4b245e5f5fbc19130f96ec52f2755c6f5bb5c84827adae7594509c00d7971050a399dfd17147cc9e03ceebcb326e3ad260d3bdcad3
+  metadata.gz: 995a352c3728e5fa27aef25e0b1b41d0f39de4535e42e7b6f8fa918b48618dccbe7176503242910233c7ef3ecd8f866b28066b9756612250fc10c18ec9060843
+  data.tar.gz: 2364c4b40827f0971386195cf1d92b151fdbf448c0ff2dd95c4d58e3f3177d542984cf7236b13b9bbfc8b27ffdd04290d4c0eadfd75bf57f9ff16f39b34e83ed

data/README.md

@@ -0,0 +1,76 @@
+# Hearthstone Deckstrings [![Gem Version](https://badge.fury.io/rb/deckstrings.svg)](http://rubygems.org/gems/deckstrings) [![Build Status](https://travis-ci.org/schmich/hearthstone-deckstrings.svg?branch=master)](https://travis-ci.org/schmich/hearthstone-deckstrings)
+
+Ruby library for encoding and decoding [Hearthstone deckstrings](https://hearthsim.info/docs/deckstrings/). See [documentation](http://www.rubydoc.info/gems/deckstrings) for help.
+
+## Usage
+
+```bash
+gem install deckstrings
+```
+
+```ruby
+require 'deckstrings'
+```
+
+Hearthstone deckstrings encode a Hearthstone deck in a compact format.
+
+The IDs used in deckstrings and in this library refer to Hearthstone DBF IDs which uniquely define Hearthstone entities like cards and heroes.
+
+For additional entity metadata (e.g. hero class, card cost, card name), the DBF IDs can be used in conjunction with the [HearthstoneJSON](https://hearthstonejson.com/) database.
+
+## Decoding
+
+`Deckstrings::decode` provides the simplest decoding with the least validation.
+
+```ruby
+deckstring = 'AAECAZICCPIF+Az5DK6rAuC7ApS9AsnHApnTAgtAX/4BxAbkCLS7Asu8As+8At2+AqDNAofOAgA='
+puts Deckstrings::decode(deckstring)
+```
+
+```text
+{:format=>2, :heroes=>[274], :cards=>{754=>1, 1656=>1, 1657=>1, 38318=>1, 40416=>1, 40596=>1, 41929=>1, 43417=>1, 64=>2, 95=>2, 254=>2, 836=>2, 1124=>2, 40372=>2, 40523=>2, 40527=>2, 40797=>2, 42656=>2, 42759=>2}}
+```
+
+`Deckstrings::Deck.parse` provides extended validation and additional deck information including card name and cost.
+
+```ruby
+deckstring = 'AAECAZICCPIF+Az5DK6rAuC7ApS9AsnHApnTAgtAX/4BxAbkCLS7Asu8As+8At2+AqDNAofOAgA='
+puts Deckstrings::Deck.parse(deckstring)
+```
+
+```text
+Format: Standard
+Class: Druid
+Hero: Malfurion Stormrage
+
+2× Innervate
+2× Jade Idol
+2× Wild Growth
+2× Wrath
+2× Jade Blossom
+2× Swipe
+2× Jade Spirit
+1× Fandral Staghelm
+1× Spellbreaker
+2× Nourish
+1× Big Game Hunter
+2× Spreading Plague
+1× The Black Knight
+1× Aya Blackpaw
+2× Jade Behemoth
+1× Malfurion the Pestilent
+1× Primordial Drake
+2× Ultimate Infestation
+1× Kun the Forgotten King
+```
+
+## Encoding
+
+`Deckstrings::encode`
+
+`Deckstrings::Deck`
+
+## License
+
+Copyright © 2017 Chris Schmich  
+MIT License. See [LICENSE](LICENSE) for details.

data/lib/deckstrings.rb

@@ -1,4 +1,3 @@
 require 'deckstrings/enum'
 require 'deckstrings/varint'
-require 'deckstrings/version'
 require 'deckstrings/deckstrings'

data/lib/deckstrings/deckstrings.rb

@@ -1,251 +1,392 @@
 require 'base64'
 require 'json'
 
-class FormatError < StandardError
-  def initialize(message)
-    super(message)
+module Deckstrings
+  class FormatError < StandardError
+    def initialize(message)
+      super(message)
+    end
   end
-end
 
-class Format
-  include Enum
-  define :wild, 1, 'Wild'
-  define :standard, 2, 'Standard'
-end
+  # Enumeration of valid format types: wild and standard.
+  class Format
+    include Enum
 
-class HeroClass
-  include Enum
-  define :mage, 'mage', 'Mage'
-  define :rogue, 'rogue', 'Rogue'
-  define :druid, 'druid', 'Druid'
-  define :hunter, 'hunter', 'Hunter'
-  define :shaman, 'shaman', 'Shaman'
-  define :priest, 'priest', 'Priest'
-  define :warrior, 'warrior', 'Warrior'
-  define :paladin, 'paladin', 'Paladin'
-  define :warlock, 'warlock', 'Warlock'
-end
+    # @!scope class
+    # @return [Format] Wild format.
+    define :wild, 1, 'Wild'
 
-class Database
-  def initialize
-    file = File.expand_path('database.json', File.dirname(__FILE__))
-    @database = JSON.parse(File.read(file))
+    # @!scope class
+    # @return [Format] Standard format.
+    define :standard, 2, 'Standard'
   end
 
-  def self.instance
-    @@instance ||= Database.new
-  end
+  class HeroClass
+    include Enum
 
-  def cards
-    @cards ||= begin
-      @database['cards'].map { |k, v| [k.to_i, v] }.to_h
-    end
-  end
+    # @!scope class
+    # @return [HeroClass] Mage class.
+    define :mage, 'mage', 'Mage'
 
-  def heroes
-    @heroes ||= begin
-      @database['heroes'].map { |k, v| [k.to_i, v] }.to_h
-    end
-  end
-end
+    # @!scope class
+    # @return [HeroClass] Rogue class.
+    define :rogue, 'rogue', 'Rogue'
 
-class Hero
-  def initialize(id, name, hero_class)
-    @id = id
-    @name = name
-    @hero_class = HeroClass.parse(hero_class)
-  end
+    # @!scope class
+    # @return [HeroClass] Druid class.
+    define :druid, 'druid', 'Druid'
 
-  def self.mage
-    self.jaina
-  end
+    # @!scope class
+    # @return [HeroClass] Hunter class.
+    define :hunter, 'hunter', 'Hunter'
 
-  def self.jaina
-    self.from_id(637)
-  end
+    # @!scope class
+    # @return [HeroClass] Shaman class.
+    define :shaman, 'shaman', 'Shaman'
 
-  def self.khadgar
-    self.from_id(39117)
-  end
+    # @!scope class
+    # @return [HeroClass] Priest class.
+    define :priest, 'priest', 'Priest'
 
-  def self.rogue
-    self.valeera
-  end
+    # @!scope class
+    # @return [HeroClass] Warrior class.
+    define :warrior, 'warrior', 'Warrior'
 
-  def self.valeera
-    self.from_id(930)
-  end
+    # @!scope class
+    # @return [HeroClass] Paladin class.
+    define :paladin, 'paladin', 'Paladin'
 
-  def self.maiev
-    self.from_id(40195)
+    # @!scope class
+    # @return [HeroClass] Warlock class.
+    define :warlock, 'warlock', 'Warlock'
   end
 
-  def self.druid
-    self.malfurion
-  end
+  # @private
+  class Database
+    def initialize
+      file = File.expand_path('database.json', File.dirname(__FILE__))
+      @database = JSON.parse(File.read(file))
+    end
 
-  def self.malfurion
-    self.from_id(274)
-  end
+    def self.instance
+      @@instance ||= Database.new
+    end
 
-  def self.shaman
-    self.thrall
-  end
+    def cards
+      @cards ||= begin
+        @database['cards'].map { |k, v| [k.to_i, v] }.to_h
+      end
+    end
 
-  def self.thrall
-    self.from_id(1066)
+    def heroes
+      @heroes ||= begin
+        @database['heroes'].map { |k, v| [k.to_i, v] }.to_h
+      end
+    end
   end
 
-  def self.morgl
-    self.from_id(40183)
-  end
+  # A Hearthstone hero with basic metadata.
+  # @see Deck#heroes
+  class Hero
+    def initialize(id, name, hero_class)
+      @id = id
+      @name = name
+      @hero_class = HeroClass.parse(hero_class)
+    end
 
-  def self.priest
-    self.anduin
-  end
+    # @return [Hero] Jaina Proudmoore.
+    def self.mage
+      self.jaina
+    end
 
-  def self.anduin
-    self.from_id(813)
-  end
+    # @return [Hero] Jaina Proudmoore.
+    def self.jaina
+      self.from_id(637)
+    end
 
-  def self.tyrande
-    self.from_id(41887)
-  end
+    # @return [Hero] Khadgar.
+    def self.khadgar
+      self.from_id(39117)
+    end
 
-  def self.hunter
-    self.rexxar
-  end
+    # @return [Hero] Valeera Sanguinar.
+    def self.rogue
+      self.valeera
+    end
 
-  def self.rexxar
-    self.from_id(31)
-  end
+    # @return [Hero] Valeera Sanguinar.
+    def self.valeera
+      self.from_id(930)
+    end
 
-  def self.alleria
-    self.from_id(2826)
-  end
+    # @return [Hero] Maiev Shadowsong.
+    def self.maiev
+      self.from_id(40195)
+    end
 
-  def self.warlock
-    self.guldan
-  end
+    # @return [Hero] Malfurion Stormrage.
+    def self.druid
+      self.malfurion
+    end
 
-  def self.guldan
-    self.from_id(893)
-  end
+    # @return [Hero] Malfurion Stormrage.
+    def self.malfurion
+      self.from_id(274)
+    end
 
-  def self.paladin
-    self.uther
-  end
+    # @return [Hero] Thrall.
+    def self.shaman
+      self.thrall
+    end
 
-  def self.uther
-    self.from_id(671)
-  end
+    # @return [Hero] Thrall.
+    def self.thrall
+      self.from_id(1066)
+    end
 
-  def self.liadrin
-    self.from_id(2827)
-  end
+    # @return [Hero] Morgl the Oracle.
+    def self.morgl
+      self.from_id(40183)
+    end
 
-  def self.arthas
-    self.from_id(46116)
-  end
+    # @return [Hero] Anduin Wrynn.
+    def self.priest
+      self.anduin
+    end
 
-  def self.warrior
-    self.garrosh
-  end
+    # @return [Hero] Anduin Wrynn.
+    def self.anduin
+      self.from_id(813)
+    end
 
-  def self.garrosh
-    self.from_id(7)
-  end
+    # @return [Hero] Tyrande Whisperwind.
+    def self.tyrande
+      self.from_id(41887)
+    end
 
-  def self.magni
-    self.from_id(2828)
-  end
+    # @return [Hero] Rexxar.
+    def self.hunter
+      self.rexxar
+    end
 
-  def self.from_id(id)
-    heroes = Database.instance.heroes
-    hero = heroes[id]
-    Hero.new(id, hero['name'], hero['class'])
-  end
+    # @return [Hero] Rexxar.
+    def self.rexxar
+      self.from_id(31)
+    end
 
-  attr_reader :id, :name, :hero_class
-end
+    # @return [Hero] Alleria Windrunner.
+    def self.alleria
+      self.from_id(2826)
+    end
 
-class Card
-  def initialize(id, name, cost)
-    @id = id
-    @name = name
-    @cost = cost
-  end
+    # @return [Hero] Gul'dan.
+    def self.warlock
+      self.guldan
+    end
 
-  attr_accessor :id, :name, :cost
-end
+    # @return [Hero] Gul'dan.
+    def self.guldan
+      self.from_id(893)
+    end
+
+    # @return [Hero] Uther Lightbringer.
+    def self.paladin
+      self.uther
+    end
+
+    # @return [Hero] Uther Lightbringer.
+    def self.uther
+      self.from_id(671)
+    end
+
+    # @return [Hero] Lady Liadrin.
+    def self.liadrin
+      self.from_id(2827)
+    end
+
+    # @return [Hero] Prince Arthas.
+    def self.arthas
+      self.from_id(46116)
+    end
+
+    # @return [Hero] Garrosh Hellscream.
+    def self.warrior
+      self.garrosh
+    end
 
-class Deck
-  def initialize(format:, heroes:, cards:)
-    @format = Format.parse(format) if !format.is_a?(Format)
-    if !@format
-      raise FormatError.new("Unknown format: #{format}.")
+    # @return [Hero] Garrosh Hellscream.
+    def self.garrosh
+      self.from_id(7)
     end
 
-    @heroes = heroes.map do |id|
+    # @return [Hero] Magni Bronzebeard.
+    def self.magni
+      self.from_id(2828)
+    end
+
+    # @param id [Integer] Hero's Hearthstone DBF ID.
+    # @return [Hero] Hero corresponding to DBF ID.
+    def self.from_id(id)
       hero = Database.instance.heroes[id]
-      raise FormatError.new("Unknown hero: #{id}.") if hero.nil?
       Hero.new(id, hero['name'], hero['class'])
     end
 
-    @cards = cards.map do |id, count|
-      card = Database.instance.cards[id]
-      raise FormatError.new("Unknown card: #{id}.") if card.nil?
-      [Card.new(id, card['name'], card['cost']), count]
-    end.sort_by { |card, _| card.cost }.to_h
-  end
+    # @see https://hearthstonejson.com/ HearthstoneJSON for hero metadata.
+    # @return [Integer] Hearthstone DBF ID of the hero.
+    attr_reader :id
 
-  def deckstring
-    heroes = @heroes.map(&:id)
-    cards = @cards.map { |card, count| [card.id, count] }.to_h
-    return Deckstring.encode(format: @format.value, heroes: heroes, cards: cards)
-  end
+    # @return [String] Name of the hero.
+    attr_reader :name
 
-  def self.parse(deckstring)
-    parts = Deckstring.decode(deckstring)
-    Deck.new(parts)
+    # @return [HeroClass] Class of the hero.
+    attr_reader :hero_class
   end
 
-  def wild?
-    format == Format.wild
-  end
+  # A Hearthstone card with basic metadata.
+  # @see Deck.parse
+  class Card
+    def initialize(id, name, cost)
+      @id = id
+      @name = name
+      @cost = cost
+    end
 
-  def standard?
-    format == Format.standard
-  end
+    # @see https://hearthstonejson.com/ HearthstoneJSON for card metadata.
+    # @return [Integer] Hearthstone DBF ID of the card.
+    attr_reader :id
+
+    # @return [String] Name of the card.
+    attr_reader :name
 
-  def to_s
-    hero = @heroes.first
-    "Format: #{format}\nHero: #{hero.name} (#{hero.hero_class})\n" + cards.map do |card, count|
-      "#{count}× #{card.name}"
-    end.join("\n")
+    # @return [Integer] Mana cost of the card.
+    attr_reader :cost
   end
 
-  attr_reader :format, :heroes, :cards
-end
+  # A Hearthstone deck convertible to and from a deckstring.
+  # @see Deck.parse
+  # @see Deck#deckstring
+  class Deck
+    def initialize(format:, heroes:, cards:)
+      # TODO: Translate RangeError -> FormatError.
 
-class Deckstring
-  using VarIntExtensions
+      @format = Format.parse(format) if !format.is_a?(Format)
+      if !@format
+        raise FormatError.new("Unknown format: #{format}.")
+      end
 
-  def self.encode(format:, heroes:, cards:)
-    if format.nil?
-      # TODO
+      @heroes = heroes.map do |id|
+        hero = Database.instance.heroes[id]
+        raise FormatError.new("Unknown hero: #{id}.") if hero.nil?
+        Hero.new(id, hero['name'], hero['class'])
+      end
+
+      @cards = cards.map do |id, count|
+        card = Database.instance.cards[id]
+        raise FormatError.new("Unknown card: #{id}.") if card.nil?
+        [Card.new(id, card['name'], card['cost']), count]
+      end.sort_by { |card, _| card.cost }.to_h
     end
 
-    if heroes.nil?
-      # TODO
+    # @see .encode
+    # @see .decode
+    def raw
+      heroes = @heroes.map(&:id)
+      cards = @cards.map { |card, count| [card.id, count] }.to_h
+      { format: @format.value, heroes: heroes, cards: cards }
     end
 
-    if cards.nil?
-      # TODO
+    # @return [String] Base64-encoded compact byte string representing the deck.
+    # @see .encode
+    def deckstring
+      return Deckstrings::encode(self.raw)
     end
 
+    # @see .decode
+    # @see #deckstring
+    def self.parse(deckstring)
+      parts = Deckstrings::decode(deckstring)
+      Deck.new(parts)
+    end
+
+    # @return [Boolean] `true` if the deck is Wild format, `false` otherwise.
+    # @see #standard?
+    def wild?
+      format.wild?
+    end
+
+    # @return [Boolean] `true` if the deck is Standard format, `false` otherwise.
+    # @see #wild?
+    def standard?
+      format.standard?
+    end
+
+    # @example
+    #   Format: Standard
+    #   Class: Druid
+    #   Hero: Malfurion Stormrage
+    #
+    #   2× Innervate
+    #   2× Jade Idol
+    #   2× Wild Growth
+    #   2× Wrath
+    #   2× Jade Blossom
+    #   2× Swipe
+    #   2× Jade Spirit
+    #   1× Fandral Staghelm
+    #   1× Spellbreaker
+    #   2× Nourish
+    #   1× Big Game Hunter
+    #   2× Spreading Plague
+    #   1× The Black Knight
+    #   1× Aya Blackpaw
+    #   2× Jade Behemoth
+    #   1× Malfurion the Pestilent
+    #   1× Primordial Drake
+    #   2× Ultimate Infestation
+    #   1× Kun the Forgotten King
+    # @return [String] A pretty-printed listing of deck details.
+    def to_s
+      hero = @heroes.first
+      "Format: #{format}\nClass: #{hero.hero_class}\nHero: #{hero.name}\n\n" + cards.map do |card, count|
+        "#{count}× #{card.name}"
+      end.join("\n")
+    end
+
+    # @return [Format] Format for this deck.
+    attr_reader :format
+
+    # @return [Array<Hero>] Heroes associated with this deck. Typically, this array will contain one element.
+    attr_reader :heroes
+
+    # @return [Hash{Card => Integer}] The cards contained in the deck. A map between {Card} and the instance count in the deck.
+    attr_reader :cards
+  end
+
+  using VarIntExtensions
+
+  # Encodes a Hearthstone deck as a compact deckstring.
+  # @example
+  #   Deckstrings.encode(format: 2, heroes: [7], cards: { 44 => 1, 45 => 2 })
+  # @example
+  #   Deckstrings.encode(
+  #     format: Deckstrings::Format.standard,
+  #     heroes: [Deckstrings::Hero.warrior],
+  #     cards: { 1 => 2, 2 => 2 }
+  #   )
+  # @param format [Integer, Deckstrings::Format] Format for this deck: wild or standard.
+  # @param heroes [Array<Integer, Deckstrings::Hero>] Heroes for this deck. Multiple heroes are supported, but typically
+  #   this array will contain one element.
+  # @param cards [Hash{Integer, Deckstrings::Card => Integer}] Cards in the deck.
+  # @raise [ArgumentError] If any card counts are less than 1.
+  # @return [String] Base64-encoded compact byte string representing the deck.
+  # @see Deck#deckstring
+  # @see .decode
+  def self.encode(format:, heroes:, cards:)
     stream = StringIO.new('')
 
+    format = format.is_a?(Deckstrings::Format) ? format.value : format
+    heroes = heroes.map { |hero| hero.is_a?(Deckstrings::Hero) ? hero.id : hero }
+
     # Reserved slot, version, and format.
     stream.write_varint(0)
     stream.write_varint(1)
@@ -260,6 +401,11 @@ class Deckstring
     # Cards.
     by_count = cards.group_by { |id, n| n > 2 ? 3 : n }
 
+    invalid = by_count.keys.select { |count| count < 1 }
+    unless invalid.empty?
+      raise ArgumentError.new("Invalid card count: #{invalid.join(', ')}.")
+    end
+
     1.upto(3) do |count|
       group = by_count[count] || []
       stream.write_varint(group.length)
@@ -272,46 +418,60 @@ class Deckstring
     Base64::encode64(stream.string).strip
   end
 
+  # Decodes a Hearthstone deckstring into format, hero, and card details.
+  # @example
+  #   deck = Deckstrings::decode('AAEBAf0GAA/yAaIC3ALgBPcE+wWKBs4H2QexCMII2Q31DfoN9g4A')
+  # @example
+  #   deck = Deckstrings::decode('AAECAZICCPIF+Az5DK6rAuC7ApS9AsnHApnTAgtAX/4BxAbkCLS7Asu8As+8At2+AqDNAofOAgA=')
+  # @param deckstring [String] Base64-encoded Hearthstone deckstring.
+  # @raise [FormatError] If the deckstring is malformed or contains invalid deck data.
+  # @return [{ format: Integer, heroes: Array<Integer>, cards: Hash{Integer => Integer} }] Parsed Hearthstone deck details.
+  # @see Deck#parse
+  # @see .encode
   def self.decode(deckstring)
-    if !deckstring
-      # TODO
-    end
-
-    stream = StringIO.new(Base64::decode64(deckstring))
+    begin
+      if deckstring.nil? || deckstring.empty?
+        raise ArgumentError.new('Invalid deckstring.')
+      end
 
-    reserved = stream.read_varint
-    if reserved != 0
-      raise FormatError.new("Unexpected reserved byte: #{reserved}.")
-    end
+      stream = StringIO.new(Base64::decode64(deckstring))
 
-    version = stream.read_varint
-    if version != 1
-      raise FormatError.new("Unexpected version: #{version}.")
-    end
+      reserved = stream.read_varint
+      if reserved != 0
+        raise FormatError.new("Unexpected reserved byte: #{reserved}.")
+      end
 
-    format = stream.read_varint
+      version = stream.read_varint
+      if version != 1
+        raise FormatError.new("Unexpected version: #{version}.")
+      end
 
-    # Heroes
-    heroes = []
-    length = stream.read_varint
-    length.times do
-      heroes << stream.read_varint
-    end
+      format = stream.read_varint
 
-    # Cards
-    cards = {}
-    1.upto(3) do |i|
+      # Heroes
+      heroes = []
       length = stream.read_varint
       length.times do
-        card = stream.read_varint
-        cards[card] = i < 3 ? i : stream.read_varint
+        heroes << stream.read_varint
       end
-    end
 
-    return {
-      format: format,
-      heroes: heroes,
-      cards: cards
-    }
+      # Cards
+      cards = {}
+      1.upto(3) do |i|
+        length = stream.read_varint
+        length.times do
+          card = stream.read_varint
+          cards[card] = i < 3 ? i : stream.read_varint
+        end
+      end
+
+      return {
+        format: format,
+        heroes: heroes,
+        cards: cards
+      }
+    rescue EOFError
+      raise FormatError, 'Unexpected end of data.'
+    end
   end
 end

data/lib/deckstrings/enum.rb

@@ -1,39 +1,49 @@
-module Enum
-  def self.included(base)
-    base.extend ClassMethods
-  end
+module Deckstrings
+  module Enum
+    def self.included(base)
+      base.extend ClassMethods
+    end
 
-  module ClassMethods
-    def define(symbol, value, display = nil)
-      @@values ||= {}
-      @@values[value] = instance = self.new(symbol, value, display)
-      self.class.send :define_method, symbol do
-        instance
+    # @private
+    module ClassMethods
+      def define(symbol, value, display = nil)
+        @@values ||= {}
+        @@values[value] = instance = self.new(symbol, value, display)
+        self.class.send :define_method, symbol do
+          instance
+        end
+        self.send :define_method, "#{symbol}?".to_sym do
+          @symbol == symbol
+        end
       end
-    end
 
-    def parse(value)
-      enum = @@values[value]
-      raise RangeError.new("Unknown value: #{value}.") if !enum
-      enum
+      def parse(value)
+        enum = @@values[value]
+        raise RangeError.new("Unknown value: #{value}.") if !enum
+        enum
+      end
     end
-  end
 
-  def initialize(symbol, value, display)
-    @symbol = symbol
-    @value = value
-    @display = display
-  end
+    # @private
+    def initialize(symbol, value, display)
+      @symbol = symbol
+      @value = value
+      @display = display
+    end
 
-  def to_s
-    @display || @symbol.to_s
-  end
+    # @return [String] A string description of this enum instance.
+    def to_s
+      @display || @symbol.to_s
+    end
 
-  def symbol
-    @symbol
-  end
+    # @return [Symbol] The unique symbol for this enum instance.
+    def symbol
+      @symbol
+    end
 
-  def value
-    @value
+    # @return [Integer, String, Object] The parseable value for this enum instance.
+    def value
+      @value
+    end
   end
 end

data/lib/deckstrings/varint.rb

@@ -1,29 +1,32 @@
-module VarIntExtensions
-  refine StringIO do
-    def read_varint
-      num = 0
-      shift = 0
-      loop do
-        octet = self.getbyte
-        raise FormatError.new('Unexpected end of data.') if octet.nil?
+module Deckstrings
+  # @private
+  module VarIntExtensions
+    refine StringIO do
+      def read_varint
+        num = 0
+        shift = 0
+        loop do
+          octet = self.getbyte
+          raise EOFError.new('Unexpected end of data.') if octet.nil?
 
-        num |= (octet & 0x7f) << shift
-        return num if octet & 0x80 == 0
-        shift += 7
+          num |= (octet & 0x7f) << shift
+          return num if octet & 0x80 == 0
+          shift += 7
+        end
       end
-    end
 
-    def write_varint(num)
-      octets = []
-      loop do
-        octet = num & 0x7f
-        if (num >>= 7) > 0
-          octet |= 0x80
-          octets << (octet | 0x80)
-        else
-          octets << octet
-          self.write(octets.pack('C*'))
-          return
+      def write_varint(num)
+        octets = []
+        loop do
+          octet = num & 0x7f
+          if (num >>= 7) > 0
+            octet |= 0x80
+            octets << (octet | 0x80)
+          else
+            octets << octet
+            self.write(octets.pack('C*'))
+            return
+          end
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deckstrings
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Chris Schmich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-06 00:00:00.000000000 Z
+date: 2017-09-15 00:00:00.000000000 Z
 dependencies: []
 description: Ruby library for encoding and decoding Hearthstone deckstrings.
 email: schmch@gmail.com
@@ -17,12 +17,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
+- README.md
 - lib/deckstrings.rb
 - lib/deckstrings/database.json
 - lib/deckstrings/deckstrings.rb
 - lib/deckstrings/enum.rb
 - lib/deckstrings/varint.rb
-- lib/deckstrings/version.rb
 homepage: https://github.com/schmich/hearthstone-deckstrings
 licenses:
 - MIT
@@ -35,7 +35,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/deckstrings/version.rb

@@ -1,3 +0,0 @@
-module Deckstrings
-  VERSION = '0.0.1'
-end