fastlane 2.141.0 → 2.146.0

data/frameit/lib/frameit/editor.rb

@@ -18,8 +18,9 @@ module Frameit
     attr_accessor :image # the current image used for editing
     attr_accessor :space_to_device
 
-    def initialize(screenshot, debug_mode = false)
+    def initialize(screenshot, config, debug_mode = false)
       @screenshot = screenshot
+      @config = config
       self.debug_mode = debug_mode
     end
 
@@ -121,7 +122,7 @@ module Frameit
     def offset
       return @offset_information if @offset_information
 
-      @offset_information = fetch_config['offset'] || Offsets.image_offset(screenshot).dup
+      @offset_information = @config['offset'] || Offsets.image_offset(screenshot).dup
 
       if @offset_information && (@offset_information['offset'] || @offset_information['offset'])
         return @offset_information
@@ -148,7 +149,7 @@ module Frameit
 
     # Do we add a background and title as well?
     def is_complex_framing_mode?
-      return (fetch_config['background'] and (fetch_config['title'] or fetch_config['keyword']))
+      return (@config['background'] and (@config['title'] or @config['keyword']))
     end
 
     # more complex mode: background, frame and title
@@ -157,8 +158,8 @@ module Frameit
 
       self.space_to_device = vertical_frame_padding
 
-      if fetch_config['title']
-        background = put_title_into_background(background, fetch_config['stack_title'])
+      if @config['title']
+        background = put_title_into_background(background, @config['stack_title'])
       end
 
       if self.frame # we have no frame on le mac
@@ -169,7 +170,7 @@ module Frameit
         frame_width = background.width - horizontal_frame_padding * 2
         frame_height = background.height - effective_text_height - vertical_frame_padding
 
-        if fetch_config['show_complete_frame']
+        if @config['show_complete_frame']
           # calculate the final size of the screenshot to resize in one go
           # it may be limited either by the width or height of the frame
           image_aspect_ratio = @image.width.to_f / @image.height.to_f
@@ -191,7 +192,7 @@ module Frameit
 
     # Horizontal adding around the frames
     def horizontal_frame_padding
-      padding = fetch_config['padding']
+      padding = @config['padding']
       if padding.kind_of?(String) && padding.split('x').length == 2
         padding = padding.split('x')[0]
         padding = padding.to_i unless padding.end_with?('%')
@@ -201,7 +202,7 @@ module Frameit
 
     # Vertical adding around the frames
     def vertical_frame_padding
-      padding = fetch_config['padding']
+      padding = @config['padding']
       if padding.kind_of?(String) && padding.split('x').length == 2
         padding = padding.split('x')[1]
         padding = padding.to_i unless padding.end_with?('%')
@@ -212,7 +213,7 @@ module Frameit
     # Minimum height for the title
     def title_min_height
       @title_min_height ||= begin
-        height = fetch_config['title_min_height'] || 0
+        height = @config['title_min_height'] || 0
         if height.kind_of?(String) && height.end_with?('%')
           height = ([image.width, image.height].min * height.to_f * 0.01).ceil
         end
@@ -244,12 +245,12 @@ module Frameit
     end
 
     def title_below_image
-      @title_below_image ||= fetch_config['title_below_image']
+      @title_below_image ||= @config['title_below_image']
     end
 
     # Returns a correctly sized background image
     def generate_background
-      background = MiniMagick::Image.open(fetch_config['background'])
+      background = MiniMagick::Image.open(@config['background'])
 
       if background.height != screenshot.size[1]
         background.resize("#{screenshot.size[0]}x#{screenshot.size[1]}^") # `^` says it should fill area
@@ -338,12 +339,12 @@ module Frameit
       sum_width = title.width
       sum_width += keyword.width + keyword_padding if keyword
 
-      title_below_image = fetch_config['title_below_image']
+      title_below_image = @config['title_below_image']
 
       # Resize the 2 labels if they exceed the available space either horizontally or vertically:
       image_scale_factor = 1.0 # default
       ratio_horizontal = sum_width / (image.width.to_f - horizontal_frame_padding * 2) # The fraction of the text images compared to the left and right padding
