psd 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c100d128dba86088c063508116bc3a1acd0bd650
-  data.tar.gz: 042fe61f2579e7f7dfeda0e223abac81375908b4
+  metadata.gz: 3ad5fbd51101b2362d57e17fe0fe5544ebc51ea8
+  data.tar.gz: bb899376edd469fd83536d6bf2b50b96fb044b6e
 SHA512:
-  metadata.gz: f261b03bea18d788a5d3c608fdb4c41886a2f76030ee4d670a21ae03305940fd610743ea089bcde1c5dd15643b464b7655f591e592950020fd80151547963288
-  data.tar.gz: 3547fe009db381c5e0286c2e7a66e14944388f02591436d20cef0c4d470c4b4cf870bcd105a793aa44cf0d3d38880a2be52f893d49eb4ed40ef310d8dd640b96
+  metadata.gz: 92068cabd35464e01395b673cc8a4322fd0cd5e8f9317fcc33571df8cea9d0bd59cc98e4faeeca91399634f5549c3b04b4fbf3f891d5b32a154a54843a46e98d
+  data.tar.gz: 26686e5b31b29de64da12dce875cc9edde976451028cd0ccd1f25c855db2851e00be26619c4a8d49e84d8ee076b05e3015acd92bb978a24b014203489890b4ea

data/CONTRIBUTING.md

@@ -0,0 +1,7 @@
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/README.md

