timex_datalink_client 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7bbd5ed72c50f798a4efc663846f406338e1a777cd8587ba504a283c7976e7bf
-  data.tar.gz: '0843b0db0875cfc5ea663e85dcf0cf007bfb88b89306945390d51ab9eba09693'
+  metadata.gz: 10adb86fd981a90fa2e764e3dd63bbaf0b1ffa1c37b5210d510ea6aa29b76edb
+  data.tar.gz: 2d2b67b5b10a8a6bd7bbefd4423e9e7b661a4824649e241df0e4e3ca45e17290
 SHA512:
-  metadata.gz: 17da22510b17f02379419c84d0c80c35c9d63861d9186627d4adad2cbf7d00ed5c6aaf458316f7ec4bad5ee98fdcfa4bdbbaa96cb01b4506cce81b7193946eaa
-  data.tar.gz: 183bdf6f467c802df1e31c3f2b7e76d5a93a07e851fed8caf85fff56a93f3a48ef448d3b4f9b3884e46e9481e3c894702ae2994b96de92d9c09c4c1737a696af
+  metadata.gz: 3a2fca239d0220cc056a7577ec7b17d1e4e9cf9f2c706af832b38ec0d0eb5522ae4df970369fa7be882eea686fa0da0bb0f063d86f8ce3736ba24c9c0f1acca2
+  data.tar.gz: 4c8296686c59d03b8da2970cda23c8c525f2376a1d8bca2094c3b44955c37d59625d9cf8e9a8c9545a600421514e584a32e53d52fa537f40af0a035041f140b6

data/lib/timex_datalink_client/helpers/char_encoders.rb

@@ -20,7 +20,7 @@ class TimexDatalinkClient
       end
 
       def eeprom_chars_for(string_chars, length: 31)
-        chars = chars_for(string_chars, char_map: EEPROM_CHARS, length: length).append(EEPROM_TERMINATOR)
+        chars = chars_for(string_chars, char_map: EEPROM_CHARS, length:).append(EEPROM_TERMINATOR)
 
         packed_int = chars.each_with_index.sum do |char, index|
           char << (6 * index)

data/lib/timex_datalink_client/protocol_1/eeprom.rb

@@ -1,11 +1,14 @@
 # frozen_string_literal: true
 
+require "active_model"
+
 require "timex_datalink_client/helpers/cpacket_paginator"
 require "timex_datalink_client/helpers/crc_packets_wrapper"
 
 class TimexDatalinkClient
   class Protocol1
     class Eeprom
+      include ActiveModel::Validations
       include Helpers::CpacketPaginator
       prepend Helpers::CrcPacketsWrapper
 
@@ -16,8 +19,16 @@ class TimexDatalinkClient
       CPACKET_DATA_LENGTH = 27
       START_INDEX = 14
       APPOINTMENT_NO_NOTIFICATION = 0xff
+      APPOINTMENT_NOTIFICATION_VALID_MINUTES = (0..30).step(5)
+
+      attr_accessor :appointments, :anniversaries, :phone_numbers, :lists, :appointment_notification_minutes
 
-      attr_accessor :appointments, :anniversaries, :phone_numbers, :lists, :appointment_notification
+      validates :appointment_notification_minutes, inclusion: {
+        in: APPOINTMENT_NOTIFICATION_VALID_MINUTES,
+        allow_nil: true,
+        message: "value %{value} is invalid!  Valid appointment notification minutes values are" \
+          " #{APPOINTMENT_NOTIFICATION_VALID_MINUTES.to_a} or nil."
+      }
 
       # Create an Eeprom instance.
       #
@@ -25,21 +36,25 @@ class TimexDatalinkClient
       # @param anniversaries [Array<Anniversary>] Anniversaries to be added to EEPROM data.
       # @param phone_numbers [Array<PhoneNumber>] Phone numbers to be added to EEPROM data.
       # @param lists [Array<List>] Lists to be added to EEPROM data.
