psd 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5a6c401c74ed1123fa74ad8b50dfc6a0df6da1e5
-  data.tar.gz: c2092822eb4eae245fce20204cf05ff3f4bbe0df
+  metadata.gz: d04a7ff525ba486c5d37f11d89b6106c5ae9960a
+  data.tar.gz: 8993d2ce5b328983e55ee77a1ba6297afc37ad0a
 SHA512:
-  metadata.gz: 3696d5e2ff46cff1496b739551d264ae5c7316e6cb6a8b74e8e99a37d4d757330d32badfe66b6d2b6da5dbca32ab871a8105cd72d5b0b43486b06541d01be835
-  data.tar.gz: de41bf1813b74520558fc2161a4266d5f32b0ed7d6b26fda86ae55fbafbd2e2043f403ebcac4e23faa6441d81a8bd43f62c60e68c2b8232f9656d164d5cc65f9
+  metadata.gz: e5da04951ba02c95f1770574a70258736033ff3b9d8b74ede4873592c3ac102fe7972372df4e5ae8f5279d5044c7a475ac5f7de5e86611769d9db59234edf693
+  data.tar.gz: c2e37f8843ff642688c8ea136e28821c51ba8f964368026968301a69046eee757b7b4e48480fe91ff43bd18542d95814046fef9c07cee604aa6f25ad3466393f

data/README.md

@@ -15,6 +15,7 @@ A general purpose Photoshop file parser written in Ruby. It allows you to work w
 * Color mode and bit-depth
 * Vector mask data
 * Flattened image data
+* Layer comps
 
 PSD.rb is tested against:
 
