slimcop 0.8.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8ddb3a3a507467e8a94efb06e67729026956faf788fae905c2520ddd2016d4d
-  data.tar.gz: 793d36ff3bfffbb5f4979996395f219fe301e5ab6cbd283a75cba389d2ef0b99
+  metadata.gz: 4b967da47ab7a5721d082f4d1a4e9bb84006431c5acb5992a27f8246bdcfd904
+  data.tar.gz: 6e260866461bc31ddef835279d647905f17f87890b63af229bd98557699e0d8f
 SHA512:
-  metadata.gz: 80f8d52c2fc2a845ce0f06f58bdf943123e8253dd3834b504ee3dd3da8f30ddb55902ec9e30db041d6eae084617addcefd42b338a720f3300b5c05cf8af34f32
-  data.tar.gz: 1eef3d4bc19ad6824e6e70b98da9bb35b88cbf48e748a6bb8e00aa9bed21cedde553518ac7460098ef80ee5ac19ca6183973c89443896a22a4da4fc618ac30fb
+  metadata.gz: 62cbf9db3a9f0fc741714afdd4f886b61efb4bed1e3f4ca54e6e7caa03b3cf2e8f3141aec2456b3b13f7fe0999e5a7ab9a7578a6700225a220db08200f9b2f96
+  data.tar.gz: c6742245998d9fbd23dca47dbf55be3e8717722daa7515df5afab77baca05d1c2ddc26d80a62bbbc97a7cfa06332a5c6fb3bc078a7d3853479598f7cb86c36ea

data/CHANGELOG.md

@@ -2,7 +2,36 @@
 
 ## Unreleased
 
-## 0.8.0
+## 0.11.0 - 2022-01-10
+
+### Changed
+
+- Use :offset instead of :begin_ at RubyExtractor.
+- Detect offenses from code that containing `if`, `unless`, `do`, etc.
+
+## 0.10.0 - 2022-01-06
+
+### Added
+
+- Use .slimcop.yml as its 1st default config file.
+
+## 0.9.1 - 2022-01-04
+
+### Fixed
+
+- Fix $LOAD_PATH at ./exe/slimcop.
+
+## 0.9.0 - 2022-01-02
+
+### Changed
+
+- Require slimi >= 0.5.1 to extract Ruby code from Ruby attribute.
+
+### Fixed
+
+- Fix -v and --version option.
+
+## 0.8.0 - 2021-12-29
 
 ### Changed
 

data/Gemfile.lock

@@ -1,10 +1,10 @@
 PATH
   remote: .
   specs:
-    slimcop (0.8.0)
+    slimcop (0.11.0)
       rainbow
       rubocop (>= 0.87)
-      slimi (>= 0.4)
+      slimi (>= 0.5.1)
 
 GEM
   remote: https://rubygems.org/
@@ -45,9 +45,13 @@ GEM
     rubocop-rspec (2.6.0)
       rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
-    slimi (0.4.2)
+    slimi (0.7.0)
       temple
+      thor
+      tilt
     temple (0.8.2)
+    thor (1.2.1)
+    tilt (2.0.10)
     unicode-display_width (2.1.0)
 
 PLATFORMS

data/README.md

