motion-macos-screenshothelper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d53c26fc23d123da23be8e88e87f93f6bad72326
+  data.tar.gz: 41afb45a500129d76e7ca0003716048063050742
+SHA512:
+  metadata.gz: 3155828d0ceff7e31e78d8ecf02bbc8b944631d9a3658b1c655d57ca651fb591cf322daf55d7eb5a9f1862cfa902e158d83f8f87cc6f67c539359cc3979b397e
+  data.tar.gz: 82917f750b210a870cbc20a774a4bb19392dd3f73e0e802e46a20a7c226a8b9b07f364d0b7f3c2c5aa7ec711f09ff0b7f640e70b1537993a84730ee643de2c51

data/README.md

@@ -0,0 +1,56 @@
+# motion-macos-screenshothelper
+
+A gem for taking automated screenshots in macOS applications written in Rubymotion.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'motion-macos-screenshothelper'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install motion-macos-screenshothelper
+
+## Usage
+
+Add the ScreenshotHelper tool to your spec files like so:
+
+```
+describe 'My application' do
+  before do
+    @app = NSApplication.sharedApplication
+    @sh = Motion::ScreenshotHelper.new(my_config)
+  end
+
+  it 'takes a screenshot' do
+    @sh.shoot.should == true
+  end
+
+  it 'takes a screenshot after waiting' do
+  	# do something import with your GUI
+  	@sh.pause(1.0) # time in seconds to wait
+	@sh.shoot.should == true
+  end
+end
+````
+
+You may set the following config options when calling ```Motion::ScreenshotHelper.new`:
+
+```
+my_config = {
+      screenshot_mode: Motion::ScreenshotHelper::SCREENSHOT_MODE_FULLSCREEN, # for full-screenshots
+      shots_dir: 'screenshots', # the target dir for the screenshot files
+      file_basename: 'screenshot', # the basename for the screenshot files (a counter will be added) e.g. 'screenshot_0.png'
+      app_name: NSBundle.mainBundle.infoDictionary['CFBundleName'] # your application name needed for focusing the app with AppleScript
+}
+```
+
+ScreenshotHelper will make use of the screencapture command line tool.
+
+## Contact
+https://vt-learn.de

data/lib/motion-macos-screenshot_helper.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+unless defined?(Motion::Project::Config)
+  raise "This file must be required within a RubyMotion project Rakefile."
+end
+
+lib_dir_path = File.dirname(File.expand_path(__FILE__))
+Motion::Project::App.setup do |app|
+  app.files.unshift(Dir.glob(File.join(lib_dir_path, "project/**/*.rb")))
+end

data/lib/project/screenshot_helper.rb

@@ -0,0 +1,100 @@
+module Motion
+  # A class for taking screenshots in Ruby apps running on the Mac
+  class ScreenshotHelper
+
+    attr_accessor :config
+
+    SCREENSHOT_MODE_FULLSCREEN = 0
+    SCREENSHOT_MODE_MAINWINDOW = 1
+
+    def initialize(config)
+      self.config = default_config.merge(config)
+      @counter = 0
+      clear_dir
+      self
+    end
+
+    def default_config
+      {
+        screenshot_mode: SCREENSHOT_MODE_FULLSCREEN,
+        shots_dir: 'screenshots',
+        file_basename: 'screenshot',
+        app_name: NSBundle.mainBundle.infoDictionary['CFBundleName']
+      }
+    end
+
+    def target_filename
+      "#{config[:shots_dir]}/#{config[:file_basename].to_s}_#{@counter.to_s}.png"
+    end
+
+    def shoot
+      begin
+        focus_app
+        system screenshot_cmd
+        @counter += 1
+      rescue Exception => e
+        puts "Exception #{e}"
+        return false
+      end
+      true
+    end
+
+    def pause(sec=1.0)
+      intervall = NSDate.dateWithTimeIntervalSinceNow sec
+      NSThread.sleepUntilDate intervall
+    end
+
+    private
+
+    def check_shots_dir
+      self.config[:shots_dir] = File.absolute_path(config[:shots_dir])
+      fail(IOError, "#{config[:shots_dir]} is not a directory") unless File.directory?(ndir)
+    end
+
+    def app
+      NSApplication.sharedApplication
+    end
+
+    def screenshot_cmd
+      screen_rect = NSScreen.mainScreen.frame
+      case config[:screenshot_mode]
+      when ScreenshotHelper::SCREENSHOT_MODE_MAINWINDOW
+        fr = app_window.frame
+        x_origin = fr.origin[0]
+        y_origin = screen_rect.size[1] - fr.origin[1] - fr.size[1]
+        capture_frame = "#{x_origin},#{y_origin},#{fr.size[0]},#{fr.size[1]}"
+        rv  = "screencapture -R#{capture_frame} #{target_filename}"
+      else
+        rv = "screencapture #{target_filename}"
+      end
+      rv
+    end
+
+    def app_window
+      return app.mainWindow unless app.mainWindow.nil?
+      return app.keyWindow unless app.keyWindow.nil?
+      app.windows.first
+    end
+
+    def focus_app
+      scpt = <<SCPT
+      tell application "#{config[:app_name]}"
+      activate
+    end tell
+SCPT
+      osascript scpt
+    end
+
+    def osascript(script_src)
+      error = Pointer.new('@')
+      apple_script = NSAppleScript.alloc.initWithSource(script_src)
+      apple_script.executeAndReturnError(error)
+      puts "NSAppleScript::error #{error.value.inspect}" unless error.value.nil?
+    end
+
+    def clear_dir
+      cmd = "rm -rf #{(config[:shots_dir] + '/*').dump}"
+      system cmd
+    end
+  end
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: motion-macos-screenshothelper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Martin Kolb
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-04 00:00:00.000000000 Z
+dependencies:
+- !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'
+description: A gem for taking automated screenshots in macOS applications written
+  in Rubymotion
+email:
+- admin@vt-learn.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/motion-macos-screenshot_helper.rb
+- lib/project/screenshot_helper.rb
+homepage: https://vt-learn.de
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: This gem lets you take screenshots of your macOS app written in Rubymotion
+test_files: []