ase 1.0.3 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d8b9a4fe8dffacb1b54b6c831206538f9eb5fb49
-  data.tar.gz: 315aff5c962cc1e7f3f066a8cd9368f1658703b3
+  metadata.gz: 203efd29143fde0efedd8fe1b9eb3f0434393842
+  data.tar.gz: da48c549c3ee08b188d2df5ebb3085d8767780c6
 SHA512:
-  metadata.gz: 4a95e73f705febe274a3e5b959ab953bb2ecb39066d2006944d3b5326d34b6b13853986228fa8ef21b97cde828389947a272b26738ecf3bd78a9b7afbbc9fb63
-  data.tar.gz: 269bc26cefac68b1cb7c8218cb2412e6729c138d8579777673680102dfa784257bab57a8eac2d68c9530d0dd3aae8e36bae740460bf4a79080800c4dc308fe4f
+  metadata.gz: 5fc9481aac21f3cbaeec567f27083b4629965a19ada5320c80d13f6f819831294c32b805ba18932ea7dc6f65b62d6890dfa0c951e05eb3e4eb804b557dedfd3b
+  data.tar.gz: dff49640e93873d3f06c2115942008d4491d79ed1fe713ff40d1ebbe1f5e3ca8190db8f846709fc913099d6daf1043c38e7e3296c22fd6fcf3829fb9102f1f70

data/README.md

@@ -24,8 +24,10 @@ Or install it yourself as:
 doc = ASE.new
 
 palette = ASE::Palette.new('My Colors')
-palette.add 'Black', ASE::Color.new(0, 0, 0)
-palette.add 'Red', ASE::Color.from_hex('#ff0000')
+palette.add 'Black', ASE::Color::RGB.new(0, 0, 0)
+palette.add 'Red', ASE::Color::RGB.from_hex('#ff0000')
+palette.add 'Blue', ASE::Color::CMYK.new(0.92, 0.68, 0.2, 0)
+palette.add 'Light Gray', ASE::Color::Gray.new(0.75)
 
 doc << palette
 doc.to_file('path/to/file.ase')
@@ -36,13 +38,20 @@ doc.to_file('path/to/file.ase')
 ``` ruby
 doc = ASE.from_file('path/to/file.ase')
 
-puts doc['My Colors']['Red'].to_rgb
+puts doc['My Colors']['Red'].to_a
 #=> [255, 0, 0]
 
 puts doc['My Colors'].size
 #=> 2
 ```
 
+## Notes
+
+* If the ASE file does not define a palette, and instead simply lists colors, ASE.rb will use `:default` as the palette name.
+* ASE.rb does not support LAB colors yet.
+* Because reading & writing CMYK/LAB colors is dependent on your color profile, the output might be different than what is shown in an Adobe application. Color profile support might be added in the future.
+* Gray and Grey are interchangeable in ASE.rb
+
 ## Contributing
 
 1. Fork it

data/examples/read.rb

@@ -0,0 +1,7 @@
+require 'pp'
+require './lib/ase'
+
+puts "Must specify a file" and exit if ARGV.length == 0
+
+doc = ASE.from_file(ARGV[0])
+pp doc

data/lib/ase.rb

@@ -1,13 +1,16 @@
 dir_root = File.dirname(File.absolute_path(__FILE__))
 
 require dir_root + "/ase/version"
-require dir_root + "/ase/color"
+
+require dir_root + "/ase/color_modes/cmyk"
+require dir_root + "/ase/color_modes/gray"
+require dir_root + "/ase/color_modes/rgb"
+
 require dir_root + "/ase/file"
 require dir_root + "/ase/palette"
 require dir_root + "/ase/reader"
 require dir_root + "/ase/writer"
 
-
 class ASE
   include Reader
   include Writer

data/lib/ase/color.rb

@@ -2,60 +2,8 @@
 # given color.
 class ASE
   class Color
