gl_lint 0.2.1 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29ba9f97248e034bfecc67d5fdc9fd0499abf4f1643ca3bed324429d3822dea5
-  data.tar.gz: 37ca5350b17ab1efe805792b593c17a214eb3431b9c2e21ce9ab597434eb35b8
+  metadata.gz: 8c1993de87cae11e8c78789a86dd76ee188cd31981d236a28c133b52504abbe9
+  data.tar.gz: b9ad1954c44aca7f018a2421e5bcae5d1f52985fca5d317a010f3703ad00d8fa
 SHA512:
-  metadata.gz: dc50f8bedbd5c87cf364b2af96fbf977bdb0ce454cb74fec6f29818f60d0b4baf8aa4d5168dda72656c20d83c743d8292b35224bf7ed802edf31e6379a16e4c8
-  data.tar.gz: e18e12bb3ed9eb52787966ddba7099a580bc57116cef209e360a742df3a55b706758681fd24c9b7f95a0d84a5ef803321e704a29834df7571653b951178aa243
+  metadata.gz: 38a4162f951fbd544db9bf19e8d695d59c1be219a46d293beca1a39fc229e62f758ee69cf621f2d6a500c6589fe80fa605505c76c8ec63f4a886f2e706e2c12d
+  data.tar.gz: ee5565380924ff2faeddfd96e4d4ea823ec1988321597aeb426fbe21eb87bf5b67e9a83e3c048c3f8444d19fde3f5f72666f32340dd5d859ca18064121f456ff

data/README.md

@@ -31,7 +31,7 @@ Then add this to the file:
 require 'rubygems'
 require 'gl_lint'
 