@@ -142,6 +142,20 @@ png = psd.image.to_png # reference to PNG data
 psd.image.save_as_png 'path/to/output.png' # writes PNG to disk
 ```
 
+**Debugging**
+
+If you run into any problems parsing a PSD, you can enable debug logging via the `PSD_DEBUG` environment variable. For example:
+
+``` bash
+PSD_DEBUG=STDOUT bundle exec examples/parse.rb
+```
+
+You can also give a path to a file instead. If you need to enable debugging programatically:
+
+``` ruby
+PSD.debug = true
+```
+
 ## To-do
 
 There are a few features that are currently missing from PSD.rb.
@@ -150,11 +164,3 @@ There are a few features that are currently missing from PSD.rb.
 * Individual layer image exporting
 * More image modes + depths for image exporting
 * A few layer info blocks
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request

data/lib/psd.rb

@@ -19,13 +19,10 @@ end
 # the header, resources, the layer mask (including layers), and the preview image. We parse
 # each of these sections in order.
 class PSD
+  include Logger
   include Helpers
   include NodeExporting
 
-  # Just used to track what layer info keys we didn't parse in this file for development purposes.
-  def self.keys; @@keys; end
-  @@keys = []
-
   DEFAULTS = {
     parse_image: false,
     parse_layer_images: false
@@ -66,7 +63,10 @@ class PSD
 
   # Get the Header, parsing it if needed.
   def header
-    @header ||= Header.read(@file)
+    return @header if @header
+
+    @header = Header.read(@file)
+    PSD.logger.debug @header.inspect
   end
 
   # Get the Resources section, parsing if needed.
@@ -78,6 +78,8 @@ class PSD
     @resources = Resources.new(@file)
     @resources.parse
 
+    PSD.logger.debug @resources.inspect
+
     return @resources.data
   end
 

data/lib/psd/image.rb

@@ -40,6 +40,8 @@ class PSD
       @end_pos = @start_pos + @length
 
       @pixel_data = []
+
+      PSD.logger.debug "Image: #{width}x#{height}, length = #{@length}, mode = #{@header.mode_name}, position = #{@start_pos}"
     end
 
     # Begins parsing the image by first figuring out the compression format used, and then
@@ -49,9 +51,12 @@ class PSD
 
       # ZIP not implemented
       if [2, 3].include?(@compression)
+        PSD.logger.debug "Warning: ZIP image compression not supported yet. Skipping."
         @file.seek @end_pos and return
       end
 
+      PSD.logger.debug "Compression: id = #{@compression}, name = #{COMPRESSIONS[@compression]}"
+
       parse_image_data!
 
       return self

data/lib/psd/image_exports/png.rb

@@ -7,6 +7,7 @@ class PSD::Image
       # Load the image pixels into a PNG file and return a reference to the
       # data.
       def to_png
+        PSD.logger.debug "Beginning PNG export"
         png = ChunkyPNG::Image.new(width, height, ChunkyPNG::Color::TRANSPARENT)
 
         i = 0
@@ -29,7 +30,7 @@ class PSD::Image
 
       # Saves the PNG data to disk.
       def save_as_png(file)
-        to_png.save(file)
+        to_png.save(file, :fast_rgba)
       end
     end
   end

data/lib/psd/image_formats/rle.rb

@@ -25,6 +25,7 @@ class PSD::Image
         line_index = 0
 
         channels.times do |i|
+          PSD.logger.debug "Parsing RLE channel ##{i}: position = #{chan_pos}, line = #{line_index}"
           chan_pos = decode_rle_channel(chan_pos, line_index)
           line_index += height
         end
@@ -34,9 +35,9 @@ class PSD::Image
         height.times do |j|
           byte_count = @byte_counts[line_index]
           line_index += 1
-          start = @file.tell
+          finish = @file.tell + byte_count
 
-          while @file.tell < start + byte_count
+          while @file.tell < finish
             len = @file.read(1).bytes.to_a[0]
 
             if len < 128

data/lib/psd/image_modes/rgb.rb

@@ -4,21 +4,25 @@ class PSD::Image::Mode
     private
 
     def combine_rgb_channel
+      PSD.logger.debug "Beginning RGB processing"
+
       (0...@num_pixels).step(pixel_step) do |i|
-        pixel = {r: 0, g: 0, b: 0, a: 255}
+        r = g = b = 0
+        a = 255
 
-        PSD::Image::CHANNEL_INFO[0...channels].each_with_index do |chan, index|
+        PSD::Image::CHANNEL_INFO.each_with_index do |chan, index|
+          next if channels == 3 && chan[:id] == -1
           val = @channel_data[i + (@channel_length * index)]
 
           case chan[:id]
-          when -1 then  pixel[:a] = val
-          when 0 then   pixel[:r] = val
-          when 1 then   pixel[:g] = val
-          when 2 then   pixel[:b] = val
+          when -1 then  a = val
+          when 0 then   r = val
+          when 1 then   g = val
+          when 2 then   b = val
           end
         end
 
-        @pixel_data.push *pixel.values
+        @pixel_data.push r, g, b, a
       end
     end
   end

data/lib/psd/layer.rb

@@ -68,6 +68,8 @@ class PSD
       parse_legacy_layer_name
       parse_extra_data
 
+      PSD.logger.debug "Layer name = #{name}"
+
       @file.seek @layer_end # Skip over any filler zeros
 
       end_section
@@ -310,21 +312,24 @@ class PSD
         LAYER_INFO.each do |name, info|
           next unless info.key == key
 
+          PSD.logger.debug "Layer Info: key = #{key}, start = #{pos}, length = #{length}"
+
           begin
             i = info.new(@file, length)
             i.parse
 
             @adjustments[name] = i
             info_parsed = true
-          rescue Exception
+          rescue Exception => e
+            PSD.logger.error "Parsing error: key = #{key}, message = #{e.message}"
+            PSD.logger.error e.backtrace.join("\n")
           end
 
           break
         end
 
         if !info_parsed
-          PSD.keys << key
-          # puts "SKIPPING #{key}, length = #{length}"
+          PSD.logger.debug "SKIPPING: key = #{key}, length = #{length}"
           @file.seek pos + length
         end
 

data/lib/psd/layer_mask.rb

@@ -64,7 +64,9 @@ class PSD
       layers.reverse!
       group_layers
 
-      # Temporarily seek to the end of this section
+      parse_global_mask
+
+      # Ensure we're at the end of this section
       @file.seek finish
       end_section
 
@@ -102,5 +104,26 @@ class PSD
         end
       end
     end
+
+    def parse_global_mask
+      length = @file.read_int
+      return if length == 0
+
+      mask_end = @file.tell + length
+      PSD.logger.debug "Global Mask: length = #{length}"
+
+      @global_mask = {}
+      @global_mask[:overlay_color_space] = @file.read_short
+      @global_mask[:color_components] = 4.times.map { |i| @file.read_short >> 8 }
+      @global_mask[:opacity] = @file.read_short
+
+      # 0 = color selected, 1 = color protected, 128 = use value per layer
+      @global_mask[:kind] = @file.read(1).bytes.to_a[0]
+
+      PSD.logger.debug @global_mask
+
+      # Filler zeros
+      @file.seek mask_end
+    end
   end
 end

data/lib/psd/logger.rb

@@ -0,0 +1,42 @@
+require 'logger'
+
+class PSD
+  module Logger
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      attr_accessor :debug
+
+      def logger
+        return @logger if @logger
+
+        if debug || ENV['PSD_DEBUG']
+          @logger = ::Logger.new(debug_output)
+          @logger.formatter = proc do |severity, datetime, progname, msg|
+            "#{severity}: #{msg}\n"
+          end
+        else
+          @logger = DisabledLogger.new
+        end
+
+        return @logger
+      end
+
+      def debug_output
+        if ENV['PSD_DEBUG']
+          ENV['PSD_DEBUG'] == 'STDOUT' ? STDOUT : ENV['PSD_DEBUG']
+        end
+
+        STDOUT
+      end
+    end
+  end
+
+  class DisabledLogger
+    def method_missing(method, *args, &block)
+      # silence
+    end
+  end
+end

data/lib/psd/version.rb

@@ -1,3 +1,3 @@
 class PSD
-  VERSION = "0.3.4"
+  VERSION = "0.3.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: psd
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors:
 - Ryan LeFevre
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-31 00:00:00.000000000 Z
+date: 2013-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bindata
@@ -119,6 +119,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- CONTRIBUTING.md
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -154,6 +155,7 @@ files:
 - lib/psd/layer_info/unicode_name.rb
 - lib/psd/layer_info/vector_mask.rb
 - lib/psd/layer_mask.rb
+- lib/psd/logger.rb
 - lib/psd/mask.rb
 - lib/psd/node.rb
 - lib/psd/node_exporting.rb