cards_lib 0.0.9 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 10716ea47a94f0d478b4503e7151f99e82f41dbb
-  data.tar.gz: 541e1726e3db0891a5de3c4bb581a2a097c706fe
+  metadata.gz: 9f94c306a1f03188d1d020e3e24a79222b46defe
+  data.tar.gz: e78c436d453c9f0a550c33545eafbe6abb598438
 SHA512:
-  metadata.gz: d32136123ac2e81a3b2a86398782ab4d0214d2fb2d953eaa779ac5af82151846a024f33bcb98921cd83b96d1852cbb6254467d4c6b5d141a901587757fbc8dd2
-  data.tar.gz: cac6d824f9502c16c5c82843c018396813ae5f99a2e64e44815e6bfe2550b2172834e564b6c8487b74b96b316c69e1232b66ccefd4028ff1bb8b482677dc00a6
+  metadata.gz: d82a1aabe22e731af5d690ded716a8e186e335b8716bde7999a870096b7137f4f41f3644946d113a6f692b8ab774b96e950c7e7fe99aab2c7a78ebf36b173c52
+  data.tar.gz: 71d6a2c5bdb8f1b8c678c8f30e6c6910f5769539bd4bd70cdf91d5cc0b3b7d6e83ff471c8a81fbfd425fe02a69bbb710f9db7e0ecc0fc28d41d39ebe3106d7bd

data/.gitignore

@@ -11,3 +11,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+travis.log

data/README.md