-    class << self
-      def from_rgba(*args)
-        args = args.first if args.length == 1
-        self.new *args
-      end
-      alias :from_rgb :from_rgba
-
-      def from_hex(hex)
-        self.new *hex.gsub('#', '').scan(/../).map { |c| c.to_i(16) }
-      end
+    def self.factory(mode, *args)
+      const_get(mode.strip).new(*args)
     end
-
-    attr_accessor :r, :g, :b, :a
-
-    # We always internally store the color as RGBA.
-    def initialize(r, g, b, a = 255)
-      @r = r
-      @g = g
-      @b = b
-      @a = a
-    end
-
-    def to_rgba
-      [@r, @g, @b, @a]
-    end
-
-    def to_rgb
-      [@r, @g, @b]
-    end
-
-    def to_css
-      "rgba(#{r}, #{g}, #{b}, #{a})"
-    end
-
-    def [](i)
-      [@r, @g, @b, @a][i]
-    end
-
-    def to_hex(incl_hash=true, incl_alpha=false)
-      hex = incl_hash ? '#' : ''
-      colors = [@r, @g, @b]
-      colors << @a if incl_alpha
-
-      colors.each do |c| 
-        color = c.to_s(16)
-        if c < 16
-          hex << "0#{color}"
-        else
-          hex << color
-        end
-      end
-
-      return hex
-    end
-    alias :to_s :to_hex
   end
 end

data/lib/ase/color_modes/cmyk.rb

@@ -0,0 +1,44 @@
+require_relative '../color'
+
+class ASE
+  class Color
+    class CMYK
+      attr_accessor :c, :m, :y, :k
+
+      def initialize(c=0, m=0, y=0, k=0)
+        @c = c
+        @m = m
+        @y = y
+        @k = k
+      end
+
+      def read!(file)
+        @c, @m, @y, @k = 4.times.map do
+          file.read(4).unpack('g')[0].round(4)
+        end
+      end
+
+      def write!(file)
+        file.write 'CMYK'
+        to_a.each { |c| file.write [c].pack('g') }
+      end
+
+      def to_rgb
+        r = (1 - (@c * (1 - @k) + @k)) * 255
+        g = (1 - (@m * (1 - @k) + @k)) * 255
+        b = (1 - (@y * (1 - @k) + @k)) * 255
+
+        # Clamp
+        r = [0, r, 255].sort[1].to_i
+        g = [0, g, 255].sort[1].to_i
+        b = [0, b, 255].sort[1].to_i
+
+        RGB.new(r, g, b)
+      end
+
+      def to_a
+        [@c, @m, @y, @k]
+      end
+    end
+  end
+end

data/lib/ase/color_modes/gray.rb

@@ -0,0 +1,38 @@
+require_relative '../color'
+
+class ASE
+  class Color
+    class Gray
+      attr_accessor :value
+
+      def initialize(value=0)
+        @value = value
+      end
+
+      def read!(file)
+        @value = file.read(4).unpack('g')[0].round(4)
+      end
+
+      def write!(file)
+        file.write('Gray')
+        to_a.each { |c| file.write [c].pack('g') }
+      end
+
+      def to_rgb
+        RGB.new(*([rgb_value] * 3))
+      end
+
+      def to_a
+        [@value]
+      end
+
+      private
+
+      def rgb_value
+        (@value * 255).to_i
+      end
+    end
+
+    class Grey < Gray; end
+  end
+end

data/lib/ase/color_modes/rgb.rb

