psd 1.4.3 → 1.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e989ef2453ff6c7b5e1c5e78590921ba53c679d6
-  data.tar.gz: 7b4dadc4460ad50512119776d4ca3e97f30782a9
+  metadata.gz: cfdf8466e7c4a858bf93d47ec823c26ef3a667fa
+  data.tar.gz: bab2a4414c765c27a0d8de12b401067a2a894ba5
 SHA512:
-  metadata.gz: 219a65e3412907b5672831101ad86bc7ba900dee53f571261cae77a39137589028c170950f52b85e477b039aa596840abb35a6ce0506d515e7866162390eec56
-  data.tar.gz: 5b8436682d202ceaa47e75dccdd59470f868231473cb91c8212aefb35ed2024dfa709adddd8b650b17d8411561dfb12dadb1afeb63445aefecc64fdaea1b9780
+  metadata.gz: c80d095fbce20218530a13a3adcf29d9193a6dfe4e4a7b73bc3202bc04ddc3d1a80869d2c9f648ebca606f460647cc34e9d95f81a8bcdba0a044bd2070be8da0
+  data.tar.gz: fabf5fcfceeab8e772228ac3088aa73c5d9382cae2d31f41b405cfd5c2542139f08bbeb1f5e20fe3f99a153b8e65071398315f7fb47b36bd2070e86ec4a0e065

data/README.md

@@ -217,11 +217,7 @@ PSD.debug = true
 
 You can build previews of any subset or version of the PSD document. This is useful for generating previews of layer comps or exporting individual layer groups as images.
 
