cryptopunks 1.1.0 → 1.2.2

data/lib/cryptopunks/colors.rb

@@ -0,0 +1,162 @@
+
+ROBOT_COLORS = [
+'000000',    # color 1 - BLACK
+'535353',    # color 2 - BASE 2 (DARKER)
+'A4A4A4',    # color 3 - BASE 1
+'A9F7FF',    # color 4 - BASE 3 (LIGHTER) - eyes
+]
+
+VAMPIRE_COLORS = [
+  '000000',    # color 1 - BLACK
+  '131313',    # color 2 - BASE 4 (DARKEST)
+  '535353',    # color 3 - BASE 3 (DARKERER) - eyes
+  'A4A4A4',    # color 4 - BASE 2 (DARKER) - eyes
+  'E0E0E0',    # color 5 - BASE 1
+  'F6000B',    # color 6 - BASE 5  - teeth - red
+]
+
+MUMMY_COLORS =  [
+ '000000',    # color 1 - BLACK
+ '1F1A15',    # color 2 - BASE 5 (DARKEST)
+ '2A231C',    # color 3 - BASE 4 (DARKERERER)
+ '5F5147',    # color 4 - BASE 3 (DARKERER)
+ '927B6A',    # color 5 - BASE 2 (DARKER)
+ 'D9B599',    # color 6 - BASE 1
+ 'F6000B',    # color 7 - BASE 6 - eyes - red
+]
+
+ORC_COLORS = [
+'000000',    # color 1 - BLACK
+'171a08',    # color 2 - BASE 3 (DARKEST)
+'333F0C',    # color 3 - BASE 2 (DARKER)
+'50650E',    # color 4 - BASE 1
+'FFFFFF',    # color 5 - BASE 4 - white
+]
+
+SKELETON_COLORS = [
+   '000000',    # color 1 - BLACK
+   'e0e0e0',    # color 2 - BASE 1
+]
+
+DEMON_COLORS =  [
+ '000000',    # color 1 - BLACK
+ '390102',    # color 2 - BASE 3  (DARKEST) - eyes
+ '630006',    # color 3 - BASE 2  (DARKER) - eyes
+ '850008',    # color 4 - BASE 1
+]
+
+ZOMBIE_COLORS = [
+ '000000',    # color 1 - BLACK
+ '5e7253',    # color 2 - BASE 2  (DARKER)
+ '7da269',    # color 3 - BASE 1
+ 'ff0000',    # color 4 - BASE 3 - red eye
+ '9bbc88',    # color 5 - BASE 4  (LIGHTER)
+ '4a010d',    # color 6 - BASE 5 - mouth (female only)
+]
+
+APE_COLORS = [
+'000000',    # color 1 - BLACK
+'352410',    # color 2 - BASE 3  (DARKEST)
+'6a563f',    # color 3 - BASE 2  (DARKER) - eyes
+'856f56',    # color 4 - BASE 1
+'a98c6b',    # color 5 - BASE 4  (LIGHTER) - eyes
+]
+
+ALIEN_COLORS = [
+'000000',    # color 1 - BLACK
+'75bdbd',    # color 2 - BASE 3  (DARKEST)
+'9be0e0',    # color 3 - BASE 2  (DARKER)
+'c8fbfb',    # color 4 - BASE 1
+]
+
+
+HUMAN_LIGHTER_BASE1 = 'ead9d9'   # rgb(234 217 217) - hsl(  0°  29%  88%)
+HUMAN_LIGHTER_BASE2 = 'c9b2b2'   # rgb(201 178 178) - hsl(  0°  18%  74%) - eyes
+HUMAN_LIGHTER_BASE3 = 'a58d8d'   # rgb(165 141 141) - hsl(  0°  12%  60%) - eyes
+HUMAN_LIGHTER_BASE4 = 'ffffff'   # rgb(255 255 255) - hsl(  0°   0% 100%)    -- white
+HUMAN_LIGHTER_BASE5 = '711010'   # rgb(113  16  16) - hsl(  0°  75%  25%) - mouth
+
+HUMAN_LIGHT_BASE1   = 'dbb180'   # rgb(219 177 128) - hsl( 32°  56%  68%)
+HUMAN_LIGHT_BASE2   = 'd29d60'   # rgb(210 157  96) - hsl( 32°  56%  60%) - eyes
+HUMAN_LIGHT_BASE3   = 'a66e2c'   # rgb(166 110  44) - hsl( 32°  58%  41%) - eyes
+HUMAN_LIGHT_BASE4   = 'e7cba9'   # rgb(231 203 169) - hsl( 33°  56%  78%)
+HUMAN_LIGHT_BASE5   = '711010'   # rgb(113  16  16) - hsl(  0°  75%  25%) - mouth
+
+HUMAN_DARK_BASE1    = 'ae8b61'   # rgb(174 139  97) - hsl( 33°  32%  53%)
+HUMAN_DARK_BASE2    = 'a77c47'   # rgb(167 124  71) - hsl( 33°  40%  47%) - eyes
+HUMAN_DARK_BASE3    = '86581e'   # rgb(134  88  30) - hsl( 33°  63%  32%) - eyes
+HUMAN_DARK_BASE4    = 'b69f82'   # rgb(182 159 130) - hsl( 33°  26%  61%)
+HUMAN_DARK_BASE5    = '5f1d09'   # rgb( 95  29   9) - hsl( 14°  83%  20%) - mouth
+
+HUMAN_DARKER_BASE1  = '713f1d'   # rgb(113  63  29) - hsl( 24°  59%  28%)
+HUMAN_DARKER_BASE2  = '723709'   # rgb(114  55   9) - hsl( 26°  85%  24%) - eyes
+HUMAN_DARKER_BASE3  = '562600'   # rgb( 86  38   0) - hsl( 27° 100%  17%) - eyes
+HUMAN_DARKER_BASE4  = '8b532c'   # rgb(139  83  44) - hsl( 25°  52%  36%)
+HUMAN_DARKER_BASE5  = '4a1201'   # rgb( 74  18   1) - hsl( 14°  97%  15%) - mouth
+
+
+HUMAN_COLORS_LIGHT = [   ## todo/check: change to HUMAN_LIGHT_COLORS???
+  '000000',            # color 1 - BLACK
+  HUMAN_LIGHT_BASE3,   # color 2 - BASE 3 (DARKEST) - eyes
+  HUMAN_LIGHT_BASE2,   # color 3 - BASE 2 (DARKER)  - eyes
+  HUMAN_LIGHT_BASE1,   # color 4 - BASE 1
+  HUMAN_LIGHT_BASE4,   # color 5 - BASE 4
+  HUMAN_LIGHT_BASE5,   # color 6 - BASE 5 - mouth (femaly only)
+]
+
+HUMAN_COLORS_LIGHTER = [  ## todo/check: change to HUMAN_LIGHTER_COLORS?? or add alias - why? why not?
+  '000000',            # color 1 - BLACK
+  HUMAN_LIGHTER_BASE3,
+  HUMAN_LIGHTER_BASE2,
+  HUMAN_LIGHTER_BASE1,
+  HUMAN_LIGHTER_BASE4,
+  HUMAN_LIGHTER_BASE5,
+]
+
+HUMAN_COLORS_DARK = [
+  '000000',            # color 1 - BLACK
+  HUMAN_DARK_BASE3,
+  HUMAN_DARK_BASE2,
+  HUMAN_DARK_BASE1,
+  HUMAN_DARK_BASE4,
+  HUMAN_DARK_BASE5,
+]
+
+HUMAN_COLORS_DARKER = [
+  '000000',            # color 1 - BLACK
+  HUMAN_DARKER_BASE3,
+  HUMAN_DARKER_BASE2,
+  HUMAN_DARKER_BASE1,
+  HUMAN_DARKER_BASE4,
+  HUMAN_DARKER_BASE5,
+]
+
+
+HUMAN_COLORS = {
+'light'   => HUMAN_COLORS_LIGHT,
+'lighter' => HUMAN_COLORS_LIGHTER,
+'dark'    => HUMAN_COLORS_DARK,
+'darker'  => HUMAN_COLORS_DARKER,
+}
+
+
+
+### todo/check:
+##   use a different name other than the "generic" COLORS - why? why not?
+
+COLORS = {
+## original series
+'human'    => HUMAN_COLORS,
+'zombie'   => ZOMBIE_COLORS,
+'ape'      => APE_COLORS,
+'alien'    => ALIEN_COLORS,
+## more series
+'vampire'  => VAMPIRE_COLORS,
+'mummy'    => MUMMY_COLORS,
+'orc'      => ORC_COLORS,
+'skeleton' => SKELETON_COLORS,
+'demon'    => DEMON_COLORS,
+'robot'    => ROBOT_COLORS,
+}
+
+

