snapshot 0.10.2 → 1.0.1

data/lib/snapshot/simulators.rb

@@ -1,40 +0,0 @@
-require 'open3'
-
-module Snapshot
-  class Simulators
-    # @return the raw value of the `instruments -s` command
-    # we do it using `open3` since only ` just randomly hangs with instruments -s
-    def self.raw_simulators
-      return @result if @result
-
-      Open3.popen3('instruments -s') do |stdin, stdout, stderr, wait_thr|
-        @result = stdout.read
-      end
-      
-      @result || ''
-    end
-
-    def self.available_devices(name_only = false)
-      Helper.log.info "Fetching available devices" if $verbose
-      result = []
-      
-      output = self.raw_simulators
-
-      output.split("\n").each do |current|
-        # Example: "iPhone 5 (8.1 Simulator) [C49ECC4A-5A3D-44B6-B9BF-4E25BC326400]"
-        # Example: "iPhone 6 (9.0) [072E4EA2-861F-44CD-AB77-FB1FE07E541C]"
-        
-        match = current.match /((.+?) \(.+?\)) \[.+?\]/
-        next if match.nil?
-        
-        if name_only
-          result << match[2]
-        else
-          result << match[1]
-        end
-      end
-
-      return result
-    end
-  end
-end

data/lib/snapshot/snapfile_creator.rb

@@ -1,21 +0,0 @@
-module Snapshot
-  class SnapfileCreator
-    # This method will take care of creating a Snapfile
-    def self.create(path)
-      snapfile_path = File.join(path, 'Snapfile')
-
-      raise "Snapfile already exists at path '#{snapfile_path}'. Run 'snapshot' to use Snapshot.".red if File.exists?(snapfile_path)
-
-      gem_path = Helper.gem_path("snapshot")
-      File.write(snapfile_path, File.read("#{gem_path}/lib/assets/SnapfileTemplate"))
-      File.write([path, 'snapshot.js'].join('/'), File.read("#{gem_path}/lib/assets/snapshot.js"))
-      File.write([path, 'snapshot-iPad.js'].join('/'), File.read("#{gem_path}/lib/assets/snapshot.js"))
-      File.write([path, 'SnapshotHelper.js'].join('/'), File.read("#{gem_path}/lib/assets/SnapshotHelper.js"))
-
-      puts "Successfully created SnapshotHelper.js '#{File.join(path, 'SnapshotHelper.js')}'".green
-      puts "Successfully created new UI Automation JS file at '#{File.join(path, 'snapshot.js')}'".green
-      puts "Successfully created new UI Automation JS file for iPad at '#{File.join(path, 'snapshot-iPad.js')}'".green
-      puts "Successfully created new Snapfile at '#{snapfile_path}'".green
-    end
-  end
-end

data/lib/snapshot/snapshot_config.rb

