ase-palette 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fefbb045aba878667c779f8cf8a72f21c9c91f919efad22a436bc27594a22a0d
-  data.tar.gz: 7bbc45674d4344377fbdda0057fbb0b174c2f9eca06d7c495b50a59889e172cb
+  metadata.gz: 6361e025b4781e0cacb4f6f8b8f52b0d4b11d489468f06496b0f92c9dc11c9bb
+  data.tar.gz: 99807b55893ef200819ceb4b2cac53b1321cf99bcdab52d4c0e0680c9a825439
 SHA512:
-  metadata.gz: e25b1c71ae0192350717faf8fe00cd438ba999cf27f8b70b9ca11547d9d3f103452c426b3fd02c132ef2cd5a9efd5e0db5e33061fef3a287b5a4d43d8a218a3c
-  data.tar.gz: 3a3de6e42b122ceb0f9c5db2f7c0c35e285e67af4e96e85645b56b56c57395c4e26f6b4ea9c5c181677de4a493186921acebb1ace0a81698d1f95393c0ce0471
+  metadata.gz: 6409fcfa09189d3a50274ef25d4d179fa624b768329b2ef91da7977d9cd006255536b82ff4a2225bd8de18205328a3031666fb82d7a586c8e469d5c9f8245080
+  data.tar.gz: 76a1cf7733d883941f868a26eeb2b7bbb198b838ab1dc5e35c976533a9460a867f259dd438b1c5701be0379edc3c191fb09c4d35557cfdb3fc0faab17522e9c9

data/CHANGELOG.md

@@ -1,4 +1,7 @@
 # Changelog
 
+`0.9.1`
+- Add ability to read ASE files
+
 `0.9.0`
 - Initial beta version of gem

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ase-palette (0.9.0)
+    ase-palette (0.9.1)
       bindata (~> 2.4.4)
       hex_string (~> 1.0.1)
 

data/README.md

@@ -1,5 +1,10 @@
 # ASEPalette
 