data/lib/cryptopunks/composite.rb

@@ -0,0 +1,39 @@
+module Cryptopunks
+  class Image        ## nest Composite inside Image - why? why not?
+  class Composite  < Pixelart::ImageComposite
+
+    PUNK_HASH   = 'ac39af4793119ee46bbff351d8cb6b5f23da60222126add4268e261199a2921b'
+
+    def self.sha256( data )
+      ## todo/check: or just use Digest::SHA256.hexdigest - why? why not?
+      Digest::SHA256.digest( data ).unpack( 'H*' )[0]
+    end
+
+
+    PUNK_HEIGHT = 24
+    PUNK_WIDTH  = 24
+
+    def self.read( path='./punks.png', width: PUNK_WIDTH, height: PUNK_HEIGHT )
+      data = File.open( path, 'rb' ) { |f| f.read }
+
+      hexdigest = sha256( data )   ## check sha256 checksum
+      if hexdigest == PUNK_HASH
+         puts "     >#{hexdigest}< SHA256 hash matching"
+         puts "         ✓ True Official Genuine CryptoPunks™ verified"
+      else
+         puts "         ✓ True Official Genuine Yes, You Can! Punks Not Dead™ verified"
+      end
+
+      img = ChunkyPNG::Image.from_blob( data )
+      new( img, width: width, height: height )
+    end
+
+
+    def initialize( *args, width:  PUNK_WIDTH,
+                           height: PUNK_HEIGHT )
+      super
+    end
+
+  end ## class Composite
+  end ## class Image
+end ## module Cryptopunks

