runeterra_cards 0.4.1 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13de26db2b79d60bca9fce39d36d3d82fcaaa19fbcdae3dc2c6f34c785253d91
-  data.tar.gz: 061a9c9e56f751fc2451166af0e9b27f415c4b9293b1ac1d0dc58df714a46a6b
+  metadata.gz: a1e0528d970e63dfad42a4f65e907f76cc966bc5da298de031bb8b0903870ebe
+  data.tar.gz: 4546f417aeea04a3dd767d959603670235a8fe0f382e4a6a15a61fe726d09e49
 SHA512:
-  metadata.gz: cde13398e27b94c917c74efb2cedf4fa82c3af5b8cc7e2da4a19af959176bf24703574170718d17ace331cf20e23b019001150fdd12a90a81688cd2f17f186c3
-  data.tar.gz: 18d73970af5591a2f65ccf9ba4739800d1025f042499416ed5e2ccd6b5ad33797c3b4640bd7b89dd99600b1a4f2a3bc0f641be0499d392ad56385ec53318dc22
+  metadata.gz: 6fe77c6a6ca5c0f7c40c2f75678737f44ac4a6d3d5f120ffd2b55228462e1ebdb3963a1cdfc965d0569e252c5df7b7b9721f8b52810eb7f5fabb3fd9372719cf
+  data.tar.gz: 7686da5bfecde6a4322cff7989f25c3668c776e4185870231f39cfb998ac72c99d44c24d8383234189c6f876cbdd12d4ba283bf049b0e9982815b22fbf4575ea

data/doc/CHANGELOG.md

@@ -4,11 +4,44 @@ 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.6.1] - 2022-04-30
+### Added
+
+- Documented which versions of Ruby are officially supported:
+  - Ruby: 2.6, 2.7, 3.0, 3.1
+  - JRuby: 9.3
+  - TruffleRuby: 20, 21, 22
+
+### Fixed
+
+- Various scenarios where invalid deck codes would produce unhelpful exceptions now raise a `DeckCodeParseError` instead.
+
+## [0.6.0] - 2021-08-25
+### Added
+- Support for the Bandle City faction.
+- Support for version 4 deck codes.
+
+## [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,15 +9,23 @@ 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.6.1'
 ```
 
 Or, if you're building a Gem, your `.gemspec`:
 
 ```
