lignite 0.2.0 → 0.3.0

data/lib/lignite/motors.rb

@@ -6,10 +6,10 @@ module Lignite
     # do the DCs spawn independent threads??
     # must run ready in the same block?
 
-    attr :layer
-    attr :nos
+    attr_reader :layer
+    attr_reader :nos
     # @return [Lignite::DirectCommands]
-    attr :dc
+    attr_reader :dc
 
     # 0x02 | 0x04 | 0x08 -> [1, 2, 3]
     def nos_as_indices
@@ -24,7 +24,7 @@ module Lignite
       @dc = dc
     end
 
-    # TODO filter out support: official: no
+    # TODO: filter out support: official: no
 
     # the type is an OUT param so the VM SETs and we GET to learn the type?
     def set_type
@@ -62,7 +62,7 @@ module Lignite
     end
 
     def start
-      dc.output_start(layer, nos)   # apparently not
+      dc.output_start(layer, nos) # apparently not
     end
 
     # ATTR ~polarity

data/lib/lignite/op_compiler.rb

@@ -119,7 +119,7 @@ module Lignite
       end
 
       enums = yml["enums"]
-      enums.each do |ename, edata|
+      enums.each_value do |edata|
         edata["members"].each do |mname, mdata|
           load_const(mname, mdata["value"])
         end
@@ -177,29 +177,30 @@ module Lignite
     end
 
     def make_lc(n, bytes = nil)
-      bytes ||= if (-31 .. 31).include? n
-                  0
-                elsif (-127 .. 127).include? n
-                  1
-                elsif (-32767 .. 32767).include? n
-                  2
-                else
-                  4
-                end
+      bytes ||= if (-31..31).cover? n
+        0
+      elsif (-127..127).cover? n
+        1
+      elsif (-32767..32767).cover? n
+        2
+      else
+        4
+      end
       make_lcn(n, bytes)
     end
 
     def make_v(n, local_or_global)
       vartag = PRIMPAR_VARIABEL | local_or_global
-      if (0 .. 31).include? n
-        return [vartag | (n & PRIMPAR_VALUE)]
-      elsif (0 .. 255).include? n
-        return [vartag | PRIMPAR_LONG | PRIMPAR_1_BYTE, n & 0xff]
-      elsif (0 .. 65535).include? n
-        return [vartag | PRIMPAR_LONG | PRIMPAR_2_BYTES, n & 0xff, (n >> 8) & 0xff]
+      if (0..31).cover? n
+        [vartag | (n & PRIMPAR_VALUE)]
+      elsif (0..255).cover? n
+        [vartag | PRIMPAR_LONG | PRIMPAR_1_BYTE, n & 0xff]
+      elsif (0..65535).cover? n
+        [vartag | PRIMPAR_LONG | PRIMPAR_2_BYTES, n & 0xff, (n >> 8) & 0xff]
+      else
+        [vartag | PRIMPAR_LONG | PRIMPAR_4_BYTES,
+         n & 0xff, (n >> 8) & 0xff, (n >> 16) & 0xff, (n >> 24) & 0xff]
       end
-      [vartag | PRIMPAR_LONG | PRIMPAR_4_BYTES,
-       n & 0xff, (n >> 8) & 0xff, (n >> 16) & 0xff, (n >> 24) & 0xff]
     end
 
     # Reference a variable.

data/lib/lignite/rbf_object.rb

@@ -18,7 +18,7 @@ module Lignite
     end
 
     # @return [ByteString] an already assembled body of the object
-    attr :body
+    attr_reader :body
 
     def initialize(owner:, triggers:, local_bytes:, body:)
       @owner = owner

data/lib/lignite/system_commands.rb

@@ -4,12 +4,24 @@ module Lignite
     include Logger
     extend Logger
 
+    def self.run(conn = Connection.create, &block)
+      sc = new(conn)
+      sc.instance_exec(&block)
+      sc.close
+    end
+
     # @param conn [Connection]
     def initialize(conn = Connection.create)
-      @message_sender = MessageSender.new(conn)
+      @conn = conn
       load_yml
     end
 
+    def close
+      @conn.close
+    end
+
+    private
+
     def load_yml
       fname = File.expand_path("../../../data/sysops.yml", __FILE__)
       op_hash = YAML.load_file(fname)["sysops"]
@@ -38,7 +50,7 @@ module Lignite
         end.join("")
         logger.debug "sysop to execute: #{bytes.inspect}"
 
-        reply = @message_sender.system_command_with_reply(bytes)
+        reply = system_command_with_reply(bytes)
 
         # TODO: parse it with return_handlers
         replies = return_handlers.map do |h|
@@ -99,5 +111,21 @@ module Lignite
       end
     end
 