@@ -0,0 +1,74 @@
+require_relative '../color'
+
+class ASE
+  class Color
+    class RGB
+      attr_accessor :r, :g, :b
+
+      class << self
+        def from_rgba(*args)
+          args = args.first if args.length == 1
+          self.new *args
+        end
+        alias :from_rgb :from_rgba
+
+        def from_hex(hex)
+          self.new *hex
+            .gsub('#', '')[0...6]
+            .scan(/../)
+            .map { |c| c.to_i(16) }
+        end
+      end
+
+      def initialize(r=0, g=0, b=0)
+        @r = r
+        @g = g
+        @b = b
+      end
+
+      def read!(file)
+        @r, @g, @b = 3.times.map do |c|
+          (file.read(4).unpack('g')[0] * 255).to_i
+        end
+      end
+
+      def write!(file)
+        file.write 'RGB '
+        to_a.each { |c| file.write [c.to_f / 255].pack('g') }
+      end
+
+      def to_rgb
+        self
+      end
+
+      def to_a
+        [@r, @g, @b]
+      end
+
+      def to_css
+        "rgba(#{r}, #{g}, #{b}, #{255})"
+      end
+
+      def [](i)
+        [@r, @g, @b, 255][i]
+      end
+
+      def to_hex(incl_hash=true)
+        hex = incl_hash ? '#' : ''
+        colors = [@r, @g, @b]
+
+        colors.each do |c| 
+          color = c.to_s(16)
+          if c < 16
+            hex << "0#{color}"
+          else
+            hex << color
+          end
+        end
+
+        return hex
+      end
+      alias :to_s :to_hex
+    end
+  end
+end

data/lib/ase/palette.rb

@@ -1,5 +1,7 @@
 class ASE
   class Palette
+    include Enumerable
+
     attr_accessor :name, :colors
 
     def initialize(name)
@@ -26,6 +28,10 @@ class ASE
     end
     alias :size :length
 
+    def each(&block)
+      @colors.each(&block)
+    end
+
     def method_missing(method, *args, &block)
       if @colors.has_key?(method.to_s)
         return @colors[method.to_s]

data/lib/ase/reader.rb

@@ -30,45 +30,54 @@ class ASE
 
         block_count = @file.read_ulong
         
-        read_palette until @file.eof?
+        @palette = Palette.new(:default)
+        read_section until @file.eof?
+
+        add_palette @palette if @palettes.length == 0
+        @palette = nil
 
         @file.close
       end
 
       private
 
-      def read_palette
+      def read_section
         block_start = @file.read_ushort
 
+        case block_start
+        when 0xC001 then start_palette
+        when 1      then read_color
+        when 0xC002 then end_palette
+        end
+      end
+
+      def start_palette
         title_block_size = @file.read_ulong
         title = @file.read_string
 
-        palette = Palette.new(title)
-        
-        # Read the colors
-        while true
-          color_start = @file.read_ushort
-          break if color_start == 0xC002
+        @palette = Palette.new(title)
+      end
+
+      def end_palette
+        # Group end block
+        @file.seek 4, IO::SEEK_CUR
+        add_palette @palette
 
-          color_size = @file.read_ulong
-          color_name = @file.read_string
-          color_mode = @file.read(4)
+        @palette = Palette.new(:default)
+      end
 
-          r, g, b = @file.read(12).scan(/.{1,4}/).map do |c|
-            (c.reverse.unpack('F')[0] * 255).to_i
-          end
+      def read_color
+        color_size = @file.read_ulong
+        color_name = @file.read_string
+        color_mode = @file.read(4)
 
-          palette.add color_name, Color.new(r, g, b)
+        color = Color.factory(color_mode)
+        color.read!(@file)
 
-          # Null byte
-          @file.seek 2, IO::SEEK_CUR
-        end
+        @palette.add color_name, color
 
-        # Group end block
-        @file.seek 4, IO::SEEK_CUR
-        
-        add_palette palette
-        return true
+        # Null byte
+        @file.seek 2, IO::SEEK_CUR
       end
     end
   end

data/lib/ase/version.rb

@@ -1,3 +1,3 @@
 class ASE
-  VERSION = "1.0.3"
+  VERSION = "2.0.0"
 end

data/lib/ase/writer.rb

