arduino_ci 0.1.21 → 1.0.0

data/lib/arduino_ci/host.rb

@@ -6,6 +6,13 @@ module ArduinoCI
 
   # Tools for interacting with the host machine
   class Host
+    # TODO: this came from https://stackoverflow.com/a/22716582/2063546
+    #       and I'm not sure if it can be replaced by self.os == :windows
+    WINDOWS_VARIANT_REGEX = /mswin32|cygwin|mingw|bccwin/
+
+    # e.g. 11/27/2020  01:02 AM    <SYMLINKD>     ExcludeSomething [C:\projects\arduino-ci\SampleProjects\ExcludeSomething]
+    DIR_SYMLINK_REGEX = %r{\d+/\d+/\d+\s+[^<]+<SYMLINKD?>\s+(.*) \[([^\]]+)\]}
+
     # Cross-platform way of finding an executable in the $PATH.
     # via https://stackoverflow.com/a/5471032/2063546
     #   which('ruby') #=> /usr/bin/ruby
@@ -38,21 +45,69 @@ module ArduinoCI
       return :windows if OS.windows?
     end
 
+    # Cross-platform symlinking
     # if on windows, call mklink, else self.symlink
     # @param [Pathname] old_path
     # @param [Pathname] new_path
     def self.symlink(old_path, new_path)
-      return FileUtils.ln_s(old_path.to_s, new_path.to_s) unless RUBY_PLATFORM =~ /mswin32|cygwin|mingw|bccwin/
+      # we would prefer `new_path.make_symlink(old_path)` but "symlink function is unimplemented on this machine" with windows
+      return new_path.make_symlink(old_path) unless needs_symlink_hack?
 
-      # https://stackoverflow.com/a/22716582/2063546
+      # via https://stackoverflow.com/a/22716582/2063546
       # windows mklink syntax is reverse of unix ln -s
       # windows mklink is built into cmd.exe
       # vulnerable to command injection, but okay because this is a hack to make a cli tool work.
-      orp = old_path.realpath.to_s.tr("/", "\\") # HACK DUE TO REALPATH BUG where it
-      np = new_path.to_s.tr("/", "\\")           # still joins windows paths with '/'
+      orp = pathname_to_windows(old_path.realpath)
+      np  = pathname_to_windows(new_path)
 
       _stdout, _stderr, exitstatus = Open3.capture3('cmd.exe', "/C mklink /D #{np} #{orp}")
       exitstatus.success?
     end
+
+    # Hack for "realpath" which on windows joins paths with slashes instead of backslashes
+    # @param path [Pathname] the path to render
+    # @return [String] A path that will work on windows
+    def self.pathname_to_windows(path)
+      path.to_s.tr("/", "\\")
+    end
+
+    # Hack for "realpath" which on windows joins paths with slashes instead of backslashes
+    # @param str [String] the windows path
+    # @return [Pathname] A path that will be recognized by pathname
+    def self.windows_to_pathname(str)
+      Pathname.new(str.tr("\\", "/"))
+    end
+
+    # Whether this OS requires a hack for symlinks
+    # @return [bool]
+    def self.needs_symlink_hack?
+      RUBY_PLATFORM =~ WINDOWS_VARIANT_REGEX
+    end
+
+    # Cross-platform is-this-a-symlink function
+    # @param [Pathname] path
+    # @return [bool] Whether the file is a symlink
+    def self.symlink?(path)
+      return path.symlink? unless needs_symlink_hack?
+
+      !readlink(path).nil?
+    end
+
+    # Cross-platform "read link" function
+    # @param [Pathname] path
+    # @return [Pathname] the link target
+    def self.readlink(path)
+      return path.readlink unless needs_symlink_hack?
+
+      the_dir  = pathname_to_windows(path.parent)
+      the_file = path.basename.to_s
+
+      stdout, _stderr, _exitstatus = Open3.capture3('cmd.exe', "/c dir /al #{the_dir}")
+      symlinks = stdout.lines.map { |l| DIR_SYMLINK_REGEX.match(l) }.compact
+      our_link = symlinks.find { |m| m[1] == the_file }
+      return nil if our_link.nil?
+
+      windows_to_pathname(our_link[2])
+    end
   end
 end

