copycats 0.0.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa8f79eeca85aa94e2dd76d4d8d6a3cc61f4f6e1
-  data.tar.gz: 29eefb603cddc5f4c14559b4b368bfd3a5e9c8e2
+  metadata.gz: 4fc77be01f1cb22a3dc5a00f14ea2ca82607602b
+  data.tar.gz: 74770f25d33f910afb03b7f6c1a2ceebb9d575ef
 SHA512:
-  metadata.gz: 5421edcf8c21f7229f925c53d28113adcfe0bf226df5eaa357ff4b7af07451faf87c56cab57285d59134674c1f0ed608930f9a92011bcc6a81ea34afd10bb9aa
-  data.tar.gz: 3d646117c62e59f748380f821e6aaa565cde7703f55381907a91b3435d62c61cd42194a4a9a0dffbaff08f4581819dbc82948ab8aae88c8495660a2c063cd247
+  metadata.gz: b0b2b1aff76fbb87e38ffb8cd029b8d602b123fcd30906028e9129e299f9ff590f6f75e90f65e1682e9e1c336c740881fed9deba2d599646c5195d8d6bfbc6b6
+  data.tar.gz: 522d81bb5f67f503cbb4c83221d30a6548efb6e357037326c6ac565e0cdfc3cd0c7ad4562ac7f66729df796281f44601c60a5a2ed6666fe9e07c58b374c21b66

data/Manifest.txt

@@ -3,7 +3,23 @@ LICENSE.md
 Manifest.txt
 README.md
 Rakefile
+bin/kitty
 lib/copycats.rb
+lib/copycats/base32.rb
+lib/copycats/data.rb
+lib/copycats/gene.rb
+lib/copycats/genome.rb
+lib/copycats/models/kitty.rb
+lib/copycats/reports/genes.rb
+lib/copycats/reports/kitty.rb
+lib/copycats/reports/mix.rb
+lib/copycats/reports/traits.rb
+lib/copycats/schema.rb
+lib/copycats/tool.rb
+lib/copycats/traits.rb
 lib/copycats/version.rb
 test/helper.rb
+test/test_base32.rb
+test/test_genome.rb
+test/test_mixgenes.rb
 test/test_version.rb

data/README.md

@@ -1,6 +1,6 @@
 # Crypto Copycats Collectibles - Buy! Sell! Hodl! Sire!
 
-copycats command line tool (and core library) - crypto cats / kitties collectibles unchained - buy! sell! hodl! sire! - play for free - runs off the blockchain - no ether or gas required; run your own peer-to-peer (P2P) network node over HTTP
+copycats command line tool (and core library) - crypto cats / kitties collectibles unchained - buy! sell! hodl! sire! - play for free - runs off the blockchain w/ ledger lite - no ether / gas required; run your own peer-to-peer (P2P) network node over HTTP
 
 
 
@@ -12,6 +12,252 @@ copycats command line tool (and core library) - crypto cats / kitties collectibl
 
 
 