@@ -90,6 +91,27 @@ For any of the traversal methods, you can also retrieve folder or layer nodes on
 psd.tree.descendant_layers
 ```
 
+If you know the path to a group or layer within the tree, you can search by that path. Note that this always returns an Array because layer/group names do not have to be unique.
+
+``` ruby
+psd.tree.children_at_path("Version A/Matte")
+```
+
+**Layer Comps**
+
+You can also filter nodes based on a layer comp. To generate a new tree consisting only of the layers that are enabled in a certain layer comp:
+
+``` ruby
+# Get information about all the available layer comps
+puts psd.layer_comps
+
+# Can filter by name or by ID (obtained from above)
+tree = psd.tree.filter_by_comp('Version A')
+puts tree.children.map(&:name)
+```
+
+This returns a new node tree and does not alter the original so you won't lose any data.
+
 **Accessing Layer Data**
 
 To get data such as the name or dimensions of a layer:

data/lib/psd/file.rb

@@ -83,7 +83,7 @@ class PSD
 
     # Reads a boolean value.
     def read_boolean
-      read(1)[0] != 0
+      read(1).bytes.to_a[0] != 0
     end
 
     # Reads a 32-bit color space value.

data/lib/psd/helpers.rb

@@ -31,5 +31,9 @@ class PSD
     def tree
       @root ||= PSD::Node::Root.new(self)
     end
+
+    def layer_comps
+      @resources[:layer_comps].data.to_a
+    end
   end
 end

data/lib/psd/layer.rb

@@ -19,6 +19,7 @@ class PSD
     LAYER_INFO = {
       type: TypeTool,
       legacy_type: LegacyTypeTool,
+      metadata: MetadataSetting,
       layer_name_source: LayerNameSource,
       object_effects: ObjectEffects,
       name: UnicodeName,

data/lib/psd/layer_info/metadata_setting.rb

@@ -0,0 +1,35 @@
+require_relative '../layer_info'
+
+class PSD
+  class MetadataSetting < LayerInfo
+    @key = 'shmd'
+
+    def parse
+      count = @file.read_int
+
+      count.times do
+        @file.seek 4, IO::SEEK_CUR # signature, always 8BIM
+        
+        key = @file.read_string(4)
+        copy_on_sheet_dup = @file.read(1).bytes.to_a[0]
+        @file.seek 3, IO::SEEK_CUR # Padding
+
+        len = @file.read_int
+        data_end = @file.tell + len
+
+        PSD.logger.debug "Layer metadata: key = #{key}, length = #{len}"
+
+        parse_layer_comp_setting if key == 'cmls'
+
+        @file.seek data_end
+      end
+    end
+
+    private
+
+    def parse_layer_comp_setting
+      @file.seek 4, IO::SEEK_CUR # Version
+      @data[:layer_comp] = Descriptor.new(@file).parse
+    end
+  end
+end

data/lib/psd/layer_info/typetool.rb

@@ -25,7 +25,7 @@ class PSD
         parser.parse!
         @data[:engine_data] = parser.result
       rescue Exception => e
-        puts e.message
+        PSD.logger.error e.message
       end
 
       warpVersion = @file.read_short

data/lib/psd/node.rb

@@ -11,7 +11,7 @@ class PSD
     # Default properties that all nodes contain
     PROPERTIES = [:name, :left, :right, :top, :bottom, :height, :width]
 
-    attr_accessor :parent, :children
+    attr_accessor :parent, :children, :layer
 
     def initialize(layers=[])
       @children = []
@@ -29,6 +29,10 @@ class PSD
       @layer.visible?
     end
 
+    def psd
+      parent.psd
+    end
+
     def layer?
       is_a?(PSD::Node::Layer)
     end

data/lib/psd/node_group.rb

@@ -55,6 +55,12 @@ class PSD::Node
       })
     end
 
+    # If the method is missing, we blindly send it to the layer.
+    # The layer handles the case in which the method doesn't exist.
+    def method_missing(method, *args, &block)
+      @layer.send(method, *args, &block)
+    end
+
     private
 
     def get_dimensions

data/lib/psd/node_layer.rb

@@ -25,12 +25,6 @@ class PSD::Node
       end
     end
 
-    # If the method is missing, we blindly send it to the layer.
-    # The layer handles the case in which the method doesn't exist.
-    def method_missing(method, *args, &block)
-      layer.send(method, *args, &block)
-    end
-
     # Attempt to translate the layer.
     def translate(x=0, y=0)
       @layer.translate x, y
@@ -67,5 +61,11 @@ class PSD::Node
         ref_y: @layer.reference_point.y
       })
     end
+
+    # If the method is missing, we blindly send it to the layer.
+    # The layer handles the case in which the method doesn't exist.
+    def method_missing(method, *args, &block)
+      @layer.send(method, *args, &block)
+    end
   end
 end

data/lib/psd/node_root.rb

@@ -6,7 +6,7 @@ class PSD::Node
     include PSD::HasChildren
     include PSD::Node::ParseLayers
 
-    attr_reader :children
+    attr_accessor :children
 
     # Stores a reference to the parsed PSD and builds the
     # tree hierarchy.
@@ -51,6 +51,8 @@ class PSD::Node
       0
     end
 
+    def psd; @psd; end
+
     private
 
     def build_hierarchy

data/lib/psd/nodes/search.rb

@@ -23,6 +23,41 @@ class PSD
           return matches.map { |m| m.children_at_path(path, opts) }.flatten
         end
       end
+
+      # Given a layer comp ID, name, or :last for last document state, create a new
+      # tree based on the layers/groups that belong to the comp only.
+      def filter_by_comp(id)
+        if id.is_a?(String)
+          comp = psd.layer_comps.select { |c| c[:name] == id }.first
+          raise "Layer comp not found" if comp.nil?
+
+          id = comp[:id]
+        elsif id == :last
+          id = 0
+        end
+
+        root = PSD::Node::Root.new(psd)
+        filter_for_comp!(id, root)
+
+        return root
+      end
+
+      private
+
+      def filter_for_comp!(id, node)
+        node.children.select! do |c|
+          c
+            .metadata
+            .data[:layer_comp]['layerSettings'].map { |l| !l.has_key?('enab') || l['enab'] ? l['compList'] : nil }
+            .flatten
+            .compact
+            .include?(id)
+        end
+
+        node.children.each do |c|
+          filter_for_comp!(id, c) if c.is_a?(PSD::Node::Group)
+        end
+      end
     end
   end
 end

data/lib/psd/resources/layer_comps.rb

@@ -20,6 +20,10 @@ class PSD
         def [](val)
           @data[val]
         end
+
+        def to_a
+          @data['list'].map { |c| {id: c['compID'], name: c['Nm  '], captured_info: c['capturedInfo']} }
+        end
       end
     end
   end

data/lib/psd/version.rb

@@ -1,3 +1,3 @@
 class PSD
-  VERSION = "1.2.2"
+  VERSION = "1.3.0"
 end

data/spec/hierarchy_spec.rb

@@ -86,6 +86,23 @@ describe "Hierarchy" do
         expect(@tree.children_at_path('NOPE')).to be_an_instance_of(Array)
         expect(@tree.children_at_path('NOPE').size).to eq(0)
       end
+
+      it "should throw an error if filtering by a non-existant layer comp" do
+        expect { @tree.filter_by_comp('WAT') }.to raise_error("Layer comp not found")
+      end
+
+      it "should correctly filter and produce a new tree when filtering by layer comp" do
+        tree = @tree.filter_by_comp('Version A')
+        expect(tree).to be_an_instance_of(PSD::Node::Root)
+        expect(tree.children.size).to eq(1)
+        expect(tree.children[0].name).to eq("Version A")
+      end
+
+      it "should return a new tree when filtering by layer comps" do
+        tree = @tree.filter_by_comp('Version A')
+        expect(tree).to_not eq(@tree)
+        expect(@tree.children.size).to eq(3)
+      end
     end
   end
 end

data/spec/parsing_spec.rb

@@ -131,5 +131,18 @@ describe 'Parsing' do
       expect(blend_mode.opacity_percentage).to eq(100)
       expect(blend_mode.visible).to be_true
     end
+
+    it "should parse all layer comps" do
+      expect(@psd.layer_comps.size).to eq(3)
+      expect(@psd.layer_comps.map { |c| c[:name] }).to eq([
+        'Version A',
+        'Version B',
+        'Version C'
+      ])
+
+      @psd.layer_comps.each do |c|
+        expect(c[:id]).to be > 0
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: psd
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.0
 platform: ruby
 authors:
 - Ryan LeFevre
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-23 00:00:00.000000000 Z
+date: 2013-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -165,6 +165,7 @@ files:
 - lib/psd/layer_info/layer_name_source.rb
 - lib/psd/layer_info/layer_section_divider.rb
 - lib/psd/layer_info/legacy_typetool.rb
+- lib/psd/layer_info/metadata_setting.rb
 - lib/psd/layer_info/object_effects.rb
 - lib/psd/layer_info/placed_layer.rb
 - lib/psd/layer_info/reference_point.rb