-      # @param appointment_notification [Integer] Appointment notification (intervals of 15 minutes, 255 for no
-      #   notification)
+      # @param appointment_notification_minutes [Integer, nil] Appointment notification in minutes.
       # @return [Eeprom] Eeprom instance.
-      def initialize(appointments: [], anniversaries: [], phone_numbers: [], lists: [], appointment_notification: APPOINTMENT_NO_NOTIFICATION)
+      def initialize(
+        appointments: [], anniversaries: [], phone_numbers: [], lists: [], appointment_notification_minutes: nil
+      )
         @appointments = appointments
         @anniversaries = anniversaries
         @phone_numbers = phone_numbers
         @lists = lists
-        @appointment_notification = appointment_notification
+        @appointment_notification_minutes = appointment_notification_minutes
       end
 
       # Compile packets for EEPROM data.
       #
+      # @raise [ActiveModel::ValidationError] One or more model values are invalid.
       # @return [Array<Array<Integer>>] Two-dimensional array of integers that represent bytes.
       def packets
+        validate!
+
         [header] + payloads + [CPACKET_END]
       end
 
@@ -57,7 +72,7 @@ class TimexDatalinkClient
           items_indexes,
           items_lengths,
           earliest_appointment_year,
-          appointment_notification,
+          appointment_notification_minutes_value,
           all_packets
         ].flatten
       end
@@ -95,6 +110,12 @@ class TimexDatalinkClient
 
         earliest_appointment.time.year % 100
       end
+
+      def appointment_notification_minutes_value
+        return APPOINTMENT_NO_NOTIFICATION unless appointment_notification_minutes
+
+        appointment_notification_minutes / 5
+      end
     end
   end
 end

data/lib/timex_datalink_client/protocol_3/eeprom.rb

@@ -1,11 +1,14 @@
 # frozen_string_literal: true
 
+require "active_model"
+
 require "timex_datalink_client/helpers/cpacket_paginator"
 require "timex_datalink_client/helpers/crc_packets_wrapper"
 
 class TimexDatalinkClient
   class Protocol3
     class Eeprom
+      include ActiveModel::Validations
       include Helpers::CpacketPaginator
       prepend Helpers::CrcPacketsWrapper
 
@@ -17,8 +20,16 @@ class TimexDatalinkClient
       CPACKET_DATA_LENGTH = 32
       START_ADDRESS = 0x0236
       APPOINTMENT_NO_NOTIFICATION = 0xff
+      APPOINTMENT_NOTIFICATION_VALID_MINUTES = (0..30).step(5)
+
+      attr_accessor :appointments, :anniversaries, :phone_numbers, :lists, :appointment_notification_minutes
 
-      attr_accessor :appointments, :anniversaries, :phone_numbers, :lists, :appointment_notification
+      validates :appointment_notification_minutes, inclusion: {
+        in: APPOINTMENT_NOTIFICATION_VALID_MINUTES,
+        allow_nil: true,
+        message: "value %{value} is invalid!  Valid appointment notification minutes values are" \
+          " #{APPOINTMENT_NOTIFICATION_VALID_MINUTES.to_a} or nil."
+      }
 
       # Create an Eeprom instance.
       #
@@ -26,21 +37,25 @@ class TimexDatalinkClient
       # @param anniversaries [Array<Anniversary>] Anniversaries to be added to EEPROM data.
       # @param phone_numbers [Array<PhoneNumber>] Phone numbers to be added to EEPROM data.
       # @param lists [Array<List>] Lists to be added to EEPROM data.
-      # @param appointment_notification [Integer] Appointment notification (intervals of 15 minutes, 255 for no
-      #   notification)
+      # @param appointment_notification_minutes [Integer, nil] Appointment notification in minutes.
       # @return [Eeprom] Eeprom instance.
