kittyverse 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e56df36f3f3c53df42e7ecd83ebda939624943f1
-  data.tar.gz: 4bfcfff584c9e0329c2dfe5de70bf262dd605cd2
+  metadata.gz: 4216c923457a71aed326af9ffa9146848c4866ff
+  data.tar.gz: 4b2063cee7ba1b685581bbe1b915afff47701d5b
 SHA512:
-  metadata.gz: 6ad27041804377e2ed42ab9161f74a03a601f154b80af45972a96bdf4c233866ec5f10aafbb165b6f173a39eaaaa8d130dab2ec66300ffaff79992fd57359983
-  data.tar.gz: 585438e11230eaf60ad40115045a6a3198934f14fb0d7d35f8eb2cac6ceb4df01289244f280ae3c817fdb4d482d87239c23466ce3713fa02d5a9da4f9a9f0ab9
+  metadata.gz: abe587be776050fb01626c8cc4650c069e75c08201f31a847b2cd7e6f0b9bc107e2c1aab09e3e52e0b3d7fb3d1aa459e7280cdeaa7ddb83bb2ea3d4c013daf15
+  data.tar.gz: 8e7a2babf9c0110a75135e41c34f0572d6a4c77b0e64085e64bb309f6a5b8ef7b1f39133e20c0361e2eea3b0a31f7fbe21f452c70375593a78b23ea8b4a4de8f

data/Manifest.txt

@@ -13,6 +13,7 @@ lib/kittyverse/fancies.rb
 lib/kittyverse/links.rb
 lib/kittyverse/mewtations.rb
 lib/kittyverse/pages/genes.rb
+lib/kittyverse/recipes.rb
 lib/kittyverse/traits.rb
 lib/kittyverse/version.rb
 test/helper.rb

data/README.md

@@ -206,6 +206,8 @@ end
 Auto-generated CryptoKitties reference pages / cheat sheets include:
 
 - [**CryptoKitties Cattributes Rarity / Popularity Statistics**](CATTRIBUTES.md)
+- [**CryptoKitties Genome / Genes Cheat Sheet**](GENES.md) - Fur (FU) • Pattern (PA) • Eye Color (EC) • Eye Shape (ES) • Base Color (BC) • Highlight Color (HC) • Accent Color (AC) • Wild Element (WE) • Mouth (MO) • Environment (EN) • Secret Y Gene (SE) • Purrstige (PU)
+- [**CryptoKitties Traits Cheat Sheet (with Codes, Mewtation Levels / Tiers, Search Links and More)**](TRAITS.md)
 - [**CryptoKitties Updates - Fancy / Exclusive / Special Edition Cats - Timeline**](updates/FANCIES.md)
 - [**CryptoKitties Updates - Purrstige Trait Recipes / Formulas - Timeline**](updates/PURRSTIGES.md)
 - and others

data/lib/kittyverse.rb

@@ -23,7 +23,7 @@ require 'kittyverse/links'
 
 require 'kittyverse/pages/genes'
 
-
+require 'kittyverse/recipes'
 require 'kittyverse/traits'
 require 'kittyverse/cattributes'
 require 'kittyverse/fancies'
@@ -31,4 +31,4 @@ require 'kittyverse/fancies'
 
 
 # say hello
-puts Kittyverse.banner    if defined?($RUBYLIBS_DEBUG) && $RUBYLIBS_DEBUG
+puts Kittyverse.banner    if defined?($RUBYCOCO_DEBUG) && $RUBYCOCO_DEBUG

data/lib/kittyverse/cattributes.rb

@@ -36,7 +36,8 @@ class Cattribute
                 :key,
                 :name,
                 :traits,
-                :recipe
+                :recipe,
+                :count
 
   def initialize( **kwargs )
     update( kwargs )
@@ -107,12 +108,19 @@ class Cattribute
     puts "key: #{key}"
     pp h
 
+    recipe = Recipe.new(
+              traits:     h[:recipe][:traits],      ## todo/fix: turn strings into trait objs!!!!
+              limit:      h[:recipe][:limit],
+              time_start: h[:recipe][:time] && h[:recipe][:time][:start] ? Date.strptime( h[:recipe][:time][:start], '%Y-%m-%d' ) : nil,
+              time_end:   h[:recipe][:time] && h[:recipe][:time][:end]   ? Date.strptime( h[:recipe][:time][:end],   '%Y-%m-%d' ) : nil )
+
     cattribute = Cattribute.new(
                      key:    key,
                      name:   h[:name],
                      type:   tt,
                      traits: [],  ## empty traits
-                     recipe: h[:recipe]  ## todo/fix: add recipe as a struct (NOT as a hash)
+                     count:  h[:recipe][:count],   # note: add count from recipe hash (NOT incl. in recipe struct)
+                     recipe: recipe
                    )
     tt.cattributes << cattribute
 

data/lib/kittyverse/config/fancies.rb

@@ -30,19 +30,41 @@
 
 FANCIES =
 {
+  'curdlin': { name: 'Curdlin',
+                recipe: {
+                  time: { start: '2019-05-11', end: '2019-11-30' }, count: 4,
+                  traits: ['nachocheez', 'saycheese', 'missmuffett', 'dippedcone']},
+                desc: 'Cheeze Wizard Cat - Celebrating the Launch of the Cheeze Wizards on the Blockchain'
+                ## see https://www.cryptokitties.co/blog/post/things-are-getting-cheezy-in-cryptokitties
+             },
+
+  'kitt-e': { name: 'KITT-E', date: '2019-05-10',
+              specialedition: {
+                limit: 500 },
+              desc: 'Dapper (Crypto Contract) Wallet Promotion Cat'
+            },
+  'dapp-e': { name: 'DAPP-E', date: '2019-05-10',
+              exclusive: {
+                limit: 50, ids: (1829..1878).to_a },
+              desc: 'Dapper (Crypto Contract) Wallet Promotion Cat'
+            },
+
   # Apr 27, 2019
   # Krakitten Fancy Cat is discovered. Fancy Cat
   krakitten: { name: 'Krakitten',
                recipe: {
-                 time: { start: '2019-04-27', end: '2019-05-06' },
-                 traits: ['cobalt', 'ducky', 'salty', 'splat']}
+                 time: { start: '2019-04-27', end: '2019-05-06' }, count: 1221,
+                 traits: ['cobalt', 'ducky', 'salty', 'splat']},
+                 ## desc: 'Beware the Krakitten in the briny deep.'
              },
   # Apr 13, 2019
   # Furbeard Fancy Cat is discovered. Fancy Cat
