Class: PSD::TypeTool
- Defined in:
- lib/psd/layer_info/typetool.rb
Overview
Parses and provides information about text areas within layers in the document.
Direct Known Subclasses
Instance Attribute Summary
Attributes inherited from LayerInfo
Class Method Summary collapse
Instance Method Summary collapse
-
#colors ⇒ Object
Return all colors used for text in this layer.
- #engine_data ⇒ Object
-
#font ⇒ Object
Gets all of the basic font information for this text area.
-
#fonts ⇒ Object
Returns all fonts listed for this layer, since fonts are defined on a per-character basis.
- #method_missing(method, *args, &block) ⇒ Object
-
#parse ⇒ Object
Parse all of the text data in the layer.
- #parser ⇒ Object
-
#sizes ⇒ Object
Return all font sizes for this layer.
- #styles ⇒ Object
-
#text_value ⇒ Object
(also: #to_s)
Extracts the text within the text area.
-
#to_css ⇒ Object
Creates the CSS string and returns it.
- #to_hash ⇒ Object
Methods inherited from LayerInfo
Constructor Details
This class inherits a constructor from PSD::LayerInfo
Dynamic Method Handling
This class handles dynamic methods through the method_missing method
#method_missing(method, *args, &block) ⇒ Object
145 146 147 148 |
# File 'lib/psd/layer_info/typetool.rb', line 145 def method_missing(method, *args, &block) return @data[method] if @data.has_key?(method) return super end |
Class Method Details
.should_parse?(key) ⇒ Boolean
8 9 10 |
# File 'lib/psd/layer_info/typetool.rb', line 8 def self.should_parse?(key) key == 'TySh' end |
Instance Method Details
#colors ⇒ Object
Return all colors used for text in this layer. The colors are returned in RGBA format as an array of arrays.
> [[255, 0, 0, 255], [0, 0, 255, 255]]
76 77 78 79 80 81 82 83 |
# File 'lib/psd/layer_info/typetool.rb', line 76 def colors # If the color is opaque black, this field is sometimes omitted. return [[0, 0, 0, 255]] if engine_data.nil? || !styles.has_key?('FillColor') styles['FillColor'].map { |s| values = s['Values'].map { |v| (v * 255).round } values << values.shift # Change ARGB -> RGBA for consistency }.uniq end |
#engine_data ⇒ Object
85 86 87 |
# File 'lib/psd/layer_info/typetool.rb', line 85 def engine_data @data[:engine_data] end |
#font ⇒ Object
Gets all of the basic font information for this text area. This assumes that the first font is the only one you want.
50 51 52 53 54 55 56 57 |
# File 'lib/psd/layer_info/typetool.rb', line 50 def font { name: fonts.first, sizes: sizes, colors: colors, css: to_css } end |
#fonts ⇒ Object
Returns all fonts listed for this layer, since fonts are defined on a per-character basis.
61 62 63 64 |
# File 'lib/psd/layer_info/typetool.rb', line 61 def fonts return [] if engine_data.nil? engine_data.ResourceDict.FontSet.map(&:Name) end |
#parse ⇒ Object
Parse all of the text data in the layer.
13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
# File 'lib/psd/layer_info/typetool.rb', line 13 def parse version = @file.read_short parse_transform_info text_version = @file.read_short descriptor_version = @file.read_int @data[:text] = Descriptor.new(@file).parse @data[:engine_data] = nil begin parser.parse! @data[:engine_data] = parser.result rescue Exception => e PSD.logger.error e. end warpVersion = @file.read_short descriptor_version = @file.read_int @data[:warp] = Descriptor.new(@file).parse [:left, :top, :right, :bottom].each do |pos| @data[pos] = @file.read_int end return self end |
#parser ⇒ Object
109 110 111 |
# File 'lib/psd/layer_info/typetool.rb', line 109 def parser @parser ||= PSD::EngineData.new(@data[:text]['EngineData']) end |
#sizes ⇒ Object
Return all font sizes for this layer.
67 68 69 70 |
# File 'lib/psd/layer_info/typetool.rb', line 67 def sizes return [] if engine_data.nil? || !styles.has_key?('FontSize') styles['FontSize'].uniq end |
#styles ⇒ Object
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 |
# File 'lib/psd/layer_info/typetool.rb', line 89 def styles return {} if engine_data.nil? @styles ||= ( data = engine_data.EngineDict.StyleRun.RunArray.map do |r| r.StyleSheet.StyleSheetData end Hash[data.reduce({}) { |m, o| o.each do |k, v| (m[k] ||= []) << v end m }.map { |k, v| [k, v.uniq] }] ) end |
#text_value ⇒ Object Also known as: to_s
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.
43 44 45 |
# File 'lib/psd/layer_info/typetool.rb', line 43 def text_value @data[:text]['Txt '] end |
#to_css ⇒ Object
Creates the CSS string and returns it. Each property is newline separated and not all properties may be present depending on the document.
Colors are returned in rgba() format and fonts may include some internal Photoshop fonts.
118 119 120 121 122 123 124 125 126 127 128 129 130 131 |
# File 'lib/psd/layer_info/typetool.rb', line 118 def to_css definition = { 'font-family' => fonts.join(', '), 'font-size' => "#{sizes.first}pt", 'color' => "rgba(#{colors.first.join(', ')})" } css = [] definition.each do |k, v| css << "#{k}: #{v};" end css.join("\n") end |
#to_hash ⇒ Object
133 134 135 136 137 138 139 140 141 142 143 |
# File 'lib/psd/layer_info/typetool.rb', line 133 def to_hash { value: text_value, font: font, left: left, top: top, right: right, bottom: bottom, transform: transform } end |