-      ratio_vertical = title.height.to_f / actual_font_size # The fraction of the actual height of the images compared to the available space
+      ratio_vertical = title.height.to_f / effective_text_height # The fraction of the actual height of the images compared to the available space
       if ratio_horizontal > 1.0 || ratio_vertical > 1.0
         # If either is too large, resize with the maximum ratio:
         image_scale_factor = (1.0 / [ratio_horizontal, ratio_vertical].max)
@@ -385,7 +386,7 @@ module Frameit
     end
 
     def actual_font_size
-      font_scale_factor = fetch_config['font_scale_factor'] || 0.1
+      font_scale_factor = @config['font_scale_factor'] || 0.1
       UI.user_error!("Parameter 'font_scale_factor' can not be 0. Please provide a value larger than 0.0 (default = 0.1).") if font_scale_factor == 0.0
       [@image.width * font_scale_factor].max.round
     end
@@ -420,7 +421,7 @@ module Frameit
         text.gsub!('\n', "\n")
         text.gsub!(/(?<!\\)(')/) { |s| "\\#{s}" } # escape unescaped apostrophes with a backslash
 
-        interline_spacing = fetch_config['interline_spacing']
+        interline_spacing = @config['interline_spacing']
 
         # Add the actual title
         text_image.combine_options do |i|
@@ -429,7 +430,7 @@ module Frameit
           i.pointsize(actual_font_size)
           i.draw("text 0,0 '#{text}'")
           i.interline_spacing(interline_spacing) if interline_spacing
-          i.fill(fetch_config[key.to_s]['color'])
+          i.fill(@config[key.to_s]['color'])
         end
 
         results[key] = text_image
@@ -491,18 +492,6 @@ module Frameit
       results
     end
 
-    # Loads the config (colors, background, texts, etc.)
-    # Don't use this method to access the actual text and use `fetch_texts` instead
-    def fetch_config
-      return @config if @config
-
-      config_path = File.join(File.expand_path("..", screenshot.path), "Framefile.json")
-      config_path = File.join(File.expand_path("../..", screenshot.path), "Framefile.json") unless File.exist?(config_path)
-      file = ConfigParser.new.load(config_path)
-      return {} unless file # no config file at all
-      @config = file.fetch_value(screenshot.path)
-    end
-
     # Fetches the title + keyword for this particular screenshot
     def fetch_text(type)
       UI.user_error!("Valid parameters :keyword, :title") unless [:keyword, :title].include?(type)
@@ -518,20 +507,19 @@ module Frameit
       UI.verbose("Falling back to text in Framefile.json as there was nothing specified in the #{type}.strings file")
 
       # No string files, fallback to Framefile config
-      text = fetch_config[type.to_s]['text'] if fetch_config[type.to_s] && fetch_config[type.to_s]['text'] && fetch_config[type.to_s]['text'].length > 0 # Ignore empty string
+      text = @config[type.to_s]['text'] if @config[type.to_s] && @config[type.to_s]['text'] && @config[type.to_s]['text'].length > 0 # Ignore empty string
       return text
     end
 
     def fetch_frame_color
-      color = fetch_config['frame']
-      if color == "BLACK"
-        return Frameit::Color::BLACK
-      elsif color == "WHITE"
-        return Frameit::Color::SILVER
-      elsif color == "GOLD"
-        return Frameit::Color::GOLD
-      elsif color == "ROSE_GOLD"
-        return Frameit::Color::ROSE_GOLD
+      color = @config['frame']
+      unless color.nil?
+        Frameit::Color.constants.each do |c|
+          constant = Frameit::Color.const_get(c)
+          if color == constant.upcase.gsub(' ', '_')
+            return constant
+          end
+        end
       end
 
       return nil
@@ -539,15 +527,15 @@ module Frameit
 
     # The font we want to use
     def font(key)
-      single_font = fetch_config[key.to_s]['font']
+      single_font = @config[key.to_s]['font']
       return single_font if single_font
 
-      fonts = fetch_config[key.to_s]['fonts']
+      fonts = @config[key.to_s]['fonts']
       if fonts
         fonts.each do |font|
           if font['supported']
             font['supported'].each do |language|
-              if screenshot.path.include?(language)
+              if screenshot.language == language
                 return font["font"]
               end
             end

data/frameit/lib/frameit/offsets.rb

@@ -13,9 +13,16 @@ module Frameit
         @offsets_cache = JSON.parse(File.read(offsets_json_path))
       end
 
-      offset_value = @offsets_cache["portrait"][screenshot.device_name]
+      offset_value = @offsets_cache["portrait"][sanitize_device_name(screenshot.device_name)]
       UI.error("Tried looking for offset information for 'portrait', #{screenshot.device_name} in '#{offsets_json_path}'") unless offset_value
       return offset_value
     end
+
+    def self.sanitize_device_name(basename)
+      # this should be the same as frames_generator's sanitize_device_name (except stripping colors):
+      basename = basename.gsub("Apple", "")
+      basename = basename.gsub("-", " ")
+      basename.strip.to_s
+    end
   end
 end

data/frameit/lib/frameit/options.rb

@@ -1,6 +1,8 @@
 require 'fastlane_core/configuration/config_item'
 
 require_relative 'module'
+require_relative 'config_parser'
+require_relative 'device_types'
 
 module Frameit
   class Options
@@ -8,74 +10,99 @@ module Frameit
       @options ||= [
 
         FastlaneCore::ConfigItem.new(key: :white,
-                                     env_name: "FRAMEIT_WHITE_FRAME",
-                                     description: "Use white device frames",
-                                     type: Boolean,
-                                     optional: true),
+                                       env_name: "FRAMEIT_WHITE_FRAME",
+                                       description: "Use white device frames",
+                                       type: Boolean,
+                                       optional: true),
         FastlaneCore::ConfigItem.new(key: :silver,
-                                     env_name: "FRAMEIT_SILVER_FRAME",
-                                     description: "Use white device frames. Alias for :white",
-                                     type: Boolean,
-                                     optional: true),
+                                       env_name: "FRAMEIT_SILVER_FRAME",
+                                       description: "Use white device frames. Alias for :white",
+                                       type: Boolean,
+                                       optional: true),
         FastlaneCore::ConfigItem.new(key: :rose_gold,
-                                     env_name: "FRAMEIT_ROSE_GOLD_FRAME",
-                                     description: "Use rose gold device frames. Alias for :rose_gold",
-                                     type: Boolean,
-                                     optional: true),
+                                       env_name: "FRAMEIT_ROSE_GOLD_FRAME",
+                                       description: "Use rose gold device frames. Alias for :rose_gold",
+                                       type: Boolean,
+                                       optional: true),
         FastlaneCore::ConfigItem.new(key: :gold,
-                                     env_name: "FRAMEIT_GOLD_FRAME",
-                                     description: "Use gold device frames. Alias for :gold",
-                                     type: Boolean,
-                                     optional: true),
+                                       env_name: "FRAMEIT_GOLD_FRAME",
+                                       description: "Use gold device frames. Alias for :gold",
+                                       type: Boolean,
+                                       optional: true),
         FastlaneCore::ConfigItem.new(key: :force_device_type,
-                                     env_name: "FRAMEIT_FORCE_DEVICE_TYPE",
-                                     description: "Forces a given device type, useful for Mac screenshots, as their sizes vary",
-                                     optional: true,
-                                     verify_block: proc do |value|
-                                       available = ['iPhone_6_Plus', 'iPhone_5s', 'iPhone_4', 'iPad_mini', 'Mac']
-                                       unless available.include?(value)
-                                         UI.user_error!("Invalid device type '#{value}'. Available values: #{available}")
-                                       end
-                                     end),
+                                       env_name: "FRAMEIT_FORCE_DEVICE_TYPE",
+                                       description: "Forces a given device type, useful for Mac screenshots, as their sizes vary",
+                                       optional: true,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Invalid device type '#{value}'. Available values: " + Devices.all_device_names_without_apple.join(', ')) unless ConfigParser.supported_device?(value)
+                                       end),
         FastlaneCore::ConfigItem.new(key: :use_legacy_iphone5s,
-                                     env_name: "FRAMEIT_USE_LEGACY_IPHONE_5_S",
-                                     description: "Use iPhone 5s instead of iPhone SE frames",
+                                       env_name: "FRAMEIT_USE_LEGACY_IPHONE_5_S",
+                                       description: "Use iPhone 5s instead of iPhone SE frames",
+                                       default_value: false,
+                                       type: Boolean),
+        FastlaneCore::ConfigItem.new(key: :use_legacy_iphone6s,
+                                       env_name: "FRAMEIT_USE_LEGACY_IPHONE_6_S",
+                                       description: "Use iPhone 6s frames instead of iPhone 7 frames",
+                                       default_value: false,
+                                       type: Boolean),
+        FastlaneCore::ConfigItem.new(key: :use_legacy_iphone7,
+                                       env_name: "FRAMEIT_USE_LEGACY_IPHONE_7",
+                                       description: "Use iPhone 7 frames instead of iPhone 8 frames",
+                                       default_value: false,
+                                       type: Boolean),
+        FastlaneCore::ConfigItem.new(key: :use_legacy_iphonex,
+                                       env_name: "FRAMEIT_USE_LEGACY_IPHONE_X",
+                                       description: "Use iPhone X instead of iPhone XS frames",
+                                       default_value: false,
+                                       type: Boolean),
+        FastlaneCore::ConfigItem.new(key: :use_legacy_iphonexr,
+                                     env_name: "FRAMEIT_USE_LEGACY_IPHONE_XR",
+                                     description: "Use iPhone XR instead of iPhone 11 frames",
                                      default_value: false,
                                      type: Boolean),
