arduino_ci 0.3.0 → 1.3.0

data/lib/arduino_ci/arduino_downloader.rb

@@ -1,4 +1,5 @@
 require 'fileutils'
+require 'pathname'
 require 'net/http'
 require 'open-uri'
 require 'zip'
@@ -10,10 +11,10 @@ module ArduinoCI
   # Manage the OS-specific download & install of Arduino
   class ArduinoDownloader
 
-    # @param desired_ide_version [string] Version string e.g. 1.8.7
+    # @param desired_version [string] Version string e.g. 1.8.7
     # @param output [IO] $stdout, $stderr, File.new(/dev/null, 'w'), etc. where console output will be sent
-    def initialize(desired_ide_version, output = $stdout)
-      @desired_ide_version = desired_ide_version
+    def initialize(desired_version, output = $stdout)
+      @desired_version = desired_version
       @output = output
     end
 
@@ -30,7 +31,7 @@ module ArduinoCI
 
     # The autolocated executable of the installation
     #
-    # @return [string] or nil
+    # @return [Pathname] or nil
     def self.autolocated_executable
       # Arbitrarily, I'm going to pick the force installed location first
       # if it exists.  I'm not sure why we would have both, but if we did
@@ -39,70 +40,54 @@ module ArduinoCI
       locations.find { |loc| !loc.nil? && File.exist?(loc) }
     end
 
-    # The autolocated directory of the installation
-    #
-    # @return [string] or nil
-    def self.autolocated_installation
-      # Arbitrarily, I'm going to pick the force installed location first
-      # if it exists.  I'm not sure why we would have both, but if we did
-      # a force install then let's make sure we actually use it.
-      locations = [self.force_install_location, self.existing_installation]
-      locations.find { |loc| !loc.nil? && File.exist?(loc) }
+    # The executable Arduino file in an existing installation, or nil
+    # @return [Pathname]
+    def self.existing_executable
+      self.must_implement(__method__)
     end
 
-    # The path to the directory of an existing installation, or nil
+    # The local file (dir) name of the desired IDE package (zip/tar/etc)
     # @return [string]
-    def self.existing_installation
-      self.must_implement(__method__)
+    def package_file
+      self.class.must_implement(__method__)
     end
 
-    # The executable Arduino file in an existing installation, or nil
+    # The local filename of the extracted IDE package (zip/tar/etc)
     # @return [string]
-    def self.existing_executable
+    def self.extracted_file
       self.must_implement(__method__)
     end
 
     # The executable Arduino file in a forced installation, or nil
-    # @return [string]
+    # @return [Pathname]
     def self.force_installed_executable
-      self.must_implement(__method__)
+      Pathname.new(ENV['HOME']) + self.extracted_file
     end
 
     # The technology that will be used to complete the download
     # (for logging purposes)
     # @return [string]
-    def downloader
+    def self.downloader
       "open-uri"
     end
 
     # The technology that will be used to extract the download
     # (for logging purposes)
     # @return [string]
-    def extracter
-      "Zip"
-    end
-
-    # The URL of the desired IDE package (zip/tar/etc) for this platform
-    # @return [string]
-    def package_url
-      "https://downloads.arduino.cc/#{package_file}"
+    def self.extracter
+      self.must_implement(__method__)
     end
 
-    # The local file (dir) name of the desired IDE package (zip/tar/etc)
-    # @return [string]
-    def package_file
-      self.class.must_implement(__method__)
+    # Extract the package_file to extracted_file
+    # @return [bool] whether successful
+    def self.extract(_package_file)
+      self.must_implement(__method__)
     end
 
-    # The local filename of the extracted IDE package (zip/tar/etc)
+    # The URL of the desired IDE package (zip/tar/etc) for this platform
     # @return [string]
-    def extracted_file
-      self.class.must_implement(__method__)
-    end
-
-    # @return [String] The location where a forced install will go
-    def self.force_install_location
-      File.join(ENV['HOME'], 'arduino_ci_ide')
+    def package_url
+      "https://github.com/arduino/arduino-cli/releases/download/#{@desired_version}/#{package_file}"
     end
 
     # Download the package_url to package_file