@@ -22,41 +22,47 @@ class ASE
       @file.write_ulong(color_count + (palette_count * 2))
 
       @palettes.each do |palette_name, palette|
-        # Block start
-        @file.write_ushort 0xC001
+        write_palette(palette_name, palette)
+      end
 
-        # Block length (title is UTF-16 encoded)
-        @file.write_ulong 4 + (palette_name.length * 2)
+      @file.write_ulong 0 # Group end block
+      @file.close
+    end
 
-        # Palette name
-        @file.write_string palette_name
+    private
 
-        palette.colors.each do |name, color|
-          # Color start
-          @file.write_ushort 1
+    def write_palette(name, palette)
+      # Block start
+      @file.write_ushort 0xC001
 
-          # Block length
-          @file.write_ulong 22 + (name.length * 2)
+      # Block length (title is UTF-16 encoded)
+      @file.write_ulong 4 + (name.length * 2)
 
-          # Color name
-          @file.write_string name
+      # Palette name
+      @file.write_string name.to_s
 
-          # Color mode
-          @file.write 'RGB '
+      palette.colors.each do |name, color|
+        write_color(name, color)
+      end
 
-          # Colors
-          rgb = color.to_rgb.map { |c| c.to_f / 255 }
-          rgb.each { |c| @file.write [c].pack('F').reverse }
-          
-          # End of colors
-          @file.write_null_byte
-        end
+      @file.write_ushort 0xC002 # Group end
+    end
 
-        @file.write_ushort 0xC002 # Group end
-        @file.write_ulong 0 # Group end block
-      end
+    def write_color(name, color)
+      # Color start
+      @file.write_ushort 1
 
-      @file.close
+      # Block length
+      @file.write_ulong 22 + (name.length * 2)
+
+      # Color name
+      @file.write_string name
+
+      # Color values
+      color.write!(@file)
+      
+      # End of color
+      @file.write_null_byte
     end
   end
 end

data/spec/ase_spec.rb

@@ -31,7 +31,7 @@ describe ASE do
 
     it "can add and remove colors" do
       palette = ASE::Palette.new('Test')