data/lib/cryptopunks/generator.rb

@@ -0,0 +1,204 @@
+
+module Cryptopunks
+
+  class Metadata
+    ### todo/fix:
+    ##    move into Punks::Metadata or such
+    class Sprite
+      attr_reader :id, :name, :type, :gender
+
+
+      def initialize( id:,
+                      name:,
+                      type:,
+                      gender: )
+         @id     = id      # zero-based index eg. 0,1,2,3, etc.
+         @name   = name
+         @type   = type
+         @gender = gender
+      end
+
+      ## todo/check - find better names for type attribute/archetypes?
+      ##     use (alternate name/alias) base or face  for archetypes? any others?
+      def attribute?()  @type.downcase.start_with?( 'attribute' ); end
+      def archetype?()  @type.downcase.start_with?( 'archetype' ); end
+   end  # class Metadata::Sprite
+  end # class Metadata
+
+
+
+
+  class Generator
+
+ ######
+ # static helpers  - (turn into "true" static self.class methods - why? why not?)
+ #
+ def normalize_key( str )
+    str.downcase.gsub(/[ ()°_-]/, '').strip
+ end
+
+ def normalize_gender( str )
+    ## e.g. Female => f
+    ##      F => f
+    ##  always return f or m
+    str.downcase[0]
+ end
+
+
+ def build_attributes_by_name( recs )
+    h = {}
+    recs.each_with_index do |rec|
+      key = normalize_key( rec.name )
+      key << "_(#{rec.gender})"  if rec.attribute?
+
+      if h[ key ]
+        puts "!!! ERROR - attribute name is not unique:"
+        pp rec
+        puts "duplicate:"
+        pp h[key]
+        exit 1
+      end
+      h[ key ] = rec
+    end
+    ## pp h
+    h
+ end
+
+
+ def build_recs( recs )   ## build and normalize (meta data) records
+
+    ## sort by id
+    recs = recs.sort do |l,r|
+                       l['id'].to_i( 10 ) <=> r['id'].to_i( 10 )   # use base10 (decimal)
+                     end
+
+    ## assert all recs are in order by id (0 to size)
+    recs.each_with_index do |rec, exp_id|
+       id = rec['id'].to_i(10)
+       if id != exp_id
+          puts "!! ERROR -  meta data record ids out-of-order - expected id #{exp_id}; got #{id}"
+          exit 1
+       end
+    end
+
+    ## convert to "wrapped / immutable" kind-of struct
+    recs = recs.map do |rec|
+             id     = rec['id'].to_i( 10 )
+             name   = rec['name']
+             gender = normalize_gender( rec['gender'] )
+             type   = rec['type']
+
+             Metadata::Sprite.new(
+               id:     id,
+               name:   name,
+               type:   type,
+               gender: gender)
+           end
+    recs
+ end  # method build_recs
+
+
+
+
+ def initialize( image_path="./spritesheet.png",
+                 meta_path="./spritesheet.csv" )
+    @sheet = Pixelart::ImageComposite.read( image_path )
+    recs  = CsvHash.read( meta_path )
+
+    @recs = build_recs( recs )
+
+    ## lookup by "case/space-insensitive" name / key
+    @attributes_by_name = build_attributes_by_name( @recs )
+ end
+
+
+ def spritesheet() @sheet; end
+ alias_method  :sheet, :spritesheet
+
+
+
+
+
+ def find_meta( q, gender: nil )  ## gender (m/f) required for attributes!!!
+
+    key = normalize_key( q )  ## normalize q(uery) string/symbol
+    key << "_(#{normalize_gender( gender )})"  if gender
+
+    rec = @attributes_by_name[ key ]
+    if rec
+       puts " lookup >#{key}< => #{rec.id}: #{rec.name} / #{rec.type} (#{rec.gender})"
+       # pp rec
+    else
+       puts "!! WARN - no lookup found for key >#{key}<"
+    end
+    rec
+ end
+
+
+ def find( q, gender: nil )  ## gender (m/f) required for attributes!!!
+    rec = find_meta( q, gender: gender )
+
+    ## return image if record found
+    rec ? @sheet[ rec.id ] : nil
+ end
+
+
+
+
+ def to_recs( *values )
+      archetype_name  = values[0]
+
+      ### todo/fix:  check for nil/not found!!!!
+      archetype  = find_meta( archetype_name )
+      if archetype.nil?
+        puts "!! ERROR -  archetype >#{archetype}< not found; sorry"
+        exit 1
+      end
+
+      recs       = [archetype]
+
+      attribute_names  = values[1..-1]
+      ## note: attribute lookup requires gender from archetype!!!!
+      attribute_gender = archetype.gender
+
+      attribute_names.each do |attribute_name|
+        attribute = find_meta( attribute_name, gender: attribute_gender )
+        if attribute.nil?
+           puts "!! ERROR - attribute >#{attribute_name}< for (#{attribute_gender}) not found; sorry"
+           exit 1
+        end
+        recs << attribute
+      end
+
+      recs
+ end
+
+
+
+
+ def generate_image( *values, background: nil )
+
+    ids = if values[0].is_a?( Integer )  ## assume integer number (indexes)
+              values
+          else ## assume strings (names)
+              to_recs( *values ).map { |rec| rec.id }
+          end
+
+
+    punk = Pixelart::Image.new( 24, 24 )
+
+    if background    ## for now assume background is (simply) color
+       punk.compose!( Pixelart::Image.new( 24, 24, background ) )
+    end
+
+    ids.each do |id|
+      punk.compose!( @sheet[ id ] )
+    end
+
+    punk
+ end
+ alias_method :generate, :generate_image
+
+ end # class Generator
+
+end # module Cryptopunks

