arduino_ci 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0c01ddca13fd4bd941dcff9e9faeeae700f184bbf647876d520c7ccfce0c87b3
+  data.tar.gz: 974ce43ef7eba01113b9470750c78ad4cc5f81f0296f72f18ce43def9ad1c597
+SHA512:
+  metadata.gz: a044d9ab06badda8a648f189786c14209d7bee59d4ba299dc8790bd29e54adfd107f15a53fcb28d7ad7f286c6daf3e559f6a09b15b3f625c5344c400b0a4c5e8
+  data.tar.gz: f134b211ce71483ee88794a8a9d9f742deed82ee3d93ccecbbdd745ff53af12d6b44f71e2480c7ea98ce60d62bb28f0553c22b773bd6376ea7854bae29f19c9c

data/.yardopts

@@ -0,0 +1 @@
+lib/arduino_ci.rb lib/**/*.rb

data/README.md

@@ -0,0 +1,39 @@
+[![Gem Version](https://badge.fury.io/rb/arduino_ci.svg)](https://rubygems.org/gems/arduino_ci)
+[![Build Status](https://travis-ci.org/ifreecarve/arduino_ci.svg)](https://travis-ci.org/ifreecarve/arduino_ci)
+[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/gems/arduino_ci/)
+
+# ArduinoCI Ruby gem (`arduino_ci`)
+
+[Arduino CI](https://github.com/ifreecarve/arduino_ci) is a Ruby gem for executing Continuous Integration (CI) tests on an Arduino library -- both locally and as part of a service like Travis CI.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'arduino_ci'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install arduino_ci
+
+
+## Usage
+
+TODO: Write usage instructions here, based on other TODO of writing the actual gem.
+
+
+## Author
+
+This gem was written by Ian Katz (ifreecarve@gmail.com) in 2018.  It's released under the Apache 2.0 license.
+
+
+## See Also
+
+* [Contributing](CONTRIBUTING.md)

data/lib/arduino_ci.rb

@@ -0,0 +1,124 @@
+require "arduino_ci/version"
+
+require 'singleton'
+
+# Cross-platform way of finding an executable in the $PATH.
+# via https://stackoverflow.com/a/5471032/2063546
+#   which('ruby') #=> /usr/bin/ruby
+def which(cmd)
+  exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+  ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+    exts.each do |ext|
+      exe = File.join(path, "#{cmd}#{ext}")
+      return exe if File.executable?(exe) && !File.directory?(exe)
+    end
+  end
+  nil
+end
+
+# ArduinoCI contains classes for automated testing of Arduino code on the command line
+# @author Ian Katz <ifreecarve@gmail.com>
+module ArduinoCI
+
+  # Wrap the Arduino executable.  This requires, in some cases, a faked display.
+  class ArduinoCmd
+
+    # create as many ArduinoCmds as you like, but we need one and only one display manager
+    class DisplayMgr
+      include Singleton
+      attr_reader :enabled
+
+      def initialize
+        @existing = existing_display?
+        @enabled = false
+        @pid = nil
+      end
+
+      # attempt to determine if the machine is running a graphical display (i.e. not Travis)
+      def existing_display?
+        return true if RUBY_PLATFORM.include? "darwin"
+        return true if ENV["DISPLAY"].nil?
+        return true if ENV["DISPLAY"].include? ":"
+        false
+      end
+
+      # enable a virtual display
+      def enable
+        return @enabled = true if @existing   # silent no-op if built in display
+        return unless @pid.nil?
+
+        @enabled = true
+        @pid = fork do
+          puts "Forking Xvfb"
+          system("Xvfb", ":1", "-ac", "-screen", "0", "1280x1024x16")
+          puts "Xvfb unexpectedly quit!"
+        end
+        sleep(3)  # TODO: test a connection to the X server?
+      end
+
+      # disable the virtual display
+      def disable
+        return @enabled = false if @existing  # silent no-op if built in display
+        return if @pid.nil?
+
+        begin
+          Process.kill 9, @pid
+        ensure
+          Process.wait @pid
+          @pid = nil
+        end
+        puts "Xvfb killed"
+      end
+
+      # Enable a virtual display for the duration of the given block
+      def with_display
+        enable
+        begin
+          yield environment
+        ensure
+          disable
+        end
+      end
+
+      def environment
+        return nil unless @existing || @enabled
+        return {} if @existing
+        { DISPLAY => ":1.0" }
+      end
+
+      # On finalize, ensure child process is ended
+      def self.finalize
+        disable
+      end
+    end
+
+    class << self
+      protected :new
+
+      # attempt to find a workable Arduino executable across platforms
+      def guess_executable_location
+        osx_place = "/Applications/Arduino.app/Contents/MacOS/Arduino"
+        places = {
+          "arduino" => !which("arduino").nil?,
+          osx_place => (File.exist? osx_place),
+        }
+        places.each { |k, v| return k if v }
+        nil
+      end
+
+      def autolocate
+        ret = new
+        ret.path = guess_executable_location
+        ret
+      end
+    end
+
+    attr_accessor :path
+
+    def initialize
+      @display_mgr = DisplayMgr::instance
+    end
+
+  end
+
+end

data/lib/arduino_ci/version.rb

@@ -0,0 +1,3 @@
+module ArduinoCI
+  VERSION = "0.0.1".freeze
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: arduino_ci
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ian Katz
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-10 00:00:00.000000000 Z
+dependencies:
+- !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: 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'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.46.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.46.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: ''
+email:
+- ifreecarve@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".yardopts"
+- README.md
+- lib/arduino_ci.rb
+- lib/arduino_ci/version.rb
+homepage: http://github.com/ifreecarve/arduino_ci
+licenses:
+- Apache-2.0
+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.7.4
+signing_key: 
+specification_version: 4
+summary: Tools for building and unit testing Arduino libraries
+test_files: []