homie-mqtt 1.4.5 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c95ecceb8af9d97949e7ee75cccf878f80270ff703c07ee957b9b276c96f6538
-  data.tar.gz: 0162763dce328e5c4a43045740ca5e907d0506de4e8fc05592c524763274e965
+  metadata.gz: 8552d2aca44043208c3b3cd06fff9d5376515103d7de423926713441acecd6e0
+  data.tar.gz: a27b5fe2fe50e2975708c308ed9a0f9b5b7d2469667741fe092210adcda8582a
 SHA512:
-  metadata.gz: 53500d60691a22a98a46c81e0f5c6627bcc356503186f5275b4c643321254719ac6effbb094241f1f37800859f80f6ec4b9b5c2749e91f4169ec38e1073d9595
-  data.tar.gz: 4ee3a6ba42de0f71746c1211e4d9e543d3587d7f7d79524667e71b40a61e3a65a5a23ec90a8e09dc318399528b65345d863df423b3a5f5cd44cd3378e2cbcb9f
+  metadata.gz: b10c773d61781b4fb2e5595056e1b5e41373ec579bcf0a152f0c5dc763c3973ad09914964caaaf9c619b079e6cf15f4dc923122caf214f571741b8b6934a8317
+  data.tar.gz: dd8069070124dea54d81f3fc0095b9cce1d28d77ed655d7162182c0a11cdfecbb93cc40c97ea3778b3ebd35508cf960fdfcdd2594cac87f3621fdf11e64845c0

data/lib/homie-mqtt.rb

@@ -4,13 +4,13 @@ module MQTT
   module Homie
     class << self
       def escape_id(id)
-        id.downcase.gsub(/[^a-z0-9\-]/, '-').sub(/^[^a-z0-9]+/, '')
+        id.downcase.gsub(/[^a-z0-9\-]/, "-").sub(/^[^a-z0-9]+/, "")
       end
     end
   end
 end
 
-require 'mqtt/homie/base'
-require 'mqtt/homie/device'
-require 'mqtt/homie/node'
-require 'mqtt/homie/property'
+require "mqtt/homie/base"
+require "mqtt/homie/device"
+require "mqtt/homie/node"
+require "mqtt/homie/property"

data/lib/mqtt/homie/base.rb

@@ -9,18 +9,19 @@ module MQTT
 
       def initialize(id, name)
         raise ArgumentError, "Invalid Homie ID '#{id}'" unless id.is_a?(String) && id =~ Regexp.new("^#{REGEX}$")
+
         @id = id
         @name = name
       end
 
       def name=(value)
-        if name != value
-          name = value
-          if @published
-            device.init do
-              mqtt.publish("#{topic}/$name", name, retain: true, qos: 1)
-            end
-          end
+        return if name == value
+
+        name = value
+        return unless @published
+
+        device.init do
+          mqtt.publish("#{topic}/$name", name, retain: true, qos: 1)
         end
       end
     end

data/lib/mqtt/homie/device.rb

@@ -1,18 +1,20 @@
 # frozen_string_literal: true
 
-require 'mqtt'
-require 'ruby2_keywords'
+require "mqtt"
+require "ruby2_keywords"
 
 module MQTT
   module Homie
     class Device < Base
+      # the Homie spec version
+      VERSION = "4.0.0"
+
       attr_reader :root_topic, :state, :mqtt
-      attr_accessor :logger
-      attr_accessor :out_of_band_topic_proc
+      attr_accessor :logger, :out_of_band_topic_proc
 
       def initialize(id, name, root_topic: nil, mqtt: nil, clear_topics: true, &block)
         super(id, name)
-        @root_topic = @root_topic || "homie"
+        @root_topic = root_topic || "homie"
         @state = :init
         @nodes = {}
         @published = false
@@ -23,9 +25,7 @@ module MQTT
 
         @mqtt.on_reconnect do
           each do |node|
-            node.each do |property|
-              property.subscribe
-            end
+            node.each(&:subscribe)
           end
           mqtt.publish("#{topic}/$state", :init, retain: true, qos: 1)
           mqtt.publish("#{topic}/$state", state, retain: true, qos: 1) unless state == :init
@@ -35,6 +35,10 @@ module MQTT
         self.clear_topics if clear_topics
       end
 
+      def inspect
+        "#<MQTT::Homie::Device #{topic} name=#{name.inspect}, $state=#{state.inspect}>"
+      end
+
       def device
         self
       end
@@ -61,6 +65,7 @@ module MQTT
 
       def remove_node(id)
         return false unless (node = @nodes[id])
+
         init do
           node.unpublish
           @nodes.delete(id)
@@ -77,11 +82,15 @@ module MQTT
         @nodes.each_value(&block)
       end
 
