cardshark 0.0.1 → 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0b7dc3f06fe56ae72385c66266ddd97cd2da7aa24521d995d19bd6a117388783
+  data.tar.gz: c91be32f5aa41e6dae0a55c8cbb8fd7129fcc438371d1d23c97ff147f728ca6c
+SHA512:
+  metadata.gz: 6f7ff3b232fa6e3d467fab0755dca1d05faee036579ceb6ddc39d3b92f0cd9ff007df15d2604c17e7533357a2179b204cce6c926f334de45e8dd781414755836
+  data.tar.gz: 67e7205a272f453e42352bcebfa8571cb9aca30e5c37cbf462686ff942ab0af5b234d6e670e637d4e574d6b2e95fbf461889ebcfb59022673f4f762e717c6739

data/.github/workflows/rspec.yml

@@ -0,0 +1,20 @@
+name: RSpec
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - name: Build and test with RSpec
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec rspec

data/.gitignore

@@ -2,3 +2,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+spec/examples.txt

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper --order random --fail-fast --format documentation

data/.rubocop.yml

@@ -0,0 +1,20 @@
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://github.com/rubocop-hq/rubocop/blob/master/manual/configuration.md
+
+Metrics/BlockLength:
+  Exclude:
+    - 'Rakefile'
+    - '**/*.rake'
+    - 'test/**/*.rb'
+    - 'spec/**/*.rb'
+
+Style/Documentation:
+    Enabled: false

data/Gemfile

@@ -1,4 +1,4 @@
-source "http://rubygems.org"
+# frozen_string_literal: true
 
-# Specify your gem's dependencies in cardshark.gemspec
+source 'http://rubygems.org'
 gemspec

data/Guardfile

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+guard :rspec, cmd: 'bundle exec rspec', failed_mode: :keep do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end
+
+rubocop_options = {
+  all_on_start: false,
+  cli: '--auto-correct --format simple'
+}
+guard :rubocop, rubocop_options do
+  watch(/.+\.rb$/)
+  watch(%r{(?:.+\/)?\.rubocop(?:_todo)?\.yml$}) { |m| File.dirname(m[0]) }
+end

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2011 by John Britton - http://www.johndbritton.com
+
+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/README.md

@@ -0,0 +1,49 @@
+# Cardshark
+
+## Example usage:
+
+```ruby
+require 'cardshark'
+
+class Deck < Cardshark::Deck; end
+class Card < Cardshark::Card; end
+class Rank < Cardshark::Dimension; end
+class Suit < Cardshark::Dimension; end
+
+ranks = [
+  :ace,
+  :two,
+  :three,
+  :four,
+  :five,
+  :six,
+  :seven,
+  :eight,
+  :nine,
+  :ten,
+  :jack,
+  :queen,
+  :king
+].each do |name|
+  Rank.new(name)
+end
+
+suits = [
+  :clubs,
+  :diamonds,
+  :hearts,
+  :spades
+].each do |name|
+  Suit.new(name)
+end
+
+deck = Deck.new do
+  cards = []
+  Suit.all.each do |suit|
+    Rank.all.each do |rank|
+      cards << Card.new(rank, suit)
+    end
+  end
+  cards
+end
+```

data/Rakefile

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 require 'bundler'
 Bundler::GemHelper.install_tasks

data/cardshark.gemspec

@@ -1,23 +1,30 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "cardshark/version"
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('lib', __dir__)
+require 'cardshark/version'
 
 Gem::Specification.new do |s|
-  s.name        = "cardshark"
+  s.name        = 'cardshark'
   s.version     = Cardshark::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["John Britton - @johndbritton"]
-  s.email       = ["public@johndbritton.com"]
-  s.homepage    = "http://www.johndbritton.com"
-  s.summary     = %q{A library for various types of card decks}
-  s.description = %q{Supports Canasta, French, Piquet, and Uno Decks}
+  s.authors     = ['John Britton - @johndbritton']
+  s.email       = ['public@johndbritton.com']
+  s.homepage    = 'https://github.com/johndbritton/cardshark'
+  s.summary     = 'A library for building decks of cards.'
+  s.description = 'A library for building decks of cards.'
 
-  s.rubyforge_project = "cardshark"
+  s.rubyforge_project = 'cardshark'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  s.executables   = `git ls-files -- bin/*`
+                    .split("\n")
+                    .map { |f| File.basename(f) }
+  s.require_paths = ['lib']
 
-  s.add_development_dependency "rspec", "~> 2.0.0.beta.22"
+  s.add_development_dependency 'guard-rspec', '~> 4.7.3'
+  s.add_development_dependency 'guard-rubocop', '~>1.3.0'
+  s.add_development_dependency 'rspec', '~> 3.9.0'
+  s.add_development_dependency 'rubocop', '~> 0.79.0'
+  s.add_development_dependency 'terminal-notifier-guard', '~> 1.7.0'
 end

data/lib/cardshark.rb

@@ -1,3 +1,10 @@
+# frozen_string_literal: true
+
+require 'cardshark/card'
+require 'cardshark/deck'
+require 'cardshark/dimension'
+require 'cardshark/error'
+require 'cardshark/version'
+
 module Cardshark
-  # Your code goes here...
 end