@@ -119,7 +104,7 @@ module ArduinoCI
         total_size += size
         needed_dots = (total_size / chunk_size).to_i
         unprinted_dots = needed_dots - dots
-        @output.print("." * unprinted_dots) if unprinted_dots > 0
+        @output.print("." * unprinted_dots) if unprinted_dots.positive?
         dots = needed_dots
       end
 
@@ -130,26 +115,10 @@ module ArduinoCI
       @output.puts "\nArduino force-install failed downloading #{package_url}: #{e}"
     end
 
-    # Extract the package_file to extracted_file
-    # @return [bool] whether successful
-    def extract
-      Zip::File.open(package_file) do |zip|
-        batch_size = [1, (zip.size / 100).to_i].max
-        dots = 0
-        zip.each do |file|
-          @output.print "." if (dots % batch_size).zero?
-          file.restore_permissions = true
-          file.extract { accept_all }
-          dots += 1
-        end
-      end
-    end
-
-    # Move the extracted package file from extracted_file to the force_install_location
+    # Move the extracted package file from extracted_file to the force_installed_executable
     # @return [bool] whether successful
     def install
-      # Move only the content of the directory
-      FileUtils.mv extracted_file, self.class.force_install_location
+      FileUtils.mv self.class.extracted_file.to_s, self.class.force_installed_executable.to_s
     end
 
     # Forcibly install Arduino on linux from the web
@@ -161,39 +130,40 @@ module ArduinoCI
         return false
       end
 
+      arduino_package = "Arduino #{@desired_version} package"
       attempts = 0
 
       loop do
-        if File.exist? package_file
-          @output.puts "Arduino package seems to have been downloaded already" if attempts.zero?
+        if File.exist?(package_file)
+          @output.puts "#{arduino_package} seems to have been downloaded already at #{package_file}" if attempts.zero?
           break
         elsif attempts >= DOWNLOAD_ATTEMPTS
           break @output.puts "After #{DOWNLOAD_ATTEMPTS} attempts, failed to download #{package_url}"
         else
-          @output.print "Attempting to download Arduino package with #{downloader}"
+          @output.print "Attempting to download #{arduino_package} with #{self.class.downloader}"
           download
           @output.puts
         end
         attempts += 1
       end
 
-      if File.exist? extracted_file
-        @output.puts "Arduino package seems to have been extracted already"
-      elsif File.exist? package_file
-        @output.print "Extracting archive with #{extracter}"
-        extract
+      if File.exist?(self.class.extracted_file)
+        @output.puts "#{arduino_package} seems to have been extracted already at #{self.class.extracted_file}"
+      elsif File.exist?(package_file)
+        @output.print "Extracting archive with #{self.class.extracter}"
+        self.class.extract(package_file)
         @output.puts
       end
 
-      if File.exist? self.class.force_install_location
-        @output.puts "Arduino package seems to have been installed already"
-      elsif File.exist? extracted_file
+      if File.exist?(self.class.force_installed_executable)
+        @output.puts "#{arduino_package} seems to have been installed already at #{self.class.force_installed_executable}"
+      elsif File.exist?(self.class.extracted_file)
         install
       else
-        @output.puts "Could not find extracted archive (tried #{extracted_file})"
+        @output.puts "Could not find extracted archive (tried #{self.class.extracted_file})"
       end
 
-      File.exist? self.class.force_install_location
+      File.exist?(self.class.force_installed_executable)
     end
 
   end

data/lib/arduino_ci/arduino_downloader_linux.rb

@@ -1,7 +1,5 @@
 require "arduino_ci/arduino_downloader"
 
-USE_BUILDER = false
-
 module ArduinoCI
 
   # Manage the linux download & install of Arduino
@@ -10,13 +8,25 @@ module ArduinoCI
     # The local filename of the desired IDE package (zip/tar/etc)
     # @return [string]
     def package_file
