try sord

- including review suggestions from @jgraichen

.gitignore

@@ -1,4 +1,6 @@
 .DS_Store
 *.lock
+doc/*
 pkg/*
+.yardoc
 sorbet/rbi/hidden-definitions/errors.txt

.solargraph.yml

@@ -0,0 +1,16 @@
+---
+include:
+- "**/*.rb"
+- "bin/dyndnsd"
+exclude:
+- spec/**/*
+- test/**/*
+- vendor/**/*
+- ".bundle/**/*"
+require: []
+domains: []
+reporters:
+- rubocop
+- require_not_found
+require_paths: []
+max_files: 5000

Rakefile

@@ -7,6 +7,10 @@ RSpec::Core::RakeTask.new(:spec)
 RuboCop::RakeTask.new
 Bundler::Audit::Task.new
 
+task :solargraph do
+  sh 'solargraph typecheck'
+end
+
 task :sorbet do
   sh 'srb typecheck'
 end

dyndnsd.gemspec

@@ -34,5 +34,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rack-test'
   s.add_development_dependency 'rubocop', '~> 0.80.0'
   s.add_development_dependency 'bundler-audit', '~> 0.6.0'
+  s.add_development_dependency 'solargraph'
   s.add_development_dependency 'sorbet', '~> 0.5.0'
+  s.add_development_dependency 'sord'
 end

lib/dyndnsd.rb

@@ -22,21 +22,32 @@ require 'dyndnsd/textfile_reporter'
 require 'dyndnsd/version'
 
 module Dyndnsd
+  # @return [Logger]
   def self.logger
     @logger
   end
 
+  # @param logger [Logger]
+  # @return [Logger]
   def self.logger=(logger)
     @logger = logger
   end
 
   class LogFormatter
+    # @param lvl [Object]
+    # @param _time [DateTime]
+    # @param _progname [String]
+    # @param msg [Object]
+    # @return [String]
     def call(lvl, _time, _progname, msg)
       format("[%s] %-5s %s\n", Time.now.strftime('%Y-%m-%d %H:%M:%S'), lvl, msg.to_s)
     end
   end
 
   class Daemon
+    # @param config [Hash{String => Object}]
+    # @param db [Dyndnsd::Database]
+    # @param updater [#update]
     def initialize(config, db, updater)
       @users = config['users']
       @domain = config['domain']
@@ -52,6 +63,9 @@ module Dyndnsd
       end
     end
 
+    # @param username [String]
+    # @param password [String]
+    # @return [Boolean]
     def authorized?(username, password)
       Helper.span('check_authorized') do |span|
         span.set_tag('dyndnsd.user', username)
@@ -65,6 +79,8 @@ module Dyndnsd
       end
     end
 
+    # @param env [Hash{String => String}]
+    # @return [Array{Integer,Hash{String => String},Array{String}}]
     def call(env)
       return [422, {'X-DynDNS-Response' => 'method_forbidden'}, []] if env['REQUEST_METHOD'] != 'GET'
       return [422, {'X-DynDNS-Response' => 'not_found'}, []] if env['PATH_INFO'] != '/nic/update'
@@ -72,6 +88,7 @@ module Dyndnsd
       handle_dyndns_request(env)
     end
 
+    # @return [void]
     def self.run!
       if ARGV.length != 1
         puts 'Usage: dyndnsd config_file'
@@ -116,6 +133,8 @@ module Dyndnsd
 
     private
 
+    # @param params [Hash{String => String}]
+    # @return [Array{String}]
     def extract_v4_and_v6_address(params)
       return [] if !(params['myip'])
       begin
@@ -127,6 +146,9 @@ module Dyndnsd
       end
     end
 
+    # @param env [Hash{String => String}]
+    # @param params [Hash{String => String}]
+    # @return [Array{String}]
     def extract_myips(env, params)
       # require presence of myip parameter as valid IPAddr (v4) and valid myip6
       return extract_v4_and_v6_address(params) if params.key?('myip6')
@@ -141,6 +163,9 @@ module Dyndnsd
       [env['REMOTE_ADDR']]
     end
 
+    # @param hostnames [String]
+    # @param myips [Array{String}]
+    # @return [Array{Symbol}]
     def process_changes(hostnames, myips)
       changes = []
       Helper.span('process_changes') do |span|
@@ -165,6 +190,7 @@ module Dyndnsd
       changes
     end
 
+    # @return [void]
     def update_db
       @db['serial'] += 1
       Dyndnsd.logger.info "Committing update ##{@db['serial']}"
@@ -173,6 +199,8 @@ module Dyndnsd
       Metriks.meter('updates.committed').mark
     end
 
+    # @param env [Hash{String => String}]
+    # @return [Array{Integer,Hash{String => String},Array{String}}]
     def handle_dyndns_request(env)
       params = Rack::Utils.parse_query(env['QUERY_STRING'])
 
@@ -211,6 +239,8 @@ module Dyndnsd
 
     # SETUP
 
