somfy_sdn 2.1.5 → 2.2.0

data/lib/sdn/message/ilt2/master_control.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SDN
   class Message
     module ILT2
@@ -10,12 +12,14 @@ module SDN
             return unless checksum(data[0..2]) == data[3..4]
             # no clue what's special about these
             return unless data[0..1] == [0xfa, 0x7a]
+
             klass = case data[2]
-              when 0x00; Down
-              when 0xfa; Up
-              when 0xff; Stop
-              end
+                    when 0x00 then Down
+                    when 0xfa then Up
+                    when 0xff then Stop
+                    end
             return unless klass
+
             [klass.new, 5]
           end
         end
@@ -25,11 +29,10 @@ module SDN
 
         class Stop < MasterControl
         end
- 
+
         class Up < MasterControl
         end
-
       end
     end
   end
-end
+end

data/lib/sdn/message/ilt2/post.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SDN
   class Message
     module ILT2
@@ -13,7 +15,7 @@ module SDN
         end
 
         def channels=(value)
-          @channels = value &. & 0xff
+          @channels = value&.& 0xff
         end
 
         def parse(params)
@@ -26,7 +28,7 @@ module SDN
         end
 
         def class_inspect
-          ", @channels=#{channels.chr.unpack('b8').first}"
+          ", @channels=#{channels.chr.unpack1("b8")}"
         end
       end
 
@@ -77,9 +79,9 @@ module SDN
       class PostMotorPosition < Message
         MSG = 0x64
         PARAMS_LENGTH = 3
-  
+
         attr_accessor :position_pulses, :position_percent
-  
+
         def initialize(position_pulses = nil, position_percent = nil, **kwargs)
           super(**kwargs)
           self.position_pulses = position_pulses
@@ -94,7 +96,7 @@ module SDN
 
         def params
           from_number(position_pulses, 2) +
-            from_number(position_percent && position_percent * 255 / 100)
+            from_number(position_percent && (position_percent * 255 / 100))
         end
       end
 

data/lib/sdn/message/ilt2/set.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SDN
   class Message
     module ILT2
@@ -19,7 +21,7 @@ module SDN
           down_limit: 2,
           ip: 4,
           unlock: 5
-        }
+        }.freeze
 
         # when target_type is down_limit, target is number of 10ms intervals it's still allowed to roll up
         attr_reader :target_type, :target, :priority
@@ -40,16 +42,21 @@ module SDN
         end
 
         def target_type=(value)
-          raise ArgumentError, "target_type must be one of :current, :up_limit, :down_limit, :ip, or :unlock" unless TARGET_TYPE.keys.include?(value)
+          unless TARGET_TYPE.key?(value)
+            raise ArgumentError,
+                  "target_type must be one of :current, :up_limit, :down_limit, :ip, or :unlock"
+          end
+
           @target_type = value
         end
 
         def target=(value)
-          @target = value&. & 0xff
+          @target = value&.& 0xff
         end
 
         def priority=(value)
-          raise ArgumentError, "priority must be between 1 and 100" unless (1..100).include?(value)
+          raise ArgumentError, "priority must be between 1 and 100" unless (1..100).cover?(value)
+
           @priority = value
         end
 
@@ -78,12 +85,13 @@ module SDN
         end
 
         def ip=(value)
-          raise ArgumentError, "ip must be in range 1..16 or nil" unless ip.nil? || (1..16).include?(ip)
+          raise ArgumentError, "ip must be in range 1..16 or nil" unless ip.nil? || (1..16).cover?(ip)
+
           @ip = value
         end
 
         def value=(value)
-          @value = value &. & 0xffff
+          @value = value&.& 0xffff
         end
 
         def params
@@ -110,7 +118,7 @@ module SDN
           jog_down_ms: 11,
           jog_up_pulses: 12,
           jog_down_pulses: 13,
-          position_percent: 16,
+          position_percent: 16
         }.freeze
 
         attr_reader :target_type, :target
@@ -126,26 +134,27 @@ module SDN
           super
           self.target_type = TARGET_TYPE.invert[to_number(params[0])]
           target = to_number(params[1..2])
