runeterra_cards 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 275e8ca4e8362b65da7022dc3042e9fbe3b0970f52443e652476757be52125f1
+  data.tar.gz: ab803e005acf47f9499aad38aaad76d0e1c59c275dc4457bc8735208f08baace
+SHA512:
+  metadata.gz: f406aad97cd4b6b57b356f08ff665661d3edecd608467b0a04b2c76d434927bc406cd01fec7f02aa171701f0a0f89fd2e322de7cbc871d18cb58993c9ae4d9e3
+  data.tar.gz: 96023313de8c2868fbf551185224a9441a13e30ddb297f9766b69b07481f4d21c1a56b78052ec09ba3a5aa22878c39f1c94ef196a235838b5cc447bb08255d96

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 James 'zofrex' Sanderson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/lib/runeterra_cards.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'runeterra_cards/version'
+require 'runeterra_cards/errors'
+require 'runeterra_cards/factions'
+require 'runeterra_cards/card_and_count'
+require 'runeterra_cards/card_metadata'
+require 'runeterra_cards/metadata'
+require 'runeterra_cards/card_set'
+
+module RuneterraCards
+  # The version of deck encoding supported
+  SUPPORTED_VERSION = 2
+end

data/lib/runeterra_cards/card_and_count.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module RuneterraCards
+  # Represents a card and how many of that card are in a collection.
+  # @deprecated
+  class CardAndCount
+    # 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(code: nil, count:, set: nil, faction_number: nil, card_number: nil)
+      if code
+        raise if set || faction_number || card_number
+
+        @code = code
+      else
+        padded_set = format('%<i>02d', i: set)
+        faction = FACTION_IDENTIFIERS_FROM_INT.fetch(faction_number)
+        padded_card_number = format('%<i>03d', i: card_number)
+        @code = "#{padded_set}#{faction}#{padded_card_number}"
+      end
+      @count = count
+    end
+
+    def eql?(other)
+      code.eql?(other.code) && count.equal?(other.count)
+    end
+
+    def hash
+      [code, count].hash
+    end
+  end
+end

data/lib/runeterra_cards/card_metadata.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module RuneterraCards
+  # Represents metadata for a single card. Metadata is all meaning the game imbues upon a card code, including things
+  # like cost, health, etc and also localised information such as name and description.
+  #
+  # Currently this class only represents a thin sliver of metadata as required by its downstream consumers.
+  #
+  # @see CardAndCount
+  class CardMetadata
+    RARITIES = {
+      'None' => :none,
+      'Common' => :common,
+      'Rare' => :rare,
+      'Epic' => :epic,
+      'Champion' => :champion,
+    }.freeze
+    private_constant :RARITIES
+
+    # Returns the name attribute. The name is the localised name that the card would have in game.
+    # For example: "House Spider".
+    # @return [String]
+    attr_reader :name
+
+    # Returns the card_code attribute. For example: "01NX055".
+    # @return [String]
+    attr_reader :card_code
+
+    # Returns the card's rarity as a symbol. Can be one of: +:none+, +:common+, +:rare+, +:epic+, or +:champion+
+    # @return [Symbol]
+    attr_reader :rarity
+
+    # Creates a single {CardMetadata} Object from the supplied Hash of data.
+    # This is intended for use with the data files from Legends of Runeterra Data Dragon, and it expects a Hash
+    # representing a single card from the parsed JSON data files from Data Dragon.
+    #
+    # @param hash [Hash] Card data from Legends of Runeterra Data Dragon
+    # @option hash [String] name
+    # @option hash [String] cardCode
+    # @option hash [Boolean] collectible
+    #
+    # @raise [MissingCardDataError] if any of the expected hash parameters are missing, or if +rarityRef+ contains an
+    #   unexpected value.
+    def initialize(hash)
+      begin
+        @name, @card_code, @collectible, rarity_ref = hash.fetch_values('name', 'cardCode', 'collectible', 'rarityRef')
+      rescue KeyError => e
+        raise MetadataLoadError.new(hash['name'] || hash['cardCode'], "Missing expected key: #{e.key}")
+      end
+
+      @rarity = RARITIES[rarity_ref]
+      return unless rarity.nil?
+
+      raise MetadataLoadError.new(name, "Invalid value for rarityRef, got: #{rarity_ref}, "\
+"expected one of: #{RARITIES.keys.join ', '}")
+    end
+
+    # Whether or not the card is collectible.
+    def collectible?
+      @collectible
+    end
+  end
+end

