Merge pull request #269 from 0x1eef/lint/standardrb

Add the standardrb linter

Author: 0x1eef

.github/workflows/test.yml

@@ -9,7 +9,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby_version: ["2.3", "2.4", "2.5", "2.6", "2.7", "3.0", "3.1", "3.2"]
+        ruby_version: ["2.6", "2.7", "3.0", "3.1", "3.2"]
         experimental: [false]
         include:
           - ruby_version: "ruby-head"
@@ -21,4 +21,5 @@ jobs:
         with:
           ruby-version: ${{ matrix.ruby_version }}
           bundler-cache: true
+      - run: "bundle exec rubocop lib/ spec/"
       - run: "bundle exec rspec spec/ -b"

.rubocop.yml

@@ -0,0 +1,54 @@
+##
+# Plugins
+require:
+  - standard
+
+##
+# Defaults: standardrb
+inherit_gem:
+  standard: config/base.yml
+
+##
+# Rules that break from standardrb defaults
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+##
+# Disabled rules
+Lint/AssignmentInCondition:
+  Enabled: false
+Lint/FloatComparison:
+  Enabled: false
+Lint/ConstantDefinitionInBlock:
+  Enabled: false
+Lint/EmptyWhen:
+  Exclude:
+    - "lib/webmachine/dispatcher/route.rb"
+Lint/DuplicateMethods:
+  Exclude:
+    - "lib/webmachine/application.rb"
+Lint/UnderscorePrefixedVariableName:
+  Exclude:
+    - "lib/webmachine/trace/resource_proxy.rb"
+    - "spec/webmachine/dispatcher_spec.rb"
+Lint/NestedMethodDefinition:
+  Exclude:
+    - "spec/webmachine/decision/flow_spec.rb"
+Lint/RescueException:
+  Exclude:
+    - "spec/webmachine/decision/fsm_spec.rb"
+Lint/RaiseException:
+  Exclude:
+    - "spec/webmachine/decision/fsm_spec.rb"
+Style/MissingRespondToMissing:
+  Exclude:
+    - "lib/webmachine/request.rb"
+Style/NilComparison:
+  Exclude:
+    - "spec/webmachine/decision/falsey_spec.rb"
+Style/GlobalVars:
+  Exclude:
+    - "lib/webmachine/decision/conneg.rb"
+
+AllCops:
+  SuggestExtensions: false

Gemfile

@@ -3,29 +3,16 @@ source 'https://rubygems.org'
 gemspec
 
 group :development do
-  gem "yard", "~> 0.9"
-  gem "rake", "~> 12.0"
+  gem 'yard', '~> 0.9'
+  gem 'rake', '~> 12.0'
 end
 
 group :test do
-  gem "rspec", "~> 3.0", ">= 3.6.0"
-  gem "rspec-its", "~> 1.2"
-  gem "rack", "~> 2.0"
-  gem "rack-test", "~> 0.7"
-  gem "websocket_parser", "~>1.0"
-end
-
-group :guard do
-  gem 'guard-rspec', '~> 4.7'
-  case RbConfig::CONFIG['host_os']
-  when /darwin/
-    gem 'rb-fsevent', '~> 0.10'
-    # gem 'growl_notify'
-    gem 'growl', '~> 1.0'
-  when /linux/
-    gem 'rb-inotify'
-    gem 'libnotify'
-  end
+  gem 'rspec', '~> 3.0', '>= 3.6.0'
+  gem 'rspec-its', '~> 1.2'
+  gem 'rack', '~> 2.0'
+  gem 'rack-test', '~> 0.7'
+  gem 'websocket_parser', '~>1.0'
 end
 
 group :docs do

Guardfile

@@ -1,44 +1,44 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 
 begin
   require 'yard'
   require 'yard/rake/yardoc_task'
   YARD::Rake::YardocTask.new do |doc|
