cw_card_utils 0.1.9 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33af01174c18c349d5ecadd729ff82f228645e4d7de70345e031483a9b6e4aeb
-  data.tar.gz: d95e60dcf30519bdeca9ca86ab04c727e2b76c1a6de990417bd21bbe41e7ad26
+  metadata.gz: 0aab3de52c635cd3e24f8ba808777bfc5e60cb07b0e2f02357c67f00212dcfc9
+  data.tar.gz: 28d0d647d3c6f91a69b6853abcd73605e9f116a8251afff8c5f39a7cf77b22fe
 SHA512:
-  metadata.gz: dfa2f46a027dda4ffd67bdace956049c47bdc3a009a70f36ade4c722939d38658d05bf8adf57d85753442e44a71f6aeb12a247579277e1ecd38ce17de846bd9e
-  data.tar.gz: b0e79425dc4ce0d47788cba711c19e80554cf1a89eb63b695cbb03fa2ba0286b2e451cc20364a3b3344fd97cb0f5a56db16ba3464e90a341563fcf58ec245b1d
+  metadata.gz: 42be3567474156c9c6417d0c7994485567608af868a3f8dadd832b964c99216397bda74d89e83210c3e170ba1b5d4dddef19c401efc70eb7380dfe8068753c7b
+  data.tar.gz: 4218005f3d49d44613e738b2f718f5f1997a314ec81918d865f9bec17b714b6c811f9dfcc2fd6a79ced057175fa8bfc69e15e8f3d0b981b4b7c00d52cb3014af

data/README.md

@@ -1,50 +1,79 @@
 # CwCardUtils
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/cw_card_utils`. To experiment with that code, run `bin/console` for an interactive prompt.
+A Ruby gem for analyzing Magic: The Gathering decklists and calculating various metrics.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cw_card_utils'
+```
 
-Install the gem and add to the application's Gemfile by executing:
+And then execute:
 
 ```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+bundle install
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+## Configuration
 
-```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+You can configure the card data source used by the library:
+
+```ruby
+# In a Rails initializer (config/initializers/cw_card_utils.rb)
+CwCardUtils.configure do |config|
+  config.card_data_source = MyCustomDataSource.new
+end
+
+# Or set it directly
+CwCardUtils.card_data_source = MyCustomDataSource.new
 ```
 
+The default data source is `CwCardUtils::ScryfallCmcData.instance`, which loads card data from a local JSON file.
+
 ## Usage
 
-TODO: Write usage instructions here
+### Basic Deck Parsing
 
-## Development
+```ruby
+require 'cw_card_utils'
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+# Parse a decklist
+decklist = <<~DECK
+  4 Lightning Bolt
+  4 Mountain
+  2 Shock
+DECK
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+deck = CwCardUtils::DecklistParser::Parser.new(decklist).parse
 
-## Contributing
+# Access deck information
+puts deck.mainboard_size  # => 10
+puts deck.color_identity  # => ["R"]
+puts deck.archetype      # => :aggro
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/cw_card_utils. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/cw_card_utils/blob/main/CODE_OF_CONDUCT.md).
+### Custom Data Sources
 
-## License
+You can implement your own card data source by inheriting from `CwCardUtils::CardDataSource`:
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+```ruby
+class MyCustomDataSource < CwCardUtils::CardDataSource
+  def find_card(name)
+    # Your implementation here
+    # Should return a hash with card data or nil
+  end
+end
 
-## Code of Conduct
+# Configure the library to use your data source
+CwCardUtils.card_data_source = MyCustomDataSource.new
+```
 
-Everyone interacting in the CwCardUtils project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/cw_card_utils/blob/main/CODE_OF_CONDUCT.md).
+## Development
 
-## Included Data
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-This gem includes [bulk data from Scryfall][1] to provide fallback for the curve calculator. For production
-or real-life usage, this should use your own data store. 
+## Contributing
 
-[1]: https://scryfall.com/docs/api/bulk-data
+Bug reports and pull requests are welcome on GitHub at https://github.com/cracklingwit/cw_card_utils.

data/lib/cw_card_utils/deck_comparator.rb

@@ -90,7 +90,7 @@ module CwCardUtils
 
     def extract_synergy_pairs(deck)
       synergy_cards = deck.main.select do |card|
-        (card.tags & [:synergistic_finisher, :tribal_synergy, :scaling_threat]).any?
+        card.tags.intersect?([:synergistic_finisher, :tribal_synergy, :scaling_threat])
       end
       return [] if synergy_cards.size < 2
       synergy_cards.map(&:name).combination(2).to_a

data/lib/cw_card_utils/decklist_parser/card.rb

@@ -4,11 +4,11 @@ module CwCardUtils
   module DecklistParser
     # A Card is a single card in a deck.
     class Card
-      def initialize(name, count, cmc_data_source = CwCardUtils::ScryfallCmcData.instance)
+      def initialize(name, count, cmc_data_source = nil)
         @name = name
         @count = count
         @tags = []
-        @cmc_data_source = cmc_data_source
+        @cmc_data_source = cmc_data_source || CwCardUtils.card_data_source
       end
 
       attr_reader :name, :count, :cmc_data_source

data/lib/cw_card_utils/decklist_parser/parser.rb

@@ -6,9 +6,9 @@ module CwCardUtils
     class Parser
       attr_reader :deck
 
-      def initialize(decklist, cmc_data_source = CwCardUtils::ScryfallCmcData.instance)
+      def initialize(decklist, cmc_data_source = nil)
         @decklist = decklist.is_a?(IO) ? decklist.read : decklist
-        @deck = Deck.new(cmc_data_source)
+        @deck = Deck.new(cmc_data_source || CwCardUtils.card_data_source)
       end
 
       def inspect

data/lib/cw_card_utils/scryfall_cmc_data.rb

@@ -79,9 +79,9 @@ module CwCardUtils
 
   # Represents a card with Scryfall data
   class ScryfallCard
-    def initialize(name, data_source = ScryfallCmcData.instance)
+    def initialize(name, data_source = nil)
       @name = name
-      @data = data_source.find_card(@name) || {}
+      @data = (data_source || CwCardUtils.card_data_source).find_card(@name) || {}
     end
 
     def cmc

data/lib/cw_card_utils/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CwCardUtils
-  VERSION = "0.1.9"
+  VERSION = "0.1.10"
 end

data/lib/cw_card_utils.rb

@@ -9,4 +9,17 @@ require_relative "cw_card_utils/deck_comparator"
 
 module CwCardUtils
   class Error < StandardError; end
+
+  # Configuration for the library
+  class << self
+    attr_writer :card_data_source
+
+    def card_data_source
+      @card_data_source ||= ScryfallCmcData.instance
+    end
+
+    def configure
+      yield self if block_given?
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cw_card_utils
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.10
 platform: ruby
 authors:
 - Ryan Stenhouse