build: rubocop fixes and deprecation of .rubocop_todo.yml file

.gitignore

@@ -3,3 +3,4 @@ test.output
 fixture.output
 pkg/*
 checksums/*
+*.gem

.rubocop.yml

@@ -1 +1,25 @@
-inherit_from: .rubocop_todo.yml
+AllCops:
+  TargetRubyVersion: 2.7
+  SuggestExtensions: false
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+# TODO: Enable this cop after figuring out why it is failing even when mfa required is set to true
+Gemspec/RequireMFA:
+  Enabled: false
+
+
+# NOTE: I think I actually prefer to have the development dependencies in the gemspec as they
+#       are therefore visible in Rubygems.org
+Gemspec/DevelopmentDependencies:
+  Enabled: false

Gemfile

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 gemspec
 
-gem 'rubocop', require: false
+gem "rubocop", require: false

Rakefile

@@ -1,12 +1,19 @@
 # frozen_string_literal: true
 
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
+require "bundler/gem_tasks"
 
 begin
+  require "rspec/core/rake_task"
   RSpec::Core::RakeTask.new(:spec)
 rescue LoadError
-  puts 'RSpec, or one of its dependencies, is not available. Install it with: bundle install'
+  puts "RSpec, or one of its dependencies, is not available. Install it with: bundle install"
 end
 
-task default: :spec
+begin
+  require "rubocop/rake_task"
+  RuboCop::RakeTask.new
+rescue LoadError
+  puts "rubocop, or one of its dependencies, is not available. Install it with: bundle install"
+end
+
+task default: %i[spec rubocop]

atco.gemspec

@@ -2,21 +2,22 @@
 
 require_relative "lib/atco/version"
 
-Gem::Specification.new do |s|
-  s.name = 'atco'
-  s.version = Atco::VERSION
-  s.description = 'Simple and opinionated library for parsing ATCO .cif files to JSON with Ruby'
-  s.summary = 'Parse ATCO .cif files to JSON with Ruby'
-  s.homepage = 'http://github.com/davidjrice/atco'
-  s.license = 'MIT'
-  s.authors = ['David Rice']
-  s.email = '[email protected]'
-  s.files = s.files = Dir['{lib,spec}/**/*', 'README.md', 'Rakefile', 'VERSION']
-  s.extra_rdoc_files = [
-    'README.md'
+Gem::Specification.new do |spec|
+  spec.name = "atco"
+  spec.version = Atco::VERSION
+  spec.description = "Simple and opinionated library for parsing ATCO .cif files to JSON with Ruby"
+  spec.summary = "Parse ATCO .cif files to JSON with Ruby"
+  spec.homepage = "http://github.com/davidjrice/atco"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.7.0"
+  spec.authors = ["David Rice"]
+  spec.email = "[email protected]"
+  spec.files = Dir["{lib,spec}/**/*", "README.md", "Rakefile", "VERSION"]
+  spec.extra_rdoc_files = [
+    "README.md"
   ]
-  s.rdoc_options = ['--charset=UTF-8']
-  s.require_paths = ['lib']
-  s.add_development_dependency 'rake'
-  s.add_development_dependency 'rspec'
+  spec.rdoc_options = ["--charset=UTF-8"]
+  spec.require_paths = ["lib"]
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.9"
 end

lib/atco.rb

@@ -1,27 +1,28 @@
 # frozen_string_literal: true
 
-require 'open3'
-require 'tempfile'
-require_relative 'atco/location'
-require_relative 'atco/journey'
-require_relative 'atco/stop'
-require_relative 'atco/version'
-
-module Atco
-  class << self
+require "open3"
+require "tempfile"
+require_relative "atco/location"
+require_relative "atco/journey"
+require_relative "atco/stop"
+require_relative "atco/version"
+
+# Public: Atco is a module that provides a parser for the ATCO-CIF data format.
+module Atco # rubocop:disable Metrics/ModuleLength
+  class << self # rubocop:disable Metrics/ClassLength
     @path = nil
-    @@methods = {
-      bank_holiday: 'QH',
-      operator: 'QP',
-      additional_location_info: 'QB',
-      location: 'QL',
-      destination: 'QT',
-      intermediate: 'QI',
-      origin: 'QO',
-      journey_header: 'QS'
-    }
-
-    def parse(file)
+    METHODS = {
+      bank_holiday: "QH",
+      operator: "QP",
+      additional_location_info: "QB",
+      location: "QL",
+      destination: "QT",
+      intermediate: "QI",
+      origin: "QO",
+      journey_header: "QS"
+    }.freeze
+
+    def parse(file) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
       @path = File.expand_path(file)
       data = File.readlines(@path)
 
@@ -37,13 +38,13 @@ def parse(file)
           header = parse_header(line)
           next
         end
-        @@methods.each do |method, identifier|
+        METHODS.each do |method, identifier|
           object = send("parse_#{method}", line)
           next unless object[:record_identity] && object[:record_identity] == identifier
 
-          current_journey = object if object[:record_identity] && object[:record_identity] == @@methods[:journey_header]
-          if object[:record_identity] && (object[:record_identity] == @@methods[:location] || object[:record_identity] == @@methods[:additional_location_info])
-            if object[:record_identity] == @@methods[:location]
+          current_journey = object if object[:record_identity] && object[:record_identity] == METHODS[:journey_header]
+          if object[:record_identity] && (object[:record_identity] == METHODS[:location] || object[:record_identity] == METHODS[:additional_location_info]) # rubocop:disable Layout/LineLength
+            if object[:record_identity] == METHODS[:location]
               current_location = object
             else
               locations << Location.new(current_location, object)
@@ -146,7 +147,7 @@ def parse_origin(string)
       }
     end
 
