screengrab 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a9389e49b61448d2e514a577597a2eeabab3a27d
-  data.tar.gz: 5dcce367104bdd340e7326ab5b8afebe8bb2e0f4
+  metadata.gz: 743b0f8af7f0ec6de3aa80d03aa61847db7c8bfb
+  data.tar.gz: 7b7959a8b42f88eca5b1dc2885d78d59f5e95946
 SHA512:
-  metadata.gz: fbd73085c982df0d8bf27b553db09eae485a17fac711bf13d9c1a6e240a5da3bc8f587a9d1dc971109bd9796d93ddc92e94b6a8d1bebc642084a5cb6b4c0db30
-  data.tar.gz: 9e0d0e76b21219e90a182ea87dd7be781e7ba35ac8cfc0df4b3bf150b94ebea6c8ae0c5557396a1e2da33c189ba2a0e633622c5e91d05be89e64ac45f772d9c8
+  metadata.gz: 24dfcd3e54c91a52a1acf5bf863e1117300128e149ce1999855d504fb20c39226a5e89a31725c6692742b6ba9dfe21ca0ada6004ade40ceae628efefbc178a93
+  data.tar.gz: 7e98d055a361f43556567b0d4979ef0aab7eceff03d423a174c07bcb00fe85470a8c0acc0b37b915257fe69e379c7f65b3b3c44768fecc2436588fef658c35f2

data/README.md

@@ -35,6 +35,8 @@ screengrab
 
 ###### Automated localized screenshots of your Android app on every device
 
