runeterra_cards 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13de26db2b79d60bca9fce39d36d3d82fcaaa19fbcdae3dc2c6f34c785253d91
-  data.tar.gz: 061a9c9e56f751fc2451166af0e9b27f415c4b9293b1ac1d0dc58df714a46a6b
+  metadata.gz: 143a6e1907badc2fc066202446fa5106a8ddfda903e195b4fadd2a8c45fcc824
+  data.tar.gz: '0669ded1c45362335feddb5f5f8846407f61a85a04a458877fb728ace2a99cc1'
 SHA512:
-  metadata.gz: cde13398e27b94c917c74efb2cedf4fa82c3af5b8cc7e2da4a19af959176bf24703574170718d17ace331cf20e23b019001150fdd12a90a81688cd2f17f186c3
-  data.tar.gz: 18d73970af5591a2f65ccf9ba4739800d1025f042499416ed5e2ccd6b5ad33797c3b4640bd7b89dd99600b1a4f2a3bc0f641be0499d392ad56385ec53318dc22
+  metadata.gz: 88a8a01c7a0971da6c084210bbd0b5121add3faf6dd5b28ac12c1235ad5023adeda8729af3fe8b96479a895aab48769a87b81dddabe9d662cc15514cf003ebe6
+  data.tar.gz: 289070859e22694e9014fad41b6fce31a867489541080644c4a98adee6fa87afa653a08ea68cdbe536af3fe3a9875386b508e0f73d0b1301f98152cf3d5203fd

data/doc/CHANGELOG.md

@@ -4,11 +4,27 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.5.0] - 2021-03-05
+### Added
+- Support for the Shurima faction.
+- Support for version 3 deck codes.
+- A new Card class to represent cards on their own without a count.
+- CardSet#as_cards, which returns all the cards in the set as Cards.
+- CardSet#as_card_codes, which returns all the cards in the set as card codes.
+
+### Removed
+- RuneterraCards.from_card_and_counts method.
+- CardAndCount class (replaced by the new Card class).
+- CardSet#as_card_and_counts (replaced by #as_cards).
+
+### Deprecated
+- CardSet#cards – the signature of this method will be changing in a future version to match #as_cards, migrate to #as_card_codes to keep the current #cards behaviour.
+
 ## [0.4.1] - 2021-02-05
+### Fixed
 
