exsys 0.5 → 0.6

data/test/test_readme.rb

@@ -0,0 +1,61 @@
+require_relative 'helper'
+
+# The README documents the executable by name and by example.  Both can
+# drift away from the tool without anything saying so -- the name did,
+# and sat wrong through four releases -- so both are checked here.
+class TestReadme < Minitest::Test
+    include CLI
+
+    README = File.read(File.join(ROOT, 'README.md')).freeze
+
+    # Regression: every example named `exsys-hub`, which has never been
+    # the name of anything this gem installs.
+    def test_the_shell_examples_name_the_real_executable
+        named = shell_commands.map {|line| line.split.first }.uniq
+                              .grep(/\Aexsys/)
+
+        refute_empty named, 'no exsys command appears in the README'
+        assert_equal [ File.basename(EXE) ], named
+    end
+
+    # And each example must still be one the tool accepts, so that a
+    # renamed action or a changed argument syntax cannot sit in the
+    # documentation unnoticed.
+    def test_every_documented_example_is_accepted
+        examples = documented_examples
+        assert_operator examples.size, :>=, 6, 'README examples went missing'
+
+        examples.each do |line, argv|
+            _, err, st = exsys_usb_raw(argv)
+            assert_equal 0, st.exitstatus,
+                         "README example is not accepted: #{line}\n#{err}"
+        end
+    end
+
+    def test_the_documented_test_command_is_the_one_that_runs
+        assert_includes shell_commands, 'rake test'
+    end
+
+    private
+
+    # Command lines from the README's shell blocks, comments and blank
+    # lines removed.
+    def shell_commands
+        README.scan(/^~~~sh$(.*?)^~~~$/m).flatten.join("\n")
+              .lines.map {|l| l.sub(/#.*/, '').strip }.reject(&:empty?)
+    end
+
+    # Those that invoke the executable, as [ line, argv ].  The shell
+    # variable the README uses for the device is replaced by one that
+    # exists everywhere, and anything the shell would interpret rather
+    # than pass on -- a pipe, a conditional, a redirection -- is cut
+    # off, since these run the executable directly and not under a
+    # shell.  What is checked is the invocation, not the plumbing.
+    def documented_examples
+        shell_commands.filter_map do |line|
+            next unless line.start_with?(File.basename(EXE))
+            cmd = line.split(/\s(?:\|\||&&|\||;|>>?)\s/).first
+            [ line, Shellwords.split(cmd.sub('${dev}', '/dev/null'))[1..] ]
+        end
+    end
+end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: exsys
 version: !ruby/object:Gem::Version
-  version: '0.5'
+  version: '0.6'
 platform: ruby
 authors:
 - Stéphane D'Alu
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-29 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uart
@@ -24,6 +23,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -64,16 +77,22 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
+- Rakefile
 - bin/exsys-usb
 - exsys.gemspec
 - lib/exsys.rb
 - lib/exsys/managed-usb.rb
 - lib/exsys/version.rb
+- test/helper.rb
+- test/support/fake_hub.rb
+- test/support/uart.rb
+- test/test_exsys_usb.rb
+- test/test_managed_usb.rb
+- test/test_readme.rb
 homepage: https://github.com/sdalu/ruby-exsys
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -88,8 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.19
-signing_key:
+rubygems_version: 4.0.16
 specification_version: 4
 summary: ExSYS managed USB hub support
 test_files: []