lxi_rb 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77313b2200b1ba847066182454dd2ac2ef36adc61a4c356f441e685f7e27c4da
-  data.tar.gz: a7ac41c3eb21734f6af0e3bbb42f83fce01a6323357a130b04042cf52b95fa46
+  metadata.gz: 14332658e014f39abcd5aa4dedd87f86ed793a8ee891ae2c38abed1e96740248
+  data.tar.gz: d417f13bb3e8cc874b9b0d0cffb394a307c42d70ecc69410a15838b8e42171e9
 SHA512:
-  metadata.gz: '067999e1c48acb5037f78b7fba4d503762f93550a6ba76f392912f2b8adda565fb1a5a6e5ac6858809dda85bc4420c405d294ab296a31adc96f095e0e01dbaf4'
-  data.tar.gz: d8f1dda2cf1538daa27c09e338bafa33c05e16e399420e4c26b2936df10f878d732d0d6fd9bc030490c6c8e2de98a8922111d40b7bb8d350585fba1a3db67695
+  metadata.gz: 0bc179e9643858482b291f1faf50ee9c7302bfbbf4a576052136c2d7d23a7c383b5efe751fe847552246cfbcd0d76058aa1454fafdaec68b64cff8aa4d1998bf
+  data.tar.gz: 6536d4d6defd3abae63528f58e6982f80dc608358fed282e6e1f7eef290462108e96de205e1761af054319cb6b40b1af04b2a0e234e050fe2f2a82c2049665a1

data/.rubocop.yml

@@ -0,0 +1,55 @@
+# Rubocop config for lxi_rb rubygem
+AllCops:
+  TargetRubyVersion: 3.1
+  EnabledByDefault: true
+  AutoCorrect: true
+
+require:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-minitest
+
+inherit_gem:
+  syntax_tree: config/rubocop.yml
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 30
+
+Metrics/BlockLength:
+  Max: 30
+
+Metrics/ClassLength:
+  Enabled: false
+
+Documentation:
+  Enabled: false
+
+Style/Copyright:
+  Enabled: false
+
+Style/DocumentationMethod:
+  Enabled: false
+
+Lint/ConstantResolution:
+  Enabled: false
+
+Bundler/GemComment:
+  Enabled: false
+
+Style/ConstantVisibility:
+  Enabled: false
+
+Style/IpAddresses:
+  Enabled: false
+
+Style/MissingElse:
+  Enabled: false

data/CHANGELOG.md

