icns 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 21907abf35ec200a4464c7f44871455d1f3d1053
-  data.tar.gz: 3da2ede6d26b008b40ce8d1fa0bb257be64deb2d
+SHA256:
+  metadata.gz: 73af1cb7701d4470b180246ec9c13dd6ecb6b72df1f5154874a1717c40fc8c40
+  data.tar.gz: 7ae0fa54528d9b01662fd86906b56d6d1c6c328ab1e3cc0246d4e4f495b35dfd
 SHA512:
-  metadata.gz: a6afa750b73da5a50b20af734c48697920f7b06b16832c8544db25ff0c85eb42232ca0bb9279c7fce9641388fff654a98df02af69db511edbc57d198f432d396
-  data.tar.gz: 3c8af1ab4300fc43efe5573abd9b542512f46ecf954dc9d3b981d6291e3e2aec7697b1a05f60c5b7bfefe0711a206f1973cc58f7e893d7b523547e80892e5203
+  metadata.gz: fc9f61bad74d25a699c0e1a592040a159e73351b565e7f98ed18d0e8604a32109c75a529c618526f6e998453d081595f0ce21ae534afe522db23c7ae9f6f0ebe
+  data.tar.gz: df524a7ba9b7713304f2b15f8b8679b832516ceaf5e235be2041b3b8c97079592c01cfe15253d5233b524f178729c87cdb8d59ffb359a60c4c00c8390e123fff

data/.rubocop.yml

@@ -0,0 +1,12 @@
+AllCops:
+  TargetRubyVersion: 2.5.1
+  Exclude:
+    - bin/**/*
+    - vendor/**/*
+
+Style/AsciiComments:
+  Enabled: false
+
+Metrics:
+  Exclude:
+    - test/**/*

data/.ruby-version

@@ -0,0 +1 @@
+2.5.1

data/.travis.yml

@@ -1,5 +1,8 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.4.2
-before_install: gem install bundler -v 1.16.1
+  - 2.5.1
+before_install: gem install bundler -v 1.16.2
+script:
+  - bundle exec rake test
+  - bundle exec rubocop

data/Gemfile

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

data/Gemfile.lock

@@ -1,13 +1,28 @@
 PATH
   remote: .
   specs:
-    icns (0.1.0)
+    icns (0.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.0)
     minitest (5.11.3)
+    parallel (1.12.1)
+    parser (2.5.1.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.1)
+    rainbow (3.0.0)
     rake (10.5.0)
+    rubocop (0.56.0)
+      parallel (~> 1.10)
+      parser (>= 2.5)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    unicode-display_width (1.3.2)
 
 PLATFORMS
   ruby
@@ -17,6 +32,10 @@ DEPENDENCIES
   icns!
   minitest (~> 5.0)
   rake (~> 10.0)
+  rubocop (~> 0.56)
+
+RUBY VERSION
+   ruby 2.5.1p57
 
 BUNDLED WITH
-   1.16.1
+   1.16.2

data/README.md

@@ -1,6 +1,9 @@
-# Icns
+# ICNS
 
-Ruby library for extrating images from [ICNS](https://en.wikipedia.org/wiki/Apple_Icon_Image_format) files.
+[![Gem Version](https://img.shields.io/gem/v/icns.svg)](http://rubygems.org/gems/icns)
+[![Build Status](https://travis-ci.com/soffes/icns.svg?branch=master)](https://travis-ci.com/soffes/icns)
+
+Ruby library for extrating images from [Apple Icon Image format (ICNS)](https://en.wikipedia.org/wiki/Apple_Icon_Image_format) files.
 
 
 ## Installation
@@ -28,10 +31,10 @@ Read an icon out of an ICNS file:
 require 'icns'
 
 # Create a reader for an ICNS file
-reader = Icns::Reader('/Applications/Preview.app/Contents/Resources/Preview.icns')
+reader = Icns::Reader.new('/Applications/Preview.app/Contents/Resources/Preview.icns')
 
 # Extract the image data for a given size
-data = reader.image_for_size(1024)
+data = reader.image(size: 1024)
 
 # Write the image data out or do whatever you want with it
 File.write('Preview.png', data)

data/Rakefile

@@ -1,10 +1,12 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+# frozen_string_literal: true
+
+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"]
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
 end
 
-task :default => :test
+task default: :test

data/icns.gemspec

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'icns/version'
 
@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.version       = Icns::VERSION
   spec.authors       = ['Sam Soffes']
   spec.email         = ['sam@soff.es']
-  spec.summary       = 'Ruby library for extrating images from ICNS files.'
+  spec.summary       = 'Read images from Apple Icon Image format (ICNS) files.'
   spec.homepage      = 'https://github.com/soffes/icns'
   spec.license       = 'MIT'
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   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'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop', '~> 0.56'
 end

data/lib/icns.rb

@@ -106,12 +106,12 @@ module Icns
 
   # 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)
-  }
+    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]
+  }.freeze
 end

data/lib/icns/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Icns
   class Error < StandardError; end
 

data/lib/icns/reader.rb

@@ -3,10 +3,11 @@
 require 'icns/errors'
 
 module Icns
+  # Read an ICNS file’s metadata and extract images.
   class Reader
     # Initialize with a path to a valid ICNS file
     def initialize(path)
-      throw FileNotFound unless File.exists?(path)
+      throw FileNotFound unless File.exist?(path)
 
       @path = path
       @parts = {}
@@ -20,8 +21,8 @@ module Icns
     end
 
     # Raw data for a type
-    def data_for_type(type)
-      return nil unless part = @parts[type.to_s]
+    def data(type:)
+      return nil unless (part = @parts[type.to_s])
 
       File.open(@path) do |file|
         # Seek to the image data position
@@ -33,12 +34,12 @@ module Icns
     end
 
     # PNG or JPEG-2000 data for a size
-    def image_for_size(size)
-      return nil unless types = SIZE_TO_TYPE[size.to_i]
+    def image(size:)
+      return nil unless (types = SIZE_TO_TYPE[size.to_i])
 
       data = nil
       types.each do |type|
-        break if data = data_for_type(type)
+        break if (data = self.data(type: type))
       end
 
       data
@@ -47,8 +48,8 @@ module Icns
     # 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
+      @parts.keys.select { |k| types.include?(k) }
+            .map { |k| TYPE_TO_SIZE[k] }.sort.uniq
     end
 
     private
@@ -74,24 +75,28 @@ module Icns
         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
+        loop do
+          break unless read_part(file)
         end
       end
     end
+
+    def read_part(file)
+      # If we can't read the icon type and length, we’re at the end
+      return false 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.unpack1('N') - 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

data/lib/icns/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: icns
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Sam Soffes
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-18 00:00:00.000000000 Z
+date: 2018-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.16'
+- !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'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -39,19 +53,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0.56'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0.56'
 description: 
 email:
 - sam@soff.es
@@ -60,6 +74,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
@@ -93,8 +109,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: Ruby library for extrating images from ICNS files.
+summary: Read images from Apple Icon Image format (ICNS) files.
 test_files: []