frameit 2.4.1 → 2.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a0fbeeee7a265d5f757d6172db851a1db0974a8
-  data.tar.gz: 88ca5a4d0268d03ce589981c986bc1635704caf7
+  metadata.gz: 51f6e23e8a0eda4b74b3c2088da03c61ef8e98e5
+  data.tar.gz: 424487c213ded6efd87fb8e3f6dedfe6c090e063
 SHA512:
-  metadata.gz: 864d6698f6a6fea4c0a9ba5892b37391bec7440644112bdd36ec7e9d790a08a9d0fbc999c6e26bb783144168ce2225a0f65a5cd9f9d567032b68b3703a6270f6
-  data.tar.gz: cdc9caa978480de1cbb4062e74fd77efe29c156047edec90857f4326a0989073226400906b65958616ad96d00d941adf31042ca9f0f6f374fad3f70a67ca9786
+  metadata.gz: 1a4b71cff4333d074dfa1577fae67ca6675b55022e50048222017694856fa3e6af54921d7f210245673e393d77a7d01ba4e6f801dc598ba651aedf4b97cfd1d6
+  data.tar.gz: 33c0fe594cb17ebf08aa5a2a207eda07f53204fe03181f3b6450869b0958a29a9dfb7ed754984bbc466f5ec2c83f9fde4b6f696eadb328ab774bea4530220c33

data/README.md

@@ -29,14 +29,14 @@
 frameit
 ============
 