@@ -6,6 +6,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 - - -
+## [v0.7.1](https://github.com/robcarruthers/lxi_rb/compare/v0.7.0..v0.7.1) - 2023-05-11
+#### Miscellaneous Chores
+- **(Rubocop)** Fix offences - ([ba347f4](https://github.com/robcarruthers/lxi_rb/commit/ba347f4de9bbcafb28aa86a747f88ca725e4725e)) - [@robcarruthers](https://github.com/robcarruthers)
+
+- - -
+
 ## [v0.7.0](https://github.com/robcarruthers/lxi_rb/compare/v0.6.4..v0.7.0) - 2023-05-11
 #### Tests
 - **(Lxi)** Add Lxi module tests - ([627766f](https://github.com/robcarruthers/lxi_rb/commit/627766f3953486e54fc7bb67a3cb75701e1aa537)) - [@robcarruthers](https://github.com/robcarruthers)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lxi_rb (0.6.4)
+    lxi_rb (0.7.0)
       ffi (~> 1.15)
 
 GEM
@@ -38,6 +38,13 @@ GEM
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.26.0)
       parser (>= 3.2.1.0)
+    rubocop-minitest (0.31.0)
+      rubocop (>= 1.39, < 2.0)
+    rubocop-performance (1.17.1)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
     ruby-progressbar (1.11.0)
     unicode-display_width (2.4.2)
 
@@ -51,6 +58,9 @@ DEPENDENCIES
   minitest-reporters (~> 1.4)
   rake (~> 13.0)
   rubocop (~> 1.21)
+  rubocop-minitest (~> 0.3)
+  rubocop-performance (~> 1.10)
+  rubocop-rake (~> 0.4)
 
 BUNDLED WITH
    2.4.10

data/lib/lxi/callbacks.rb

@@ -1,18 +1,21 @@
 # frozen_string_literal: true
+require 'ffi'
+
 module Lxi
+  include FFI
   # VXI11 Discovery Callbacks
   BroadcastCallback =
     FFI::Function.new(:void, %i[pointer pointer]) do |address, interface|
-      puts "Broadcast: #{address.read_string}, #{interface.read_string}"
+      puts("Broadcast: #{address.read_string}, #{interface.read_string}")
     end
 
   DeviceCallback =
     FFI::Function.new(:void, %i[pointer pointer]) do |address, id|
-      puts "Device: #{address.read_string}, #{id.read_string}"
+      puts("Device: #{address.read_string}, #{id.read_string}")
     end
 
   ServiceCallback =
     FFI::Function.new(:void, %i[pointer pointer pointer int]) do |address, id, service, port|
-      puts "Service: #{address.read_string}, #{id.read_string}, #{service.read_string}, #{port}"
+      puts("Service: #{address.read_string}, #{id.read_string}, #{service.read_string}, #{port}")
     end
 end

data/lib/lxi/device.rb

@@ -15,14 +15,14 @@ module Lxi
 
       connect
 
-      yield self if block_given?
+      yield(self) if block_given?
     end
 
     def connect
       Lxi.init_lxi_session
 
       @id = Lxi.lxi_connect(@address, @port, @name, @timeout, @protocol)
-      raise Error, 'LXI Connection Error' if @id == LXI_ERROR
+      raise(Error, 'LXI Connection Error') if @id == LXI_ERROR
 
       true
     end
@@ -33,27 +33,27 @@ module Lxi
     end
     alias close disconnect
 
-    def send(message)
+    def write(message)
       bytes_sent = Lxi.lxi_send(@id, message, message.length, @timeout)
-      raise Error, 'LXI communications error' unless bytes_sent.positive?
+      raise(Error, 'LXI communications error') unless bytes_sent.positive?
 
       bytes_sent
     end
-    alias scpi send
-    alias write send
+    alias scpi write
+    alias send write
 
     def read(length)
       message = FFI::MemoryPointer.new(:char, length)
       bytes_received = Lxi.lxi_receive(@id, message, length, @timeout)
-      raise Error, 'LXI communications error' unless bytes_received.positive?
+      raise(Error, 'LXI communications error') unless bytes_received.positive?
 
       message.read_string
     end
     alias gets read
 
     def query(message)
-      send message
-      read 10_000
+      write(message)
+      read(10_000)
     end
   end
 end

data/lib/lxi/discovery.rb

@@ -2,7 +2,7 @@
 module Lxi
   # Search for LXI-11 instruments on the network and return hash of instruments
   def self.discover(timeout: 1000, type: :vxi11)
-    raise Error, 'LXI Library Initialisation Error' unless lxi_init == LXI_OK
+    raise(Error, 'LXI Library Initialisation Error') unless lxi_init == LXI_OK
 
     devices = []
     device_callback =
@@ -14,7 +14,7 @@ module Lxi
     info[:device] = device_callback
 
     lxi_discover_internal(info, timeout, type)
-    sleep 0.1
+    sleep(0.1)
     devices
   end
 
@@ -26,10 +26,10 @@ module Lxi
     info[:broadcast] = BroadcastCallback
     info[:device] = DeviceCallback
 
-    puts "Searching for LXI devices - please wait...\n\n"
+    puts("Searching for LXI devices - please wait...\n\n")
 
     result = lxi_discover_internal(info, timeout, type)
 
-    puts "Error during discovery: #{result}" if result.negative?
+    puts("Error during discovery: #{result}") if result.negative?
   end
 end

data/lib/lxi/methods.rb

@@ -2,6 +2,6 @@
 module Lxi
   # Initialise the LXI library
   def self.init_lxi_session
-    raise Error, 'LXI Library Initialisation Error' unless Lxi.lxi_init == LXI_OK
+    raise(Error, 'LXI Library Initialisation Error') unless Lxi.lxi_init == LXI_OK
   end
 end

data/lib/lxi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Lxi
-  VERSION = '0.7.0'
+  VERSION = '0.7.1'
 end

data/lib/lxi_rb.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require_relative 'lxi/version'
-require_relative 'lxi/functions'
-require_relative 'lxi/methods'
-require_relative 'lxi/constants'
 require_relative 'lxi/callbacks'
-require_relative 'lxi/discovery'
+require_relative 'lxi/constants'
 require_relative 'lxi/device'
+require_relative 'lxi/discovery'
+require_relative 'lxi/functions'
+require_relative 'lxi/methods'
+require_relative 'lxi/version'
 
 module Lxi
   extend FFIFunctions

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lxi_rb
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Rob Carruthers
@@ -38,6 +38,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -53,33 +81,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.14'
+        version: '1.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.14'
+        version: '1.18'
 - !ruby/object:Gem::Dependency
-  name: minitest-reporters
+  name: rubocop-minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '0.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
 description: The gem includes methods required for discovering and communicating with
   LXI compliant devices
 email:
@@ -88,6 +144,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".rubocop.yml"
 - ".tool-versions"
 - ".vscode/settings.json"
 - CHANGELOG.md
@@ -112,6 +169,7 @@ metadata:
   homepage_uri: https://github.com/robcarruthers/lxi_rb
   source_code_uri: https://github.com/robcarruthers/lxi_rb
   changelog_uri: https://github.com/robcarruthers/lxi_rb/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths: