frameit 2.5.1 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0386691d3d975aaa1470d94950208b4f086d776b
-  data.tar.gz: a7ae4164557057c19324728f3a0ba5883e81cdac
+  metadata.gz: ca41caa77fe286974535798d0cfd0b7e9d40817f
+  data.tar.gz: b3c561df48818d59d872d441a78794d8c18a69a0
 SHA512:
-  metadata.gz: 9f2afb9854ac5040fb8fec9ade1a5e073d8e002a02be5aa715638a5f2ad4f69e375cad43b77c74cef24c7da8e24f11c2e8d3e316482055e14e466618f163a6e8
-  data.tar.gz: afdb2af3b99176e503fedb2910bccd7a477e6900e8b3e2fbaff64d884792002c303025ec40d9f8d65a1bfb82335627fb871a81044d1cea026966ca1c4a029138
+  metadata.gz: 3239ebd211e9c2c6bc9037cbd780d338b29dad61a63cd3e4a6b203a354fc73d6549a9ae23d62d93e4db9b88a28ccaac8968cc53abcafd42fded6e64e34578ece
+  data.tar.gz: 66b4c0349ae6c2c019ec9981d5593c40a192e1aef344dda7d9b63cd870509ffcdb37abc2f94384d86ab59c1dfb3b26610b315b8da35fbb187336324e95fd4c30

data/README.md

@@ -1,24 +1,24 @@
 <h3 align="center">
-  <a href="https://github.com/fastlane/fastlane">
-    <img src="assets/fastlane.png" width="150" />
+  <a href="https://github.com/fastlane/fastlane/tree/master/fastlane">
+    <img src="../fastlane/assets/fastlane.png" width="150" />
     <br />
     fastlane
   </a>
 </h3>
 <p align="center">
-  <a href="https://github.com/fastlane/deliver">deliver</a> &bull;
-  <a href="https://github.com/fastlane/snapshot">snapshot</a> &bull;
+  <a href="https://github.com/fastlane/fastlane/tree/master/deliver">deliver</a> &bull;
+  <a href="https://github.com/fastlane/fastlane/tree/master/snapshot">snapshot</a> &bull;
   <b>frameit</b> &bull;
-  <a href="https://github.com/fastlane/pem">pem</a> &bull;
-  <a href="https://github.com/fastlane/sigh">sigh</a> &bull;
-  <a href="https://github.com/fastlane/produce">produce</a> &bull;
-  <a href="https://github.com/fastlane/cert">cert</a> &bull;
-  <a href="https://github.com/fastlane/spaceship">spaceship</a> &bull;
-  <a href="https://github.com/fastlane/pilot">pilot</a> &bull;
+  <a href="https://github.com/fastlane/fastlane/tree/master/pem">pem</a> &bull;
+  <a href="https://github.com/fastlane/fastlane/tree/master/sigh">sigh</a> &bull;
+  <a href="https://github.com/fastlane/fastlane/tree/master/produce">produce</a> &bull;
+  <a href="https://github.com/fastlane/fastlane/tree/master/cert">cert</a> &bull;
+  <a href="https://github.com/fastlane/fastlane/tree/master/spaceship">spaceship</a> &bull;
+  <a href="https://github.com/fastlane/fastlane/tree/master/pilot">pilot</a> &bull;
   <a href="https://github.com/fastlane/boarding">boarding</a> &bull;
-  <a href="https://github.com/fastlane/gym">gym</a> &bull;
-  <a href="https://github.com/fastlane/scan">scan</a> &bull;
-  <a href="https://github.com/fastlane/match">match</a>
+  <a href="https://github.com/fastlane/fastlane/tree/master/gym">gym</a> &bull;
+  <a href="https://github.com/fastlane/fastlane/tree/master/scan">scan</a> &bull;
+  <a href="https://github.com/fastlane/fastlane/tree/master/match">match</a>
 </p>
 -------
 