+      def count
+        @nodes.count
+      end
+
       def publish
         return if @published
 
         mqtt.batch_publish do
-          mqtt.publish("#{topic}/$homie", "4.0.0", retain: true, qos: 1)
+          mqtt.publish("#{topic}/$homie", VERSION, retain: true, qos: 1)
           mqtt.publish("#{topic}/$name", name, retain: true, qos: 1)
           mqtt.publish("#{topic}/$state", @state.to_s, retain: true, qos: 1)
 
@@ -106,6 +115,9 @@ module MQTT
 
           mqtt.publish("#{topic}/$nodes", @nodes.keys.join(","), retain: true, qos: 1)
           @nodes.each_value(&:publish)
+
+          yield if block_given?
+
           mqtt.publish("#{topic}/$state", (@state = :ready).to_s, retain: true, qos: 1)
         end
 
@@ -126,17 +138,15 @@ module MQTT
       end
 
       def init
-        if state == :init
-          return yield state
-        end
+        return yield state if state == :init
 
         prior_state = state
-        mqtt.publish("#{topic}/$state", (state = :init).to_s, retain: true, qos: 1)
+        mqtt.publish("#{topic}/$state", (self.state = :init).to_s, retain: true, qos: 1)
         result = nil
         mqtt.batch_publish do
           result = yield prior_state
         end
-        mqtt.publish("#{topic}/$state", (state = :ready).to_s, retain: true, qos: 1)
+        mqtt.publish("#{topic}/$state", (self.state = :ready).to_s, retain: true, qos: 1)
         result
       end
 
@@ -145,7 +155,7 @@ module MQTT
 
         @mqtt.subscribe("#{topic}/#")
         @mqtt.unsubscribe("#{topic}/#", wait_for_ack: true)
-        while !@mqtt.queue_empty?
+        until @mqtt.queue_empty?
           packet = @mqtt.get
           @mqtt.publish(packet.topic, retain: true, qos: 0)
         end

data/lib/mqtt/homie/node.rb

@@ -13,6 +13,16 @@ module MQTT
         @published = false
       end
 
+      def inspect
+        "#<MQTT::Homie::Node #{topic} name=#{full_name.inspect}, type=#{type.inspect}>"
+      end
+
+      def full_name
+        return name if device.count == 1
+
+        "#{device.name} #{name}"
+      end
+
       def topic
         "#{device.topic}/#{id}"
       end
@@ -21,6 +31,7 @@ module MQTT
         device.init do |prior_state|
           property = Property.new(self, *args, &block)
           raise ArgumentError, "Property '#{property.id}' already exists on '#{id}'" if @properties.key?(property.id)
+
           @properties[property.id] = property
           property.publish if prior_state == :ready
           property
@@ -29,6 +40,7 @@ module MQTT
 
       def remove_property(id)
         return false unless (property = @properties[id])
+
         init do
           property.unpublish
           @properties.delete(id)
@@ -73,6 +85,7 @@ module MQTT
 
       def unpublish
         return unless @published
+
         @published = false
 
         mqtt.publish("#{topic}/$name", retain: true, qos: 0)

data/lib/mqtt/homie/property.rb

@@ -6,19 +6,26 @@ module MQTT
       attr_reader :node, :datatype, :format, :unit, :value
 
       def initialize(node, id, name, datatype, value = nil, format: nil, retained: true, unit: nil, &block)
-        raise ArgumentError, "Invalid Homie datatype" unless %i[string integer float boolean enum color datetime duration].include?(datatype)
+        raise ArgumentError, "Invalid Homie datatype" unless %i[string integer float boolean enum color datetime
+                                                                duration].include?(datatype)
         raise ArgumentError, "retained must be boolean" unless [true, false].include?(retained)
+
         format = format.join(",") if format.is_a?(Array) && datatype == :enum
-        if %i{integer float}.include?(datatype) && format.is_a?(Range)
+        if %i[integer float].include?(datatype) && format.is_a?(Range)
           raise ArgumentError "only inclusive ranges are supported" if format.exclude_end?
+
           format = "#{format.begin}:#{format.end}"
         end
         raise ArgumentError, "format must be nil or a string" unless format.nil? || format.is_a?(String)
         raise ArgumentError, "unit must be nil or a string" unless unit.nil? || unit.is_a?(String)
         raise ArgumentError, "format is required for enums" if datatype == :enum && format.nil?
         raise ArgumentError, "format is required for colors" if datatype == :color && format.nil?
-        raise ArgumentError, "format must be either rgb or hsv for colors" if datatype == :color && !%w{rgb hsv}.include?(format.to_s)
-        raise ArgumentError, "an initial value cannot be provided for a non-retained property" if !value.nil? && !retained
+        if datatype == :color && !%w[rgb hsv].include?(format.to_s)
+          raise ArgumentError, "format must be either rgb or hsv for colors"
+        end
+        if !value.nil? && !retained
+          raise ArgumentError, "an initial value cannot be provided for a non-retained property"
+        end
 
         super(id, name)
 
