kittypedia 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 064256ae823ca2bfdfc58f6c2d7c39403e9a1e438c72b0b6b8f94440aad9a880
+  data.tar.gz: 689d9abe788c0b40d825c6280e1410dbe4202491c4c345fa1ae6ec33c278383c
+SHA512:
+  metadata.gz: 5f437dd79d64160272ecc27809377b19cd2fd809b21eba26b69b5484d91701a4e4ae1640d363da40eb69d35ccd12f03a609ef44b331f045146cfe8c0e7e36e93
+  data.tar.gz: 5517ee6004ed766aaade5613017b00f6cedb47dbbe457b1ae89517e18c0f2b6ddf33796b291d0e13acd6cc865fcc2ee0277cff54c33b3a5ba3e277ecf466d950

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+### 0.0.1 / 2021-02-17
+
+* Everything is new. First release

data/Manifest.txt

@@ -0,0 +1,9 @@
+CHANGELOG.md
+Manifest.txt
+README.md
+Rakefile
+lib/kittypedia.rb
+lib/kittypedia/genome_tables.rb
+lib/kittypedia/links.rb
+lib/kittypedia/pages/genes.rb
+lib/kittypedia/version.rb

data/README.md

@@ -0,0 +1,50 @@
+# Kittypedia
+
+kittypedia - (auto-)generate and update pages on cattributes, traits, fancies (normal, exclusive, special editions) and more
+
+* home  :: [github.com/cryptocopycats/kittyverse](https://github.com/cryptocopycats/kittyverse)
+* bugs  :: [github.com/cryptocopycats/kittyverse/issues](https://github.com/cryptocopycats/kittyverse/issues)
+* gem   :: [rubygems.org/gems/kittypedia](https://rubygems.org/gems/kittypedia)
+* rdoc  :: [rubydoc.info/gems/kittypedia](http://rubydoc.info/gems/kittypedia)
+
+
+## Usage
+
+To be done
+
+
+
+
+
+
+
+## Real World Usage
+
+### Reference Pages / Cheat Sheets @ Kittypedia
+
+Auto-generated reference pages / cheat sheets
+in the [Kittypedia - The Free CryptoKitties Encyclopedia](https://github.com/cryptocopycats/kittypedia) include:
+
+- [Cattributes Rarity / Popularity Statistics](https://github.com/cryptocopycats/kittypedia/blob/master/CATTRIBUTES.md)
+- [Genome / Genes Cheat Sheet](https://github.com/cryptocopycats/kittypedia/blob/master/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)
+- [Traits Cheat Sheet (with Codes, Mewtation Levels / Tiers, Search Links and More)](https://github.com/cryptocopycats/kittypedia/blob/master/TRAITS.md)
+- [Fancy / Exclusive / Special Edition Cats - Timeline](https://github.com/cryptocopycats/kittypedia/blob/master/TIMELINE-FANCIES.md)
+- [Purrstige Trait Recipes / Formulas - Timeline](https://github.com/cryptocopycats/kittypedia/blob/master/TIMELINE-PURRSTIGES.md)
+- and others
+
+
+
+
+
+
+## License
+
+![](https://publicdomainworks.github.io/buttons/zero88x31.png)
+
+The `kittypedia` scripts are dedicated to the public domain.
+Use it as you please with no restrictions whatsoever.
+
+
+## Questions? Comments?
+
+Post them on the [cryptokitties reddit](https://www.reddit.com/r/cryptokitties). Thanks.

data/Rakefile

@@ -0,0 +1,30 @@
+require 'hoe'
+require './lib/kittypedia/version.rb'
+
+Hoe.spec 'kittypedia' do
+
+  self.version = Kittypedia::VERSION
+
+  self.summary = "kittypedia - (auto-)generate and update pages on cattributes, traits, fancies (normal, exclusive, special editions) and more"
+  self.description = summary
+
+  self.urls    = { home: 'https://github.com/cryptocopycats/kittyverse' }
+
+  self.author  = 'Gerald Bauer'
+  self.email   = 'wwwmake@googlegroups.com'
+
+  # switch extension to .markdown for gihub formatting
+  self.readme_file  = 'README.md'
+  self.history_file = 'CHANGELOG.md'
+
+  self.extra_deps = [
+    ['kittyverse', '>= 1.0.1']
+  ]
+
+  self.licenses = ['Public Domain']
+
+  self.spec_extras = {
+    required_ruby_version: '>= 2.2.2'
+  }
+
+end

data/lib/kittypedia.rb

@@ -0,0 +1,19 @@
+## 3rd party libs
+require 'kittyverse'
+
+
+
+## our own code
+require 'kittypedia/version'    # note: let version always go first
+
+require 'kittypedia/links'
+require 'kittyverse/genome_tables'
+require 'kittypedia/pages/genes'
+
+
+
+
+
+# say hello
+puts Kittypedia.banner
+

data/lib/kittypedia/genome_tables.rb

@@ -0,0 +1,59 @@
+
+class Genome
+  def build_tables()   GenomeTables.new( self ).build;  end
+end # class Genome
+
+
+class GenomeTables
+  def initialize( genome )
+    @genome = genome
+  end
+
+  def build
+    pos = 0
+    buf = ""
+    buf << "Genes (256-Bit Integer Number):\n"
+    buf << "- Base 10 (Decimal): #{@genome.num}\n"
+    buf << "- Base 2 (Binary): #{@genome.binary}\n"
+    buf << "- Base 2⁵ = 32\n"
+    buf << "  - (Kai):   #{@genome.kai}\n"
+    buf << "  - (Codes): #{@genome.codes}\n"
+    buf << "\n\n"
+
+    @genome.each do |slice|
+      tt = slice.type
+
+      buf << "#{tt.name} (#{tt.code}) - Genes #{tt.genes}\n\n"
+
+###
+##   fix/todo: add stars for purity?
+##     ****   - all traits the same
+##     ***    - two same pairs of traits
+##     **     - one pair of same traits
+
+      buf << "|Gene  |Binary   |Kai  |Code | Name     |   |\n"
+      buf << "|------|---------|-----|-----|----------|---|\n"
+      buf << "| #{pos} | #{slice.d.binary} | #{slice.d.kai} | #{slice.d.code} |**#{fmt_trait(slice.d)}** | d |\n"; pos+=1
+      buf << "| #{pos} | #{slice.r1.binary} | #{slice.r1.kai} | #{slice.r1.code} |#{fmt_trait(slice.r1)} | r1 |\n"; pos+=1
+      buf << "| #{pos} | #{slice.r2.binary} | #{slice.r2.kai} | #{slice.r2.code} |#{fmt_trait(slice.r2)} | r2 |\n"; pos+=1
+      buf << "| #{pos} | #{slice.r3.binary} | #{slice.r3.kai} | #{slice.r3.code} |#{fmt_trait(slice.r3)} | r3 |\n"; pos+=1
+      buf << "\n"
+
+      if tt.key == :body    ## add legend for first entry
+        buf << "d = dominant, r1 = 1st order recessive, r2 = 2nd order recessive, r3 = 3rd order recessive\n\n"
+      end
+    end
+
+    buf
+  end
+
+####################
+## helpers
+
+  def fmt_trait( trait )
+    buf = ""
+    buf << (trait.name || '∅')
+    buf << " #{trait.tier_roman}"    if trait.tier > 0
+    buf
+  end
+end  # class GenomeTables

data/lib/kittypedia/links.rb

@@ -0,0 +1,54 @@
+###############################
+#  cryptokitties.co links
+
+def kitties_kitty_url( id )
+  "https://www.cryptokitties.co/kitty/#{id}"
+end
+
+
+def kitties_search_url( q )
+ "https://www.cryptokitties.co/search?include=sale,sire,other&search=#{q}"
+end
+
+
+
+
+def kitties_fancy_search_url( fancy )   ## todo: find a better name - why? why not?
+
+  ## note: use (official) chinese name for search param if present
+  param =  fancy.name_cn ? fancy.name_cn : fancy.key
+
+  if fancy.special_edition?
+    q = "specialedition:#{param}"    ## todo: urlescape param - why? why not?
+  elsif fancy.exclusive?   ## just use fancy too - why? why not?
+    q = "exclusive:#{param}"
+  else  ## assume "normal/regular" fancy
+    q = "fancy:#{param}"
+  end
+
+  "https://www.cryptokitties.co/search?include=sale,sire,other&search=#{q}"
+end
+
+## alias :kitties_special_search_url :kitties_fancy_search_url
+def kitties_specialedition_search_url( fancy ) kitties_fancy_search_url( fancy ); end
+
+
+
+################################
+#  /media - image links
+
+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/kittypedia/pages/genes.rb

@@ -0,0 +1,99 @@
+
+class GenesPage
+
+def build
+  buf = ""
+  buf << "# Genes (#{TraitType.size} x 4)\n\n"
+
+  headings = []
+  TraitType.each do |tt|
+    anchor = "#{tt.name} #{tt.code}".downcase.gsub( ' ', '-' )
+    headings << "[#{tt.name} (#{tt.code})](##{anchor})"
+  end
+
+  buf << headings.join( " • " )
+  buf << "\n\n"
+
+
+  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
+
+  puts buf
+
+  buf
+end ## method build
+
+
+
+def make_table( traits )
+  rows = make_rows( traits, columns: 2 )    ## was 4
+  ## pp rows
+
+  buf = ""
+  buf << "|Kai|Code|Name         |Kai|Code|Name        |\n"
+  buf << "|--:|---:|-------------|--:|---:|------------|\n"
+
+  rows.each do |row|
+    buf << "| "
+
+    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.downcase.start_with?( "totesbasic" )  ## note: special case for three totesbasic traits
+          q = "totesbasic"
+        else
+          q = name
+        end
+        cattribute = "**[#{name}](#{kitties_search_url(q)})** #{tier}"
+      end
+
+      "#{kai} | #{code} | #{cattribute}"
+    end
+
+    buf << parts.join( " | " )
+    buf << " |\n"
+  end
+
+  buf
+end
+
+
+## helpers
+def make_rows( items, columns: 2 )
+  offset = items.size / columns
+  pp offset
+
+  rows = []
+  offset.times.with_index do |row|
+    ## note: construct [items[row],items[offset+row],items[offset*2+row], ...]
+    rows << columns.times.with_index.map { |col| items[offset*col+row] }
+  end
+  rows
+end
+
+
+  def save( path )
+    File.open( path, "w:utf-8" ) do |f|
+      f.write build
+    end
+  end
+
+end # class GenesPage

data/lib/kittypedia/version.rb

@@ -0,0 +1,20 @@
+module Kittypedia
+
+  MAJOR = 0
+  MINOR = 0
+  PATCH = 1
+  VERSION = [MAJOR,MINOR,PATCH].join('.')
+
+  def self.version
+    VERSION
+  end
+
+  def self.banner
+    "kittypedia/#{VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}] in (#{root})"
+  end
+
+  def self.root
+    File.expand_path( File.dirname(File.dirname(File.dirname(__FILE__))) )
+  end
+
+end # module Kittypedia

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: kittypedia
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Gerald Bauer
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-02-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kittyverse
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.22'
+description: kittypedia - (auto-)generate and update pages on cattributes, traits,
+  fancies (normal, exclusive, special editions) and more
+email: wwwmake@googlegroups.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- CHANGELOG.md
+- Manifest.txt
+- README.md
+files:
+- CHANGELOG.md
+- Manifest.txt
+- README.md
+- Rakefile
+- lib/kittypedia.rb
+- lib/kittypedia/genome_tables.rb
+- lib/kittypedia/links.rb
+- lib/kittypedia/pages/genes.rb
+- lib/kittypedia/version.rb
+homepage: https://github.com/cryptocopycats/kittyverse
+licenses:
+- Public Domain
+metadata: {}
+post_install_message:
+rdoc_options:
+- "--main"
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: kittypedia - (auto-)generate and update pages on cattributes, traits, fancies
+  (normal, exclusive, special editions) and more
+test_files: []