-**NOTE: You MUST initialize with the parse_layer_images option set to true, as shown below.**
-
 ``` ruby
-psd = PSD.new(file, parse_layer_images: true)
-
 # Save a layer comp
 psd.tree.filter_by_comp("Version A").save_as_png('./Version A.png')
 
@@ -235,3 +231,4 @@ There are a few features that are currently missing from PSD.rb.
 
 * More image modes + depths for image exporting
 * A few layer info blocks
+* Support for rendering all layer styles

data/lib/psd.rb

@@ -24,11 +24,6 @@ class PSD
   include Helpers
   include NodeExporting
 
-  DEFAULTS = {
-    parse_image: false,
-    parse_layer_images: false
-  }
-
   attr_reader :file, :opts
   alias :options :opts
 
@@ -55,7 +50,7 @@ class PSD
     @file = PSD::File.new(file, 'rb')
     @file.seek 0 # If the file was previously used and not closed
 
-    @opts = DEFAULTS.merge(opts)
+    @opts = opts
     @header = nil
     @resources = nil
     @layer_mask = nil
@@ -74,7 +69,7 @@ class PSD
     header
     resources
     layer_mask
-    image if @opts[:parse_image]
+    image
     
     @parsed = true
 
@@ -121,7 +116,12 @@ class PSD
     ensure_resources
     ensure_layer_mask
 
-    @image ||= Image.new(@file, @header).parse
+    @image ||= (
+      # The image is the last section in the file, so we don't have to
+      # bother with skipping over the bytes to read more data.
+      image = Image.new(@file, @header)
+      LazyExecute.new(image, @file).later(:parse)
+    )
   end
 
   # Export the current file to a new PSD. This may or may not work.

data/lib/psd/channel_image.rb

@@ -9,7 +9,6 @@ class PSD
 
     attr_reader :width, :height, :mask_data
     
-
     def initialize(file, header, layer)
       @layer = layer
 
@@ -27,7 +26,7 @@ class PSD
     def skip
       PSD.logger.debug "Skipping channel image data. Layer = #{@layer.name}"
       @channels_info.each do |ch|
-        @file.seek ch.length, IO::SEEK_CUR
+        @file.seek ch[:length], IO::SEEK_CUR
       end
     end
 
@@ -66,7 +65,7 @@ class PSD
 
         if finish != start + ch_info[:length]
           PSD.logger.error "Read incorrect number of bytes for channel ##{ch_info[:id]}. Expected = #{ch_info[:length]}, Actual = #{finish - start}"
-          @file.seek start + @ch_info[:length]
+          @file.seek start + ch_info[:length]
         end
       end
 

data/lib/psd/layer/channel_image.rb

@@ -3,9 +3,9 @@ class PSD
     module ChannelImage
       attr_reader :image
 
-      def parse_channel_image(header, parse)
-        @image = PSD::ChannelImage.new(@file, header, self)
-        parse ? @image.parse : @image.skip
+      def parse_channel_image(header)
+        image = PSD::ChannelImage.new(@file, header, self)
+        @image = LazyExecute.new(image, @file).now(:skip).later(:parse)
       end
     end
   end

data/lib/psd/layer/info.rb

@@ -44,34 +44,20 @@ class PSD
           length = Util.pad2 @file.read_int
           pos = @file.tell
 
-          info_parsed = false
+          key_parseable = false
           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(self, length)
-              i.parse
-
-              @adjustments[name] = i
-              info_parsed = true
-            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.logger.debug "Skipping: layer = #{name}, key = #{key}, pos = #{@file.tell}, length = #{length}"
-            @file.seek pos + length
+            i = info.new(self, length)
+            @adjustments[name] = LazyExecute.new(i, @file).now(:skip).later(:parse)
+            key_parseable = true and break
           end
 
-          if @file.tell != (pos + length)
-            PSD.logger.warn "Layer info key #{key} ended at #{@file.tell}, expected #{pos + length}"
-            @file.seek pos + length
+          unless key_parseable
+            PSD.logger.debug "Skipping unknown layer info block: key = #{key}, length = #{length}"
+            @file.seek length, IO::SEEK_CUR
           end
         end
 
@@ -81,17 +67,6 @@ class PSD
       def vector_mask
         info[:vector_mask_2] || info[:vector_mask]
       end
-
-      def export_extra_data(outfile)
-        outfile.write @file.read(@extra_data_end - @extra_data_begin)
-        if @path_components && !@path_components.empty?
-          outfile.seek @vector_mask_begin
-          @file.seek @vector_mask_begin
-
-          write_vector_mask(outfile)
-          @file.seek outfile.tell
-        end
-      end
     end
   end
 end

data/lib/psd/layer_info.rb

@@ -15,9 +15,13 @@ class PSD
       @data = {}
     end
 
+    def skip
+      @file.seek @section_end
+    end
+
     # Override this - default seeks to end of section
     def parse
-      @file.seek @section_end
+      skip
     end
   end
 end

data/lib/psd/layer_mask.rb

@@ -56,7 +56,7 @@ class PSD
 
         layers.each do |layer|
           @file.seek 8, IO::SEEK_CUR and next if layer.folder? || layer.folder_end?
-          layer.parse_channel_image(@header, @options[:parse_layer_images])
+          layer.parse_channel_image(@header)
         end
       end
 
@@ -107,11 +107,12 @@ class PSD
 
     def parse_global_mask
       length = @file.read_int
+      
+      PSD.logger.debug "Global Mask: length = #{length}"
       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 }

data/lib/psd/lazy_execute.rb

@@ -0,0 +1,54 @@
+class PSD
+  # Used for lazily executing methods on demand
+  class LazyExecute
+    def initialize(obj, file)
+      @obj = obj
+      @file = file
+
+      @start_pos = @file.tell
+      @loaded = false
+      @load_method = nil
+      @load_args = []
+
+      PSD.logger.debug "Marked #{@obj.class.name} at position #{@start_pos} for lazy execution"
+    end
+
+    def now(method, *args, &block)
+      PSD.logger.debug "Executing #{@obj.class.name}##{method} now"
+      @obj.send(method, *args, &block)
+      return self
+    end
+
+    def later(method, *args)
+      @load_method = method
+      @load_args = args
+      return self
+    end
+
+    def loaded?
+      @loaded
+    end
+
+    def method_missing(method, *args, &block)
+      load! unless loaded?
+      @obj.send(method, *args, &block)
+    end
+
+    def inspect
+      "<PSD::LazyExecute @obj=#{@obj.class.name}, @pos=#{@start_pos}, @load_method=:#{@load_method}>"
+    end
+
+    private
+
+    def load!
+      PSD.logger.debug "Lazily executing #{@obj.class.name}##{@load_method}"
+      orig_pos = @file.tell
+      @file.seek @start_pos
+
+      @obj.send(@load_method, *@load_args)
+
+      @file.seek orig_pos
+      @loaded = true
+    end
+  end
+end

data/lib/psd/logger.rb

@@ -13,7 +13,7 @@ class PSD
         return @logger if @logger
 
         if debug || ENV['PSD_DEBUG']
-          @logger = ::Logger.new(debug_output)
+          @logger = ::Logger.new(STDOUT)
           @logger.formatter = proc do |severity, datetime, progname, msg|
             "#{severity}: #{msg}\n"
           end
@@ -23,14 +23,6 @@ class PSD
 
         return @logger
       end
-
-      def debug_output
-        if ENV['PSD_DEBUG']
-          ENV['PSD_DEBUG'] == 'STDOUT' ? STDOUT : ENV['PSD_DEBUG']
-        end
-
-        STDOUT
-      end
     end
   end
 

data/lib/psd/nodes/build_preview.rb

@@ -48,8 +48,8 @@ class PSD
         PSD.logger.warn("Blend mode #{blending_mode} is not implemented") unless Compose.respond_to?(blending_mode)
         PSD.logger.debug("Blending #{layer.name} with #{blending_mode} blend mode")
 
-        LayerStyles.new(layer, other).apply!
         other = ClippingMask.new(layer, other).apply
+        LayerStyles.new(layer, other).apply!
 
         blend_pixels!(blending_mode, layer, base, other, offset_x, offset_y)
       end

data/lib/psd/util.rb

@@ -1,16 +1,17 @@
 class PSD
-  class Util
-    # Ensures value is a multiple of 2
-    def self.pad2(i)
-      ((i + 1) / 2) * 2
+  module Util
+    extend self
+    
+    def pad2(i)
+      (i + 1) & ~0x01
     end
 
     # Ensures value is a multiple of 4
-    def self.pad4(i)
-      i - (i.modulo(4)) + 3
+    def pad4(i)
+      ((i + 4) & ~0x03) - 1
     end
 
-    def self.clamp(num, min, max)
+    def clamp(num, min, max)
       [min, num, max].sort[1]
     end
   end

data/lib/psd/version.rb

@@ -1,3 +1,3 @@
 class PSD
-  VERSION = "1.4.3"
+  VERSION = "1.4.4"
 end

data/spec/image_spec.rb

@@ -45,7 +45,6 @@ describe 'Image Exporting' do
       @psd.parse!
 
       image = @psd.tree.children.first.image
-      expect(image).to be_an_instance_of(PSD::ChannelImage)
       expect(image.width).to eq(1)
       expect(image.height).to eq(1)
 

data/spec/lazy_execute_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe PSD::LazyExecute do
+  before(:each) do
+    @psd = PSD.new('spec/files/pixel.psd')
+  end
+
+  it 'initializes correctly' do
+    expect(@psd.image).to be_an_instance_of(PSD::LazyExecute)
+    expect(@psd.image).to_not be_loaded
+    expect(@psd.image.instance_variable_get(:@obj)).to be_an_instance_of(PSD::Image)
+    expect(@psd.image.instance_variable_get(:@start_pos)).to eq @psd.file.tell
+    expect(@psd.image.instance_variable_get(:@load_method)).to eq :parse
+  end
+
+  it 'loads when accessed the first time' do
+    @psd.image.to_png
+    expect(@psd.image).to be_loaded
+  end
+end

data/spec/parsing_spec.rb

@@ -74,12 +74,14 @@ describe 'Parsing' do
       expect(@psd.layer_mask.layers.size).to be > 0
     end
 
-    it "should contain the global layer mask data" do
-      expect(@psd.layer_mask.global_mask).to_not be_nil
-      expect(@psd.layer_mask.global_mask).to include :overlay_color_space
-      expect(@psd.layer_mask.global_mask).to include :color_components
-      expect(@psd.layer_mask.global_mask).to include opacity: 1.0
-    end
+    # The test file is actually missing the global mask. Need a new test file
+    # with it present.
+    # it "should contain the global layer mask data" do
+    #   expect(@psd.layer_mask.global_mask).to_not be_nil
+    #   expect(@psd.layer_mask.global_mask).to include :overlay_color_space
+    #   expect(@psd.layer_mask.global_mask).to include :color_components
+    #   expect(@psd.layer_mask.global_mask).to include opacity: 1.0
+    # end
   end
 
   describe 'Layers' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: psd
 version: !ruby/object:Gem::Version
-  version: 1.4.3
+  version: 1.4.4
 platform: ruby
 authors:
 - Ryan LeFevre
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-21 00:00:00.000000000 Z
+date: 2013-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -192,6 +192,7 @@ files:
 - lib/psd/layer_info/vector_stroke_content.rb
 - lib/psd/layer_mask.rb
 - lib/psd/layer_styles.rb
+- lib/psd/lazy_execute.rb
 - lib/psd/logger.rb
 - lib/psd/mask.rb
 - lib/psd/node.rb
@@ -223,8 +224,8 @@ files:
 - spec/files/slices.psd
 - spec/files/text.psd
 - spec/hierarchy_spec.rb
-- spec/identity_spec.rb
 - spec/image_spec.rb
+- spec/lazy_execute_spec.rb
 - spec/parsing_spec.rb
 - spec/psd_spec.rb
 - spec/slices_spec.rb
@@ -250,7 +251,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.8
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: General purpose library for parsing Photoshop files
@@ -263,8 +264,8 @@ test_files:
 - spec/files/slices.psd
 - spec/files/text.psd
 - spec/hierarchy_spec.rb
-- spec/identity_spec.rb
 - spec/image_spec.rb
+- spec/lazy_execute_spec.rb
 - spec/parsing_spec.rb
 - spec/psd_spec.rb
 - spec/slices_spec.rb

data/spec/identity_spec.rb

@@ -1,34 +0,0 @@
-require 'spec_helper'
-require 'tempfile'
-
-describe "Identity exports" do
-  it "should export the simplest PSD" do
-    filepath = 'spec/files/simplest.psd'
-    psd = PSD.new(filepath)
-    psd.parse!
-    tmpfile = Tempfile.new("simplest_export.psd")
-    psd.export tmpfile.path
-
-    expect(Digest::MD5.hexdigest(tmpfile.read)).to eq(Digest::MD5.hexdigest(File.read(filepath)))
-  end
-
-  it "should export a file with a layer" do
-    filepath = 'spec/files/one_layer.psd'
-    psd = PSD.new(filepath)
-    psd.parse!
-    tmpfile = Tempfile.new("one_layer_export.psd")
-    psd.export tmpfile.path
-
-    expect(Digest::MD5.hexdigest(tmpfile.read)).to eq(Digest::MD5.hexdigest(File.read(filepath)))
-  end
-
-  it "should export a PSD with vector paths" do
-    filepath = 'spec/files/path.psd'
-    psd = PSD.new(filepath)
-    psd.parse!
-    tmpfile = Tempfile.new("path_export.psd")
-    psd.export tmpfile.path
-
-    expect(Digest::MD5.hexdigest(tmpfile.read)).to eq(Digest::MD5.hexdigest(File.read(filepath)))
-  end
-end