@@ -32,6 +39,24 @@ module MQTT
         @block = block
       end
 
+      def inspect
+        result = +"#<MQTT::Homie::Property #{topic} name=#{full_name.inspect}, datatype=#{datatype.inspect}"
+        result << ", format=#{format.inspect}" if format
+        result << ", unit=#{unit.inspect}" if unit
+        result << ", settable=true" if settable?
+        result << if retained?
+                    ", value=#{value.inspect}"
+                  else
+                    ", retained=false"
+                  end
+        result << ">"
+        result.freeze
+      end
+
+      def full_name
+        "#{node.full_name} #{name}"
+      end
+
       def device
         node.device
       end
@@ -49,39 +74,41 @@ module MQTT
       end
 
       def value=(value)
-        if @value != value
-          @value = value if retained?
-          publish_value if @published
-        end
+        return if @value == value
+
+        @value = value if retained?
+        publish_value if @published
       end
 
       def unit=(unit)
-        if unit != @unit
-          @unit = unit
-          if @published
-            device.init do
-              mqtt.publish("#{topic}/$unit", unit.to_s, retain: true, qos: 1)
-            end
-          end
+        return if unit == @unit
+
+        @unit = unit
+        return unless @published
+
+        device.init do
+          mqtt.publish("#{topic}/$unit", unit.to_s, retain: true, qos: 1)
         end
       end
 
       def format=(format)
-        if format != @format
-          @format = format
-          if @published
-            device.init do
-              mqtt.publish("#{topic}/$format", format.to_s, retain: true, qos: 1)
-            end
-          end
+        return if format == @format
+
+        @format = format
+        return unless @published
+
+        device.init do
+          mqtt.publish("#{topic}/$format", format.to_s, retain: true, qos: 1)
         end
       end
 
       def range
+        return nil unless format
+
         case datatype
-        when :enum; format.split(',')
-        when :integer; Range.new(*format.split(':').map(&:to_i))
-        when :float; Range.new(*format.split(':').map(&:to_f))
+        when :enum then format.split(",")
+        when :integer then Range.new(*format.split(":").map(&:to_i))
+        when :float then Range.new(*format.split(":").map(&:to_f))
         else; raise MethodNotImplemented
         end
       end
@@ -89,24 +116,29 @@ module MQTT
       def set(value)
         case datatype
         when :boolean
-          return unless %w{true false}.include?(value)
-          value = value == 'true'
+          return unless %w[true false].include?(value)
+
+          value = value == "true"
         when :integer
-          return unless value =~ /^-?\d+$/
+          return unless /^-?\d+$/.match?(value)
+
           value = value.to_i
-          return unless range.include?(value) if format
+          return if format && !range.include?(value)
         when :float
-          return unless value =~ /^-?(?:\d+|\d+\.|\.\d+|\d+\.\d+)(?:[eE]-?\d+)?$/
+          return unless /^-?(?:\d+|\d+\.|\.\d+|\d+\.\d+)(?:[eE]-?\d+)?$/.match?(value)
+
           value = value.to_f
-          return unless range.include?(value) if format
+          return if format && !range.include?(value)
         when :enum
           return unless range.include?(value)
         when :color
-          return unless value =~ /^\d{1,3},\d{1,3},\d{1,3}$/
-          value = value.split(',').map(&:to_i)
-          if format == 'rgb'
+          return unless /^\d{1,3},\d{1,3},\d{1,3}$/.match?(value)
+
+          value = value.split(",").map(&:to_i)
+          case format
+          when "rgb"
             return if value.max > 255
-          elsif format == 'hsv'
+          when "hsv"
             return if value.first > 360 || value[1..2].max > 100
           end
         when :datetime
@@ -153,6 +185,7 @@ module MQTT
 
       def unpublish
         return unless @published
+
         @published = false
 
         mqtt.publish("#{topic}/$name", retain: true, qos: 0)

data/lib/mqtt/homie/version.rb

@@ -2,6 +2,6 @@
 
 module MQTT
   module Homie
-    VERSION = '1.4.5'
+    VERSION = "1.5.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: homie-mqtt
 version: !ruby/object:Gem::Version
-  version: 1.4.5
+  version: 1.5.0
 platform: ruby
 authors:
 - Cody Cutrer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-04 00:00:00.000000000 Z
+date: 2021-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mqtt-ccutrer
@@ -72,6 +72,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.23'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.23'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
 description: 
 email: cody@cutrer.com'
 executables: []
@@ -87,7 +129,8 @@ files:
 homepage: https://github.com/ccutrer/homie-mqtt
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -96,7 +139,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="