-  spec.add_dependency 'runeterra_cards', '~> 0.4.1'
+  spec.add_dependency 'runeterra_cards', '~> 0.6.1'
 ```
 
+### Ruby version support
+
+* Ruby: 2.6, 2.7, 3.0, 3.1
+* JRuby: 9.3 only
+* TruffleRuby: 20, 21, 22
+
+Note that only Linux and Windows are included in automated testing, although other platforms are expected to work. Also note that truffleruby compatibility is not tested on Windows.
+
 ## Updates & Versioning
 
 This library will conform to [semantic versioning](https://semver.org/) once it hits 1.0. In the meantime, you can rely on the minor version (Y in x.Y.z) being bumped for backwards-incompatible changes.

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

@@ -1,22 +1,18 @@
 # frozen_string_literal: true
 
 module RuneterraCards
-  # Represents a card and how many of that card are in a collection.
-  # @deprecated
-  class CardAndCount
+  # Represents a card.
+  #
+  # @todo: add getters for set, faction, card number
+  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 +23,23 @@ module RuneterraCards
         padded_card_number = format('%<i>03d', i: card_number)
         @code = "#{padded_set}#{faction}#{padded_card_number}"
       end
-      @count = count
     end
 
-    #:nodoc:
+    # Returns +true+ if _this_ and _other_ both have the same card code.
+    #
+    # @param other [Card]
+    # @return [Boolean]
     def eql?(other)
-      code.eql?(other.code) && count.equal?(other.count)
+      code.eql?(other.code)
     end
 
-    #:nodoc:
+    # Compute a hash code for this card. Two cards with the same card code will have the same hash code (and will
+    # compare using {#eql?}).
+    #
+    # @see Object#hash.
+    # @return [Integer]
     def hash
-      [code, count].hash
+      code.hash
     end
   end
 end

data/lib/runeterra_cards/card_set.rb

@@ -6,20 +6,21 @@ module RuneterraCards
   # Represents a collection of cards.
   #
   # @todo The API to this class is very unstable and will change a lot in a coming release.
+  # @todo add #== !
   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}
@@ -28,21 +29,28 @@ module RuneterraCards
       remaining_cards =
         cards.each_with_object({}) do |(code, count), result|
           new_count = count - other.count_for_card_code(code)
-          result[code] = new_count unless new_count.equal?(0)
+          result[code] = new_count unless new_count.eql?(0)
         end
 
       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
@@ -60,12 +68,12 @@ module RuneterraCards
 
       raise UnrecognizedVersionError.new(SUPPORTED_VERSION, version) unless version <= SUPPORTED_VERSION
 
-      raise unless format.equal? 1
+      raise unless format.eql? 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,15 +102,16 @@ 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
+        set_faction_combination_count = shift_and_check(array)
         set_faction_combination_count.times.flat_map do
-          number_of_cards, set, faction = array.shift(3)
+          number_of_cards, set, faction = shift_and_check(array, 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)
+          shift_and_check(array, number_of_cards).map do |card_number|
+            cac = Card.new(set: set, faction_number: faction, card_number: card_number)
+            [cac.code, number_of_copies]
           end
         end
       end
@@ -110,10 +119,30 @@ module RuneterraCards
 
     private_class_method :assemble_card_list
 
+    # Like Array#shift but checks that the number of items requested was
+    #   actually retrieved, errors otherwise.
+    # @param [Array<T>] array Array to shift one or more values from
+    # @param [Integer] count Number of items to shift from the array (default 1)
+    # @return [Array<T>,T]
+    # @raise [DeckCodeParseError]
+    def self.shift_and_check(array, count=nil)
+      if count
+        raise DeckCodeParseError if array.length < count
+
+        array.shift(count)
+      else
+        raise DeckCodeParseError if array.empty?
+
+        array.shift
+      end
+    end
+
+    private_class_method :shift_and_check
+
     # @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 +151,6 @@ module RuneterraCards
       end
     end
 
-    private_class_method :unpack_uleb128
+    private_class_method :unpack_big_endian_varint
   end
 end

data/lib/runeterra_cards/cost.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+# @todo could be more obvious what's wrong when you call == on the wrong class e.g. a number
 module RuneterraCards
   # Represents the cost of a {CardSet}, as wildcards or shards.
   # To get the cost of a {CardSet} you need to call {Metadata#cost_of}, as rarity (and therefore cost) is a property
@@ -54,10 +55,10 @@ module RuneterraCards
     # The number of shards needed. I.e. the equivalent amount of shards for all these wildcards.
     # @return [Fixnum] shards
     def shards
-      common * 100 +
-        rare * 300 +
-        epic * 1200 +
-        champion * 3000
+      (common * 100) +
+        (rare * 300) +
+        (epic * 1200) +
+        (champion * 3000)
     end
 
     # Whether this Cost is equal to another. Equality means exactly the same number of each wildcard, not just the
@@ -65,10 +66,10 @@ module RuneterraCards
     # @param [Cost] other an object that response to {#common}, {#rare}, {#epic}, and {#champion}.
     # @return [Boolean] equal?
     def ==(other)
-      common.equal?(other.common) &&
-        rare.equal?(other.rare) &&
-        epic.equal?(other.epic) &&
-        champion.equal?(other.champion)
+      common.eql?(other.common) &&
+        rare.eql?(other.rare) &&
+        epic.eql?(other.epic) &&
+        champion.eql?(other.champion)
     end
 
     # Subtracts another Cost from this one. Subtraction is performed by subtracting each wildcard type individually,

data/lib/runeterra_cards/factions.rb

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

data/lib/runeterra_cards/metadata.rb

@@ -33,7 +33,7 @@ module RuneterraCards
       data = JSON.parse(file)
       data.each do |card_data|
         card = CardMetadata.new(card_data)
-        @cards[card.card_code] = card
+        @cards[card.card_code] = card # TODO: warn or error if there are duplicate card codes!
       end
     end
 

data/lib/runeterra_cards/version.rb

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

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 = 4
   public_constant :SUPPORTED_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.6.1
 platform: ruby
 authors:
 - James "zofrex" Sanderson
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-05 00:00:00.000000000 Z
+date: 2022-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base32
@@ -24,34 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.3.2
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: deep-cover
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 13.0.1
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.1
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -142,14 +128,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.1
+        version: 0.15.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.1
+        version: 0.15.2
 - !ruby/object:Gem::Dependency
   name: rubocop-packaging
   requirement: !ruby/object:Gem::Requirement
@@ -204,7 +190,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 +198,7 @@ files:
 - lib/runeterra_cards/factions.rb
 - lib/runeterra_cards/metadata.rb
 - lib/runeterra_cards/version.rb
-homepage: 
+homepage:
 licenses:
 - MIT
 metadata:
@@ -220,7 +206,8 @@ 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: 
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -235,8 +222,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Legends of Runeterra deck code decoder & Data Dragon card data loader.
 test_files: []