+## kitty Command Line Tool
+
+Use the `kitty` command line tool to (auto-)read kitty data records
+(in comma-separated values (CSV)) into an in-memory SQLite database
+and print reports. Example - [`kitties_1-100.csv`](data/kitties_1-100.csv):
+
+```
+id,gen,genes_kai
+1,0,ccac7787fa7fafaa16467755f9ee444467667366cccceede
+2,0,ca9c7575f442af9g666455577777444466868667ccccffec
+3,0,ac9a6686ff7f99aa66665575779f444467867748ccccdcfc
+4,0,ccac568622fff99g16167555ffed444486684687ccccdcff
+5,0,ca9c8777747fg99g44117775f77d444477886377ccccffef
+...
+```
+
+Note: By default all datafiles (`**/*.csv`) in the `./data` and all subdirectories
+get (auto-)read. Use the `-i/--include` option to change the data directory.
+
+
+
+### Kitty Genes Reader / Report
+
+Pass in the id (e.g. `1`, `43`, etc.) of the kitty to print a genes report.
+Example:
+
+```
+$ kitty 1
+```
+
+prints:
+
+```
+# Kitty #1
+
+genes (kai): ccac 7787 fa7f afaa 1646 7755 f9ee 4444 6766 7366 cccc eede
+
+Fur (Genes 0-3)
+
+|Gene| Binary |Kai (Tier)| Trait      |    |
+|----|--------|----------|------------|----|
+| 0  | 01101  | e (I)    | **sphynx** | d  |
+| 1  | 01100  | d (I)    | munchkin ) | r1 |
+| 2  | 01101  | e (I)    | sphynx     | r2 |
+| 3  | 01101  | e (I)    | sphynx     | r3 |
+
+d = dominant, r1 = 1st order recessive, r2 = 2nd order recessive, r3 = 3rd order recessive
+
+Pattern (Genes 4-7)
+
+|Gene| Binary |Kai (Tier)| Trait      |    |
+|----|--------|----------|------------|----|
+| 4  | 01011  | c (I)    | **jaguar** | d  |
+| 5  | 01011  | c (I)    | jaguar     | r1 |
+| 6  | 01011  | c (I)    | jaguar     | r2 |
+| 7  | 01011  | c (I)    | jaguar     | r3 |
+
+Eye Color (Genes 8-11)
+
+|Gene| Binary |Kai (Tier)| Trait       |    |
+|----|--------|----------|-------------|----|
+| 8  | 00101  | 6 (I)    | **sizzurp** | d  |
+| 9  | 00101  | 6 (I)    | sizzurp     | r1 |
+| 10 | 00010  | 3 (I)    | topaz       | r2 |
+| 11 | 00110  | 7 (I)    | chestnut    | r3 |
+
+Eye Shape (Genes 12-15)
+
+|Gene| Binary  |Kai (Tier)| Trait      |    |
+|----|---------|----------|------------|----|
+| 12 | 00101   | 6 (I)    | **simple** | d  |
+| 13 | 00101   | 6 (I)    | simple     | r1 |
+| 14 | 00110   | 7 (I)    | crazy      | r2 |
+| 15 | 00101   | 6 (I)    | simple     | r3 |
+
+Base Color (Genes 16-19)
+
+|Gene| Binary |Kai (Tier)| Trait          |    |
+|----|--------|----------|----------------|----|
+| 16 | 00011  | 4 (I)    | **orangesoda** | d  |
+| 17 | 00011  | 4 (I)    | orangesoda     | r1 |
+| 18 | 00011  | 4 (I)    | orangesoda     | r2 |
+| 19 | 00011  | 4 (I)    | orangesoda     | r3 |
+
+Highlight Color (Genes 20-23)
+
+|Gene| Binary |Kai (Tier)| Trait        |    |
+|----|--------|----------|--------------|----|
+| 20 | 01101  | e (I)    | **lemonade** | d  |
+| 21 | 01101  | e (I)    | lemonade     | r1 |
+| 22 | 01000  | 9 (I)    | swampgreen   | r2 |
+| 23 | 01110  | f (I)    | chocolate    | r3 |
+
+Accent Color (Genes 24-27)
+
+|Gene| Binary |Kai (Tier)| Trait           |    |
+|----|--------|----------|-----------------|----|
+| 24 | 00100  | 5 (I)    | **granitegrey** | d  |
+| 25 | 00100  | 5 (I)    | granitegrey     | r1 |
+| 26 | 00110  | 7 (I)    | kittencream     | r2 |
+| 27 | 00110  | 7 (I)    | kittencream     | r3 |
+
+Wild (Genes 28-31)
+
+|Gene| Binary |Kai (Tier)| Trait   |    |
+|----|--------|----------|---------|----|
+| 28 | 00101  | 6 (I)    | **?**   |  d |
+| 29 | 00011  | 4 (I)    | ?       | r1 |
+| 30 | 00101  | 6 (I)    | ?       | r2 |
+| 31 | 00000  | 1 (I)    | ?       | r3 |
+
+Mouth (Genes 32-35)
+
+|Gene| Binary |Kai (Tier)| Trait        |   |
+|----|--------|----------|--------------|---|
+| 32 | 01001  | a (I)    | **pouty**    | d |
+| 33 | 01001  | a (I)    | pouty        | r1 |
+| 34 | 01110  | f (I)    | happygokitty | r2 |
+| 35 | 01001  | a (I)    | pouty        | r3 |
+```
+
+
+### Kitty Mix Genes (Matron + Sire) Report
+
+Pass in two ids for the matron and sire kitties to print a mix genes report.
+Example:
+
+
+```
+$ kitty 2 43
+```
+
+prints:
+
+```
+# Kitty #2 + #43
+
+genes (kai) 1: ca9c 7575 f442 af9g 6664 5557 7777 4444 6686 8667 cccc ffec
+genes (kai) 2: ca9a 7588 72a7 fa9f 4111 5555 dedf 4444 5888 4666 cccc fded
+
+Fur (Genes 0-3)
+
+|Gene|Kai|Trait (Matron) |Kai|Trait (Sire)  |    |
+|----|---|---------------|---|--------------|----|
+| 0  | c | **himalayan** | d | **munchkin** | d  |
+| 1  | e | sphynx        | e | sphynx       | r1 |
+| 2  | f | ragamuffin    | d | munchkin     | r2 |
+| 3  | f | ragamuffin    | f | ragamuffin   | r3 |
+
+d = dominant, r1 = 1st order recessive, r2 = 2nd order recessive, r3 = 3rd order recessive
+
+Pattern (Genes 4-7)
+
+|Gene|Kai|Trait (Matron)|Kai|Trait (Sire)|    |
+|----|---|--------------|---|------------|----|
+| 4  | c | **jaguar**   | c | **jaguar** | d  |
+| 5  | c | jaguar       | c | jaguar     | r1 |
+| 6  | c | jaguar       | c | jaguar     | r2 |
+| 7  | c | jaguar       | c | jaguar     | r3 |
+
+Eye Color (Genes 8-11)
+
+|Gene|Kai|Trait (Matron)|Kai|Trait (Sire) |    |
+|----|---|--------------|---|-------------|----|
+| 8  | 7 | **chestnut** | 6 | **sizzurp** | d  |
+| 9  | 6 | sizzurp      | 6 | sizzurp     | r1 |
+| 10 | 6 | sizzurp      | 6 | sizzurp     | r2 |
+| 11 | 8 | strawberry   | 4 | mintgreen   | r3 |
+
+Eye Shape (Genes 12-15)
+
+|Gene|Kai|Trait (Matron)|Kai|Trait (Sire)     |    |
+|----|---|--------------|---|-----------------|----|
+| 12 | 6 | **simple**   | 8 | **thicccbrowz** | d  |
+| 13 | 8 | thicccbrowz  | 8 | thicccbrowz     | r1 |
+| 14 | 6 | simple       | 8 | thicccbrowz     | r2 |
+| 15 | 6 | simple       | 5 | otaku           | r3 |
+
+Base Color (Genes 16-19)
+
+|Gene|Kai|Trait (Matron)  |Kai|Trait (Sire)    |    |
+|----|---|----------------|---|----------------|----|
+| 16 | 4 | **orangesoda** | 4 | **orangesoda** | d  |
+| 17 | 4 | orangesoda     | 4 | orangesoda     | r1 |
+| 18 | 4 | orangesoda     | 4 | orangesoda     | r2 |
+| 19 | 4 | orangesoda     | 4 | orangesoda     | r3 |
+
+Highlight Color (Genes 20-23)
+
+|Gene|Kai|Trait (Matron)   |Kai|Trait (Sire)   |    |
+|----|---|-----------------|---|---------------|----|
+| 20 | 7 | **royalpurple** | f | **chocolate** | d  |
+| 21 | 7 | royalpurple     | d | coffee        | r1 |
+| 22 | 7 | royalpurple     | e | lemonade      | r2 |
+| 23 | 7 | royalpurple     | d | coffee        | r3 |
+
+Accent Color (Genes 24-27)
+
+|Gene|Kai|Trait (Matron)   |Kai|Trait (Sire)     |    |
+|----|---|-----------------|---|-----------------|----|
+| 24 | 7 | **kittencream** | 5 | **granitegrey** | d  |
+| 25 | 5 | granitegrey     | 5 | granitegrey     | r1 |
+| 26 | 5 | granitegrey     | 5 | granitegrey     | r2 |
+| 27 | 5 | granitegrey     | 5 | granitegrey     | r3 |
+
+Wild (Genes 28-31)
+
+|Gene|Kai|Trait (Matron)|Kai|Trait (Sire)|    |
+|----|---|--------------|---|------------|----|
+| 28 | 4 | **?**        | 1 | **?**      | d  |
+| 29 | 6 | ?            | 1 | ?          | r1 |
+| 30 | 6 | ?            | 1 | ?          | r2 |
+| 31 | 6 | ?            | 4 | ?          | r3 |
+
+Mouth (Genes 32-35)
+
+|Gene|Kai|Trait (Matron) |Kai|Trait (Sire)      |    |
+|----|---|---------------|---|------------------|----|
+| 32 | g | **soserious** | f | **happygokitty** | d  |
+| 33 | 9 | beard         | 9 | beard            | r1 |
+| 34 | f | happygokitty  | a | pouty            | r2 |
+| 35 | a | pouty         | f | happygokitty     | r3 |
+```
+
+
+
+
+## Quick References / Cheat Sheets
+
+[Traits](TRAITS.md) - Traits (Cattributes) Charts with Mutation (Mewtations) Pairs and Tiers
+
+[Genes](GENES.md)  - Fur (0-3) • Pattern (4-7) • Eye Color (8-11) • Eye Shape (12-15) • Base Color (16-19) • Highlight Color (20-23) • Accent Color (24-27) • Wild (28-31) • Mouth (32-35) • Future 1 (36-39) • Future 2 (40-43) • Future 3 (44-47)
+
+
+
+
+## Installation - I Can Has Copycats?
+
+Use:
+
+```
+$ gem install copycats
+```
+
+
+
 ## License
 
 ![](https://publicdomainworks.github.io/buttons/zero88x31.png)

data/Rakefile

@@ -5,7 +5,7 @@ Hoe.spec 'copycats' do
 
   self.version = Copycats::VERSION
 
-  self.summary = "copycats - command line tool (and core library) crypto cats / kitties collectibles unchained - buy! sell! hodl! sire! - play for free - runs off the blockchain - no ether or gas required; run your own peer-to-peer (P2P) network node over HTTP"
+  self.summary = "copycats - command line tool (and core library) crypto cats / kitties collectibles unchained - buy! sell! hodl! sire! - play for free - runs off the blockchain w/ ledger lite - no ether / gas required; run your own peer-to-peer (P2P) network node over HTTP"
   self.description = summary
 
   self.urls    = ['https://github.com/openblockchains/copycats']
@@ -18,6 +18,8 @@ Hoe.spec 'copycats' do
   self.history_file = 'HISTORY.md'
 
   self.extra_deps = [
+    ['activerecord'],
+    ['sqlite3'],
   ]
 
   self.licenses = ['Public Domain']

data/bin/kitty

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+###################
+# DEV TIPS:
+#
+# For local testing run like:
+#
+#    ruby -I./lib bin/kitty
+#
+# Set the executable bit in Linux. Example:
+#
+#    % chmod a+x bin/kitty
+#
+
+require 'copycats'
+
+Copycats.main

data/lib/copycats.rb

@@ -4,12 +4,65 @@ require 'pp'        # for pp => pretty printer
 
 require 'date'
 require 'time'
+require 'uri'
 require 'json'
+require 'csv'
+require 'enumerator'    ## needed for each_slice
+require 'optparse'      # note: used for command line tool (see Tool in tool.rb)
 
+require 'logger'    # note: use for ActiveRecord::Base.logger -- remove/replace later w/ LogUtils::Logger ???
+
+## 3rd party gems
+require 'active_record'   ## todo: add sqlite3? etc.
 
 
 ## our own code
 require 'copycats/version'    # note: let version always go first
+require 'copycats/base32'
+require 'copycats/traits'
+require 'copycats/gene'
+require 'copycats/genome'
+
+require 'copycats/schema'
+require 'copycats/data'
+
+require 'copycats/models/kitty'
+
+require 'copycats/reports/kitty'
+require 'copycats/reports/mix'
+require 'copycats/reports/genes'
+require 'copycats/reports/traits'
+
+require 'copycats/tool'
+
+
+## add wrapper for allowing configuration of random number generator
+module Lottery
+
+  def self.random
+    @random ||= Random.new
+  end
+
+  def self.random=(value)
+    @random = value
+  end
+
+  def self.rand( arg=nil )
+    if arg.is_a? Integer
+      random.rand( arg )  ## max (number) = arg
+    else
+      random.rand     ## between 0.0 and 1.0 (as floating point number)
+    end
+  end
+end  ## module Lottery
+
+
+module Copycats
+## add command line binary (tool) e.g. $ try kitty -h
+  def self.main
+   Tool.new.run( ARGV )
+  end
+end
 
 
 

data/lib/copycats/base32.rb

@@ -0,0 +1,155 @@
+# encoding: utf-8
+
+
+class Base32   ## Base32  (2^5 - 5bits)
+
+  # See https://en.wikipedia.org/wiki/Base58
+  ALPHABET = "123456789abcdefghijkmnopqrstuvwx"
+  BASE     = ALPHABET.length   ## 32 chars/letters/digits
+
+  # Converts a base10 integer to a base32 string.
+  def self.encode( num )
+    buf = String.new
+    while num >= BASE
+      puts "num=#{num}"
+      mod = num % BASE
+      puts "  mod=#{mod} == #{ALPHABET[mod]}"
+      buf = ALPHABET[mod] + buf
+      puts "buf=#{buf}"
+      num = (num - mod)/BASE
+    end
+    ALPHABET[num] + buf
+  end
+
+
+  # Converts a base58 string to a base10 integer.
+  def self.decode( str )
+    num = 0
+    str.reverse.each_char.with_index do |char,index|
+      char_index = ALPHABET.index(char)
+      raise ArgumentError, 'Value passed not a valid Base32 String.'  if char_index.nil?
+      num += (char_index)*(BASE**(index))
+    end
+    num
+  end
+
+
+## simple hash map (helper) for conversion to binary string
+BINARY = {
+  '1' => '00000',    # 0
+  '2' => '00001',    # 1
+  '3' => '00010',    # 2
+  '4' => '00011',    # 3
+  '5' => '00100',    # 4
+  '6' => '00101',    # 5
+  '7' => '00110',    # 6
+  '8' => '00111',    # 7
+  '9' => '01000',    # 8
+  'a' => '01001',    # 9
+  'b' => '01010',    # 10
+  'c' => '01011',    # 11
+  'd' => '01100',    # 12
+  'e' => '01101',    # 13
+  'f' => '01110',    # 14
+  'g' => '01111',    # 15
+  'h' => '10000',    # 16
+  'i' => '10001',    # 17
+  'j' => '10010',    # 18
+  'k' => '10011',    # 19
+  'm' => '10100',    # 20
+  'n' => '10101',    # 21
+  'o' => '10110',    # 22
+  'p' => '10111',    # 23
+  'q' => '11000',    # 24
+  'r' => '11001',    # 25
+  's' => '11010',    # 26
+  't' => '11011',    # 27
+  'u' => '11100',    # 28
+  'v' => '11101',    # 29
+  'w' => '11110',    # 30
+  'x' => '11111'     # 31
+}
+
+NUMBER = {    ## rename INTEGER /INT - why? why not??
+  '1' => 0,
+  '2' => 1,
+  '3' => 2,
+  '4' => 3,
+  '5' => 4,
+  '6' => 5,
+  '7' => 6,
+  '8' => 7,
+  '9' => 8,
+  'a' => 9,
+  'b' => 10,
+  'c' => 11,
+  'd' => 12,
+  'e' => 13,
+  'f' => 14,
+  'g' => 15,
+  'h' => 16,
+  'i' => 17,
+  'j' => 18,
+  'k' => 19,
+  'm' => 20,
+  'n' => 21,
+  'o' => 22,
+  'p' => 23,
+  'q' => 24,
+  'r' => 25,
+  's' => 26,
+  't' => 27,
+  'u' => 28,
+  'v' => 29,
+  'w' => 30,
+  'x' => 31
+}
+
+## add shortcuts (convenience) aliases
+BIN = BINARY
+NUM = NUMBER
+
+
+#############################
+#  Tier 1    Tier 2    Tier 3    Tier 4    Tier 5
+##  (1-g)     (h-p)     (q-t)     (u,v)      (w)
+
+TIER = {    ## todo/fix: use an algo to calculate - why? why not?
+  '1' => 1,
+  '2' => 1,
+  '3' => 1,
+  '4' => 1,
+  '5' => 1,
+  '6' => 1,
+  '7' => 1,
+  '8' => 1,
+  '9' => 1,
+  'a' => 1,
+  'b' => 1,
+  'c' => 1,
+  'd' => 1,
+  'e' => 1,
+  'f' => 1,
+  'g' => 1,
+  'h' => 2,
+  'i' => 2,
+  'j' => 2,
+  'k' => 2,
+  'm' => 2,
+  'n' => 2,
+  'o' => 2,
+  'p' => 2,
+  'q' => 3,
+  'r' => 3,
+  's' => 3,
+  't' => 3,
+  'u' => 4,
+  'v' => 4,
+  'w' => 5,
+  'x' => nil
+}
+
+end # class Base32
+
+## add a shortcut (convenience) alias
+Kai = Base32