psd 0.3.5 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3ad5fbd51101b2362d57e17fe0fe5544ebc51ea8
-  data.tar.gz: bb899376edd469fd83536d6bf2b50b96fb044b6e
+  metadata.gz: 041d9171afea1dcddd97b7466d804bf2caa39935
+  data.tar.gz: e8512840bae631128967d55a7df8ea34f4f56edc
 SHA512:
-  metadata.gz: 92068cabd35464e01395b673cc8a4322fd0cd5e8f9317fcc33571df8cea9d0bd59cc98e4faeeca91399634f5549c3b04b4fbf3f891d5b32a154a54843a46e98d
-  data.tar.gz: 26686e5b31b29de64da12dce875cc9edde976451028cd0ccd1f25c855db2851e00be26619c4a8d49e84d8ee076b05e3015acd92bb978a24b014203489890b4ea
+  metadata.gz: 88b090498daaa95c0c78235a513d37f790622d03d0de4340fa02ac662c1a3dc2a9bbb9d622bb85bbda21c1b277f7b10056555be09178208ac3c784815ebcc694
+  data.tar.gz: 25edcad79447dd549a89feb77ed63f513778bdbe890dcdb76a9a92f3fc24da14ba2b499d93eb1f6ee447bf24fd1ce35dd062aa1172cff730cec3fe891769ffaa

data/README.md