-GlLint.run_cli(app_root: File.expand_path('..', __dir__))
+GlLint.call_cli(app_root: File.expand_path('..', __dir__))
 ```
 
 Then run `bin/lint` to lint your changes
@@ -39,16 +39,6 @@ Then run `bin/lint` to lint your changes
 Alternatively, if your project doesn't have JavaScript, add `linters: ['rubocop]`
 
 ```ruby
-GlLint.run_cli(app_root: File.expand_path('..', __dir__),
+GlLint.call_cli(app_root: File.expand_path('..', __dir__),
                linters: ['rubocop'])
 ```
-
-## Publishing gem to rubygems!
-
-[Build the gem](http://guides.rubygems.org/make-your-own-gem/)
-
-    gem build gl_lint.gemspec
-
-[Push to rubygems](http://guides.rubygems.org/publishing/)
-
-    gem push gl_lint-0.2.0.gem

data/gl_lint.gemspec

@@ -5,6 +5,8 @@ lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'gl_lint/version'
 
+NON_GEM_FILES = ['Gemfile', 'Gemfile.lock', 'Guardfile', 'bin/lint'].freeze
+
 Gem::Specification.new do |spec|
   spec.name = 'gl_lint'
   spec.version = GlLint::VERSION
@@ -18,7 +20,8 @@ Gem::Specification.new do |spec|
 
   spec.extra_rdoc_files = ['README.md']
 
-  spec.files = `git ls-files`.split($INPUT_RECORD_SEPARATOR).grep_v(/^(spec|\.)/)
+  spec.files = `git ls-files`
+               .split($INPUT_RECORD_SEPARATOR).grep_v(/^(spec|\.)/) - NON_GEM_FILES
   spec.require_paths = ['lib']
 
   spec.add_dependency 'optparse'

data/lib/gl_lint/cli.rb

@@ -15,9 +15,8 @@ module GlLint
     class << self
       # Disabling metrics, it doesn't make sense to deconstruct the CLI parser
       # rubocop:disable Metrics
-      def parse(app_root:, linters: nil, default_target: nil)
-        options = lint_options(linters:, default_target:)
-                  .merge(app_root:)
+      def parse(app_root:, linters: nil, default_target: nil, options: {})
+        options = default_options(linters:, app_root:, default_target:).merge(options)
 
         OptionParser.new do |parser|
           TARGET_FILE_OPTS.each do |args|
@@ -80,7 +79,6 @@ module GlLint
 
           raise "Passed both 'filenames' and 'target files': #{options[:target_files]}" if options[:target_files]
         end
-
         options[:target_files] ||= options[:default_target]
         options
       end
@@ -88,11 +86,17 @@ module GlLint
 
       private
 
-      def lint_options(linters:, default_target: nil)
+      def default_options(linters:, app_root:, default_target:)
         {
-          linters: linters || LINTERS,
+          app_root:,
+          default_target: default_target || DEFAULT_TARGET,
+          filenames: nil,
+          linters: Array(linters || LINTERS),
+          list_only: false,
+          no_fix: false,
           unsafe_fix: ENV['UNSAFE_LINT'] == 'true',
-          default_target: default_target || DEFAULT_TARGET
+          verbose: false,
+          write_rubocop_rules: false
         }
       end
     end

data/lib/gl_lint/export_rubocop.rb

@@ -9,7 +9,8 @@ module GlLint
       def write_rules(app_root)
         puts 'Updating .rubocop_rules.yml'
 
-        enabled_rules = rubocop_rules.map { |arr| stored_rule(app_root, arr) }.compact
+        enabled_rules = [['RuboCop-version', rubocop_version]] +
+                        rubocop_rules.map { |arr| stored_rule(app_root, arr) }.compact
 
         File.write('.rubocop_rules.yml', YAML.dump(enabled_rules.to_h))
       end
@@ -32,6 +33,10 @@ module GlLint
         YAML.safe_load(`rubocop -c .rubocop.yml --show-cops`,
                        permitted_classes: [Regexp, Symbol]).to_a
       end
+
+      def rubocop_version
+        `rubocop -V`.strip.split("\n").first.split('[').first.strip
+      end
     end
   end
 end

data/lib/gl_lint/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GlLint
-  VERSION = '0.2.1'
+  VERSION = '0.3.1'
 end

data/lib/gl_lint.rb

@@ -5,28 +5,33 @@ require 'gl_lint/export_rubocop'
 
 module GlLint
   class << self
-    def lint_strategy_from_options(no_fix: false, list_only: false, unsafe_fix: false)
-      return :list_only if list_only
-      return :no_fix if no_fix
+    def call_cli(app_root:, default_target: nil, linters: nil)
+      options = GlLint::CLI.parse(app_root:, linters:, default_target:)
+      puts 'Options: ', options, '' if options[:verbose]
 
-      unsafe_fix ? :unsafe_fix : :fix
+      call(**options.except(:verbose, :default_target))
     end
 
-    def run_cli(app_root:, linters: nil)
-      options = GlLint::CLI.parse(app_root:, linters:)
-      puts 'Options: ', options, '' if options[:verbose]
+    def call(app_root:, write_rubocop_rules: false, no_fix: false, list_only: false, unsafe_fix: false, linters: nil,
+             target_files: nil, filenames: nil)
 
-      Dir.chdir(options[:app_root]) do
-        if options[:write_rubocop_rules]
+      Dir.chdir(app_root) do
+        if write_rubocop_rules
           GlLint::ExportRubocop.write_rules(app_root)
         else
-          lint_strategy = lint_strategy_from_options(**options.slice(:no_fix, :list_only,
-                                                                     :unsafe_fix))
-          linter_args = options.slice(:linters, :target_files, :filenames)
-                               .merge(lint_strategy:)
-          GlLint::Linter.new.lint(**linter_args)
+          lint_strategy = lint_strategy_from_options(no_fix:, list_only:, unsafe_fix:)
+          GlLint::Linter.new.lint(linters:, target_files:, filenames:, lint_strategy:)
         end
       end
     end
+
+    private
+
+    def lint_strategy_from_options(no_fix: false, list_only: false, unsafe_fix: false)
+      return :list_only if list_only
+      return :no_fix if no_fix
+
+      unsafe_fix ? :unsafe_fix : :fix
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gl_lint
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.1
 platform: ruby
 authors:
 - Give Lively
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-08 00:00:00.000000000 Z
+date: 2024-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: optparse
@@ -87,11 +87,8 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
-- Gemfile
-- Guardfile
 - LICENSE
 - README.md
-- bin/lint
 - gl_lint.gemspec
 - lib/gl_lint.rb
 - lib/gl_lint/cli.rb

data/Gemfile

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-group :development, :test do
-  gem 'guard'
-  gem 'guard-rspec'
-  gem 'rspec'
-end
-
-gemspec

data/Guardfile

@@ -1,25 +0,0 @@
-directories %w[lib spec]
-
-rspec_options = {
-  cmd: 'bundle exec rspec',
-  all_after_pass: false,
-  all_on_start: false,
-  failed_mode: :focus
-}
-
-guard :rspec, rspec_options do
-  require 'guard/rspec/dsl'
-  dsl = Guard::RSpec::Dsl.new(self)
-
-  # Feel free to open issues for suggestions and improvements
-
-  # RSpec files
-  rspec = dsl.rspec
-  watch(rspec.spec_helper) { rspec.spec_dir }
-  watch(rspec.spec_support) { rspec.spec_dir }
-  watch(rspec.spec_files)
-
-  # Ruby files
-  ruby = dsl.ruby
-  dsl.watch_spec_files_for(ruby.lib_files)
-end

data/bin/lint

@@ -1,6 +0,0 @@
-#!/usr/bin/env ruby
-require 'bundler/setup' # don't use rubygems, keep references internal
-require 'gl_lint'
-
-GlLint.run_cli(app_root: File.expand_path('..', __dir__),
-               linters: ['rubocop'])