data/lib/cryptopunks/image.rb

@@ -1,84 +1,121 @@
 module Cryptopunks
-  class Image
-    def self.read( path='./punks.png' )
-      data = File.open( path, 'rb' ) { |f| f.read }
-      new( data )
-    end
-
-
-    attr_accessor :zoom
 
-    PUNK_ROWS   = 100
-    PUNK_COLS   = 100
-    PUNK_COUNT  = PUNK_ROWS * PUNK_COLS    ## 10_000 = 100x100  (24000x24000 pixel)
 
-    PUNK_HEIGHT = 24
-    PUNK_WIDTH  = 24
+class Design   ## todo/fix - move to its own file!!!
 
-    PUNK_HASH   = 'ac39af4793119ee46bbff351d8cb6b5f23da60222126add4268e261199a2921b'
+end # class Design
 
 
-    def initialize( data )
-      @punks = ChunkyPNG::Image.from_blob( data )
-      puts "     #{@punks.height}x#{@punks.width} (height x width)"
-
-      ## check sha256 checksum
-      @hexdigest = sha256( data )
-      if original?
-         puts "     >#{@hexdigest}< SHA256 hash matching"
-         puts "         ✓ True Official Genuine CryptoPunks™ verified"
-      else
-         puts " !! ERROR: >#{hexdigest}< SHA256 hash NOT matching"
-         puts "           >#{PUNK_HASH}< expected for True Official Genuine CryptoPunks™."
-         puts ""
-         puts "     Sorry, please download the original."
-         exit 1
-      end
 
-      @zoom  = 1
+##############
+## todo/check:
+##    find a better way to (auto?) include more designs?
+class DesignSeries    ## find a better name for class (just use Series?) - why? why not?
+  def self.build( dir )
+    data = {}
+    paths =  Dir.glob( "#{dir}/**.txt" )
+    paths.each do |path|
+      basename = File.basename( path, File.extname( path ) )
+      text = File.open( path, 'r:utf-8' ) { |f| f.read }
+      ## todo/check: auto-parse "ahead of time" here
+      ##              or keep "raw" text - why? why not?
+      data[ basename ] = text
     end
+    data
+  end
+
+  def initialize( dir )
+    @dir = dir  # e.g. "#{Cryptopunks.root}/config/more"
+  end
+
+  def data
+    ## note: lazy load / build on first demand only
+    @data ||= self.class.build( @dir )
+  end
+
+  def [](key) data[ key ]; end
+  def size()    data.size; end
+  def keys()    data.keys; end
+  def to_h()    data; end    ## todo/check: use to_hash() - why? why not?
+end   # class DesignSeries
+
+
+
+class Image
+
+def self.read( path )   ## convenience helper
+  img = ChunkyPNG::Image.from_file( path )
+  new( img )
+end
+
+
+def initialize( initial=nil, design: nil,
+                             colors: nil )
+    if initial
+      ## pass image through as-is
+      img = initial
+    else
+
+      ## todo/fix:
+      ## move design code into design class!!!
+      ##  for now assume design is a string
+      ##   split into parts
+      ##       original/alien-male or original@alien-male
+      ##       more/alien-female or more@alien-female
+      ##       original/human-male+darker or original@human-male!darker ????
+      ##        human-male!darker ?????
+      ##    keep @ as separator too - why? why not?
+      parts = design.split( %r{[@/]} )
+      parts.unshift( '*' )    if parts.size == 1  ## assume "all-in-one" series (use * as name/id/placeholder)
+
+      series_key        = parts[0]
+      design_composite  = parts[1]
+
+      ## todo/check - find a way for unambigious (color) variant key
+      ##   use unique char e.g. +*!# or such
+      more_parts = design_composite.split(  %r{[!+]} )
+      design_key   = more_parts[0]
+      variant_key  = more_parts[1]     ## color variant for now (for humans) e.g. lighter/light/dark/darker
+
+      series = if ['*','**','_','__'].include?( series_key )
+                  DESIGNS    ## use all-series-in-one collection
+               else
+                  case series_key
+                  when 'original' then DESIGNS_ORIGINAL
+                  when 'more'     then DESIGNS_MORE
+                  else  raise ArgumentError, "unknown design series >#{series_key}<; sorry"
+                  end
+               end
+
+      design = series[ design_key ]
+      raise ArgumentError, "unknow design >#{design_key}< in series >#{series_key}<; sorry"  if design.nil?
+
+      if colors.nil?  ## try to auto-fill in colors
+         ##  note: (auto-)remove _male,_female qualifier if exist
+         colors_key = design_key.sub( '-male', '' ).sub( '-female', '' )
+         colors =  COLORS[ colors_key ]
+
+         ## allow / support color scheme variants (e.g. lighter/light/dark/darker) etc.
+         if colors.is_a?(Hash)
+           if variant_key
+             colors = colors[ variant_key ]
+             raise ArgumentError, "no colors defined for variant >#{variant_key}< for design >#{design_key}< in series >#{series_key}<; sorry"   if colors.nil?
+           else  ## note: use (fallback to) first color scheme if no variant key present
+             colors = colors[ colors.keys[0] ]
+           end
+         end
+
+         raise ArgumentError, "no (default) colors defined for design >#{design_key}< in series >#{series_key}<; sorry"   if colors.nil?
+      end
 
