lignite 0.3.0 → 0.4.0

data/lignite.gemspec

@@ -52,7 +52,13 @@ TXT
     "lib/lignite/connection/replay.rb",
     "lib/lignite/connection/tap.rb",
     "lib/lignite/connection/usb.rb",
+    "lib/lignite/defines.rb",
+    "lib/lignite/defines.rb.erb",
     "lib/lignite/direct_commands.rb",
+    "lib/lignite/enums.rb",
+    "lib/lignite/enums.rb.erb",
+    "lib/lignite/ev3_ops.rb",
+    "lib/lignite/ev3_tool.rb",
     "lib/lignite/logger.rb",
     "lib/lignite/message.rb",
     "lib/lignite/motors.rb",
@@ -79,9 +85,17 @@ TXT
     "spec/data/VernierReadout.lms",
     "spec/data/VernierReadout.rb",
     "spec/data/VernierReadout.rbf",
+    "spec/data/ev3tool_download.yml",
+    "spec/data/ev3tool_list_files.yml",
+    "spec/data/ev3tool_start.yml",
+    "spec/data/ev3tool_stop.yml",
+    "spec/data/ev3tool_upload.yml",
+    "spec/data/everstorm.rbf",
     "spec/direct_commands_spec.rb",
+    "spec/ev3_tool_spec.rb",
     "spec/spec_helper.rb",