-      "#{extracted_file}-linux64.tar.xz"
+      "arduino-cli_#{@desired_version}_Linux_64bit.tar.gz"
+    end
+
+    # The local file (dir) name of the extracted IDE package (zip/tar/etc)
+    # @return [string]
+    def self.extracted_file
+      "arduino-cli"
+    end
+
+    # The executable Arduino file in an existing installation, or nil
+    # @return [string]
+    def self.existing_executable
+      Host.which("arduino-cli")
     end
 
     # Make any preparations or run any checks prior to making changes
     # @return [string] Error message, or nil if success
     def prepare
-      reqs = [extracter]
+      reqs = [self.class.extracter]
       reqs.each do |req|
         return "#{req} does not appear to be installed!" unless Host.which(req)
       end
@@ -26,62 +36,14 @@ module ArduinoCI
     # The technology that will be used to extract the download
     # (for logging purposes)
     # @return [string]
-    def extracter
+    def self.extracter
       "tar"
     end
 
     # Extract the package_file to extracted_file
     # @return [bool] whether successful
-    def extract
-      system(extracter, "xf", package_file)
-    end
-
-    # The local file (dir) name of the extracted IDE package (zip/tar/etc)
-    # @return [string]
-    def extracted_file
-      "arduino-#{@desired_ide_version}"
-    end
-
-    # The path to the directory of an existing installation, or nil
-    # @return [string]
-    def self.existing_installation
-      exe = self.existing_executable
-      return nil if exe.nil?
-
-      File.dirname(exe) # it's not really this
-      # but for this platform it doesn't really matter
-    end
-
-    # The executable Arduino file in an existing installation, or nil
-    # @return [string]
-    def self.existing_executable
-      if USE_BUILDER
-        # builder_name = "arduino-builder"
-        # cli_place = Host.which(builder_name)
-        # unless cli_place.nil?
-        #   ret = ArduinoCmdLinuxBuilder.new
-        #   ret.base_cmd = [cli_place]
-        #   return ret
-        # end
-      end
-      Host.which("arduino")
-    end
-
-    # The executable Arduino file in a forced installation, or nil
-    # @return [string]
-    def self.force_installed_executable
-      if USE_BUILDER
-        # forced_builder = File.join(ArduinoCmdLinuxBuilder.force_install_location, builder_name)
-        # if File.exist?(forced_builder)
-        #   ret = ArduinoCmdLinuxBuilder.new
-        #   ret.base_cmd = [forced_builder]
-        #   return ret
-        # end
-      end
-      forced_arduino = File.join(self.force_install_location, "arduino")
-      return forced_arduino if File.exist? forced_arduino
-
-      nil
+    def self.extract(package_file)
+      system(extracter, "xf", package_file, extracted_file)
     end
 
   end

data/lib/arduino_ci/arduino_downloader_osx.rb

@@ -8,54 +8,42 @@ module ArduinoCI
     # The local filename of the desired IDE package (zip/tar/etc)
     # @return [string]
     def package_file
-      "arduino-#{@desired_ide_version}-macosx.zip"
+      "arduino-cli_#{@desired_version}_macOS_64bit.tar.gz"
     end
 
     # The local file (dir) name of the extracted IDE package (zip/tar/etc)
     # @return [string]
-    def extracted_file
-      "Arduino.app"
+    def self.extracted_file
+      "arduino-cli"
     end
 
-    # @return [String] The location where a forced install will go
-    def self.force_install_location
-      # include the .app extension
-      File.join(ENV['HOME'], 'Arduino.app')
-    end
-
-    # An existing Arduino directory in one of the given directories, or nil
-    # @param Array<string> a list of places to look
+    # The executable Arduino file in an existing installation, or nil
     # @return [string]
-    def self.find_existing_arduino_dir(paths)
-      paths.find(&File.method(:exist?))
+    def self.existing_executable
+      Host.which("arduino-cli")
     end
 
-    # An existing Arduino file in one of the given directories, or nil
-    # @param Array<string> a list of places to look for the executable
-    # @return [string]
-    def self.find_existing_arduino_exe(paths)
-      paths.find do |path|
-        exe = File.join(path, "MacOS", "Arduino")
-        File.exist? exe
+    # Make any preparations or run any checks prior to making changes
+    # @return [string] Error message, or nil if success
+    def prepare
+      reqs = [self.class.extracter]
+      reqs.each do |req|
+        return "#{req} does not appear to be installed!" unless Host.which(req)
       end