-
-    def hexdigest()  @hexdigest end
-
-    def verify?()  @hexdigest == PUNK_HASH; end
-    alias_method :genuine?,  :verify?
-    alias_method :original?, :verify?
-
-
-
-    def size() PUNK_COUNT; end
-
-    def []( index )
-      @zoom == 1 ? crop( index ) : scale( index, @zoom )
-    end
-
-
-    def crop( index  )
-      y, x = index.divmod( PUNK_ROWS )
-      @punks.crop( x*PUNK_WIDTH, y*PUNK_HEIGHT, PUNK_WIDTH, PUNK_HEIGHT )
+      ## note: unwrap inner image before passing on to super c'tor
+      img = Pixelart::Image.parse( design, colors: colors ).image
     end
 
+    super( img.width, img.height, img )
+end
 
-    def scale( index, zoom )
-      punk = ChunkyPNG::Image.new( PUNK_WIDTH*zoom, PUNK_HEIGHT*zoom,
-                                   ChunkyPNG::Color::WHITE )
 
-      ## (x,y) offset in big all-in-one punks image
-      y, x = index.divmod( PUNK_ROWS )
 
-      ## copy all 24x24 pixels
-      PUNK_WIDTH.times do |i|
-        PUNK_HEIGHT.times do |j|
-          pixel = @punks[i+x*PUNK_WIDTH, j+y*PUNK_HEIGHT]
-          zoom.times do |n|
-            zoom.times do |m|
-              punk[n+zoom*i,m+zoom*j] = pixel
-            end
-          end
-        end
-      end
-      punk
-    end
-  end ## class Image
-end ## module Cryptopunks
+end  # class Image
+end  # module Cryptopunks

data/lib/cryptopunks/structs.rb

@@ -137,12 +137,25 @@ end  ## (nested) class Accessory
     @birthday    = Date.new( 2017, 6, 23)   ## all 10,000 minted on June 23, 2017
   end
 
-  ## convenience helpers for types (5)
-  def alien?()  @type.name=='Alien'; end
-  def ape?()    @type.name=='Ape'; end
-  def zombie?() @type.name=='Zombie'; end
-  def female?() @type.name=='Female'; end
-  def male?()   @type.name=='Male'; end
+  def is_type?( name ) @type.name == name; end
+  alias_method :is?, :is_type?
+
+  ## convenience helpers for "classic" (5) types
+  def alien?()  is_type?( 'Alien'); end
+  def ape?()    is_type?( 'Ape' ); end
+  def zombie?() is_type?( 'Zombie' ); end
+  def female?() is_type?( 'Female' ); end
+  def male?()   is_type?( 'Male' ); end
+
+  ## convenience helpers to lookup attributes
+  def has_attribute?( name )
+    accessories.each do |acc|
+      return true  if acc.name == name
+    end
+    false
+  end
+  alias_method :has?,     :has_attribute?
+  alias_method :include?, :has_attribute?
 end # class Metadata
 
 end  # module Cryptopunks

data/lib/cryptopunks/version.rb

@@ -3,8 +3,8 @@
 module Cryptopunks
 
   MAJOR = 1
-  MINOR = 1
-  PATCH = 0
+  MINOR = 2
+  PATCH = 2
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 
   def self.version