-Fixed
+- Fixed issue where card numbers > 127 came out extremely wrong, e.g. Aphelios and several other of the new cards ([issue #4](https://github.com/zofrex/runeterra_cards/issues/4)).
 
-- Fixed issue where card numbers > 127 came out extremely wrong, e.g. Aphelios and several other of the new cards ([issue #4](https://github.com/zofrex/runeterra_cards/issues/4))
 ## [0.4.0] - 2020-12-08
 ### Added
 - [`CardMetadata` now has a `#cost` attribute representing the mana cost of a card.](https://github.com/zofrex/runeterra_cards/pull/3) (thanks, [nieszkah](https://github.com/alpm)!) Technically this is backwards-compatibility breaking as it makes a new field in metadata json mandatory.

data/doc/README.md

@@ -9,13 +9,13 @@ This library makes it easy to decode Legends of Runeterra deck codes, load Data
 Add the following to your `Gemfile`:
 
 ```
-gem 'runeterra_cards', '~> 0.4.1'
+gem 'runeterra_cards', '~> 0.5.0'
 ```
 
 Or, if you're building a Gem, your `.gemspec`:
 
 ```
-  spec.add_dependency 'runeterra_cards', '~> 0.4.1'
+  spec.add_dependency 'runeterra_cards', '~> 0.5.0'
 ```
 
 ## Updates & Versioning

data/lib/runeterra_cards.rb

@@ -3,7 +3,7 @@
 require 'runeterra_cards/version'
 require 'runeterra_cards/errors'
 require 'runeterra_cards/factions'
-require 'runeterra_cards/card_and_count'
+require 'runeterra_cards/card'
 require 'runeterra_cards/card_metadata'
 require 'runeterra_cards/metadata'
 require 'runeterra_cards/card_set'
@@ -16,6 +16,6 @@ require 'runeterra_cards/cost'
 # You might also want to check out the {file:doc/README.md} and the {file:doc/CHANGELOG.md}.
 module RuneterraCards
   # The version of deck encoding supported
-  SUPPORTED_VERSION = 2
+  SUPPORTED_VERSION = 3
   public_constant :SUPPORTED_VERSION
 end

data/lib/runeterra_cards/{card_and_count.rb → card.rb}

@@ -1,22 +1,17 @@
 # frozen_string_literal: true
 
 module RuneterraCards
-  # Represents a card and how many of that card are in a collection.
+  # Represents a card
   # @deprecated
-  class CardAndCount
+  class Card
     # The card code, for example "01DE123"
     # @return [String]
     attr_reader :code
 
-    # How many of this card are in a collection (between 1-3).
-    # @return [Fixnum]
-    attr_reader :count
-
     # @param set [Fixnum]
     # @param faction_number [Fixnum]
     # @param card_number [Fixnum]
-    # @param count [Fixnum]
-    def initialize(count:, code: nil, set: nil, faction_number: nil, card_number: nil)
+    def initialize(code: nil, set: nil, faction_number: nil, card_number: nil)
       if code
         raise if set || faction_number || card_number
 
@@ -27,17 +22,16 @@ module RuneterraCards
         padded_card_number = format('%<i>03d', i: card_number)
         @code = "#{padded_set}#{faction}#{padded_card_number}"
       end
-      @count = count
     end
 
     #:nodoc:
     def eql?(other)
-      code.eql?(other.code) && count.equal?(other.count)
+      code.eql?(other.code)
     end
 
     #:nodoc:
     def hash
-      [code, count].hash
+      code.hash
     end
   end
 end

data/lib/runeterra_cards/card_set.rb

@@ -7,19 +7,19 @@ module RuneterraCards
   #
   # @todo The API to this class is very unstable and will change a lot in a coming release.
   class CardSet
-    # @return [Hash<String,Fixnum>]
+    # Extract this bitmask so Mutant can't see it, until this fix is released https://github.com/mbj/mutant/pull/1218
+    HIGH_BIT = 0b1000_0000
+    private_constant :HIGH_BIT
+
+    # @return [Hash{String => Number}]
+    # @deprecated
     attr_reader :cards
 
-    # @param [Hash<String,Fixnum>] cards A Hash of card codes mapping to card counts
+    # @param [Hash{String => Number},Enumerable{String => Number}] cards A Hash of card codes mapping to card counts
     def initialize(cards)
       @cards = cards
     end
 
-    # @deprecated
-    def self.from_card_and_counts(set)
-      new(Hash[set.map { |cac| [cac.code, cac.count] }])
-    end
-
     # Subtract another {CardSet CardSet} from this one. Items with count 0 are not represented in the returned
     # {CardSet CardSet}, they are removed altogether.
     # @param [CardSet] other An object that responds to {#count_for_card_code}
@@ -34,15 +34,22 @@ module RuneterraCards
       CardSet.new(remaining_cards)
     end
 
-    # @return [Enumerator<CardAndCount>]
-    # @deprecated
-    def as_card_and_counts
-      cards.map { |code, count| CardAndCount.new(code: code, count: count) }
+    # @return [Enumerable<Card => Number>]
+    def as_cards
+      cards.transform_keys { |code| Card.new(code: code) }
+    end
+
+    # Return all cards in the card set as a map of card codes to counts.
+    # @example
+    #   set.as_card_codes #=> { '01DE044' => 1, '02NX003' => 2 }
+    # @return [Enumerable<String => Number>]
+    def as_card_codes
+      cards
     end
 
     # Returns how many of the given card are in this CardSet.
     # @param [String] code Card code, e.g. "01DE031"
-    # @return [Fixnum] How many of the card are in this CardSet, or 0 if it isn't present.
+    # @return [Integer] How many of the card are in this CardSet, or 0 if it isn't present.
     def count_for_card_code(code)
       cards[code] || 0
     end
@@ -62,10 +69,10 @@ module RuneterraCards
 
       raise unless format.equal? 1
 
-      int_array = unpack_uleb128(binary_data[1..])
+      int_array = unpack_big_endian_varint(binary_data[1..])
       cards = assemble_card_list(int_array)
 
-      from_card_and_counts(cards)
+      new(cards.to_h)
     end
 
     # @param string [String] base32-encoded string
@@ -94,7 +101,7 @@ module RuneterraCards
     private_class_method :decode_format_and_version
 
     # @param [Array<Fixnum>] array
-    # @return [Array<CardAndCount>]
+    # @return [Array<Card>]
     def self.assemble_card_list(array)
       3.downto(1).flat_map do |number_of_copies|
         set_faction_combination_count = array.shift
@@ -102,7 +109,8 @@ module RuneterraCards
           number_of_cards, set, faction = array.shift(3)
 
           array.shift(number_of_cards).map do |card_number|
-            CardAndCount.new(set: set, faction_number: faction, card_number: card_number, count: number_of_copies)
+            cac = Card.new(set: set, faction_number: faction, card_number: card_number)
+            [cac.code, number_of_copies]
           end
         end
       end
@@ -112,8 +120,8 @@ module RuneterraCards
 
     # @param [String] binary
     # @return [Enumerable<Fixnum>]
-    def self.unpack_uleb128(binary)
-      binary.each_byte.slice_after { |b| (b & 0b1000_0000).zero? }.map do |int_bytes|
+    def self.unpack_big_endian_varint(binary)
+      binary.each_byte.slice_after { |b| (b & HIGH_BIT).zero? }.map do |int_bytes|
         acc = 0
         int_bytes.each_with_index do |byte, index|
           acc += (byte & 0b0111_1111) << (7 * index)
@@ -122,6 +130,6 @@ module RuneterraCards
       end
     end
 
-    private_class_method :unpack_uleb128
+    private_class_method :unpack_big_endian_varint
   end
 end

data/lib/runeterra_cards/factions.rb

@@ -13,6 +13,7 @@ module RuneterraCards
     4 => 'PZ',
     5 => 'SI',
     6 => 'BW',
+    7 => 'SH',
     9 => 'MT',
   }.freeze
   public_constant :FACTION_IDENTIFIERS_FROM_INT
@@ -29,6 +30,7 @@ module RuneterraCards
     'PZ' => 4,
     'SI' => 5,
     'BW' => 6,
+    'SH' => 7,
     'MT' => 9,
   }.freeze
   public_constant :FACTION_INTS_FROM_IDENTIFIER

data/lib/runeterra_cards/version.rb

@@ -2,6 +2,6 @@
 
 module RuneterraCards
   # The version of this library
-  VERSION = '0.4.1'
+  VERSION = '0.5.0'
   public_constant :VERSION
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: runeterra_cards
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - James "zofrex" Sanderson
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-05 00:00:00.000000000 Z
+date: 2021-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base32
@@ -204,7 +204,7 @@ files:
 - doc/CHANGELOG.md
 - doc/README.md
 - lib/runeterra_cards.rb
-- lib/runeterra_cards/card_and_count.rb
+- lib/runeterra_cards/card.rb
 - lib/runeterra_cards/card_metadata.rb
 - lib/runeterra_cards/card_set.rb
 - lib/runeterra_cards/cost.rb
@@ -212,7 +212,7 @@ files:
 - lib/runeterra_cards/factions.rb
 - lib/runeterra_cards/metadata.rb
 - lib/runeterra_cards/version.rb
-homepage: 
+homepage:
 licenses:
 - MIT
 metadata:
@@ -220,7 +220,7 @@ metadata:
   changelog_uri: https://www.rubydoc.info/gems/runeterra_cards/file/doc/CHANGELOG.md
   source_code_uri: https://github.com/zofrex/runeterra_cards
   documentation_uri: https://www.rubydoc.info/gems/runeterra_cards/
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -236,7 +236,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.4
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Legends of Runeterra deck code decoder & Data Dragon card data loader.
 test_files: []