-      def initialize(appointments: [], anniversaries: [], phone_numbers: [], lists: [], appointment_notification: APPOINTMENT_NO_NOTIFICATION)
+      def initialize(
+        appointments: [], anniversaries: [], phone_numbers: [], lists: [], appointment_notification_minutes: nil
+      )
         @appointments = appointments
         @anniversaries = anniversaries
         @phone_numbers = phone_numbers
         @lists = lists
-        @appointment_notification = appointment_notification
+        @appointment_notification_minutes = appointment_notification_minutes
       end
 
       # Compile packets for EEPROM data.
       #
+      # @raise [ActiveModel::ValidationError] One or more model values are invalid.
       # @return [Array<Array<Integer>>] Two-dimensional array of integers that represent bytes.
       def packets
+        validate!
+
         [CPACKET_CLEAR, header] + payloads + [CPACKET_END]
       end
 
@@ -53,7 +68,7 @@ class TimexDatalinkClient
           items_addresses,
           items_lengths,
           earliest_appointment_year,
-          appointment_notification
+          appointment_notification_minutes_value
         ].flatten
       end
 
@@ -90,6 +105,12 @@ class TimexDatalinkClient
 
         earliest_appointment.time.year % 100
       end
+
+      def appointment_notification_minutes_value
+        return APPOINTMENT_NO_NOTIFICATION unless appointment_notification_minutes
+
+        appointment_notification_minutes / 5
+      end
     end
   end
 end

data/lib/timex_datalink_client/protocol_4/eeprom.rb

@@ -1,11 +1,14 @@
 # frozen_string_literal: true
 
+require "active_model"
+
 require "timex_datalink_client/helpers/cpacket_paginator"
 require "timex_datalink_client/helpers/crc_packets_wrapper"
 
 class TimexDatalinkClient
   class Protocol4
     class Eeprom
+      include ActiveModel::Validations
       include Helpers::CpacketPaginator
       prepend Helpers::CrcPacketsWrapper
 
@@ -17,8 +20,16 @@ class TimexDatalinkClient
       CPACKET_DATA_LENGTH = 32
       START_ADDRESS = 0x0236
       APPOINTMENT_NO_NOTIFICATION = 0xff
+      APPOINTMENT_NOTIFICATION_VALID_MINUTES = (0..30).step(5)
+
+      attr_accessor :appointments, :anniversaries, :phone_numbers, :lists, :appointment_notification_minutes
 
-      attr_accessor :appointments, :anniversaries, :phone_numbers, :lists, :appointment_notification
+      validates :appointment_notification_minutes, inclusion: {
+        in: APPOINTMENT_NOTIFICATION_VALID_MINUTES,
+        allow_nil: true,
+        message: "value %{value} is invalid!  Valid appointment notification minutes values are" \
+          " #{APPOINTMENT_NOTIFICATION_VALID_MINUTES.to_a} or nil."
+      }
 
       # Create an Eeprom instance.
       #
@@ -26,21 +37,25 @@ class TimexDatalinkClient
       # @param anniversaries [Array<Anniversary>] Anniversaries to be added to EEPROM data.
       # @param phone_numbers [Array<PhoneNumber>] Phone numbers to be added to EEPROM data.
       # @param lists [Array<List>] Lists to be added to EEPROM data.
-      # @param appointment_notification [Integer] Appointment notification (intervals of 15 minutes, 255 for no
-      #   notification)
+      # @param appointment_notification_minutes [Integer, nil] Appointment notification in minutes.
       # @return [Eeprom] Eeprom instance.
-      def initialize(appointments: [], anniversaries: [], phone_numbers: [], lists: [], appointment_notification: APPOINTMENT_NO_NOTIFICATION)
+      def initialize(
+        appointments: [], anniversaries: [], phone_numbers: [], lists: [], appointment_notification_minutes: nil
+      )
         @appointments = appointments
         @anniversaries = anniversaries
         @phone_numbers = phone_numbers
         @lists = lists
-        @appointment_notification = appointment_notification
+        @appointment_notification_minutes = appointment_notification_minutes
       end
 
       # Compile packets for EEPROM data.
       #