-[![Twitter: @KauseFx](https://img.shields.io/badge/contact-@KrauseFx-blue.svg?style=flat)](https://twitter.com/KrauseFx)
-[![License](https://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://github.com/KrauseFx/frameit/blob/master/LICENSE)
+[![Twitter: @KauseFx](https://img.shields.io/badge/contact-@FastlaneTools-blue.svg?style=flat)](https://twitter.com/FastlaneTools)
+[![License](https://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://github.com/fastlane/frameit/blob/master/LICENSE)
 [![Gem](https://img.shields.io/gem/v/frameit.svg?style=flat)](http://rubygems.org/gems/frameit)
 [![Build Status](https://img.shields.io/travis/fastlane/frameit/master.svg?style=flat)](https://travis-ci.org/fastlane/frameit)
 
 ###### Quickly put your screenshots into the right device frames
 
-Get in contact with the developer on Twitter: [@KrauseFx](https://twitter.com/KrauseFx)
+Get in contact with the developer on Twitter: [@FastlaneTools](https://twitter.com/FastlaneTools)
 
 
 -------
@@ -99,7 +99,7 @@ You only have to do this once per computer.
 - Press ```Enter```. The [Apple page](https://developer.apple.com/app-store/marketing/guidelines/#images) to download the images should open in your browser.
 - Download the devices you want to use
 - Press ```Enter```
-- Unzip and move the content of the zip files to ```~/.frameit/device_frames```
+- Unzip and move the content of the zip files to ```~/.frameit/devices_frames```
 - Press ```Enter```
   
 # Usage
@@ -185,6 +185,9 @@ To define the title and optionally the keyword, put two `.strings` files into th
 
 The `keyword.strings` and `title.strings` are standard `.strings` file you already use for your iOS apps, making it easy to use your existing translation service to get localized titles.
 
+**Note:** These `.strings` files **MUST** be utf-16 encoded.  If you are having trouble see [issue #49](https://github.com/fastlane/frameit/issues/49)
+
+
 #### Uploading screenshots to iTC
 
 Use [deliver](https://github.com/fastlane/deliver) to upload all screenshots to iTunes Connect completely automatically :rocket:
@@ -248,7 +251,7 @@ Check out [`snapshot`](https://github.com/fastlane/snapshot) to automatically ge
 
 ## Alternative location to store device_frames
 
-Device frames can also be stored in a ```./fastlane/screenshots/device_frames``` directory if you prefer rather than in the ```~/.frameit/device_frames``` directory. If doing so please be aware that Apple's images are copyrighted and should not be redistributed as part of a repository so you may want to include them in your .gitignore file.
+Device frames can also be stored in a ```./fastlane/screenshots/devices_frames``` directory if you prefer rather than in the ```~/.frameit/device_frames``` directory. If doing so please be aware that Apple's images are copyrighted and should not be redistributed as part of a repository so you may want to include them in your .gitignore file.
 
 ## White background of frames
 
@@ -273,6 +276,9 @@ brew install imagemagick
 # Need help?
 Please submit an issue on GitHub and provide information about your setup
 
+# Code of Conduct
+Help us keep `frameit` open and inclusive. Please read and follow our [Code of Conduct](https://github.com/fastlane/code-of-conduct).
+
 # License
 This project is licensed under the terms of the MIT license. See the LICENSE file.
 

data/bin/frameit

@@ -15,7 +15,7 @@ class FrameItApplication
     program :description, 'Quickly put your screenshots into the right device frames'
     program :help, 'Author', 'Felix Krause <frameit@krausefx.com>'
     program :help, 'Website', 'https://fastlane.tools'
-    program :help, 'GitHub', 'https://github.com/krausefx/frameit'
+    program :help, 'GitHub', 'https://github.com/fastlane/frameit'
     program :help_formatter, :compact
 
     global_option('--verbose') { $verbose = true }

data/lib/frameit.rb

@@ -16,6 +16,7 @@ require 'fastlane_core'
 
 module Frameit
   Helper = FastlaneCore::Helper # you gotta love Ruby: Helper.* should use the Helper class contained in FastlaneCore
+  UI = FastlaneCore::UI
 end
 
 # rubocop:disable all

data/lib/frameit/config_parser.rb

@@ -2,7 +2,7 @@ module Frameit
   class ConfigParser
     def load(path)
       return nil unless File.exist?(path) # we are okay with no config at all
-      Helper.log.info "Parsing config file '#{path}'".yellow if $verbose
+      UI.message "Parsing config file '#{path}'" if $verbose
       @path = path
       self.parse(File.read(path))
     end
@@ -12,8 +12,8 @@ module Frameit
       begin
         @data = JSON.parse(data)
       rescue => ex
-        Helper.log.fatal ex
-        raise "Invalid JSON file at path '#{@path}'. Make sure it's a valid JSON file".red
+        UI.error ex.message
+        UI.user_error! "Invalid JSON file at path '#{@path}'. Make sure it's a valid JSON file"
       end
 
       self
@@ -63,29 +63,29 @@ module Frameit
           validate_values(value) # recursive call
         else
           if key == 'font'
-            raise "Could not find font at path '#{File.expand_path(value)}'" unless File.exist? value
+            UI.user_error! "Could not find font at path '#{File.expand_path(value)}'" unless File.exist? value
           end
 
           if key == 'fonts'
-            raise "`fonts` must be an array" unless value.kind_of? Array
+            UI.user_error! "`fonts` must be an array" unless value.kind_of? Array
 
             value.each do |current|
-              raise "You must specify a font path" if current.fetch('font', '').length == 0
-              raise "Could not find font at path '#{File.expand_path(current.fetch('font'))}'" unless File.exist? current.fetch('font')
-              raise "`supported` must be an array" unless current.fetch('supported', []).kind_of? Array
+              UI.user_error! "You must specify a font path" if current.fetch('font', '').length == 0
+              UI.user_error! "Could not find font at path '#{File.expand_path(current.fetch('font'))}'" unless File.exist? current.fetch('font')
+              UI.user_error! "`supported` must be an array" unless current.fetch('supported', []).kind_of? Array
             end
           end
 
           if key == 'background'
-            raise "Could not find background image at path '#{File.expand_path(value)}'" unless File.exist? value
+            UI.user_error! "Could not find background image at path '#{File.expand_path(value)}'" unless File.exist? value
           end
 
           if key == 'color'
-            raise "Invalid color '#{value}'. Must be valid Hex #123123" unless value.include? "#"
+            UI.user_error! "Invalid color '#{value}'. Must be valid Hex #123123" unless value.include? "#"
           end
 
           if key == 'padding'
-            raise "padding must be type integer or pair of integers of format 'AxB'" unless value.kind_of?(Integer) || value.split('x').length == 2
+            UI.user_error! "padding must be type integer or pair of integers of format 'AxB'" unless value.kind_of?(Integer) || value.split('x').length == 2
           end
         end
       end

data/lib/frameit/dependency_checker.rb

@@ -8,12 +8,12 @@ module Frameit
 
     def self.check_image_magick
       unless `which convert`.include? "convert"
-        Helper.log.fatal '#############################################################'
-        Helper.log.fatal "# You have to install the ImageMagick to use FrameIt"
-        Helper.log.fatal "# Install it using 'brew update && brew install imagemagick'"
-        Helper.log.fatal "# If you don't have homebrew: http://brew.sh"
-        Helper.log.fatal '#############################################################'
-        raise "Install ImageMagick and start frameit again!"
+        UI.error '#############################################################'
+        UI.error "# You have to install the ImageMagick to use FrameIt"
+        UI.error "# Install it using 'brew update && brew install imagemagick'"
+        UI.error "# If you don't have homebrew: http://brew.sh"
+        UI.error '#############################################################'
+        UI.user_error! "Install ImageMagick and start frameit again!"
       end
     end
   end

data/lib/frameit/editor.rb

@@ -39,7 +39,7 @@ module Frameit
       output_path = screenshot.path.gsub('.png', '_framed.png').gsub('.PNG', '_framed.png')
       image.format "png"
       image.write output_path
-      Helper.log.info "Added frame: '#{File.expand_path(output_path)}'".green
+      UI.success "Added frame: '#{File.expand_path(output_path)}'"
     end
 
     # puts the screenshot into the frame
@@ -58,7 +58,7 @@ module Frameit
       if @offset_information and (@offset_information['offset'] or @offset_information['offset'])
         return @offset_information
       end
-      raise "Could not find offset_information for '#{screenshot}'"
+      UI.user_error! "Could not find offset_information for '#{screenshot}'"
     end
 
     #########################################################################################
@@ -179,7 +179,7 @@ module Frameit
         # too large - resizing now
         smaller = (1.0 / ratio)
 
-        Helper.log.debug "Text for image #{self.screenshot.path} is quite long, reducing font size by #{(ratio - 1.0).round(2)}" if $verbose
+        UI.message "Text for image #{self.screenshot.path} is quite long, reducing font size by #{(ratio - 1.0).round(2)}" if $verbose
 
         title.resize "#{(smaller * title.width).round}x"
         keyword.resize "#{(smaller * keyword.width).round}x" if keyword
@@ -235,8 +235,8 @@ module Frameit
 
         current_font = font(key)
         text = fetch_text(key)
-        Helper.log.debug "Using #{current_font} as font the #{key} of #{screenshot.path}" if $verbose and current_font
-        Helper.log.debug "Adding text '#{text}'" if $verbose
+        UI.message "Using #{current_font} as font the #{key} of #{screenshot.path}" if $verbose and current_font
+        UI.message "Adding text '#{text}'" if $verbose
 
         text.gsub! '\n', "\n"
 
@@ -269,7 +269,7 @@ module Frameit
 
     # Fetches the title + keyword for this particular screenshot
     def fetch_text(type)
-      raise "Valid parameters :keyword, :title" unless [:keyword, :title].include? type
+      UI.user_error! "Valid parameters :keyword, :title" unless [:keyword, :title].include? type
 
       # Try to get it from a keyword.strings or title.strings file
       strings_path = File.join(File.expand_path("..", screenshot.path), "#{type}.strings")
@@ -281,11 +281,11 @@ module Frameit
 
       # No string files, fallback to Framefile config
       result = fetch_config[type.to_s]['text'] if fetch_config[type.to_s]
-      Helper.log.debug "Falling back to default text as there was nothing specified in the .strings file" if $verbose
+      UI.message "Falling back to default text as there was nothing specified in the .strings file" if $verbose
 
       if type == :title and !result
         # title is mandatory
-        raise "Could not get title for screenshot #{screenshot.path}. Please provide one in your Framefile.json".red
+        UI.user_error! "Could not get title for screenshot #{screenshot.path}. Please provide one in your Framefile.json"
       end
 
       return result
@@ -307,13 +307,13 @@ module Frameit
             end
           else
             # No `supported` array, this will always be true
-            Helper.log.debug "Found a font with no list of supported languages, using this now" if $verbose
+            UI.message "Found a font with no list of supported languages, using this now" if $verbose
             return font["font"]
           end
         end
       end
 
-      Helper.log.debug "No custom font specified for #{screenshot}, using the default one" if $verbose
+      UI.message "No custom font specified for #{screenshot}, using the default one" if $verbose
       return nil
     end
   end

data/lib/frameit/frame_converter.rb

@@ -8,34 +8,34 @@ module Frameit
     end
 
     def setup_frames
-      puts "----------------------------------------------------".green
-      puts "Looks like you have no device templates installed".green
-      puts "The images can not be pre-installed due to licensing".green
-      puts "Press Enter to get started".green
-      puts "----------------------------------------------------".green
+      UI.success "----------------------------------------------------"
+      UI.success "Looks like you have no device templates installed"
+      UI.success "The images can not be pre-installed due to licensing"
+      UI.success "Press Enter to get started"
+      UI.success "----------------------------------------------------"
       STDIN.gets
 
       system("open '#{DOWNLOAD_URL}'")
-      puts "----------------------------------------------------".green
-      puts "Download the zip files for the following devices".green
-      puts "iPhone 6s, iPhone 6s Plus, iPhone 5s, iPad mini 4 and iPad Pro".green
-      puts "You only need to download the devices you want to use".green
-      puts "Press Enter when you downloaded the zip files".green
-      puts "----------------------------------------------------".green
+      UI.success "----------------------------------------------------"
+      UI.success "Download the zip files for the following devices"
+      UI.success "iPhone 6s, iPhone 6s Plus, iPhone 5s, iPad mini 4 and iPad Pro"
+      UI.success "You only need to download the devices you want to use"
+      UI.success "Press Enter when you downloaded the zip files"
+      UI.success "----------------------------------------------------"
       STDIN.gets
 
       loop do
         system("mkdir -p '#{templates_path}' && open '#{templates_path}'")
-        puts "----------------------------------------------------".green
-        puts "Extract the downloaded files into the folder".green
-        puts "'#{templates_path}', which should be open in your Finder".green
-        puts "You can just copy the whole content into it.".green
-        puts "Press Enter when you extracted the files into the given folder".green
-        puts "----------------------------------------------------".green
+        UI.success "----------------------------------------------------"
+        UI.success "Extract the downloaded files into the folder"
+        UI.success "'#{templates_path}', which should be open in your Finder"
+        UI.success "You can just copy the whole content into it."
+        UI.success "Press Enter when you extracted the files into the given folder"
+        UI.success "----------------------------------------------------"
         STDIN.gets
 
         if !frames_exist?
-          puts "Sorry, I can't find the PSD files. Make sure you unzipped them into '#{templates_path}'".red
+          UI.error "Sorry, I can't find the PSD files. Make sure you unzipped them into '#{templates_path}'"
         else
           break # everything is finished
         end
@@ -62,7 +62,7 @@ module Frameit
         resulting_path = psd.gsub('.psd', '.png')
         next if File.exist?(resulting_path)
 
-        Helper.log.debug "Converting PSD file '#{psd}'".yellow
+        UI.important "Converting PSD file '#{psd}'"
         image = MiniMagick::Image.open(psd)
         if image
           image.format 'png'
@@ -70,7 +70,7 @@ module Frameit
 
           image.write(resulting_path)
         else
-          Helper.log.error "Could not parse PSD file at path '#{psd}'"
+          UI.error "Could not parse PSD file at path '#{psd}'"
         end
       end
     end

data/lib/frameit/runner.rb

@@ -28,12 +28,12 @@ module Frameit
             screenshot = Screenshot.new(full_path, color)
             screenshot.frame!
           rescue => ex
-            Helper.log.error ex
-            Helper.log.error "Backtrace:\n\t#{ex.backtrace.join("\n\t")}" if $verbose
+            UI.error ex.to_s
+            UI.error "Backtrace:\n\t#{ex.backtrace.join("\n\t")}" if $verbose
           end
         end
       else
-        Helper.log.error "Could not find screenshots"
+        UI.error "Could not find screenshots"
       end
     end
   end

data/lib/frameit/screenshot.rb

@@ -9,7 +9,7 @@ module Frameit
     # path: Path to screenshot
     # color: Color to use for the frame
     def initialize(path, color)
-      raise "Couldn't find file at path '#{path}'".red unless File.exist? path
+      UI.user_error "Couldn't find file at path '#{path}'" unless File.exist? path
       @color = color
       @path = path
       @size = FastImage.size(path)
@@ -36,7 +36,7 @@ module Frameit
       when sizes::MAC
         return 'Mac'
       else
-        Helper.log.error "Unknown device type for size #{@screen_size} for path '#{path}'"
+        UI.error "Unknown device type for size #{@screen_size} for path '#{path}'"
       end
     end
 

data/lib/frameit/strings_parser.rb

@@ -2,15 +2,15 @@ module Frameit
   # This class will parse the .string files
   class StringsParser
     def self.parse(path)
-      raise "Couldn't find strings file at path '#{path}'".red unless File.exist? path
-      raise "Must be .strings file, only got '#{path}'".red unless path.end_with? ".strings"
+      UI.user_error! "Couldn't find strings file at path '#{path}'" unless File.exist? path
+      UI.user_error! "Must be .strings file, only got '#{path}'" unless path.end_with? ".strings"
 
       result = {}
 
       # A .strings file is UTF-16 encoded. We only want to deal with UTF-8
       content = `iconv -f UTF-16 -t UTF-8 '#{path}'`
 
-      content.split("\n").each do |line|
+      content.split("\n").each_with_index do |line, index|
         begin
           # We don't care about comments and empty lines
           if line.start_with? '"'
@@ -20,8 +20,8 @@ module Frameit
             result[key] = value
           end
         rescue => ex
-          Helper.log.error ex
-          Helper.log.error line
+          UI.error "Error parsing #{path} line #{index + 1}: '#{line}'"
+          UI.verbose "#{ex.message}\n#{ex.backtrace.join('\n')}"
         end
       end
 

data/lib/frameit/template_finder.rb

@@ -26,13 +26,13 @@ module Frameit
 
       if templates.count == 0
         if screenshot.screen_size == Deliver::AppScreenshot::ScreenSize::IOS_35
-          Helper.log.warn "Unfortunately 3.5\" device frames were discontinued. Skipping screen '#{screenshot.path}'".yellow
-          Helper.log.debug "Looked for: '#{parts.join(joiner)}.png'".red
+          UI.important "Unfortunately 3.5\" device frames were discontinued. Skipping screen '#{screenshot.path}'"
+          UI.error "Looked for: '#{parts.join(joiner)}.png'"
         else
-          Helper.log.error "Could not find a valid template for screenshot '#{screenshot.path}'".red
-          Helper.log.error "You can download new templates from '#{FrameConverter::DOWNLOAD_URL}'"
-          Helper.log.error "and store them in '#{templates_path}'"
-          Helper.log.error "Missing file: '#{parts.join(joiner)}.png'".red
+          UI.error "Could not find a valid template for screenshot '#{screenshot.path}'"
+          UI.error "You can download new templates from '#{FrameConverter::DOWNLOAD_URL}'"
+          UI.error "and store them in '#{templates_path}'"
+          UI.error "Missing file: '#{parts.join(joiner)}.png'"
         end
         return nil
       else

data/lib/frameit/version.rb

@@ -1,3 +1,3 @@
 module Frameit
-  VERSION = "2.4.1"
+  VERSION = "2.4.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: frameit
 version: !ruby/object:Gem::Version
-  version: 2.4.1
+  version: 2.4.2
 platform: ruby
 authors:
 - Felix Krause
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-15 00:00:00.000000000 Z
+date: 2016-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fastlane_core
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: 0.36.1
     - - "<"
       - !ruby/object:Gem::Version
         version: 1.0.0
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: 0.36.1
     - - "<"
       - !ruby/object:Gem::Version
         version: 1.0.0
@@ -190,14 +190,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.34'
+        version: 0.35.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.34'
+        version: 0.35.1
 description: Quickly put your screenshots into the right device frames
 email:
 - frameit@krausefx.com
@@ -243,7 +243,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.0
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Quickly put your screenshots into the right device frames