spritesheet 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b39cad35371c607d82e460f957ae49e6465bba2617b5c193b617dd0d1146fa6
-  data.tar.gz: dc94f8002443ab0c82620b4e3792832255511b27b91e5808483629b139ab5427
+  metadata.gz: 42558ded0ba665a79897c0945feb3ac4f45dd7898e91c07273b208f61c1683f3
+  data.tar.gz: 579fce5675a690b90c3156c706b227871a30f83aad5c71f441d6c88cf8d287a0
 SHA512:
-  metadata.gz: 9fa1624258eca260dfe601da139a11ce36ce21b832018c0c43fd1852b0daad087766f1b3bf48c3598481303ebac083e85a4fdbb7d85b3c745cd8ba7d8705e103
-  data.tar.gz: f4e08a4d6cfbc419d92345151a444d06ad21183941fde4537bccf1cc3340ce0dfe2040c7a638c3fb1bf661c8841fd36ab8bdc32a17c74573ef2b768f5a3d8560
+  metadata.gz: decc64366caccc575170a3d0d92ead2b089e00b4f2822a61f360c1d9d0f638d1a2f77d8f5a90ab5f9f5eae11d2bba1560488f755e18dad633d601129fb87f4ea
+  data.tar.gz: 80757ac10d6a0bdd5b2c804ea2745237170b8e4af935d21480ada8793078a5f19783239ba3e20edba0ae9fd742d40d960dba909ce99592285d62a7962f40936d

data/Manifest.txt

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

data/lib/spritesheet/base.rb

@@ -0,0 +1,14 @@
+## 3rd party
+require 'pixelart/base'
+
+
+## our own code
+require 'spritesheet/version'    # note: let version always go first
+require 'spritesheet/spritesheet'
+require 'spritesheet/packer'
+
+
+
+
+puts Pixelart::Module::Spritesheet.banner    # say hello
+

data/lib/spritesheet/packer.rb

@@ -0,0 +1,89 @@
+
+module Pixelart
+
+
+class Spritesheet
+
+def self.pack( path,
+                 cols: 10,
+                 dir: '.',
+                 width: 24,
+                 height: 24 )
+
+  ## check - change dir to image_dir or such - why? why not?
+
+  attributes = CsvHash.read( path )
+  puts "  #{attributes.size} record(s)"  #=> ??
+
+
+  total = attributes.size
+
+  rows = total/cols
+  rows += 1  if (total % cols) != 0     ## add extra row for remainder
+
+  sheet = ImageComposite.new( cols, rows,
+                                width: width,
+                                height: height )
+
+  meta = []  ## output meta(data) records
+
+  ####
+  #  add attributes
+  attributes.each do |rec|
+    img_path = rec['path']
+    sheet << Image.read( "#{dir}/#{img_path}" )
+
+    name       = rec['name']
+    more_names = (rec['more_names'] || '').split( '|' )
+
+    if name.nil? || name.empty?
+       name = File.basename( img_path, File.extname( img_path ))
+    end
+
+    ## normalize spaces in more names
+    names = [name] + more_names
+    names = names.map {|str| str.strip.gsub(/[ ]{2,}/, ' ' )}
+
+
+    meta << { 'id'         => meta.size.to_s,   ## note: always strings expected (NOT integer numbers)
+              'category'   => rec['type'] || rec['category'],
+              'name'       => names[0],
+              'more_names' => names[1..-1].join( ' | ')}
+
+  end
+
+   ## pp meta
+   ## puts "  #{meta.size} record(s)"
+
+  new( sheet, _build_recs( meta ),
+        width: width,
+        height: height )
+end   # method self.pack
+
+
+def export( path='./spritesheet.csv', format: 'csv' )
+  if format.downcase.to_s == 'csv'
+    headers = ['id', 'category', 'name', 'more_names']
+
+    ## todo/fix: make sure dirname path exists!!!
+    File.open( path, "w:utf-8" ) do |f|
+       f.write( headers.join( ', '))
+       f.write( "\n")
+       records.each do |rec|
+         values = [rec.id,
+                   rec.type,
+                   rec.name,
+                   rec.more_names.join( ' | ')]
+         f.write( values.join( ', ' ))
+         f.write( "\n" )
+       end
+    end
+  else
+    puts "!! ERROR - unsupported export format >#{format}<; sorry"
+    exit 1
+  end
+end
+
+end # class Spritesheet
+end # module Pixelart
+

data/lib/spritesheet/spritesheet.rb

@@ -39,6 +39,7 @@ module Pixelart
 
 
 
+
  def self._build_recs( recs )   ## build and normalize (meta data) records
     ## sort by id
     recs = recs.sort do |l,r|
@@ -74,7 +75,6 @@ module Pixelart
     recs
  end  # method build_recs
 
-
  def self.read_records( path )
    recs = CsvHash.read( path )
    _build_recs( recs )
@@ -120,27 +120,27 @@ module Pixelart
  alias_method :meta, :records
 
 
- def find_meta_by( name: )
+ def find_meta_by( name:, warn: true )
     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}<"
+       puts "!! WARN - no lookup found for key >#{key}<"   if warn
     end
 
     rec
  end
 
- def find_by( name: )
-   rec = find_meta_by( name: name )
+ def find_by( name:, warn: true )
+   rec = find_meta_by( name: name, warn: warn )
 
    ## return (cropped/sliced) image from image composite if record found
    rec ? @image[ rec.id ] : nil
  end
 
- def _find( name )  find_by( name: name ); end
+ def _find( name )  find_by( name: name, warn: false ); end
  alias_method :[], :_find
 
 

data/lib/spritesheet/version.rb

@@ -4,8 +4,8 @@ module Module
 module Spritesheet
 
   MAJOR = 1
-  MINOR = 0
-  PATCH = 1
+  MINOR = 1
+  PATCH = 0
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 
   def self.version

data/lib/spritesheet.rb

@@ -1,15 +1,11 @@
-## 3rd party
-require 'pixelart/base'
+## our own code (without "top-level" shortcuts e.g. "modular version")
+require 'spritesheet/base'   # aka "strict(er)" version
 
 
+###
+#  add convenience top-level shortcuts / aliases
+#    make Image, Color, Palette8bit, etc top-level
+include Pixelart
 
-## our own code
-require 'spritesheet/version'    # note: let version always go first
-require 'spritesheet/spritesheet'
 
 
-
-
-
-puts Pixelart::Module::Spritesheet.banner    # say hello
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spritesheet
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-08 00:00:00.000000000 Z
+date: 2022-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pixelart
@@ -72,6 +72,8 @@ files:
 - README.md
 - Rakefile
 - lib/spritesheet.rb
+- lib/spritesheet/base.rb
+- lib/spritesheet/packer.rb
 - lib/spritesheet/spritesheet.rb
 - lib/spritesheet/version.rb
 homepage: https://github.com/pixelartexchange/pixelart