kittyverse 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b83f8ccd15b5d6499f12627e7a8bb1261b33176b
-  data.tar.gz: 9086b03449228f510ac73ee7198fe9264744a93c
+  metadata.gz: e56df36f3f3c53df42e7ecd83ebda939624943f1
+  data.tar.gz: 4bfcfff584c9e0329c2dfe5de70bf262dd605cd2
 SHA512:
-  metadata.gz: 2bcfa16de3bb45b077bbfff8d503e87a7f28de68d55a2b1257b4540eb91ac5f28a88fceb94b814b7167b5b4a7aeb1812628fd33200ce81ae785fa90507c8f8c1
-  data.tar.gz: 22938b98bdd3bfb741033537516d28dff5f5b0e527571600c5016514e1969f7422fafa81885a9bcc0a5ae3823a918c681377ae5fc2daec0970784e08d8149fac
+  metadata.gz: 6ad27041804377e2ed42ab9161f74a03a601f154b80af45972a96bdf4c233866ec5f10aafbb165b6f173a39eaaaa8d130dab2ec66300ffaff79992fd57359983
+  data.tar.gz: 585438e11230eaf60ad40115045a6a3198934f14fb0d7d35f8eb2cac6ceb4df01289244f280ae3c817fdb4d482d87239c23466ce3713fa02d5a9da4f9a9f0ab9

data/Manifest.txt

@@ -4,16 +4,18 @@ Manifest.txt
 README.md
 Rakefile
 lib/kittyverse.rb
-lib/kittyverse/catalog.rb
 lib/kittyverse/cattributes.rb
+lib/kittyverse/config/fancies.rb
+lib/kittyverse/config/purrstiges.rb
+lib/kittyverse/config/traits.rb
+lib/kittyverse/config/traits_timeline.rb
 lib/kittyverse/fancies.rb
 lib/kittyverse/links.rb
 lib/kittyverse/mewtations.rb
 lib/kittyverse/pages/genes.rb
-lib/kittyverse/purrstige.rb
 lib/kittyverse/traits.rb
-lib/kittyverse/traits_timeline.rb
 lib/kittyverse/version.rb
 test/helper.rb
 test/test_cattributes.rb
+test/test_fancies.rb
 test/test_traits.rb

data/README.md