+    def system_command_with_reply(instr_bytes)
+      cmd = Message.system_command_with_reply(instr_bytes)
+      @conn.send(cmd.bytes)
+
+      reply = Message.reply_from_bytes(@conn.receive)
+      assert_match(reply.msgid, cmd.msgid, "Reply id")
+      assert_match(reply.command, unpack_u8(instr_bytes[0]), "Command num")
+      raise VMError, format("Error: %u", reply.status) if reply.error?
+
+      reply.data
+    end
+
+    def assert_match(actual, expected, description)
+      return if actual == expected
+      raise "#{description} does not match, expected #{expected}, actual #{actual}"
+    end
   end
 end

data/lib/lignite/variables.rb

@@ -14,7 +14,7 @@ module Lignite
     # declare
     def add(id, size, unpacker)
       raise "Duplicate variable #{id}" if @vars.key?(id)
-      @vars[id] = {offset: @offset, size: size}
+      @vars[id] = { offset: @offset, size: size }
       @offset += size
       @unpacker += unpacker
     end
@@ -41,7 +41,7 @@ module Lignite
     end
   end
 
-  # {#variables} are {Variables}
+  # `variables` are {Variables}
   module VariableDeclarer
     def data8(id)
       variables.add(id, 1, "C")

data/lignite.gemspec

@@ -1,5 +1,3 @@
-# -*- encoding: utf-8 -*-
-
 require File.expand_path(File.dirname(__FILE__) + "/lib/lignite/version")
 
 Gem::Specification.new do |s|