-      color = ASE::Color.new(255, 255, 255)
+      color = ASE::Color::RGB.new(255, 255, 255)
       
       palette.add 'White', color
       expect(palette.colors).to eq({
@@ -44,8 +44,8 @@ describe ASE do
 
     it '#length returns the number of colors' do
       palette = ASE::Palette.new('Test')
-      palette.add 'White', ASE::Color.new(255, 255, 255)
-      palette.add 'Black', ASE::Color.new(0, 0, 0)
+      palette.add 'White', ASE::Color::RGB.new(255, 255, 255)
+      palette.add 'Black', ASE::Color::RGB.new(0, 0, 0)
 
       expect(palette.length).to be 2
       expect(palette.size).to be 2
@@ -53,42 +53,10 @@ describe ASE do
 
     it '#[] lets you access a specific color' do
       palette = ASE::Palette.new('Test')
-      color = ASE::Color.new(255, 255, 255)
+      color = ASE::Color::RGB.new(255, 255, 255)
 
       palette.add 'White', color
       expect(palette['White']).to be color
     end
   end
-
-  describe ASE::Color do
-    it 'must be initialized with all RGB channels' do
-      expect {
-        ASE::Color.new
-      }.to raise_error
-    end
-
-    it 'sets a proper default for the alpha channel' do
-      color = ASE::Color.new(0, 0, 0)
-      expect(color.a).to be 255
-    end
-
-    it 'can be created with an RGB array' do
-      color1 = ASE::Color.from_rgba [0, 0, 0]
-      color2 = ASE::Color.from_rgb [0, 0, 0]
-
-      expect(color1.to_rgba).to eq([0, 0, 0, 255])
-      expect(color2.to_rgba).to eq([0, 0, 0, 255])
-    end
-
-    it 'can be created from a hex value' do
-      color1 = ASE::Color.from_hex('#000000')
-      color2 = ASE::Color.from_hex('000000')
-      color3 = ASE::Color.from_hex('#00000000')
-
-      rgba = [0, 0, 0, 255]
-      expect(color1.to_rgba).to eq(rgba)
-      expect(color2.to_rgba).to eq(rgba)
-      expect(color3.to_rgba).to eq([0, 0, 0, 0])
-    end
-  end
 end

data/spec/color_spec.rb

@@ -0,0 +1,96 @@
+require 'spec_helper'
+
+describe ASE::Color do
+  it "has a working factory method" do
+    expect(ASE::Color).to respond_to(:factory)
+  end
+
+  describe ASE::Color::RGB do
+    it "works with the color factory" do
+      expect(ASE::Color.factory('RGB')).to be_an_instance_of(ASE::Color::RGB)
+      expect(ASE::Color.factory('RGB ')).to be_an_instance_of(ASE::Color::RGB)
+    end
+
+    it 'can be created with an RGB array' do
+      color1 = ASE::Color::RGB.from_rgba [0, 0, 0]
+      color2 = ASE::Color::RGB.from_rgb [0, 0, 0]
+
+      expect(color1.to_a).to eq([0, 0, 0])
+      expect(color2.to_a).to eq([0, 0, 0])
+    end
+
+    it 'can be created from a hex value' do
+      color1 = ASE::Color::RGB.from_hex('#000000')
+      color2 = ASE::Color::RGB.from_hex('000000')
+      color3 = ASE::Color::RGB.from_hex('#00000000')
+
+      rgb = [0, 0, 0]
+      expect(color1.to_a).to eq(rgb)
+      expect(color2.to_a).to eq(rgb)
+      expect(color3.to_a).to eq([0, 0, 0])
+    end
+
+    it "returns itself when calling to_rgb" do
+      color = ASE::Color::RGB.new(10, 10, 10)
+      expect(color.to_rgb).to be color
+    end
+
+    it "can be expressed as an array" do
+      color = ASE::Color::RGB.new(10, 10, 10)
+      expect(color.to_a).to eq([10, 10, 10])
+    end
+  end
+
+  describe ASE::Color::Gray do
+    it "works with the color factory" do
+      expect(ASE::Color.factory('Gray')).to be_an_instance_of(ASE::Color::Gray)
+      expect(ASE::Color.factory('Grey')).to be_an_instance_of(ASE::Color::Grey)
+    end
+
+    it "has a readable value" do
+      color = ASE::Color::Gray.new(0.75)
+      expect(color.value).to eq(0.75)
+    end
+
+    it "can be expressed as an array" do
+      color = ASE::Color::Gray.new(0.75)
+      expect(color.to_a).to eq([0.75])
+    end
+
+    it "can be converted to RGB" do
+      color = ASE::Color::Gray.new(0.75)
+      rgb = color.to_rgb
+
+      rgb_value = (255 * 0.75).to_i
+      expect(rgb).to be_an_instance_of(ASE::Color::RGB)
+      expect(rgb.to_a).to eq([rgb_value] * 3)
+    end
+  end
+
+  describe ASE::Color::CMYK do
+    it "works with the color factory" do
+      expect(ASE::Color.factory('CMYK')).to be_an_instance_of(ASE::Color::CMYK)
+    end
+
+    it "has readable values" do
+      color = ASE::Color::CMYK.new(0.1, 0.2, 0.3, 0.4)
+      expect(color.c).to eq(0.1)
+      expect(color.m).to eq(0.2)
+      expect(color.y).to eq(0.3)
+      expect(color.k).to eq(0.4)
+    end
+
+    it "can be expressed as an array" do
+      color = ASE::Color::CMYK.new(0.1, 0.2, 0.3, 0.4)
+      expect(color.to_a).to eq([0.1, 0.2, 0.3, 0.4])
+    end
+
+    it "can be converted to RGB" do
+      color = ASE::Color::CMYK.new(0.1, 0.2, 0.3, 0.4)
+      rgb = color.to_rgb
+
+      expect(rgb).to be_an_instance_of(ASE::Color::RGB)
+      expect(rgb.to_a).to eq([137, 122, 107])
+    end
+  end
+end

data/spec/file_spec.rb

@@ -39,8 +39,8 @@ describe 'Files' do
 
     it 'correctly reads the color values' do
       doc = ASE.from_file('spec/files/control.ase')
-      expect(doc['Simple']['White'].to_rgb).to eq([255, 255, 255])
-      expect(doc['Simple']['Black'].to_rgb).to eq([0, 0, 0])
+      expect(doc['Simple']['White'].to_a).to eq([255, 255, 255])
+      expect(doc['Simple']['Black'].to_a).to eq([0, 0, 0])
     end
   end
 
@@ -49,8 +49,9 @@ describe 'Files' do
       doc = ASE.new
 
       palette = ASE::Palette.new('Test')
-      palette.add 'Red', ASE::Color.new(255, 0, 0)
-      palette.add 'Blue', ASE::Color.new(0, 0, 255)
+      palette.add 'Red', ASE::Color::RGB.new(255, 0, 0)
+      palette.add 'Blue', ASE::Color::CMYK.new(0.91, 0.68, 0.2, 0)
+      palette.add 'Blah', ASE::Color::Gray.new(0.5)
 
       doc << palette
 
@@ -73,7 +74,7 @@ describe 'Files' do
 
     it 'writes the correct number of colors' do
       d = ASE.from_file(@output.path)
-      expect(d['Test'].size).to be 2
+      expect(d['Test'].size).to be 3
     end
 
     it 'writes the correct color names' do
@@ -84,8 +85,16 @@ describe 'Files' do
 
     it 'writes the correct color values' do
       d = ASE.from_file(@output.path)
-      expect(d['Test']['Red'].to_rgb).to eq([255, 0, 0])
-      expect(d['Test']['Blue'].to_rgb).to eq([0, 0, 255])
+      expect(d['Test']['Red'].to_a).to eq([255, 0, 0])
+      expect(d['Test']['Blue'].to_a).to eq([0.91, 0.68, 0.2, 0])
+      expect(d['Test']['Blah'].to_a).to eq([0.5])
+    end
+
+    it 'writes the correct color types' do
+      d = ASE.from_file(@output.path)
+      expect(d['Test']['Red']).to be_an_instance_of(ASE::Color::RGB)
+      expect(d['Test']['Blue']).to be_an_instance_of(ASE::Color::CMYK)
+      expect(d['Test']['Blah']).to be_an_instance_of(ASE::Color::Gray)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ase
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 2.0.0
 platform: ruby
 authors:
 - Ryan LeFevre
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-24 00:00:00.000000000 Z
+date: 2013-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -96,15 +96,20 @@ files:
 - Rakefile
 - ase.gemspec
 - examples/control.php
+- examples/read.rb
 - examples/simple.rb
 - lib/ase.rb
 - lib/ase/color.rb
+- lib/ase/color_modes/cmyk.rb
+- lib/ase/color_modes/gray.rb
+- lib/ase/color_modes/rgb.rb
 - lib/ase/file.rb
 - lib/ase/palette.rb
 - lib/ase/reader.rb
 - lib/ase/version.rb
 - lib/ase/writer.rb
 - spec/ase_spec.rb
+- spec/color_spec.rb
 - spec/file_spec.rb
 - spec/files/control.ase
 - spec/spec_helper.rb
@@ -135,6 +140,7 @@ summary: Reader/writer for Adobe Swatch Exchange files. Can be used across the e
   Adobe Creative Suite.
 test_files:
 - spec/ase_spec.rb
+- spec/color_spec.rb
 - spec/file_spec.rb
 - spec/files/control.ase
 - spec/spec_helper.rb