@@ -18,7 +18,7 @@ Use the `Traits` helper class to lookup trait types (e.g. fur, pattern, eye colo
 ``` ruby
 t = Traits[ 'FU00' ]
 p t.class      #=> Trait
-p t.name       #=> "savannah"
+p t.name       #=> "Savannah"
 p t.type.name  #=> "Fur"
 p t.code       #=> "FU00"
 p t.kai        #=> "1"
@@ -51,7 +51,7 @@ Use:
 ``` ruby
 t = Traits[ 'PA14' ]
 p t.class      #=> Trait
-p t.name       #=> "totesbasic 1"
+p t.name       #=> "Totesbasic 1"
 p t.type.name  #=> "Pattern"
 p t.code       #=> "PA14"
 p t.kai        #=> "f"
@@ -68,7 +68,7 @@ t = Traits[ :body ][ 'f' ]
 t = Traits[ :body ][ '14' ]
 t = Traits[ :body ][ 14 ]
 # ...
-``` 
+```
 
 
 
@@ -104,19 +104,19 @@ Use the `Cattribute` helper class to lookup cattributes incl. purrstige cattribu
 ``` ruby
 c = Cattribute[ 'savannah' ]
 p c.class          #=> Cattribute
-p c.name           #=> "savannah"
+p c.name           #=> "Savannah"
 p c.type.name      #=> "Fur"
 p c.traits.size    #=> 1
-p c.traits         #=> ["savannah"]
+p c.traits         #=> ["Savannah"]
 p c.traits[0].code #=> "FU00"
 # ...
 
 c = Cattribute[ 'totesbasic' ]
 p c.class          #=> Cattribute
-p c.name           #=> "totesbasic"
+p c.name           #=> "Totesbasic"
 p c.type.name      #=> "Pattern"
 p c.traits.size    #=> 3
-p c.traits         #=> ["totesbasic 1", "totesbasic 2", "totesbasic 3"]
+p c.traits         #=> ["Totesbasic 1", "Totesbasic 2", "Totesbasic 3"]
 p c.traits[0].code #=> "PA14"
 p c.traits[1].code #=> "PA15"
 p c.traits[2].code #=> "PA23"
@@ -124,20 +124,79 @@ p c.traits[2].code #=> "PA23"
 
 c = Cattribute[ 'bionic' ]
 p c.class          #=> Cattribute
-p c.name           #=> "bionic"
+p c.name           #=> "Bionic"
 p c.type.name      #=> "Purrstige"
 p c.traits.size    #=> 0
 p c.traits         #=> []
 p c.recipe         #=> {time: {start: "2019-05-01", end: "2019-08-31"},
-                   #    traits: ["ragdoll",
+                   #    traits: ["Ragdoll",
                    #              "WE05",
-                   #              ["totesbasic 1", "totesbasic 2", "totesbasic 3"],
+                   #              ["Totesbasic 1", "Totesbasic 2", "Totesbasic 3"],
                    #              "PU30"]}
 
 # ...
 ```
 
+### Fancies
+
+Use the `Fancy` helper class to lookup fancy or exclusive or special edition cats  incl. timed trait recipes / forumlas, counts, limits, ids and more:
+
+``` ruby
+f = Fancy[ :genesis ]
+p f.class         #=> Fancy
+p f.name          #=> "Genesis"
+p f.key           #=> :genesis
+p f.exlusive?     #=> true
+p f.ids.size      #=> 1
+p f.ids           #=> [1]
+#...
+
+# -or-
+
+f = Fancy.find_by_key( :genesis )
+f = Fancy.find_by( key: 'genesis' )
+f = Fancy[ 'Genesis' ]
+f = Fancy.find_by_name( 'Genesis' )
+f = Fancy.find_by( name: 'Genesis' )
+# ...
+
+f = Fancy[ :bugcat ]
+p f.class         #=> Fancy
+p f.name          #=> "Bug Cat"
+p f.key           #=> :bugcat
+p f.exlusive?     #=> true
+p f.ids.size      #=> 3
+p f.ids           #=> [101,102,103]
+#...
 
+# -or-
+
+f = Fancy[ 'Bug Cat' ]
+f = Fancy[ 'BugCat' ]
+f = Fancy[ 'bugcat' ]
+f = Fancy.find_by_name( 'Bug Cat' )
+f = Fancy.find_by( name: 'Bug Cat' )
+# ...
+```
+
+**Fancy Cat Types**
+
+``` ruby
+p Fancy.size                      #=> 83
+p Fancy.exclusives.size           #=> 22
+p Fancy.special_editions.size     #=> 5
+p Fancy.fancies.size              #=> 56
+```
+
+Loop over all fancies:
+
+``` ruby
+Fancy.each do |fancy|
+  p fancy.name
+end
+
+# ...
+```
 
 
 ## Real World Usage

data/lib/kittyverse.rb

@@ -11,281 +11,22 @@ require 'base32-alphabets'
 
 ## our own code
 require 'kittyverse/version'    # note: let version always go first
-require 'kittyverse/traits'
-require 'kittyverse/traits_timeline'
-require 'kittyverse/mewtations'
-require 'kittyverse/fancies'
-require 'kittyverse/purrstige'
-require 'kittyverse/catalog'
-
-
-require 'kittyverse/links'
-require 'kittyverse/pages/genes'
-
-
-class Trait
-
-  def self.traits_by_name()  @@traits_by_name ||= {}; end
-  def self.traits_by_code()  @@traits_by_code ||= {}; end
-
-  def self.find_by_code( code )
-    ## note: allow string AND symbols (thus, use .to_s)
-    ##  e.g. allow 'FU01', 'fu01', :fu01, :FU01, etc.
-    @@traits_by_code[ code.upcase.to_s ]
-  end
-
-  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 ]
-  end
-
-  ## add "generic" convenience find helper
-  def self.find_by( **kwargs )
-    if kwargs[ :name ]
-       find_by_name( kwargs[ :name ] )
-    elsif kwargs[ :code ]
-      find_by_code( kwargs[ :code] )
-    else
-      ## todo/fix: throw argument except!!!
-      nil
-    end
-  end
-
-
-
-  attr_accessor :type,
-                :name,
-                :kai     # kai char e.g. '1', '2', etc.
-
-  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
-
-  def num()   Kai::NUMBER[@kai]; end
-  def code()  @type.code + Kai::CODE[@kai]; end
-end  # class Trait
-
-
-
-class TraitType
-
-  def self.trait_types_by_key()  @@trait_types_by_key ||= {}; end
-  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 ]
-
-    @@trait_types_by_key[ key.to_sym ]
-  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 ]
-  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 ]
+require 'kittyverse/config/traits'
+require 'kittyverse/config/traits_timeline'
+require 'kittyverse/config/fancies'
+require 'kittyverse/config/purrstiges'
 