-  furbeard: { name: 'Furbeard', date: '2019-04-13',
+  furbeard: { name: 'Furbeard',
               recipe: {
-                limit: 3733,  ### todo -check if furbear was time windowed???
-                traits: ['inflatablepool', 'hanauma', 'neckbeard']}
+                time: { start: '2019-04-13', end: '2019-04-26'}, count: 3733,
+                traits: ['inflatablepool', 'hanauma', 'neckbeard']},
+                desc: 'Dread Pirate Cat'   # Avast Ye! This Old Salt knows a few tricks: how to avoid a meowtiny, how to get out of swabbing the litter deck, and just where the captain's log is buried.
+                ## see https://www.cryptokitties.co/blog/post/pirate-cats-are-plundering-cryptokitties/
             },
 
   # Apr 10, 2019
@@ -63,7 +85,7 @@ FANCIES =
   # Glitter Fancy Cat is discovered. Fancy Cat
   glitter: { name: 'Glitter',
              recipe: {
-               time: { start: '2019-03-30', end: '2019-11-30'},
+               time: { start: '2019-03-30', end: '2019-11-30'},  count: 658,   ## note: ++count NOT FINAL!!!
                traits: ['rorschach', 'juju', 'unicorn', 'hyacinth'] }
            },
 
@@ -118,14 +140,14 @@ FANCIES =
   # Al Fancy Cat is discovered. Fancy Cat
   al: { name: 'Al',
         recipe: {
-          time: { start: '2019-02-17', end: '2019-12-01'},
+          time: { start: '2019-02-17', end: '2019-12-01'}, count: 3209, ## note: count NOT FINAL!!!
           traits: ['munchkin','moue','cashewmilk','brownies'] }
       },
   # Feb 16, 2019
   # Pizzazz Fancy Cat is discovered.Fancy Cat
   pizzazz: { name: 'Pizzazz',
              recipe: {
-               time: { start: '2019-02-16', end: '2019-12-01'},
+               time: { start: '2019-02-16', end: '2019-12-01'}, count: 1438, ## note: count NOT FINAL!!!
                traits: ['mekong', 'scarlet', 'spangled', 'wonky'] }
            },
 
@@ -138,11 +160,12 @@ FANCIES =
 
   # Feb 9, 2019
   # Miss Purrfect Fancy Cat is discovered.Fancy Cat
