frameit 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3d2a2a56cf47435c5ade1e1a23aa9be3d173a5d6
-  data.tar.gz: 7cb3e2d31b45a5d536c8cad848c558bbef57d0b4
+  metadata.gz: a09eef67fb1b74cdf9233221b02a0bef2c90cdb7
+  data.tar.gz: 254360304c3cae8929e7a06c142223de91fb9008
 SHA512:
-  metadata.gz: 05da10f3143b6f271f3b28328fc85875826f3f738f0ec90b9bcee82d4d8d0a62d57fde6e5731cc09c3b76fd7d6cbd06170bc5d404221950fcb4cbb24aace802b
-  data.tar.gz: e0bf2d046840925a4ff16b91d0bf08807dc9a7e3d8fb20751ca584e2d78277eb04b9719d53785a7449cda7f24f188e37905d3d1c9be498114441763340ad86b4
+  metadata.gz: edf0fda390e74e7a6f2ebf31b4400e0ccd1c952b61bcc76968084dc9d4fa5d12cdcdb9f766e64595dfae804ba6799decd1af72cf5825a28f1492637a70be3b38
+  data.tar.gz: a9922bb2cb107ce9157b1d2be1bb7a95c5fa55205a91c5e768549382b86ee2f37accd817d74b82a978cf8f8b7cfeaacca791612e35b2f0429c14e2c378210985

data/README.md

@@ -61,6 +61,20 @@ Here is a nice gif, that shows ```frameit``` in action:
 
 ![assets/FrameitGit.gif](assets/FrameitGit.gif?raw=1)
 
+### Results
+
+![assets/ScreenshotsBig.png](assets/ScreenshotsBig.png?raw=1)
+
+-------
+
+![assets/ScreenshotsOverview.png](assets/ScreenshotsOverview.png?raw=1)
+
+-------
+
+![assets/MacExample.png](assets/MacExample.png?raw=1)
+
+<h5 align="center">The <code>frameit</code> 2.0 update was kindly sponsored by <a href="https://mindnode.com/">MindNode</a>, seen in the screenshots above.
+
 # Installation
 
 Make sure, you have the commandline tools installed
@@ -101,6 +115,107 @@ To run the setup process again to add new frames use:
 
 When using `frameit` without titles on top, the screenshots will have the full resolution, which means they can't be uploaded to the App Store directly. They are supposed to be used for websites, print media and emails. Check out the section below to use the screenshots for the App Store.
 