-          if target_type == :position_percent
-            target = target.to_f / 255 * 100
-          end
-          if target_type == :ip
-            target += 1
-          end
+          target = target.to_f / 255 * 100 if target_type == :position_percent
+          target += 1 if target_type == :ip
           self.target = target
         end
 
         def target_type=(value)
-          raise ArgumentError, "target_type must be one of :up_limit, :down_limit, :stop, :ip, :next_ip_up, :next_ip_down, :jog_up, :jog_down, or :position_percent" unless TARGET_TYPE.keys.include?(value)
+          unless TARGET_TYPE.key?(value)
+            raise ArgumentError, "target_type must be one of :up_limit, :down_limit, " \
+                                 ":stop, :ip, :next_ip_up, :next_ip_down, :jog_up, " \
+                                 ":jog_down, or :position_percent"
+          end
+
           @target_type = value
         end
 
         def target=(value)
-          if target_type == :position_percent && value
-            @target = [[0, value].max, 100].min
-          else
-            @target = value&. & 0xffff
-          end
+          @target = if target_type == :position_percent && value
+                      value.clamp(0, 100)
+                    else
+                      value&.& 0xffff
+                    end
         end
 
         def params

data/lib/sdn/message/post.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SDN
   class Message
     class PostGroupAddr < Message
@@ -24,7 +26,7 @@ module SDN
       end
 
       def class_inspect
-        ", group_index=#{group_index.inspect}, group_address=#{group_address ? print_address(group_address) : 'nil'}"
+        ", group_index=#{group_index.inspect}, group_address=#{group_address ? print_address(group_address) : "nil"}"
       end
     end
 
@@ -160,10 +162,6 @@ module SDN
     class PostNetworkLock < UnknownMessage
       MSG = 0x36
       PARAMS_LENGTH = 5
-
-      def parse(params)
-        super
-      end
     end
 
     class PostNodeAddr < Message

data/lib/sdn/message/set.rb

@@ -1,9 +1,17 @@
+# frozen_string_literal: true
+
 module SDN
   class Message
     class SetFactoryDefault < Message
       MSG = 0x1f
       PARAMS_LENGTH = 1
-      RESET = { all_settings: 0x00, group_addresses: 0x01, limits: 0x11, rotation: 0x12, rolling_speed: 0x13, ips: 0x15, locks: 0x17 }
+      RESET = { all_settings: 0x00,
+                group_addresses: 0x01,
+                limits: 0x11,
+                rotation: 0x12,
+                rolling_speed: 0x13,
+                ips: 0x15,
+                locks: 0x17 }.freeze
 
       attr_reader :reset
 
@@ -19,7 +27,11 @@ module SDN
       end
 
       def reset=(value)
-        raise ArgumentError, "reset must be one of :all_settings, :group_addresses, :limits, :rotation, :rolling_speed, :ips, :locks" unless RESET.keys.include?(value)
+        unless RESET.key?(value)
+          raise ArgumentError,
+                "reset must be one of :all_settings, :group_addresses, :limits, :rotation, :rolling_speed, :ips, :locks"
+        end
+
         @reset = value
       end
 
@@ -32,7 +44,8 @@ module SDN
       MSG = 0x51
       PARAMS_LENGTH = 4
 
-      attr_reader :group_index, :group_address
+      attr_accessor :group_address
+      attr_reader :group_index
 
       def initialize(dest = nil, group_index = 1, group_address = nil, **kwargs)
         kwargs[:dest] ||= dest
@@ -48,12 +61,9 @@ module SDN
       end
 
       def group_index=(value)
-        raise ArgumentError, "group_index is out of range" unless (1..16).include?(value)
-        @group_index = value
-      end
+        raise ArgumentError, "group_index is out of range" unless (1..16).cover?(value)
 
-      def group_address=(value)
-        @group_address = value
+        @group_index = value
       end
 
       def params
@@ -61,7 +71,7 @@ module SDN
       end
 
       def class_inspect
-        ", group_index=#{group_index.inspect}, group_address=#{group_address ? print_address(group_address) : 'nil'}"
+        ", group_index=#{group_index.inspect}, group_address=#{group_address ? print_address(group_address) : "nil"}"
       end
     end
 
