autoload-checker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6e5e30b050ff00a10be2fbb62a51bb5b57f7a7cfe7f612fd7afdf2a99e2c4028
+  data.tar.gz: 1f16534a3b8a2965c4e08b1d1e35bab5fa43d0b421cd697d013fa761888183c3
+SHA512:
+  metadata.gz: fc1269943f368984f3c3bebe7ab836a61bd57b4e985409b76f6443c0644097da00df194a96592951675a0decf1e438fb7a73034c25b9b3d7e2f668a0dd3d98d8
+  data.tar.gz: a611efd324d67b824680ceb70aead2410574ca03e51256e19e9dc668d0b185cbf26603682333c473c66b8683639207c16f2752920c867a97629089fd63f09a3e

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem "rspec", "~> 3.11", :group => :test

data/Gemfile.lock

@@ -0,0 +1,26 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.5.0)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+
+PLATFORMS
+  x86_64-darwin-21
+
+DEPENDENCIES
+  rspec (~> 3.11)
+
+BUNDLED WITH
+   2.3.11

data/LICENSE

@@ -0,0 +1,13 @@
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+                    Version 2, December 2004
+
+ Copyright (C) 2022 cyberfined
+
+ Everyone is permitted to copy and distribute verbatim or modified
+ copies of this license document, and changing it is allowed as long
+ as the name is changed.
+
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. You just DO WHAT THE FUCK YOU WANT TO.

data/README.md

@@ -0,0 +1,35 @@
+# autoload_checker
+
+Checks for conflicts in class/module definitions and corrects them. For instance, you have
+a file `foo/bar/baz.rb` with following content:
+
+```ruby
+module Foo
+  module Bar
+    class Baz
+    end
+  end
+end
+```
+
+And a file `foo/bar.rb` with following content:
+
+```ruby
+module Foo
+  class Bar
+  end
+end
+```
+
+So, when you start your app, "Bar is not a class" exception will be thrown. autoload_checker
+detects conflict definitions and fix them by replacing `module Bar` with `class Bar`
+in `foo/bar/baz.rb`.
+
+# Usage
+
+```
+Usage: ./autoload_checker.rb [options]
+    -p, --path FILE                  [Mandatory] file or directory to check
+    -c, --correct                    Enable errors correction
+    -h, --help                       Prints this help
+```

data/bin/autoload_checker.rb

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+
+require 'pathname'
+$:.unshift Pathname.new(File.expand_path(__dir__)).parent.join('lib')
+
+require 'optparse'
+require 'namespace'
+require 'autoload_checker'
+
+Options = Struct.new(:dir, :correct)
+
+options = Options.new(nil, false)
+opt_parser = OptionParser.new do |opts|
+  opts.banner = "Usage: #{$0} [options]"
+  opts.on('-p FILE', '--path', String, '[Mandatory] file or directory to check') do |v|
+    options.dir = v
+  end
+  opts.on('-c', '--correct', TrueClass, 'Enable errors correction') { |v| options.correct = v }
+  opts.on('-h', '--help', 'Prints this help') do
+    puts opts
+    exit
+  end
+end
+opt_parser.parse!
+
+unless options.dir
+  puts opt_parser.help
+  exit(1)
+end
+
+autoload_checker = AutoloadChecker.new(path: options.dir, correct: options.correct)
+autoload_checker.call
+exit(1) if autoload_checker.fixes.any? && !options.correct

data/lib/autoload_checker.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+class AutoloadChecker
+  def initialize(path:, correct:, output: $stderr)
+    @path = path
+    @correct = correct
+    @output = output
+  end
+
+  def call
+    validator.call
+    return if fixes.empty?
+
+    if correct?
+      fixes.each { |file, fixes| Namespace::Corrector.new(file: file, fixes: fixes).call }
+    else
+      validator.fixes.each do |_file, fixes|
+        fixes.each { |fix| @output.puts(fix.pretty_error) }
+      end
+    end
+  end
+
+  def fixes
+    validator.fixes
+  end
+
+  private
+
+  def validator
+    @validator ||= Namespace::Validator.new(@path)
+  end
+
+  def correct?
+    @correct
+  end
+end