+    # @param config [Hash{String => Object}]
+    # @return [void]
     private_class_method def self.setup_logger(config)
       if config['logfile']
         Dyndnsd.logger = Logger.new(config['logfile'])
@@ -222,6 +252,7 @@ module Dyndnsd
       Dyndnsd.logger.formatter = LogFormatter.new
     end
 
+    # @return [void]
     private_class_method def self.setup_traps
       Signal.trap('INT') do
         Dyndnsd.logger.info 'Quitting...'
@@ -233,6 +264,8 @@ module Dyndnsd
       end
     end
 
+    # @param config [Hash{String => Object}]
+    # @return [void]
     private_class_method def self.setup_monitoring(config)
       # configure metriks
       if config['graphite']
@@ -260,6 +293,8 @@ module Dyndnsd
       end
     end
 
+    # @param config [Hash{String => Object}]
+    # @return [void]
     private_class_method def self.setup_tracing(config)
       # configure OpenTracing
       if config.dig('tracing', 'jaeger')
@@ -274,10 +309,12 @@ module Dyndnsd
       end
     end
 
+    # @param config [Hash{String => Object}]
+    # @return [void]
     private_class_method def self.setup_rack(config)
       # configure daemon
       db = Database.new(config['db'])
-      updater = Updater::CommandWithBindZone.new(config['domain'], config['updater']['params']) if config['updater']['name'] == 'command_with_bind_zone'
+      updater = Updater::CommandWithBindZone.new(config['domain'], config.dig('updater', 'params')) if config.dig('updater', 'name') == 'command_with_bind_zone'
       daemon = Daemon.new(config, db, updater)
 
       # configure rack

lib/dyndnsd/database.rb

@@ -8,10 +8,12 @@ module Dyndnsd
 
     def_delegators :@db, :[], :[]=, :each, :has_key?
 
+    # @param db_file [String]
     def initialize(db_file)
       @db_file = db_file
     end
 
+    # @return [void]
     def load
       if File.file?(@db_file)
         @db = JSON.parse(File.read(@db_file, mode: 'r'))
@@ -21,6 +23,7 @@ module Dyndnsd
       @db_hash = @db.hash
     end
 
+    # @return [void]
     def save
       Helper.span('database_save') do |_span|
         File.open(@db_file, 'w') { |f| JSON.dump(@db, f) }
@@ -28,6 +31,7 @@ module Dyndnsd
       end
     end
 
+    # @return [Boolean]
     def changed?
       @db_hash != @db.hash
     end

lib/dyndnsd/generator/bind.rb

@@ -3,6 +3,8 @@
 module Dyndnsd
   module Generator
     class Bind
+      # @param domain [String]
+      # @param config [Hash{String => Object}]
       def initialize(domain, config)
         @domain = domain
         @ttl = config['ttl']
@@ -11,6 +13,8 @@ module Dyndnsd
         @additional_zone_content = config['additional_zone_content']
       end
 
+      # @param db [Dyndnsd::Database]
+      # @return [String]
       def generate(db)
         out = []
         out << "$TTL #{@ttl}"

lib/dyndnsd/helper.rb

@@ -4,6 +4,9 @@ require 'ipaddr'
 
 module Dyndnsd
   class Helper
+    # @param hostname [String]
+    # @param domain [String]
+    # @return [Boolean]
     def self.fqdn_valid?(hostname, domain)
       return false if hostname.length < domain.length + 2
       return false if !hostname.end_with?(domain)
@@ -12,6 +15,8 @@ module Dyndnsd
       true
     end
 
+    # @param ip [String]
+    # @return [Boolean]
     def self.ip_valid?(ip)
       IPAddr.new(ip)
       true
@@ -19,15 +24,26 @@ module Dyndnsd
       false
     end
 
+    # @param username [String]
+    # @param password [String]
+    # @param users [Hash]
+    # @return [Boolean]
     def self.user_allowed?(username, password, users)
       (users.key? username) && (users[username]['password'] == password)
     end
 
+    # @param hostname [String]
+    # @param myips [Array]
+    # @param hosts [Hash]
+    # @return [Boolean]
     def self.changed?(hostname, myips, hosts)
       # myips order is always deterministic
       ((!hosts.include? hostname) || (hosts[hostname] != myips)) && !myips.empty?
     end
 
+    # @param operation [String]
+    # @param block [Proc]
+    # @return [void]
     def self.span(operation, &block)
       scope = OpenTracing.start_active_span(operation)
       span = scope.span

lib/dyndnsd/responder/dyndns_style.rb

@@ -3,10 +3,13 @@
 module Dyndnsd
   module Responder
     class DynDNSStyle
+      # @param app [#call]
       def initialize(app)
         @app = app
       end
 
+      # @param env [Hash{String => String}]
+      # @return [Array{Integer,Hash{String => String},Array{String}}]
       def call(env)
         @app.call(env).tap do |status_code, headers, body|
           if headers.key?('X-DynDNS-Response')