@@ -41,6 +41,28 @@ psd = PSD.new('/path/to/file.psd')
 psd.parse!
 ```
 
+Or, if you prefer the File.open way of doing things, you can do that too.
+
+``` ruby
+require 'psd'
+
+PSD.open('path/to/file.psd') do |psd|
+  p psd.tree.to_hash
+end
+```
+
+As you can see, `open` calls `parse!` for you, so that you can get down to business right away.
+
+If you happen to prefer things DSL-style, the `open` method will also let you operate on the PSD object directly. Again, the call to `parse!` is handled for you.
+
+``` ruby
+require 'psd'
+
+PSD.open('path/to/file.psd') do
+  p tree.to_hash
+end
+```
+
 **Traversing the Document**
 
 To access the document as a tree structure, use `psd.tree` to get the root node. From there, you can traverse the tree using any of these methods:

data/lib/psd.rb

@@ -30,6 +30,24 @@ class PSD
 
   attr_reader :file
 
+  # Opens the named file, parses it, and makes it available for reading. Then, closes it after you're finished.
+  # @param filename [String]  the name of the file to open
+  # @return [PSD] the {PSD} object if no block was given, otherwise the value of the block
+  def self.open(filename, opts={}, &block)
+    psd = PSD.new(filename, opts)
+    psd.parse!
+
+    return psd unless block_given?
+
+    if 0 == block.arity
+      psd.instance_eval(&block)
+    else
+      yield psd
+    end
+  ensure
+    psd.close if psd
+  end
+
   # Create and store a reference to our PSD file
   def initialize(file, opts={})
     @file = PSD::File.new(file, 'rb')
@@ -42,6 +60,11 @@ class PSD
     @parsed = false
   end
 
+  # Close the PSD file
+  def close
+    file.close unless file.closed?
+  end
+
   # There is a specific order that must be followed when parsing
   # the PSD. Sections can be skipped if needed. This method will
   # parse all sections of the PSD.
@@ -71,16 +94,16 @@ class PSD
 
   # Get the Resources section, parsing if needed.
   def resources
-    return @resources.data unless @resources.nil?
+    return @resources unless @resources.nil?
 
     ensure_header
 
     @resources = Resources.new(@file)
     @resources.parse
 
-    PSD.logger.debug @resources.inspect
+    PSD.logger.debug @resources.data.inspect
 
-    return @resources.data
+    return @resources
   end
 
   # Get the LayerMask section. Ensures the header and resources

data/lib/psd/descriptor.rb

@@ -13,9 +13,13 @@ class PSD
     # a variable number of items in the descriptor. We return the Hash that represents
     # the full data structure.
     def parse
-      @data[:class] = parse_class
+      PSD.logger.debug "Descriptor: pos = #{@file.tell}"
 
+      @data[:class] = parse_class
       num_items = @file.read_int
+
+      PSD.logger.debug "Class = #{@data[:class]}, Item count = #{num_items}"
+
       num_items.times do |i|
         id, value = parse_key_item
         @data[id] = value
@@ -35,11 +39,13 @@ class PSD
 
     def parse_id
       len = @file.read_int
-      len == 0 ? @file.read_int : @file.read_string(len)
+      len == 0 ? @file.read_string(4) : @file.read_string(len)
     end
 
     def parse_key_item
       id = parse_id
+      PSD.logger.debug "Key = #{id}"
+
       value = parse_item
 
       return id, value
@@ -47,11 +53,12 @@ class PSD
 
     def parse_item(type = nil)
       type = @file.read_string(4) if type.nil?
+      PSD.logger.debug "Type = #{type}"
 
       value = case type
       when 'bool'         then parse_boolean
       when 'type', 'GlbC' then parse_class
-      when 'Objc', 'GlbO' then parse
+      when 'Objc', 'GlbO' then Descriptor.new(@file).parse
       when 'doub'         then parse_double
       when 'enum'         then parse_enum
       when 'alis'         then parse_alias

data/lib/psd/resource.rb

@@ -3,25 +3,24 @@ class PSD
   #
   # Most of the resources are options/preferences set by the user
   # or automatically by Photoshop.
-  class Resource < BinData::Record
-    endian  :big
+  class Resource
+    attr_reader :type, :id, :name, :size
+    attr_accessor :data
 
-    string  :type, read_length: 4
-    uint16  :id
-    uint8   :name_len
-    stringz :name, read_length: :name_length
-    uint32  :res_size
+    def initialize(file)
+      @file = file
+      @data = {}
+      @type = nil
+    end
 
-    skip    length: :resource_size
+    def parse
+      @type = @file.read_string(4) # Always 8BIM
+      @id = @file.read_short
 
-    #---
-    # Really weird padding business
-    def name_length
-      Util.pad2(name_len + 1) - 1
-    end
+      name_length = Util.pad2(@file.read(1).bytes.to_a[0] + 1) - 1
+      @name = @file.read_string(name_length)
 
-    def resource_size
-      Util.pad2(res_size)
+      @size = Util.pad2(@file.read_int)
     end
   end
 end

data/lib/psd/resource_section.rb

@@ -0,0 +1,22 @@
+class PSD
+  class Resource
+    class Section
+      def self.factory(file, resource)
+        Section.constants.each do |c|
+          section = Section.const_get(c)
+          next unless section.id == resource.id
+
+          section.new(file, resource).parse
+          return section.name
+        end
+
+        return nil
+      end
+
+      def initialize(file, resource)
+        @file = file
+        @resource = resource
+      end
+    end
+  end
+end

data/lib/psd/resources.rb

@@ -8,7 +8,8 @@ class PSD
     
     def initialize(file)
       @file = file
-      @resources = []
+      @resources = {}
+      @type_index = {}
       @length = nil
     end
 
@@ -21,7 +22,17 @@ class PSD
 
       while n > 0
         pos = @file.tell
-        @resources << PSD::Resource.read(@file)
+
+        resource = Resource.new(@file)
+        resource.parse
+
+        resource_end = @file.tell + resource.size
+
+        name = Resource::Section.factory(@file, resource)
+        @resources[resource.id] = resource
+        @type_index[name] = resource.id unless name.nil?
+
+        @file.seek resource_end
         n -= @file.tell - pos
       end
 
@@ -30,13 +41,24 @@ class PSD
       end
 
       end_section
-      return @resources
     end
 
     def skip
       @file.seek length, IO::SEEK_CUR
     end
 
+    def [](id)
+      if id.is_a?(Symbol)
+        by_type(id)
+      else
+        @resources[id]
+      end
+    end
+
+    def by_type(id)
+      @resources[@type_index[id]]
+    end
+
     private
 
     def length

data/lib/psd/resources/layer_comps.rb

@@ -0,0 +1,16 @@
+class PSD
+  class Resource
+    class Section
+      class LayerComps < Section
+        def self.id; 1065; end
+        def self.name; :layer_comps; end
+
+        def parse
+          # Descriptor version
+          @file.seek 4, IO::SEEK_CUR
+          @resource.data = Descriptor.new(@file).parse
+        end
+      end
+    end
+  end
+end

data/lib/psd/version.rb

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

data/psd.gemspec

@@ -26,5 +26,8 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'guard'
   gem.add_development_dependency 'guard-rspec'
-  gem.add_development_dependency 'rb-fsevent', '~> 0.9'
+
+  if RUBY_PLATFORM =~ /darwin/
+    gem.add_development_dependency 'rb-fsevent', '~> 0.9'
+  end
 end

data/spec/parsing_spec.rb

@@ -45,16 +45,16 @@ describe 'Parsing' do
 
     it "should contain data" do
       @psd.resources.should_not be_nil
-      @psd.resources.is_a?(Array).should be_true
-      @psd.resources.size.should >= 1
+      @psd.resources.data.is_a?(Hash).should be_true
+      @psd.resources.data.size.should >= 1
     end
 
     it "should be of type 8BIM" do
-      @psd.resources.each { |r| r.type.should == '8BIM' }
+      @psd.resources.data.each { |id, r| r.type.should == '8BIM' }
     end
 
     it "should have an ID" do
-      @psd.resources.each do |r|
+      @psd.resources.data.each do |id, r|
         r.id.should_not be_nil
       end
     end

data/spec/psd_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe 'PSD' do
+  let(:filename) { 'spec/files/example.psd' }
+
+	it 'should open a file without a block' do
+    psd = PSD.open(filename)
+    psd.parsed?.should == true
+    psd.should be_instance_of PSD
+	end
+
+  it 'should refuse to open a bad filename' do
+    expect { PSD.open('') }.to raise_error
+  end
+
+  it 'should open a file and feed it to a block' do
+    PSD.open(filename) do |psd|
+      psd.parsed?.should == true
+      psd.should be_instance_of PSD
+    end
+  end
+
+  it 'should open a file and feed it to a block DSL style' do
+    PSD.open(filename) do
+      parsed?.should == true
+      is_a?(PSD).should == true
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: psd
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.4.0
 platform: ruby
 authors:
 - Ryan LeFevre
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-02 00:00:00.000000000 Z
+date: 2013-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bindata
@@ -170,7 +170,9 @@ files:
 - lib/psd/pascal_string.rb
 - lib/psd/path_record.rb
 - lib/psd/resource.rb
+- lib/psd/resource_section.rb
 - lib/psd/resources.rb
+- lib/psd/resources/layer_comps.rb
 - lib/psd/section.rb
 - lib/psd/util.rb
 - lib/psd/version.rb
@@ -183,6 +185,7 @@ files:
 - spec/hierarchy_spec.rb
 - spec/identity_spec.rb
 - spec/parsing_spec.rb
+- spec/psd_spec.rb
 - spec/spec_helper.rb
 - spec/text_spec.rb
 homepage: http://cosmos.layervault.com/psdrb.html
@@ -218,5 +221,6 @@ test_files:
 - spec/hierarchy_spec.rb
 - spec/identity_spec.rb
 - spec/parsing_spec.rb
+- spec/psd_spec.rb
 - spec/spec_helper.rb
 - spec/text_spec.rb