-  misspurrfect: { name: 'Miss Purrfect', date: '2019-02-09',
+  misspurrfect: { name: 'Miss Purrfect',
                   recipe: {
-                    limit: 1298,
+                    time: { start: '2019-02-09', end: '2019-02-14'}, count: 1298,
                     traits: ['allyouneed', 'butterscotch', 'asif', 'satiated', 'flapflap']},
                   desc: "Celebrating St. Valentine's Day 2019 (Feb/14th)"
+                  ## see https://www.cryptokitties.co/blog/post/how-to-breed-miss-purrfect/
                 },
 
   ## 2019
@@ -152,9 +175,10 @@ FANCIES =
   # Squib Fancy Cat is discovered. Fancy Cat
   squib: { name: 'Squib', date: '2019-01-26',
            recipe: {
-             limit: 1443,
+             limit: 1443,    ## todo/check:  check if time-windows?
              traits: ['oldlace', 'razzledazzle', 'buzzed', 'rollercoaster']},
            desc: 'Celebrating American Football Super Bowl LIII in 2019'
+           ## see https://www.cryptokitties.co/blog/post/how-to-breed-squib/
          },
 
   tallythepurrocious: { name: 'Tally The Purrocious',
@@ -195,7 +219,7 @@ FANCIES =
             },
   pawrula:  { name: 'Pawrula the Bright',
               recipe: {
-                 time: { start: '2018-12-15', end: '2019-11-30' },
+                 time: { start: '2018-12-15', end: '2019-11-30' }, count: 1952,  ## note: count NOT FINAL!!!
                  traits: ['camo', 'butterscotch', 'fox'] },
               desc: 'Neha Narula - Director of the Digital Currency Initiative at the MIT Media Lab'
             },
@@ -367,7 +391,7 @@ FANCIES =
   ## May
   page:              { name: 'Page', date: '2018-05-31',
                        recipe: {
-                         limit: 50_000,
+                         limit: 50_000,   count: 3936,  ## note: count NOT FINAL!!!
                          traits: ['rascal', 'peach', 'wasntme' ]}
                      },
   "schrödingerscat": { name: "Schrödinger's Cat", date: '2018-05-20',
@@ -512,7 +536,7 @@ FANCIES =
   santaclaws:   { name: 'Santa Claws', date: '2017-12-12',
                   recipe: {
                     limit: 1000, overflow: 2,
-                    traits: ['cloudwhite','scarlet','beard','wild_d'] },
+                    traits: ['cloudwhite','scarlet','beard','WE12'] },
                   desc: 'Ho Ho Ho - Santa Claus Kitty'
                 },
   mistletoe:    { name: 'Mistletoe', date: '2017-12-09',

data/lib/kittyverse/config/purrstiges.rb

@@ -57,43 +57,43 @@ squelch: { name: 'Squelch',
 #  Scratchingpost trait is discovered. Purrstige
 scratchingpost: { name: 'Scratchingpost',
                   recipe: {
-                    time: { start: '2019-04-13', end: '2019-05-10' },
+                    time: { start: '2019-04-13', end: '2019-05-10' }, count: 772,
                     traits: ['WE10', 'PU26'] }
                 },
 #  Hooked trait is discovered. Purrstige
 hooked: { name: 'Hooked',
           recipe: {
-            time: { start: '2019-04-13', end: '2019-05-10' },
+            time: { start: '2019-04-13', end: '2019-05-10' }, count: 1277,
             traits: ['WE10', 'PU27'] }
         },
 #  Landlubber trait is discovered. Purrstige
 landlubber: { name: 'Landlubber',
               recipe: {
-                time: { start: '2019-04-13', end: '2019-05-10' },
+                time: { start: '2019-04-13', end: '2019-05-10' }, count: 711,
                 traits: ['WE10', 'PU29'] }
             },
 # Wrecked trait is discovered. Purrstige
 wrecked: { name: 'Wrecked',
            recipe: {
-             time: { start: '2019-04-13', end: '2019-05-10' },
+             time: { start: '2019-04-13', end: '2019-05-10' }, count: 959,
              traits: ['EN00', 'PU26'] }
           },
 # Purrbados trait is discovered. Purrstige
 purrbados: { name: 'Purrbados',
              recipe: {
-               time: { start: '2019-04-13', end: '2019-05-10' },
+               time: { start: '2019-04-13', end: '2019-05-10' }, count: 1344,
                traits: ['EN01', 'PU26'] }
             },
 # Timbers trait is discovered. Purrstige
 timbers: { name: 'Timbers',
            recipe: {
-             time: { start: '2019-04-13', end: '2019-05-10' },
+             time: { start: '2019-04-13', end: '2019-05-10' }, count: 472,
              traits: ['WE10', 'EN00', 'PU26'] }
           },
 # Maraud trait is discovered. Purrstige
 maraud: { name: 'Maraud',
           recipe: {
-            time: { start: '2019-04-13', end: '2019-05-10' },
+            time: { start: '2019-04-13', end: '2019-05-10' }, count: 620,
             traits: ['WE10', 'EN01', 'PU26'] }
         },
 

data/lib/kittyverse/config/traits.rb

@@ -95,7 +95,7 @@ TRAITS =
     genes: '8-11',
     name:  'Eye Color', code: 'EC',
     kai: {
-    '1' => 'Hundergrey',
+    '1' => 'Thundergrey',
     '2' => 'Gold',
     '3' => 'Topaz',
     '4' => 'Mintgreen',
@@ -375,3 +375,53 @@ TRAITS =
       ##  prune, furball, duckduckcat, or thatsawrap - more like fancies (not really traits)
   }
 }
+
+
+# quick hack - map copycats keys to (internal) cryptokitties trait type keys
+#  note: all keys are the same except:
+ALT_TRAIT_TYPE_KEYS =
+{
+  :color1    => :colorprimary,
+  :color2    => :colorsecondary,
+  :color3    => :colortertiary,
+  :purrstige => :prestige,
+  ## add :fur, etc. too - why? why not?
+}
+
+ALT_TRAIT_TYPE_NAMES =
+{
+  'body'             => 'fur',
+  'eyes'             => 'eye shape',
+  'eye type'         => 'eye shape',
+  'body color'       => 'base color',
+  'primary color'    => 'base color',
+  'base colour'      => 'base color',       # british (canadian) spelling
+  'secondary color'  => 'highlight color',
+  'sec color'        => 'highlight color',
+  'pattern color'    => 'highlight color',
+  'highlight colour' => 'highlight color',  # british (canadian) spelling
+  'tertiary color'   => 'accent color',
+  'accent colour'    => 'accent color',     # british (canadian) spelling
+  'wild'             => 'wild element',
+  'secret'           => 'secret y gene',
+  'prestige'         => 'purrstige',
+}
+
+ALT_TRAIT_NAMES =
+{
+  'totesbasic (14)' => 'totesbasic 1',
+  'totesbasic (15)' => 'totesbasic 2',
+  'totesbasic (23)' => 'totesbasic 3',
+  'totesbasic_14'   => 'totesbasic 1',
+  'totesbasic_15'   => 'totesbasic 2',
+  'totesbasic_23'   => 'totesbasic 3',
+  'totesbasic (f)'  => 'totesbasic 1',
+  'totesbasic (g)'  => 'totesbasic 2',
+  'totesbasic (p)'  => 'totesbasic 3',
+  'totesbasic_f'    => 'totesbasic 1',
+  'totesbasic_g'    => 'totesbasic 2',
+  'totesbasic_p'    => 'totesbasic 3',
+  'totesbasic_1'    => 'totesbasic 1',
+  'totesbasic_2'    => 'totesbasic 2',
+  'totesbasic_3'    => 'totesbasic 3',
+}

data/lib/kittyverse/fancies.rb

@@ -3,12 +3,6 @@
 
 class Fancy
 
-  def self.special_editions()  @@special_editions  ||= []; end  # special edition fancies
-  def self.exclusives()        @@exclusives        ||= []; end  # exclusive fancies
-  def self.fancies()           @@fancies           ||= []; end  # "normal" fancies
-
-
-
   def self.fancies_by_key()  @@fancies_by_key  ||= {}; end
   def self.fancies_by_name() @@fancies_by_name ||= {}; end
 
@@ -54,6 +48,23 @@ class Fancy
     end
   end
 
+
+  def self.special_editions  # special edition fancies
+    @@fancies_by_key.values.select { |fancy| fancy.special_edition? }
+  end
+  def self.exclusives        # exclusive fancies
+    @@fancies_by_key.values.select { |fancy| fancy.exclusive? }
+  end
+  def self.fancies           # "normal" fancies
+    @@fancies_by_key.values.select { |fancy| fancy.recipe? }
+  end
+
+  def self.breedable         ## todo: find a better name (or add alias) e.g. use unlocked why? why not?
+    today = Date.today
+    @@fancies_by_key.values.select { |fancy| fancy.breedable?( today ) }
+  end
+
+
   def self.size() @@fancies_by_key.size; end  ## todo: add length alias too? why? why not?
 
 
@@ -70,9 +81,12 @@ class Fancy
                 :recipe,
                 :count,
                 :limit,
-                :ids
+                :ids,
+                :time_start,
+                :time_end
 
   def initialize( **kwargs )
+    @exclusive = @specialedition = @recipe = nil
     update( kwargs )
   end
 
@@ -88,64 +102,97 @@ class Fancy
   alias_method :special_edition?, :specialedition?
   def recipe?()           @recipe.nil? == false; end
 
+  def overflow?() @count && @limit && @count > @limit; end
+  def overflow()  @count - @limit; end   ## todo: check for count limit set - why? why not?
+  def limit?()    @limit; end
+  def count?()    @count; end
+
+  def time?()     @time_start && @time_end; end  ## is fancy(recipe,specialedition) time windowed? true/false
+
+  def time_days() (@time_end.jd - @time_start.jd) + 1; end
+
+
+  def unlocked?( today=Date.today )
+    if @recipe
+      if @recipe.time?   ## time windowed recipe
+        if @recipe.time_end >= today
+          true
+        else
+          false
+        end
+      else  ## assume limit
+        if @count && @count < @limit
+          true
+        else
+          false
+        end
+      end
+    else
+      false
+    end
+  end
+
+  alias_method :breedable?, :unlocked?
+
+  def locked?( today=Date.today ) !unlocked?( today ); end
 
 
-  ## auto-fill
+  ###########################################
+  ## auto-fill fancies
   FANCIES.each do |key,h|
 
+    name    = h[:name]
+    name_cn = h[:name_cn]   # add chinese name if present
+
     date_str = h[:date]
     date_str = h[:recipe][:time][:start]         if date_str.nil? && h[:recipe]
     date_str = h[:specialedition][:time][:start] if date_str.nil? && h[:specialedition]
 
     date = Date.strptime( date_str, '%Y-%m-%d' )
 
-
-    name =    h[:name]
-    name_cn = h[:name_cn]   # add chinese name if present
-    desc    = h[:desc]
-
-    exclusive      = h[:exclusive]
-    specialedition = h[:specialedition]
-    recipe         = h[:recipe]
-
     attribs = {
       key:       key,
-      date:      date,
       name:      name,
       name_cn:   name_cn,
-      desc:      desc,
-      exclusive: exclusive,
-      specialedition: specialedition,
-      recipe:    recipe,
+      date:      date,
+      desc:      h[:desc]
     }
 
-
-    ## todo: check for overflow  - if overflow use limit+overflow = count
-    ##   add traits and time windows
-    if exclusive
-      attribs = attribs.merge( limit: h[:exclusive][:limit],
-                               count: h[:exclusive][:count],
-                               ids:   h[:exclusive][:ids] )
-    elsif specialedition
-      attribs = attribs.merge( limit: h[:specialedition][:limit],
-                               count: h[:specialedition][:count] )
-    else  ## assume "normal/regular" fancy with recipes
-      attribs = attribs.merge( limit: h[:recipe][:limit],
-                               count: h[:recipe][:count] )
-    end
+    attribs = if h[:exclusive]
+                attribs.merge( exclusive: true,
+                               limit:     h[:exclusive][:limit],
+                               ids:       h[:exclusive][:ids] )
+              elsif h[:specialedition]
+                attribs.merge( specialedition: true,
+                               limit:          h[:specialedition][:limit],
+                               time_start:     h[:specialedition][:time] && h[:specialedition][:time][:start] ? Date.strptime( h[:specialedition][:time][:start], '%Y-%m-%d' ) : nil,
+                               time_end:       h[:specialedition][:time] && h[:specialedition][:time][:end]   ? Date.strptime( h[:specialedition][:time][:end],   '%Y-%m-%d' ) : nil )
+              else ## assume "normal/regular" fancy with recipes
+                pp h[:recipe]
+                recipe = Recipe.new(
+                          traits:     h[:recipe][:traits],      ## todo/fix: turn strings into trait objs!!!!
+                          variants:   h[:recipe][:variants],    ## todo/fix: turn variant hash into variant ??? - why? why not?
+                          limit:      h[:recipe][:limit],
+                          time_start: h[:recipe][:time] && h[:recipe][:time][:start] ? Date.strptime( h[:recipe][:time][:start], '%Y-%m-%d' ) : nil,
+                          time_end:   h[:recipe][:time] && h[:recipe][:time][:end]   ? Date.strptime( h[:recipe][:time][:end],   '%Y-%m-%d' ) : nil )
+
+                ## note: support overflow "shortcut" - overflow+limit => count
+                count = if h[:recipe][:overflow]
+                          recipe.limit + h[:recipe][:overflow]
+                        else
+                          h[:recipe][:count]
+                        end
+
+                attribs.merge( recipe:     recipe,
+                               limit:      recipe.limit,
+                               time_start: recipe.time_start,
+                               time_end:   recipe.time_end,
+                               count:      count )
+              end
 
 
     fancy = Fancy.new( **attribs )
-    pp fancy
-
-    if fancy.exclusive?
-      exclusives << fancy
-    elsif fancy.special_edition?
-      special_editions << fancy
-    else  ## assume "normal/regular" fancy (with recipe)
-      fancies << fancy
-    end
-
+    ## pp fancy
 
     ## note: key MUST be a symbol (NOT a string)
     fancies_by_key[key] = fancy

data/lib/kittyverse/links.rb

@@ -40,10 +40,18 @@ def kitties_specialedition_search_url( fancy ) kitties_fancy_search_url( fancy )
 ################################
 #  /media - image links
 
-def media_fancy_pic_url( key, variant_key=nil )    ### todo: find a better name - why? why not?
+def media_fancy_url( key, variant_key=nil )    ### todo: find a better name - why? why not?
   if variant_key
     "https://cryptocopycats.github.io/media/kitties/100x100/fancy-#{key}-#{variant_key}.png"
   else
     "https://cryptocopycats.github.io/media/kitties/100x100/fancy-#{key}.png"
   end
 end
+
+## (old) alias for media_fany_url
+def media_fancy_pic_url( key, variant_key=nil ) media_fancy_url( key, variant_key ); end
+
+
+def media_icon_url( key )   ## note: use :unlocked, :locked, etc.
+  "https://cryptocopycats.github.io/media/icons/18x18/#{key}.png"
+end

data/lib/kittyverse/mewtations.rb

@@ -1,117 +1,120 @@
-# encoding: utf-8
-
-
-##################################
-#  Tier 0 (Base)           (1-g)
-#  Tier 1 (Mewtation I)    (h-p)
-#  Tier 2 (Mewtation II)   (q-t)
-#  Tier 3 (Mewtation III)  (u,v)
-#  Tier 4 (Mewtation IIII) (w)
-#
-TIER = {    ## todo/fix: use an algo to calculate - why? why not?
-  '1' => 0,
-  '2' => 0,
-  '3' => 0,
-  '4' => 0,
-  '5' => 0,
-  '6' => 0,
-  '7' => 0,
-  '8' => 0,
-  '9' => 0,
-  'a' => 0,
-  'b' => 0,
-  'c' => 0,
-  'd' => 0,
-  'e' => 0,
-  'f' => 0,
-  'g' => 0,
-  'h' => 1,
-  'i' => 1,
-  'j' => 1,
-  'k' => 1,
-  'm' => 1,
-  'n' => 1,
-  'o' => 1,
-  'p' => 1,
-  'q' => 2,
-  'r' => 2,
-  's' => 2,
-  't' => 2,
-  'u' => 3,
-  'v' => 3,
-  'w' => 4,
-  'x' => nil
-}
-
-## (quick 'n' dirty) kai to mutation/mewtation level (I,II,III,IIII)
-MUTATION_LEVEL = {
-  '1' => '',
-  '2' => '',
-  '3' => '',
-  '4' => '',
-  '5' => '',
-  '6' => '',
-  '7' => '',
-  '8' => '',
-  '9' => '',
-  'a' => '',
-  'b' => '',
-  'c' => '',
-  'd' => '',
-  'e' => '',
-  'f' => '',
-  'g' => '',
-  'h' => 'I',
-  'i' => 'I',
-  'j' => 'I',
-  'k' => 'I',
-  'm' => 'I',
-  'n' => 'I',
-  'o' => 'I',
-  'p' => 'I',
-  'q' => 'II',
-  'r' => 'II',
-  's' => 'II',
-  't' => 'II',
-  'u' => 'III',
-  'v' => 'III',
-  'w' => 'IIII',
-  'x' => ''
-}
-MEWTATION_LEVEL = MUTATION_LEVEL   ## add alias
-
-MUTATION_PAIR = {
-  '1' => '',   ## todo: use nil for "" - why? why not?
-  '2' => '',
-  '3' => '',
-  '4' => '',
-  '5' => '',
-  '6' => '',
-  '7' => '',
-  '8' => '',
-  '9' => '',
-  'a' => '',
-  'b' => '',
-  'c' => '',
-  'd' => '',
-  'e' => '',
-  'f' => '',
-  'g' => '',
-  'h' => '1+2',
-  'i' => '3+4',
-  'j' => '5+6',
-  'k' => '7+8',
-  'm' => '9+a',
-  'n' => 'b+c',
-  'o' => 'd+e',
-  'p' => 'f+g',
-  'q' => 'h+i',
-  'r' => 'j+k',
-  's' => 'm+n',
-  't' => 'o+p',
-  'u' => 'q+r',
-  'v' => 's+t',
-  'w' => 'u+v',
-  'x' => ''
-}
-MEWTATION_PAIR = MUTATION_PAIR   ## add alias
+# encoding: utf-8
+
+##################################
+#  Tier 0 (Base)           (1-g)
+#  Tier 1 (Mewtation I)    (h-p)
+#  Tier 2 (Mewtation II)   (q-t)
+#  Tier 3 (Mewtation III)  (u,v)
+#  Tier 4 (Mewtation IIII) (w)      # note: use IIII instead of IV
+#
+
+MUTATION_TIER = {    ## todo/fix: use an algo to calculate - why? why not?
+  '1' => 0,
+  '2' => 0,
+  '3' => 0,
+  '4' => 0,
+  '5' => 0,
+  '6' => 0,
+  '7' => 0,
+  '8' => 0,
+  '9' => 0,
+  'a' => 0,
+  'b' => 0,
+  'c' => 0,
+  'd' => 0,
+  'e' => 0,
+  'f' => 0,
+  'g' => 0,
+  'h' => 1,
+  'i' => 1,
+  'j' => 1,
+  'k' => 1,
+  'm' => 1,
+  'n' => 1,
+  'o' => 1,
+  'p' => 1,
+  'q' => 2,
+  'r' => 2,
+  's' => 2,
+  't' => 2,
+  'u' => 3,
+  'v' => 3,
+  'w' => 4,
+  'x' => nil
+}
+
+## (quick 'n' dirty) kai to mutation/mewtation tier level in roman numerals (I,II,III,IIII) - as strings (and nil)
+MUTATION_TIER_ROMAN = {
+  '1' => '',
+  '2' => '',
+  '3' => '',
+  '4' => '',
+  '5' => '',
+  '6' => '',
+  '7' => '',
+  '8' => '',
+  '9' => '',
+  'a' => '',
+  'b' => '',
+  'c' => '',
+  'd' => '',
+  'e' => '',
+  'f' => '',
+  'g' => '',
+  'h' => 'I',
+  'i' => 'I',
+  'j' => 'I',
+  'k' => 'I',
+  'm' => 'I',
+  'n' => 'I',
+  'o' => 'I',
+  'p' => 'I',
+  'q' => 'II',
+  'r' => 'II',
+  's' => 'II',
+  't' => 'II',
+  'u' => 'III',
+  'v' => 'III',
+  'w' => 'IIII',
+  'x' => ''          ## Use nil and NOT empty string "" - why? why not?
+}
+
+MUTATION_PAIR = {
+  '1' => '',   ## todo: use nil for "" - why? why not?
+  '2' => '',
+  '3' => '',
+  '4' => '',
+  '5' => '',
+  '6' => '',
+  '7' => '',
+  '8' => '',
+  '9' => '',
+  'a' => '',
+  'b' => '',
+  'c' => '',
+  'd' => '',
+  'e' => '',
+  'f' => '',
+  'g' => '',
+  'h' => '1+2',
+  'i' => '3+4',
+  'j' => '5+6',
+  'k' => '7+8',
+  'm' => '9+a',
+  'n' => 'b+c',
+  'o' => 'd+e',
+  'p' => 'f+g',
+  'q' => 'h+i',
+  'r' => 'j+k',
+  's' => 'm+n',
+  't' => 'o+p',
+  'u' => 'q+r',
+  'v' => 's+t',
+  'w' => 'u+v',
+  'x' => ''
+}
+
+## add alias(es)
+MEWTATION_TIER       = MUTATION_TIER
+MEWTATION_TIER_ROMAN = MUTATION_TIER_ROMAN
+MEWTATION_PAIR       = MUTATION_PAIR

data/lib/kittyverse/pages/genes.rb

@@ -5,39 +5,22 @@ class GenesPage
 
 def build
   buf = ""
-  buf << "# Genes (#{TRAITS.keys.size} x 4)\n\n"
+  buf << "# Genes (#{TraitType.size} x 4)\n\n"
 
   headings = []
-  TRAITS.values.each do |trait|
-    headings << "#{trait[:name]} (#{trait[:genes]})"
+  TraitType.each do |tt|
+    anchor = "#{tt.name} #{tt.code}".downcase.gsub( ' ', '-' )
+    headings << "[#{tt.name} (#{tt.code})](##{anchor})"
   end
 
   buf << headings.join( " • " )
   buf << "\n\n"
 
 
-  TRAITS.values.each do |trait|
-
-    puts "Kai	 Name"
-    items = []
-    Kai::ALPHABET.each do |kai|
-      value = trait[:kai][kai]
-      code  = "#{trait[:code]}%02d" % Kai::NUMBER[kai]   ## e.g. FU00, FU01, FU02, etc.
-      if value =~ /_[0-9a-z]$/
-        if value.start_with?( "totesbasic" )  ## note: special case for three totesbasic traits
-        else
-          value = '?'
-        end
-      end
-      items << [kai, code, value]
-    end
-
-    items.each do |item|
-      puts "#{item[0]} #{item[1]} #{item[2]}"
-    end
-
-    buf << "## #{trait[:name]} (#{trait[:code]}) - Genes #{trait[:genes]}\n\n"
-    buf << make_table( items )
+  TraitType.each do |tt|
+    buf << "## #{tt.name} (#{tt.code})\n\n"
+    buf << "_Genes #{tt.genes}_\n\n"
+    buf << make_table( tt.traits )
     buf << "\n\n"
   end
 
@@ -48,9 +31,9 @@ end ## method build
 
 
 
-def make_table( items )
-  rows = make_rows( items, columns: 2 )    ## was 4
-  pp rows
+def make_table( traits )
+  rows = make_rows( traits, columns: 2 )    ## was 4
+  ## pp rows
 
   buf = ""
   buf << "|Kai|Code|Name         |Kai|Code|Name        |\n"
@@ -59,22 +42,32 @@ def make_table( items )
   rows.each do |row|
     buf << "| "
 
-    parts = row.map do |item|
-      kai  = item[0]
-      name = item[2]
-
-      if name == '?'
-        cattribute = "?"
+    parts = row.map do |trait|
+      kai    = trait.kai
+      ## binary = "%05b" % Kai::NUM[kai]
+      code   = trait.code
+      name   = trait.name
+      tier   = trait.tier_roman   ## e.g. I,II,III, etc. : String
+
+      if name.nil?
+        ## note: so far x/31 trait is unknown/undefined!!!
+        if kai == "x"
+          cattribute = "?"
+        elsif trait.type.key == :secret
+          cattribute = "? #{tier}"    ## unknown unknown
+        else  ## "anonymous / unnamed" gene / trait
+          cattribute = "∅ #{tier}"    ## known unknown :-)
+        end
       else
-        if name.start_with?( "totesbasic" )  ## note: special case for three totesbasic traits
+        if name.downcase.start_with?( "totesbasic" )  ## note: special case for three totesbasic traits
           q = "totesbasic"
         else
           q = name
         end
-        cattribute = "**[#{name}](#{kitties_search_url(q)})** #{MEWTATION_LEVEL[kai]}"
+        cattribute = "**[#{name}](#{kitties_search_url(q)})** #{tier}"
       end
 
-      "#{item[0]} | #{item[1]} | #{cattribute}"
+      "#{kai} | #{code} | #{cattribute}"
     end
 
     buf << parts.join( " | " )

data/lib/kittyverse/recipes.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+
+
+class Recipe
+
+  attr_accessor :time_start,   ## use date_start -why? why not?
+                :time_end,
+                :traits,
+                :variants,
+                :limit
+
+  def initialize( **kwargs )
+    update( kwargs )
+  end
+
+  def update( **kwargs )
+    kwargs.each do |name,value|
+      send( "#{name}=", value ) ## use "regular" plain/classic attribute setter
+    end
+    self   ## return self for chaining
+  end
+
+  ## is recipe time windowed? true/false
+  def time?() @time_start && @time_end; end
+
+  def time_days() (@time_end.jd - @time_start.jd) + 1; end
+
+end  # class Recipe

data/lib/kittyverse/traits.rb

@@ -3,8 +3,8 @@
 
 class Trait
 
-  def self.traits_by_name()  @@traits_by_name ||= {}; end
   def self.traits_by_code()  @@traits_by_code ||= {}; end
+  def self.traits_by_name()  @@traits_by_name ||= {}; end
 
   def self.find_by_code( code )
     ## note: allow string AND symbols (thus, use .to_s)
@@ -15,21 +15,34 @@ class Trait
   def self.find_by_name( name )
     ## note: allow string AND symbols (thus, use .to_s !!!)
     ## note: downcase name e.g. allow Savannah too (not just savannah)
-    @@traits_by_name[ name.downcase.to_s ]
+
+    name = name.to_s.downcase
+    name = ALT_TRAIT_NAMES[ name ]  if ALT_TRAIT_NAMES[ name ]
+
+    @@traits_by_name[ name ]
   end
 
-  ## add "generic" convenience find helper
+
+  ## add "generic" convenience find helpers
   def self.find_by( **kwargs )
-    if kwargs[ :name ]
-       find_by_name( kwargs[ :name ] )
-    elsif kwargs[ :code ]
+    if kwargs[ :code ]
       find_by_code( kwargs[ :code] )
+    elsif kwargs[ :name ]
+      find_by_name( kwargs[ :name ] )
     else
       ## todo/fix: throw argument except!!!
       nil
     end
   end
 
+  def self.[]( key )
+    if key.size == 4 && key =~ /^[A-Za-z]{2}[0-9]{2}$/
+      Trait.find_by_code( key )
+    else
+      Trait.find_by_name( key )
+    end
+  end
+
 
 
   attr_accessor :type,
@@ -47,8 +60,34 @@ class Trait
     self   ## return self for chaining
   end
 
-  def num()   Kai::NUMBER[@kai]; end
-  def code()  @type.code + Kai::CODE[@kai]; end
+  def num()    Kai::NUMBER[@kai]; end
+  def code()   "#{@type.code}#{Kai::CODE[@kai]}"; end
+  def binary() "%05b" % num; end
+  alias_method :bin, :binary
+
+
+  def tier( format=:num )
+    ## num   =>  0,1,2,3,4,nil                 : Integer|Nil
+    ## roman => "","I","II","III","IIII",nil   : String|Nil
+
+    if format == :roman
+      MUTATION_TIER_ROMAN[@kai]
+    else   ## assume integer num(ber)
+      MUTATION_TIER[@kai]
+    end
+  end
+
+  def tier_roman() tier(:roman); end
+
+  alias_method :level, :tier
+  alias_method :m,     :tier   # m = mewtation/mutation
+
+  def base?() tier == 0; end  # base level 0 - no mutation
+  def m1?()   tier == 1; end  # m1 - mutation level 1
+  def m2?()   tier == 2; end  # m2 - mutation level 2
+  def m3?()   tier == 3; end  # m3 - mutation level 3
+  def m4?()   tier == 4; end  # m4 - mutation level 4
+
 end  # class Trait
 
 
@@ -59,58 +98,30 @@ class TraitType
   def self.trait_types_by_code() @@trait_types_by_code ||= {}; end
   def self.trait_types_by_name() @@trait_types_by_name ||= {}; end
 
-  # quick hack - map copycats keys to (internal) cryptokitties trait type keys
-  #  note: all keys are the same except:
-  ALT_TRAIT_TYPE_KEYS =
-  {
-    # :colorprimary   => :color1,
-    # :colorsecondary => :color2,
-    # :colortertiary  => :color3
-
-    :color1   => :colorprimary,
-    :color2   => :colorsecondary,
-    :color3   => :colortertiary
-  }
-
 
   def self.find_by_key( key )
     ## note: allow string AND symbols (thus, use .to_sym !!!)
     ## note: allow  known alternative mappings/key (e.g. "internal" cryptokitties keys if different)
-    key = ALT_TRAIT_TYPE_KEYS[ key.to_sym ]  if ALT_TRAIT_TYPE_KEYS[ key.to_sym ]
+    key = key.to_sym
+    key = ALT_TRAIT_TYPE_KEYS[ key ]  if ALT_TRAIT_TYPE_KEYS[ key ]
 
-    @@trait_types_by_key[ key.to_sym ]
+    @@trait_types_by_key[ key]
   end
 
   def self.find_by_code( code )
     ## note: allow string AND symbols (thus, use .to_s)
     ##  e.g. allow 'FU', 'fu', :fu, :FU, etc.
-    @@trait_types_by_code[ code.upcase.to_s ]
+    code = code.to_s.upcase
+    @@trait_types_by_code[ code ]
   end
 
-  ALT_TRAIT_TYPE_NAMES =
-  {
-    'body'             => 'fur',
-    'eyes'             => 'eye shape',
-    'eye type'         => 'eye shape',
-    'body color'       => 'base color',
-    'primary color'    => 'base color',
-    'base colour'      => 'base color',       # british (canadian) spelling
-    'secondary color'  => 'highlight color',
-    'sec color'        => 'highlight color',
-    'pattern color'    => 'highlight color',
-    'highlight colour' => 'highlight color',  # british (canadian) spelling
-    'tertiary color'   => 'accent color',
-    'accent colour'    => 'accent color',     # british (canadian) spelling
-    'wild'             => 'wild element',
-    'secret'           => 'secret y gene'
-  }
-
   def self.find_by_name( name )
     ## note: downcase name e.g. allow fur too (not just Fur)
     ## note: allow  known alternative mappings/key (e.g. "internal" cryptokitties keys if different)
-    name = ALT_TRAIT_TYPE_NAMES[ name.downcase ]  if ALT_TRAIT_TYPE_NAMES[ name.downcase ]
+    name = name.to_s.downcase
+    name = ALT_TRAIT_TYPE_NAMES[ name ]  if ALT_TRAIT_TYPE_NAMES[ name ]
 
-    @@trait_types_by_name[ name.downcase ]
+    @@trait_types_by_name[ name ]
   end
 
 
@@ -128,6 +139,19 @@ class TraitType
     end
   end
 
+  def self.[]( key )
+    ## check for codes e.g. FU, PA, ... (or fu, pa,...).
+    if key.size == 2 && key =~ /^[A-Za-z]{2}$/
+      TraitType.find_by_code( key )
+    else
+      if key.is_a? Symbol    ## e.g. :body, :pattern, etc.
+        TraitType.find_by_key( key )
+      else ## assume string
+        TraitType.find_by_name( key )
+      end
+    end
+  end
+
   def self.each
     @@trait_types_by_key.each do |(key,type)|
       yield( type )
@@ -140,6 +164,8 @@ class TraitType
     end
   end
 
+  def self.size() @@trait_types_by_key.size; end  ## todo: add length alias too? why? why not?
+
 
   attr_accessor :key,
                 :name,
@@ -236,11 +262,6 @@ end  # class TraitType
 
 class Traits
   def self.[]( key )
-
-   ## todo:
-   ##   add lookup trait type by alt_names (string)
-   ##   add lookup trait type by alt_keys (symbol)
-
     ## check for codes e.g. FU, PA, ... (or fu, pa,...).
     if key.size == 2 && key =~ /^[A-Za-z]{2}$/
       TraitType.find_by_code( key )

data/lib/kittyverse/version.rb

@@ -5,7 +5,7 @@ class Kittyverse
 
   MAJOR = 0
   MINOR = 4
-  PATCH = 0
+  PATCH = 1
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 
   def self.version

data/test/test_fancies.rb

@@ -37,6 +37,31 @@ def test_bugcat_v2
 end
 
 
+def test_curdlin
+  fancy = Fancy[ 'Curdlin' ]
+  assert_equal :curdlin,   fancy.key
+  assert                   fancy.exclusive? == false
+  assert                   fancy.specialedition? == false
+  assert                   fancy.special_edition? == false
+
+  assert                   fancy.time?
+  assert                   fancy.recipe?
+  assert                   fancy.recipe.time?
+  assert 4,                fancy.recipe.traits.size
+  assert 204,              fancy.time_days
+  assert 204,              fancy.recipe.time_days
+
+  today  = Date.new( 2019,  5,  5 )
+  assert                   fancy.unlocked?( today )
+  assert                   fancy.breedable?( today )
+  assert                   fancy.locked?( today ) == false
+  future = Date.new( 2019, 12, 20 )
+  assert                   fancy.unlocked?( future ) == false
+  assert                   fancy.breedable?( future ) == false
+  assert                   fancy.locked?( future )
+end
+
+
 def test_misc
   Fancy.each do |fancy|
     p fancy.name

data/test/test_traits.rb

@@ -12,13 +12,16 @@ class TestTraits < MiniTest::Test
 
 
 def test_savannah
-  [ Traits[ 'FU00' ],
+  [ Trait[ 'FU00' ],
     Trait.find_by_code( 'FU00' ),
     Trait.find_by( code: 'FU00' ),
-    Traits[ 'savannah' ],
-    Traits[ 'Savannah' ],
+    Trait[ 'savannah' ],
+    Trait[ 'Savannah' ],
     Trait.find_by_name( 'Savannah' ),
     Trait.find_by( name: 'Savannah' ),
+    Traits[ 'FU00' ],
+    Traits[ 'savannah' ],
+    Traits[ 'Savannah' ],
     Traits[ :body ][ '1' ],
     Traits[ :body ][ '00' ],
     Traits[ :body ][ 0 ],
@@ -33,19 +36,91 @@ def test_savannah
     assert_equal "Fur",      t.type.name
     assert_equal "FU00",     t.code
     assert_equal "1",        t.kai
+    assert_equal 0,          t.num
+    assert_equal "00000",    t.bin
+    assert_equal "00000",    t.binary
+    assert_equal 0,          t.tier
+    assert_equal "",         t.tier_roman
+    assert_equal "",         t.tier(:roman)
+    assert                   t.base?
+    assert                   t.m1? == false
+    assert                   t.m2? == false
+    assert                   t.m3? == false
+    assert                   t.m4? == false
+  end
+end
+
+def test_moonrise
+  t = Trait[ 'Moonrise' ]
+  assert_equal "PA30",  t.code
+  assert_equal "w",     t.kai
+  assert_equal 30,      t.num
+  assert_equal "11110", t.bin
+  assert_equal "11110", t.binary
+  assert_equal 4,       t.tier
+  assert_equal 4,       t.level
+  assert_equal 4,       t.m
+  assert_equal "IIII",  t.tier_roman
+  assert_equal "IIII",  t.tier(:roman)
+  assert_equal "IIII",  t.level(:roman)
+  assert_equal "IIII",  t.m(:roman)
+  assert                t.base? == false
+  assert                t.m1? == false
+  assert                t.m2? == false
+  assert                t.m3? == false
+  assert                t.m4?
+end
+
+
+def test_totesbasic
+  [ Trait.find_by_name( 'totesbasic 1' ),
+    Trait.find_by_name( 'totesbasic_1' ),
+    Trait.find_by_name( 'totesbasic (14)' ),
+    Trait.find_by_name( 'totesbasic_14' ),
+    Trait.find_by_name( 'totesbasic (f)' ),
+    Trait.find_by_name( 'totesbasic_f' ),
+    Trait[ 'totesbasic 1' ],
+    Trait[ 'totesbasic_1' ],
+  ].each do |t|
+    assert_equal Trait,          t.class
+    assert_equal "Totesbasic 1", t.name
+    assert_equal "Pattern",      t.type.name
+    assert_equal "PA14",         t.code
+    assert_equal "f",            t.kai
+    assert_equal 14,             t.num
+    assert                       t.base?
+    assert_equal 0,              t.tier
+    assert_equal "",             t.tier_roman
+    assert_equal "",             t.tier(:roman)
   end
 end
 
+
 def test_fu31
   [ Traits[ :body ][ 'x' ],
     Traits[ :body ][ '31' ],
     Traits[ :body ][ 31 ]
   ].each do |t|
     assert_equal Trait,    t.class
-    assert_equal nil,      t.name
+    assert       t.name == nil
     assert_equal "Fur",    t.type.name
     assert_equal "FU31",   t.code
     assert_equal "x",      t.kai
+    assert_equal 31,       t.num
+    assert_equal "11111",  t.bin
+    assert_equal "11111",  t.binary
+    assert                 t.tier == nil
+    assert                 t.level == nil
+    assert                 t.m == nil
+    assert_equal "",       t.tier_roman
+    assert_equal "",       t.tier(:roman)
+    assert_equal "",       t.level(:roman)
+    assert_equal "",       t.m(:roman)
+    assert                 t.base? == false
+    assert                 t.m1? == false
+    assert                 t.m2? == false
+    assert                 t.m3? == false
+    assert                 t.m4? == false
   end
 end
 
@@ -59,6 +134,7 @@ def test_vigilante
     assert_equal "Pattern",   t.type.name
     assert_equal "PA00",      t.code
     assert_equal "1",         t.kai
+    assert_equal 0,           t.num
   end
 end
 
@@ -69,6 +145,8 @@ def test_body
   ].each do |tt|
     assert_equal TraitType, tt.class
     assert_equal "Fur",     tt.name
+    assert_equal :body,     tt.key
+    assert_equal 32,        tt.traits.size
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kittyverse
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-09 00:00:00.000000000 Z
+date: 2019-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base32-alphabets
@@ -78,6 +78,7 @@ files:
 - lib/kittyverse/links.rb
 - lib/kittyverse/mewtations.rb
 - lib/kittyverse/pages/genes.rb
+- lib/kittyverse/recipes.rb
 - lib/kittyverse/traits.rb
 - lib/kittyverse/version.rb
 - test/helper.rb