-        FastlaneCore::ConfigItem.new(key: :use_legacy_iphone6s,
-                                     env_name: "FRAMEIT_USE_LEGACY_IPHONE_6_S",
-                                     description: "Use iPhone 6s frames instead of iPhone 7 frames",
+        FastlaneCore::ConfigItem.new(key: :use_legacy_iphonexs,
+                                     env_name: "FRAMEIT_USE_LEGACY_IPHONE_XS",
+                                     description: "Use iPhone XS instead of iPhone 11 Pro frames",
                                      default_value: false,
                                      type: Boolean),
-        FastlaneCore::ConfigItem.new(key: :use_legacy_iphonex,
-                                     env_name: "FRAMEIT_USE_LEGACY_IPHONE_X",
-                                     description: "Use iPhone X instead of iPhone XS frames",
+        FastlaneCore::ConfigItem.new(key: :use_legacy_iphonexsmax,
+                                     env_name: "FRAMEIT_USE_LEGACY_IPHONE_XS_MAX",
+                                     description: "Use iPhone XS Max instead of iPhone 11 Pro Max frames",
                                      default_value: false,
                                      type: Boolean),
         FastlaneCore::ConfigItem.new(key: :force_orientation_block,
-                                     type: :string_callback,
-                                     description: "[Advanced] A block to customize your screenshots' device orientation",
-                                     display_in_shell: false,
-                                     optional: true,
-                                     default_value: proc do |filename|
-                                       f = filename.downcase
-                                       if f.end_with?("force_landscapeleft")
-                                         :landscape_left
-                                       elsif f.end_with?("force_landscaperight")
-                                         :landscape_right
-                                       end
-                                     end,
-                                     default_value_dynamic: true),
+                                       type: :string_callback,
+                                       description: "[Advanced] A block to customize your screenshots' device orientation",
+                                       display_in_shell: false,
+                                       optional: true,
+                                       default_value: proc do |filename|
+                                         f = filename.downcase
+                                         if f.end_with?("force_landscapeleft")
+                                           :landscape_left
+                                         elsif f.end_with?("force_landscaperight")
+                                           :landscape_right
+                                         end
+                                       end,
+                                       default_value_dynamic: true),
         FastlaneCore::ConfigItem.new(key: :debug_mode,
-                                     env_name: "FRAMEIT_DEBUG_MODE",
-                                     description: "Output debug information in framed screenshots",
-                                     default_value: false,
-                                     type: Boolean),
+                                       env_name: "FRAMEIT_DEBUG_MODE",
+                                       description: "Output debug information in framed screenshots",
+                                       default_value: false,
+                                       type: Boolean),
         FastlaneCore::ConfigItem.new(key: :resume,
-                                     env_name: "FRAMEIT_RESUME",
-                                     description: "Resume frameit instead of reprocessing all screenshots",
-                                     default_value: false,
-                                     type: Boolean)
+                                       env_name: "FRAMEIT_RESUME",
+                                       description: "Resume frameit instead of reprocessing all screenshots",
+                                       default_value: false,
+                                       type: Boolean),
+        FastlaneCore::ConfigItem.new(key: :use_platform,
+                                       env_name: "FRAMEIT_USE_PLATFORM",
+                                       description: "Choose a platform, the valid options are IOS, ANDROID and ANY (IOS is default to ensure backward compatibility)",
+                                       optional: true,
+                                       default_value: Platform::IOS,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Invalid platform type '#{value}'. Available values are " + Platform.all_platforms.join(', ') + ".") unless ConfigParser.supported_platform?(value)
+                                       end)
       ]
     end
   end

