psd 3.1.2 → 3.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e01eed6ed75e5db88c644ea838ff2f29d89c9df2
-  data.tar.gz: ca303780610167552c62d169a886595d71b55a6d
+  metadata.gz: f50b617c54533215a7298c60bd67cf41a822b9b4
+  data.tar.gz: 5e460352673f2a562d1539ef354297a776431beb
 SHA512:
-  metadata.gz: f69ddfe1cf1ce6f9600151080928539f5529ae94fdbf0cb94c32bc7e4f0b6e2eef8058dc7af1cc9094202181bce10265a67c6fb850f182772aacbc48ca5ff3b5
-  data.tar.gz: cf3f1ae5c8a4c25eeaadc90e93f0d36b479d024fe7da33909a25f2b2b8d00c1ceb1d2d2fe058af67f106781400d29a7e35bdd7da57c7f6fdb4d50a2e35f4eb68
+  metadata.gz: 48fb4c174e1faace5c98f63f5a5ed584a4a459c553d7c284efa1e15b22bfdbc5e28bfd93dac16d4e9a1f7c47dba1dc3f40e05d9c514e1045ccd90590d38f39d3
+  data.tar.gz: 79ebfea952eb57031c6cc0d57e803728c20cb107597a2df578261dcf677708d5a998701039ef9a4032aad374a556ce33a2dc816dbf64ab17c9ec5756cfa96f70

data/README.md

@@ -19,9 +19,8 @@ A general purpose Photoshop file parser written in Ruby. It allows you to work w
 
 PSD.rb is tested against:
 
-* MRI 1.9.3 & 2.0.0
+* MRI 1.9.3, 2.0.0, 2.1.0
 * JRuby (1.9.3 mode)
