ase-palette 0.9.1 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6361e025b4781e0cacb4f6f8b8f52b0d4b11d489468f06496b0f92c9dc11c9bb
-  data.tar.gz: 99807b55893ef200819ceb4b2cac53b1321cf99bcdab52d4c0e0680c9a825439
+  metadata.gz: a8efd3a8b6e4f148e1b6ef04583e55e2c05f6ed3bb9ba236ff0f3c763789c0a2
+  data.tar.gz: 0fd75bad1b0cb5cfa08f9ae199534cbf82d2ba3ddbf1bf634e02fa6290e619f5
 SHA512:
-  metadata.gz: 6409fcfa09189d3a50274ef25d4d179fa624b768329b2ef91da7977d9cd006255536b82ff4a2225bd8de18205328a3031666fb82d7a586c8e469d5c9f8245080
-  data.tar.gz: 76a1cf7733d883941f868a26eeb2b7bbb198b838ab1dc5e35c976533a9460a867f259dd438b1c5701be0379edc3c191fb09c4d35557cfdb3fc0faab17522e9c9
+  metadata.gz: 61b554c482bf803f87cb852743ce3e0ab4a6a547662f516db04d55c05b788782597292afdc59dfb8d5c7a5e334e833330b70b4ffa99534b917102dcafa846c95
+  data.tar.gz: f232f7e71ed8d260c0f21133843666c76d198dfba892c4ba6f807d8df76fcb69d5f451e5dfa2d25e5b1edce1c4159f49d38d92ac11283e0c1009748811aa486b

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+`0.9.2`
+- Update dependencies
+
 `0.9.1`
 - Add ability to read ASE files
 

data/Gemfile.lock

@@ -1,30 +1,30 @@
 PATH
   remote: .
   specs:
-    ase-palette (0.9.1)
-      bindata (~> 2.4.4)
+    ase-palette (0.9.2)
+      bindata (~> 2.4.10)
       hex_string (~> 1.0.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    bindata (2.4.4)
-    diff-lcs (1.3)
+    bindata (2.4.10)
+    diff-lcs (1.5.0)
     hex_string (1.0.1)
-    rake (11.3.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
+    rake (13.0.6)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
 
 PLATFORMS
   ruby
@@ -32,8 +32,8 @@ PLATFORMS
 DEPENDENCIES
   ase-palette!
   bundler (~> 2.0)
-  rake (~> 11.2)
-  rspec (~> 3.8)
+  rake (~> 13.0)
+  rspec (~> 3.10)
 
 BUNDLED WITH
    2.0.1

data/README.md

@@ -1,4 +1,4 @@
-# ASEPalette
+# 🎨 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)
@@ -15,29 +15,26 @@ gem 'ase-palette'
 
 ## Usage
 
-### Load
+### 🚀 Load
 
 ```ruby
 require 'ase-palette'
 ```
 
-### Write
+### 📝 Write
 
 ```ruby
-# Create palette
+# Create a palette
 palette = ASEPalette.new
 
-# Create color
-color   = ASEPalette::Color::RGB.new "Red", 255, 0, 0
+# Add a color
+palette.add_color ASEPalette::Color::RGB.new "Red", 255, 0, 0
 
-# Add color to palette
-palette.add_color color
-
-# Add color to group
-palette.add_color color, group_name: "Group Name"
+# Add a color to a group
+palette.add_color ASEPalette::Color::CMYK.new "Yellow", 100, 0, 0, 0, group_name: "My Group"
 ```
 
-### Read
+### 📖 Read
 
 ```ruby
 # Access top-level colors
@@ -59,17 +56,17 @@ palette.colors(include_from_groups: true).each do |color|
 end
 ```
 
-### Edit
+### 🖋 Edit
 
 ```ruby
 # Remove a color, including those from groups
 palette.remove_color_with_name "Red"
 
-# Remove a group and all of the colors it contains
+# Remove a group and all of the colors in it
 palette.remove_group_with_name "Group Name" 
 ```
 
-### Export
+### ⬆️ Export
 
 ```ruby
 # Store file
@@ -83,7 +80,7 @@ respond_to do |format|
 end
 ```
 
-### Import
+### ⬇️ Import
 
 ```ruby
 # Open palette from file
@@ -100,11 +97,14 @@ puts palette
 #   Violet, RGB: 90/0/255, :global
 #   Blue, RGB: 0/0/255, :global
 #   Green, RGB: 50/255/50, :global
-#   Red, RGB: 240/0/20, :global
 #
 # Group 2
 #   Orange CMYK, CMYK: 0/80/100/0, :global
 #   Yellow CMYK, CMYK: 0/20/100/0, :global
+# 
+# Group 3
+#   PANTONE Yellow C, LAB: 89/-1/111, :spot
+#   PANTONE Orange 021 C, LAB: 61/66/85, :spot
 #
 # --------------
 # 7 colors, 2 groups

data/ase-palette.gemspec

@@ -37,10 +37,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.required_ruby_version = ">= 2.5.0"
 
-  spec.add_dependency "bindata", "~>2.4.4"
+  spec.add_dependency "bindata", "~>2.4.10"
   spec.add_dependency "hex_string", "~>1.0.1"
 
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 11.2"
-  spec.add_development_dependency "rspec", "~> 3.8"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.10"
 end

data/lib/ase-palette/palette.rb

@@ -1,7 +1,5 @@
 module ASEPalette
-  class Palette
-    # TODO: Consider removing 'with_name' from method signatures
- 
+  class Palette 
     # Initialize palette
     def initialize(path = nil)
       @version_major = 1
@@ -71,7 +69,21 @@ module ASEPalette
           raise Error, "A color named #{color.name} already exists"
         end
       else
-        raise Error, "Argument 'color' is not of type #{ASEPalette::Color}"
+        raise Error, "Argument 'color' must be of type #{ASEPalette::Color}"
+      end
+    end
+
+    # Add multiple colors to palette
+    # 'colors' must be an array of Color objects
+    # Optionally provide 'group_name' to place color in group
+    # Group will be created if it does not exist
+    def add_colors(colors, group_name: nil)
+      if colors.is_a? Array
+        colors.each do |color|
+          add_color(color, group_name: group_name)
+        end
+      else
+        raise Error, "Argument 'colors' must be of type #{Array}"
       end
     end
 
@@ -183,13 +195,13 @@ module ASEPalette
       end
     end
 
-    # Returns an array of all colors in the palette,
+    # Returns a copied array of all colors in palette,
     # including those in groups
     def all_colors
       @colors + @groups.map { |group| group.colors }.flatten
     end
 
-    # Determines whether or not a color exists in the palette,
+    # Determines whether color exists in palette,
     # including those in groups
     def color_does_not_exist(name)
       all_colors.select { |color| color.name == name }.length == 0

data/lib/ase-palette/palette_binary.rb

@@ -20,6 +20,34 @@ module ASEPalette
 
     class ASEBinData < BinData::Record
       endian :big
+
+      class String16Null < BinData::Primitive
+        endian :big
+
+        uint16 :len, value: -> { data.length / 2 + 1 }
+        string :data, read_length: -> { (len - 1) * 2 }
+        uint16 :null_terminator, value: 0
+
+        # Force UTF-16 string encoding
+        # when anonymous bytes are naively read in,
+        # then encode for UTF-8, which the user expects
+        def get
+          self.data.force_encoding(Encoding::UTF_16BE).encode(Encoding::UTF_8)
+        end
+
+        # Expect to receive UTF-8 string when setting
+        def set(string)
+          self.data = string.encode(Encoding::UTF_16BE)
+        end
+
+        # Calculate total size, in bytes, of:
+        # - UTF-16-encoded string
+        # - uint16 length of string (2 bytes)
+        # - null terminator (2 bytes)
+        def size
+          self.data.length + 4
+        end
+      end
     
       string :signature, value: "ASEF", read_length: 4
       uint16 :version_major, initial_value: DEFAULT_VERSION_MAJOR
@@ -28,14 +56,17 @@ module ASEPalette
     
       array :blocks, initial_length: -> { block_count } do
         uint16 :block_type
+
         uint32 :block_length, value: -> {
           block_length = 0
-          if block_type == BLOCK_TYPE_COLOR ||
-            block_type == BLOCK_TYPE_GROUP_START
-            block_length += block_data.name.length
+          if block_type == BLOCK_TYPE_GROUP_START ||
+             block_type == BLOCK_TYPE_COLOR
+            block_length += block_data.name.size
           end
           if block_type == BLOCK_TYPE_COLOR
-            block_length += 10
+            # Add length of color_model string (4 bytes) +
+            # color_type uint16 (2 bytes)
+            block_length += 6
             case block_data.color_model
             when COLOR_MODEL_RGB
               block_length += 4 * 3
@@ -44,52 +75,47 @@ module ASEPalette
             when COLOR_MODEL_LAB
               block_length += 4 * 3
             end
-          elsif block_type == BLOCK_TYPE_GROUP_START
-            block_length += 4
           end
           block_length
         }
+
         choice :block_data, selection: -> { block_type } do
           class BlockGroupStart < BinData::Record
             endian :big
-            uint16 :name_length, value: -> { name.length / 2 + 1 }
-            string :name, read_length: -> { (name_length - 1) * 2 }
-            uint16 :null_padding, value: 0
+            String16Null :name
           end
           class BlockGroupEnd < BinData::Record
           end
           class BlockColor < BinData::Record
             endian :big
-            uint16 :name_length, value: -> { name.length / 2 + 1 }
-            string :name, read_length: -> { (name_length - 1) * 2 }
-            uint16 :null_padding, value: 0
+
+            class ColorDataRGB < BinData::Record
+              endian :big
+              float :red, initial_value: 0
+              float :green, initial_value: 0
+              float :blue, initial_value: 0
+            end
+            class ColorDataCMYK < BinData::Record
+              endian :big
+              float :cyan, initial_value: 0
+              float :magenta, initial_value: 0
+              float :yellow, initial_value: 0
+              float :black, initial_value: 0
+            end
+            class ColorDataLAB < BinData::Record
+              endian :big
+              float :lightness, initial_value: 0
+              float :a, initial_value: 0
+              float :b, initial_value: 0
+            end
+            
+            String16Null :name
             string :color_model, read_length: 4
             choice :color_data, selection: -> { color_model } do
-              class ColorDataRGB < BinData::Record
-                endian :big
-                float :red, initial_value: 0
-                float :green, initial_value: 0
-                float :blue, initial_value: 0
-              end
-              class ColorDataCMYK < BinData::Record
-                endian :big
-                float :cyan, initial_value: 0
-                float :magenta, initial_value: 0
-                float :yellow, initial_value: 0
-                float :black, initial_value: 0
-              end
-              class ColorDataLAB < BinData::Record
-                endian :big
-                float :lightness, initial_value: 0
-                float :a, initial_value: 0
-                float :b, initial_value: 0
-              end
-    
               ColorDataRGB  COLOR_MODEL_RGB
               ColorDataCMYK COLOR_MODEL_CMYK
               ColorDataLAB  COLOR_MODEL_LAB
-              # Grayscale data is stored in a CMYK structure
-              ColorDataCMYK COLOR_MODEL_GRAY
+              ColorDataCMYK COLOR_MODEL_GRAY # Grayscale data stored in CMYK structure
             end
             uint16 :color_type, initial_value: COLOR_TYPE_DEFAULT
           end
@@ -190,7 +216,7 @@ module ASEPalette
       palette.blocks.push({
         block_type: BLOCK_TYPE_COLOR,
         block_data: {
-          name: name.encode(Encoding::UTF_16BE),
+          name: name,
           color_model: color_model,
           color_data: color_data,
           color_type: color_type,
@@ -202,7 +228,7 @@ module ASEPalette
       palette.blocks.push({
         block_type: BLOCK_TYPE_GROUP_START,
         block_data: {
-          name: name.encode(Encoding::UTF_16BE),
+          name: name
         }
       })
     end
@@ -226,7 +252,7 @@ module ASEPalette
         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)
+          block_name = block_data[:name]
         end
         if block_type == BLOCK_TYPE_COLOR
           color = { name: block_name }

data/lib/ase-palette/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ase-palette
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.2
 platform: ruby
 authors:
 - Sam Becker
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-03-15 00:00:00.000000000 Z
+date: 2022-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bindata
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.4
+        version: 2.4.10
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.4
+        version: 2.4.10
 - !ruby/object:Gem::Dependency
   name: hex_string
   requirement: !ruby/object:Gem::Requirement
@@ -58,28 +58,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.2'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.2'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.10'
 description: Read and write Adobe Swatch Exchange files.
 email:
 - sam@sambecker.com
@@ -113,7 +113,7 @@ metadata:
   homepage_uri: https://github.com/sambecker/ase-palette
   source_code_uri: https://github.com/sambecker/ase-palette
   changelog_uri: https://github.com/sambecker/ase-palette/blob/master/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -128,8 +128,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.3.5
+signing_key:
 specification_version: 4
 summary: Create and manage Adobe ASE palettes.
 test_files: []