retinator 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c401027d0c6d29f925b6e243600b1f11c2276485
+  data.tar.gz: 75482b368b08a188053ae225f20f14f88a4fa52b
+SHA512:
+  metadata.gz: b049df9236a269f599ed84e35b3eacf4a790f87409df708e2a72bfde093c3ff53e55f1991c37b89686e6eadd93c3ef7833ff945b6f91a326539dded08c38a542
+  data.tar.gz: 9a288ac7002757bb0d9e5e2b872e9769ae3aef14dfb46302380c82bdc96afa96f6add4355de1d67915c218ac719d9f0d41237f8a5c5aeb6e163ccdcf51f80d18

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.travis.yml

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

data/.vscode/launch.json

@@ -0,0 +1,65 @@
+{
+    // Utilizar IntelliSense para aprender acerca de los posibles atributos.
+    // Mantenga el puntero para ver las descripciones de los existentes atributos 
+    // Para más información, visite: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Run Vertical Test",
+            "type": "Ruby",
+            "request": "launch",
+            "cwd": "${workspaceRoot}",
+            "program": "${workspaceRoot}/bin/retinator",
+            "args": [
+                "${workspaceRoot}/test/vertical.jpg",
+                "150"
+            ]
+        },
+        {
+            "name": "Run Horizontal Test",
+            "type": "Ruby",
+            "request": "launch",
+            "cwd": "${workspaceRoot}",
+            "program": "${workspaceRoot}/bin/retinator",
+            "args": [
+                "${workspaceRoot}/test/horizontal.jpg",
+                "150"
+            ]
+        },
+        {
+            "name": "Run Help Test",
+            "type": "Ruby",
+            "request": "launch",
+            "cwd": "${workspaceRoot}",
+            "program": "${workspaceRoot}/bin/retinator"
+        },
+        {
+            "name": "No Arguments Test",
+            "type": "Ruby",
+            "request": "launch",
+            "cwd": "${workspaceRoot}",
+            "program": "${workspaceRoot}/bin/retinator"
+        },
+        {
+            "name": "Wrong Flag Test",
+            "type": "Ruby",
+            "request": "launch",
+            "cwd": "${workspaceRoot}",
+            "program": "${workspaceRoot}/bin/retinator",
+            "args": [
+                "-l"
+            ]
+        },
+        {
+            "name": "Wrong Arguments Test",
+            "type": "Ruby",
+            "request": "launch",
+            "cwd": "${workspaceRoot}",
+            "program": "${workspaceRoot}/bin/retinator",
+            "args": [
+                "nofile",
+                "200"
+            ]
+        }
+    ]
+}

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in retinator.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    retinator (0.1.1)
+      colorize (~> 0.8.1)
+      mini_magick (~> 4.8)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    colorize (0.8.1)
+    mini_magick (4.8.0)
+    minitest (5.11.1)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  retinator!
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Mario Negro
+
+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,51 @@
+# Retinator [![Build Status](https://travis-ci.org/emenegro/retinator.svg?branch=master)](https://travis-ci.org/emenegro/retinator)
+
+Retinator resizes the source image and generates three images in @1x, @2x and @3x iOS resolutions.
+
+![retinator-gif](etc/retinator.gif)
+
+## Usage
+
+```        
+retinator [source_image] [destination_resolution]
+retinator --help
+```
+
+- `[source_image]`: path to the source image
+- `[destination_resolution]`: a number indicating the resolution of the smaller dimension of the destination @1x image
+
+### Example
+
+For an input image of 3000x1500, `retinator test.jpg 200` will output:
+
+```
+test.png    (400x200)
+test@2x.png (800x400)
+test@3x.png (1200x600)
+```
+
+## Installation
+
+This gem needs ImageMagick or GraphicksMagick in order to run. It has to be installed using a [brew](https://brew.sh) formula. Run this command in your terminal:
+
+```
+brew install graphicsmagick
+```
+
+After that you can install the tool the usual way:
+
+```
+gem install retinator
+```
+
+Or, in dev mode:
+
+```
+bundle install
+gem build retinator.gemspec
+gem install retinator-[VERSION].gem
+```
+
+## TODO
+
+- Allow batch processing

data/Rakefile

@@ -0,0 +1,15 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+require 'rubygems/package_task'
+
+spec = eval(File.read('retinator.gemspec'))
+Gem::PackageTask.new(spec) do |pkg|
+end
+
+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/retinator

@@ -0,0 +1,56 @@
+#!/usr/bin/env ruby
+
+require "retinator"
+require "colorize"
+require "optparse"
+
+# Graceful exit
+Signal.trap("INT") do
+  puts "\nRemoving partially generated images...".blue
+  Retinator.remove_files_on_abort
+  exit
+end
+
+options = {}
+option_parser = OptionParser.new do |opts|
+  opts.banner = "Usage: #{File.basename($PROGRAM_NAME)} source_image destination_resolution
+
+Retinator resizes the source image and generates
+three images in @1x, @2x and @3x iOS resolutions
+
+- source_image: path to the source image
+- destination_resolution: a number indicating the minimum resolution
+  of the smaller dimension of the destination @1x image
+  
+Example: for an input image of 3000x1500, 'retinator test.jpg 200' will output:
+  test.png    (400x200)
+  test@2x.png (800x400)
+  test@3x.png (1200x600)
+  "
+end
+
+begin
+  option_parser.parse!
+
+  if ARGV.count != 2
+    puts option_parser
+    exit 1
+  end
+
+  file = ARGV.shift
+  if !File.exist? file
+    puts "Error, no file found at '#{file}'".red
+    exit 1
+  end
+
+  res = ARGV.shift.to_i
+  if res <= 0
+    puts "Error, destination resolution has to be a number greater than 0".red
+    exit 1
+  end
+
+  Retinator.generate file, res
+rescue OptionParser::InvalidOption => ex
+  puts "Error, #{ex.message}".red
+  exit 1
+end

data/lib/retinator/config.rb

@@ -0,0 +1,8 @@
+OUTPUT_MAX_SCALE = 3
+OUTPUT_FORMAT = "png"
+OUTPUTS = [
+  # [RESOLUTION MULTIPLIER, FILE SUFFIX]
+  [1, ""], 
+  [2, "@2x"], 
+  [3, "@3x"]
+]

data/lib/retinator/utils.rb

@@ -0,0 +1,8 @@
+module Utils
+  class << self
+    def filename(path)
+      extension = File.extname path
+      return File.basename path, extension
+    end 
+  end
+end

data/lib/retinator/version.rb

@@ -0,0 +1,3 @@
+module Retinator
+  VERSION = "0.1.1"
+end

data/lib/retinator.rb

@@ -0,0 +1,67 @@
+require "mini_magick"
+require "colorize"
+require "fileutils"
+require_relative "retinator/version"
+require_relative "retinator/config"
+require_relative "retinator/utils"
+
+module Retinator
+  class << self
+    def generate(path, res)
+      return false unless check_params path, res
+      show_dimension_hint_if_needed path, res
+      generate_images path, res
+      return true
+    end
+
+    def remove_files_on_abort
+      @saved_files.each do |file|
+        FileUtils.rm file
+      end
+      @saved_files.clear
+    end
+
+    private def check_params(path, res)
+      return false unless path && res
+      return false unless File.exist? path
+      return false unless res.kind_of? Integer
+      return false unless res > 0
+      return true
+    end
+
+    private def generate_images(path, res)
+      @saved_files = []
+      name = Utils.filename path
+      OUTPUTS.each do |config|
+        scale = config[0]
+        suffix = config[1]
+        filename = "#{name}#{suffix}.#{OUTPUT_FORMAT}"
+        puts "Generating #{filename}..."
+        image = resize path, res * scale
+        save_file image, filename, OUTPUT_FORMAT
+      end
+      puts "Done!".green
+      @saved_files.clear
+    end
+
+    private def show_dimension_hint_if_needed(path, res)
+      image = MiniMagick::Image.open(path)
+      smaller_dimensions = image.dimensions.select { |d| d <= res * OUTPUT_MAX_SCALE}
+      if !smaller_dimensions.empty?
+        puts "[!] Size of the source image is smaller than the destination resolution".yellow
+        puts "    Result images could be pixelated".yellow
+      end
+    end
+
+    private def resize(path, res)
+      image = MiniMagick::Image.open path
+      return image.resize("#{res}x#{res}^")
+    end
+
+    private def save_file(image, filename, format)
+      image.format format
+      image.write filename
+      @saved_files << filename
+    end
+  end
+end

data/retinator.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "retinator/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "retinator"
+  spec.version       = Retinator::VERSION
+  spec.authors       = ["Mario Negro"]
+  spec.email         = ["mario.negro.martin@gmail.com"]
+
+  spec.summary       = "Generates @1x, @2x and @3x images versions of an image"
+  spec.description   = "Generates @1x, @2x and @3x images versions of an image for iOS projects"
+  spec.homepage      = "https://github.com/emenegro/retinator"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "colorize", "~> 0.8.1"
+  spec.add_runtime_dependency "mini_magick", "~> 4.8"
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: retinator
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Mario Negro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: mini_magick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+- !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: Generates @1x, @2x and @3x images versions of an image for iOS projects
+email:
+- mario.negro.martin@gmail.com
+executables:
+- retinator
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- ".vscode/launch.json"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/retinator
+- etc/retinator.gif
+- lib/retinator.rb
+- lib/retinator/config.rb
+- lib/retinator/utils.rb
+- lib/retinator/version.rb
+- retinator.gemspec
+homepage: https://github.com/emenegro/retinator
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Generates @1x, @2x and @3x images versions of an image
+test_files: []