-    "spec/system_commands_spec.rb"
+    "spec/system_commands_spec.rb",
+    "tools/ops_from_yml"
   ]
 
   s.executables = s.files.grep(/^bin\//) { |f| File.basename(f) }
@@ -91,8 +105,9 @@ TXT
   s.add_dependency "thor", "~> 0.19"
 
   s.add_development_dependency "coveralls", "~> 0"
-  s.add_development_dependency "simplecov", "~> 0"
   s.add_development_dependency "rake", ">= 0", "< 99"
   s.add_development_dependency "rspec", "~> 3"
+  s.add_development_dependency "rubocop", "0.50.0"
+  s.add_development_dependency "simplecov", "~> 0"
   s.add_development_dependency "yard", "~> 0"
 end

data/spec/assembler_spec.rb

@@ -5,8 +5,6 @@ require "fileutils"
 
 describe Lignite::Assembler do
   shared_examples "compiles" do |base, asm_version|
-    let(:datadir) { File.expand_path("../data", __FILE__) }
-
     let(:in_rb) { "#{datadir}/#{base}.rb" }
     let(:actual_rbf) { "#{datadir}/#{base}.out.rbf" }
     let(:expected_rbf) { "#{datadir}/#{base}.rbf" }

data/spec/data/ev3tool_download.yml

@@ -0,0 +1,3 @@
+---
+- SEND: 0100019400102e2e2f70726a732f6576657273746f726d2f6576657273746f726d2e72626600
+- RECV: 0100039400a3040000004c45474fa304000065000e0004000000b8000000000000001a0000001a02000000000000000000002202000000000000000000003702000000000000000000004c02000000000000000000005b02000000000000000000006a02000000000000000000008302000000000000000000009c0200000000000000000000e8020000000000000a0000004c0300000000000004000000b60300000000000004000000fa03000000000000040000006e0400000000000000000000821b08841200841300820000820000841c01820000820000842e2e2f617070732f427269636b2050726f6772616d2f4f6e427269636b496d616765313200841101840500823500821900844556335253544f524d0084003000603000617c0462991d00021d000140991d0003812100014005820b0030014a30014b30014c30016364600282380068600e8232008e820000820100487d0948014e3160483000606d488202008215006948820a00820d007d02846f6b004e5194026251960548991d0000003f01443c444d414d821600424a8214009402628472696768740030014a4082030030004a991d00021d0001443c444d644d0a821500424b821300940262846c6566740030014b4082030030004b991d000381210001443c444d684d1b823500424c823300940262842e2e2f617070732f427269636b2050726f6772616d2f4f6e427269636b536f756e6430340030014c4082030030004c0b42638220ff0a300061a30007000a300061b100068164820000830000000000a600060a300061b1000681ce820000830000000000a600060a300061a5000222a500041ea600060a300061a500021ea5000422a600060aae0001816483000000008338040000830000000000a600010aae0001819c83000000008338040000830000000000a600010a300061b00006814b820000830000000000ae0001816483000000008338040000830000000000a60007aa0001ae0001819c83000000008338040000830000000000a60001aa0001a30006000a300161318132484161825700b10006816448830000000000a60006416182430036828a024085404486444161823400194882ffff484161822900b10006816448830000000000a60006416182150036821405408540448644194882ffff48426182d2ff0a300061b10006816482c80083fa00000001a60006aa0006b1000681648238ff83fa00000001a60006aa0006b10006816482c80083fa00000001a60006aa0006b1000681648238ff83fa00000001a60006aa0006a30006008583c80000004086409402628468657900960a30006194026284736e65657a6500b10006819c820000832c01000001a60006aa0006b100068164820000832c01000001a60040a30006000a300061940262846c65667400968583c8000000408640b0000681328238ff835e01000001a60006aa00068583c800000040864094026284726967687400968583c8000000408640b00006813282c80083c201000001a60006aa0006b0000681328238ff839600000001a60006aa0006a30006000a300061a3000f00940262842e2e2f617070732f427269636b2050726f6772616d2f4f6e427269636b536f756e64313100963000630a0000000000040000006e0400

data/spec/data/ev3tool_list_files.yml

@@ -0,0 +1,3 @@
+---
+- SEND: 0100019900102e2e2f70726a732f6576657273746f726d00
+- RECV: 010003990871010000003643413332454336363238354146383733443036453635354435373538304237203030303030344133206576657273746f726d2e7262660a353444464136454132353838303633394645343533454438414234424638413720303030303135334320736e65657a652e7273660a4636333133324538394331354433414346334432373737343639314132383134203030303031303041206865792e7273660a45314631454635413639443544424345313938304246304530374646363733442030303030313334432072696768742e7273660a3631384538383446334145423834314332354241374136463336333831384246203030303031444439206f6b302e7273660a4334333637354536383843384334343138364343444446393239353234423230203030303031354538206f6b312e7273660a4641373044304532303532413342384136413636353136454335313741314644203030303031424243206c6566742e7273660a2e2e2f0a2e2f0a

data/spec/data/ev3tool_start.yml

@@ -0,0 +1,4 @@
+---
+- SEND: 0100019900102e2e2f70726a732f2e2e2f70726a732f6576657273746f726d00
+- RECV: 010003990871010000003643413332454336363238354146383733443036453635354435373538304237203030303030344133206576657273746f726d2e7262660a353444464136454132353838303633394645343533454438414234424638413720303030303135334320736e65657a652e7273660a4636333133324538394331354433414346334432373737343639314132383134203030303031303041206865792e7273660a45314631454635413639443544424345313938304246304530374646363733442030303030313334432072696768742e7273660a3631384538383446334145423834314332354241374136463336333831384246203030303031444439206f6b302e7273660a4334333637354536383843384334343138364343444446393239353234423230203030303031354538206f6b312e7273660a4641373044304532303532413342384136413636353136454335313741314644203030303031424243206c6566742e7273660a2e2e2f0a2e2f0a
+- SEND: 0200800020c00801802e2e2f70726a732f6576657273746f726d2f6576657273746f726d2e7262660040440301404400

data/spec/data/ev3tool_stop.yml

@@ -0,0 +1,2 @@
+---
+- SEND: 01008000000201

data/spec/data/ev3tool_upload.yml

@@ -0,0 +1,5 @@
+---
+- SEND: 010001923b0000002e2e2f70726a732f48656c6c6f576f726c642f48656c6c6f576f726c642e72626600
+- RECV: 010003920000
+- SEND: 02000193004c45474f3b0000006d000100000000001c000000000000000000000084130000008405010a81328048656c6c6f2c20776f726c642100840083030a
+- RECV: 020003930800

data/spec/direct_commands_spec.rb

@@ -16,6 +16,7 @@ describe Lignite::DirectCommands do
       allow_any_instance_of(Lignite::DirectCommands).to receive(:sleep)
       ENV["LIGNITE_REPLAY"] = replay_yml
       expect { load(script) }.not_to raise_error
+      ENV["LIGNITE_REPLAY"] = nil
     end
   end
 

data/spec/ev3_tool_spec.rb

@@ -0,0 +1,71 @@
+require_relative "spec_helper"
+require "lignite/ev3_tool"
+
+require "fileutils"
+
+describe Lignite::Ev3Tool do
+  around(:each) do |example|
+    ENV["LIGNITE_REPLAY"] = replay
+    example.call
+    subject.close
+    ENV["LIGNITE_REPLAY"] = nil
+  end
+
+  before(:each) { Lignite::Message.reset_msgid }
+
+  describe "#raw_ls" do
+    let(:replay) { "#{datadir}/ev3tool_list_files.yml" }
+
+    it "communicates and returns the right thing" do
+      expected = [
+        "everstorm.rbf",
+        "sneeze.rsf",
+        "hey.rsf",
+        "right.rsf",
+        "ok0.rsf",
+        "ok1.rsf",
+        "left.rsf"
+      ]
+
+      expect(subject.raw_ls("everstorm")).to eq(expected)
+    end
+  end
+
+  describe "#start" do
+    let(:replay) { "#{datadir}/ev3tool_start.yml" }
+
+    it "communicates the right thing" do
+      expect { subject.start("everstorm") }.not_to raise_error
+    end
+  end
+
+  describe "#stop" do
+    let(:replay) { "#{datadir}/ev3tool_stop.yml" }
+
+    it "communicates the right thing" do
+      expect { subject.stop }.not_to raise_error
+    end
+  end
+
+  describe "#download" do
+    let(:replay) { "#{datadir}/ev3tool_download.yml" }
+
+    it "communicates the right thing" do
+      expected_file_contents = File.read("#{datadir}/everstorm.rbf", mode: "rb")
+      f = double("File")
+      expect(File).to receive(:open).with("everstorm.rbf", "w").and_yield(f)
+      allow(File).to receive(:open).and_call_original
+      expect(f).to receive(:write).with(expected_file_contents)
+
+      expect { subject.download("../prjs/everstorm/everstorm.rbf") }.not_to raise_error
+    end
+  end
+
+  describe "#upload" do
+    let(:replay) { "#{datadir}/ev3tool_upload.yml" }
+
+    it "communicates the right thing" do
+      expect { subject.upload("#{datadir}/HelloWorld.rbf") }.not_to raise_error
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -13,7 +13,8 @@ if ENV["COVERAGE"] || ENV["TRAVIS"]
   top = File.expand_path("../..", __FILE__)
   # track all ruby files under lib
   SimpleCov.track_files("#{top}/lib/**/*.rb")
-  SimpleCov.track_files("bin/ev3tool")
+  # filter out the huge generated file
+  SimpleCov.add_filter("ev3_ops.rb")
 
   # use coveralls for on-line code coverage reporting at Travis CI
   if ENV["TRAVIS"]
@@ -25,3 +26,7 @@ if ENV["COVERAGE"] || ENV["TRAVIS"]
   end
   SimpleCov.start
 end
+
+def datadir
+  File.expand_path("../data", __FILE__)
+end

data/tools/ops_from_yml

@@ -0,0 +1,176 @@
+#!/usr/bin/ruby
+require "yaml"
+require "erb"
+
+class TODO < RuntimeError
+end
+
+def load_const(name, value, desc)
+  "    # #{desc.to_s.chomp}\n" \
+  "    Lignite::#{name} = #{value.inspect}\n\n"
+end
+
+def rendered_file(yml_hash)
+  op_hash = yml_hash["ops"]
+
+  result = <<RUBY
+# This file is generated from ev3.yml. DO NOT EDIT.
+
+module Lignite
+  # Bytecodes implemented by EV3
+  module Ev3Ops
+#{rendered_ops(op_hash).chomp}
+  end
+end
+RUBY
+  result
+end
+
+# @return [String] Ruby code
+def rendered_ops(op_hash)
+  ss = op_hash.map do |oname, odata|
+    rendered_op2(oname, odata)
+  end
+  ss.join "\n"
+end
+
+# @param oname [String] "PROGRAM_STOP"
+# @return [String] Ruby code
+def rendered_op2(oname, odata)
+  ovalue = odata["value"]
+  oparams = odata["params"]
+  p1 = oparams.first
+  if p1 && p1["type"] == "SUBP"
+    commands = p1["commands"]
+    s = ""
+    commands.each do |cname, cdata|
+      cdesc = cdata["desc"]
+      cvalue = cdata["value"]
+      s << load_const(cname, cvalue, cdesc)
+      cparams = cdata["params"]
+      s << rendered_op4("#{oname}_#{cname}".downcase, cdesc, ovalue, cvalue, cparams)
+    end
+    s << rendered_multiop(oname, commands)
+    s
+  else
+    rendered_op4(oname.downcase, odata["desc"], ovalue, nil, oparams)
+  end
+end
+
+# @return [String] Ruby code
+def rendered_multiop(oname, commands)
+  names = commands.map do |cname, cdata|
+    csym = cname.downcase.to_sym
+    cvalue = cdata["value"]
+    [cvalue, csym]
+  end.to_h
+
+  osym = oname.downcase.to_sym
+
+  multiplex_values = names.map do |cvalue, csym|
+    "      #{cvalue} => #{csym.inspect},\n"
+  end
+
+  result = <<RUBY
+
+    MULTIPLEX_#{oname} = {
+#{multiplex_values.join("").chomp}
+    }.freeze
+
+    def #{osym}(*args)
+      logger.debug "called #{osym} with \#{args.inspect}"
+      cvalue = args.shift
+      csym = MULTIPLEX_#{oname}.fetch(cvalue)
+      __send__("#{osym}_\#{csym}", *args)
+    end
+RUBY
+  result
+end
+
+def param_handler(par)
+  par_type = par["type"]
+  case par_type
+  when "PAR8", "PAR16", "PAR32", "PARF"
+    :param_simple
+  when "PARNO"
+    :param_multiple
+  else
+    raise TODO, "Unhandled param type #{par_type}"
+  end
+end
+
+# @return [String] Ruby code
+def method_docs(odesc, params)
+  ss = params.map do |p|
+    n = p["name"].downcase
+    t = p["type"]
+    "    # @param #{n} [#{t}] (#{p["dir"]}) #{p["desc"]}\n"
+  end
+  "    # #{odesc.to_s.chomp}\n" + ss.join("")
+end
+
+# @param oname [String] "move32_32"
+# @param ovalue [Integer] 0x3A
+# @param cvalue [Integer,nil]
+# @return [String] Ruby code
+def rendered_op4(oname, odesc, ovalue, cvalue, params) # rubocop:disable Metrics/MethodLength
+  s = ""
+
+  param_handlers = params.map { |par| param_handler(par) }
+
+  param_names = params.map do |par|
+    (par["type"] == "PARNO" ? "*" : "") + par["name"].downcase
+  end
+  param_decl = param_names.join ", "
+  param_decl = "(#{param_decl})" unless param_decl.empty?
+
+  s << method_docs(odesc, params)
+  s << <<RUBY
+    def #{oname}#{param_decl}
+      logger.debug do
+        args = [#{param_names.join ", "}]
+        "called #{oname} with \#{args.inspect}"
+      end
+
+      bytes = u8(#{format("0x%02X", ovalue)})
+RUBY
+  s << "      bytes += param_simple(#{cvalue})\n" unless cvalue.nil?
+  param_names.zip(param_handlers).each do |pname, phand|
+    s << "      bytes += #{phand}(#{pname})\n"
+  end
+  s << <<RUBY
+      logger.debug "returning bytecode: \#{bytes.inspect}"
+      bytes
+    end
+RUBY
+  s
+rescue TODO => e
+  "    # Could not define #{oname}: #{e.message}\n"
+end
+
+def whitespace_cleanup(s)
+  s.lines.map(&:rstrip).join("\n") + "\n"
+end
+
+def render_erb_file(erb_filename, a_binding)
+  safe = nil
+  trim = "<>-"
+  erb = ERB.new(File.read(erb_filename), safe, trim)
+  out_filename = erb_filename.sub(/\.erb$/, "")
+  header = "# This file is generated from its .erb template. DO NOT EDIT.\n\n"
+  rendered = erb.result(a_binding)
+  rendered = whitespace_cleanup(rendered)
+  File.write(out_filename, header + rendered)
+end
+
+# run this via "rake ops"
+yml = YAML.load_file(ARGV[0])
+out_fn = ARGV[1]
+
+rendered = rendered_file(yml)
+rendered = whitespace_cleanup(rendered)
+File.write(out_fn, rendered)
+
+libdir = File.expand_path("..", out_fn)
+render_erb_file("#{libdir}/defines.rb.erb", binding)
+render_erb_file("#{libdir}/enums.rb.erb", binding)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lignite
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Martin Vidner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-02 00:00:00.000000000 Z
+date: 2018-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: libusb
@@ -52,20 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -100,6 +86,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.50.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.50.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -159,7 +173,13 @@ files:
 - lib/lignite/connection/replay.rb
 - lib/lignite/connection/tap.rb
 - lib/lignite/connection/usb.rb
+- lib/lignite/defines.rb
+- lib/lignite/defines.rb.erb
 - lib/lignite/direct_commands.rb
+- lib/lignite/enums.rb
+- lib/lignite/enums.rb.erb
+- lib/lignite/ev3_ops.rb
+- lib/lignite/ev3_tool.rb
 - lib/lignite/logger.rb
 - lib/lignite/message.rb
 - lib/lignite/motors.rb
@@ -186,9 +206,17 @@ files:
 - spec/data/VernierReadout.lms
 - spec/data/VernierReadout.rb
 - spec/data/VernierReadout.rbf
+- spec/data/ev3tool_download.yml
+- spec/data/ev3tool_list_files.yml
+- spec/data/ev3tool_start.yml
+- spec/data/ev3tool_stop.yml
+- spec/data/ev3tool_upload.yml
+- spec/data/everstorm.rbf
 - spec/direct_commands_spec.rb
+- spec/ev3_tool_spec.rb
 - spec/spec_helper.rb
 - spec/system_commands_spec.rb
+- tools/ops_from_yml
 homepage: https://github.com/mvidner/lignite
 licenses:
 - GPL-3.0-only