@@ -30,9 +30,9 @@ frameit
 ============
 
 [![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)
+[![License](https://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://github.com/fastlane/fastlane/blob/master/frameit/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)
+[![Build Status](https://img.shields.io/circleci/project/fastlane/fastlane/master.svg?style=flat)](https://circleci.com/gh/fastlane/fastlane)
 
 ###### Quickly put your screenshots into the right device frames
 
@@ -122,7 +122,7 @@ When using `frameit` without titles on top, the screenshots will have the full r
 
 # Titles and Background (optional)
 
-With `frameit` 2.0 you are now able to add a custom background, title and text colors to your screenshots. Optionally you can also set a custom font size.
+With `frameit` 2.0 you are now able to add a custom background, title and text colors to your screenshots.
 
 A working example can be found in the [fastlane examples](https://github.com/fastlane/examples/tree/master/MindNode/screenshots) project.
 
@@ -185,12 +185,12 @@ 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 (UTF-16 LE with BOM).  They also must begin with an empty line. If you are having trouble see [issue #49](https://github.com/fastlane/frameit/issues/49)
+**Note:** These `.strings` files **MUST** be utf-16 encoded (UTF-16 LE with BOM).  They also must begin with an empty line. If you are having trouble see [issue #1740](https://github.com/fastlane/fastlane/issues/1740)
 
 
 #### Uploading screenshots to iTC
 
-Use [deliver](https://github.com/fastlane/deliver) to upload all screenshots to iTunes Connect completely automatically :rocket:
+Use [deliver](https://github.com/fastlane/fastlane/tree/master/deliver) to upload all screenshots to iTunes Connect completely automatically :rocket:
 
 ### Mac
 
@@ -231,23 +231,23 @@ Check out the [MindNode example project](https://github.com/fastlane/examples/tr
 ## [`fastlane`](https://fastlane.tools) Toolchain
 
 - [`fastlane`](https://fastlane.tools): Connect all deployment tools into one streamlined workflow
-- [`deliver`](https://github.com/fastlane/deliver): Upload screenshots, metadata and your app to the App Store
-- [`snapshot`](https://github.com/fastlane/snapshot): Automate taking localized screenshots of your iOS app on every device
-- [`pem`](https://github.com/fastlane/pem): Automatically generate and renew your push notification profiles
-- [`sigh`](https://github.com/fastlane/sigh): Because you would rather spend your time building stuff than fighting provisioning
-- [`produce`](https://github.com/fastlane/produce): Create new iOS apps on iTunes Connect and Dev Portal using the command line
-- [`cert`](https://github.com/fastlane/cert): Automatically create and maintain iOS code signing certificates
-- [`spaceship`](https://github.com/fastlane/spaceship): Ruby library to access the Apple Dev Center and iTunes Connect
-- [`pilot`](https://github.com/fastlane/pilot): The best way to manage your TestFlight testers and builds from your terminal
+- [`deliver`](https://github.com/fastlane/fastlane/tree/master/deliver): Upload screenshots, metadata and your app to the App Store
+- [`snapshot`](https://github.com/fastlane/fastlane/tree/master/snapshot): Automate taking localized screenshots of your iOS app on every device
+- [`pem`](https://github.com/fastlane/fastlane/tree/master/pem): Automatically generate and renew your push notification profiles
+- [`sigh`](https://github.com/fastlane/fastlane/tree/master/sigh): Because you would rather spend your time building stuff than fighting provisioning
+- [`produce`](https://github.com/fastlane/fastlane/tree/master/produce): Create new iOS apps on iTunes Connect and Dev Portal using the command line
+- [`cert`](https://github.com/fastlane/fastlane/tree/master/cert): Automatically create and maintain iOS code signing certificates
+- [`spaceship`](https://github.com/fastlane/fastlane/tree/master/spaceship): Ruby library to access the Apple Dev Center and iTunes Connect
+- [`pilot`](https://github.com/fastlane/fastlane/tree/master/pilot): The best way to manage your TestFlight testers and builds from your terminal
 - [`boarding`](https://github.com/fastlane/boarding): The easiest way to invite your TestFlight beta testers
-- [`gym`](https://github.com/fastlane/gym): Building your iOS apps has never been easier
-- [`scan`](https://github.com/fastlane/scan): The easiest way to run tests of your iOS and Mac app
-- [`match`](https://github.com/fastlane/match): Easily sync your certificates and profiles across your team using git
+- [`gym`](https://github.com/fastlane/fastlane/tree/master/gym): Building your iOS apps has never been easier
+- [`scan`](https://github.com/fastlane/fastlane/tree/master/scan): The easiest way to run tests of your iOS and Mac app
+- [`match`](https://github.com/fastlane/fastlane/tree/master/match): Easily sync your certificates and profiles across your team using git
 
 ##### [Like this tool? Be the first to know about updates and new fastlane tools](https://tinyletter.com/krausefx)
 
 ## Generate localized screenshots
-Check out [`snapshot`](https://github.com/fastlane/snapshot) to automatically generate screenshots using ```UI Automation```.
+Check out [`snapshot`](https://github.com/fastlane/fastlane/tree/master/snapshot) to automatically generate screenshots using ```UI Automation```.
 
 ## Alternative location to store device_frames
 
@@ -277,7 +277,7 @@ brew install imagemagick
 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).
+Help us keep `frameit` open and inclusive. Please read and follow our [Code of Conduct](https://github.com/fastlane/fastlane/blob/master/CODE_OF_CONDUCT.md).
 
 # License
 This project is licensed under the terms of the MIT license. See the LICENSE file.

data/bin/frameit

@@ -19,6 +19,7 @@ class FrameItApplication
     program :help_formatter, :compact
 
     global_option('--verbose') { $verbose = true }
+    FastlaneCore::CommanderGenerator.new.generate(Frameit::Options.available_options)
 
     default_command :black
 
@@ -27,6 +28,7 @@ class FrameItApplication
       c.description = "Adds a black frame around all screenshots."
 
       c.action do |args, options|
+        load_config(options)
         Frameit::Runner.new.run('.', Frameit::Color::BLACK)
       end
     end
@@ -36,6 +38,7 @@ class FrameItApplication
       c.description = "Adds a silver frame around all screenshots."
 
       c.action do |args, options|
+        load_config(options)
         Frameit::Runner.new.run('.', Frameit::Color::SILVER)
       end
     end
@@ -53,6 +56,14 @@ class FrameItApplication
 
     run!
   end
+
+  private
+
+  def load_config(options)
+    o = options.__hash__.dup
+    o.delete(:verbose)
+    Frameit.config = FastlaneCore::Configuration.create(Frameit::Options.available_options, o)
+  end
 end
 
 begin

data/lib/frameit.rb

@@ -11,10 +11,15 @@ require 'frameit/template_finder'
 require 'frameit/strings_parser'
 require 'frameit/mac_editor'
 require 'frameit/dependency_checker'
+require 'frameit/options'
 
 require 'fastlane_core'
 
 module Frameit
+  class << self
+    attr_accessor :config
+  end
+
   Helper = FastlaneCore::Helper # you gotta love Ruby: Helper.* should use the Helper class contained in FastlaneCore
   UI = FastlaneCore::UI
 end

data/lib/frameit/frame_converter.rb

@@ -9,7 +9,7 @@ module Frameit
 
     def setup_frames
       UI.success "----------------------------------------------------"
-      UI.success "Looks like you have no device templates installed"
+      UI.success "Looks like you'd like to install new device templates"
       UI.success "The images can not be pre-installed due to licensing"
       UI.success "Press Enter to get started"
       UI.success "----------------------------------------------------"
@@ -18,7 +18,7 @@ module Frameit
       system("open '#{DOWNLOAD_URL}'")
       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 "iPhone 6s, iPhone 6s Plus, iPhone SE, 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 "----------------------------------------------------"
@@ -64,6 +64,27 @@ module Frameit
 
         UI.important "Converting PSD file '#{psd}'"
         image = MiniMagick::Image.open(psd)
+
+        if psd =~ /iPhone-SE/
+          UI.success "Removing white background 🚫 ⬜️"
+
+          # The iPhone-SE screenshots from April 2016 have
+          # 3 layers, a background, a product, and the 'put your image here' layer
+          # imagemagick seems to add an additional layer with no label which this the
+          # composite of all three.  We want to remove the background and composite layer
+          good_layers = image.layers.reject do |layer|
+            label = layer.details['Properties']['label']
+            label.to_s.length == 0 || label =~ /White B/i
+          end
+          product_layer = good_layers.shift
+
+          good_layers.each do |layer|
+            product_layer.layers << layer
+          end
+
+          image = product_layer
+        end
+
         if image
           image.format 'png'
           image.trim

data/lib/frameit/offsets.rb

@@ -19,10 +19,17 @@ module Frameit
             'width' => 530
           }
         when size::IOS_40
-          return {
-            'offset' => "+54+197",
-            'width' => 544
-          }
+          if Frameit.config[:use_legacy_iphone5s]
+            return {
+              'offset' => "+54+197",
+              'width' => 544
+            }
+          else
+            return {
+             'offset' => "+48+178",
+             'width' => 485
+            }
+          end
         when size::IOS_35
           return {
             'offset' => "+59+260",
@@ -52,10 +59,17 @@ module Frameit
             'width' => 946
           }
         when size::IOS_40
-          return {
-            'offset' => "+201+48",
-            'width' => 970
-          }
+          if Frameit.config[:use_legacy_iphone5s]
+            return {
+              'offset' => "+201+48",
+              'width' => 970
+            }
+          else
+            return {
+              'offset' => "+177+41",
+              'width' => 859
+            }
+          end
         when size::IOS_35
           return {
             'offset' => "+258+52",

data/lib/frameit/options.rb

@@ -0,0 +1,14 @@
+module Frameit
+  class Options
+    def self.available_options
+      @options ||= [
+        FastlaneCore::ConfigItem.new(key: :use_legacy_iphone5s,
+                                     env_name: "FRAMEIT_USE_LEGACY_IPHONE_5_S",
+                                     optional: true,
+                                     is_string: false,
+                                     description: "use iPhone 5s instead of iPhone SE frames",
+                                     default_value: false)
+      ]
+    end
+  end
+end

data/lib/frameit/screenshot.rb

@@ -26,7 +26,7 @@ module Frameit
       when sizes::IOS_47
         return 'iPhone-6s'
       when sizes::IOS_40
-        return 'iPhone_5s'
+        return Frameit.config[:use_legacy_iphone5s] ? 'iPhone_5s' : 'iPhone-SE'
       when sizes::IOS_35
         return 'iPhone_4'
       when sizes::IOS_IPAD

data/lib/frameit/template_finder.rb

@@ -1,38 +1,84 @@
 module Frameit
   # Responsible for finding the correct device
   class TemplateFinder
+
+    class FilenameTransform
+      def initialize(device_name)
+        @device_name = device_name
+      end
+    end
+
+    # Example: iPhone_5s_Vert_SpaceGray_sRGB
+    class Type1Transform < FilenameTransform
+      def transform(color, orientation)
+        # Note the * on the end to handle the _sRGB part
+        "#{@device_name}_#{orientation}_#{color}*"
+      end
+    end
+
+    # Example: iPad-Pro-Space-Gray-vertical.png
+    class Type2Transform < FilenameTransform
+      def transform(color, orientation)
+        fixed_color = color == 'SpaceGray' ? "Space-Gray" : "Silver"
+        fixed_orientation = orientation == 'Horz' ? 'horizontal' : 'vertical'
+        "#{@device_name}-#{fixed_color}-#{fixed_orientation}"
+      end
+    end
+
+    # Example: iPhone-SE-Space-Gray
+    # Note that 'vertical' is implied
+    class Type3Transform < FilenameTransform
+      def transform(color, orientation)
+        fixed_color = color == 'SpaceGray' ? "Space-Gray" : "Silver"
+        filename = "#{@device_name}-#{fixed_color}"
+        if orientation == 'Horz'
+          "#{filename}-horizontal"
+        else
+          filename
+        end
+      end
+    end
+
+    DEVICE_TO_TRANSFORM_TYPE = {
+      'iPhone-SE' => Type3Transform.new('iPhone-SE'),
+      'iPad-Pro' => Type2Transform.new('iPad-Pro'),
+      'iPad-mini' => Type2Transform.new('iPad-mini'),
+      'iPhone-6s' => Type2Transform.new('iPhone-6s'),
+      'iPhone-6s-Plus' => Type2Transform.new('iPhone-6s-Plus')
+    }
+
     # This will detect the screen size and choose the correct template
     def self.get_template(screenshot)
       return nil if screenshot.mac?
-      parts = [
-        screenshot.device_name,
-        screenshot.orientation_name,
-        screenshot.color
-      ]
-      joiner = "_"
-
-      if screenshot.device_name.include?('iPad') || screenshot.device_name.include?('6s')
-        parts = [
-          screenshot.device_name,
-          (screenshot.color == 'SpaceGray' ? "Space-Gray" : "Silver"),
-          (screenshot.orientation_name == "Horz" ? "horizontal" : "vertical")
-        ]
-        joiner = "-"
-      end
+
+      transformer = DEVICE_TO_TRANSFORM_TYPE[screenshot.device_name]
+
+      # The "original" pattern is the type 1 transform
+      # so if we don't have something more specific, go for that
+      transformer ||= Type1Transform.new(screenshot.device_name)
+      filename = transformer.transform(screenshot.color, screenshot.orientation_name)
 
       templates_path = [ENV['HOME'], FrameConverter::FRAME_PATH].join('/')
-      templates = Dir["../**/#{parts.join(joiner)}*.{png,jpg}"] # local directory
-      templates += Dir["#{templates_path}/**/#{parts.join(joiner)}*.{png,jpg}"] # ~/.frameit folder
+      templates = Dir["../**/#{filename}.{png,jpg}"] # local directory
+      templates += Dir["#{templates_path}/**/#{filename}.{png,jpg}"] # ~/.frameit folder
+
+      UI.verbose "Looking for #{filename} and found #{templates.count}"
 
       if templates.count == 0
         if screenshot.screen_size == Deliver::AppScreenshot::ScreenSize::IOS_35
           UI.important "Unfortunately 3.5\" device frames were discontinued. Skipping screen '#{screenshot.path}'"
-          UI.error "Looked for: '#{parts.join(joiner)}.png'"
+          UI.error "Looked for: '#{filename}.png'"
+        elsif screenshot.device_name == 'iPhone-SE'
+          UI.error "By default frameit uses the iPhone SE for screenshots"
+          UI.error "Unable to find a frame #{filename}.png"
+          UI.error "You can download iPhone-SE templates from '#{FrameConverter::DOWNLOAD_URL}'"
+          UI.error "and store them in '#{templates_path}'"
+          UI.error "\nIf you'd prefer to use the old iPhone 5s templates, add the option --use_legacy_iphone5s"
         else
           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'"
+          UI.error "Missing file: '#{filename}.png'"
         end
         return nil
       else

data/lib/frameit/version.rb

@@ -1,3 +1,3 @@
 module Frameit
-  VERSION = "2.5.1"
+  VERSION = "2.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: frameit
 version: !ruby/object:Gem::Version
-  version: 2.5.1
+  version: 2.6.0
 platform: ruby
 authors:
 - Felix Krause
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-03 00:00:00.000000000 Z
+date: 2016-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fastlane_core
@@ -114,6 +114,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.3
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -190,14 +204,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.35.1
+        version: 0.38.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.35.1
+        version: 0.38.0
 description: Quickly put your screenshots into the right device frames
 email:
 - frameit@krausefx.com
@@ -218,6 +232,7 @@ files:
 - lib/frameit/frame_converter.rb
 - lib/frameit/mac_editor.rb
 - lib/frameit/offsets.rb
+- lib/frameit/options.rb
 - lib/frameit/runner.rb
 - lib/frameit/screenshot.rb
 - lib/frameit/strings_parser.rb
@@ -243,7 +258,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.6.2
 signing_key: 
 specification_version: 4
 summary: Quickly put your screenshots into the right device frames