@@ -84,7 +94,8 @@ module SDN
       end
 
       def direction=(value)
-        raise ArgumentError, "direction must be one of :standard, :reversed" unless DIRECTION.keys.include?(value)
+        raise ArgumentError, "direction must be one of :standard, :reversed" unless DIRECTION.key?(value)
+
         @direction = value
       end
 
@@ -97,7 +108,11 @@ module SDN
       MSG = 0x15
       PARAMS_LENGTH = 4
       # for distribute, value is how many IPs to distribute over
-      TYPE = { delete: 0x00, current_position: 0x01, position_pulses: 0x02, position_percent: 0x03, distribute: 0x04 }.freeze
+      TYPE = { delete: 0x00,
+               current_position: 0x01,
+               position_pulses: 0x02,
+               position_percent: 0x03,
+               distribute: 0x04 }.freeze
 
       attr_reader :type, :ip, :value
 
@@ -113,23 +128,28 @@ module SDN
         super
         self.type = TYPE.invert[to_number(params[0])]
         ip = to_number(params[1])
-        ip = nil if ip == 0
+        ip = nil if ip.zero?
         self.ip = ip
         self.value = to_number(params[2..3])
       end
 
       def type=(value)
-        raise ArgumentError, "type must be one of :delete, :current_position, :position_pulses, :position_percent, :distribute" unless TYPE.keys.include?(value)
+        unless TYPE.key?(value)
+          raise ArgumentError,
+                "type must be one of :delete, :current_position, :position_pulses, :position_percent, :distribute"
+        end
+
         @type = value
       end
 
       def ip=(value)
-        raise ArgumentError, "ip must be in range 1..16 or nil" unless ip.nil? || (1..16).include?(ip)
+        raise ArgumentError, "ip must be in range 1..16 or nil" unless ip.nil? || (1..16).cover?(ip)
+
         @ip = value
       end
 
       def value=(value)
-        @value = value &. & 0xffff
+        @value = value&.& 0xffff
       end
 
       def params
@@ -140,8 +160,8 @@ module SDN
     class SetMotorLimits < Message
       MSG = 0x11
       PARAMS_LENGTH = 4
-      TYPE = { delete: 0x00, current_position: 0x01, specified_position: 0x02, jog_ms: 0x04, jog_pulses: 0x05 }
-      TARGET = { down: 0x00, up: 0x01 }
+      TYPE = { delete: 0x00, current_position: 0x01, specified_position: 0x02, jog_ms: 0x04, jog_pulses: 0x05 }.freeze
+      TARGET = { down: 0x00, up: 0x01 }.freeze
 
       attr_reader :type, :target, :value
 
@@ -161,17 +181,22 @@ module SDN
       end
 
       def type=(value)
-        raise ArgumentError, "type must be one of :delete, :current_position, :specified_position, :jog_ms, :jog_pulses" unless TYPE.keys.include?(value)
+        unless TYPE.key?(value)
+          raise ArgumentError,
+                "type must be one of :delete, :current_position, :specified_position, :jog_ms, :jog_pulses"
+        end
+
         @type = value
       end
 
       def target=(value)
-        raise ArgumentError, "target must be one of :up, :down" unless TARGET.keys.include?(value)
+        raise ArgumentError, "target must be one of :up, :down" unless TARGET.key?(value)
+
         @target = value
       end
 
       def value=(value)
-        @value = value&. & 0xffff
+        @value = value&.& 0xffff
       end
 
       def params
@@ -186,6 +211,7 @@ module SDN
       PARAMS_LENGTH = 3
 
       attr_accessor :up_speed, :down_speed, :slow_speed
+
       def initialize(dest = nil, up_speed: nil, down_speed: nil, slow_speed: nil, **kwargs)
         kwargs[:dest] ||= dest
         super(**kwargs)
@@ -212,7 +238,7 @@ module SDN
       attr_accessor :locked, :priority
 
       def parse(params)
-        self.locked = to_number(params[0]) == 1 ? true : false
+        self.locked = to_number(params[0]) == 1
         self.priority = to_number(params[1])
       end
 
