copycats 0.0.1 → 0.5.0

data/lib/copycats/reports/kitty.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+class KittyReport
+
+  def initialize( *args, **kwargs )
+    if args.empty? # try keyword args
+      @id   = kwargs[:id]
+      @kai  = kwargs[:genes]   ## todo/check: also incl. check for kai key - why? why not?
+    else
+      # try positional args
+      ##  for now alsways assume ActiveRecord - Kitty::Model
+      kitty = args[0]
+      @id   = kitty.id
+      @kai  = fmt_kai( kitty.genes )    ## pretty print in groups of four (4)
+    end
+  end
+
+  def build
+    buf = "# Kitty \##{@id}\n\n"
+    buf << "genes (kai): #{@kai}\n\n"
+    buf << Genome.new( @kai ).build_tables
+
+    ## puts buf
+
+    buf
+  end
+
+  def save( path )
+    File.open( path, "w" ) do |f|
+      f.write build
+    end
+  end
+
+
+#####
+#  helpers
+  def fmt_kai( kai )
+    ## format in groups of four (4) separated by space
+    ##  e.g.  ccac7787fa7fafaa16467755f9ee444467667366cccceede
+    ##     :  ccac 7787 fa7f afaa 1646 7755 f9ee 4444 6766 7366 cccc eede
+    kai.reverse.gsub( /(.{4})/, '\1 ').reverse.strip
+  end
+
+
+end  # class KittyReport

data/lib/copycats/reports/mix.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+class MixReport
+
+  def initialize( matron, sire )
+    @matron_id   = matron.id
+    @sire_id     = sire.id
+    @matron_kai  = fmt_kai( matron.genes )    ## pretty print in groups of four (4)
+    @sire_kai    = fmt_kai( sire.genes )
+  end
+
+
+  def build
+    buf = "# Kitty \##{@matron_id} + \##{@sire_id}\n\n"
+    buf << "genes (kai) 1: #{@matron_kai}\n"
+    buf << "genes (kai) 2: #{@sire_kai}\n\n"
+
+    buf << Genome.new( @matron_kai ).build_mix_tables( Genome.new( @sire_kai ))
+
+    ## puts buf
+    buf
+  end
+
+
+## fix/todo: use "generic" report class (inherits save)!!!!!
+  def save( path )
+    File.open( path, "w" ) do |f|
+      f.write build
+    end
+  end
+
+
+
+#####
+#  helpers
+#    todo: move to helpers module for (re)use
+  def fmt_kai( kai )
+    ## format in groups of four (4) separated by space
+    ##  e.g.  ccac7787fa7fafaa16467755f9ee444467667366cccceede
+    ##     :  ccac 7787 fa7f afaa 1646 7755 f9ee 4444 6766 7366 cccc eede
+    kai.reverse.gsub( /(.{4})/, '\1 ').reverse.strip
+  end
+
+
+end  # class KittyReport

data/lib/copycats/reports/traits.rb