data/frameit/lib/frameit/runner.rb

@@ -14,9 +14,8 @@ module Frameit
       end
     end
 
-    def run(path, color = nil)
+    def run(path, color = nil, platform = nil)
       unless color
-        color = Frameit::Color::BLACK
         color = Frameit::Color::SILVER if Frameit.config[:white] || Frameit.config[:silver]
         color = Frameit::Color::GOLD if Frameit.config[:gold]
         color = Frameit::Color::ROSE_GOLD if Frameit.config[:rose_gold]
@@ -29,11 +28,12 @@ module Frameit
           next if skip_path?(full_path)
 
           begin
-            screenshot = Screenshot.new(full_path, color)
+            config = create_config(full_path)
+            screenshot = Screenshot.new(full_path, color, config, platform)
 
             next if skip_up_to_date?(screenshot)
 
-            editor = editor(screenshot)
+            editor = editor(screenshot, config)
 
             if editor.should_skip?
               UI.message("Skipping framing of screenshot #{screenshot.path}.  No title provided in your Framefile.json or title.strings.")
@@ -71,12 +71,22 @@ module Frameit
       false
     end
 
-    def editor(screenshot)
+    def editor(screenshot, config)
       if screenshot.mac?
-        return MacEditor.new(screenshot)
+        return MacEditor.new(screenshot, config)
       else