+# Titles and Background (optional)
+
+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.
+
+#### `Framefile.json`
+
+Use it to define the general information:
+
+```json
+{
+  "default": {
+    "keyword": {
+      "font": "./fonts/MyFont-Rg.otf"
+    },
+    "title": {
+      "font": "./fonts/MyFont-Th.otf",
+      "color": "#545454"
+    },
+    "background": "./background.jpg",
+    "padding": 50
+  },
+
+  "data": [
+    {
+      "filter": "Brainstorming",
+      "keyword": {
+        "color": "#d21559"
+      }
+    },
+    {
+      "filter": "Organizing",
+      "keyword": {
+        "color": "#feb909"
+      }
+    },
+    {
+      "filter": "Sharing",
+      "keyword": {
+        "color": "#aa4dbc"
+      }
+    },
+    {
+      "filter": "Styling",
+      "keyword": {
+        "color": "#31bb48"
+      }
+    }
+  ]
+}
+```
+
+The `filter` value is a part of the screenshot named for which the given option should be used. If a screenshot is named `iPhone5_Brainstorming.png` the first entry in the `data` array will be used.
+
+The `Framefile.json` should be in the `screenshots` folder, as seen in the [example](https://github.com/fastlane/examples/tree/master/MindNode/screenshots).
+
+#### `.strings` files
+
+To define the title and optionally the keyword, put two `.strings` files into the language folder (e.g. [en-US in the example project](https://github.com/fastlane/examples/tree/master/MindNode/screenshots/en-US))
+
+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.
+
+#### Uploading screenshots to iTC
+
+Use [deliver](https://github.com/KrauseFx/deliver) to upload all screenshots to iTunes Connect completely automatic :rocket:
+
+### Mac
+
+With `frameit` 2.0 is possible to also frame Mac OS X Applications. You have to provide the following:
+
+- The `offset` information so `frameit` knows where to put your screenshots
+- A path to a `background`, which should contain both the background and the Mac
+- `titleHeight`: The height in px that should be used for the title
+
+##### Example
+```json
+{
+  "default": {
+    "title": {
+      "color": "#545454"
+    },
+    "background": "Mac.jpg",
+    "offset": {
+      "offset": "+676+479",
+      "titleHeight": 320
+    }
+  },
+  "data": [
+    {
+      "filter": "Brainstorming",
+      "keyword": {
+        "color": "#d21559"
+      }
+    }
+  ]
+}
+```
+
+Check out the [MindNode example project](https://github.com/fastlane/examples/tree/master/MindNode/screenshots)
+
 # Tips
 
 ## [`fastlane`](https://fastlane.tools) Toolchain

data/bin/frameit

@@ -20,6 +20,7 @@ class FrameItApplication
 
     always_trace!
 
+    global_option('--verbose') { $verbose = true }
 
     default_command :black
 

data/lib/frameit/config_parser.rb

@@ -41,11 +41,14 @@ module Frameit
       values.each do |key, value|
         if value.kind_of?Hash
           change_paths_to_absolutes!(value) # recursive call
+        elsif value.kind_of?Array
+          value.each do |current|
+            change_paths_to_absolutes!(current) if current.kind_of?Hash # recursive call
+          end
         else
           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) 
               value.replace File.join(containing_folder, value)
@@ -65,6 +68,16 @@ module Frameit
             raise "Could not find font at path '#{File.expand_path(value)}'" unless File.exists?value
           end
 
+          if key == 'fonts'
+            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
+            end
+          end
+
           if key == 'background'
             raise "Could not find background image at path '#{File.expand_path(value)}'" unless File.exists?value
           end

data/lib/frameit/editor.rb

@@ -92,7 +92,7 @@ module Frameit
           @image = put_into_frame
 
           # Decrease the size of the framed screenshot to fit into the defined padding + background
-          frame_width = background.width - fetch_config['padding'] * 2
+          frame_width = background.width - frame_padding * 2
           image.resize "#{frame_width}x"
         end
 
@@ -105,6 +105,13 @@ module Frameit
         image
       end
 
+      # Padding around the frames
+      def frame_padding
+        multi = 1.0
+        multi = 1.7 if self.screenshot.is_triple_density?
+        return fetch_config['padding'] * multi
+      end
+
       # Returns a correctly sized background image
       def generate_background
         background = MiniMagick::Image.open(fetch_config['background'])
@@ -119,6 +126,7 @@ module Frameit
         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
+        bottom_space -= 50 if (screenshot.is_mini? and screenshot.is_portrait?) # super old devices
 
         self.top_space_above_device = background.height - image.height - bottom_space
 
@@ -184,10 +192,12 @@ module Frameit
             i.resize "#{max_width}x#{image_height}!" # `!` says it should ignore the ratio
           end
 
+          current_font = font(key)
+          Helper.log.debug "Using #{current_font} as font the #{key} of #{screenshot.path}" if $verbose and current_font
+
           # Add the actual title
-          font = fetch_config[key.to_s]['font']
           title_image.combine_options do |i|
-            i.font font if font
+            i.font current_font if current_font
             i.gravity "Center"
             i.pointsize actual_font_size
             i.draw "text 0,0 '#{fetch_text(key)}'"
@@ -226,6 +236,7 @@ module Frameit
 
         # 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
@@ -235,5 +246,30 @@ module Frameit
         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
+              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
+        end
+
+        Helper.log.debug "No custom font specified, using the default one" if $verbose
+        return nil
+      end
   end
 end

data/lib/frameit/offsets.rb

@@ -20,7 +20,12 @@ module Frameit
             when size::IOS_40
               return {
                 'offset' => "+54+197",
-                'width' => 543
+                'width' => 544
+              }
+            when size::IOS_35
+              return {
+                'offset' => "+59+260",
+                'width' => 647
               }
             when size::IOS_IPAD
               return {

data/lib/frameit/runner.rb

@@ -15,19 +15,21 @@ module Frameit
     end
 
     def run(path, color = Color::BLACK)
-      screenshots = Dir.glob("#{path}/**/*.{png,PNG}")
+      screenshots = Dir.glob("#{path}/**/*.{png,PNG}").uniq # uniq because thanks to {png,PNG} there are duplicates
 
       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
           
           begin
             screenshot = Screenshot.new(full_path, color)
             screenshot.frame!
           rescue => ex
             Helper.log.error ex
+            Helper.log.error "Backtrace:\n\t#{ex.backtrace.join("\n\t")}"
           end
         end
       else 

data/lib/frameit/screenshot.rb

@@ -36,6 +36,16 @@ module Frameit
       end
     end
 
+    # Is the device a 3x device? (e.g. 6 Plus)
+    def is_triple_density?
+      (screen_size == Deliver::AppScreenshot::ScreenSize::IOS_55)
+    end
+
+    # Super old devices
+    def is_mini?
+      (screen_size == Deliver::AppScreenshot::ScreenSize::IOS_35)
+    end
+
     def is_mac?
       return device_name == 'Mac'
     end

data/lib/frameit/version.rb

@@ -1,3 +1,3 @@
 module Frameit
-  VERSION = "2.0.1"
+  VERSION = "2.1.0"
 end

metadata

@@ -1,153 +1,153 @@
 --- !ruby/object:Gem::Specification
 name: frameit
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Felix Krause
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-17 00:00:00.000000000 Z
+date: 2015-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fastlane_core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.7.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.7.2
 - !ruby/object:Gem::Dependency
   name: fastimage
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.6.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.6.3
 - !ruby/object:Gem::Dependency
   name: mini_magick
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 4.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 4.0.2
 - !ruby/object:Gem::Dependency
   name: deliver
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>'
+    - - ">"
       - !ruby/object:Gem::Version
         version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>'
+    - - ">"
       - !ruby/object:Gem::Version
         version: '0.3'
 - !ruby/object:Gem::Dependency
   name: bundler
   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: rake
   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: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: pry
   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: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.7.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.7.4
 - !ruby/object:Gem::Dependency
   name: coveralls
   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'
 description: Quickly put your screenshots into the right device frames
@@ -185,17 +185,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Quickly put your screenshots into the right device frames