@@ -227,7 +253,7 @@ module SDN
 
       attr_accessor :label
 
-      def initialize(dest = nil, label = '', **kwargs)
+      def initialize(dest = nil, label = "", **kwargs)
         kwargs[:dest] ||= dest
         super(**kwargs)
         self.label = label

data/lib/sdn/message.rb

@@ -1,4 +1,6 @@
-require 'sdn/message/helpers'
+# frozen_string_literal: true
+
+require "sdn/message/helpers"
 
 module SDN
   class MalformedMessage < RuntimeError; end
@@ -6,14 +8,16 @@ module SDN
   class Message
     class << self
       def inherited(klass)
+        super
         return Message.inherited(klass) unless self == Message
+
         @message_map = nil
         (@subclasses ||= []) << klass
       end
 
       def expected_response?(message)
-        if name =~ /::Get([A-Za-z]+)/
-          message.class.name == name.sub("::Get", "::Post")
+        if /::Get([A-Za-z]+)/.match?(name)
+          message.class.name == name.sub("::Get", "::Post") # rubocop:disable Style/ClassEqualityComparison
         else
           message.is_a?(Ack) || message.is_a?(Nack)
         end
@@ -30,6 +34,7 @@ module SDN
           return result if result
 
           return [nil, 0] if data.length - offset < 11
+
           msg = to_number(data[offset])
           length = to_number(data[offset + 1])
           ack_requested = length & 0x80 == 0x80
@@ -57,7 +62,7 @@ module SDN
           result.parse(data.slice(offset + 9, length - 11))
           result.msg = msg if message_class == UnknownMessage
         rescue ArgumentError => e
-          SDN.logger.warn "discarding illegal message of type #{message_class.name}: #{e}"
+          SDN.logger.warn "Discarding illegal message of type #{message_class.name}: #{e}"
           result = nil
         end
         [result, offset + length]
@@ -67,10 +72,10 @@ module SDN
 
       def message_map
         @message_map ||=
-          @subclasses.inject({}) do |memo, klass|
+          @subclasses.each_with_object({}) do |klass, memo|
             next memo unless klass.constants(false).include?(:MSG)
+
             memo[klass.const_get(:MSG, false)] = klass
-            memo
           end
       end
     end
@@ -83,7 +88,7 @@ module SDN
     def initialize(node_type: nil, ack_requested: false, src: nil, dest: nil)
       @node_type = node_type || 0
       @ack_requested = ack_requested
-      if src.nil? && !dest.nil? && is_group_address?(dest)
+      if src.nil? && !dest.nil? && group_address?(dest)
         src = dest
         dest = nil
       end
@@ -92,7 +97,11 @@ module SDN
     end
 
     def parse(params)
-      raise MalformedMessage, "unrecognized params for #{self.class.name}: #{params.map { |b| '%02x' % b }}" if self.class.const_defined?(:PARAMS_LENGTH) && params.length != self.class.const_get(:PARAMS_LENGTH)
+      return unless self.class.const_defined?(:PARAMS_LENGTH) && params.length != self.class.const_get(:PARAMS_LENGTH)
+
+      raise MalformedMessage, "unrecognized params for #{self.class.name}: #{params.map do |b|
+                                                                               format("%02x", b)
+                                                                             end}"
     end
 
     def serialize
@@ -105,25 +114,32 @@ module SDN
     end
 
     def ==(other)
-      self.serialize == other.serialize
+      serialize == other.serialize
     end
 
     def inspect
-      "#<%s @node_type=%s, @ack_requested=%s, @src=%s, @dest=%s%s>" % [self.class.name, node_type_to_string(node_type), ack_requested, print_address(src), print_address(dest), class_inspect]
+      format("#<%s @node_type=%s, @ack_requested=%s, @src=%s, @dest=%s%s>",
+             self.class.name,
+             node_type_to_string(node_type),
+             ack_requested,
+             print_address(src),
+             print_address(dest),
+             class_inspect)
     end
     alias_method :to_s, :inspect
 
     def class_inspect