data/lib/runeterra_cards/card_set.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require 'base32'
+
+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.
+  class CardSet
+    attr_reader :cards
+
+    def initialize(cards)
+      @cards = cards
+    end
+
+    # @deprecated
+    def self.from_card_and_counts(set)
+      new(Hash[set.map { |cac| [cac.code, cac.count] }])
+    end
+
+    def -(other)
+      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)
+      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) }
+    end
+
+    def count_for_card_code(code)
+      cards[code] || 0
+    end
+
+    # @param deck_code [String]
+    # @raise [Base32Error] if the deck code cannot be Base32 decoded.
+    # @raise [UnrecognizedVersionError] if the deck code's version is not supported by this library
+    #   (see {SUPPORTED_VERSION}).
+    # @raise [EmptyInputError] if the deck code is an empty string.
+    def self.from_deck_code(deck_code)
+      binary_data = decode_base32(deck_code)
+      format, version = decode_format_and_version(binary_data[0])
+
+      raise UnrecognizedVersionError.new(SUPPORTED_VERSION, version) unless version <= SUPPORTED_VERSION
+
+      raise unless format.equal? 1
+
+      int_array = binary_data[1..].unpack('w*')
+      cards = assemble_card_list(int_array)
+      from_card_and_counts(cards)
+    end
+
+    # @param string [String] base32-encoded string
+    # @return [String] binary data
+    def self.decode_base32(string)
+      raise EmptyInputError if string.empty?
+
+      begin
+        Base32.decode(string)
+      rescue StandardError
+        raise Base32Error
+      end
+    end
+
+    private_class_method :decode_base32
+
+    # @param byte [String] a single byte
+    # @return [FixNum] format and version, in that order
+    def self.decode_format_and_version(byte)
+      format_and_version = byte.unpack1('C')
+      format = format_and_version >> 4
+      version = format_and_version & 0xF
+      [format, version]
+    end
+
+    private_class_method :decode_format_and_version
+
+    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.times.flat_map do
+          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)
+          end
+        end
+      end
+    end
+
+    private_class_method :assemble_card_list
+  end
+end

data/lib/runeterra_cards/errors.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module RuneterraCards
+  # The base exception for errors that occur when decoding a deck code
+  class DeckCodeParseError < StandardError
+  end
+
+  # This exception is raised if the deck code cannot be Base32-decoded. This probably means it isn't a deck code, or
+  # got malformed somehow.
+  class Base32Error < DeckCodeParseError
+    def initialize
+      super('Encountered an error while Base32 decoding deck code.' \
+        ' Probably an invalid deck code, or possibly a bug in the Base32 handling.')
+    end
+  end
+
+  # This exception is raised if the deck code is an empty string.
+  class EmptyInputError < DeckCodeParseError
+    def initialize
+      super('The input was an empty string')
+    end
+  end
+
+  # This exception is raised if the deck code version number in the deck code is not one we can handle. This could mean
+  # this isn't a deck code (especially if the version number is very different to the one expected), or it could mean
+  # Riot has updated the deck code version and you need to update this library.
+  #
+  # If updating this library fails to resolve the issue, and  you are sure this is a deck code, check GitHub for an
+  # issue relating to this. If none exists, then file one!
+  # @see SUPPORTED_VERSION
+  class UnrecognizedVersionError < DeckCodeParseError
+    def initialize(expected, got)
+      super("Unrecognized deck code version number: #{got}, was expecting: #{expected}. \
+Possibly an invalid deck code, possibly you need to update the deck code library version.")
+    end
+  end
+
+  # This exception is raised if you try to parse data from Runeterra Data Dragon that is not in the expected form.
+  # The message will tell you what data was not right, and the {#card} attribute will tell you which card had issues,
+  # if possible.
+  #
+  # @see CardMetadata#initialize
+  class MetadataLoadError < StandardError
+    # Return the name or card code of the card that was missing an expected attribute.
+    # @return [String] name if the name was present
+    # @return [String] card code if the name was not present
+    # @return [nil] if neither name nor card code were present
+    attr_reader :card
+
+    def initialize(card, problem)
+      if card.nil?
+        super("Error loading data for unknown card (no code or name): #{problem}")
+      else
+        super("Error loading data for card #{card}: #{problem}")
+      end
+      @card = card
+    end
+  end
+end