@@ -1,233 +0,0 @@
-module Snapshot
-  class SnapshotConfig
-    
-    # @return (SnapshotFile)
-    attr_accessor :snapshot_file
-
-    # @return (Array) List of simulators to use
-    attr_accessor :devices
-
-    # @return (Array) A list of languages which should be used
-    attr_accessor :languages
-    
-    # @return (String) The iOS version (e.g. 8.1)
-    attr_accessor :ios_version
-
-    # @return (String) The path to the project/workspace
-    attr_accessor :project_path
-
-    # @return (String) The name of a scheme, manually set by the user using the config file
-    attr_accessor :manual_scheme
-
-    # @return (String) The path to the JavaScript file to use
-    attr_accessor :manual_js_file
-
-    # @return (String) The path, in which the screenshots should be stored
-    attr_accessor :screenshots_path
-
-    # @return (String) The build command, wich should build the app to build_dir (/tmp/snapshot by default)
-    attr_accessor :build_command
-
-    # @return (String) The build directory, defaults to '/tmp/snapshot'
-    attr_accessor :build_dir
-
-    # @return (BOOL) Skip the removal of the alpha channel from the screenshots
-    attr_accessor :skip_alpha_removal
-
-    # @return (BOOL) Clear previously generated screenshots before creating new ones
-    attr_accessor :clear_previous_screenshots
-
-    # @return (String) This will be prepended before the actual build command
-    attr_accessor :custom_args
-    
-    # @return (String) This will be appended to the actual build command
-    attr_accessor :custom_build_args
-
-    # @return (String) This will be appended to the run command
-    attr_accessor :custom_run_args
-
-    # @return (Hash) All the blocks, which are called on specific actions
-    attr_accessor :blocks
-
-    attr_accessor :html_title
-
-
-    # A shared singleton
-    def self.shared_instance(path = nil)
-      @@instance ||= SnapshotConfig.new(path)
-    end
-
-    # @param path (String) the path to the config file to use (including the file name)
-    def initialize(path = nil)
-      DependencyChecker.check_simulators
-      path ||= './Snapfile'
-      set_defaults
-
-      if File.exists?path
-        Helper.log.info "Using '#{path}'".green if $verbose
-        self.snapshot_file = SnapshotFile.new(path, self)
-
-        self.verify_devices
-      else
-        if path != './Snapfile'
-          raise "Could not find Snapfile at path '#{path}'. Make sure you pass the full path, including 'Snapfile'".red
-        else
-          # Using default settings, since user didn't provide a path
-          Helper.log.error "Could not find './Snapfile'. It is recommended to create a file using 'snapshot init' into the current directory. Using the defaults now.".red
-          self.verify_devices
-        end
-      end
-
-      load_env
-    end
-
-    def set_defaults
-      self.ios_version = Snapshot::LatestIosVersion.version
-
-      self.languages = [
-        'de-DE',
-        'en-US'
-      ]
-
-      self.screenshots_path = './screenshots'
-
-      folders = ["./*.xcworkspace"] # we prefer workspaces
-      folders << "./*.xcodeproj"
-      folders << "../*.xcworkspace"
-      folders << "../*.xcodeproj"
-
-      folders.each do |current|
-        self.project_path ||= (File.expand_path(Dir[current].first) rescue nil)
-      end
-
-      empty = Proc.new {}
-      self.blocks = {
-        setup_for_device_change: empty, 
-        teardown_device: empty,
-        setup_for_language_change: empty,
-        teardown_language: empty
-      }
-
-      self.html_title = self.project_name || 'KrauseFx/snapshot'
-
-    end
-
-    # This has to be done after parsing the Snapfile (iOS version)
-    def set_default_simulators
-      self.devices ||= [
-        "iPhone 6" + version_suffix(self.ios_version),
-        "iPhone 6 Plus" + version_suffix(self.ios_version),
-        "iPhone 5" + version_suffix(self.ios_version),
-        "iPhone 4s" + version_suffix(self.ios_version),
-      ]
-    end
-
-    # This method takes care of appending the iOS version to the simulator name
-    def verify_devices
-      self.set_default_simulators
-
-      actual_devices = []
-      self.devices.each do |current|
-        current += version_suffix(self.ios_version) unless current.include? " ("
-
-        if Simulators.available_devices.include? current
-          actual_devices << current
-        else
-          raise "Device '#{current}' not found. Available device types: #{Simulators.available_devices}".red
-        end
-      end
-      self.devices = actual_devices
-    end
-
-    def load_env
-      # Load environment variables
-      self.manual_scheme = ENV["SNAPSHOT_SCHEME"] if ENV["SNAPSHOT_SCHEME"]
-      self.screenshots_path = ENV["SNAPSHOT_SCREENSHOTS_PATH"] if ENV["SNAPSHOT_SCREENSHOTS_PATH"]
-    end
-
-    # Getters
-
-    # Returns the file name of the project
-    def project_name
-      File.basename(self.project_path, ".*" ) if self.project_path
-    end
-
-    # The JavaScript UIAutomation file
-    def js_file(ipad = false)
-      return ENV["SNAPSHOT_JS_FILE"] if ENV["SNAPSHOT_JS_FILE"]
-      
-      result = manual_js_file
-
-      unless result
-        files = Dir.glob("./*.js").delete_if { |path| (path.include?"SnapshotHelper.js" or path.include?"iPad.js") }
-        if files.count == 1
-          result = files.first
-        end
-      end
-
-      if ipad
-        ipad_file = result.split('.js').join('/') + '-iPad.js'
-        if File.exists?(ipad_file)
-          result = ipad_file
-        end
-      end
-
-      unless File.exists?(result || '')
-        raise "Could not determine which UIAutomation file to use. Please pass a path to your Javascript file using 'js_file'.".red
-      end
-
-      return result
-    end
-
-    # The scheme to use (either it's set, or there is only one, or user has to enter it)
-    def scheme
-      begin
-        project_key = 'project'
-        project_key = 'workspace' if project_path.end_with?'.xcworkspace'
-        command = "xcodebuild -#{project_key} '#{project_path}' -list"
-        Helper.log.debug command if $verbose
-        
-        schemes = `#{command}`.split("Schemes:").last.split("\n").each { |a| a.strip! }.delete_if { |a| a == '' }
-        
-        Helper.log.debug "Found available schemes: #{schemes}" if $verbose
-
-        self.manual_scheme = schemes.first if schemes.count == 1
-
-        if self.manual_scheme
-          if not schemes.include?manual_scheme
-            raise "Could not find requested scheme '#{self.manual_scheme}' in Xcode's schemes #{schemes}"
-          else
-            return self.manual_scheme
-          end
-        else
-          # We have to ask the user first
-          puts "Found the following schemes in your project:".green
-          puts "You can use 'scheme \"Name\"' in your Snapfile".green
-          puts "--------------------------------------------".green
-          while not schemes.include?self.manual_scheme
-            schemes.each_with_index do |current, index|
-              puts "#{index + 1}) #{current}"
-            end
-            val = gets.strip.to_i
-            if val > 0
-              self.manual_scheme = (schemes[val - 1] rescue nil)
-            end
-          end
-          return self.manual_scheme
-        end
-      rescue => ex
-        raise "Could not fetch available schemes: #{ex}".red
-      end
-    end
-
-    def version_suffix version
-      # Xcode 6 and before: "iPhone 5 (8.0 Simulator)"
-      # Xcode 7 and later: "iPhone 6 (9.0)"
-      if LatestIosVersion.version.to_i >= 9
-        " (#{version})"
-      else
-        " (#{version} Simulator)"
-      end
-    end
-  end
-end