data/lib/arduino_ci/library_properties.rb

@@ -0,0 +1,96 @@
+module ArduinoCI
+
+  # Information about an Arduino library package, as specified by the library.properties file
+  #
+  # See https://arduino.github.io/arduino-cli/library-specification/#libraryproperties-file-format
+  class LibraryProperties
+
+    # @return [Hash] The properties file parsed as a hash
+    attr_reader :fields
+
+    # @param path [Pathname] The path to the library.properties file
+    def initialize(path)
+      @fields = {}
+      File.foreach(path) do |line_with_delim|
+        line = line_with_delim.chomp
+        parts = line.split("=", 2)
+        next if parts[0].nil?
+        next if parts[0].empty?
+        next if parts[1].nil?
+
+        @fields[parts[0]] = parts[1] unless parts[1].empty?
+      end
+    end
+
+    # @return [Hash] the properties as a hash, all strings
+    def to_h
+      @fields.clone
+    end
+
+    # Enable a shortcut syntax for library property accessors, in the style of `attr_accessor` metaprogramming.
+    # This is used to create a named field pointing to a specific property in the file, optionally applying
+    # a specific formatting function.
+    #
+    #  The formatting function MUST be a static method on this class.  This is a limitation caused by the desire
+    #  to both (1) expose the formatters outside this class, and (2) use them for metaprogramming without the
+    #  having to name the entire function.  field_reader is a static method, so if not for the fact that
+    #  `self.class.methods.include? formatter` fails to work for class methods in this context (unlike
+    #  `self.methods.include?`, which properly finds instance methods), I would allow either one and just
+    #  conditionally `define_method` the proper definition
+    #
+    # @param name [String] What the accessor will be called
+    # @param field_num [Integer] The name of the key of the property
+    # @param formatter [Symbol] The symbol for the formatting function to apply to the field (optional)
+    # @return [void]
+    # @macro [attach] field_reader
+    #   @!attribute [r] $1
+    #   @return property $2 of the library.properties file, formatted with the function {$3}
+    def self.field_reader(name, formatter = nil)
+      key = name.to_s
+      if formatter.nil?
+        define_method(name) { @fields[key] }
+      else
+        define_method(name) { @fields.key?(key) ? self.class.send(formatter.to_sym, @fields[key]) : nil }
+      end
+    end
+
+    # Parse a value as a comma-separated array
+    # @param input [String]
+    # @return [Array<String>] The individual values
+    def self._csv(input)
+      input.split(",").map(&:strip)
+    end
+
+    # Parse a value as a boolean
+    # @param input [String]
+    # @return [Array<String>] The individual values
+    def self._bool(input)
+      input == "true"  # no indication given in the docs that anything but lowercase "true" indicates boolean true.
+    end
+
+    field_reader :name
+    field_reader :version
+    field_reader :author, :_csv
+    field_reader :maintainer
+    field_reader :sentence
+    field_reader :paragraph
+    field_reader :category
+    field_reader :url
+    field_reader :architectures, :_csv
+    field_reader :depends, :_csv
+    field_reader :dot_a_linkage, :_bool
+    field_reader :includes, :_csv
+    field_reader :precompiled, :_bool
+    field_reader :ldflags, :_csv
+
+    # The value of sentence always will be prepended, so you should start by writing the second sentence here
+    #
+    # (according to the docs)
+    # @return [String] the sentence and paragraph together
+    def full_paragraph
+      [sentence, paragraph].join(" ")
+    end
+
+  end
+
+end

data/lib/arduino_ci/version.rb

@@ -1,3 +1,3 @@
 module ArduinoCI
-  VERSION = "0.1.21".freeze
+  VERSION = "1.0.0".freeze
 end

data/misc/default.yml

@@ -3,7 +3,12 @@
 #   https://en.wikipedia.org/wiki/List_of_Arduino_boards_and_compatible_systems
 
 packages:
-  # arduino:xxx are builtin, we don't need to include them here
+  arduino:avr:
+    url: https://downloads.arduino.cc/packages/package_index.json
+  arduino:sam:
+    url: https://downloads.arduino.cc/packages/package_index.json
+  arduino:samd:
+    url: https://downloads.arduino.cc/packages/package_index.json
   esp8266:esp8266:
     url: http://arduino.esp8266.com/stable/package_esp8266com_index.json
   adafruit:avr:
@@ -21,7 +26,10 @@ platforms:
     gcc:
       features:
       defines:
+        - __AVR__
         - __AVR_ATmega328P__
+        - ARDUINO_ARCH_AVR
+        - ARDUINO_AVR_UNO
       warnings:
       flags:
   due:
@@ -30,7 +38,10 @@ platforms:
     gcc:
       features:
       defines:
-        - __AVR_ATmega328__
+        - __SAM3X8E__
+        - ARDUINO_ARCH_SAM
+        - ARDUINO_SAM_DUE
+        - NUM_SERIAL_PORTS=4
       warnings:
       flags:
   zero:
@@ -39,8 +50,11 @@ platforms:
     gcc:
       features:
       defines:
-       - __SAMD21G18A__
-       - ARDUINO_SAMD_ZERO
+        - __SAMD21G18A__
+        - ARDUINO_ARCH_SAMD
+        - ARDUINO_SAMD_ZERO
+        # This also has SerialUSB, which is not included here.
+        - NUM_SERIAL_PORTS=2
       warnings:
       flags:
   esp32:
@@ -49,6 +63,10 @@ platforms:
     gcc:
       features:
       defines:
+        - ESP32
+        - ARDUINO_ARCH_ESP32
+        - ARDUINO_FEATHER_ESP32
+        - NUM_SERIAL_PORTS=3
       warnings:
       flags:
   esp8266:
@@ -57,6 +75,10 @@ platforms:
     gcc:
       features:
       defines:
+        - ESP8266
+        - ARDUINO_ARCH_ESP8266
+        - ARDUINO_ESP8266_ESP12
+        - NUM_SERIAL_PORTS=2
       warnings:
       flags:
   leonardo:
@@ -65,7 +87,10 @@ platforms:
     gcc:
       features:
       defines:
+        - __AVR__
         - __AVR_ATmega32U4__
+        - ARDUINO_ARCH_AVR
+        - ARDUINO_AVR_LEONARDO
       warnings:
       flags:
   trinket:
@@ -74,6 +99,10 @@ platforms:
     gcc:
       features:
       defines:
+        - __AVR__
+        - __AVR_ATtiny85__
+        - ARDUINO_ARCH_AVR
+        - ARDUINO_AVR_TRINKET5
       warnings:
       flags:
   gemma:
@@ -82,6 +111,10 @@ platforms:
     gcc:
       features:
       defines:
+        - __AVR__
+        - __AVR_ATtiny85__
+        - ARDUINO_ARCH_AVR
+        - ARDUINO_AVR_GEMMA
       warnings:
       flags:
   m4:
@@ -90,6 +123,12 @@ platforms:
     gcc:
       features:
       defines:
+        - __SAMD51__
+        - __SAMD51J19A__
+        - ARDUINO_ARCH_SAMD
+        - ARDUINO_METRO_M4
+        # Serial is actually USB virtual serial, not HardwareSerial
+        - NUM_SERIAL_PORTS=2
       warnings:
       flags:
   mega2560:
@@ -98,7 +137,10 @@ platforms:
     gcc:
       features:
       defines:
+        - __AVR__
         - __AVR_ATmega2560__
+        - ARDUINO_ARCH_AVR
+        - ARDUINO_AVR_MEGA2560
       warnings:
       flags:
   cplayClassic:
@@ -107,6 +149,10 @@ platforms:
     gcc:
       features:
       defines:
+        - __AVR__
+        - __AVR_ATmega32U4__
+        - ARDUINO_ARCH_AVR
+        - ARDUINO_AVR_CIRCUITPLAY
       warnings:
       flags:
   cplayExpress:
@@ -115,6 +161,11 @@ platforms:
     gcc:
       features:
       defines:
+        - __SAMD21G18A__
+        - ARDUINO_ARCH_SAMD
+        - ARDUINO_SAMD_CIRCUITPLAYGROUND_EXPRESS
+        # Serial is actually an alias of SerialUSB, not a HardwareSerial
+        - NUM_SERIAL_PORTS=2
       warnings:
       flags:
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arduino_ci
 version: !ruby/object:Gem::Version
-  version: 0.1.21
+  version: 1.0.0
 platform: ruby
 authors:
 - Ian Katz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-07 00:00:00.000000000 Z
+date: 2020-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: os
@@ -38,104 +38,42 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.15'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.15'
-- !ruby/object:Gem::Dependency
-  name: keepachangelog_manager
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.0.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.0.1
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.59.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.59.0
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.11
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.11
 description: ''
 email:
-- ianfixes@gmail.com
+- arduino.continuous.integration@gmail.com
 executables:
+- arduino_ci.rb
 - arduino_ci_remote.rb
 - arduino_library_location.rb
 - ensure_arduino_installation.rb
-- libasan.rb
 extensions: []
 extra_rdoc_files: []
 files:
 - ".yardopts"
 - README.md
+- REFERENCE.md
 - cpp/arduino/Arduino.cpp
 - cpp/arduino/Arduino.h
-- cpp/arduino/Arduino.h.orig
 - cpp/arduino/ArduinoDefines.h
 - cpp/arduino/AvrMath.h
+- cpp/arduino/Client.h
+- cpp/arduino/EEPROM.h
 - cpp/arduino/Godmode.cpp
 - cpp/arduino/Godmode.h
 - cpp/arduino/HardwareSerial.h
+- cpp/arduino/IPAddress.h
+- cpp/arduino/MockEventQueue.h
 - cpp/arduino/PinHistory.h
 - cpp/arduino/Print.h
+- cpp/arduino/Printable.h
 - cpp/arduino/SPI.h
+- cpp/arduino/Server.h
 - cpp/arduino/SoftwareSerial.h
 - cpp/arduino/Stream.h
+- cpp/arduino/Udp.h
 - cpp/arduino/WCharacter.h
 - cpp/arduino/WString.h
+- cpp/arduino/Wire.h
 - cpp/arduino/avr/README.md
 - cpp/arduino/avr/common.h
 - cpp/arduino/avr/fuse.h
@@ -414,8 +352,8 @@ files:
 - cpp/arduino/binary.h
 - cpp/arduino/ci/DeviceUsingBytes.h
 - cpp/arduino/ci/ObservableDataStream.h
-- cpp/arduino/ci/Queue.h
 - cpp/arduino/ci/README.md
+- cpp/arduino/ci/StreamTape.h
 - cpp/arduino/ci/Table.h
 - cpp/arduino/stdlib.cpp
 - cpp/arduino/stdlib.h
@@ -424,16 +362,12 @@ files:
 - cpp/unittest/Assertion.h
 - cpp/unittest/Compare.h
 - cpp/unittest/OstreamHelpers.h
+- exe/arduino_ci.rb
 - exe/arduino_ci_remote.rb
 - exe/arduino_library_location.rb
 - exe/ensure_arduino_installation.rb
-- exe/libasan.rb
 - lib/arduino_ci.rb
-- lib/arduino_ci/arduino_cmd.rb
-- lib/arduino_ci/arduino_cmd_linux.rb
-- lib/arduino_ci/arduino_cmd_linux_builder.rb
-- lib/arduino_ci/arduino_cmd_osx.rb
-- lib/arduino_ci/arduino_cmd_windows.rb
+- lib/arduino_ci/arduino_backend.rb
 - lib/arduino_ci/arduino_downloader.rb
 - lib/arduino_ci/arduino_downloader_linux.rb
 - lib/arduino_ci/arduino_downloader_osx.rb
@@ -442,9 +376,10 @@ files:
 - lib/arduino_ci/ci_config.rb
 - lib/arduino_ci/cpp_library.rb
 - lib/arduino_ci/host.rb
+- lib/arduino_ci/library_properties.rb
 - lib/arduino_ci/version.rb
 - misc/default.yml
-homepage: http://github.com/ianfixes/arduino_ci
+homepage: http://github.com/Arduino-CI/arduino_ci
 licenses:
 - Apache-2.0
 metadata: {}