Add rucoop && enforce styling

Author: Federico Moya

.rubocop.yml

@@ -0,0 +1,5 @@
+AllCops:
+  TargetRubyVersion: 2.4
+
+Style/Documentation:
+  Enabled: false

Gemfile

@@ -1,7 +1,10 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
 
-gemspec
+source 'https://rubygems.org'
 
 group :development do
   gem 'byebug'
+  gem 'rake', '~> 12.0'
+  gem 'rubocop'
+  gem 'test-unit'
 end

Gemfile.lock

@@ -1,32 +1,39 @@
-PATH
-  remote: .
-  specs:
-    simplecov-json-formatter (0.1.1)
-      json
-      simplecov (~> 0.18, >= 0.18.0)
-
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.1)
     byebug (11.1.3)
-    docile (1.3.2)
-    json (2.3.1)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
     power_assert (1.2.0)
-    rake (13.0.1)
-    simplecov (0.18.5)
-      docile (~> 1.1)
-      simplecov-html (~> 0.11)
-    simplecov-html (0.12.2)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
+    rubocop (0.89.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.3.0, < 1.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.3.0)
+      parser (>= 2.7.1.4)
+    ruby-progressbar (1.10.1)
     test-unit (3.3.6)
       power_assert
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   byebug
-  rake
-  simplecov-json-formatter!
+  rake (~> 12.0)
+  rubocop
   test-unit
 
 BUNDLED WITH

Rakefile

@@ -1,4 +1,6 @@
-require 'bundler/gem_tasks'
+# frozen_string_literal: true
+
+require 'bundler/setup'
 require 'rake/testtask'
 
 Rake::TestTask.new(:test) do |t|
@@ -7,4 +9,13 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList['test/**/*_test.rb']
 end
 
-task :default => :test
+begin
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+rescue LoadError
+  task :rubocop do
+    warn 'Rubocop is disabled'
+  end
+end
+
+task default: %i[rubocop test]

lib/simplecov-json-formatter.rb renamed to lib/simplecov_json_formatter.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require 'simplecov'
-require 'simplecov-json-formatter/result_hash_formatter'
-require 'simplecov-json-formatter/result_exporter'
+require 'simplecov_json_formatter/result_hash_formatter'
+require 'simplecov_json_formatter/result_exporter'
 require 'json'
 
 module SimpleCov
@@ -27,7 +29,8 @@ def export_formatted_result(result_hash)
       end
 
       def output_message(result)
-        "JSON Coverage report generated for #{result.command_name} to #{SimpleCov.coverage_path}. #{result.covered_lines} / #{result.total_lines} LOC (#{result.covered_percent.round(2)}%) covered."
+        "JSON Coverage report generated for #{result.command_name} to #{SimpleCov.coverage_path}. \
+        #{result.covered_lines} / #{result.total_lines} LOC (#{result.covered_percent.round(2)}%) covered."
       end
     end
   end

lib/simplecov-json-formatter/result_exporter.rb renamed to lib/simplecov_json_formatter/result_exporter.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module SimpleCovJSONFormatter
   class ResultExporter
-    FILENAME='coverage.json'
+    FILENAME = 'coverage.json'
 
     def initialize(result_hash)
       @result = result_hash

lib/simplecov-json-formatter/result_hash_formatter.rb renamed to lib/simplecov_json_formatter/result_hash_formatter.rb

@@ -1,4 +1,6 @@
-require 'simplecov-json-formatter/source_file_formatter'
+# frozen_string_literal: true
+
+require 'simplecov_json_formatter/source_file_formatter'
 
 module SimpleCovJSONFormatter
   class ResultHashFormatter

lib/simplecov-json-formatter/source_file_formatter.rb renamed to lib/simplecov_json_formatter/source_file_formatter.rb

@@ -1,37 +1,50 @@
+# frozen_string_literal: true
+
 module SimpleCovJSONFormatter
   class SourceFileFormatter
     def initialize(source_file)
       @source_file = source_file
     end
 
     def format
+      {
+        lines: lines,
+        branches: branches
+      }
+    end
+
+    private
+
+    def lines
       lines = []
       @source_file.lines.each do |line|
         lines << parse_line(line)
       end
+
+      lines
+    end
+
+    def branches
       branches = []
       @source_file.branches.each do |branch|
         branches << parse_branch(branch)
       end
-      {
-        lines: lines,
-        branches: branches,
-      }
-    end
 
-    private
+      branches
+    end
 
     def parse_line(line)
       return line.coverage unless line.skipped?
-      "ignored"
+
+      'ignored'
     end
 
     def parse_branch(branch)
       {
         type: branch.type,
         start_line: branch.start_line,
         end_line: branch.end_line,
-        coverage: parse_line(branch),
+        coverage: parse_line(branch)
       }
     end
   end

lib/simplecov-json-formatter/version.rb renamed to lib/simplecov_json_formatter/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SimpleCovJSONFormatter
   VERSION = '0.1.1'
 end

simplecov-json-formatter.gemspec renamed to simplecov_json_formatter.gemspec

@@ -1,24 +1,23 @@
-$LOAD_PATH.push File.expand_path('../lib', __FILE__)
-require 'simplecov-json-formatter/version'
+# frozen_string_literal: true
 
-Gem::Specification.new 'simplecov-json-formatter' do |s|
+$LOAD_PATH.push File.expand_path('lib', __dir__)
+require 'simplecov_json_formatter/version'
+
+Gem::Specification.new 'simplecov_json_formatter' do |s|
   s.version     = SimpleCovJSONFormatter::VERSION
   s.platform    = Gem::Platform::RUBY
   s.authors     = ['Federico Moya']
   s.email       = ['[email protected]']
-  s.homepage    = 'https://github.com/fede-moya/simplecov-json-formatter'
-  s.summary     = %Q{JSON formatter for SimpleCov}
+  s.homepage    = 'https://github.com/fede-moya/simplecov_json_formatter'
+  s.summary     = %(JSON formatter for SimpleCov)
   s.description = s.summary
 
-  s.files         = Dir['{lib}/**/*.*', "*.md"]
+  s.files         = Dir['{lib}/**/*.*', '*.md']
   s.test_files    = Dir['{test}/**/*.*']
   s.require_paths = ['lib']
 
   s.required_ruby_version = '>= 2.4.0'
-  
-  s.add_dependency 'simplecov', '~> 0.18', '>= 0.18.0'
+
   s.add_dependency 'json'
-  
-  s.add_development_dependency 'rake'
-  s.add_development_dependency 'test-unit'
+  s.add_dependency 'simplecov', '~> 0.18', '>= 0.18.0'
 end