@@ -0,0 +1,122 @@
+# encoding: utf-8
+
+class TraitsReport
+
+ROMAN = {
+  1 => 'I',
+  2 => 'II',
+  3 => 'III',
+  4 => 'IIII',
+  5 => 'V'
+}
+
+
+def build
+  buf = ""
+  buf << "# Traits\n\n"
+
+  buf << "| Tier | Kai |"
+  TRAITS.values[0,6].each do |trait|
+    buf << " #{trait[:name]} |"
+  end
+  buf << "\n"
+  buf << "|----|----|----|----|----|----|----|----|\n"
+
+  buf << "|    |    |"
+  TRAITS.values[0,6].each do |trait|
+    buf << " #{trait[:genes]} |"
+  end
+  buf << "\n"
+
+  Kai::ALPHABET.each_char do |kai|
+    tier = ROMAN[ Kai::TIER[kai] ]
+    tier = '?'  if tier.nil?
+    buf << "| #{tier} | #{kai} |"
+    TRAITS.values[0,6].each do |trait|
+      value = trait[:kai][kai]
+      value = '?'  if value.nil? || value.empty?
+      buf << " #{value} |"
+    end
+    buf << "\n"
+  end
+  buf << "\n\n"
+
+  ## part ii (split into two tables)
+  buf << "| Tier | Kai |"
+  TRAITS.values[6,6].each do |trait|
+    buf << " #{trait[:name]} |"
+  end
+  buf << "\n"
+  buf << "|----|----|----|----|----|----|----|----|\n"
+
+  buf << "|    |    |"
+  TRAITS.values[6,6].each do |trait|
+    buf << " #{trait[:genes]} |"
+  end
+  buf << "\n"
+
+  Kai::ALPHABET.each_char do |kai|
+    tier = ROMAN[ Kai::TIER[kai] ]
+    tier = '?'  if tier.nil?
+    buf << "| #{tier} | #{kai} |"
+    TRAITS.values[6,6].each do |trait|
+      value = trait[:kai][kai]
+      value = '?'  if value.nil? || value.empty?
+      buf << " #{value} |"
+    end
+    buf << "\n"
+  end
+  buf << "\n\n"
+
+
+  buf += <<TXT
+## Mutations / Mewtations
+
+16 Mutation Pairs (16 x 2 = 32)
+
+```
+Tier I    Tier II   Tier III  Tier IIII  Tier V
+ (1-g)     (h-p)     (q-t)     (u,v)      (w)
+1+2 = h   h+i = q   q+r = u   u+v = w
+3+4 = i   j+k = r   s+t = v
+5+6 = j   m+n = s
+7+8 = k   o+p = t
+9+a = m
+b+c = n
+d+e = o
+f+g = p
+```
+
+Note: It's impossible for a mutation to reach `x` e.g. `w+x = x`.
+
+## Kai (Base32) Notation
+
+|Kai    |Binary |Num|Kai    |Binary |Num|Kai    |Binary |Num|Kai    |Binary |Num|
+|-------|-------|---|-------|-------|---|-------|-------|---|-------|-------|---|
+| **1** | 00000 | 0 | **9** | 01000 | 8 | **h** | 10000 |16 | **q** | 11000 |24 |
+| **2** | 00001 | 1 | **a** | 01001 | 9 | **i** | 10001 |17 | **r** | 11001 |25 |
+| **3** | 00010 | 2 | **b** | 01010 | 10| **j** | 10010 |18 | **s** | 11010 |26 |
+| **4** | 00011 | 3 | **c** | 01011 | 11| **k** | 10011 |19 | **t** | 11011 |27 |
+| **5** | 00100 | 4 | **d** | 01100 | 12| **m** | 10100 |20 | **u** | 11100 |28 |
+| **6** | 00101 | 5 | **e** | 01101 | 13| **n** | 10101 |21 | **v** | 11101 |29 |
+| **7** | 00110 | 6 | **f** | 01110 | 14| **o** | 10110 |22 | **w** | 11110 |30 |
+| **8** | 00111 | 7 | **g** | 01111 | 15| **p** | 10111 |23 | **x** | 11111 |31 |
+
+Note: The digit-0 and the letter-l are NOT used in kai.
+
+TXT
+
+
+  puts buf
+
+  buf
+end ## method build
+
+
+  def save( path )
+    File.open( path, "w" ) do |f|
+      f.write build
+    end
+  end
+
+end # class TraitsReport

data/lib/copycats/schema.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+class CreateDb
+
+def up
+
+ActiveRecord::Schema.define do
+
+create_table :kitties do |t|
+  ### t.integer :ref,    null: false    ## reference id - todo - find a better name e.g. uid (for unique id?) or gid?
+  ## note: use built-in id for id!!!!
+  
+  t.string  :name      ## optional name e.g. Genesis, Galaxy Cat, etc.
+  t.string  :genes     ## genes in kai format
+  t.integer :gen       ## generation e.g. 0,1,2,etc.
+end
+
+
+end # block Schema.define
+
+end # method up
+
+end # class CreateDb

data/lib/copycats/tool.rb

@@ -0,0 +1,66 @@
+# encoding: utf-8
+
+module Copycats
+
+class Tool
+
+def run( args )
+  opts = {}
+
+  parser = OptionParser.new do |cmd|
+    cmd.banner = "Usage: kitty [options]"
+
+    cmd.separator ""
+    cmd.separator "  Data options:"
+
+    cmd.on("-i", "--include=DIR", "Data directory (default: ./data)") do |name|
+      opts[:data_dir] = name
+    end
+
+    cmd.separator ""
+    cmd.separator "  General options:"
+
+    cmd.on("-h", "--help", "Prints this help") do
+      puts cmd
+      exit
+    end
+  end
+
+  parser.parse!( args )
+  pp opts
+
+
+  data_dir = opts[:data_dir] || './data'
+
+  setup( data_dir: data_dir )
+
+  pp args
+
+  if args.size == 1
+    id = args[0].to_i
+    kitty = Copycats::Model::Kitty.find( id )
+    ## pp k
+
+    buf = KittyReport.new( kitty ).build
+
+    puts buf
+  elsif args.size == 2
+    matron_id = args[0].to_i
+    sire_id   = args[1].to_i
+
+    matron = Copycats::Model::Kitty.find( matron_id )
+    sire   = Copycats::Model::Kitty.find( sire_id )
+    ## pp matron
+
+    buf = MixReport.new( matron, sire ).build
+
+    puts buf
+  else
+    puts "error: too many arguments (expected one or two kitty ids / names / genes)"
+  end
+end  ## method run
+
+
+end   ## class Tool
+
+end   ## module Copycats