-    def parse_journey_header(string)
+    def parse_journey_header(string) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       {
         record_identity: string[0, 2],
         transaction_type: string[2, 1],

lib/atco/journey.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
 module Atco
+  # Atco::Journey is a data class to abstract ATCO-CIF Journey records.
   class Journey
     attr_accessor :vehicle_type, :registration_number, :identifier, :operator, :route_number, :first_date_of_operation,
                   :running_board, :last_date_of_operation, :school_term_time, :route_direction, :bank_holidays, :stops
 
-    def initialize(data)
+    def initialize(data) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       @mondays = parse_boolean_int data[:operates_on_mondays]
       @tuesdays = parse_boolean_int data[:operates_on_tuesdays]
       @wednesdays = parse_boolean_int data[:operates_on_wednesdays]
@@ -61,10 +62,10 @@ def sundays?
     end
 
     def parse_boolean_int(string)
-      string && string == '1' ? true : false
+      string && string == "1"
     end
 
-    def to_json(*args)
+    def to_json(*attrs) # rubocop:disable Metrics/MethodLength
       {
         vehicle_type: @vehicle_type,
         registration_number: @registration_number,
@@ -78,7 +79,7 @@ def to_json(*args)
         route_direction: @route_direction,
         bank_holidays: @bank_holidays,
         stops: @stops
-      }.to_json(*args)
+      }.to_json(*attrs)
     end
   end
 end

lib/atco/location.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Atco
+  # Atco::Location is a data class to abstract ATCO-CIF Location records.
   class Location
     attr_accessor :name, :identifier, :easting, :northing, :gazeteer_code
 
@@ -12,14 +13,14 @@ def initialize(location_header, additional_location_information)
       @gazeteer_code = location_header[:gazetteer_code]
     end
 
-    def to_json(*a)
+    def to_json(*attrs)
       {
         name: @name,
         identifier: @identifier,
         easting: @easting,
         northing: @northing,
         gazeteer_code: @gazeteer_code
-      }.to_json(*a)
+      }.to_json(*attrs)
     end
   end
 end

lib/atco/stop.rb

@@ -1,20 +1,21 @@
 # frozen_string_literal: true
 
 module Atco
+  # Atco::Stop is a class to abstract ATCO-CIF Origin, Intermediate and Destination (Stop) records.
   class Stop
     attr_accessor :bay_number, :location, :timing_point_indicator, :fare_stage_indicator, :published_departure_time,
                   :record_identity
 
     def origin?
-      @record_identity == 'QO'
+      @record_identity == "QO"
     end
 
     def intermediate?
-      @record_identity == 'QI'
+      @record_identity == "QI"
     end
 
     def destination?
-      @record_identity == 'QT'
+      @record_identity == "QT"
     end
 
     def initialize(data)
@@ -26,15 +27,15 @@ def initialize(data)
       @record_identity = data[:record_identity]
     end
 
-    def to_json(*args)
+    def to_json(*attrs)
       {
         record_identity: @record_identity,
         location: @location,
         published_departure_time: @published_departure_time,
         timing_point_indicator: @timing_point_indicator,
         fare_stage_indicator: @fare_stage_indicator,
         bay_number: @bay_number
-      }.to_json(*args)
+      }.to_json(*attrs)
     end
   end
 end

lib/atco/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Atco
-  VERSION = '1.0.0'
-end
+  VERSION = "1.0.1"
+end