data/lib/snapshot/snapshot_file.rb

@@ -1,87 +0,0 @@
-module Snapshot
-  class SnapshotFile
-
-    # @return (String) The path to the used Deliverfile.
-    attr_accessor :path
-
-    # @param path (String) the path to the config file to use (including the file name)
-    def initialize(path, config)
-      raise "Config file not found at path '#{path}'".red unless File.exists?(path.to_s)
-
-      self.path = path
-
-      @config = config
-
-      eval(File.read(self.path))
-    end
-
-    def method_missing(method_sym, *arguments, &block)
-      if ["setup", "teardown"].any?{|a| method_sym.to_s.include?a }
-        value = nil # this is a block
-      else
-        value = arguments.first || (block.call if block_given?) # this is either a block or a value
-      end
-
-      case method_sym
-        when :devices
-          raise "Devices has to be an array".red unless value.kind_of?Array
-          @config.devices = value
-        when :languages
-          @config.languages = value
-        when :ios_version
-          raise "ios_version has to be an String".red unless value.kind_of?String
-          @config.ios_version = value
-        when :scheme
-          raise "scheme has to be an String".red unless value.kind_of?String
-          @config.manual_scheme = value
-        when :js_file
-          raise "js_file has to be an String".red unless value.kind_of?String
-          raise "js_file at path '#{value}' not found".red unless File.exists?value
-          @config.manual_js_file = File.expand_path(value)
-        when :screenshots_path
-          raise "screenshots_path has to be an String".red unless value.kind_of?String
-          @config.screenshots_path = File.expand_path(value)
-        when :build_command
-          raise "build_command has to be an String".red unless value.kind_of?String
-          @config.build_command = value
-        when :build_dir
-          raise "build_dir has to be an String".red unless value.kind_of?String
-          @config.build_dir = File.expand_path(value)
-        when :custom_args
-          raise "custom_args has to be an String".red unless value.kind_of?String
-          @config.custom_args = value
-        when :custom_build_args
-          raise "custom_build_args has to be an String".red unless value.kind_of?String
-          @config.custom_build_args = value
-        when :custom_run_args
-          raise "custom_run_args has to be an String".red unless value.kind_of?String
-          @config.custom_run_args = value
-        when :skip_alpha_removal
-          @config.skip_alpha_removal = true
-        when :clear_previous_screenshots
-          @config.clear_previous_screenshots = true
-        when :project_path
-          raise "project_path has to be an String".red unless value.kind_of?String
-
-          path = File.expand_path(value)
-          if File.exists?path and (path.end_with?".xcworkspace" or path.end_with?".xcodeproj")
-            @config.project_path = path
-          else
-            raise "The given project_path '#{path}' could not be found. Make sure to include the extension as well.".red
-          end
-        when :html_path
-          raise "The `html_path` options was removed from snapshot. The default location is now the screenshots path. Please remove this line from your 'Snapfile'.".red
-        # Blocks
-        when :setup_for_device_change, :teardown_device, :setup_for_language_change, :teardown_language
-          raise "#{method_sym} needs to have a block provided." unless block_given?
-          Helper.log.warn("'setup_for_language_change' and 'teardown_language' are deprecated.".yellow) if [:setup_for_language_change, :teardown_language].include?method_sym
-          @config.blocks[method_sym] = block
-        when :html_title 
-          raise "html_title has to be an String".red unless value.kind_of?String
-          @config.html_title = value
-        else
-          Helper.log.error "Unknown method #{method_sym}"
-        end
-    end
-  end
-end