data/lib/cardshark/abstract.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'cardshark/error'
+
+module Cardshark
+  module Abstract
+    def self.included(base)
+      base.instance_variable_set(:@abstract, true)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def new(*)
+        if instance_variable_defined?(:@abstract)
+          if instance_variable_get(:@abstract) == true
+            raise Error::AbstractClass
+          end
+        end
+
+        super
+      end
+
+      private
+
+      def inherited(subclass)
+        subclass.instance_variable_set(:@abstract, false)
+      end
+    end
+  end
+end

data/lib/cardshark/card.rb

@@ -1,10 +1,35 @@
+# frozen_string_literal: true
+
+require 'cardshark/dimension'
+
 module Cardshark
   class Card
-    attr_reader :rank, :suit
-    def initialize(card)
-      @rank = card[:rank]
-      @suit = card[:suit]
-      self.freeze
+    def initialize(*args)
+      validate_arguments(args)
+
+      @dimensions = {}
+      args.each { |arg| @dimensions[arg.class.id] = arg }
+      define_dimension_methods
+    end
+
+    def dimensions
+      @dimensions.keys
+    end
+
+    private
+
+    def define_dimension_methods
+      @dimensions.keys.each do |dimension|
+        define_singleton_method dimension do
+          @dimensions[dimension]
+        end
+      end
+    end
+
+    def validate_arguments(args)
+      raise ArgumentError if args.empty?
+      raise ArgumentError if args.detect { |arg| !arg.is_a?(Dimension) }
+      raise ArgumentError unless args.uniq(&:class).count == args.count
     end
   end
-end
+end

data/lib/cardshark/deck.rb

@@ -1,33 +1,80 @@
+# frozen_string_literal: true
+
+require 'cardshark/error'
+
 module Cardshark
-  module Deck
-    def size
-      @cards.size
+  class Deck
+    def initialize(&block)
+      raise ArgumentError if block.nil?
+
+      @deck_order = nil
+      @draw_position = 0
+      @cards = yield || []
+
+      @cards.each do |card|
+        raise ArgumentError if card.class.is_a?(Card)
+      end
     end
-    
-    def cards
-      @cards
+
+    def draw
+      raise Error::DeckExhausted if draw_position >= cards.count
+
+      card = cards[deck_order[draw_position]]
+      @draw_position += 1
+      card
     end
-    
-    def shuffle!
-      @cards.shuffle!
-      @shuffled = true
+
+    def count
+      cards.count
     end
-    
+
     def shuffled?
-      return false unless @shuffled
-      true
-    end
-    
-    # Helper method that builds cards
-    def create_cards(suits, ranks)
-      created_cards = Array.new
-      suits.each do |suit|
-        ranks.each do |rank|
-          created_cards.push Card.new(:rank => rank, :suit => suit)
-        end
+      !@deck_order.nil?
+    end
+
+    def shuffle!(mapping)
+      raise Error::DeckAlreadyShuffled if shuffled?
+
+      validate_mapping(mapping)
+
+      @deck_order = mapping
+
+      self
+    end
+
+    private
+
+    attr_reader :cards, :draw_position
+
+    def deck_order
+      return @deck_order unless @deck_order.nil?
+
+      count.times.collect { |i| i }
+    end
+
+    def validate_mapping(mapping)
+      ensure_mapping_is_array(mapping)
+      ensure_mapping_is_correct_arity(mapping)
+      ensure_mapping_is_correct_type(mapping)
+      ensure_mapping_elements_in_bounds(mapping)
+    end
+
+    def ensure_mapping_is_array(mapping)
+      raise ArgumentError if mapping.class != Array
+    end
+
+    def ensure_mapping_is_correct_arity(mapping)
+      raise Error::DeckOrderInvalid if mapping.count != count
+    end
+
+    def ensure_mapping_is_correct_type(mapping)
+      raise Error::DeckOrderInvalid if mapping.detect { |i| i.class != Integer }
+    end
+
+    def ensure_mapping_elements_in_bounds(mapping)
+      raise Error::DeckOrderInvalid if mapping.detect do |i|
+        i.negative? || i >= count
       end
-      created_cards
     end
-    
   end
-end
+end

data/lib/cardshark/dimension.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'cardshark/abstract'
+require 'cardshark/error'
+
+module Cardshark
+  class Dimension
+    include Abstract
+
+    def self.new(id)
+      raise ArgumentError if id.class != Symbol
+
+      if instances[id].nil?
+        instances[id] = super
+      else
+        instances[id]
+      end
+    end
+
+    def self.all
+      instances.values
+    end
+
+    def self.id
+      if name.nil?
+        object_id.to_s.downcase.to_sym
+      else
+        name.split('::').last.gsub(/(.)([A-Z])/, '\1_\2').downcase.to_sym
+      end
+    end
+
+    def initialize(id)
+      @id = id
+    end
+
+    def to_s
+      id.to_s.capitalize
+    end
+
+    private
+
+    class << self
+      private
+
+      def instances
+        @instances ||= {}
+      end
+      attr_writer :instances
+    end
+
+    attr_accessor :id
+
+    def inherited(_subclass)
+      raise Error::DimensionInheritanceLimit
+    end
+  end
+end