appiconset 2.2.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ef0d21daa468cb3bca61be5786766824f2c4ec9c553e9c3df5cf6dec06fd635
-  data.tar.gz: 514769fbdbfa9bbcc9de26ee59ecab63f89062695d158a1f54d87af76afa6c89
+  metadata.gz: 31edc704c52144a5eefe2339052935d3d2e8ad7c4dc062c6f09c162a963e7c43
+  data.tar.gz: 2d17094adebf34d345320a4144677a6bbb4c482b3c4e41f97f79c2f042008b04
 SHA512:
-  metadata.gz: 314eac0eab5dea83e8785067433d781f52ecdf769a46a06b2a678a868c30c03a73fbb6b1bf6025cd304ac66600c787251da2c17f5f5280beef16892518982534
-  data.tar.gz: 7a76a7819eaf2dfef44a2b9fad945b3cbedb578b04c84374eed3b41464f7c6da4667a26258a77683ff83424d3aa312b464d663c3bb8fd30e5a174c81a22a68d6
+  metadata.gz: 5d0fdd192a4fa0a39eb6b0394801193c370332f945d532b0ada368f6761ae87a6749902b91cd71b39a3a28334f66cf351d5cd9646976172a3f0d257b1f87c69c
+  data.tar.gz: e7392ae02c798e4f7a7f96d5891601db597e7a8ba1970a3f21d8402b5bce0fd6ed089928500057a6cd4c7e89f9da118f9bee37f23a4deb79f79f6ff7890dac2b

data/.rubocop_todo.yml

@@ -9,7 +9,7 @@
 # Offense count: 3
 # Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
 Metrics/AbcSize:
-  Max: 32
+  Max: 40
 
 # Offense count: 1
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
@@ -20,7 +20,7 @@ Metrics/BlockLength:
 # Offense count: 1
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
-  Max: 102
+  Max: 120
 
 # Offense count: 1
 # Configuration parameters: AllowedMethods, AllowedPatterns.
@@ -30,4 +30,4 @@ Metrics/CyclomaticComplexity:
 # Offense count: 3
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
-  Max: 38
+  Max: 64

data/README.base.md