@@ -40,7 +40,7 @@ Usage: slimcop [options] [file1, file2, ...]
 ### Example
 
 ```console
-$ slimcop
+$ slimcop 'spec/fixtures/**/*.slim'
 Inspecting 1 file
 C
 

data/exe/slimcop

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
 require 'slimcop'
 
 Slimcop::Cli.new(ARGV).call

data/lib/slimcop/cli.rb

@@ -72,10 +72,11 @@ module Slimcop
       options = {}
       parser = ::OptionParser.new
       parser.banner = 'Usage: slimcop [options] [file1, file2, ...]'
+      parser.version = VERSION
       parser.on('-a', '--auto-correct', 'Auto-correct offenses.') do
         options[:auto_correct] = true
       end
-      parser.on('-c', '--config=', 'Specify configuration file. (default: .rubocop.yml if it exists)') do |file_path|
+      parser.on('-c', '--config=', 'Specify configuration file. (default: .slimcop.yml or .rubocop.yml)') do |file_path|
         options[:additional_config_file_path] = file_path
       end
       parser.on('--[no-]color', 'Force color output on or off.') do |value|

data/lib/slimcop/rubo_cop_config_generator.rb

@@ -4,7 +4,8 @@ require 'rubocop'
 
 module Slimcop
   class RuboCopConfigGenerator
-    DEFAULT_ADDITIONAL_CONFIG_PATH = '.rubocop.yml'
+    DEFAULT_ADDITIONAL_CONFIG_PATH1 = '.slimcop.yml'
+    DEFAULT_ADDITIONAL_CONFIG_PATH2 = '.rubocop.yml'
 
     # @param [String] additional_config_file_path
     def initialize(additional_config_file_path: nil)
@@ -43,8 +44,10 @@ module Slimcop
         @additional_config = \
           if @additional_config_file_path
             ::RuboCop::ConfigLoader.load_file(@additional_config_file_path)
-          elsif ::File.exist?(DEFAULT_ADDITIONAL_CONFIG_PATH)
-            ::RuboCop::ConfigLoader.load_file(DEFAULT_ADDITIONAL_CONFIG_PATH)
+          elsif ::File.exist?(DEFAULT_ADDITIONAL_CONFIG_PATH1)
+            ::RuboCop::ConfigLoader.load_file(DEFAULT_ADDITIONAL_CONFIG_PATH1)
+          elsif ::File.exist?(DEFAULT_ADDITIONAL_CONFIG_PATH2)
+            ::RuboCop::ConfigLoader.load_file(DEFAULT_ADDITIONAL_CONFIG_PATH2)
           end
       end
     end

data/lib/slimcop/ruby_clipper.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module Slimcop
+  # Remove unnecessary part (e.g. `if`, `unless`, `do`, ...) from Ruby code.
+  class RubyClipper
+    # @param [String] code
+    def initialize(code)
+      @code = code
+    end
+
+    # @return [Hash]
+    def call
+      [
+        PrecedingKeywordRemover,
+        TrailingDoRemover
+      ].each_with_object(
+        code: @code,
+        offset: 0
+      ) do |klass, object|
+        result = klass.new(object[:code]).call
+        object[:code] = result[:code]
+        object[:offset] += result[:offset]
+      end
+    end
+
+    class PrecedingKeywordRemover
+      REGEXP = /
+        \A
+        (?:
+          begin
+          | case
+          | else
+          | elsif
+          | ensure
+          | if
+          | rescue
+          | unless
+          | until
+          | when
+          | while
+          | for[ \t]+\w+[ \t]+in
+        )
+        [ \t]
+      /x.freeze
+
+      # @param [String] code
+      def initialize(code)
+        @code = code
+      end
+
+      # @return [Hash]
+      def call
+        data = @code.match(REGEXP)
+        if data
+          offset = data[0].length
+          {
+            code: @code[offset..],
+            offset: offset
+          }
+        else
+          {
+            code: @code,
+            offset: 0
+          }
+        end
+      end
+    end
+
+    class TrailingDoRemover
+      REGEXP = /
+        [ \t]
+        do
+        [ \t]*
+        (\|[^|]*\|)?
+        [ \t]*
+        \Z
+      /x.freeze
+
+      # @param [String] code
+      def initialize(code)
+        @code = code
+      end
+
+      # @return [Hash]
+      def call
+        {
+          code: @code.sub(REGEXP, ''),
+          offset: 0
+        }
+      end
+    end
+  end
+end

data/lib/slimcop/ruby_extractor.rb

@@ -3,7 +3,7 @@
 require 'slimi'
 
 module Slimcop
-  # Extract codes from Slim source.
+  # Extract Ruby codes from Slim source.
   class RubyExtractor
     # @param [String, nil] file_path
     # @param [String] source
@@ -15,10 +15,10 @@ module Slimcop
     # @return [Array<Hash>]
     def call
       ranges.map do |(begin_, end_)|
+        clipped = RubyClipper.new(@source[begin_...end_]).call
         {
-          begin_: begin_,
-          code: @source[begin_...end_],
-          end_: end_
+          code: clipped[:code],
+          offset: begin_ + clipped[:offset]
         }
       end
     end

data/lib/slimcop/slim_offense_collector.rb

@@ -25,7 +25,7 @@ module Slimcop
         ).call.map do |rubocop_offense|
           Offense.new(
             file_path: @file_path,
-            offset: snippet[:begin_],
+            offset: snippet[:offset],
             rubocop_offense: rubocop_offense,
             source: @source
           )

data/lib/slimcop/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Slimcop
-  VERSION = '0.8.0'
+  VERSION = '0.11.0'
 end

data/lib/slimcop.rb

@@ -7,6 +7,7 @@ module Slimcop
   autoload :Offense, 'slimcop/offense'
   autoload :PathFinder, 'slimcop/path_finder'
   autoload :RuboCopConfigGenerator, 'slimcop/rubo_cop_config_generator'
+  autoload :RubyClipper, 'slimcop/ruby_clipper'
   autoload :RubyExtractor, 'slimcop/ruby_extractor'
   autoload :RubyOffenseCollector, 'slimcop/ruby_offense_collector'
   autoload :SlimCorrector, 'slimcop/slim_corrector'

data/slimcop.gemspec

@@ -33,5 +33,5 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'rainbow'
   spec.add_dependency 'rubocop', '>= 0.87'
-  spec.add_dependency 'slimi', '>= 0.4'
+  spec.add_dependency 'slimi', '>= 0.5.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slimcop
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-28 00:00:00.000000000 Z
+date: 2022-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: 0.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: 0.5.1
 description: 
 email:
 - r7kamura@gmail.com
@@ -78,6 +78,7 @@ files:
 - lib/slimcop/offense.rb
 - lib/slimcop/path_finder.rb
 - lib/slimcop/rubo_cop_config_generator.rb
+- lib/slimcop/ruby_clipper.rb
 - lib/slimcop/ruby_extractor.rb
 - lib/slimcop/ruby_offense_collector.rb
 - lib/slimcop/slim_corrector.rb