+[<img src="https://img.shields.io/gem/v/ase-palette.svg?color=g" />](https://rubygems.org/gems/ase-palette)
+[<img src="https://img.shields.io/gem/dt/ase-palette.svg?color=g" />](https://rubygems.org/gems/ase-palette)
+
+Create and manage Adobe ASE color palettes in Ruby.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -8,14 +13,6 @@ Add this line to your application's Gemfile:
 gem 'ase-palette'
 ```
 
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install ase-palette
-
 ## Usage
 
 ### Load
@@ -86,17 +83,13 @@ respond_to do |format|
 end
 ```
 
-### Import [UNDER DEVELOPMENT]
+### Import
 
 ```ruby
 # Open palette from file
-palette = ASEPalette.open('path/to/palette.ase')
-
-# Access color
-puts palette.color_with_name "Red"
-# Red, RGB: 255/0/0, :global
+palette = ASEPalette.open 'path/to/palette.ase'
 
-# Access palette
+# Access palette colors
 puts palette
 # ASEPalette 2.0
 # --------------

data/lib/ase-palette.rb

@@ -13,4 +13,8 @@ module ASEPalette
   def self.new
     Palette.new
   end
+
+  def self.open(path)
+    Palette.new(path)
+  end
 end

data/lib/ase-palette/palette.rb

@@ -1,15 +1,17 @@
 module ASEPalette
   class Palette
     # TODO: Consider removing 'with_name' from method signatures
-    # TODO: Make sure to encode strings back to UTF-8 when importing ASE files
-    # TODO: Check case-sensitivity of the ASE spec for color and group names
  
     # Initialize palette
-    def initialize
+    def initialize(path = nil)
       @version_major = 1
       @version_minor = 0
       @colors = []
       @groups = []
+      if path
+        palette_hash = PaletteBinary.build_binary_hash_from_file(path)
+        initialize_values_from_palette_hash(palette_hash)
+      end
     end
 
     # Get palette version
@@ -35,7 +37,7 @@ module ASEPalette
 
     # Get color by name
     def color_with_name(name)
-      found_colors = all_colors.select { |c| c.name == name }
+      found_colors = all_colors.select { |color| color.name == name }
       found_colors.length >= 1 ? found_colors[0] : nil
     end
 
@@ -46,7 +48,7 @@ module ASEPalette
 
     # Get read-only group by name
     def group_with_name(name)
-      found_groups = @groups.select { |g| g.name == name }
+      found_groups = @groups.select { |group| group.name == name }
       found_groups.length >= 1 ? found_groups[0].clone : nil
     end
 
@@ -56,7 +58,7 @@ module ASEPalette
     # Returns true if color is added
     def add_color(color, group_name: nil)
       if color.is_a? Color
-        if color_does_not_exist_in_palette(color.name)
+        if color_does_not_exist(color.name)
           if group_name
             group = find_or_create_group(group_name)
             group.colors << color
@@ -76,7 +78,7 @@ module ASEPalette
     # Create empty group in palette
     # Returns true if group is created
     def create_group(name)
-      if @groups.select { |group| group.name == name }.length == 0
+      if group_does_not_exist(name)
         @groups << ASEPalette::Group.new(name)
         true
       else
@@ -116,20 +118,22 @@ module ASEPalette
         s += "This palette is empty\n"
       end
       s += divider
-      s += "#{all_colors.length} color#{if all_colors.length != 1 then "s" end}, " \
-           "#{@groups.length} group#{if @groups.length != 1 then "s" end}"
+      s += "#{all_colors.length} " \
+           "color#{if all_colors.length != 1 then "s" end}, " \
+           "#{@groups.length} " \
+           "group#{if @groups.length != 1 then "s" end}"
       s
     end
 
     # Create binary representation of palette
     def to_binary
-      palette = PaletteBinary.build_binary_palette(
+      binary_palette = PaletteBinary.build_binary_palette(
         @colors.map(&:to_h),
         @groups.map(&:to_h),
         @version_major,
         @version_minor,
       )
-      palette.to_binary_s
+      binary_palette.to_binary_s
     end
 
     # Create human-readable hex representation of palette
@@ -139,6 +143,46 @@ module ASEPalette
 
     private
 
+    # Set palette values from binary-derived hash
+    # Used to populate a Palette from an ASE file
+    def initialize_values_from_palette_hash(palette_hash)
+      @version_major = palette_hash[:version_major]
+      @version_minor = palette_hash[:version_minor]
+      palette_hash[:colors].each do |color|
+        add_color(color_from_hash(color))
+      end
+      palette_hash[:groups].each do |group|
+        group[:colors].each do |color|
+          add_color(color_from_hash(color), group_name: group[:name])
+        end
+      end
+    end
+
+    # Create Color object from binary-derived hash
+    # Used to populate a Palette from an ASE file
+    def color_from_hash(color)
+      case color[:model]
+      when :rgb
+        Color::RGB.new(
+          color[:name],
+          *color[:data].values,
+          color[:type],
+        )
+      when :cmyk
+        Color::CMYK.new(
+          color[:name],
+          *color[:data].values,
+          color[:type],
+        )
+      when :lab
+        Color::LAB.new(
+          color[:name],
+          *color[:data].values,
+          color[:type],
+        )
+      end
+    end
+
     # Returns an array of all colors in the palette,
     # including those in groups
     def all_colors
@@ -147,10 +191,15 @@ module ASEPalette
 
     # Determines whether or not a color exists in the palette,
     # including those in groups
-    def color_does_not_exist_in_palette(name)
+    def color_does_not_exist(name)
       all_colors.select { |color| color.name == name }.length == 0
     end
 
+    # Determines whether or not a group exists in the palette
+    def group_does_not_exist(name)
+      @groups.select { |group| group.name == name }.length == 0
+    end
+
     # Returns a found or created group
     def find_or_create_group(name)
       found_groups = @groups.select { |group| group.name == name }

data/lib/ase-palette/palette_binary.rb

@@ -21,12 +21,12 @@ module ASEPalette
     class ASEBinData < BinData::Record
       endian :big
     
-      string :signature, value: "ASEF"
+      string :signature, value: "ASEF", read_length: 4
       uint16 :version_major, initial_value: DEFAULT_VERSION_MAJOR
       uint16 :version_minor, initial_value: DEFAULT_VERSION_MINOR
       uint32 :block_count, value: -> { blocks.length }
     
-      array :blocks do
+      array :blocks, initial_length: -> { block_count } do
         uint16 :block_type
         uint32 :block_length, value: -> {
           block_length = 0
@@ -53,7 +53,7 @@ module ASEPalette
           class BlockGroupStart < BinData::Record
             endian :big
             uint16 :name_length, value: -> { name.length / 2 + 1 }
-            string :name, read_length: :name_length
+            string :name, read_length: -> { (name_length - 1) * 2 }
             uint16 :null_padding, value: 0
           end
           class BlockGroupEnd < BinData::Record
@@ -61,9 +61,9 @@ module ASEPalette
           class BlockColor < BinData::Record
             endian :big
             uint16 :name_length, value: -> { name.length / 2 + 1 }
-            string :name, read_length: :name_length
+            string :name, read_length: -> { (name_length - 1) * 2 }
             uint16 :null_padding, value: 0
-            string :color_model, initial_value: COLOR_MODEL_DEFAULT
+            string :color_model, read_length: 4
             choice :color_data, selection: -> { color_model } do
               class ColorDataRGB < BinData::Record
                 endian :big
@@ -134,6 +134,12 @@ module ASEPalette
       palette
     end
 
+    def self.build_binary_hash_from_file(path)
+      file = File.open(path)
+      binary = ASEBinData.read(file)
+      binary_to_hash(binary)
+    end
+
     private
 
     def self.binary_add_color(palette, name, model, type, data)
@@ -206,5 +212,78 @@ module ASEPalette
         block_type: BLOCK_TYPE_GROUP_END,
       })
     end
+
+    def self.binary_to_hash(binary)
+      palette = {
+        version_major: binary.version_major,
+        version_minor: binary.version_minor,
+        colors: [],
+        groups: [],
+      }
+
+      current_group = nil
+      binary.blocks.each do |block|
+        block_type = block[:block_type]
+        block_data = block[:block_data]
+        if block_type == BLOCK_TYPE_COLOR || block_type == BLOCK_TYPE_GROUP_START
+          block_name = block_data[:name].force_encoding(Encoding::UTF_16BE).encode(Encoding::UTF_8)
+        end
+        if block_type == BLOCK_TYPE_COLOR
+          color = { name: block_name }
+
+          color_data = block_data[:color_data]
+
+          case block_data[:color_model]
+          when COLOR_MODEL_RGB
+            color[:model] = :rgb
+            color[:data] = {
+              r: (color_data[:red] * 255.0).round,
+              g: (color_data[:green] * 255.0).round,
+              b: (color_data[:blue] * 255.0).round,
+            }
+          when COLOR_MODEL_CMYK, COLOR_MODEL_GRAY
+            color[:model] = :cmyk
+            color[:data] = {
+              c: (color_data[:cyan] * 100.0).round,
+              m: (color_data[:magenta] * 100.0).round,
+              y: (color_data[:yellow] * 100.0).round,
+              k: (color_data[:black] * 100.0).round,
+            }
+          when COLOR_MODEL_LAB
+            color[:model] = :lab
+            color[:data] = {
+              l: (color_data[:lightness] * 100.0).round,
+              a: (color_data[:a]).round,
+              b: (color_data[:b]).round,
+            }
+          end
+
+          case block_data[:color_type]
+          when COLOR_TYPE_GLOBAL
+            color[:type] = :global
+          when COLOR_TYPE_SPOT
+            color[:type] = :spot
+          when COLOR_TYPE_NORMAL
+            color[:type] = :normal
+          end
+
+          if current_group
+            current_group[:colors] << color
+          else
+            palette[:colors] << color
+          end
+        elsif block_type == BLOCK_TYPE_GROUP_START
+          current_group = {
+            name: block_name,
+            colors: []
+          }
+          palette[:groups] << current_group
+        elsif block_type == BLOCK_TYPE_GROUP_END
+          current_group = nil
+        end
+      end
+
+      palette
+    end
   end
 end

data/lib/ase-palette/version.rb

@@ -1,3 +1,3 @@
 module ASEPalette
-  VERSION = "0.9.0"
+  VERSION = "0.9.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ase-palette
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Sam Becker
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-14 00:00:00.000000000 Z
+date: 2019-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bindata