templatecop 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b3638b72df80a798b42389125fa1b67085a6c1ddbae87ac431b9fa2f4088ab7
-  data.tar.gz: d6c5635d979fe7734f412259fc0dc2761e048de9afe76c271b6ac79452af6ff4
+  metadata.gz: 60c625ec4bf026174039c9a815a1baee6e562fff906a0d07bd77b0c4a0d6f96a
+  data.tar.gz: 4e08952b06bf388c51a91c12efecfce3642e9c73f8d60df0b64f43f1bc068b87
 SHA512:
-  metadata.gz: e4616cc878daf91433567903956aab4f6a96f5a3f33e38284ec1f4d9754632a59a841011eec804e88abb5281a16ac6651cf84cad91e9d33f2d0ff0195120bcbf
-  data.tar.gz: 8624e290b2f2f42304210ef0a71cf5d15ed57bf01ee1e17a4e131012d52d40f8078f56080d074ebbc668827a91d9095844de42d9be434289bd8a46d34db500dd
+  metadata.gz: e3c60ad4fcd3721fe16324fafeca33352b959ac2c6956283b0e62c03a322e7c95931d4bfa8bd03519e5dbbd2d098cf48551d5ee0f253656eddea26637e30e220
+  data.tar.gz: 904a14de0c89e399a207a25037db8cfb5b7c42a366fe781aa37caf9b4f9141cac6274f980bfad8a5de4901f4e31699a69c0be243fc29d8dec0d62f848d9f5ad9

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## Unreleased
 
+## 0.2.0 - 2022-01-22
+
+### Changed
+
+- Run in parallel.
+
 ## 0.1.0 - 2022-01-15
 
 - Initial release.

data/Gemfile

@@ -9,3 +9,4 @@ gem 'rake'
 gem 'rspec'
 gem 'rubocop'
 gem 'rubocop-rspec'
+gem 'slimcop'

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    templatecop (0.1.0)
+    templatecop (0.2.0)
+      parallel
       parser
       rubocop (>= 0.87)
 
@@ -44,6 +45,16 @@ GEM
     rubocop-rspec (2.7.0)
       rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
+    slimcop (0.13.1)
+      slimi (>= 0.5.1)
+      templatecop
+    slimi (0.7.1)
+      temple
+      thor
+      tilt
+    temple (0.8.2)
+    thor (1.2.1)
+    tilt (2.0.10)
     unicode-display_width (2.1.0)
 
 PLATFORMS
@@ -54,6 +65,7 @@ DEPENDENCIES
   rspec
   rubocop
   rubocop-rspec
+  slimcop
   templatecop!
 
 BUNDLED WITH

data/README.md

@@ -1,5 +1,8 @@
 # Templatecop
 
+[![Gem Version](https://badge.fury.io/rb/templatecop.svg)](https://rubygems.org/gems/templatecop)
+[![test](https://github.com/r7kamura/templatecop/actions/workflows/test.yml/badge.svg)](https://github.com/r7kamura/templatecop/actions/workflows/test.yml)
+
 [RuboCop](https://github.com/rubocop/rubocop) runner framework for template language.
 
 ## Installation
@@ -24,4 +27,7 @@ gem install templatecop
 
 ## Usage
 
-TBD.
+See these examples:
+
+- <https://github.com/r7kamura/erbcop>
+- <https://github.com/r7kamura/slimcop>

data/lib/templatecop/offense.rb

@@ -50,6 +50,44 @@ module Templatecop
       )
     end
 
+    # @note For Parallel.
+    # @return [Hash]
+    def marshal_dump
+      {
+        begin_pos: @rubocop_offense.location.begin_pos,
+        cop_name: @rubocop_offense.cop_name,
+        end_pos: @rubocop_offense.location.end_pos,
+        file_path: @file_path,
+        message: @rubocop_offense.message.dup.force_encoding(::Encoding::UTF_8).scrub,
+        offset: @offset,
+        severity: @rubocop_offense.severity.to_s,
+        source: @source,
+        status: @rubocop_offense.status
+      }
+    end
+
+    # @note For Parallel.
+    # @param [Hash] hash
+    def marshal_load(hash)
+      @file_path = hash[:file_path]
+      @offset = hash[:offset]
+      @rubocop_offense = ::RuboCop::Cop::Offense.new(
+        hash[:severity],
+        ::Parser::Source::Range.new(
+          ::Parser::Source::Buffer.new(
+            @file_path,
+            source: @source
+          ),
+          hash[:begin_pos],
+          hash[:end_pos]
+        ),
+        hash[:message],
+        hash[:cop_name],
+        hash[:status].to_sym
+      )
+      @source = hash[:source]
+    end
+
     private
 
     # @return [Parser::Source::Buffer]

data/lib/templatecop/runner.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require 'parallel'
+require 'stringio'
+
 module Templatecop
   # Run investigation and auto-correcttion.
   class Runner
@@ -25,9 +28,11 @@ module Templatecop
     # @return [Array<RuboCop::Cop::Offense>]
     def call
       on_started
-      offenses = investigate_and_correct
-      on_finished
-      offenses
+      result = run_in_parallel
+      on_finished(result)
+      result.flat_map do |(_, offenses)|
+        offenses
+      end
     end
 
     private
@@ -59,9 +64,9 @@ module Templatecop
       ).call
     end
 
-    # @return [Array<RuboCop::Cop::Offense>]
-    def investigate_and_correct
-      @file_paths.flat_map do |file_path|
+    # @return [Hash]
+    def run_in_parallel
+      ::Parallel.map(@file_paths) do |file_path|
         offenses_per_file = []
         max_trials_count.times do
           on_file_started(file_path)
@@ -84,7 +89,7 @@ module Templatecop
           )
         end
         on_file_finished(file_path, offenses_per_file)
-        offenses_per_file
+        [file_path, offenses_per_file]
       end
     end
 
@@ -112,7 +117,18 @@ module Templatecop
       @formatter.file_finished(file_path, offenses)
     end
 
-    def on_finished
+    # We need to adjust @formatter's status (in silently)
+    # because @formatter.on_file_* was called in child process, not in this process.
+    # @param [Array] result
+    def on_finished(result)
+      original = @formatter.output
+      @formatter.instance_variable_set(:@output, ::StringIO.new)
+      result.each do |(file_path, offenses)|
+        on_file_started(file_path)
+        on_file_finished(file_path, offenses)
+      end
+      @formatter.instance_variable_set(:@output, original)
+
       @formatter.finished(@file_paths)
     end
   end

data/lib/templatecop/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Templatecop
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/templatecop.gemspec

@@ -29,6 +29,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.metadata['rubygems_mfa_required'] = 'true'
 
+  spec.add_dependency 'parallel'
   spec.add_dependency 'parser'
   spec.add_dependency 'rubocop', '>= 0.87'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: templatecop
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-15 00:00:00.000000000 Z
+date: 2022-01-21 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: parallel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: parser
   requirement: !ruby/object:Gem::Requirement