data/lib/namespace/corrector.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal
+
+class Namespace
+  class Corrector
+    def initialize(file:, fixes:)
+      @file = file
+      @fixes = fixes
+    end
+
+    def call
+      content = File.read(@file)
+      @fixes.each do |fix|
+        content.gsub!(/#{fix.from} #{fix.const_name}/, "#{fix.to} #{fix.const_name}")
+      end
+      File.write(@file, content)
+    end
+  end
+end

data/lib/namespace/fix.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+class Namespace
+  class Fix
+    attr_reader :file, :const_name, :from, :to
+
+    def initialize(file:, const_name:, from:, to:)
+      @file = file
+      @const_name = const_name
+      @from = from
+      @to = to
+    end
+
+    def pretty_error
+      "#{@file}: #{const_name} must be a #{@to} not a #{@from}"
+    end
+  end
+end

data/lib/namespace/parser.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'ripper'
+require 'namespace'
+
+class Namespace
+  class NonRootAstError < StandardError; end
+  class ConstRefExpectedError < StandardError; end
+
+  class Parser
+    def initialize(file)
+      @file = file
+    end
+
+    def call
+      @ast = File.open(@file) { |fd| Ripper.sexp(fd, @file) }
+      raise NonRootAstError, @file unless @ast[0] == :program
+
+      module_or_class_defs(@ast[1])
+    end
+
+    private
+
+    def module_or_class_defs(ast)
+      ast.each_with_object({}) do |stmt, namespaces|
+        next if !stmt.is_a?(Array) || !%i[module class].include?(stmt[0])
+
+        type = stmt[0]
+        const_ref = stmt[1]
+        raise ConstRefExpectedError unless %i[const_ref const_path_ref].include?(const_ref[0])
+
+        next if const_ref[0] == :const_path_ref
+
+        name = const_ref[1][1]
+        pos = const_ref[1][2]
+        line = pos[0]
+        column = pos[1]
+
+        children = module_or_class_defs(module_or_class_body(stmt))
+        namespaces[name] = Namespace.new(
+          type: type, name: name, children: children, file: @file, line: line, column: column
+        )
+      end
+    end
+
+    def module_or_class_body(ast)
+      index = ast.find_index { |stmt| stmt.is_a?(Array) && stmt[0] == :bodystmt }
+      ast[index][1]
+    end
+  end
+end

data/lib/namespace/validator.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require 'pathname'
+require 'namespace/fix'
+require 'namespace/parser'
+
+class Namespace
+  class Validator
+    attr_reader :fixes, :namespaces
+
+    def initialize(root_dir)
+      @root_dir = root_dir
+      @namespaces = {}
+      @fixes = Hash.new { |hsh, k| hsh[k] = [] }
+    end
+
+    def call
+      directories = [@root_dir]
+      new_directories = []
+
+      while directories.any?
+        dir = directories.pop
+        Pathname.glob(File.join(dir, '*')) do |file|
+          if file.directory?
+            new_directories << file
+          elsif file.extname == '.rb'
+            namespace = Namespace::Parser.new(file.to_s).call
+            add_namespace(namespace)
+          end
+        end
+
+        if directories.empty?
+          directories = new_directories
+          new_directories = []
+        end
+      end
+    end
+
+    private
+
+    def add_namespace(namespace)
+      merge_children(@namespaces, namespace)
+    end
+
+    def merge_children(children1, children2)
+      children2.each do |k, space2|
+        space1 = children1[k]
+        if !space1
+          if space2.class? && !space2.has_standalone_file? && space2.children.any?
+            @fixes[space2.file] << Fix.new(
+              file: space2.file, const_name: k, from: :class, to: :module
+            )
+            space2.type = :module
+          end
+
+          children1[k] = space2
+          next
+        end
+
+        if space1.type != space2.type
+          @fixes[space2.file] << Fix.new(
+            file: space2.file, const_name: k, from: space2.type, to: space1.type
+          )
+        end
+
+        merge_children(space1.children, space2.children)
+      end
+    end
+  end
+end

data/lib/namespace.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'pathname'
+require 'namespace/corrector'
+require 'namespace/fix'
+require 'namespace/parser'
+require 'namespace/validator'
+
+class Namespace
+  attr_reader :name, :children, :file, :line, :column
+  attr_accessor :type
+
+  def initialize(type:, name:, children:, file:, line:, column:)
+    @type = type
+    @name = name
+    @children = children
+    @file = file
+    @line = line
+    @column = column
+  end
+
+  def has_standalone_file?
+    Pathname.new(@file).basename.to_s == to_snake_case(@name) + ".rb"
+  end
+
+  def class?
+    @type == :class
+  end
+
+  def module?
+    @type == :module
+  end
+
+  private
+  
+  def to_snake_case(str)
+    str.gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+       .gsub(/([a-z\d])([A-Z])/,'\1_\2')
+       .tr('-', '_')
+       .downcase
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: autoload-checker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- cyberfined
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Checks for conflicts in class/module definitions and corrects them.
+email:
+- cyberfined@protonmail.com
+executables:
+- autoload_checker.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- bin/autoload_checker.rb
+- lib/autoload_checker.rb
+- lib/namespace.rb
+- lib/namespace/corrector.rb
+- lib/namespace/fix.rb
+- lib/namespace/parser.rb
+- lib/namespace/validator.rb
+homepage: https://github.com/cyberfined/autoload-checker
+licenses:
+- WTFPL
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.11
+signing_key:
+specification_version: 4
+summary: Checks for conflicts in class/module definitions and corrects them.
+test_files: []