-        return Editor.new(screenshot, Frameit.config[:debug_mode])
+        return Editor.new(screenshot, config, Frameit.config[:debug_mode])
       end
     end
+
+    # Loads the config (colors, background, texts, etc.)
+    # Don't use this method to access the actual text and use `fetch_texts` instead
+    def create_config(screenshot_path)
+      config_path = File.join(File.expand_path("..", screenshot_path), "Framefile.json")
+      config_path = File.join(File.expand_path("../..", screenshot_path), "Framefile.json") unless File.exist?(config_path)
+      file = ConfigParser.new.load(config_path)
+      return {} unless file # no config file at all
+      file.fetch_value(screenshot_path)
+    end
   end
 end

data/frameit/lib/frameit/screenshot.rb

@@ -1,87 +1,75 @@
-require 'deliver/app_screenshot'
-
 require_relative 'editor'
 require_relative 'mac_editor'
 require_relative 'device_types'
 require_relative 'module'
+require_relative 'device'
 
 module Frameit
   # Represents one screenshot
   class Screenshot
     attr_accessor :path # path to the screenshot
     attr_accessor :size # size in px array of 2 elements: height and width
-    attr_accessor :screen_size # deliver screen size type, is unique per device type, used in device_name
+    attr_accessor :device # device detected according to resolution, priority and settings
     attr_accessor :color # the color to use for the frame (from Frameit::Color)
 
     # path: Path to screenshot
     # color: Color to use for the frame
-    def initialize(path, color)
+    def initialize(path, color, config, platform_command)
       UI.user_error!("Couldn't find file at path '#{path}'") unless File.exist?(path)
       @color = color
       @path = path
       @size = FastImage.size(path)
 
-      @screen_size = ENV["FRAMEIT_FORCE_DEVICE_TYPE"] || Deliver::AppScreenshot.calculate_screen_size(path)
+      # There are three ways how we can get settings to Frameit:
+      # - options.rb
+      #   - gets parameters via CLI (e. g. fastlane run frameit use_platform:"android") or fastfile (Fastlane's global
+      #     settings for a given project)
+      #   - see Parameters in the doc
+      #   - contains default values and validates values
+      #   - accessed via Frameit.config[:key]
+      #   - lowest priority
+      # - commands_generator.rb
+      #   - commands entered directly to CLI (e. g. fastlane frameit android)
+      #   - they are passed via constructors to other classes
+      #   - higher priority than options.rb (user may enter a command to override fastfile's global setting)
+      # - config_parser.rb
+      #   - gets key / values from Framefile.json
+      #   - see Advanced usage in the doc
+      #   - both default and specific values can be entered in the file (filtered by file name)
+      #   - accessed via ConfigParser.fetch_value(screenshot.path)[key] (the ConfigParser's instance is passed
+      #     to Screenshot's constructor as config, i.e. we call config[key])
+      #   - should have the highest priority, because user might set a specific value for a specific screenshot which
+      #     should override CLI parameters and fastfile global setting
+      platform = config['use_platform'] || platform_command || Frameit.config[:use_platform]
+      @device = Device.find_device_by_id_or_name(config['force_device_type'] || Frameit.config[:force_device_type]) || Device.detect_device(path, platform)
     end
 
     # Device name for a given screen size. Used to use the correct template
     def device_name
-      # rubocop:disable Require/MissingRequireStatement
-      sizes = Deliver::AppScreenshot::ScreenSize
-      case @screen_size
-      when sizes::IOS_65
-        return 'iPhone XS Max'
-      when sizes::IOS_61
-        return 'iPhone XR'
-      when sizes::IOS_58
-        return Frameit.config[:use_legacy_iphonex] ? 'iPhone X' : 'iPhone XS'
-      when sizes::IOS_55
-        return Frameit.config[:use_legacy_iphone6s] ? 'iPhone 6s Plus' : 'iPhone 7 Plus'
-      when sizes::IOS_47
-        return Frameit.config[:use_legacy_iphone6s] ? 'iPhone 6s' : 'iPhone 7'
-      when sizes::IOS_40
-        return Frameit.config[:use_legacy_iphone5s] ? 'iPhone 5s' : 'iPhone SE'
-      when sizes::IOS_35
-        return 'iPhone 4'
-      when sizes::IOS_IPAD
-        return 'iPad Air 2'
-      when sizes::IOS_IPAD_10_5
-        return 'iPad Pro (10.5-inch)'
-      when sizes::IOS_IPAD_11
-        return 'iPad Pro (11-inch)'
-      when sizes::IOS_IPAD_PRO
-        return 'iPad Pro'
-      when sizes::IOS_IPAD_PRO_12_9
-        return 'iPad Pro (12.9-inch) (3rd generation)'
-      when sizes::MAC
-        return 'MacBook'
-      else
-        UI.error("Unknown device type for size #{@screen_size} for path '#{path}'")
-      end
+      @device.formatted_name
       # rubocop:enable Require/MissingRequireStatement
     end
 
-    def color
-      if !Frameit.config[:use_legacy_iphone6s] && @color == Frameit::Color::BLACK
-        if @screen_size == Deliver::AppScreenshot::ScreenSize::IOS_55 || @screen_size == Deliver::AppScreenshot::ScreenSize::IOS_47
-          return "Matte Black" # RIP space gray
-        end
-      end
-      return @color
+    def default_color
+      @device.default_color
+    end
+
+    def deliver_screen_id
+      @device.deliver_screen_id
     end
 
     # Is the device a 3x device? (e.g. iPhone 6 Plus, iPhone X)
     def triple_density?
-      (screen_size == Deliver::AppScreenshot::ScreenSize::IOS_55 || screen_size == Deliver::AppScreenshot::ScreenSize::IOS_58 || screen_size == Deliver::AppScreenshot::ScreenSize::IOS_65)
+      !device.density_ppi.nil? && device.density_ppi > 400
     end
 
     # Super old devices (iPhone 4)
     def mini?
-      (screen_size == Deliver::AppScreenshot::ScreenSize::IOS_35)
+      !device.density_ppi.nil? && device.density_ppi < 300
     end
 
     def mac?
-      return device_name == 'MacBook'
+      device_name == 'MacBook'
     end
 
     # The name of the orientation of a screenshot. Used to find the correct template
@@ -134,6 +122,10 @@ module Frameit
       return File.mtime(path) > File.mtime(output_path)
     end
 
+    def language
+      @language ||= Pathname.new(path).parent.basename.to_s
+    end
+
     def to_s
       self.path
     end