cardistry 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e760749252ebfaa5a7c8a2293150af68a9b9d3cce8c1c7e1b12614ff5b22322
-  data.tar.gz: 24ac91f6f0f5ea0ea564ea8d84ff8bd46c4dcc41764f65546a9512d97faec440
+  metadata.gz: 9f23f4fcaa617afe7e2082023e94719bcbb72f027c34b411cceacb80a6f8cc2d
+  data.tar.gz: 44ba04791c6bf858527c72ecbaa43e206eb441420395251d1228c4c1ff44cef3
 SHA512:
-  metadata.gz: 456c1592c65569b4dee5e79a5c4bdac3d42903e250c61cab55eaaf8e7f145a4869889619bcff63872ddfe8e06a4036e15b3000a2d59a6687b484357d90690eda
-  data.tar.gz: 375747e1b0c6dab0df14c778d554ed7b5fbb63aa4367433abf3bed2872bc7ff1fbc61e8ddb2a4cab0b5ef300ec0cf18c0c17a30ed9c2ed1b03b4ac3ee9c17d04
+  metadata.gz: 68f71f2e2a2865552b89d45de906e420f8b9facf5a1b172755cb69d31ba853800e96664ed32d6fbc76229e3fce5bd75f6ddcb36c39c97879de3593bd18281784
+  data.tar.gz: c17f7e9d80cf05caf0f2fc5778415929468f06dcc5ec634c4aa8aaca7e488ca5aa4e42faebb68f7df4c13b6d49b11ab03e3508b400b77839b3a836303b77039f

data/.github/workflows/ruby.yml

@@ -0,0 +1,33 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@21351ecc0a7c196081abca5dc55b08f085efe09a
+      with:
+        ruby-version: 2.6
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake spec

data/README.md

@@ -1,9 +1,21 @@
+[![Gem Version](https://badge.fury.io/rb/cardistry.svg)](https://badge.fury.io/rb/cardistry)
+
 # Cardistry
 
-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/cardistry`. To experiment with that code, run `bin/console` for an interactive prompt.
+Cardistry provides a few basic classes that model the behavior of a real deck of cards – and a (mostly!) complete test suite. 
+
+### Goals
 
-TODO: Delete this and the text above, and describe your gem
+- Easily extendable classes so that you can model your favorite decks and games, from poker to tarot, or even MTG or UNO.
+- Realistic, simulated (not random!) riffle shuffling
+- Common actions like cutting the deck, dealing individual cards to other locations, and more.
 
+#### Intended Classes
+- **Card** - Represents a single card, to be contained by other Classes
+- **Deck** - An enumerable collection of cards. 
+- **Spread** (*not yet added*) – A sequence of positions, each with a name (ie "The River").
+- **Hand** (*not yet added*) - A sortable collection of cards.
+ 
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -22,17 +34,80 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### A Basic Deck
+
+```ruby
+require 'cardistry'
+
+deck = Cardistry::Deck.new
+deck.load 'cards.json'
+
+puts deck.size    # 52
+puts deck.info    # "cards: 52, suits: [:spades, :hearts, :clubs, :diamonds]
+puts deck.first   # "Ace of Spades"
+
+puts deck[0].suit # :spades
+
+```
+
+### Extending Classes
+
+```ruby
+require 'cardistry'
+
+class CoolerCard < Cardistry::Card
+  
+  def to_s
+    "Cooler than #{super}"
+  end
+  
+end
+
+```
+
+### Example source data file
+
+Eventually a standard poker style deck will be included. You can find something close in `spec/test_deck.json` for now. 
+
+*Note that currently, all fields except `rank` are optional, `kind` will default to `:pip`*
+
+```js
+[
+  {
+    "name": "Ace of Spades",
+    "kind": "pip",
+    "suit": "spades",
+    "rank": 1
+  },
+  
+  // ...
+  
+  {
+    "suit": "clubs",
+    "rank": 7
+  },
+  
+  // ...
+  
+  {
+    "name": "Queen of Hearts",
+    "kind": "court",
+    "suit": "hearts",
+    "rank": 12
+  },
+  
+  // ...etc
+]
+```
+
 
 ## Development
 
 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.
 
-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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/cardistry. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/nickisnoble/cardistry. 
 
 ## License
 
@@ -40,4 +115,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Cardistry project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/cardistry/blob/master/CODE_OF_CONDUCT.md).
+Be nice or leave!

data/cardistry.gemspec

@@ -10,20 +10,18 @@ Gem::Specification.new do |spec|
   spec.email         = ["nick.noble@hey.com"]
 
   spec.summary       = %q{A toolkit for modeling cards, decks, hands, and spreads.}
-  spec.homepage      = "https://rubygems.org/gems/cardistry"
+  spec.homepage      = "https://github.com/nickisnoble/cardistry"
   spec.license       = "MIT"
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
-  # if spec.respond_to?(:metadata)
-  #   spec.metadata["allowed_push_host"] = "http://rubygems.org/"
-
-  #   spec.metadata["homepage_uri"] = spec.homepage
-  #   spec.metadata["source_code_uri"] = "https://github.com/nickisnoble/cardistry"
-  # else
-  #   raise "RubyGems 2.0 or newer is required to protect against " \
-  #     "public gem pushes."
-  # end
+  if spec.respond_to?(:metadata)
+    # spec.metadata["allowed_push_host"] = "http://rubygems.org/"
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/nickisnoble/cardistry"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

data/lib/cardistry/version.rb

@@ -1,3 +1,3 @@
 module Cardistry
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cardistry
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Nick Noble
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-04 00:00:00.000000000 Z
+date: 2021-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -59,10 +59,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
-- CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -75,10 +75,12 @@ files:
 - lib/cardistry/card.rb
 - lib/cardistry/deck.rb
 - lib/cardistry/version.rb
-homepage: https://rubygems.org/gems/cardistry
+homepage: https://github.com/nickisnoble/cardistry
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/nickisnoble/cardistry
+  source_code_uri: https://github.com/nickisnoble/cardistry
 post_install_message:
 rdoc_options: []
 require_paths:

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at nick.noble@hey.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/