-      ivars = instance_variables - [:@node_type, :@ack_requested, :@src, :@dest, :@params]
+      ivars = instance_variables - %i[@node_type @ack_requested @src @dest @params]
       return if ivars.empty?
+
       ivars.map { |iv| ", #{iv}=#{instance_variable_get(iv).inspect}" }.join
     end
 
     protected
 
-    def params; []; end
-
-    public
+    def params
+      []
+    end
 
     class SimpleRequest < Message
       PARAMS_LENGTH = 0
@@ -144,11 +160,10 @@ module SDN
                  limits_not_set: 0x22,
                  ip_not_set: 0x23,
                  out_of_range: 0x24,
-                 busy: 0xff }
-                 # 17 limits not set?
-                 # 37 not implemented? (get motor rolling speed)
-                 # 39 at limit? blocked?
-
+                 busy: 0xff }.freeze
+      # 17 limits not set?
+      # 37 not implemented? (get motor rolling speed)
+      # 39 at limit? blocked?
 
       # presumed
       attr_accessor :error_code
@@ -180,33 +195,34 @@ module SDN
         self.params = params
       end
 
-      alias parse params=
+      alias_method :parse, :params=
 
       def serialize
         # prevent serializing something we don't know
         raise NotImplementedError unless params
+
         super
       end
 
       def class_inspect
-        result = if self.class == UnknownMessage
-          result = ", @msg=%02xh" % msg 
-        else
-          super || ""
-        end
+        result = if instance_of?(UnknownMessage)
+                   format(", @msg=%02xh", msg)
+                 else
+                   super || ""
+                 end
         return result if params.empty?
 
-        result << ", @params=#{params.map { |b| "%02x" % b }.join(' ')}"
+        result << ", @params=#{params.map { |b| format("%02x", b) }.join(" ")}"
       end
     end
   end
 end
 
-require 'sdn/message/control'
-require 'sdn/message/get'
-require 'sdn/message/post'
-require 'sdn/message/set'
-require 'sdn/message/ilt2/get'
-require 'sdn/message/ilt2/master_control'
-require 'sdn/message/ilt2/post'
-require 'sdn/message/ilt2/set'
+require "sdn/message/control"
+require "sdn/message/get"
+require "sdn/message/post"
+require "sdn/message/set"
+require "sdn/message/ilt2/get"
+require "sdn/message/ilt2/master_control"
+require "sdn/message/ilt2/post"
+require "sdn/message/ilt2/set"

data/lib/sdn/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SDN
-  VERSION = '2.1.5'
+  VERSION = "2.2.0"
 end

data/lib/sdn.rb

@@ -1,21 +1,27 @@
-require 'logger'
+# frozen_string_literal: true
 
-require 'sdn/client'
-require 'sdn/message'
+require "logger"
+
+require "sdn/client"
+require "sdn/message"
 
 module SDN
-  BROADCAST_ADDRESS = [0xff, 0xff, 0xff]
+  BROADCAST_ADDRESS = [0xff, 0xff, 0xff].freeze
 
   class << self
-    def logger
-      @logger ||= begin
-        Logger.new(STDOUT, :info).tap do |logger|
-          logger.datetime_format = '%Y-%m-%d %H:%M:%S.%L'
-          logger.formatter = proc do |severity, datetime, progname, msg|
-            "#{datetime.strftime(logger.datetime_format)} [#{Process.pid}/#{Thread.current.object_id}] #{severity}: #{msg}\n"
-          end
-        end
+    def logger=(logger)
+      logger.datetime_format = "%Y-%m-%d %H:%M:%S.%L"
+      logger.formatter = proc do |severity, datetime, _progname, msg|
+        "#{datetime.strftime(logger.datetime_format)} " \
+          "[#{Process.pid}/#{Thread.current.object_id}] " \
+          "#{severity}: #{msg}\n"
       end
+      @logger = logger
+    end
+
+    def logger
+      self.logger = Logger.new($stdout, :info) unless @logger
+      @logger
     end
   end
 end

data/lib/somfy_sdn.rb

@@ -1 +1,3 @@
-require 'sdn'
+# frozen_string_literal: true
+
+require "sdn"