data/lib/copycats/traits.rb

@@ -0,0 +1,298 @@
+# encoding: utf-8
+
+###
+#  trais / kaittributes
+#   see https://cryptokittydex.com/kaittributes
+#       https://docs.google.com/spreadsheets/d/1ShiBKSglFAB2vJe4Uow3iF09FBVq6ZAaOzTCIECf4iA
+#       http://www.rolldice.club/cryptokitties/wkt_tree.php
+#
+
+
+
+## ordered by gene position (0,1,3.4,5,... etc.)
+##  12 traits (4 genes each)
+TRAITS =
+{
+  body: {
+    genes: '0-3',
+    name:  'Fur',
+    kai: {
+    '1' => 'savannah',
+    '2' => 'selkirk',
+    '3' => '',
+    '4' => 'birman',
+    '5' => '',
+    '6' => 'bobtail',
+    '7' => '',
+    '8' => '',
+    '9' => '',
+    'a' => 'cymric',
+    'b' => 'chartreux',
+    'c' => 'himalayan',
+    'd' => 'munchkin',
+    'e' => 'sphynx',
+    'f' => 'ragamuffin',
+    'g' => 'ragdoll',
+    'h' => 'norwegianforest',
+    'i' => '',
+    'j' => '',
+    'k' => '',
+    'm' => '',
+    'n' => 'mainecoon',
+    'o' => 'laperm',
+    'p' => 'persian',
+    'q' => '',
+    'r' => '',
+    's' => '',
+    't' => 'manx',
+    'u' => '',
+    'v' => '',
+    'w' => '',
+    'x' => ''
+    }
+  },
+  pattern: {
+    genes: '4-7',
+    name: 'Pattern',
+    kai: {
+    '1' => '',
+    '2' => 'tiger',
+    '3' => '',
+    '4' => 'ganado',
+    '5' => 'leopard',
+    '6' => 'camo ',
+    '7' => '',
+    '8' => 'spangled',
+    '9' => 'calicool',
+    'a' => 'luckystripe',
+    'b' => 'amur',
+    'c' => 'jaguar',
+    'd' => 'spock',
+    'e' => '',
+    'f' => 'totesbasic',  ## use totesbasic_f - why? why not?
+    'g' => 'totesbasic',  ## use totesbasic_g
+    'h' => '',
+    'i' => '',
+    'j' => 'dippedcone',
+    'k' => '',
+    'm' => 'tigerpunk',
+    'n' => 'henna',
+    'o' => '',
+    'p' => 'totesbasic',  ## use totesbasic_p
+    'q' => '',
+    'r' => '',
+    's' => 'hotrod',
+    't' => '',
+    'u' => '',
+    'v' => '',
+    'w' => '',
+    'x' => ''
+    }
+  },
+  coloreyes: {
+    genes: '8-11',
+    name:  'Eye Color',
+    kai: {
+    '1' => 'thundergrey',
+    '2' => 'gold',
+    '3' => 'topaz',
+    '4' => 'mintgreen',
+    '5' => '',
+    '6' => 'sizzurp',
+    '7' => 'chestnut',
+    '8' => 'strawberry',
+    '9' => 'sapphire',
+    'a' => 'forgetmenot',
+    'b' => '',
+    'c' => 'coralsunrise',
+    'd' => '',
+    'e' => '',
+    'f' => '',
+    'g' => '',
+    'h' => 'pumpkin',
+    'i' => 'limegreen',
+    'j' => '',
+    'k' => 'bubblegum',
+    'm' => 'twilightsparkle',
+    'n' => '',
+    'o' => '',
+    'p' => '',
+    'q' => 'babypuke',
+    'r' => '',
+    's' => '',
+    't' => '',
+    'u' => '',
+    'v' => '',
+    'w' => '',
+    'x' => ''
+    }
+  },
+  eyes: {
+    genes: '12-15',
+    name: 'Eye Shape', ##  eye type
+    kai: {
+    '2' => 'wonky',
+    '3' => 'serpent',
+    '4' => 'googly',
+    '5' => 'otaku',
+    '6' => 'simple',
+    '7' => 'crazy',
+    '8' => 'thicccbrowz',
+    'b' => 'baddate',
+    'd' => 'chronic',
+    'e' => 'slyboots',
+    'f' => 'wiley',
+    'g' => 'stunned',
+    'i' => 'alien',
+    'j' => 'fabulous',
+    'k' => 'raisedbrow',
+    'o' => 'sass',
+    'p' => 'sweetmeloncakes',
+    'r' => 'wingtips',
+    't' => 'buzzed'
+    }
+  },
+  color1: {
+    genes: '16-19',
+    name: 'Base Color',   ##  colorprimary / body color
+    kai: {
+    '1' => 'shadowgrey',
+    '2' => 'salmon',
+    '4' => 'orangesoda',
+    '5' => 'cottoncandy',
+    '6' => 'mauveover',
+    '7' => 'aquamarine',
+    '8' => 'nachocheez',
+    '9' => 'harbourfog',
+    'b' => 'greymatter',
+    'f' => 'hintomint',
+    'g' => 'bananacream',
+    'h' => 'cloudwhite',
+    'j' => 'oldlace',
+    'k' => 'koala',
+    'p' => 'verdigris',
+    'r' => 'onyx'
+    }
+  },
+  color2: {
+    genes: '20-23',
+    name:  'Highlight Color',  ## colorsecondary / sec color / pattern color
+    kai: {
+    '3' => 'egyptiankohl',
+    '5' => 'lilac',
+    '6' => 'apricot',
+    '7' => 'royalpurple',
+    '9' => 'swampgreen',
+    'a' => 'violet',
+    'b' => 'scarlet',
+    'c' => 'barkbrown',
+    'd' => 'coffee',
+    'e' => 'lemonade',
+    'f' => 'chocolate',
+    'j' => 'turtleback',
+    'm' => 'wolfgrey',
+    'n' => 'cerulian',
+    'o' => 'skyblue',
+    's' => 'royalblue'
+    }
+  },
+  color3: {
+    genes: '24-27',
+    name: 'Accent Color',  ## colortertiary
+    kai: {
+    '1' => 'belleblue',
+    '2' => 'sandalwood',
+    '3' => 'peach',
+    '4' => 'icy',
+    '5' => 'granitegrey',
+    '6' => '',
+    '7' => 'kittencream',
+    '8' => 'emeraldgreen',
+    '9' => '',
+    'a' => '',
+    'b' => 'purplehaze',
+    'c' => '',
+    'd' => 'azaleablush',
+    'e' => 'missmuffett',
+    'f' => 'morningglory',
+    'g' => '',
+    'h' => 'daffodil',
+    'i' => 'flamingo',
+    'j' => '',
+    'k' => 'bloodred',
+    'm' => '',
+    'n' => '',
+    'o' => 'periwinkle',
+    'p' => '',
+    'q' => 'seafoam',
+    'r' => '',
+    's' => '',
+    't' => '',
+    'u' => '',
+    'v' => '',
+    'w' => '',
+    'x' => ''
+    }
+  },
+  wild: {
+    genes: '28-31',
+    name: 'Wild',
+    kai: {
+    'i' =>  'elk',
+    'k' =>  'trioculus'
+    }
+  },
+  mouth: {
+    genes: '32-35',
+    name:  'Mouth',
+    kai: {
+    '1' => 'whixtensions',
+    '2' => 'wasntme',
+    '3' => 'wuvme',
+    '4' => 'gerbil',
+    '5' => '',
+    '6' => '',
+    '7' => '',
+    '8' => '',
+    '9' => 'beard',
+    'a' => 'pouty',
+    'b' => 'saycheese',
+    'c' => 'grim',
+    'd' => '',
+    'e' => '',
+    'f' => 'happygokitty',
+    'g' => 'soserious',
+    'h' => 'cheeky',
+    'i' => 'starstruck',
+    'j' => '',
+    'k' => '',
+    'm' => 'dali',
+    'n' => 'grimace',
+    'o' => '',
+    'p' => 'tongue',
+    'q' => 'yokel',
+    'r' => '',
+    's' => 'neckbeard',
+    't' => '',
+    'u' => '',
+    'v' => '',
+    'w' => '',
+    'x' => ''
+   }
+  },
+  future1: {
+      genes: '36-39',
+      name: 'Future 1',
+      kai: { }   ## use alpha_1, alpha_2, ... - why? why not?
+  },
+  future2: {
+      genes: '40-43',
+      name: 'Future 2',
+      kai: { }   ## use beta_1, beta_2, ... - why? why not?
+  },
+  future3: {
+      genes: '44-47',
+      name: 'Future 3',
+      kai: { }   ## use gamma_1, gamma_2, ... - why? why not?
+  }
+}