frameit 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c760029195536b3059b16d0bdb3e8978e4a4e49
-  data.tar.gz: 2547179f82e1d7728f7ff5606124ba5a1831443a
+  metadata.gz: 282b80c6a1c36585b03f673281420a00cb2a6199
+  data.tar.gz: c6a680cb4695176fa45a502de590910d4b375756
 SHA512:
-  metadata.gz: 9e7efcc8cb1a18f852e2e68821150e992fda318759ee112d417c4827dc03d280121a167c146ee53d5a110b159e15090ff116b6dde9ca1f47febba82e7824a71c
-  data.tar.gz: 4f00d02e58cbea96fbf51c0bbbea7bbfacc501b83c040103412f19019be7611b50a9dc770b0de54aa949febc600cf9ec39a9c45f70d8a6f1dfc00bb27f492023
+  metadata.gz: 24064baaba326038de4a40f1013b7a8af47e8591ec8538f1abb4bed5b911335232f799a70a90304a3f5323fc120650a6c14ab69334f2855efcf8084a3f6a09b9
+  data.tar.gz: 15fbdbcbca9d926b69ae115ff955139bcfbe78cdeef5d2fe179f5fa59ad285227d288de235f4da6f5115d96dd04c8ae50ad6d08c33e1de99a37b3d51e27cc315

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Felix Krause
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,98 @@
+<p align="center">
+  <a href="https://github.com/KrauseFx/deliver">Deliver</a> &bull; 
+  <a href="https://github.com/KrauseFx/snapshot">Snapshot</a> &bull; 
+  <b>FrameIt</b>
+</p>
+-------
+
+<p align="center">
+    <img src="assets/frameit.png">
+</p>
+
+FrameIt - Add gorgeous device frames around your screenshots
+============
+
+[![Twitter: @KauseFx](https://img.shields.io/badge/contact-@KrauseFx-blue.svg?style=flat)](https://twitter.com/KrauseFx)
+[![License](http://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://github.com/KrauseFx/frameit/blob/master/LICENSE)
+[![Gem](https://img.shields.io/gem/v/frameit.svg?style=flat)](http://rubygems.org/gems/frameit)
+
+Want a device frame around your screenshot? Do it in an instant!
+
+Follow the developer on Twitter: [@KrauseFx](https://twitter.com/KrauseFx)
+
+
+-------
+[Features](#features) &bull;
+[Installation](#installation) &bull;
+[Usage](#usage) &bull;
+[Tips](#tips) &bull;
+[Need help?](#need-help)
+
+-------
+
+
+# Features
+
+Put a gorgeous device frame around your iOS screenshots just by running one simple command. Support for:
+- iPhone 6 Plus, iPhone 6, iPhone 5s and iPad Air
+- Portrait and Landscape
+- Black and Silver devices
+
+Here is a nice gif, that shows ```frameit``` in action:
+
+![assets/FrameitGit.gif](assets/FrameitGit.gif)
+
+Here is how the result can look like
+![assets/Overview.png](assets/Overview.png)
+
+# Installation
+
+Install the gem
+
+    sudo gem install frameit
+
+Because of legal reasons, I can not pre-package the device frames with ```FrameIt```.
+
+The process of adding is really easy, just run ```frameit``` and the guide will help you set it up.
+You only have to do this once per computer.
+
+- Run ```frameit```
+- Press ```Enter```. The [Apple page](https://developer.apple.com/app-store/marketing/guidelines/#images) to download the images should open in your browser.
+- Download the devices you want to use
+- Press ```Enter```
+- Unzip and move the content of the zip files to ```~/.frameit/device_frames```
+- Press ```Enter```
+  
+# Usage
+
+Why should you have to use Photoshop, just to add a frame around your screenshots?
+
+Just navigate to your folder of screenshots and try the following:
+
+- ```frameit```
+- ```frameit silver```
+
+# Tips
+
+## Use a clean status bar
+You can use [SimulatorStatusMagic](https://github.com/shinydevelopment/SimulatorStatusMagic) to clean up the status bar.
+
+## Uninstall
+- ```sudo gem uninstall frameit```
+- ```rm -rf ~/.frameit```
+
+# Need help?
+- If there is a technical problem with ```FrameIt```, submit an issue. Run ```frameit --trace``` to get the stacktrace.
+- I'm available for contract work - drop me an email: frameit@felixkrause.at
+
+# License
+This project is licensed under the terms of the MIT license. See the LICENSE file.
+
+# Contributing
+
+1. Create an issue to discuss about your idea
+2. Fork it (https://github.com/KrauseFx/frameit/fork)
+3. Create your feature branch (`git checkout -b my-new-feature`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request

data/bin/frameit

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+
+$:.push File.expand_path("../../lib", __FILE__)
+
+require 'frameit'
+require 'commander/import'
+require 'frameit/update_checker'
+require 'frameit/dependency_checker'
+
+HighLine.track_eof = false
+
+
+# Commander
+program :version, Frameit::VERSION
+program :description, 'Find all screenshots in current folder and put a nice frame around it. This will duplicate the images.'
+program :help, 'Author', 'Felix Krause <krausefx@gmail.com>'
+program :help, 'Website', 'http://felixkrause.at'
+program :help, 'GitHub', 'https://github.com/krausefx/frameit'
+program :help_formatter, :compact
+
+global_option('--verbose') { $verbose = true }
+
+
+Frameit::UpdateChecker.verify_latest_version
+
+default_command :black
+
+
+command :black do |c|
+  c.syntax = 'frameit black'
+
+  c.action do |args, options|
+    Frameit::DependencyChecker.check_dependencies
+    Frameit::Editor.new.run('.', Frameit::Editor::Color::BLACK)
+  end
+end
+
+command :silver do |c|
+  c.syntax = 'frameit silver'
+  
+  c.action do |args, options|
+    Frameit::DependencyChecker.check_dependencies
+    Frameit::Editor.new.run('.', Frameit::Editor::Color::SILVER)
+  end
+end
+
+alias_command :white, :silver
+
+def shared_run(c)
+  c.description = 'Find all screenshots in current folder and put a nice frame around it. This will duplicate the images.'
+end

data/lib/frameit.rb

@@ -0,0 +1,14 @@
+require 'json'
+require 'mini_magick'
+require 'frameit/version'
+require 'frameit/helper'
+require 'frameit/frame_converter'
+require 'frameit/editor'
+require 'deliver'
+
+# Third Party code
+require 'colored'
+
+module Frameit
+  
+end

data/lib/frameit/dependency_checker.rb

@@ -0,0 +1,29 @@
+module Frameit
+  class DependencyChecker
+    def self.check_dependencies
+      self.check_image_magick
+      # self.check_xctool
+    end
+
+    def self.check_image_magick
+      unless `which convert`.include?"convert"
+        Helper.log.fatal '#############################################################'
+        Helper.log.fatal "# You have to install the ImageMagick to use FrameIt"
+        Helper.log.fatal "# Install it using 'brew update && brew install imagemagick'"
+        Helper.log.fatal "# If you don't have homebrew: http://brew.sh"
+        Helper.log.fatal '#############################################################'
+        raise "Install ImageMagick and start frameit again!"
+      end
+    end
+
+    # def self.check_xctool
+    #   if not self.xctool_installed?
+    #     Helper.log.error '#############################################################'
+    #     Helper.log.error "# xctool is recommended to build the apps"
+    #     Helper.log.error "# Install it using 'brew install xctool'"
+    #     Helper.log.error "# Falling back to xcode build instead "
+    #     Helper.log.error '#############################################################'
+    #   end
+    # end
+  end
+end

data/lib/frameit/editor.rb

@@ -0,0 +1,155 @@
+require 'fastimage'
+
+module Frameit
+  class Editor
+    module Color
+      BLACK = "SpaceGray"
+      SILVER = "Slvr"
+    end
+
+    module Orientation
+      PORTRAIT = "Vert"
+      LANDSCAPE = "Horz"
+    end
+
+
+    def initialize
+      FrameConverter.new.run
+    end
+
+    def run(path, color = Color::BLACK)
+      @color = color
+
+      Dir["#{path}/**/*.png"].each do |screenshot|
+        next if screenshot.include?"_framed.png"
+        begin
+          template_path = get_template(screenshot)
+          if template_path
+            template = MiniMagick::Image.open(template_path)
+            image = MiniMagick::Image.open(screenshot)
+
+            offset_information = image_offset(screenshot)
+            raise "Could not find offset_information for '#{screenshot}'" unless (offset_information and offset_information[:width])
+            width = offset_information[:width]
+            image.resize width
+
+            result = template.composite(image) do |c|
+              c.compose "Over"
+              c.geometry offset_information[:offset]
+            end
+
+            output_path = screenshot.gsub('.png', '_framed.png')
+            result.write output_path
+            Helper.log.info "Successfully framed screenshots at path '#{output_path}'".green
+          end
+        rescue Exception => ex
+          Helper.log.error ex
+        end
+      end
+    end
+
+    # This will detect the screen size and choose the correct template
+    def get_template(path)
+      parts = [
+        device_name(screen_size(path)),
+        orientation_name(path),
+        @color
+      ]
+
+      templates_path = [ENV['HOME'], FrameConverter::FRAME_PATH].join('/')
+      templates = Dir["#{templates_path}/**/#{parts.join('_')}*.png"]
+
+      if templates.count == 0
+        if screen_size(path) == Deliver::AppScreenshot::ScreenSize::IOS_35
+          Helper.log.warn "Unfortunately 3.5\" device frames were discontinued. Skipping screen '#{path}'".yellow
+        else
+          Helper.log.error "Could not find a valid template for screenshot '#{path}'".red
+          Helper.log.error "You can download new templates from '#{FrameConverter::DOWNLOAD_URL}'"
+          Helper.log.error "and store them in '#{templates_path}'"
+          Helper.log.error "Missing file: '#{parts.join('_')}.psd'".red
+        end
+        return nil
+      else
+        # Helper.log.debug "Found template '#{templates.first}' for screenshot '#{path}'"
+        return templates.first.gsub(" ", "\ ")
+      end
+    end
+
+    private
+      def screen_size(path)
+        Deliver::AppScreenshot.calculate_screen_size(path)
+      end
+
+      def device_name(screen_size)
+        size = Deliver::AppScreenshot::ScreenSize
+        case screen_size
+          when size::IOS_55
+            return 'iPhone_6_Plus'
+          when size::IOS_47
+            return 'iPhone_6'
+          when size::IOS_40
+            return 'iPhone_5s'
+          when size::IOS_IPAD
+            return 'iPad_Air'
+        end
+      end
+
+      def orientation_name(path)
+        size = FastImage.size(path)
+        return Orientation::PORTRAIT if size[0] < size[1]
+        return Orientation::LANDSCAPE
+      end
+
+      def image_offset(path)
+        size = Deliver::AppScreenshot::ScreenSize
+        case orientation_name(path)
+          when Orientation::PORTRAIT
+            case screen_size(path)
+              when size::IOS_55
+                return { 
+                  offset: '+42+147',
+                  width: 539
+                }
+              when size::IOS_47
+                return {
+                  offset: '+41+154',
+                  width: 530
+                }
+              when size::IOS_40
+                return {
+                  offset: "+54+197",
+                  width: 543
+                }
+              when size::IOS_IPAD
+                return {
+                  offset: '+57+112',
+                  width: 765
+                }
+            end
+          when Orientation::LANDSCAPE
+            case screen_size(path)
+              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_IPAD
+                return {
+                  offset: '+113+57',
+                  width: 1024
+                }
+            end
+        end
+      end
+  end
+end

data/lib/frameit/frame_converter.rb

@@ -0,0 +1,77 @@
+module Frameit
+  class FrameConverter
+    DOWNLOAD_URL = 'https://developer.apple.com/app-store/marketing/guidelines/#images'
+    FRAME_PATH = '.frameit/devices_frames'
+    
+    def run
+      @templates_path = "#{ENV['HOME']}/#{FRAME_PATH}"
+
+      self.setup_frames
+    end
+
+    def templates_path
+      @templates_path
+    end
+
+    def setup_frames
+      unless frames_exist?
+        puts "----------------------------------------------------".green
+        puts "Looks like you have no device templates installed".green
+        puts "The images can not be pre-installed due to licensing".green
+        puts "Press Enter to get started".green
+        puts "----------------------------------------------------".green
+        STDIN.gets
+        
+        system("open '#{DOWNLOAD_URL}'")
+        puts "----------------------------------------------------".green
+        puts "Download the zip files for the following devices".green
+        puts "iPhone 6, iPhone 6 Plus, iPhone 5s and iPad Air".green
+        puts "You only need to download the devices you want to use".green
+        puts "Press Enter when you downloaded the zip files".green
+        puts "----------------------------------------------------".green
+        STDIN.gets
+
+        while not frames_exist?
+          system("mkdir -p '#{@templates_path}' && open '#{@templates_path}'")
+          puts "----------------------------------------------------".green
+          puts "Extract the downloaded files into the folder".green
+          puts "'#{@templates_path}', which should be open in your Finder'".green
+          puts "You can just copy the whole content into it.'".green
+          puts "The structure doesn't matter.".green
+          puts "Press Enter when you downloaded the zip files".green
+          puts "----------------------------------------------------".green
+          STDIN.gets
+
+          if not frames_exist?
+            puts "Sorry, I can't find the PSD files. Make sure you unzipped them into '#{@templates_path}'".red
+          end
+        end
+      end
+
+      convert_frames
+    end
+
+    def frames_exist?
+      Dir["#{@templates_path}/**/*.psd"].count > 0
+    end
+
+    # Converts all the PSD files to trimmed PNG files
+    def convert_frames
+      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
+        end
+      end
+    end
+  end
+end

data/lib/frameit/helper.rb

@@ -0,0 +1,51 @@
+require 'logger'
+
+module Frameit
+  class Helper
+
+
+    # Logging happens using this method
+    def self.log
+      if is_test?
+        @@log ||= Logger.new(STDOUT) # don't show any logs when running tests
+      else
+        @@log ||= Logger.new(STDOUT)
+      end
+
+      @@log.formatter = proc do |severity, datetime, progname, msg|
+        string = "#{severity} [#{datetime.strftime('%Y-%m-%d %H:%M:%S.%2N')}]: "
+        second = "#{msg}\n"
+
+        if severity == "DEBUG"
+          string = string.magenta
+        elsif severity == "INFO"
+          string = string.white
+        elsif severity == "WARN"
+          string = string.yellow
+        elsif severity == "ERROR"
+          string = string.red
+        elsif severity == "FATAL"
+          string = string.red.bold
+        end
+
+
+        [string, second].join("")
+      end
+
+      @@log
+    end
+
+    # @return true if the currently running program is a unit test
+    def self.is_test?
+      defined?SpecHelper
+    end
+
+    # @return the full path to the Xcode developer tools of the currently
+    #  running system
+    def self.xcode_path
+      return "" if self.is_test? and not OS.mac?
+      `xcode-select -p`.gsub("\n", '') + "/"
+    end
+
+  end
+end

data/lib/frameit/update_checker.rb

@@ -0,0 +1,45 @@
+require 'open-uri'
+
+module Frameit
+  # Verifies, the user runs the latest version of this gem
+  class UpdateChecker
+    # This method will check if the latest version is installed and show a warning if that's not the case
+    def self.verify_latest_version
+      if self.update_available?
+        v = fetch_latest
+        puts '#######################################################################'.green
+        puts "# FrameIt #{v} is available.".green
+        puts "# It is recommended to use the latest version.".green
+        puts "# Update using '(sudo) gem update frameit'.".green
+        puts "# To see what's new, open https://github.com/KrauseFx/frameit/releases.".green
+        puts '#######################################################################'.green
+        return true
+      end
+      false
+    end
+
+    # Is a new official release available (this does not include pre-releases)
+    def self.update_available?
+      begin
+        latest = fetch_latest
+        if latest and Gem::Version.new(latest) > Gem::Version.new(current_version)
+          return true
+        end
+      rescue Exception => ex
+        Helper.log.debug(ex)
+        Helper.log.error("Could not check if 'frameit' is up to date.")
+      end
+      return false
+    end
+
+    # The currently used version of this gem
+    def self.current_version
+      Frameit::VERSION
+    end
+
+    private
+      def self.fetch_latest
+        JSON.parse(open("http://rubygems.org/api/v1/gems/frameit.json").read)["version"]
+      end
+  end
+end

data/lib/frameit/version.rb

@@ -0,0 +1,3 @@
+module Frameit
+  VERSION = "0.1.0"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: frameit
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Felix Krause
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-11 00:00:00.000000000 Z
+date: 2014-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.8.1
+- !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
@@ -182,10 +196,21 @@ description: Take the pain out of using Photoshop, just to add a device around y
   screenshot.
 email:
 - krausefx@gmail.com
-executables: []
+executables:
+- frameit
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- LICENSE
+- README.md
+- bin/frameit
+- lib/frameit.rb
+- lib/frameit/dependency_checker.rb
+- lib/frameit/editor.rb
+- lib/frameit/frame_converter.rb
+- lib/frameit/helper.rb
+- lib/frameit/update_checker.rb
+- lib/frameit/version.rb
 homepage: http://felixkrause.at
 licenses:
 - MIT