runeterra_cards 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 143a6e1907badc2fc066202446fa5106a8ddfda903e195b4fadd2a8c45fcc824
-  data.tar.gz: '0669ded1c45362335feddb5f5f8846407f61a85a04a458877fb728ace2a99cc1'
+  metadata.gz: 353f87a2a2c4e5d16342a19e52f9ae679b9e7e046a7136d6149a54394bc8aec0
+  data.tar.gz: 3b2bdacf5d4bf409f973a8717e4c1891b870bb2ef5d91c68d945a3a74ad3494a
 SHA512:
-  metadata.gz: 88a8a01c7a0971da6c084210bbd0b5121add3faf6dd5b28ac12c1235ad5023adeda8729af3fe8b96479a895aab48769a87b81dddabe9d662cc15514cf003ebe6
-  data.tar.gz: 289070859e22694e9014fad41b6fce31a867489541080644c4a98adee6fa87afa653a08ea68cdbe536af3fe3a9875386b508e0f73d0b1301f98152cf3d5203fd
+  metadata.gz: ff27c6e2bbd96d649b56296cd85a83e221aabb6ab8cee984e37e8ef86802e11ebf86e792163deb467647b1af0b8aec4ac37d1d259f0a22fc87ec919886fbd7c8
+  data.tar.gz: 320369b766faa12a6b9b2236fab749d5c1297ffa5cbb52323e29976e98709c8a388513a34af69b49458b62c2c78c467035672097b43e4c9049a908fb026ea6d5

data/doc/CHANGELOG.md

@@ -4,6 +4,29 @@ 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.7.0] - 2022-05-26
+### Added
+
+- Support for the Runeterra faction.
+- Support for version 5 deck codes.
+
+## [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.

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.5.0'
+gem 'runeterra_cards', '~> 0.7.0'
 ```
 
 Or, if you're building a Gem, your `.gemspec`:
 
 ```
-  spec.add_dependency 'runeterra_cards', '~> 0.5.0'
+  spec.add_dependency 'runeterra_cards', '~> 0.7.0'
 ```
 
+### 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.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
 module RuneterraCards
-  # Represents a card
-  # @deprecated
+  # Represents a card.
+  #
+  # @todo: add getters for set, faction, card number
   class Card
     # The card code, for example "01DE123"
     # @return [String]
@@ -24,12 +25,19 @@ module RuneterraCards
       end
     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)
     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.hash
     end

data/lib/runeterra_cards/card_set.rb

@@ -6,6 +6,7 @@ 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
     # 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
@@ -28,7 +29,7 @@ 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)
@@ -67,7 +68,7 @@ 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_big_endian_varint(binary_data[1..])
       cards = assemble_card_list(int_array)
@@ -104,11 +105,11 @@ module RuneterraCards
     # @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|
+          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
@@ -118,6 +119,26 @@ 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_big_endian_varint(binary)

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

@@ -15,6 +15,8 @@ module RuneterraCards
     6 => 'BW',
     7 => 'SH',
     9 => 'MT',
+    10 => 'BC',
+    12 => 'RU',
   }.freeze
   public_constant :FACTION_IDENTIFIERS_FROM_INT
 
@@ -32,6 +34,8 @@ module RuneterraCards
     'BW' => 6,
     'SH' => 7,
     'MT' => 9,
+    'BC' => 10,
+    'RU' => 12,
   }.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.5.0'
+  VERSION = '0.7.0'
   public_constant :VERSION
 end

data/lib/runeterra_cards.rb

@@ -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 = 3
+  SUPPORTED_VERSION = 5
   public_constant :SUPPORTED_VERSION
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: runeterra_cards
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - James "zofrex" Sanderson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-05 00:00:00.000000000 Z
+date: 2022-05-26 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
@@ -220,6 +206,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/
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -235,7 +222,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Legends of Runeterra deck code decoder & Data Dragon card data loader.