Fix path generation on windows by using Pathname

Author: ianfixes

CHANGELOG.md

@@ -19,6 +19,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - External libraries aren't forcibly installed via the Arduino binary (in `arduino_cmd_remote.rb`) if they appear to exist on disk already
 - `attachInterrupt` and `detachInterrupt` are now mocked instead of `_NOP`
 - Unit test binaries now run with debugging symbols and address sanitization (if available), to help isolate the causes of segfaults
+- `ArduinoCommand::libdir` logic is now centralized, using `sketchbook.path` from prefs instead of hard-coding
 
 ### Deprecated
 
@@ -31,6 +32,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - CPP file aggregation now ignores dotfiles
 - Unit test `compilers` section of YAML configuration is now properly inherited from parent configuration files
 - Retrieving preferences is now properly cached
+- Paths on Windows should now work due to the use of `Pathname`
 
 ### Security
 

exe/arduino_ci_remote.rb

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 require 'arduino_ci'
 require 'set'
+require 'pathname'
 
 WIDTH = 80
 
@@ -72,7 +73,9 @@ def assured_platform(purpose, name, config)
 @arduino_cmd = ArduinoCI::ArduinoInstallation.autolocate!
 
 # initialize library under test
-installed_library_path = assure("Installing library under test") { @arduino_cmd.install_local_library(".") }
+installed_library_path = attempt("Installing library under test") do
+  @arduino_cmd.install_local_library(Pathname.new("."))
+end
 library_examples = @arduino_cmd.library_examples(installed_library_path)
 cpp_library = ArduinoCI::CppLibrary.new(installed_library_path, @arduino_cmd.lib_dir)
 attempt("Library installed at #{installed_library_path}") { true }
@@ -129,7 +132,7 @@ def assured_platform(purpose, name, config)
 
 # iterate boards / tests
 last_board = nil
-if !File.exist?(cpp_library.tests_dir)
+if !cpp_library.tests_dir.exist?
   attempt("Skipping unit tests; no tests dir at #{cpp_library.tests_dir}") { true }
 elsif cpp_library.test_files.empty?
   attempt("Skipping unit tests; no test files were found in #{cpp_library.tests_dir}") { true }
@@ -141,7 +144,7 @@ def assured_platform(purpose, name, config)
     assure("Switching to board for #{p} (#{board})") { @arduino_cmd.use_board(board) } unless last_board == board
     last_board = board
     cpp_library.test_files.each do |unittest_path|
-      unittest_name = File.basename(unittest_path)
+      unittest_name = unittest_path.basename.to_s
       compilers.each do |gcc_binary|
         attempt_multiline("Unit testing #{unittest_name} with #{gcc_binary}") do
           exe = cpp_library.build_for_test_with_configuration(

lib/arduino_ci/arduino_cmd.rb

@@ -1,4 +1,5 @@
 require 'fileutils'
+require 'pathname'
 
 module ArduinoCI
 
@@ -67,7 +68,7 @@ def parse_pref_string(arduino_output)
 
     # @return [String] the path to the Arduino libraries directory
     def lib_dir
-      "<lib_dir not defined>"
+      Pathname.new(get_pref("sketchbook.path")) + "libraries"
     end
 
     # fetch preferences in their raw form
@@ -192,9 +193,9 @@ def install_library(library_name)
 
     # generate the (very likely) path of a library given its name
     # @param library_name [String] The name of the library
-    # @return [String] The fully qualified library name
+    # @return [Pathname] The fully qualified library name
     def library_path(library_name)
-      File.join(lib_dir, library_name)
+      Pathname.new(lib_dir) + library_name
     end
 
     # Determine whether a library is present in the lib dir
@@ -205,7 +206,7 @@ def library_path(library_name)
     # @param library_name [String] The name of the library
     # @return [bool]
     def library_present?(library_name)
-      File.exist?(library_path(library_name))
+      library_path(library_name).exist?
     end
 
     # update the library index
@@ -254,24 +255,24 @@ def verify_sketch(path)
 
     # ensure that the given library is installed, or symlinked as appropriate
     # return the path of the prepared library, or nil
-    # @param path [String] library to use
+    # @param path [Pathname] library to use
     # @return [String] the path of the installed library
     def install_local_library(path)
-      realpath = File.expand_path(path)
-      library_name = File.basename(realpath)
+      src_path = path.realpath
+      library_name = src_path.basename
       destination_path = library_path(library_name)
 
       # things get weird if the sketchbook contains the library.
       # check that first
-      if File.exist? destination_path
+      if destination_path.exist?
         uhoh = "There is already a library '#{library_name}' in the library directory"
-        return destination_path if destination_path == realpath
+        return destination_path if destination_path == src_path
 
         # maybe it's a symlink? that would be OK
-        if File.symlink?(destination_path)
-          return destination_path if File.readlink(destination_path) == realpath
+        if destination_path.symlink?
+          return destination_path if destination_path.readlink == src_path
 
-          @last_msg = "#{uhoh} and it's not symlinked to #{realpath}"
+          @last_msg = "#{uhoh} and it's not symlinked to #{src_path}"
           return nil
         end
 
@@ -280,20 +281,20 @@ def install_local_library(path)
       end
 
       # install the library
-      Host.symlink(realpath, destination_path)
+      Host.symlink(src_path, destination_path)
       destination_path
     end
 
     # @param installed_library_path [String] The library to query
     # @return [Array<String>] Example sketch files
     def library_examples(installed_library_path)
-      example_path = File.join(installed_library_path, "examples")
+      example_path = Pathname.new(installed_library_path) + "examples"
       return [] unless File.exist?(example_path)
 
-      examples = Pathname.new(example_path).children.select(&:directory?).map(&:to_path).map(&File.method(:basename))
+      examples = example_path.children.select(&:directory?).map(&:to_path).map(&File.method(:basename))
       files = examples.map do |e|
-        proj_file = File.join(example_path, e, "#{e}.ino")
-        File.exist?(proj_file) ? proj_file : nil
+        proj_file = example_path + e + "#{e}.ino"
+        proj_file.exist? ? proj_file.to_s : nil
       end
       files.reject(&:nil?)
     end

lib/arduino_ci/arduino_cmd_linux.rb

@@ -32,12 +32,6 @@ def _prefs_raw
       resp[:out]
     end
 
-    # implementation for Arduino library dir location
-    # @return [String] the path to the Arduino libraries directory
-    def lib_dir
-      File.join(get_pref("sketchbook.path"), "libraries")
-    end
-
     def run_with_gui_guess(message, *args, **kwargs)
       # On Travis CI, we get an error message in the GUI instead of on STDERR
       # so, assume that if we don't get a rapid reply that things are not installed

lib/arduino_ci/arduino_cmd_linux_builder.rb

@@ -14,12 +14,6 @@ class ArduinoCmdLinuxBuilder < ArduinoCmd
     flag :install_library, "--install-library"   # apparently doesn't exist
     flag :verify,          "-compile"
 
-    # linux-specific implementation
-    # @return [String] The path to the library dir
-    def lib_dir
-      File.join(get_pref("sketchbook.path"), "libraries")
-    end
-
   end
 
 end

lib/arduino_ci/arduino_cmd_osx.rb

@@ -12,11 +12,6 @@ class ArduinoCmdOSX < ArduinoCmd
     flag :install_boards,  "--install-boards"
     flag :install_library, "--install-library"
     flag :verify,          "--verify"
-
-    def lib_dir
-      File.join(ENV['HOME'], "Documents", "Arduino", "libraries")
-    end
-
   end
 
 end

lib/arduino_ci/arduino_cmd_windows.rb

@@ -12,11 +12,6 @@ class ArduinoCmdWindows < ArduinoCmd
     flag :install_boards,  "--install-boards"
     flag :install_library, "--install-library"
     flag :verify,          "--verify"
-
-    def lib_dir
-      File.join(ENV['userprofile'], "Documents", "Arduino", "libraries")
-    end
-
   end
 
 end