+      nil
     end
 
-    # The path to the directory of an existing installation, or nil
+    # The technology that will be used to extract the download
+    # (for logging purposes)
     # @return [string]
-    def self.existing_installation
-      self.find_existing_arduino_dir(["/Applications/Arduino.app"])
+    def self.extracter
+      "tar"
     end
 
-    # The executable Arduino file in an existing installation, or nil
-    # @return [string]
-    def self.existing_executable
-      self.find_existing_arduino_exe(["/Applications/Arduino.app"])
-    end
-
-    # The executable Arduino file in a forced installation, or nil
-    # @return [string]
-    def self.force_installed_executable
-      self.find_existing_arduino_exe([self.force_install_location])
+    # Extract the package_file to extracted_file
+    # @return [bool] whether successful
+    def self.extract(package_file)
+      system(extracter, "xf", package_file, extracted_file)
     end
 
   end

data/lib/arduino_ci/arduino_downloader_windows.rb

@@ -10,19 +10,6 @@ module ArduinoCI
   # Manage the POSIX download & install of Arduino
   class ArduinoDownloaderWindows < ArduinoDownloader
 
-    # Make any preparations or run any checks prior to making changes
-    # @return [string] Error message, or nil if success
-    def prepare
-      nil
-    end
-
-    # The technology that will be used to complete the download
-    # (for logging purposes)
-    # @return [string]
-    def downloader
-      "open-uri"
-    end
-
     # Download the package_url to package_file
     # @return [bool] whether successful
     def download
@@ -35,29 +22,28 @@ module ArduinoCI
       @output.puts "\nArduino force-install failed downloading #{package_url}: #{e}"
     end
 
-    # Move the extracted package file from extracted_file to the force_install_location
-    # @return [bool] whether successful
-    def install
-      # Move only the content of the directory
-      FileUtils.mv extracted_file, self.class.force_install_location
-    end
-
     # The local filename of the desired IDE package (zip/tar/etc)
     # @return [string]
     def package_file
-      "#{extracted_file}-windows.zip"
+      "arduino-cli_#{@desired_version}_Windows_64bit.zip"
+    end
+
+    # The executable Arduino file in an existing installation, or nil
+    # @return [string]
+    def self.existing_executable
+      Host.which("arduino-cli")
     end
 
     # The technology that will be used to extract the download
     # (for logging purposes)
     # @return [string]
-    def extracter
+    def self.extracter
       "Expand-Archive"
     end
 
     # Extract the package_file to extracted_file
     # @return [bool] whether successful
-    def extract
+    def self.extract(package_file)
       Zip::File.open(package_file) do |zip|
         zip.each do |file|
           file.extract(file.name)
@@ -67,36 +53,8 @@ module ArduinoCI
 
     # The local file (dir) name of the extracted IDE package (zip/tar/etc)
     # @return [string]
-    def extracted_file
-      "arduino-#{@desired_ide_version}"
-    end
-
-    # The path to the directory of an existing installation, or nil
-    # @return [string]
-    def self.existing_installation
-      exe = self.existing_executable
-      return nil if exe.nil?
-
-      File.dirname(exe)
-    end
-
-    # The executable Arduino file in an existing installation, or nil
-    # @return [string]
-    def self.existing_executable
-      arduino_reg = 'SOFTWARE\WOW6432Node\Arduino'
-      Win32::Registry::HKEY_LOCAL_MACHINE.open(arduino_reg).find do |reg|
-        path = reg.read_s('Install_Dir')
-        exe = File.join(path, "arduino_debug.exe")
-        File.exist? exe
-      end
-    rescue
-      nil
-    end
-
-    # The executable Arduino file in a forced installation, or nil
-    # @return [string]
-    def self.force_installed_executable
-      File.join(self.force_install_location, "arduino_debug.exe")
+    def self.extracted_file
+      "arduino-cli.exe"
     end
 
   end