-    doc.files = Dir["lib/**/*.rb"] + ['README.md']
-    doc.options = ["-m", "markdown"]
+    doc.files = Dir['lib/**/*.rb'] + ['README.md']
+    doc.options = ['-m', 'markdown']
   end
 rescue LoadError
 end
 
-desc "Validate the gemspec file."
+desc 'Validate the gemspec file.'
 task :validate_gemspec do
-  Gem::Specification.load("webmachine.gemspec").validate
+  Gem::Specification.load('webmachine.gemspec').validate
 end
 
-task :build => :validate_gemspec
+task build: :validate_gemspec
 
-desc "Cleans up white space in source files"
+desc 'Cleans up white space in source files'
 task :clean_whitespace do
   no_file_cleaned = true
 
-  Dir["**/*.rb"].each do |file|
+  Dir['**/*.rb'].each do |file|
     contents = File.read(file)
     cleaned_contents = contents.gsub(/([ \t]+)$/, '')
     unless cleaned_contents == contents
       no_file_cleaned = false
       puts " - Cleaned #{file}"
-      File.open(file, 'w') { |f| f.write(cleaned_contents) }
+      File.write(file, cleaned_contents)
     end
   end
 
   if no_file_cleaned
-    puts "No files with trailing whitespace found"
+    puts 'No files with trailing whitespace found'
   end
 end
 
 require 'rspec/core/rake_task'
 
-desc "Run specs"
+desc 'Run specs'
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

Rakefile

@@ -2,21 +2,23 @@
 require 'webmachine/trace'
 
 class MyTracedResource < Webmachine::Resource
-  def trace?; true; end
+  def trace?
+    true
+  end
 
   def resource_exists?
     case request.query['e']
     when 'true'
       true
     when 'fail'
-      raise "BOOM"
+      raise 'BOOM'
     else
       false
     end
   end
 
   def to_html
-    "<html>You found me.</html>"
+    '<html>You found me.</html>'
   end
 end
 

examples/debugger.rb

@@ -18,7 +18,7 @@ def handle_event(event)
     resource = event.payload[:resource]
     code = event.payload[:code]
 
-    puts "[%s] method=%s uri=%s code=%d resource=%s time=%.4f" % [
+    puts '[%s] method=%s uri=%s code=%d resource=%s time=%.4f' % [
       Time.now.iso8601, request.method, request.uri.to_s, code, resource,
       event.duration
     ]
@@ -34,7 +34,7 @@ def handle_event(event)
 
   app.configure do |config|
     config.adapter = :WEBrick
-    config.adapter_options = {:AccessLog => [], :Logger => Logger.new('/dev/null')}
+    config.adapter_options = {AccessLog: [], Logger: Logger.new('/dev/null')}
   end
 end
 

examples/logging.rb

@@ -6,11 +6,11 @@ def last_modified
   end
 
   def encodings_provided
-    { "gzip" => :encode_gzip, "identity" => :encode_identity }
+    {'gzip' => :encode_gzip, 'identity' => :encode_identity}
   end
 
   def to_html
-    "<html><head><title>Hello from Webmachine</title></head><body>Hello, world!</body></html>"
+    '<html><head><title>Hello from Webmachine</title></head><body>Hello, world!</body></html>'
   end
 end
 

examples/webrick.rb

@@ -1,10 +1,8 @@
 module Webmachine
-
   # The abstract class for definining a Webmachine adapter.
   #
   # @abstract Subclass and override {#run} to implement a custom adapter.
   class Adapter
-
     # @return [Webmachine::Application] returns the application
     attr_reader :application
 
@@ -25,6 +23,5 @@ def self.run(application)
     def run
       raise NotImplementedError
     end
-
   end
 end

lib/webmachine/adapter.rb

@@ -24,7 +24,7 @@ def empty?
       # @yield [chunk]
       # @yieldparam [String] chunk a chunk of the request body
       def each
-        @request.body {|chunk| yield chunk }
+        @request.body { |chunk| yield chunk }
       end
     end # class RequestBody
   end # module Adapters