spritesheet 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8511728b85f60e17547179b2642b1b98789b778d454e714d29911fbabb07f456
-  data.tar.gz: d7330fd8a0ddc18fcfe5a04a0c914e5c1b50548058e83e6fb23e8cb6924a7370
+  metadata.gz: 7b39cad35371c607d82e460f957ae49e6465bba2617b5c193b617dd0d1146fa6
+  data.tar.gz: dc94f8002443ab0c82620b4e3792832255511b27b91e5808483629b139ab5427
 SHA512:
-  metadata.gz: 6aa47190ec3a45db1c3c0ce7b51a935124dfae0eb90a991d6dcbb0583748ec188b2c6fa7d43a2ad9f9fb37cce81302e61482ac975023c99b530f9e8508d1776d
-  data.tar.gz: 6a0c4033a797fe33a2fa1e7cf050abfd0d33089424bb1bb93b95a2c5bbbfcc69b618a25545b10527577ed259bbbae28abbe231bc67d62f203131fa3e392a7c2c
+  metadata.gz: 9fa1624258eca260dfe601da139a11ce36ce21b832018c0c43fd1852b0daad087766f1b3bf48c3598481303ebac083e85a4fdbb7d85b3c745cd8ba7d8705e103
+  data.tar.gz: f4e08a4d6cfbc419d92345151a444d06ad21183941fde4537bccf1cc3340ce0dfe2040c7a638c3fb1bf661c8841fd36ab8bdc32a17c74573ef2b768f5a3d8560

data/Manifest.txt

@@ -3,4 +3,5 @@ Manifest.txt
 README.md
 Rakefile
 lib/spritesheet.rb
+lib/spritesheet/spritesheet.rb
 lib/spritesheet/version.rb

data/Rakefile

@@ -11,7 +11,7 @@ end
 
 Hoe.spec 'spritesheet' do
 
-  self.version = Spritesheet::VERSION
+  self.version = Pixelart::Module::Spritesheet::VERSION
 
   self.summary = "spritesheet"
   self.description = summary

data/lib/spritesheet/spritesheet.rb

@@ -0,0 +1,181 @@
+
+module Pixelart
+
+  class Metadata
+    class Sprite     ## todo/check: rename/change type to category - why? why not?
+      attr_reader :id, :name, :type, :more_names
+
+      def initialize( id:,
+                      name:,
+                      type:,
+                      more_names: [] )
+         @id         = id      # zero-based index eg. 0,1,2,3, etc.
+         @name       = name
+         @type       = type
+         @more_names = more_names
+      end
+   end  # class Metadata::Sprite
+  end # class Metadata
+
+
+  class Spritesheet
+
+ ######
+ # static helpers  - (turn into "true" static self.class methods - why? why not?)
+ #
+ def self.normalize_key( str )
+   ## add & e.g. B&W
+   ## add ' e.g. McDonald's Red
+    str.downcase.gsub(/[ ()&°'_-]/, '').strip
+ end
+
+ def self.normalize_name( str )
+   ## normalize spaces in more names
+   str.strip.gsub( /[ ]{2,}/, ' ' )
+ end
+
+ def normalize_key( str )     self.class.normalize_key( str ); end
+ def normalize_name( str )    self.class.normalize_name( str ); end
+
+
+
+ def self._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       = normalize_name( rec['name'] )
+
+             ## todo:  double check if rec['type'] returns nil or empty string if column/field not present?
+             type       = rec['type'] || rec['category']
+
+             more_names = (rec['more_names'] || '').split( '|' )
+             more_names = more_names.map {|str| normalize_name( str ) }
+
+             Metadata::Sprite.new(
+               id:         id,
+               name:       name,
+               type:       type,
+               more_names: more_names )
+           end
+    recs
+ end  # method build_recs
+
+
+ def self.read_records( path )
+   recs = CsvHash.read( path )
+   _build_recs( recs )
+ end
+ class << self
+   alias_method :read_meta, :read_records
+ end
+
+
+ def self.read( image_path="./spritesheet.png",
+                meta_path="./spritesheet.csv",
+                 width: 24,
+                 height: 24)
+   img = ImageComposite.read( image_path, width: width, height: height )
+   recs = read_records( meta_path )
+
+   new( img, recs, width: width, height: height )
+ end
+
+
+
+ def initialize( img,
+                 recs,
+                 width: 24,
+                 height: 24 )
+    @width  = width
+    @height = height
+
+    ## todo: check if img is a ImageComposite or plain Image?
+    ##              if plain Image "auto-wrap" into ImageComposite - why? why not?
+    @image  = img
+    @recs   = recs
+
+    ## lookup by "case/space-insensitive" name / key
+    @attributes_by_name = _build_attributes_by_name( @recs )
+ end
+
+
+ def image() @image; end
+ alias_method  :composite, :image   # add some more aliases/alt names - why? why not?
+
+ def records() @recs; end
+ alias_method :meta, :records
+
+
+ def find_meta_by( name: )
+    key = normalize_key( name )  ## normalize q(uery) string/symbol
+
+    rec = @attributes_by_name[ key ]
+    if rec
+       puts " lookup >#{key}< => #{rec.id}: #{rec.name} / #{rec.type}"
+    else
+       puts "!! WARN - no lookup found for key >#{key}<"
+    end
+
+    rec
+ end
+
+ def find_by( name: )
+   rec = find_meta_by( name: name )
+
+   ## return (cropped/sliced) image from image composite if record found
+   rec ? @image[ rec.id ] : nil
+ end
+
+ def _find( name )  find_by( name: name ); end
+ alias_method :[], :_find
+
+
+######
+##  helpers
+def _build_attributes_by_name( recs )
+   h = {}
+   recs.each_with_index do |rec|
+     names = [rec.name] + rec.more_names
+
+     names.each do |name|
+       key = normalize_key( name )
+
+       if h[ key ]
+         puts "!!! ERROR - attribute name is not unique:"
+         pp rec
+         puts "duplicate:"
+         pp h[key]
+         exit 1
+       end
+       h[ key ] = rec
+     end
+  end
+   ## pp h
+   h
+end
+
+ end # class Spritesheet
+
+
+
+
+ ## add convenience (alternate spelling) alias - why? why not?
+ SpriteSheet = Spritesheet
+ Sheet       = Spritesheet
+ Sprite      = Spritesheet
+
+end # module Pixelart

data/lib/spritesheet/version.rb

@@ -1,10 +1,11 @@
 
-
+module Pixelart
+module Module
 module Spritesheet
 
   MAJOR = 1
   MINOR = 0
-  PATCH = 0
+  PATCH = 1
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 
   def self.version
@@ -20,4 +21,5 @@ module Spritesheet
   end
 
 end # module Spritesheet
-
+end # module Module
+end # module Pixelart

data/lib/spritesheet.rb

@@ -5,8 +5,11 @@ require 'pixelart/base'
 
 ## our own code
 require 'spritesheet/version'    # note: let version always go first
+require 'spritesheet/spritesheet'
 
 
 
 
-puts Spritesheet.banner    # say hello
+
+puts Pixelart::Module::Spritesheet.banner    # say hello
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spritesheet
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Gerald Bauer
@@ -72,6 +72,7 @@ files:
 - README.md
 - Rakefile
 - lib/spritesheet.rb
+- lib/spritesheet/spritesheet.rb
 - lib/spritesheet/version.rb
 homepage: https://github.com/pixelartexchange/pixelart
 licenses: