frameit 2.2.1 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 33697842a9684e1245b3cf21196579eab29f9df9
-  data.tar.gz: 3a71b690abfea0de0de196ddcab330f581f461fe
+  metadata.gz: 34abb8d5461e92d27d8ee707a1e6fae13c1d1b16
+  data.tar.gz: f5a0190aaf203cc07ec3244a9c3bd8636d3244bd
 SHA512:
-  metadata.gz: 435f45f0176da56d12aa4258b3e91c57e5869789c3a60b4fa46acab276be667f76b49c9c40b1f930ae4b29ed62f7cb86b3896cb768009547639c409e08f46981
-  data.tar.gz: 76b974d29562dd17976266b6721b5b066a45cb9e06d0b9f03146f3bd79b08045a9e8cabfb3abe144dc3fc885d09140a227a4372b789b0f604a92436c6974104e
+  metadata.gz: cbab4d88a66db2754bd73f34458e8d3eac2a47e29a38430775025cc7399c38e5391933c605a226437235c94cf5a53cb8655dd2297edd6cd76178acd97e285093
+  data.tar.gz: 24a29d8ef715756269fb3265e013ec76e35b343c60c0225f890dcd81ff59acfe4849c958bbef2df5e91a5fdd749e988ed52673c705272120a3cdcc724942d2d4

data/README.md

@@ -13,16 +13,16 @@
   <a href="https://github.com/KrauseFx/sigh">sigh</a> &bull; 
   <a href="https://github.com/KrauseFx/produce">produce</a> &bull;
   <a href="https://github.com/KrauseFx/cert">cert</a> &bull;
-  <a href="https://github.com/KrauseFx/codes">codes</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/boarding">boarding</a> &bull;
-  <a href="https://github.com/fastlane/gym">gym</a>
+  <a href="https://github.com/fastlane/gym">gym</a> &bull;
+  <a href="https://github.com/fastlane/scan">scan</a>
 </p>
 -------
 
 <p align="center">
-    <img src="assets/frameit.png">
+  <img src="assets/frameit.png" height="110">
 </p>
 
 frameit
@@ -233,17 +233,21 @@ Check out the [MindNode example project](https://github.com/fastlane/examples/tr
 - [`sigh`](https://github.com/KrauseFx/sigh): Because you would rather spend your time building stuff than fighting provisioning
 - [`produce`](https://github.com/KrauseFx/produce): Create new iOS apps on iTunes Connect and Dev Portal using the command line
 - [`cert`](https://github.com/KrauseFx/cert): Automatically create and maintain iOS code signing certificates
-- [`codes`](https://github.com/KrauseFx/codes): Create promo codes for iOS Apps using the command line
 - [`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
 - [`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
 
 ##### [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/KrauseFx/snapshot) to automatically generate screenshots using ```UI Automation```.
 
+## 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.
+
 ## White background of frames
 
 Some stock images provided by Apple still have a white background instead of a transparent one. You'll have to edit the Photoshop file to remove the white background, delete the generated `.png` file and run `frameit` again.

data/bin/frameit

@@ -22,7 +22,6 @@ class FrameItApplication
 
     default_command :black
 
-
     command :black do |c|
       c.syntax = 'frameit black'
       c.description = "Adds a black frame around all screenshots."
@@ -35,7 +34,7 @@ class FrameItApplication
     command :silver do |c|
       c.syntax = 'frameit silver'
       c.description = "Adds a silver frame around all screenshots."
-      
+
       c.action do |args, options|
         Frameit::Runner.new.run('.', Frameit::Color::SILVER)
       end
@@ -44,7 +43,7 @@ class FrameItApplication
     command :setup do |c|
       c.syntax = 'frameit setup'
       c.description = "Helps you adding new frames."
-      
+
       c.action do |args, options|
         Frameit::FrameConverter.new.run
       end
@@ -56,11 +55,10 @@ class FrameItApplication
   end
 end
 
-
 begin
   FastlaneCore::UpdateChecker.start_looking_for_update('frameit')
   Frameit::DependencyChecker.check_dependencies
   FrameItApplication.new.run
 ensure
   FastlaneCore::UpdateChecker.show_update_status('frameit', Frameit::VERSION)
-end
+end

data/lib/frameit.rb

@@ -18,10 +18,11 @@ module Frameit
   Helper = FastlaneCore::Helper # you gotta love Ruby: Helper.* should use the Helper class contained in FastlaneCore
 end
 
-
+# rubocop:disable all
 class ::Hash
   def fastlane_deep_merge(second)
     merger = proc { |key, v1, v2| Hash === v1 && Hash === v2 ? v1.merge(v2, &merger) : v2 }
     self.merge(second, &merger)
   end
-end
+end
+# rubocop:enable all

data/lib/frameit/config_parser.rb

@@ -1,14 +1,12 @@
 module Frameit
   class ConfigParser
     def load(path)
-      return nil unless File.exists?(path) # we are okay with no config at all
+      return nil unless File.exist?(path) # we are okay with no config at all
       Helper.log.info "Parsing config file '#{path}'".yellow if $verbose
       @path = path
       self.parse(File.read(path))
     end
 
-
-
     # @param data (String) the JSON data to be parsed
     def parse(data)
       begin
@@ -24,8 +22,8 @@ module Frameit
     # Fetches the finished configuration for a given path. This will try to look for a specific value
     # and fallback to a default value if nothing was found
     def fetch_value(path)
-      specific = @data['data'].find { |a| path.include?a['filter'] }
-      
+      specific = @data['data'].find { |a| path.include? a['filter'] }
+
       default = @data['default']
 
       values = default.fastlane_deep_merge(specific || {})
@@ -39,18 +37,18 @@ module Frameit
     # Use absolute paths instead of relative
     def change_paths_to_absolutes!(values)
       values.each do |key, value|
-        if value.kind_of?Hash
+        if value.kind_of? Hash
           change_paths_to_absolutes!(value) # recursive call
-        elsif value.kind_of?Array
+        elsif value.kind_of? Array
           value.each do |current|
-            change_paths_to_absolutes!(current) if current.kind_of?Hash # recursive call
+            change_paths_to_absolutes!(current) if current.kind_of? Hash # recursive call
           end
         else
-          if ['font', 'background'].include?key
+          if ['font', 'background'].include? key
             # Change the paths to relative ones
             # `replace`: to change the content of the string, so it's actually stored
             if @path # where is the config file. We don't have a config file in tests
-              containing_folder = File.expand_path('..', @path) 
+              containing_folder = File.expand_path('..', @path)
               value.replace File.join(containing_folder, value)
             end
           end
@@ -61,36 +59,36 @@ module Frameit
     # Make sure the paths/colors are valid
     def validate_values(values)
       values.each do |key, value|
-        if value.kind_of?Hash
+        if value.kind_of? Hash
           validate_values(value) # recursive call
         else
           if key == 'font'
-            raise "Could not find font at path '#{File.expand_path(value)}'" unless File.exists?value
+            raise "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
+            raise "`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.exists?current.fetch('font')
-              raise "`supported` must be an array" unless current.fetch('supported', []).kind_of?Array
+              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
             end
           end
 
           if key == 'background'
-            raise "Could not find background image at path '#{File.expand_path(value)}'" unless File.exists?value
+            raise "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?"#"
+            raise "Invalid color '#{value}'. Must be valid Hex #123123" unless value.include? "#"
           end
 
           if key == 'padding'
-            raise "padding must be type integer" unless value.kind_of?Integer
+            raise "padding must be type integer" unless value.kind_of? Integer
           end
         end
       end
     end
   end
-end
+end

data/lib/frameit/dependency_checker.rb

@@ -1,13 +1,13 @@
 module Frameit
   class DependencyChecker
     def self.check_dependencies
-      return if Helper.is_test?
-      
+      return if Helper.test?
+
       self.check_image_magick
     end
 
     def self.check_image_magick
-      unless `which convert`.include?"convert"
+      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'"
@@ -17,4 +17,4 @@ module Frameit
       end
     end
   end
-end
+end

data/lib/frameit/device_types.rb

@@ -8,4 +8,4 @@ module Frameit
     PORTRAIT = "Vert"
     LANDSCAPE = "Horz"
   end
-end
+end

data/lib/frameit/editor.rb

@@ -33,273 +33,275 @@ module Frameit
       @image = MiniMagick::Image.open(screenshot.path)
     end
 
-
     private
-      def store_result
-        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
-      end
-
-      # puts the screenshot into the frame
-      def put_into_frame
-        @image = frame.composite(image, "png") do |c|
-          c.compose "Over"
-          c.geometry offset['offset']
-        end
-      end
-
-      def offset
-        return @offset_information if @offset_information
 
-        @offset_information = fetch_config['offset'] || Offsets.image_offset(screenshot)
+    def store_result
+      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
+    end
 
-        if @offset_information and (@offset_information['offset'] or @offset_information['offset'])
-          return @offset_information
-        end
-        raise "Could not find offset_information for '#{screenshot}'"
+    # puts the screenshot into the frame
+    def put_into_frame
+      @image = frame.composite(image, "png") do |c|
+        c.compose "Over"
+        c.geometry offset['offset']
       end
+    end
 
-      #########################################################################################
-      # Everything below is related to title, background, etc. and is not used in the easy mode
-      #########################################################################################
-
-      # this is used to correct the 1:1 offset information
-      # the offset information is stored to work for the template images
-      # since we resize the template images to have higher quality screenshots
-      # we need to modify the offset information by a certain factor
-      def modify_offset(multiplicator)
-        # Format: "+133+50"
-        hash = offset['offset']
-        x = hash.split("+")[1].to_f * multiplicator
-        y = hash.split("+")[2].to_f * multiplicator
-        new_offset = "+#{x.round}+#{y.round}"
-        @offset_information['offset'] = new_offset
-      end
+    def offset
+      return @offset_information if @offset_information
 
-      # Do we add a background and title as well?
-      def should_add_title?
-        return (fetch_config['background'] and (fetch_config['title'] or fetch_config['keyword']))
+      @offset_information = fetch_config['offset'] || Offsets.image_offset(screenshot)
+
+      if @offset_information and (@offset_information['offset'] or @offset_information['offset'])
+        return @offset_information
       end
+      raise "Could not find offset_information for '#{screenshot}'"
+    end
 
-      # more complex mode: background, frame and title
-      def complex_framing
-        background = generate_background
-        
-        if self.frame # we have no frame on le mac
-          resize_frame!
-          @image = put_into_frame
-
-          # Decrease the size of the framed screenshot to fit into the defined padding + background
-          frame_width = background.width - frame_padding * 2
-          image.resize "#{frame_width}x"
-        end
+    #########################################################################################
+    # Everything below is related to title, background, etc. and is not used in the easy mode
+    #########################################################################################
+
+    # this is used to correct the 1:1 offset information
+    # the offset information is stored to work for the template images
+    # since we resize the template images to have higher quality screenshots
+    # we need to modify the offset information by a certain factor
+    def modify_offset(multiplicator)
+      # Format: "+133+50"
+      hash = offset['offset']
+      x = hash.split("+")[1].to_f * multiplicator
+      y = hash.split("+")[2].to_f * multiplicator
+      new_offset = "+#{x.round}+#{y.round}"
+      @offset_information['offset'] = new_offset
+    end
 
-        @image = put_device_into_background(background)
+    # Do we add a background and title as well?
+    def should_add_title?
+      return (fetch_config['background'] and (fetch_config['title'] or fetch_config['keyword']))
+    end
 
-        if fetch_config['title']
-          @image = add_title
-        end
+    # more complex mode: background, frame and title
+    def complex_framing
+      background = generate_background
 
-        image
-      end
+      if self.frame # we have no frame on le mac
+        resize_frame!
+        @image = put_into_frame
 
-      # Padding around the frames
-      def frame_padding
-        multi = 1.0
-        multi = 1.7 if self.screenshot.is_triple_density?
-        return fetch_config['padding'] * multi
+        # Decrease the size of the framed screenshot to fit into the defined padding + background
+        frame_width = background.width - frame_padding * 2
+        image.resize "#{frame_width}x"
       end
 
-      # Returns a correctly sized background image
-      def generate_background
-        background = MiniMagick::Image.open(fetch_config['background'])
+      @image = put_device_into_background(background)
 
-        if background.height != screenshot.size[1]
-          background.resize "#{screenshot.size[0]}x#{screenshot.size[1]}!" # `!` says it should ignore the ratio
-        end
-        background
+      if fetch_config['title']
+        @image = add_title
       end
 
-      def put_device_into_background(background)
-        left_space = (background.width / 2.0 - image.width / 2.0).round
-        bottom_space = -(image.height / 10).round # to be just a bit below the image bottom
-        bottom_space -= 40 if screenshot.is_portrait? # even more for portrait mode
+      image
+    end
 
-        if screenshot.is_mini?
-          # Such small devices need special treatment
-          bottom_space -= 50 if screenshot.is_portrait?
-          bottom_space += 65 unless screenshot.is_portrait?
-        end
+    # Padding around the frames
+    def frame_padding
+      multi = 1.0
+      multi = 1.7 if self.screenshot.triple_density?
+      return fetch_config['padding'] * multi
+    end
 
-        self.top_space_above_device = background.height - image.height - bottom_space
+    # Returns a correctly sized background image
+    def generate_background
+      background = MiniMagick::Image.open(fetch_config['background'])
 
-        @image = background.composite(image, "png") do |c|
-          c.compose "Over"
-          c.geometry "+#{left_space}+#{top_space_above_device}"
-        end
+      if background.height != screenshot.size[1]
+        background.resize "#{screenshot.size[0]}x#{screenshot.size[1]}!" # `!` says it should ignore the ratio
+      end
+      background
+    end
+
+    def put_device_into_background(background)
+      left_space = (background.width / 2.0 - image.width / 2.0).round
+      bottom_space = -(image.height / 10).round # to be just a bit below the image bottom
+      bottom_space -= 40 if screenshot.portrait? # even more for portrait mode
 
-        return image
+      if screenshot.mini?
+        # Such small devices need special treatment
+        bottom_space -= 50 if screenshot.portrait?
+        bottom_space += 65 unless screenshot.portrait?
       end
 
-      # Resize the frame as it's too low quality by default
-      def resize_frame!
-        multiplicator = (screenshot.size[0].to_f / offset['width'].to_f) # by how much do we have to change this?
-        new_frame_width = multiplicator * frame.width # the new width for the frame
-        frame.resize "#{new_frame_width.round}x" # resize it to the calculated witdth
-        modify_offset(multiplicator) # modify the offset to properly insert the screenshot into the frame later
+      self.top_space_above_device = background.height - image.height - bottom_space
+
+      @image = background.composite(image, "png") do |c|
+        c.compose "Over"
+        c.geometry "+#{left_space}+#{top_space_above_device}"
       end
 
-      # Add the title above the device
-      def add_title
-        title_images = build_title_images(image.width)
-        keyword = title_images[:keyword]
-        title = title_images[:title]
-
-        # sum_width: the width of both labels together including the space inbetween
-        #   is used to calculate the ratio
-        sum_width = title.width
-        sum_width += keyword.width + keyword_padding if keyword
-
-        # Resize the 2 labels if necessary
-        smaller = 1.0 # default
-        ratio = (sum_width + keyword_padding * 2) / image.width.to_f
-        if ratio > 1.0
-          # 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
-
-          title.resize"#{(smaller * title.width).round}x"
-          keyword.resize"#{(smaller * keyword.width).round}x" if keyword
-          sum_width *= smaller
-        end
+      return image
+    end
 
-        top_space = (top_space_above_device / 2.0 - (actual_font_size / 2.0 * smaller)).round # centered
-        left_space = (image.width / 2.0 - sum_width / 2.0).round
+    # Resize the frame as it's too low quality by default
+    def resize_frame!
+      multiplicator = (screenshot.size[0].to_f / offset['width'].to_f) # by how much do we have to change this?
+      new_frame_width = multiplicator * frame.width # the new width for the frame
+      frame.resize "#{new_frame_width.round}x" # resize it to the calculated witdth
+      modify_offset(multiplicator) # modify the offset to properly insert the screenshot into the frame later
+    end
 
-        # First, put the keyword on top of the screenshot, if we have one
-        if keyword
-          @image = image.composite(keyword, "png") do |c|
-            c.compose "Over"
-            c.geometry "+#{left_space}+#{top_space}"
-          end
+    # Add the title above the device
+    # rubocop:disable Metrics/AbcSize
+    def add_title
+      title_images = build_title_images(image.width)
+      keyword = title_images[:keyword]
+      title = title_images[:title]
+
+      # sum_width: the width of both labels together including the space inbetween
+      #   is used to calculate the ratio
+      sum_width = title.width
+      sum_width += keyword.width + keyword_padding if keyword
+
+      # Resize the 2 labels if necessary
+      smaller = 1.0 # default
+      ratio = (sum_width + keyword_padding * 2) / image.width.to_f
+      if ratio > 1.0
+        # 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
+
+        title.resize "#{(smaller * title.width).round}x"
+        keyword.resize "#{(smaller * keyword.width).round}x" if keyword
+        sum_width *= smaller
+      end
 
-          left_space += keyword.width + (keyword_padding * smaller)
-        end
-        
-        # Then, put the title on top of the screenshot next to the keyword
-        @image = image.composite(title, "png") do |c|
+      top_space = (top_space_above_device / 2.0 - (actual_font_size / 2.0 * smaller)).round # centered
+      left_space = (image.width / 2.0 - sum_width / 2.0).round
+
+      # First, put the keyword on top of the screenshot, if we have one
+      if keyword
+        @image = image.composite(keyword, "png") do |c|
           c.compose "Over"
           c.geometry "+#{left_space}+#{top_space}"
         end
-        image
-      end
 
-      def actual_font_size
-        [top_space_above_device / 3.0, @image.width / 30.0].max.round
+        left_space += keyword.width + (keyword_padding * smaller)
       end
 
-      # The space between the keyword and the title
-      def keyword_padding
-        (actual_font_size / 2.0).round
+      # Then, put the title on top of the screenshot next to the keyword
+      @image = image.composite(title, "png") do |c|
+        c.compose "Over"
+        c.geometry "+#{left_space}+#{top_space}"
       end
+      image
+    end
+    # rubocop:enable Metrics/AbcSize
 
-      # This will build 2 individual images with the title, which will then be added to the real image
-      def build_title_images(max_width)
-        words = [:keyword, :title].keep_if{ |a| fetch_text(a) } # optional keyword/title
-        results = {}
-        words.each do |key|
-          # Create empty background
-          empty_path = File.join(Helper.gem_path('frameit'), "lib/assets/empty.png")
-          title_image = MiniMagick::Image.open(empty_path)
-          image_height = actual_font_size * 2 # gets trimmed afterwards anyway, and on the iPad the `y` would get cut
-          title_image.combine_options do |i|
-            # * 2.0 as the text might be larger than the actual image. We're trimming afterwards anyway
-            i.resize "#{max_width * 2.0}x#{image_height}!" # `!` says it should ignore the ratio
-          end
+    def actual_font_size
+      [top_space_above_device / 3.0, @image.width / 30.0].max.round
+    end
 
-          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 '#{fetch_text(key)}'"if $verbose
-
-          # Add the actual title
-          title_image.combine_options do |i|
-            i.font current_font if current_font
-            i.gravity "Center"
-            i.pointsize actual_font_size
-            i.draw "text 0,0 '#{fetch_text(key)}'"
-            i.fill fetch_config[key.to_s]['color']
-          end
-          title_image.trim # remove white space
+    # The space between the keyword and the title
+    def keyword_padding
+      (actual_font_size / 2.0).round
+    end
 
-          results[key] = title_image
+    # This will build 2 individual images with the title, which will then be added to the real image
+    def build_title_images(max_width)
+      words = [:keyword, :title].keep_if { |a| fetch_text(a) } # optional keyword/title
+      results = {}
+      words.each do |key|
+        # Create empty background
+        empty_path = File.join(Helper.gem_path('frameit'), "lib/assets/empty.png")
+        title_image = MiniMagick::Image.open(empty_path)
+        image_height = actual_font_size * 2 # gets trimmed afterwards anyway, and on the iPad the `y` would get cut
+        title_image.combine_options do |i|
+          # * 2.0 as the text might be larger than the actual image. We're trimming afterwards anyway
+          i.resize "#{max_width * 2.0}x#{image_height}!" # `!` says it should ignore the ratio
         end
-        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
+        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
+
+        # Add the actual title
+        title_image.combine_options do |i|
+          i.font current_font if current_font
+          i.gravity "Center"
+          i.pointsize actual_font_size
+          i.draw "text 0,0 '#{text}'"
+          i.fill fetch_config[key.to_s]['color']
+        end
+        title_image.trim # remove white space
 
-        config_path = File.join(File.expand_path("..", screenshot.path), "Framefile.json")
-        config_path = File.join(File.expand_path("../..", screenshot.path), "Framefile.json") unless File.exists?config_path
-        file = ConfigParser.new.load(config_path)
-        return {} unless file # no config file at all
-        @config = file.fetch_value(screenshot.path)
+        results[key] = title_image
       end
+      results
+    end
 
-      # Fetches the title + keyword for this particular screenshot
-      def fetch_text(type)
-        raise "Valid parameters :keyword, :title" unless [:keyword, :title].include?type
+    # 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
 
-        # Try to get it from a keyword.strings or title.strings file
-        strings_path = File.join(File.expand_path("..", screenshot.path), "#{type.to_s}.strings")
-        if File.exists?strings_path
-          parsed = StringsParser.parse(strings_path)
-          result = parsed.find { |k, v| screenshot.path.include?k }
-          return result.last if result
-        end
+      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
 
-        # No string files, fallback to Framefile config
-        result = fetch_config[type.to_s]['text']      
-        Helper.log.debug "Falling back to default text as there was nothing specified in the .strings file" if $verbose
+    # Fetches the title + keyword for this particular screenshot
+    def fetch_text(type)
+      raise "Valid parameters :keyword, :title" unless [:keyword, :title].include? type
 
-        if !result and type == :title
-          # title is mandatory
-          raise "Could not get title for screenshot #{screenshot.path}. Please provide one in your Framefile.json".red
-        end
+      # Try to get it from a keyword.strings or title.strings file
+      strings_path = File.join(File.expand_path("..", screenshot.path), "#{type}.strings")
+      if File.exist? strings_path
+        parsed = StringsParser.parse(strings_path)
+        result = parsed.find { |k, v| screenshot.path.include? k }
+        return result.last if result
+      end
 
-        return result
+      # No string files, fallback to Framefile config
+      result = fetch_config[type.to_s]['text']
+      Helper.log.debug "Falling back to default text as there was nothing specified in the .strings file" if $verbose
+
+      if !result and type == :title
+        # title is mandatory
+        raise "Could not get title for screenshot #{screenshot.path}. Please provide one in your Framefile.json".red
       end
 
-      # The font we want to use
-      def font(key)
-        single_font = fetch_config[key.to_s]['font']
-        return single_font if single_font
-
-        fonts = fetch_config[key.to_s]['fonts']
-        if fonts
-          fonts.each do |font|
-            if font['supported']
-              font['supported'].each do |language|
-                if screenshot.path.include?language
-                  return font["font"]
-                end
+      return result
+    end
+
+    # The font we want to use
+    def font(key)
+      single_font = fetch_config[key.to_s]['font']
+      return single_font if single_font
+
+      fonts = fetch_config[key.to_s]['fonts']
+      if fonts
+        fonts.each do |font|
+          if font['supported']
+            font['supported'].each do |language|
+              if screenshot.path.include? language
+                return font["font"]
               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
-              return font["font"]
             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
+            return font["font"]
           end
         end
-
-        Helper.log.debug "No custom font specified for #{screenshot}, using the default one" if $verbose
-        return nil
       end
+
+      Helper.log.debug "No custom font specified for #{screenshot}, using the default one" if $verbose
+      return nil
+    end
   end
 end

data/lib/frameit/frame_converter.rb

@@ -2,7 +2,7 @@ module Frameit
   class FrameConverter
     DOWNLOAD_URL = 'https://developer.apple.com/app-store/marketing/guidelines/#images'
     FRAME_PATH = '.frameit/devices_frames'
-    
+
     def run
       self.setup_frames
     end
@@ -14,7 +14,7 @@ module Frameit
       puts "Press Enter to get started".green
       puts "----------------------------------------------------".green
       STDIN.gets
-      
+
       system("open '#{DOWNLOAD_URL}'")
       puts "----------------------------------------------------".green
       puts "Download the zip files for the following devices".green
@@ -34,7 +34,7 @@ module Frameit
         puts "----------------------------------------------------".green
         STDIN.gets
 
-        if not frames_exist?
+        if !frames_exist?
           puts "Sorry, I can't find the PSD files. Make sure you unzipped them into '#{templates_path}'".red
         else
           break # everything is finished
@@ -60,17 +60,17 @@ module Frameit
 
       Dir["#{templates_path}/**/*.psd"].each do |psd|
         resulting_path = psd.gsub('.psd', '.png')
-        unless File.exists?resulting_path
-          Helper.log.debug "Converting PSD file '#{psd}'".yellow
-          image = MiniMagick::Image.open(psd)
-          if image
-            image.format 'png'
-            image.trim
-            
-            image.write(resulting_path)
-          else
-            Helper.log.error "Could not parse PSD file at path '#{psd}'"
-          end
+        next if File.exist?(resulting_path)
+
+        Helper.log.debug "Converting PSD file '#{psd}'".yellow
+        image = MiniMagick::Image.open(psd)
+        if image
+          image.format 'png'
+          image.trim
+
+          image.write(resulting_path)
+        else
+          Helper.log.error "Could not parse PSD file at path '#{psd}'"
         end
       end
     end

data/lib/frameit/mac_editor.rb

@@ -1,7 +1,6 @@
 module Frameit
   # Responsible for framing Mac Screenshots
   class MacEditor < Editor
-
     def prepare_image
       image = super
       image.resize("#{offset['width']}x") if offset['width']
@@ -30,4 +29,4 @@ module Frameit
       MiniMagick::Image.open(fetch_config['background']) # no resizing on the Mac
     end
   end
-end
+end

data/lib/frameit/offsets.rb

@@ -5,62 +5,62 @@ module Frameit
     def self.image_offset(screenshot)
       size = Deliver::AppScreenshot::ScreenSize
       case screenshot.orientation_name
-        when Orientation::PORTRAIT
-          case screenshot.screen_size
-            when size::IOS_55
-              return { 
-                'offset' => '+41+146',
-                'width' => 541
-              }
-            when size::IOS_47
-              return {
-                'offset' => '+40+153',
-                'width' => 532
-              }
-            when size::IOS_40
-              return {
-                'offset' => "+54+197",
-                'width' => 544
-              }
-            when size::IOS_35
-              return {
-                'offset' => "+59+260",
-                'width' => 647
-              }
-            when size::IOS_IPAD
-              return {
-                'offset' => '+50+134',
-                'width' => 792
-              }
-          end
-        when Orientation::LANDSCAPE
-          case screenshot.screen_size
-            when size::IOS_55
-              return { 
-                'offset' => "+146+41",
-                'width' => 960
-              }
-            when size::IOS_47
-              return {
-                'offset' => "+153+41",
-                'width' => 946
-              }
-            when size::IOS_40
-              return {
-                'offset' => "+201+48",
-                'width' => 970
-              }
-            when size::IOS_35
-              return {
-                'offset' => "+258+52",
-                'width' => 966
-              }
-            when size::IOS_IPAD
-              return {
-                'offset' => '+133+50',
-                'width' => 1058
-              }
-          end
+      when Orientation::PORTRAIT
+        case screenshot.screen_size
+        when size::IOS_55
+          return {
+            'offset' => '+41+146',
+            'width' => 541
+          }
+        when size::IOS_47
+          return {
+            'offset' => '+40+153',
+            'width' => 532
+          }
+        when size::IOS_40
+          return {
+            'offset' => "+54+197",
+            'width' => 544
+          }
+        when size::IOS_35
+          return {
+            'offset' => "+59+260",
+            'width' => 647
+          }
+        when size::IOS_IPAD
+          return {
+            'offset' => '+47+135',
+            'width' => 737
+          }
+        end
+      when Orientation::LANDSCAPE
+        case screenshot.screen_size
+        when size::IOS_55
+          return {
+            'offset' => "+146+41",
+            'width' => 960
+          }
+        when size::IOS_47
+          return {
+            'offset' => "+153+41",
+            'width' => 946
+          }
+        when size::IOS_40
+          return {
+            'offset' => "+201+48",
+            'width' => 970
+          }
+        when size::IOS_35
+          return {
+            'offset' => "+258+52",
+            'width' => 966
+          }
+        when size::IOS_IPAD
+          return {
+            'offset' => '+135+47',
+            'width' => 983
+          }
+        end
       end
     end
   end

data/lib/frameit/runner.rb

@@ -5,12 +5,12 @@ module Frameit
   class Runner
     def initialize
       converter = FrameConverter.new
-      unless converter.frames_exist?
-        # First run
-        converter.run
-      else
+      if converter.frames_exist?
         # Just make sure, the PSD files are converted to PNG
         converter.convert_frames
+      else
+        # First run
+        converter.run
       end
     end
 
@@ -19,11 +19,11 @@ module Frameit
 
       if screenshots.count > 0
         screenshots.each do |full_path|
-          next if full_path.include?"_framed.png"
-          next if full_path.include?".itmsp/" # a package file, we don't want to modify that
-          next if full_path.include?"device_frames/" # these are the device frames the user is using
-          next if full_path.downcase.include?"watch" # we don't care about watches right now
-          
+          next if full_path.include? "_framed.png"
+          next if full_path.include? ".itmsp/" # a package file, we don't want to modify that
+          next if full_path.include? "device_frames/" # these are the device frames the user is using
+          next if full_path.downcase.include? "watch" # we don't care about watches right now
+
           begin
             screenshot = Screenshot.new(full_path, color)
             screenshot.frame!
@@ -32,7 +32,7 @@ module Frameit
             Helper.log.error "Backtrace:\n\t#{ex.backtrace.join("\n\t")}" if $verbose
           end
         end
-      else 
+      else
         Helper.log.error "Could not find screenshots"
       end
     end

data/lib/frameit/screenshot.rb

@@ -9,44 +9,44 @@ 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.exists?path
+      raise "Couldn't find file at path '#{path}'".red 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) 
+      @screen_size = ENV["FRAMEIT_FORCE_DEVICE_TYPE"] || Deliver::AppScreenshot.calculate_screen_size(path)
     end
 
     # Device name for a given screen size. Used to use the correct template
     def device_name
       sizes = Deliver::AppScreenshot::ScreenSize
       case @screen_size
-        when sizes::IOS_55
-          return 'iPhone_6_Plus'
-        when sizes::IOS_47
-          return 'iPhone_6'
-        when sizes::IOS_40
-          return 'iPhone_5s'
-        when sizes::IOS_35
-          return 'iPhone_4'
-        when sizes::IOS_IPAD
-          return 'iPad_mini'
-        when sizes::MAC
-          return 'Mac'
+      when sizes::IOS_55
+        return 'iPhone_6_Plus'
+      when sizes::IOS_47
+        return 'iPhone_6'
+      when sizes::IOS_40
+        return 'iPhone_5s'
+      when sizes::IOS_35
+        return 'iPhone_4'
+      when sizes::IOS_IPAD
+        return 'iPad_mini'
+      when sizes::MAC
+        return 'Mac'
       end
     end
 
     # Is the device a 3x device? (e.g. 6 Plus)
-    def is_triple_density?
+    def triple_density?
       (screen_size == Deliver::AppScreenshot::ScreenSize::IOS_55)
     end
 
     # Super old devices
-    def is_mini?
+    def mini?
       (screen_size == Deliver::AppScreenshot::ScreenSize::IOS_35)
     end
 
-    def is_mac?
+    def mac?
       return device_name == 'Mac'
     end
 
@@ -56,7 +56,7 @@ module Frameit
       return Orientation::LANDSCAPE
     end
 
-    def is_portrait?
+    def portrait?
       return (orientation_name == Orientation::PORTRAIT)
     end
 
@@ -66,11 +66,11 @@ module Frameit
 
     # Add the device frame, this will also call the method that adds the background + title
     def frame!
-      if self.is_mac?
+      if self.mac?
         MacEditor.new.frame!(self)
       else
         Editor.new.frame!(self)
       end
     end
   end
-end
+end

data/lib/frameit/strings_parser.rb

@@ -2,8 +2,8 @@ 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.exists?path
-      raise "Must be .strings file, only got '#{path}'".red unless path.end_with?".strings"
+      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"
 
       result = {}
 
@@ -13,19 +13,19 @@ module Frameit
       content.split("\n").each do |line|
         begin
           # We don't care about comments and empty lines
-          if line.start_with?'"'
+          if line.start_with? '"'
             key = line.match(/"(.*)" \= /)[1]
             value = line.match(/ \= "(.*)"/)[1]
 
             result[key] = value
           end
         rescue => ex
-          Helper.log.error ex          
+          Helper.log.error ex
           Helper.log.error line
         end
       end
-      
+
       result
     end
   end
-end
+end

data/lib/frameit/template_finder.rb

@@ -1,10 +1,9 @@
 module Frameit
   # Responsible for finding the correct device
   class TemplateFinder
-
     # This will detect the screen size and choose the correct template
     def self.get_template(screenshot)
-      return nil if screenshot.is_mac?
+      return nil if screenshot.mac?
       parts = [
         screenshot.device_name,
         screenshot.orientation_name,
@@ -12,11 +11,9 @@ module Frameit
       ]
       parts << "sRGB" if screenshot.device_name == 'iPad_mini'
 
-
       templates_path = [ENV['HOME'], FrameConverter::FRAME_PATH].join('/')
       templates = Dir["../**/#{parts.join('_')}*.{png,jpg}"] # local directory
-      templates = templates + Dir["#{templates_path}/**/#{parts.join('_')}*.{png,jpg}"] # ~/.frameit folder
-      
+      templates += Dir["#{templates_path}/**/#{parts.join('_')}*.{png,jpg}"] # ~/.frameit folder
 
       if templates.count == 0
         if screenshot.screen_size == Deliver::AppScreenshot::ScreenSize::IOS_35
@@ -30,8 +27,8 @@ module Frameit
         end
         return nil
       else
-        return templates.first.gsub(" ", "\ ")
+        return templates.first.tr(" ", "\ ")
       end
     end
   end
-end
+end

data/lib/frameit/version.rb

@@ -1,3 +1,3 @@
 module Frameit
-  VERSION = "2.2.1"
+  VERSION = "2.2.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: frameit
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.2.2
 platform: ruby
 authors:
 - Felix Krause
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-08 00:00:00.000000000 Z
+date: 2015-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fastlane_core
@@ -142,6 +142,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.7.4
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.19.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.19.0
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -156,6 +170,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.34'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.34'
 description: Quickly put your screenshots into the right device frames
 email:
 - frameit@krausefx.com
@@ -201,7 +243,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Quickly put your screenshots into the right device frames