runeterra_cards 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7a06c2e4f2c76ba4038979ac6215010fb95b763da60717bc18faec557d41dcb
-  data.tar.gz: 1583f4620c7ccc60f3f2d18ed5646f2c9e2d38691cd191340dc70db9de9012ec
+  metadata.gz: e072725d1ac2b1af062cfa42826a5efd9eb991eb51f65d8897b90a5110fbf8c7
+  data.tar.gz: a3a260958b84602a94e53d0ccaa19f714fb7fbdccf036569d195419e13dbbc77
 SHA512:
-  metadata.gz: 571ad2f19f35022cdc41f9b0195b7a87b70e6f6cb7f75438e16a6e7e891355c1615debf359dd59c0717abe7cb7125adfde5e8a54b076dcecf45389364df6827b
-  data.tar.gz: b5414fa7da1d020f6ec6eec394e66fa1735f264a60e850be18e8f5dba303959e5f517a3bbb6d0edbb1734867d619b432c7cbeb5a6bebc461c33946d7634fc692
+  metadata.gz: f7c8a7b954a62793eb396e299e52ea104e8cf08b0d9d18c616b8d37bad973620c01981460dced44320f09bfc9f7a84423d1e5f6f8caba58db9c9ba35ec70ce01
+  data.tar.gz: ac21bf2ed0a0ee367771a33b0417456eb1986469998760484875e5d5871d03e7a720cfd1a2ef9a808e69eb42339cd92ecc10439755b4b6959e60ca36b4b510ea

data/doc/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changelog
+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.2.1] - 2020-08-29
+### Fixed
+- Correctly packaged README and CHANGELOG in the Gem
+
+## [0.2.0] - 2020-08-29
+### Added
+- Added support for the Mount Targon faction
+- UnrecognizedVersionError#version returns the version number that wasn't recognized.
+- UnrecognizedFactionError, which is raised by CardAndCount#new (and by extension, CardSet#from_deck_code) if an unrecognized faction number is encountered.
+
+### Changed
+- FACTION_IDENTIFIERS_FROM_INT is now a Hash instead of an Array. The API for looking up a faction identifier by integer should remain unchanged in most cases.
+
+## [0.1.0] - 2020-08-28
+### Added
+- Initial public release, with support for loading deck codes (Bilgewater and earlier) and loading metadata from Legends of Runeterra Data Dragon.

data/doc/README.md

@@ -0,0 +1,64 @@
+<!-- This is the README file for the Gem documentation / online documentation. It should be thorough and authoritative for using the Gem, but not discuss development concerns, which belong in the Github README. -->
+
+## Description
+
+This library makes it easy to decode Legends of Runeterra deck codes, load Data Dragon metadata for cards, and perform operations on the data.
+
+## Installation
+
+Add the following to your `Gemfile`:
+
+```
+gem 'runeterra_cards', '~> 0.2.0'
+```
+
+Or, if you're building a Gem, your `.gemspec`:
+
+```
+  spec.add_dependency 'runeterra_cards', '~> 0.2.0'
+```
+
+## 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.
+
+All changes are documented in the {file:doc/CHANGELOG.md}.
+
+## Main Concepts
+
+Your typical main entry points to this library will be {RuneterraCards::CardSet} for manipulating deck codes and/or {RuneterraCards::Metadata} for handling Data Dragon card data.
+
+## Examples
+
+Load a deck code:
+
+```
+require 'runeterra_cards'
+
+deck_code = 'CEBAOAQGC4OSKJZJF44ACAQFBIBAIAQGAEPCYNIBAICQOAYCAECSOMADAIDAKGRWAEBAKAY'
+deck = RuneterraCards::CardSet.from_deck_code(deck_code)
+
+deck.count_for_card_code('02BW053') #=> 2
+
+deck.cards.each do |card, count|
+  puts "#{card} x#{count}"
+end
+```
+
+Load metadata from Legends of Runeterra Data Dragon:
+
+```
+require 'runeterra_cards'
+
+metadata = RuneterraCards::Metadata.new
+
+metadata.add_set_file 'set1-en_us.json'
+metadata.add_set_file 'set2-en_us.json'
+
+card = metadata.lookup_card '02BW053'
+card.name #=> "Nautilus"
+```
+
+## Development & Contributing
+
+See the [Github project](https://github.com/zofrex/runeterra_cards) for more details.

data/lib/runeterra_cards/version.rb

@@ -2,5 +2,5 @@
 
 module RuneterraCards
   # The version of this library
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification
 name: runeterra_cards
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
-- zofrex
+- James "zofrex" Sanderson
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -178,7 +178,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.25
-description: Legends of Runeterra deck encoder/decoder and general purpose card info
+description: Legends of Runeterra deck code decoder & Data Dragon card data loader.
 email:
 - zofrex@gmail.com
 executables: []
@@ -186,6 +186,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE.txt
+- doc/CHANGELOG.md
+- doc/README.md
 - lib/runeterra_cards.rb
 - lib/runeterra_cards/card_and_count.rb
 - lib/runeterra_cards/card_metadata.rb
@@ -197,7 +199,11 @@ files:
 homepage: 
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/zofrex/runeterra_cards/issues
+  changelog_uri: https://www.rubydoc.info/gems/runeterra_cards/doc/CHANGELOG.md
+  mailing_list_uri: https://groups.example.com/bestgemever
+  source_code_uri: https://github.com/zofrex/runeterra_cards
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -216,5 +222,5 @@ requirements: []
 rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
-summary: Legends of Runeterra deck encoder/decoder and general purpose card info
+summary: Legends of Runeterra deck code decoder & Data Dragon card data loader.
 test_files: []