-* Rubinius (1.9.3 mode)
 
 If you use MRI Ruby and are interested in significantly speeding up PSD.rb with native code, check out [psd_native](https://github.com/layervault/psd_native).
 
@@ -76,15 +75,23 @@ 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:
+To access the document as a tree structure, use `psd.tree` to get the root node. From there, work with the tree using any of these methods:
 
 * `root`: get the root node from anywhere in the tree
+* `root?`: is this the root node?
 * `children`: get all immediate children of the node
+* `has_children?`: does this node have any children?
+* `childless?`: opposite of `has_children?`
 * `ancestors`: get all ancestors in the path of this node (excluding the root)
 * `siblings`: get all sibling tree nodes including the current one (e.g. all layers in a folder)
+* `next_sibling`: gets the sibling immediately following the current node
+* `prev_sibling`: gets the sibling immediately before the current node
+* `has_siblings?`: does this node have any siblings?
+* `only_child?`: opposite of `has_siblings?`
 * `descendants`: get all descendant nodes not including the current one
 * `subtree`: same as descendants but starts with the current node
-* `depth`: calculate the depth of the current node
+* `depth`: calculate the depth of the current node (root node is 0)
+* `path`: gets the path to the current node
 
 For any of the traversal methods, you can also retrieve folder or layer nodes only by appending `_layers` or `_groups` to the method. For example:
 
@@ -96,6 +103,7 @@ If you know the path to a group or layer within the tree, you can search by that
 
 ``` ruby
 psd.tree.children_at_path("Version A/Matte")
+psd.tree.children_at_path(["Version A", "Matte"])
 ```
 
 ### Layer Comps
@@ -111,7 +119,7 @@ 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.
+This returns a new node tree and does not alter the original.
 
 ### Accessing Layer Data
 
@@ -197,6 +205,20 @@ png = psd.image.to_png # reference to PNG data
 psd.image.save_as_png 'path/to/output.png' # writes PNG to disk
 ```
 
+This uses the full rasterized preview provided by Photoshop. It does not use the built-in rendering engine (described below). If the file was not saved with Compatibility Mode enabled, this will return an empty image.
+
+### Preview Building
+
+You can build previews of any subset or version of the PSD document using the built-in renderer. This is useful for generating previews of layer comps or exporting individual layer groups as images.
+
+``` ruby
+# Save a layer comp
+psd.tree.filter_by_comp("Version A").save_as_png('./Version A.png')
+
+# Generate PNG of individual layer group
+psd.tree.children_at_path("Group 1").first.to_png
+```
+
 ### Debugging
 
 If you run into any problems parsing a PSD, you can enable debug logging via the `PSD_DEBUG` environment variable. For example:
@@ -205,31 +227,17 @@ If you run into any problems parsing a PSD, you can enable debug logging via the
 PSD_DEBUG=true bundle exec examples/parse.rb
 ```
 
-You can also give a path to a file instead. If you need to enable debugging programatically:
+If you need to enable debugging programatically:
 
 ``` ruby
 PSD.debug = true
 ```
 
-### Preview Building
-
-**This is currently an experimental feature. It works "well enough" but is not perfect yet.**
-
-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.
-
-``` ruby
-# Save a layer comp
-psd.tree.filter_by_comp("Version A").save_as_png('./Version A.png')
-
-# Generate PNG of individual layer group
-psd.tree.children_at_path("Group 1").first.to_png
-```
-
 ## To-do
 
 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
+* Support for layer comp adjusted layer styles
 * Render engine fixes for groups with lowered opacity

data/lib/psd.rb

@@ -1,5 +1,6 @@
 require 'psd/enginedata'
 require 'chunky_png'
+require 'xmp'
 # require "cairo"
 
 require 'active_support/core_ext/module/delegation'

data/lib/psd/file.rb

@@ -82,7 +82,10 @@ class PSD
     # Reads a unicode string, which is double the length of a normal string and encoded as UTF-16.
     def read_unicode_string(length=nil)
       length ||= read_int if length.nil?
-      !length.nil? && length > 0 ? read(length * 2).encode('UTF-8', 'UTF-16BE').delete("\000") : ''
+      return '' if length.nil? || length <= 0
+      read(length * 2)
+        .encode('UTF-8', 'UTF-16BE', universal_newline: true)
+        .delete("\000")
     end
 
     # Reads a boolean value.

data/lib/psd/image.rb

@@ -120,4 +120,4 @@ class PSD
       @pixel_data[i]
     end
   end
-end
+end

data/lib/psd/layer_info/typetool.rb

@@ -18,9 +18,6 @@ class PSD
       descriptor_version = @file.read_int
 
       @data[:text] = Descriptor.new(@file).parse
-      @data[:text]['EngineData']
-        .encode!('UTF-8', 'MacRoman', invalid: :replace, undef: :replace)
-        .delete!("\000")
 
       @data[:engine_data] = nil
       begin
@@ -44,12 +41,7 @@ class PSD
     # Extracts the text within the text area. In the event that psd-enginedata fails
     # for some reason, we attempt to extract the text using some rough regex.
     def text_value
-      if engine_data.nil?
-        # Something went wrong, lets hack our way through.
-        /\/Text \(˛ˇ(.*)\)$/.match(@data[:text]['EngineData'])[1].gsub /\r/, "\n"
-      else
-        engine_data.EngineDict.Editor.Text
-      end
+      @data[:text]['Txt ']
     end
     alias :to_s :text_value
 

data/lib/psd/layer_mask.rb

@@ -12,8 +12,7 @@ class PSD
 
       @layers = []
       @merged_alpha = false
-      @global_mask = nil
-      @extras = []
+      @global_mask = nil      
     end
 
     # Allows us to skip this section because it starts with the length of the section

data/lib/psd/resources/xmp_metadata.rb

@@ -0,0 +1,46 @@
+require 'psd/resources/base'
+
+class PSD
+  class Resource
+    module Section
+      class XMPMetadata < Base
+        resource_id 1060
+        name :xmp_metadata
+
+        attr_reader :xml, :data
+        alias_method :to_hash, :data
+
+        def parse
+          @xml = @file.read(@resource.size)
+          @data = {}
+
+          @xmp = XMP.new(xml)
+          @xmp.namespaces.each do |a|
+            parse_tree(a.to_sym)
+          end
+        rescue Java::OrgW3cDom::DOMException
+          PSD.logger.error "Unable to parse XMP Metadata"
+        ensure
+          @resource.data = self
+        end
+
+        private
+
+        def parse_tree(attr_name)
+          @data[attr_name] = {}
+          @xmp.send(attr_name).attributes.each do |a|
+            begin
+              @data[attr_name][a.to_sym] = @xmp.send(attr_name).send(a)[0]
+            rescue
+              @data[attr_name][a.to_sym] = parse_text_node(@xmp.send(attr_name), "//#{attr_name}:#{a}")
+            end
+          end
+        end
+
+        def parse_text_node(node, path)
+          node.send(:xml).xpath(path).first.text
+        end
+      end
+    end
+  end
+end

data/lib/psd/version.rb

@@ -1,3 +1,3 @@
 class PSD
-  VERSION = "3.1.2"
+  VERSION = "3.1.3"
 end

data/psd.gemspec

@@ -19,9 +19,10 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
   gem.add_dependency 'rake'
-  gem.add_dependency 'psd-enginedata', '~> 1.0'
+  gem.add_dependency 'psd-enginedata', '~> 1'
   gem.add_dependency 'chunky_png'
   gem.add_dependency 'activesupport', '~> 3.2.7'
+  gem.add_dependency 'xmp'
 
   gem.test_files = Dir.glob("spec/**/*")
   gem.add_development_dependency 'rspec'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: psd
 version: !ruby/object:Gem::Version
-  version: 3.1.2
+  version: 3.1.3
 platform: ruby
 authors:
 - Ryan LeFevre
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-10 00:00:00.000000000 Z
+date: 2014-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: chunky_png
   requirement: !ruby/object:Gem::Requirement
@@ -67,6 +67,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 3.2.7
+- !ruby/object:Gem::Dependency
+  name: xmp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -140,7 +154,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- circle.yml
 - lib/psd.rb
 - lib/psd/blend_mode.rb
 - lib/psd/channel_image.rb
@@ -223,6 +236,7 @@ files:
 - lib/psd/resources/guides.rb
 - lib/psd/resources/layer_comps.rb
 - lib/psd/resources/slices.rb
+- lib/psd/resources/xmp_metadata.rb
 - lib/psd/util.rb
 - lib/psd/version.rb
 - psd.gemspec

data/circle.yml

@@ -1,6 +0,0 @@
-machine:
-  ruby:
-    version: 2.0.0-p195
-test:
-  override:
-    - rspec