+`screengrab` generates localized screenshots of your Android app for different device types and languages for Google Play and can be uploaded using ([`supply`](https://github.com/fastlane/fastlane/tree/master/supply).
+
 <img src="assets/running-screengrab.gif" width="640">
 
 ### Why should I automate this process?
@@ -53,7 +55,7 @@ sudo gem install screengrab
 
 ##### Gradle dependency
 ```java
-androidTestCompile 'tools.fastlane:screengrab:0.3.0'
+androidTestCompile 'tools.fastlane:screengrab:0.3.2'
 ```
 
 ##### Configuring your Manifest Permissions
@@ -152,7 +154,7 @@ If you're having trouble getting your device unlocked and the screen activated t
 
 ## [`fastlane`](https://fastlane.tools) Toolchain
 
-- [`fastlane`](https://fastlane.tools): Connect all deployment tools into one streamlined workflow
+- [`fastlane`](https://fastlane.tools): The easiest way to automate building and releasing your iOS and Android apps
 - [`supply`](https://github.com/fastlane/fastlane/tree/master/supply): Upload screenshots, metadata and your app to the Play Store
 
 You can find all the tools on [fastlane.tools](https://fastlane.tools).

data/bin/screengrab

@@ -1,65 +1,6 @@
 #!/usr/bin/env ruby
-
 $:.push File.expand_path("../../lib", __FILE__)
 
 require 'screengrab'
-require 'commander'
-
-HighLine.track_eof = false
-
-class ScreengrabApplication
-  include Commander::Methods
-
-  def run
-    program :version, Screengrab::VERSION
-    program :description, 'CLI for \'screengrab\' - Automate taking localized screenshots of your Android app on emulators or real devices'
-    program :help, 'Authors', 'Andrea Falcone <afalcone@twitter.com>, Michael Furtak <mfurtak@twitter.com>'
-    program :help, 'Website', 'https://fastlane.tools'
-    program :help, 'GitHub', 'https://github.com/fastlane/screengrab'
-    program :help_formatter, :compact
-
-    global_option('--verbose', 'Shows a more verbose output') { $verbose = true }
-
-    always_trace!
-
-    FastlaneCore::CommanderGenerator.new.generate(Screengrab::Options.available_options)
-
-    command :run do |c|
-      c.syntax = 'screengrab'
-      c.description = 'Take new screenshots based on the screengrabfile.'
-
-      c.action do |args, options|
-        o = options.__hash__.dup
-        o.delete(:verbose)
-        Screengrab.config = FastlaneCore::Configuration.create(Screengrab::Options.available_options, o)
-        Screengrab.android_environment = Screengrab::AndroidEnvironment.new(Screengrab.config[:android_home],
-                                                                            Screengrab.config[:build_tools_version])
-
-        Screengrab::DependencyChecker.check(Screengrab.android_environment)
-        Screengrab::Runner.new.run
-      end
-    end
-
-    command :init do |c|
-      c.syntax = 'screengrab init'
-      c.description = "Creates a new Screengrabfile in the current directory"
-
-      c.action do |args, options|
-        require 'screengrab/setup'
-        path = (Screengrab::Helper.fastlane_enabled? ? './fastlane' : '.')
-        Screengrab::Setup.create(path)
-      end
-    end
-
-    default_command :run
-
-    run!
-  end
-end
-
-begin
-  FastlaneCore::UpdateChecker.start_looking_for_update('screengrab')
-  ScreengrabApplication.new.run
-ensure
-  FastlaneCore::UpdateChecker.show_update_status('screengrab', Screengrab::VERSION)
-end
+require 'screengrab/commands_generator'
+Screengrab::CommandsGenerator.start

data/lib/screengrab/commands_generator.rb

@@ -0,0 +1,62 @@
+require 'commander'
+
+HighLine.track_eof = false
+
+module Screengrab
+  class CommandsGenerator
+    include Commander::Methods
+
+    def self.start
+      FastlaneCore::UpdateChecker.start_looking_for_update('screengrab')
+      self.new.run
+    ensure
+      FastlaneCore::UpdateChecker.show_update_status('screengrab', Screengrab::VERSION)
+    end
+
+    def run
+      program :version, Screengrab::VERSION
+      program :description, 'CLI for \'screengrab\' - Automate taking localized screenshots of your Android app on emulators or real devices'
+      program :help, 'Authors', 'Andrea Falcone <afalcone@twitter.com>, Michael Furtak <mfurtak@twitter.com>'
+      program :help, 'Website', 'https://fastlane.tools'
+      program :help, 'GitHub', 'https://github.com/fastlane/screengrab'
+      program :help_formatter, :compact
+
+      global_option('--verbose', 'Shows a more verbose output') { $verbose = true }
+
+      always_trace!
+
+      FastlaneCore::CommanderGenerator.new.generate(Screengrab::Options.available_options)
+
+      command :run do |c|
+        c.syntax = 'screengrab'
+        c.description = 'Take new screenshots based on the screengrabfile.'
+
+        c.action do |args, options|
+          o = options.__hash__.dup
+          o.delete(:verbose)
+          Screengrab.config = FastlaneCore::Configuration.create(Screengrab::Options.available_options, o)
+          Screengrab.android_environment = Screengrab::AndroidEnvironment.new(Screengrab.config[:android_home],
+                                                                              Screengrab.config[:build_tools_version])
+
+          Screengrab::DependencyChecker.check(Screengrab.android_environment)
+          Screengrab::Runner.new.run
+        end
+      end
+
+      command :init do |c|
+        c.syntax = 'screengrab init'
+        c.description = "Creates a new Screengrabfile in the current directory"
+
+        c.action do |args, options|
+          require 'screengrab/setup'
+          path = (Screengrab::Helper.fastlane_enabled? ? './fastlane' : '.')
+          Screengrab::Setup.create(path)
+        end
+      end
+
+      default_command :run
+
+      run!
+    end
+  end
+end

data/lib/screengrab/runner.rb

@@ -230,20 +230,24 @@ module Screengrab
 
       UI.verbose("Starting screenshot count is: #{starting_screenshot_count}")
 
-      device_screenshots_paths.each do |device_path|
-        if_device_path_exists(device_serial, device_path) do |path|
-          @executor.execute(command: "adb -s #{device_serial} pull #{path} #{@config[:output_directory]}",
-                            print_all: false,
-                            print_command: true)
+      # Make a temp directory into which to pull the screenshots before they are moved to their final location.
+      # This makes directory cleanup easier, as the temp directory will be removed when the block completes.
+      Dir.mktmpdir do |tempdir|
+        device_screenshots_paths.each do |device_path|
+          if_device_path_exists(device_serial, device_path) do |path|
+            @executor.execute(command: "adb -s #{device_serial} pull #{path} #{tempdir}",
+                              print_all: false,
+                              print_command: true)
+          end
         end
-      end
 
-      # The SDK can't 100% determine what kind of device it is running on relative to the categories that
-      # supply and Google Play care about (phone, 7" tablet, TV, etc.).
-      #
-      # Therefore, we'll move the pulled screenshots from their genericly named folder to one named by the
-      # user provided device_type option value to match the directory structure that supply expects
-      move_pulled_screenshots(device_type_dir_name)
+        # The SDK can't 100% determine what kind of device it is running on relative to the categories that
+        # supply and Google Play care about (phone, 7" tablet, TV, etc.).
+        #
+        # Therefore, we'll move the pulled screenshots from their genericly named folder to one named by the
+        # user provided device_type option value to match the directory structure that supply expects
+        move_pulled_screenshots(tempdir, device_type_dir_name)
+      end
 
       ending_screenshot_count = screenshot_file_names_in(@config[:output_directory], device_type_dir_name).length
 
@@ -259,23 +263,34 @@ module Screengrab
       ending_screenshot_count - starting_screenshot_count
     end
 
-    def move_pulled_screenshots(device_type_dir_name)
+    def move_pulled_screenshots(pull_dir, device_type_dir_name)
       # Glob pattern that finds the pulled screenshots directory for each locale
-      # (Matches: fastlane/metadata/android/en-US/images/screenshots)
-      screenshots_dir_pattern = File.join(@config[:output_directory], '**', "screenshots")
+      # Possible matches:
+      #   [pull_dir]/en-US/images/screenshots
+      #   [pull_dir]/screengrab/en-US/images/screenshots
+      screenshots_dir_pattern = File.join(pull_dir, '**', "screenshots")
 
       Dir.glob(screenshots_dir_pattern, File::FNM_CASEFOLD).each do |screenshots_dir|
         src_screenshots = Dir.glob(File.join(screenshots_dir, '*.png'), File::FNM_CASEFOLD)
 
-        # We move the screenshots by replacing the last segment of the screenshots directory path with
-        # the device_type specific name
+        # The :output_directory is the final location for the screenshots, so we begin by replacing
+        # the temp directory portion of the path, with the output directory
+        dest_dir = screenshots_dir.gsub(pull_dir, @config[:output_directory])
+
+        # Different versions of adb are inconsistent about whether they will pull down the containing
+        # directory for the screenshots, so we'll try to remove that path from the directory name when
+        # creating the destination path.
+        # See: https://github.com/fastlane/fastlane/pull/4915#issuecomment-236368649
+        dest_dir = dest_dir.gsub('screengrab/', '')
+
+        # We then replace the last segment of the screenshots directory path with the device_type
+        # specific name, as expected by supply
         #
         # (Moved to: fastlane/metadata/android/en-US/images/phoneScreenshots)
-        dest_dir = File.join(File.dirname(screenshots_dir), device_type_dir_name)
+        dest_dir = File.join(File.dirname(dest_dir), device_type_dir_name)
 
         FileUtils.mkdir_p(dest_dir)
         FileUtils.cp_r(src_screenshots, dest_dir)
-        FileUtils.rm_r(screenshots_dir)
         UI.success "Screenshots copied to #{dest_dir}"
       end
     end

data/version.properties

@@ -1,3 +1,3 @@
 major=0
-minor=3
-patch=2
+minor=4
+patch=0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: screengrab
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Andrea Falcone
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-07 00:00:00.000000000 Z
+date: 2016-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fastlane_core
@@ -199,6 +199,7 @@ files:
 - lib/assets/ScreengrabfileTemplate
 - lib/screengrab.rb
 - lib/screengrab/android_environment.rb
+- lib/screengrab/commands_generator.rb
 - lib/screengrab/dependency_checker.rb
 - lib/screengrab/detect_values.rb
 - lib/screengrab/options.rb