-    @@trait_types_by_name[ name.downcase ]
-  end
 
+require 'kittyverse/mewtations'
+require 'kittyverse/links'
 
-  ## add "generic" convenience find helper
-  def self.find_by( **kwargs )
-    if kwargs[ :key ]
-       find_by_key( kwargs[ :key ] )
-    elsif 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.each
-    @@trait_types_by_key.each do |(key,type)|
-      yield( type )
-    end
-  end
-
-  def self.each_with_index
-    @@trait_types_by_key.each_with_index do |(key,type),i|
-      yield( type,i )
-    end
-  end
-
-
-  attr_accessor :key,
-                :name,
-                :code,
-                :genes,
-                :traits,      ## array of 32 traits
-                :cattributes  ## array of 29/31/x cattributes
-
-  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
-
-  def [](key)
-    if key.is_a? Integer   ## assume 0,1,2,3,.. index
-      traits[ key ]
-    elsif key.size == 2 && key =~ /^[0-9]{2}$/   ## assume code e.g. '00', '01', .. etc.
-      traits[ key.to_i(10) ]
-    else   ## assume kai char
-      traits[ Kai::NUMBER[key] ]
-    end
-  end
-
-
-  TRAITS.reduce( TraitType.trait_types_by_key ) do |types, (key, h)|
-
-   type = TraitType.new(
-     key:   key,
-     name:  h[:name],    # e.g. 'Fur'
-     code:  h[:code],    # e.g. 'FU'
-     genes: h[:genes]    # e.g. '0-3'
-   )
-
-   # auto-fill kai mapping
-   ## note: to keep "insertion" order - recreate new hash mapping
-   hash_kai  = h[:kai]
-   hash_kai2 = {}
-   Kai::ALPHABET.each do |kai|
-     name = hash_kai[kai]
-     if name.nil?
-       ## puts "#{key} - #{kai} is missing"
-       hash_kai2[kai] = "#{key}_#{kai}"
-     elsif name.empty?
-       ## puts "#{key} - #{kai} is empty"
-       hash_kai2[kai] = "#{key}_#{kai}"
-     else
-       hash_kai2[kai] = name
-     end
-   end
-   h[:kai] = hash_kai2
-
-   type.traits = h[:kai].reduce([]) do |traits, (kai,name)|   # array of 32 traits
-     trait = Trait.new(
-       type: type,
-       name: name,
-       kai:  kai
-     )
-
-     ## (auto-)add traits for lookup by name, code, etc. via (hash) mapping
-     Trait.traits_by_name[ trait.name ] = trait
-     Trait.traits_by_code[ trait.code ] = trait
-
-     traits << trait
-     traits
-   end
-
-   types[key] = type
-   types
- end
-
- TraitType.trait_types_by_key.reduce( TraitType.trait_types_by_code ) do |types, (key, type)|
-   types[type.code] = type
-   types
- end
-
- TraitType.trait_types_by_key.reduce( TraitType.trait_types_by_name ) do |types, (key, type)|
-   ## note: downcase Fur to fur and so on (for case insensitive match)
-   types[type.name.downcase] = type
-   types
- end
-
-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 )
-    ## check for codes e.g. FU00, FU01 ... (or fu00, fu01, ...)
-    elsif key.size == 4 && key =~ /^[A-Za-z]{2}[0-9]{2}$/
-      Trait.find_by_code( key )
-    else
-      if key.is_a? Symbol    ## e.g. :body, :pattern, etc.
-        t = TraitType.find_by_key( key )
-        t = Trait.find_by_name( key )      if t.nil?  ## try trait name next - why? why not?
-        t
-      else ## assume string
-        t = TraitType.find_by_name( key )
-        t = Trait.find_by_name( key )      if t.nil?  ## try trait name next
-        t
-      end
-    end
-  end
-
-  def self.each() TraitType.each { |type| yield(type) }; end
-  def self.each_with_index() TraitType.each_with_index { |type,i| yield(type,i) }; end
-end  # class Traits
+require 'kittyverse/pages/genes'
 
 
+require 'kittyverse/traits'
 require 'kittyverse/cattributes'
+require 'kittyverse/fancies'