@@ -20,6 +18,8 @@ TXT
   s.files       = [
     ".coveralls.yml",
     ".gitignore",
+    ".rspec",
+    ".rubocop.yml",
     ".travis.yml",
     ".yardopts",
     "COPYING",
@@ -34,22 +34,27 @@ TXT
     "data/sysops.yml",
     "examples/bobbee.rb",
     "examples/hello.rb",
+    "examples/hello.yml",
     "examples/light-sensor.rb",
+    "examples/light-sensor.yml",
     "examples/lights.rb",
+    "examples/lights.yml",
     "examples/motors.rb",
     "examples/sound.rb",
     "examples/sys_list_files.rb",
+    "examples/sys_list_files.yml",
     "lib/lignite.rb",
     "lib/lignite/assembler.rb",
     "lib/lignite/body_compiler.rb",
     "lib/lignite/bytes.rb",
     "lib/lignite/connection.rb",
     "lib/lignite/connection/bluetooth.rb",
+    "lib/lignite/connection/replay.rb",
+    "lib/lignite/connection/tap.rb",
     "lib/lignite/connection/usb.rb",
     "lib/lignite/direct_commands.rb",
     "lib/lignite/logger.rb",
     "lib/lignite/message.rb",
-    "lib/lignite/message_sender.rb",
     "lib/lignite/motors.rb",
     "lib/lignite/op_compiler.rb",
     "lib/lignite/rbf_object.rb",
@@ -57,7 +62,9 @@ TXT
     "lib/lignite/variables.rb",
     "lib/lignite/version.rb",
     "lignite.gemspec",
+    "rubocop-suse.yml",
     "spec/assembler_spec.rb",
+    "spec/connection_usb_spec.rb",
     "spec/data/ColorReadout.lms",
     "spec/data/ColorReadout.rb",
     "spec/data/ColorReadout.rbf",
@@ -72,13 +79,16 @@ TXT
     "spec/data/VernierReadout.lms",
     "spec/data/VernierReadout.rb",
     "spec/data/VernierReadout.rbf",
-    "spec/spec_helper.rb"
+    "spec/direct_commands_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/system_commands_spec.rb"
   ]
 
   s.executables = s.files.grep(/^bin\//) { |f| File.basename(f) }
 
   s.required_ruby_version = ">= 2.1" # mandatory keyword arguments
   s.add_dependency "libusb", "~> 0.6"
+  s.add_dependency "thor", "~> 0.19"
 
   s.add_development_dependency "coveralls", "~> 0"
   s.add_development_dependency "simplecov", "~> 0"

data/rubocop-suse.yml

@@ -0,0 +1,74 @@
+# This is the shared Rubocop configuration for SUSE projects. It is maintained
+# at https://github.com/SUSE/style-guides/blob/master/rubocop-suse.yml
+#
+# The configuration is tested and used with the Rubocop version used by Hound
+# (https://houndci.com).
+#
+# We use the default Hound config as a baseline:
+#
+#   https://raw.githubusercontent.com/thoughtbot/hound/master/config/style_guides/ruby.yml
+#
+# This file contains the rules with derive from this.
+
+Lint/EndAlignment:
+  StyleGuide: https://github.com/SUSE/style-guides/blob/master/Ruby.md#lintendalignment
+  EnforcedStyleAlignWith: variable
+
+Metrics/AbcSize:
+  StyleGuide: https://github.com/SUSE/style-guides/blob/master/Ruby.md#metricsabcsize
+  Max: 30
+
+Metrics/LineLength:
+  StyleGuide: https://github.com/SUSE/style-guides/blob/master/Ruby.md#metricslinelength
+  Max: 100
+  # To make it possible to copy or click on URIs in the code, we allow lines
+  # contaning a URI to be longer than Max.
+  AllowURI: true
+  URISchemes:
+    - http
+    - https
+
+Style/AlignHash:
+  StyleGuide: https://github.com/SUSE/style-guides/blob/master/Ruby.md#stylealignhash
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+
+Style/AlignParameters:
+  StyleGuide: https://github.com/SUSE/style-guides/blob/master/Ruby.md#stylealignparameters
+  Enabled: false
+
+Style/CollectionMethods:
+  StyleGuide: https://github.com/SUSE/style-guides/blob/master/Ruby.md#stylecollectionmethods
+  Enabled: false
+
+Style/EmptyLinesAroundBlockBody:
+  StyleGuide: https://github.com/SUSE/style-guides/blob/master/Ruby.md#styleemptylinesaroundblockbody
+  Enabled: false
+
+Style/MultilineOperationIndentation:
+  StyleGuide: https://github.com/SUSE/style-guides/blob/master/Ruby.md#stylemultilineoperationindentation
+  EnforcedStyle: indented
+
+Style/StringLiterals:
+  StyleGuide: https://github.com/SUSE/style-guides/blob/master/Ruby.md#stylestringliterals
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  StyleGuide: https://github.com/SUSE/style-guides/blob/master/Ruby.md#stylestringliteralsininterpolation
+  EnforcedStyle: double_quotes
+
+Style/WordArray:
+  StyleGuide: https://github.com/SUSE/style-guides/blob/master/Ruby.md#deviations-from-the-upstream-style-guide
+  Enabled: false
+
+Style/RegexpLiteral:
+  StyleGuide: https://github.com/SUSE/style-guides/blob/master/Ruby.md#deviations-from-the-upstream-style-guide
+  Enabled: false
+
+Style/SignalException:
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#fail-method
+  EnforcedStyle: only_raise
+
+Style/NumericLiterals:
+  StyleGuide: https://github.com/SUSE/style-guides/blob/master/Ruby.md#stylenumericliterals
+  Enabled: false

data/spec/connection_usb_spec.rb

@@ -0,0 +1,42 @@
+require_relative "spec_helper"
+require "lignite"
+
+describe Lignite::Connection::Usb do
+  let(:device) do
+    instance_double("FakeDevice", interfaces: [interface])
+  end
+  let(:interface) { double("FakeInterface", endpoints: [in_ep, out_ep]) }
+  let(:in_ep) { double("InEndpoint", direction: :in) }
+  let(:out_ep) { double("OutEndpoint", direction: :out) }
+  let(:dev_handle) { double("FakeDevHandle") }
+
+  before(:each) do
+    usb = instance_double("FakeContext", devices: [device])
+    allow(LIBUSB::Context).to receive(:new).and_return(usb)
+    allow(dev_handle).to receive(:"auto_detach_kernel_driver=")
+    allow(dev_handle).to receive(:claim_interface).and_yield
+  end
+
+  describe "#write" do
+    it "does not crash" do
+      data = "hello"
+      allow(device).to receive(:open).and_yield(dev_handle)
+      allow(dev_handle).to receive(:interrupt_transfer).and_return(data.bytesize)
+      expect { subject.write(data) }.to_not raise_error
+    end
+  end
+
+  describe "#read" do
+    it "does not crash" do
+      allow(device).to receive(:open).and_yield(dev_handle)
+      allow(dev_handle).to receive(:interrupt_transfer).and_return("hello")
+      expect(subject.read(1000)).to eq("hello")
+    end
+  end
+
+  describe "#write" do
+    it "does not crash" do
+      expect { subject.close }.to_not raise_error
+    end
+  end
+end

data/spec/data/ColorReadout.rb

@@ -15,38 +15,37 @@ vmthread :MAIN do
   data8 :Mode
   data8 :State
 
-
   move8_8(3, :Mode)
 
-  self.loop do
+  loop do
     ui_draw(FILLWINDOW, 0x00, 0, 0)
     ui_draw(SELECT_FONT, SMALL_FONT)
-    ui_draw(TEXT, FG_COLOR, 0, 10, ' Color Readout  V0.00 ')
-    ui_draw(TEXT, FG_COLOR, 0, 30, 'Mode ')
+    ui_draw(TEXT, FG_COLOR, 0, 10, " Color Readout  V0.00 ")
+    ui_draw(TEXT, FG_COLOR, 0, 30, "Mode ")
 
-    ui_draw(TEXT, FG_COLOR, 0, 50, 'Raw 1')
-    ui_draw(TEXT, FG_COLOR, 0, 65, 'Raw 2')
-    ui_draw(TEXT, FG_COLOR, 0, 80, 'Raw 3')
-    ui_draw(TEXT, FG_COLOR, 0, 118, 'Left = 3     Right = 4')
+    ui_draw(TEXT, FG_COLOR, 0, 50, "Raw 1")
+    ui_draw(TEXT, FG_COLOR, 0, 65, "Raw 2")
+    ui_draw(TEXT, FG_COLOR, 0, 80, "Raw 3")
+    ui_draw(TEXT, FG_COLOR, 0, 118, "Left = 3     Right = 4")
     ui_draw(SELECT_FONT, NORMAL_FONT)
 
     move8_32(:Mode, :Data1)
     and32(:Data1, 0xFF, :Data1)
-    strings(NUMBER_FORMATTED, :Data1, '%1d', 8, :String)
+    strings(NUMBER_FORMATTED, :Data1, "%1d", 8, :String)
     ui_draw(TEXT, FG_COLOR, 64, 30, :String)
 
     input_device(READY_RAW, 0, PORT, 0, :Mode, 3, :Data1, :Data2, :Data3)
 
     and32(:Data1, 0xFFFF, :Data1)
-    strings(NUMBER_FORMATTED, :Data1, '%-5d', 8, :String)
+    strings(NUMBER_FORMATTED, :Data1, "%-5d", 8, :String)
     ui_draw(TEXT, FG_COLOR, 64, 50, :String)
 
     and32(:Data2, 0xFFFF, :Data2)
-    strings(NUMBER_FORMATTED, :Data2, '%-5d', 8, :String)
+    strings(NUMBER_FORMATTED, :Data2, "%-5d", 8, :String)
     ui_draw(TEXT, FG_COLOR, 64, 65, :String)
 
     and32(:Data3, 0xFFFF, :Data3)
-    strings(NUMBER_FORMATTED, :Data3, '%-5d', 8, :String)
+    strings(NUMBER_FORMATTED, :Data3, "%-5d", 8, :String)
     ui_draw(TEXT, FG_COLOR, 64, 80, :String)
 
     ui_draw(UPDATE)

data/spec/data/HelloWorld-subop.rb

@@ -1,6 +1,6 @@
 vmthread :MAIN do
   ui_draw(FILLWINDOW, 0x00, 0, 0)
-  ui_draw(TEXT, FG_COLOR, 10, 50, 'Hello, world!')
+  ui_draw(TEXT, FG_COLOR, 10, 50, "Hello, world!")
   ui_draw(UPDATE)
   ui_button(WAIT_FOR_PRESS)
 end

data/spec/data/HelloWorld.rb

@@ -1,6 +1,6 @@
 vmthread :MAIN do
   ui_draw_fillwindow(0x00, 0, 0)
-  ui_draw_text(1, 10, 50, 'Hello, world!')
+  ui_draw_text(1, 10, 50, "Hello, world!")
   ui_draw_update
   ui_button_wait_for_press
 end

data/spec/data/NoDebug.rb

@@ -1,4 +1,4 @@
-appv = 'NoDebug V1.02'
+appv = "NoDebug V1.02"
 
 vmthread :MAIN do
   data8 :ShowVersion

data/spec/data/VernierReadout.rb

@@ -5,18 +5,18 @@ vmthread :MAIN do
   data32 :Data1
   datas :String, 8
 
-  self.loop do
+  loop do
     ui_draw(FILLWINDOW, 0x00, 0, 0)
     ui_draw(SELECT_FONT, SMALL_FONT)
-    ui_draw(TEXT, FG_COLOR, 0, 10, 'Vernier Readout  V0.00')
+    ui_draw(TEXT, FG_COLOR, 0, 10, "Vernier Readout  V0.00")
 
-    ui_draw(TEXT, FG_COLOR, 0, 50, 'Raw 1')
+    ui_draw(TEXT, FG_COLOR, 0, 50, "Raw 1")
     ui_draw(SELECT_FONT, NORMAL_FONT)
 
     input_device(READY_RAW, 0, PORT, 1, 0, 1, :Data1)
 
     and32(:Data1, 0xFFFF, :Data1)
-    strings(NUMBER_FORMATTED, :Data1, '%-5d', 8, :String)
+    strings(NUMBER_FORMATTED, :Data1, "%-5d", 8, :String)
     ui_draw(TEXT, FG_COLOR, 64, 50, :String)
 
     ui_draw(UPDATE)