rubocop pass

Author: inopinatus

.rubocop.yml

@@ -0,0 +1,17 @@
+AllCops:
+  TargetRubyVersion: 3.4
+  NewCops: enable
+  Exclude:
+    - "doc/**/*"
+    - "tmp/**/*"
+    - "vendor/**/*"
+
+plugins:
+  - rubocop-minitest
+  - rubocop-rake
+
+Layout/LineLength:
+  Max: 120
+
+Style/Documentation:
+  Enabled: false

Gemfile

@@ -1,3 +1,14 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 gemspec
+
+group :development, :test do
+  gem 'minitest'
+  gem 'rake'
+  gem 'rdoc', '>= 7'
+  gem 'rubocop', '~> 1.65'
+  gem 'rubocop-minitest', '~> 0.37'
+  gem 'rubocop-rake', '~> 0.7'
+end

Rakefile

@@ -1,19 +1,21 @@
-require "bundler/setup"
-require "bundler/gem_tasks"
-require "rdoc/task"
-require "rake/testtask"
-require "tmpdir"
-require "fileutils"
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'rdoc/task'
+require 'rake/testtask'
+require 'tmpdir'
+require 'fileutils'
 
 Rake::TestTask.new do |t|
-  t.libs << "lib"
-  t.libs << "test"
-  t.test_files = FileList["test/**/test_*.rb"]
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.test_files = FileList['test/**/test_*.rb']
 end
 
-directory "tmp"
-file "tmp/Examples.md" => ["tmp", *FileList["examples/*.rb"]] do |f|
-  File.open(f.name, "w") do |out|
+directory 'tmp'
+file 'tmp/Examples.md' => ['tmp', *FileList['examples/*.rb']] do |f|
+  File.open(f.name, 'w') do |out|
     out << <<~HEAD
       # Examples
 
@@ -22,7 +24,7 @@ file "tmp/Examples.md" => ["tmp", *FileList["examples/*.rb"]] do |f|
       concatenated here for easy consumption.
 
     HEAD
-    examples = f.prerequisites.sort.grep /\.rb\z/
+    examples = f.prerequisites.sort.grep(/\.rb\z/)
     examples.each do |path|
       out << "## #{File.basename(path)}\n\n```ruby\n"
       out << File.read(path)
@@ -32,17 +34,17 @@ file "tmp/Examples.md" => ["tmp", *FileList["examples/*.rb"]] do |f|
 end
 
 Rake::RDocTask.new do |rdoc|
-  rdoc.rdoc_files.include("README.md", "LICENSE", "lib/**/*.rb", "tmp/Examples.md")
-  rdoc.main = "README.md"
-  rdoc.rdoc_dir = "doc"
+  rdoc.rdoc_files.include('README.md', 'LICENSE', 'lib/**/*.rb', 'tmp/Examples.md')
+  rdoc.main = 'README.md'
+  rdoc.rdoc_dir = 'doc'
   rdoc.generator = 'aliki'
   rdoc.title = 'Linefeed RDoc'
-  rdoc.options << "--show-hash"
+  rdoc.options << '--show-hash'
 end
 
-desc "Run the examples"
+desc 'Run the examples'
 task :demo do
-  ruby "-I lib", "examples/demo.rb"
+  ruby '-I lib', 'examples/demo.rb'
 end
 
 task default: :test

examples/01_logger.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative 'demo'
 require 'linefeed'
 
@@ -10,7 +11,8 @@ class Logger
     def initialize(output)
       line_no = 0
       linefeed do |line|
-        output << "%.3d => %s" % [line_no += 1, line]
+        line_no += 1
+        output << format('%<line_no>03d => %<line>s', line_no: line_no, line: line)
       end
     end
   end

examples/02_canonicalize.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative 'demo'
 require 'linefeed'
 
@@ -23,7 +24,7 @@ def process_line(line)
     end
 
     def canonicalize(line)
-      line.chomp.sub(/[ \t]+$/, "") + "\r\n"
+      "#{line.chomp.sub(/[ \t]+$/, '')}\r\n"
     end
 
     def close
@@ -32,4 +33,4 @@ def close
       @output.close
     end
   end
-end
+end

examples/03_escaped.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative 'demo'
 require 'linefeed'
 
@@ -12,19 +13,19 @@ def initialize(output)
     end
 
     def escape(line)
-      line.sub(/^(-|From )/, "- \\1")
+      line.sub(/^(-|From )/, '- \\1')
     end
 
     def <<(chunk)
-      super(chunk) do |line|
+      super do |line|
         @output << escape(line)
       end
     end
 
     def close
       super do |line|
-        @output << escape(line) + "\n"
+        @output << "#{escape(line)}\n"
       end
     end
   end
-end
+end

examples/04_line_digest.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
+
 require_relative 'demo'
 require 'linefeed'
-require "digest"
+require 'digest'
 
 # Only outputs at close
 module Demo
@@ -10,7 +11,7 @@ class LineDigest
 
     def initialize(output)
       @output = output
-      @line_digest = Digest("SHA256").new
+      @line_digest = Digest('SHA256').new
 
       linefeed do |line|
         @line_digest.update(line)

examples/05_chunk_digest.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
+
 require_relative 'demo'
 require 'linefeed'
-require "digest"
+require 'digest'
 
 # Not actually using Linefeed, but speaking the same protocol,
 # consuming entire chunks.
@@ -11,7 +12,7 @@ module Demo
   class ChunkDigest
     def initialize(output)
       @output = output
-      @digest = Digest("SHA256").new
+      @digest = Digest('SHA256').new
     end
 
     def <<(chunk)

examples/06_canonicalized_digest.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
+
 require_relative 'demo'
 require 'linefeed'
-require "delegate"
+require 'delegate'
 
 # Easy chaining
 module Demo

examples/07_null.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative 'demo'
 require 'linefeed'