icns 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 21907abf35ec200a4464c7f44871455d1f3d1053
+  data.tar.gz: 3da2ede6d26b008b40ce8d1fa0bb257be64deb2d
+SHA512:
+  metadata.gz: a6afa750b73da5a50b20af734c48697920f7b06b16832c8544db25ff0c85eb42232ca0bb9279c7fce9641388fff654a98df02af69db511edbc57d198f432d396
+  data.tar.gz: 3c8af1ab4300fc43efe5573abd9b542512f46ecf954dc9d3b981d6291e3e2aec7697b1a05f60c5b7bfefe0711a206f1973cc58f7e893d7b523547e80892e5203

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    icns (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.11.3)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  icns!
+  minitest (~> 5.0)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Sam Soffes, https://soff.es
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,62 @@
+# Icns
+
+Ruby library for extrating images from [ICNS](https://en.wikipedia.org/wiki/Apple_Icon_Image_format) files.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'icns'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install icns
+
+
+## Usage
+
+Read an icon out of an ICNS file:
+
+```ruby
+require 'icns'
+
+# Create a reader for an ICNS file
+reader = Icns::Reader('/Applications/Preview.app/Contents/Resources/Preview.icns')
+
+# Extract the image data for a given size
+data = reader.image_for_size(1024)
+
+# Write the image data out or do whatever you want with it
+File.write('Preview.png', data)
+```
+
+Annoyingly, icons can be either PNGs or JPEG-2000s. The image data will start with `"\x89PNG"` if it is a PNG. You need to always have them in one format or another, I’d recommend using [minimagick](https://github.com/minimagick/minimagick) to convert it.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/soffes/icns.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+
+## References
+
+https://en.wikipedia.org/wiki/Apple_Icon_Image_format

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'icns'
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/icns.gemspec

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'icns/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'icns'
+  spec.version       = Icns::VERSION
+  spec.authors       = ['Sam Soffes']
+  spec.email         = ['sam@soff.es']
+  spec.summary       = 'Ruby library for extrating images from ICNS files.'
+  spec.homepage      = 'https://github.com/soffes/icns'
+  spec.license       = 'MIT'
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+end

data/lib/icns.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+require 'icns/version'
+require 'icns/reader'
+
+module Icns
+  # Map of type names to pixel sizes
+  TYPE_TO_SIZE = {
+    # 32×32 1-bit mono icon
+    'ICON' => 32,
+
+    # 32×32 1-bit mono icon with 1-bit mask
+    'ICN#' => 32,
+
+    # 16×12 1 bit mono icon with 1-bit mask
+    'icm#' => 16,
+
+    # 16×12 4 bit icon
+    'icm4' => 16,
+
+    # 16×12 8 bit icon
+    'icm8' => 16,
+
+    # 16×16 1-bit mask
+    'ics#' => 16,
+
+    # 16×16 4-bit icon
+    'ics4' => 16,
+
+    # 16x16 8 bit icon
+    'ics8' => 16,
+
+    # 16×16 24-bit icon
+    'is32' => 16,
+
+    # 16x16 8-bit mask
+    's8mk' => 16,
+
+    # 32×32 4-bit icon
+    'icl4' => 32,
+
+    # 32×32 8-bit icon
+    'icl8' => 32,
+
+    # 32x32 24-bit icon
+    'il32' => 32,
+
+    # 32×32 8-bit mask
+    'l8mk' => 32,
+
+    # 48×48 1-bit mask
+    'ich#' => 48,
+
+    # 48×48 4-bit icon
+    'ich4' => 48,
+
+    # 48×48 8-bit icon
+    'ich8' => 48,
+
+    # 48×48 24-bit icon
+    'ih32' => 48,
+
+    # 48×48 8-bit mask
+    'h8mk' => 48,
+
+    # 128×128 24-bit icon
+    'it32' => 128,
+
+    # 128×128 8-bit mask
+    't8mk' => 128,
+
+    # 16x16 icon in JPEG 2000 or PNG format
+    'icp4' => 16,
+
+    # 32x32 icon in JPEG 2000 or PNG format
+    'icp5' => 32,
+
+    # 64x64 icon in JPEG 2000 or PNG format
+    'icp6' => 64,
+
+    # 128x128 icon in JPEG 2000 or PNG format
+    'ic07' => 128,
+
+    # 256×256 icon in JPEG 2000 or PNG format
+    'ic08' => 256,
+
+    # 512×512 icon in JPEG 2000 or PNG format
+    'ic09' => 512,
+
+    # 1024×1024 in 10.7 (or 512x512@2x "retina" in 10.8) icon in JPEG 2000 or
+    # PNG format
+    'ic10' => 1024,
+
+    # 16x16@2x "retina" icon in JPEG 2000 or PNG format
+    'ic11' => 32,
+
+    # 32x32@2x "retina" icon in JPEG 2000 or PNG format
+    'ic12' => 64,
+
+    # 128x128@2x "retina" icon in JPEG 2000 or PNG format
+    'ic13' => 256,
+
+    # 256x256@2x "retina" icon in JPEG 2000 or PNG format
+    'ic14' => 512
+  }.freeze
+
+  # Types to try for each size
+  SIZE_TO_TYPE = {
+    16 => %w(icp4),
+    32 => %w(icp5 ic11),
+    64 => %w(icp6 ic12),
+    128 => %w(ic07),
+    256 => %w(ic08 ic13),
+    512 => %w(ic09 ic14),
+    1024 => %w(ic10)
+  }
+end

data/lib/icns/errors.rb

@@ -0,0 +1,6 @@
+module Icns
+  class Error < StandardError; end
+
+  class FileNotFound < Error; end
+  class InvalidHeader < Error; end
+end

data/lib/icns/reader.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require 'icns/errors'
+
+module Icns
+  class Reader
+    # Initialize with a path to a valid ICNS file
+    def initialize(path)
+      throw FileNotFound unless File.exists?(path)
+
+      @path = path
+      @parts = {}
+
+      read_metadata
+    end
+
+    # Available types
+    def types
+      @parts.keys
+    end
+
+    # Raw data for a type
+    def data_for_type(type)
+      return nil unless part = @parts[type.to_s]
+
+      File.open(@path) do |file|
+        # Seek to the image data position
+        file.pos = part[:offset]
+
+        # Read the length of the image data
+        file.read(part[:length])
+      end
+    end
+
+    # PNG or JPEG-2000 data for a size
+    def image_for_size(size)
+      return nil unless types = SIZE_TO_TYPE[size.to_i]
+
+      data = nil
+      types.each do |type|
+        break if data = data_for_type(type)
+      end
+
+      data
+    end
+
+    # Available image sizes
+    def sizes
+      types = SIZE_TO_TYPE.values.flatten
+      @parts.keys.select { |k| types.include?(k) }.
+        map { |k| TYPE_TO_SIZE[k] }.sort.uniq
+    end
+
+    private
+
+    # These types are just metadata and not images.
+    TYPES_BLACKLIST = [
+      # An optional table of contents
+      'TOC ',
+
+      # 4-byte big endian float - equal to the bundle version number of Icon
+      # Composer.app that created to icon
+      'icnV'
+    ].freeze
+
+    def read_metadata
+      # TODO: Parse `TOC ` part if available
+
+      File.open(@path) do |file|
+        # The first 4 bytes must be 'icns'
+        throw InvalidHeader unless file.read(4) == 'icns'
+
+        # The next 4 bytes are the total length of the file. Skip ahead.
+        file.pos += 4
+
+        # Keep reading until we hit the end
+        while true
+          # If we can't read the icon type and length, we’re at the end
+          break unless (type = file.read(4)) && (length = file.read(4))
+
+          # Convert the length into an integer. The length includes the icon
+          # header. We just want the length of the image data.
+          length = length.unpack('N')[0] - 8
+
+          unless TYPES_BLACKLIST.include?(type)
+            # Add to our hash of type name to image data locations
+            puts "WARNING: duplicate part '#{type}'" if @parts[type]
+            @parts[type] = { offset: file.pos, length: length }
+          end
+
+          # Advance past the image data
+          file.pos += length
+        end
+      end
+    end
+  end
+end

data/lib/icns/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Icns
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: icns
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sam Soffes
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- sam@soff.es
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- icns.gemspec
+- lib/icns.rb
+- lib/icns/errors.rb
+- lib/icns/reader.rb
+- lib/icns/version.rb
+homepage: https://github.com/soffes/icns
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Ruby library for extrating images from ICNS files.
+test_files: []