@@ -0,0 +1,118 @@
+<!---------------------------->
+<!-- multilingual suffix: en, ja -->
+<!-- no suffix: en -->
+<!---------------------------->
+
+<!-- $ mmg README.base.md -->
+
+<!-- [ja] -->
+
+# Appiconset
+
+[![Gem Version](https://badge.fury.io/rb/appiconset.svg)](https://badge.fury.io/rb/appiconset)
+
+1024px x 1024pxの画像からmacOSアプリやiOSアプリで必要になるアプリアイコンを書き出すRubyスクリプトです。
+
+以下の環境で動作確認をしています。  
+* macOS 15.1
+
+以下のプラットフォームのアイコン作成をサポートしています。
+* iOS/iPadOS
+* macOS
+* Universal
+* watchOS
+* Android
+* tvOS
+
+# ガイド
+
+正方形アイコンを生成するには、1024px x 1024px の画像からアプリアイコンを作成します。
+
+```
+$ appiconset g -i='sample.jpg' -o='output'   
+```
+
+Contents.jsonと複数のpngファイルが作成されます。  
+これらのファイルをXcodeプロジェクトの AppIcon.appiconset にコピーします。
+
+
+## tvOSのアイコン
+
+tvOSアプリ向けのアイコンを作成するには。4640px x 1440px の画像を用意します。  
+入力画像から以下の画像を生成します。  
+入力画像は tv-top-shelf-wide と同じ、tv-top-shelf は tv-top-shelf-wide から赤の領域が削除された画像、tvはtv-top-shelfから緑の領域が削除された画像になります。
+
+| ディレクトリの名前 | サイズ | 画像 |
+|--|--|--|
+| tv | 400x1440 | ![tv](sample/tv/Icon@2x.png) |
+| tv-top-shelf | 3840x1440 | ![tv-top-shelf](sample/tv-top-shelf/Icon@2x.png)|
+| tv-top-shelf-wide | 4640x1440 |![tv-top-shelf-wide](sample/tv-top-shelf-wide/Icon@2x.png) |
+
+```
+$ appiconset g -i='sample.jpg' -o='output'   
+```
+
+## 任意のサイズのアイコン
+
+任意のサイズの画像から、1倍、2/3倍、1/3倍のアイコンを作成します。
+
+```
+$ appiconset g -i='sample.jpg' -o='output'   
+```
+
+<!-- [en] -->
+
+# Appiconset
+
+[![Gem Version](https://badge.fury.io/rb/appiconset.svg)](https://badge.fury.io/rb/appiconset)
+
+Ruby script to write app icons required for macOS and iOS apps from 1024px x 1024px images.
+
+We have confirmed the operation in the following environments.
+* macOS 15.1
+
+Icon creation is supported for the following platforms.
+* iOS/iPadOS
+* macOS
+* Universal
+* watchOS
+* Android
+* tvOS
+
+# Guide
+
+## Square icons
+
+Create an app icon from a 1024px x 1024px image.
+
+```
+$ appiconset g -i='sample.jpg' -o='output'   
+```
+
+A Contents.json and several png files will be created.  
+Copy these files to AppIcon.appiconset in the Xcode project.
+
+
+## tvOS icons
+
+To create an icon for a tvOS app, prepare a 4640px x 1440px image.  
+Generate the following image from the input image.  
+The input image is the same as tv-top-shelf-wide, tv-top-shelf is the image from tv-top-shelf-wide with the red area removed, and tv is the image from tv-top-shelf with the green area removed.
+
+| Directory name | Size | Image |
+|--|--|--|
+| tv | 400x1440 | ![tv](sample/tv/Icon@2x.png) |
+| tv-top-shelf | 3840x1440 | ![tv-top-shelf](sample/tv-top-shelf/Icon@2x.png)|
+| tv-top-shelf-wide | 4640x1440 |![tv-top-shelf-wide](sample/tv-top-shelf-wide/Icon@2x.png) |
+
+```
+$ appiconset g -i='sample.jpg' -o='output'   
+```
+
+## Icons of any size
+
+Create 1x, 2/3x, and 1/3x icons from any size image.
+
+```
+$ appiconset g -i='sample.jpg' -o='output'   
+```

data/README.ja.md

@@ -0,0 +1,55 @@
+
+
+
+# Appiconset
+
+[![Gem Version](https://badge.fury.io/rb/appiconset.svg)](https://badge.fury.io/rb/appiconset)
+
+1024px x 1024pxの画像からmacOSアプリやiOSアプリで必要になるアプリアイコンを書き出すRubyスクリプトです。
+
+以下の環境で動作確認をしています。  
+* macOS 15.1
+
+以下のプラットフォームのアイコン作成をサポートしています。
+* iOS/iPadOS
+* macOS
+* Universal
+* watchOS
+* Android
+* tvOS
+
+# ガイド
+
+正方形アイコンを生成するには、1024px x 1024px の画像からアプリアイコンを作成します。
+
+```
+$ appiconset g -i='sample.jpg' -o='output'   
+```
+
+Contents.jsonと複数のpngファイルが作成されます。  
+これらのファイルをXcodeプロジェクトの AppIcon.appiconset にコピーします。
+
+
+## tvOSのアイコン
+
+tvOSアプリ向けのアイコンを作成するには。4640px x 1440px の画像を用意します。  
+入力画像から以下の画像を生成します。  
+入力画像は tv-top-shelf-wide と同じ、tv-top-shelf は tv-top-shelf-wide から赤の領域が削除された画像、tvはtv-top-shelfから緑の領域が削除された画像になります。
+
+| ディレクトリの名前 | サイズ | 画像 |
+|--|--|--|
+| tv | 400x1440 | ![tv](sample/tv/Icon@2x.png) |
+| tv-top-shelf | 3840x1440 | ![tv-top-shelf](sample/tv-top-shelf/Icon@2x.png)|
+| tv-top-shelf-wide | 4640x1440 |![tv-top-shelf-wide](sample/tv-top-shelf-wide/Icon@2x.png) |
+
+```
+$ appiconset g -i='sample.jpg' -o='output'   
+```
+
+## 任意のサイズのアイコン
+
+任意のサイズの画像から、1倍、2/3倍、1/3倍のアイコンを作成します。
+
+```
+$ appiconset g -i='sample.jpg' -o='output'   
+```

data/README.md

@@ -1,11 +1,16 @@
+
+
+
 # Appiconset
 
-1024px x 1024pxの画像からmacOSアプリやiOSアプリで必要になるアプリアイコンを書き出すRubyスクリプトです。
+[![Gem Version](https://badge.fury.io/rb/appiconset.svg)](https://badge.fury.io/rb/appiconset)
 
-以下の環境で動作確認をしています。  
+Ruby script to write app icons required for macOS and iOS apps from 1024px x 1024px images.
+
+We have confirmed the operation in the following environments.
 * macOS 15.1
 
-以下のプラットフォームのアイコン作成をサポートしています。
+Icon creation is supported for the following platforms.
 * iOS/iPadOS
 * macOS
 * Universal
@@ -13,33 +18,40 @@
 * Android
 * tvOS
 
-# 使い方
+# Guide
 
-## 正方形アイコン
+## Square icons
 
-1024px x 1024px の画像からアプリアイコンを作成します。
+Create an app icon from a 1024px x 1024px image.
 
 ```
-$ appiconset square -i='sample.jpg' -o='output'   
+$ appiconset g -i='sample.jpg' -o='output'   
 ```
 
-Contents.jsonと複数のpngファイルが作成されます。  
-これらのファイルをXcodeプロジェクトの AppIcon.appiconset にコピーします。
+A Contents.json and several png files will be created.  
+Copy these files to AppIcon.appiconset in the Xcode project.
+
 
+## tvOS icons
 
-## tvOSのアイコン
+To create an icon for a tvOS app, prepare a 4640px x 1440px image.  
+Generate the following image from the input image.  
+The input image is the same as tv-top-shelf-wide, tv-top-shelf is the image from tv-top-shelf-wide with the red area removed, and tv is the image from tv-top-shelf with the green area removed.
 
-tvOSアプリ向けのアイコンを作成するには。4640px x 1440px の画像を用意します。  
-この画像からApp Icon.imagestack、Top Shelf Image.imageset、Top Shelf Image Wide.imagesetのアイコンを作成します。
+| Directory name | Size | Image |
+|--|--|--|
+| tv | 400x1440 | ![tv](sample/tv/Icon@2x.png) |
+| tv-top-shelf | 3840x1440 | ![tv-top-shelf](sample/tv-top-shelf/Icon@2x.png)|
+| tv-top-shelf-wide | 4640x1440 |![tv-top-shelf-wide](sample/tv-top-shelf-wide/Icon@2x.png) |
 
 ```
-$ appiconset tvos -i='sample.jpg' -o='output'   
+$ appiconset g -i='sample.jpg' -o='output'   
 ```
 
-## 任意のサイズのアイコン
+## Icons of any size
 
-任意のサイズの画像から、1倍、2/3倍、1/3倍のアイコンを作成します。
+Create 1x, 2/3x, and 1/3x icons from any size image.
 
 ```
-$ appiconset universal -i='sample.jpg' -o='output'   
+$ appiconset g -i='sample.jpg' -o='output'   
 ```

data/lib/appiconset/cli.rb

@@ -17,44 +17,16 @@ module Appiconset
       puts(Appiconset::VERSION)
     end
 
-    desc 'square', 'Create icons from a square image'
-    method_option :input, desc: 'Input image(1024px x 1024px)', aliases: '-i'
+    desc 'g', 'Create icons from any size image'
+    method_option :input, desc: 'Input image', aliases: '-i'
     method_option :output, desc: 'Write output to <dir>', aliases: '-o'
-    def square
+    def generator
       generator = Appiconset::Generator.new
 
       begin
         generator.config(options[:input].to_s, options[:output].to_s)
         generator.square_platforms
-      rescue StandardError => e
-        warn e.message
-        exit(1)
-      end
-    end
-
-    desc 'tvos', 'Create tvOS icons'
-    method_option :input, desc: 'Input image(4640px x 1440px)', aliases: '-i'
-    method_option :output, desc: 'Write output to <dir>', aliases: '-o'
-    def tvos
-      generator = Appiconset::Generator.new
-
-      begin
-        generator.config(options[:input].to_s, options[:output].to_s, 4640, 1440)
         generator.tvos_platforms
-      rescue StandardError => e
-        warn e.message
-        exit(1)
-      end
-    end
-
-    desc 'icons', 'Create Universal icons'
-    method_option :input, desc: 'Input any size image', aliases: '-i'
-    method_option :output, desc: 'Write output to <dir>', aliases: '-o'
-    def icons
-      generator = Appiconset::Generator.new
-
-      begin
-        generator.config(options[:input].to_s, options[:output].to_s, 0, 0)
         generator.universal_platforms
       rescue StandardError => e
         warn e.message

data/lib/appiconset/generator.rb

@@ -9,11 +9,15 @@ module Appiconset
   class Generator
     def initialize; end
 
-    def config(input, output, width = 1024, height = 1024)
+    def config(input, output)
       raise 'no input file.' unless File.exist?(input)
+      raise 'no output <dir>.' if output == ''
 
       size = FastImage.size(input)
-      raise 'unsupported size.' if width != 0 && height != 0 && (size[0].to_i != width || size[1].to_i != height)
+      raise 'Unsupported file.' if size.nil?
+
+      @width = size[0]
+      @height = size[1]
 
       output += '/' unless output.end_with?('/')
 
@@ -25,6 +29,10 @@ module Appiconset
 
     # 正方形アイコン
     def square_platforms
+      return unless @width == 1024 && @height == 1024
+
+      show_info('square')
+
       json_dir = "#{__dir__}/settings/*.json"
 
       Dir.glob(json_dir).each do |path|
@@ -62,15 +70,15 @@ module Appiconset
 
     # ユニバーサルアイコン
     def universal_platforms
-      size = FastImage.size(@input)
+      show_info('universal')
+
       platforms = [
         {
           name: 'universal',
           contents: [
-            { width: size[0], height: size[1], scale: 3 },
-            { width: size[0] / 3 * 2, height: size[1] / 3 * 2, scale: 2 },
-            { width: size[0] / 3, height: size[1] / 3, scale: 1 }
-
+            { width: @width, height: @height, scale: 3 },
+            { width: @width / 3 * 2, height: @height / 3 * 2, scale: 2 },
+            { width: @width / 3, height: @height / 3, scale: 1 }
           ]
         }
       ]
@@ -95,7 +103,13 @@ module Appiconset
     end
 
     # tvOSアイコン
+    # Input 4640x1440
+    # Output 2400x1440, 3840x1440, 4640x1440
     def tvos_platforms
+      return unless @width == 4640 && @height == 1440
+
+      show_info('tvOS')
+
       platforms = [
         {
           name: 'tv',
@@ -139,5 +153,9 @@ module Appiconset
         end
       end
     end
+
+    def show_info(platform_name)
+      puts "Created #{platform_name} icons from #{@width} x #{@height} image."
+    end
   end
 end

data/lib/appiconset/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Appiconset
-  VERSION = '2.2.0'
+  VERSION = '2.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appiconset
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.4.0
 platform: ruby
 authors:
 - arthur87
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-09 00:00:00.000000000 Z
+date: 2025-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -81,6 +81,8 @@ files:
 - ".rubocop_todo.yml"
 - ".travis.yml"
 - CHANGELOG.md
+- README.base.md
+- README.ja.md
 - README.md
 - Rakefile
 - exe/appiconset
@@ -97,9 +99,16 @@ files:
 - lib/appiconset/settings/universal-xcode9.1-Contents.json
 - lib/appiconset/settings/watch-xcode10.0-Contents.json
 - lib/appiconset/version.rb
+- sample/tv-top-shelf-wide/Icon@1x.png
+- sample/tv-top-shelf-wide/Icon@2x.png
+- sample/tv-top-shelf/Icon@1x.png
+- sample/tv-top-shelf/Icon@2x.png
+- sample/tv/Icon@1x.png
+- sample/tv/Icon@2x.png
 - sig/appiconset.rbs
 homepage: https://github.com/arthur87/appiconset
-licenses: []
+licenses:
+- MIT
 metadata:
   homepage_uri: https://github.com/arthur87/appiconset
   source_code_uri: https://github.com/arthur87/appiconset