@@ -19,6 +22,10 @@ module Dyndnsd
 
       private
 
+      # @param status_code [Integer]
+      # @param headers [Hash{String => String}]
+      # @param body [Array{String}]
+      # @return [Array{Integer,Hash{String => String},Array{String}}]
       def decorate_dyndnsd_response(status_code, headers, body)
         if status_code == 200
           [200, {'Content-Type' => 'text/plain'}, [get_success_body(body[0], body[1])]]
@@ -27,6 +34,10 @@ module Dyndnsd
         end
       end
 
+      # @param status_code [Integer]
+      # @param headers [Hash{String => String}]
+      # @param _body [Array{String}]
+      # @return [Array{Integer,Hash{String => String},Array{String}}]
       def decorate_other_response(status_code, headers, _body)
         if status_code == 400
           [status_code, headers, ['Bad Request']]
@@ -35,10 +46,14 @@ module Dyndnsd
         end
       end
 
+      # @param changes [Array{Symbol}]
+      # @param myips [Array{String}]
+      # @return [String]
       def get_success_body(changes, myips)
         changes.map { |change| "#{change} #{myips.join(' ')}" }.join("\n")
       end
 
+      # @return [Hash{String => Object}]
       def error_response_map
         {
           # general http errors

lib/dyndnsd/responder/rest_style.rb

@@ -3,10 +3,13 @@
 module Dyndnsd
   module Responder
     class RestStyle
+      # @param app [#call]
       def initialize(app)
         @app = app
       end
 
+      # @param env [Hash{String => String}]
+      # @return [Array{Integer,Hash{String => String},Array{String}}]
       def call(env)
         @app.call(env).tap do |status_code, headers, body|
           if headers.key?('X-DynDNS-Response')
@@ -19,6 +22,10 @@ module Dyndnsd
 
       private
 
+      # @param status_code [Integer]
+      # @param headers [Hash{String => String}]
+      # @param body [Array{String}]
+      # @return [Array{Integer,Hash{String => String},Array{String}}]
       def decorate_dyndnsd_response(status_code, headers, body)
         if status_code == 200
           [200, {'Content-Type' => 'text/plain'}, [get_success_body(body[0], body[1])]]
@@ -27,6 +34,10 @@ module Dyndnsd
         end
       end
 
+      # @param status_code [Integer]
+      # @param headers [Hash{String => String}]
+      # @param _body [Array{String}]
+      # @return [Array{Integer,Hash{String => String},Array{String}}]
       def decorate_other_response(status_code, headers, _body)
         if status_code == 400
           [status_code, headers, ['Bad Request']]
@@ -35,10 +46,14 @@ module Dyndnsd
         end
       end
 
+      # @param changes [Array{Symbol}]
+      # @param myips [Array{String}]
+      # @return [String]
       def get_success_body(changes, myips)
         changes.map { |change| change == :good ? "Changed to #{myips.join(' ')}" : "No change needed for #{myips.join(' ')}" }.join("\n")
       end
 
+      # @return [Hash{String => Object}]
       def error_response_map
         {
           # general http errors

lib/dyndnsd/textfile_reporter.rb

@@ -6,8 +6,11 @@ require 'metriks'
 
 module Dyndnsd
   class TextfileReporter
+    # @return [String]
     attr_reader :file
 
+    # @param file [String]
+    # @param options [Hash{Symbol => Object}]
     def initialize(file, options = {})
       @file = file
 
@@ -18,6 +21,7 @@ module Dyndnsd
       @on_error  = options[:on_error] || proc { |ex| }
     end
 
+    # @return [void]
     def start
       @thread ||= Thread.new do
         loop do
@@ -34,16 +38,19 @@ module Dyndnsd
       end
     end
 
+    # @return [void]
     def stop
       @thread&.kill
       @thread = nil
     end
 
+    # @return [void]
     def restart
       stop
       start
     end
 
+    # @return [void]
     def write
       File.open(@file, 'w') do |f|
         @registry.each do |name, metric|
@@ -86,6 +93,12 @@ module Dyndnsd
       end
     end
 
+    # @param file [String]
+    # @param base_name [String]
+    # @param metric [Object]
+    # @param keys [Array{Symbol}]
+    # @param snapshot_keys [Array{Symbol}]
+    # @return [void]
     def write_metric(file, base_name, metric, keys, snapshot_keys = [])
       time = Time.now.to_i
 

lib/dyndnsd/updater/command_with_bind_zone.rb

@@ -3,12 +3,16 @@
 module Dyndnsd
   module Updater
     class CommandWithBindZone
+      # @param domain [String]
+      # @param config [Hash{String => Object}]
       def initialize(domain, config)
         @zone_file = config['zone_file']
         @command = config['command']
         @generator = Generator::Bind.new(domain, config)
       end
 
+      # @param db [Dyndnsd::Database]
+      # @return [void]
       def update(db)
         Helper.span('updater_update') do |span|
           span.set_tag('dyndnsd.updater.name', self.class.name&.split('::')&.last || 'None')