skippy 0.3.0.a → 0.4.0.a

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c11b52fc9b368e0ba14ead9d714d5e194c312c03056ad27fedbbab607a443fc6
-  data.tar.gz: ecae267dae0b85c7b5a6d024a0bbc85472e8e92bd3f652349acde9bc7bad7612
+  metadata.gz: 8911df6fd31addc62c4bc4756eb46f715eaf70ea2d2bcfb32175f104dad78f82
+  data.tar.gz: dbb042f7ed689a8d1a01589b4f11479014da36861e1cf578453a75eab14028b0
 SHA512:
-  metadata.gz: 0c691c52f0cd4cf7ef73754a89f07c127301bd097b602957ca6fed8020bd43a82cc0ac025e1a3dc9eaa5ebe125ff46bc95f5b2b9d037638359b56c6d7d4ca758
-  data.tar.gz: a46e8182a2389a99041fabf6dd224a0faa0239118136f005556f93ca22ca44e1860e667769640547f5bc9051834bc00f8134c7e27b18f7b3fbad4889015e5e5a
+  metadata.gz: fda57b8e19f1a22ab2ad207bd938df1a5f9ba158400d5126572dc518130f48614cd30082aa4b4ac800fd33aa7c38fd32c712dfd4c7c5aac36432bc21762c0b6d
+  data.tar.gz: e43b4802ac2f2b0c2a60e5b8da927e9cb19cdcaee74d38c021422ebb571a7395363184f6828eccd23c66055ba2d078e8f30162849543a02d081cfcd05df853a5

data/README.md

@@ -14,7 +14,8 @@ Some of the main goals are:
   - [ ] Add/Remove/Update user templates
 - [ ] Automate common tasks
   - [ ] Packaging the extension
-  - [ ] Start SketchUp in debug mode
+  - [x] Launch SketchUp
+  - [x] Launch SketchUp in debug mode
 - [x] Easy interface to add per-project custom commands/tasks
 - [x] Library dependency management
   - [x] Pull in third-party modules into extension namespace
@@ -201,6 +202,30 @@ For more examples, refer to:
 * [github.com/thomthom/tt-lib](https://github.com/thomthom/tt-lib)
 * [github.com/thomthom/skippy-test-lib](https://github.com/thomthom/skippy-test-lib)
 
+### Launching SketchUp
+
+Skippy will attempt to locate your SketchUp installations and offer commands to launch them.
+
+These commands provides a cross platform way of launching SketchUp which can be useful in build scripts or IDE automation tasks.
+
+(**Note:** Currently Skippy assumes that SketchUp is installed to its default installation directory.)
+
+`skippy sketchup:list` will display a list of all known SketchUp versions on the system.
+
+![](https://github.com/thomthom/skippy/wiki/images/skippy-sketchup-list.png)
+
+To launch one, use `skippy sketchup:launch VERSION`, for instance:
+
+```
+skippy sketchup:launch 2018
+```
+
+You can also launch SketchUp in debug mode if the [SketchUp Ruby Debugger library](https://github.com/SketchUp/sketchup-ruby-debugger) is installed.
+
+```
+skippy sketchup:debug 2018
+```
+
 ## Development
 
 After checking out the repository, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/app/commands/sketchup.rb

@@ -0,0 +1,61 @@
+require 'json'
+require 'stringio'
+
+require 'skippy/error'
+require 'skippy/os'
+
+class Sketchup < Skippy::Command
+
+  include Thor::Actions
+
+  option :port, :type => :numeric, :default => 7000
+  desc 'debug VERSION', 'Start SketchUp with Ruby Debugger'
+  def debug(version)
+    app = find_sketchup(version)
+    unless app.can_debug
+      raise Skippy::Error, "Debug library not installed for Sketchup #{version}"
+    end
+    arguments = ['-rdebug', %("ide port=#{options.port}")]
+    Skippy.os.launch_app(app.executable, *arguments)
+  end
+
+  desc 'launch VERSION', 'Start SketchUp'
+  def launch(version)
+    app = find_sketchup(version)
+    Skippy.os.launch_app(app.executable)
+  end
+
+  desc 'list', 'List all known SketchUp versions'
+  def list
+    say shell.set_color('Known SketchUp versions:', :yellow, true)
+    Skippy.os.sketchup_apps.each { |sketchup|
+      version = sketchup.version.to_s.ljust(4)
+      sketchup_name = "SketchUp #{version}"
+      bitness = sketchup.is64bit ? '64bit' : '32bit'
+      debug = sketchup.can_debug ? '(debugger)' : ''
+      # TODO(thomthom): Use print_table ?
+      output = StringIO.new
+      output.write '  '
+      output.write shell.set_color(sketchup_name, :green, false)
+      output.write '   '
+      output.write bitness
+      output.write '   '
+      output.write shell.set_color(debug, :yellow, false)
+      say output.string
+    }
+  end
+  default_command(:list)
+
+  private
+
+  # @param [Integer] version
+  # @return [Skippy::SketchUpApp, nil]
+  def find_sketchup(version)
+    app = Skippy.os.sketchup_apps.find { |sketchup|
+      sketchup.version == version.to_i
+    }
+    raise Skippy::Error, "SketchUp #{version} not found." if app.nil?
+    app
+  end
+
+end

data/lib/skippy/os.rb

@@ -0,0 +1,17 @@
+module Skippy
+
+  if RUBY_PLATFORM =~ /darwin/
+    require 'skippy/os/mac'
+    OS = Skippy::OSMac
+  else
+    require 'skippy/os/win'
+    OS = Skippy::OSWin
+  end
+
+  @os = OS.new
+
+  def self.os
+    @os
+  end
+
+end

data/lib/skippy/os/common.rb

@@ -0,0 +1,26 @@
+class Skippy::OSCommon
+
+  # @param [String] command
+  def execute_command(command)
+    # Something with a Thor application like skippy get the 'RUBYLIB'
+    # environment set which prevents SketchUp from finding its StdLib
+    # directories. (At least under Windows.) This relates to child processes
+    # inheriting the environment variables of its parent.
+    # To work around this we unset RUBYLIB before launching SketchUp. This
+    # doesn't affect skippy as it's about to exit as soon as SketchUp starts
+    # any way.
+    ENV['RUBYLIB'] = nil if ENV['RUBYLIB']
+    id = spawn(command)
+    Process.detach(id)
+  end
+
+  # @param [String] path
+  def launch_app(path, *args)
+    raise NotImplementedError
+  end
+
+  def sketchup_apps
+    raise NotImplementedError
+  end
+
+end

data/lib/skippy/os/mac.rb

@@ -0,0 +1,32 @@
+require 'skippy/os/common'
+require 'skippy/sketchup/app'
+
+class Skippy::OSMac < Skippy::OSCommon
+
+  # @param [String] executable_path
+  def launch_app(executable_path, *args)
+    command = %(open -a "#{executable_path}")
+    unless args.empty?
+      command << " --args #{args.join(' ')}"
+    end
+    execute_command(command)
+  end
+
+  def sketchup_apps
+    apps = []
+    pattern = '/Applications/SketchUp */'
+    Dir.glob(pattern) { |path|
+      app = File.join(path, 'SketchUp.app')
+      debug_lib = File.join(app, 'Contents/Frameworks/SURubyDebugger.dylib')
+      version = File.basename(path).match(/[0-9.]+$/)[0].to_i
+      apps << Skippy::SketchUpApp.from_hash(
+        executable: app,
+        version: version,
+        can_debug: File.exist?(debug_lib),
+        is64bit: version > 2015,
+      )
+    }
+    apps.sort_by(&:version)
+  end
+
+end

data/lib/skippy/os/win.rb

@@ -0,0 +1,56 @@
+require 'skippy/os/common'
+require 'skippy/sketchup/app'
+
+class Skippy::OSWin < Skippy::OSCommon
+
+  # Note: This is not a good indication to 32bit bs 64bit. It's a naive
+  #       assumption that will fail when SketchUp is installed to a
+  #       non-standard location.
+  SYSTEM_32BIT = ENV['ProgramFiles(x86)'].nil? && ENV['ProgramW6432'].nil?
+  SYSTEM_64BIT = !SYSTEM_32BIT
+
+  PROGRAM_FILES_64BIT = File.expand_path(ENV['ProgramW6432'])
+
+  # @param [String] executable_path
+  def launch_app(executable_path, *args)
+    command = %("#{executable_path}")
+    unless args.empty?
+      command << " #{args.join(' ')}"
+    end
+    execute_command(command)
+  end
+
+  def sketchup_apps
+    # TODO(thomthom): Find by registry information.
+    apps = []
+    program_files_paths.each { |program_files|
+      pattern = "#{program_files}/{@Last Software,Google,SketchUp}/*SketchUp *"
+      Dir.glob(pattern) { |path|
+        exe = File.join(path, 'SketchUp.exe')
+        debug_dll = File.join(path, 'SURubyDebugger.dll')
+        version = File.basename(path).match(/[0-9.]+$/)[0].to_i
+        apps << Skippy::SketchUpApp.from_hash(
+          executable: exe,
+          version: version,
+          can_debug: File.exist?(debug_dll),
+          is64bit: SYSTEM_64BIT && path.start_with?("#{PROGRAM_FILES_64BIT}/"),
+        )
+      }
+    }
+    apps.sort_by(&:version)
+  end
+
+  private
+
+  def program_files_paths
+    paths = []
+    if SYSTEM_64BIT
+      paths << File.expand_path(ENV['ProgramFiles(x86)'])
+      paths << File.expand_path(ENV['ProgramW6432'])
+    else
+      paths << File.expand_path(ENV['ProgramFiles'])
+    end
+    paths
+  end
+
+end

data/lib/skippy/sketchup/app.rb

@@ -0,0 +1,11 @@
+module Skippy
+
+  SketchUpApp = Struct.new(:executable, :version, :can_debug, :is64bit) do
+
+    def self.from_hash(hash)
+      new(*hash.values_at(*members))
+    end
+
+  end
+
+end

data/lib/skippy/version.rb

@@ -1,5 +1,5 @@
 module Skippy
 
-  VERSION = '0.3.0.a'.freeze
+  VERSION = '0.4.0.a'.freeze
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skippy
 version: !ruby/object:Gem::Version
-  version: 0.3.0.a
+  version: 0.4.0.a
 platform: ruby
 authors:
 - Thomas Thomassen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-19 00:00:00.000000000 Z
+date: 2017-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -159,6 +159,7 @@ files:
 - app/commands/install.rb
 - app/commands/lib.rb
 - app/commands/new.rb
+- app/commands/sketchup.rb
 - app/commands/template.rb
 - app/resources/commands/example.rb
 - app/templates/standard/%ext_name%.rb.tt
@@ -226,7 +227,12 @@ files:
 - lib/skippy/library_manager.rb
 - lib/skippy/module_manager.rb
 - lib/skippy/namespace.rb
+- lib/skippy/os.rb
+- lib/skippy/os/common.rb
+- lib/skippy/os/mac.rb
+- lib/skippy/os/win.rb
 - lib/skippy/project.rb
+- lib/skippy/sketchup/app.rb
 - lib/skippy/version.rb
 - skippy.gemspec
 homepage: https://github.com/thomthom/skippy