data/lib/runeterra_cards/factions.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module RuneterraCards
+  # An array of the two-letter Faction identifiers, indexed by their integer identifiers
+  # @example
+  #   FACTION_IDENTIFIERS_FROM_INT[2] #=> "IO"
+  # @return [Array<String>]
+  FACTION_IDENTIFIERS_FROM_INT = %w[DE FR IO NX PZ SI BW].freeze
+
+  # A map from two-letter Faction identifiers to their integer identifiers
+  # @example
+  #   FACTION_INTS_FROM_IDENTIFIER["IO"] #=> 2
+  # @return [Hash<String,Fixnum>]
+  FACTION_INTS_FROM_IDENTIFIER = {
+    'DE' => 0,
+    'FR' => 1,
+    'IO' => 2,
+    'NX' => 3,
+    'PZ' => 4,
+    'SI' => 5,
+    'BW' => 6,
+  }.freeze
+end

data/lib/runeterra_cards/metadata.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module RuneterraCards
+  # Loads, stores, and retrieves data for cards from Legends of Runeterra Data Dragon set files.
+  # N.B. this does not ship with any metadata of its own, you must provide set files yourself and load them before
+  # this class will do anything.
+  #
+  # @example Load data and retrieve data for a card
+  #   m = RuneterraCards::Metadata.new
+  #   m.add_set_file('./set1-en_us.json')
+  #   m.lookup_card('01DE031') #=> CardMetadata
+  #
+  # @example Load data from multiple sets
+  #   m = RuneterraCards::Metadata.new
+  #   m.add_set_file('./set1-en_us.json')
+  #   m.add_set_file('./set2-en_us.json')
+  #
+  # @note This class cannot yet handle metadata for multiple locales at the same time. You will need multiple instances
+  #   of this class, one for each locale, if you wish to handle multiple locales at this time.
+  class Metadata
+    def initialize
+      @cards = {}
+    end
+
+    # Load card data from a Legends of Runeterra Data Dragon set file, e.g. "set1-en_us.json"
+    # @param file_path [String] The path to the metadata file to read
+    # @todo document and test exceptions that can be thrown here
+    def add_set_file(file_path)
+      file = File.read(file_path)
+      data = JSON.parse(file)
+      data.each do |card_data|
+        card = CardMetadata.new(card_data)
+        @cards[card.card_code] = card
+      end
+    end
+
+    # Fetch card metadata for a card via its card code
+    # @param card_code [String] card code, e.g. 01DE031
+    # @return [CardMetadata]
+    # @todo document errors if card_code doesn't exist
+    def lookup_card(card_code)
+      @cards.fetch(card_code)
+    end
+
+    # Returns all cards in the metadata set that are collectible
+    # @return [Hash<String,CardMetadata>]
+    # @see CardMetadata#collectible?
+    def all_collectible
+      @cards.select { |_, card| card.collectible? }
+    end
+
+    # Returns a [CardSet] that represents a complete card collection.
+    # That is: 3x of every card that is collectible.
+    # @return [CardSet]
+    def full_set
+      CardSet.new(all_collectible.keys.each_with_object({}) { |code, result| result[code] = 3 })
+    end
+  end
+end

data/lib/runeterra_cards/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module RuneterraCards
+  # The version of this library
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,220 @@
+--- !ruby/object:Gem::Specification
+name: runeterra_cards
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- zofrex
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-08-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: base32
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+- !ruby/object:Gem::Dependency
+  name: mutant-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.89.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.89.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-packaging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.25
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.25
+description: Legends of Runeterra deck encoder/decoder and general purpose card info
+email:
+- zofrex@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- lib/runeterra_cards.rb
+- lib/runeterra_cards/card_and_count.rb
+- lib/runeterra_cards/card_metadata.rb
+- lib/runeterra_cards/card_set.rb
+- lib/runeterra_cards/errors.rb
+- lib/runeterra_cards/factions.rb
+- lib/runeterra_cards/metadata.rb
+- lib/runeterra_cards/version.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Legends of Runeterra deck encoder/decoder and general purpose card info
+test_files: []