@@ -2,4 +2,53 @@
 
 [![Gem Version](https://badge.fury.io/rb/cards_lib.svg)](http://badge.fury.io/rb/cards_lib)[![Build Status](https://travis-ci.org/danielpclark/CardsLib.svg?branch=master)](https://travis-ci.org/danielpclark/CardsLib)[![Code Climate](https://codeclimate.com/github/danielpclark/CardsLib/badges/gpa.svg)](https://codeclimate.com/github/danielpclark/CardsLib)[![Test Coverage](https://codeclimate.com/github/danielpclark/CardsLib/badges/coverage.svg)](https://codeclimate.com/github/danielpclark/CardsLib/coverage)
 
-gem 'cards_lib'
+##Install
+
+```
+gem install 'cards_lib'
+```
+Requires Ruby 2 or greater.
+
+##Usage
+
+Create a Card with Card.new(face)
+
+```ruby
+CardsLib::Card.new("As")
+```
+
+Use a Macro to create a list of Card instances from card faces.
+
+```ruby
+CardsLib::Cards["Ah","2h","3h","4h","5h"]
+```
+
+Create a Deck with Deck.new(cards)
+A default deck is generated if no parameters are given.
+
+```ruby
+CardsLib::Deck.new
+```
+
+Pick what rules you'd like to use in determining a set of cards.
+
+```ruby
+# BOOLEAN RESULT
+CardsLib::IsSet.verify(
+  card_instances_array,
+  rules = [:unique, :ordered, :paired, :suited],
+  specifications = {min: 3, max: Float::INFINITY}
+)
+```
+
+##License
+
+The MIT License (MIT)
+
+Copyright (c) 2015 by Daniel P. Clark
+
+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/cards_lib/card.rb

@@ -2,23 +2,12 @@ module CardsLib
   class Card
     include Comparable
     def initialize(face, ranker = Ranker)
-      raise InvalidCardFace, "face cannot be blank" if face.to_s.empty?
-      @suit = nil
-      @rank = nil
-      @ranker = ranker
-      if face.is_a? Hash
-        @suit = face.fetch(:suit) { nil }
-        @rank = face.fetch(:rank) { nil }
-        if @rank && @suit
-          str = ""
-          if @rank.length.>(1) && @suit.length.>(1)
-            str = " of "
-          end
-          @face = [@rank, str, @suit].join
-        end
-      else
-        @face = face
-      end
+      raise InvalidCardFace, "Parameter face cannot be blank!" if face.to_s.empty?
+      @suit = if_hash_then_fetch(face, :suit)
+      @rank = if_hash_then_fetch(face, :rank)
+      @face = face_from_rank_and_suit(@rank, @suit) if @rank && @suit
+      
+      @face ||= face
       @ranker = ranker.new(rank)
     end
 
@@ -46,33 +35,39 @@ module CardsLib
       @ranker.<=>(other)
     end
 
-    def sequential(other)
-      @ranker.sequential(other)
+    def sequential?(other)
+      @ranker.sequential?(other)
     end
     
     # return other if true
     def paired?(other)
-      (self.rank == other.rank) ? other : NilCard.new
+      (self.rank == other.rank) ? other : nil
     end
 
     # return other if true
     def suited?(other)
-      (self.suit == other.suit) ? other : NilCard.new
+      (self.suit == other.suit) ? other : nil
     end
 
     # returns other if true
     def ordered?(other)
-      self.sequential(other) ? other : NilCard.new
+      self.sequential?(other) ? other : nil
     end
   end
 
-  class InvalidCardFace < Exception
+  class InvalidCardFace < Exception; end
+  class InvalidRankAndSuitProvided < Exception; end
 
+  private
+  def face_from_rank_and_suit(rank, suit)
+    if rank && suit
+      [rank, ((rank.length.>(1) && suit.length.>(1)) ? " of " : ""), suit].join
+    else
+      raise InvalidRankAndSuitProvided, "Suit and Rank provided in Hash are invalid!"
+    end
   end
 
-  class NilCard
-    def method_missing(m,*a,&b)
-      self 
-    end
+  def if_hash_then_fetch(item, target)
+    item.is_a?(Hash) ? item.fetch(target) { nil } : nil
   end
 end

data/lib/cards_lib/is_set.rb

@@ -2,9 +2,9 @@ module CardsLib
   module IsSet
     class << self
       def verify(cards, rules = [:unique, :paired], specs = {})
-        @max = specs.fetch(:max) {Float::INFINITY}
-        @min = specs.fetch(:min) { 3 }
-        rules.all? {|r| send(r, cards) } && (@min..@max).include?(cards.count)
+        max = specs.fetch(:max) {Float::INFINITY}
+        min = specs.fetch(:min) { 3 }
+        rules.all? {|r| send(r, cards) } && (min..max).include?(cards.count)
       end
 
       private 
@@ -12,16 +12,18 @@ module CardsLib
         cards.combination(2).all? {|a,b| a != b }
       end
 
+      using Refinements::InjectWhile
+
       def paired(cards)
-        !(cards.inject(:paired?).is_a? NilCard)
+        cards.inject_while?(:paired?)
       end
       
       def suited(cards)
-        !(cards.inject(:suited?).is_a? NilCard)
+        cards.inject_while?(:suited?)
       end
 
       def ordered(cards)
-        !(cards.sort.inject(:ordered?).is_a? NilCard)
+        cards.sort.inject_while?(:ordered?)
       end
     end
   end

data/lib/cards_lib/ranker.rb

@@ -2,26 +2,19 @@ module CardsLib
   class Ranker
     include Comparable
     attr :rank, :ranks, :rank_lookup
-    def initialize(
-        rank = nil,
-        ranks: "A23456789TJQK".split(''),
-        rank_lookup: ->rank_face{
-          @ranks.index(rank_face).to_i + 1
-        })
-      @rank = rank
-      @ranks = ranks
-      @rank_lookup = rank_lookup
+    def initialize rank = nil,
+                   ranks: "A23456789TJQK".chars,
+                   rank_lookup: nil
+    
+      @rank, @ranks, @rank_lookup = rank, ranks, rank_lookup ||
+                     ->rank_face{ @ranks.index(rank_face).to_i + 1 }
     end
 
     def <=>(item)
       @rank_lookup[self.rank] <=> @rank_lookup[item.rank]
     end
 
-    def inspect
-      @rank
-    end
-
-    def sequential(item)
+    def sequential?(item)
       (@rank_lookup[self.rank] - @rank_lookup[item.rank]).abs == 1
     end
   end

data/lib/cards_lib/refinements.rb

@@ -0,0 +1,18 @@
+module CardsLib::Refinements
+  module InjectWhile
+    refine Array do
+      def inject_while?(m)
+        result, *array = self.dup
+        loop do
+          break if array.empty?
+          other = array.shift
+
+          return false if result.class != other.class
+
+          result = result.send(m, other)
+        end
+        true
+      end
+    end
+  end
+end

data/lib/cards_lib/version.rb

@@ -1,3 +1,3 @@
 module CardsLib
-  VERSION = "0.0.9"
+  VERSION = "0.1.0"
 end

data/lib/cards_lib.rb

@@ -1,4 +1,5 @@
 require "cards_lib/version"
+require "cards_lib/refinements" # REQUIRE BEFORE USE
 require "cards_lib/card"
 require "cards_lib/deck"
 require "cards_lib/standard"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cards_lib
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors:
 - Daniel P. Clark
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-27 00:00:00.000000000 Z
+date: 2015-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -103,9 +103,9 @@ files:
 - lib/cards_lib/deck.rb
 - lib/cards_lib/is_set.rb
 - lib/cards_lib/ranker.rb
+- lib/cards_lib/refinements.rb
 - lib/cards_lib/standard.rb
 - lib/cards_lib/version.rb
-- travis.log
 homepage: http://github.com/danielpclark/CardsLib
 licenses:
 - MIT

data/travis.log

@@ -1,87 +0,0 @@
-Command line:
-"travis encrypt CODECLIMATE_REPO_TOKEN=ecf8c246bcc2fdad42590f78c7b214bc19abf212eee0979427477e9c6a510320 bundle exec rake"
-
-
-   ________                                 __
-  /        |                               /  |
-  ########/ ______    ______    __     __  ##/    _______
-     ## |  /      \  /      \  /  \   /  | /  |  /       |
-     ## | /######  | ######  | ##  \ /##/  ## | /#######/
-     ## | ## |  ##/  /    ## |  ##  /##/   ## | ##      \
-     ## | ## |      /####### |   ## ##/    ## |  ######  |
-     ## | ## |      ##    ## |    ###/     ## | /     ##/
-     ##/  ##/        #######/      #/      ##/  #######/
-
-     TRajectory Analyzer and VISualizer  -  Open-source freeware under GNU GPL v3
-
-     Copyright (c) Martin Brehm      (2009-2014)
-                   Martin Thomas     (2012-2014)
-                   Barbara Kirchner  (2009-2014)
-                   University of Leipzig / University of Bonn.
-
-     http://www.travis-analyzer.de
-
-     Please cite:
-     M. Brehm and B. Kirchner, J. Chem. Inf. Model. 2011, 51 (8), pp 2007-2023.
-
-     There is absolutely no warranty on any results obtained from TRAVIS.
-
-  #  Running on allyourdev at Thu Jun 18 13:40:20 2015 (PID 16448).
-  #  Running in /home/danielpclark/dev/CardsLib
-  #  Source code version: Jan 17 2014.
-  #  Compiled at Jan 19 2014 05:12:11.
-  #  Compiler version: 4.8.2
-  #  Target platform: Linux
-  #  Compile flags: DEBUG_ARRAYS 
-  #  Machine: int=4b, long=8b, addr=8b, 0xA0B0C0D0=D0,C0,B0,A0.
-  #  User home: /home/danielpclark
-  #  Exe path: /usr/bin/travis
-  #  Input from terminal, Output to terminal
-
- >>> Please use a color scheme with dark background or specify "-nocolor"! <<<
-
-    No configuration file found.
-    Writing default configuration to /home/danielpclark/.travis.conf ...
-
-Unknown parameter: "encrypt".
-
-    List of supported command line options:
-
-      -p <file>       Loads position data from the specified trajectory file.
-                      The file format may be *.xyz, *.pdb, *.lmp (Lammps) or HISTORY (DLPOLY).
-      -i <file>       Reads input from the specified text file.
-
-      -config <file>  Load the specified configuration file.
-      -stream         Treats input trajectory as a stream (e.g. named pipe): No fseek, etc.
-      -showconf       Shows a tree structure of the configuration file.
-      -writeconf      Writes the default configuration file, including all defines values.
-
-      -verbose        Show detailed information about what's going on.
-      -nocolor        Executes TRAVIS in monochrome mode.
-      -dimcolor       Uses dim instead of bright colors.
-
-      -credits        Display a list of persons which contributed to TRAVIS.
-      -help, -?       Shows this help.
-
-    If only one argument is specified, it is assumed to be the name of a trajectory file.
-    If argument is specified at all, TRAVIS asks for the trajectory file to open.
-
-
-    Note: To show a list of all persons which contributed to TRAVIS,
-          please add "-credits" to your command line arguments, or set the
-          variable "SHOWCREDITS" to "TRUE" in your travis.conf file.
-
-    Source code from other projects used in TRAVIS:
-      - lmfit     from Joachim Wuttke
-      - kiss_fft  from Mark Borgerding
-      - voro++    from Chris Rycroft
-
-    http://www.travis-analyzer.de
-
-    Please cite:
-
-  * "TRAVIS - A Free Analyzer and Visualizer for Monte Carlo and Molecular Dynamics Trajectories",
-    M. Brehm, B. Kirchner; J. Chem. Inf. Model. 2011, 51 (8), pp 2007-2023.
-
-*** The End ***
-