+      # @raise [ActiveModel::ValidationError] One or more model values are invalid.
       # @return [Array<Array<Integer>>] Two-dimensional array of integers that represent bytes.
       def packets
+        validate!
+
         [CPACKET_CLEAR, header] + payloads + [CPACKET_END]
       end
 
@@ -53,7 +68,7 @@ class TimexDatalinkClient
           items_addresses,
           items_lengths,
           earliest_appointment_year,
-          appointment_notification
+          appointment_notification_minutes_value
         ].flatten
       end
 
@@ -90,6 +105,12 @@ class TimexDatalinkClient
 
         earliest_appointment.time.year % 100
       end
+
+      def appointment_notification_minutes_value
+        return APPOINTMENT_NO_NOTIFICATION unless appointment_notification_minutes
+
+        appointment_notification_minutes / 5
+      end
     end
   end
 end

data/lib/timex_datalink_client/protocol_7/eeprom/speech.rb

@@ -155,7 +155,10 @@ class TimexDatalinkClient
           value_4_length = device_nickname.any? ? NICKNAME_LENGTH_WITH_DEVICE : NICKNAME_LENGTH_WITHOUT_DEVICE
 
           value_4_length.times.flat_map do |value_4_index|
-            device_value = HEADER_VALUE_4_DEVICE_INDEXES[value_4_index].sum { |device_index| packet_lengths[device_index] }
+            device_value = HEADER_VALUE_4_DEVICE_INDEXES[value_4_index].sum do |device_index|
+              packet_lengths[device_index]
+            end
+
             device_value *= HEADER_VALUE_4_DEVICE_MULTIPLIERS[value_4_index]
 
             user_value = HEADER_VALUE_4_USER_INDEXES[value_4_index].sum { |device_index| packet_lengths[device_index] }

data/lib/timex_datalink_client/protocol_7/eeprom.rb

@@ -9,9 +9,6 @@ class TimexDatalinkClient
       include Helpers::CpacketPaginator
       prepend Helpers::CrcPacketsWrapper
 
-      # FIXME use arrays for array models
-      # FIXME: check Array<Integer> yardoc around places
-
       CPACKET_SECT = [0x90, 0x05]
       CPACKET_DATA = [0x91, 0x05]
       CPACKET_END = [0x92, 0x05]

data/lib/timex_datalink_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class TimexDatalinkClient
-  VERSION = "0.10.0"
+  VERSION = "0.11.0"
 end

data/lib/timex_datalink_client.rb

@@ -104,17 +104,17 @@ class TimexDatalinkClient
   #
   # @return [Array<Array<Integer>>] Two-dimensional array of integers that represent bytes.
   def packets
-    models.map(&:packets).flatten(1)
+    models.flat_map(&:packets)
   end
 
   private
 
   def notebook_adapter
     @notebook_adapter ||= NotebookAdapter.new(
-      serial_device: serial_device,
-      byte_sleep: byte_sleep,
-      packet_sleep: packet_sleep,
-      verbose: verbose
+      serial_device:,
+      byte_sleep:,
+      packet_sleep:,
+      verbose:
     )
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timex_datalink_client
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Maxwell Pray
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-25 00:00:00.000000000 Z
+date: 2022-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: mdl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.11.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.41.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.41.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-github
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.0
 - !ruby/object:Gem::Dependency
   name: tzinfo
   requirement: !ruby/object:Gem::Requirement
@@ -182,7 +224,7 @@ files:
 - lib/timex_datalink_client/protocol_9/time_name.rb
 - lib/timex_datalink_client/protocol_9/timer.rb
 - lib/timex_datalink_client/version.rb
-homepage: https://github.com/synthead/timex_datalink_client/tree/v0.10.0
+homepage: https://github.com/synthead/timex_datalink_client/tree/v0.11.0
 licenses:
 - MIT
 metadata: {}