avo-linter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e192558b6e6c040bed45f0a10bbd3c822980e412a4a2ea8a4ff524ff1314d480
+  data.tar.gz: cde77967db5c23805bfdf329357b55f3466998858a362f909560c26b3122cb78
+SHA512:
+  metadata.gz: 3291101920e425058c5459a66c689bb5e817dddf2adf326c4e96ea5475af7ea0af2999ff60a3003012290297e75cc97dfc882443262775a777247bd10274b0bd
+  data.tar.gz: b7e07e18355ce3c711e7338c1c4d5954a6c356c8dbe9f07821742df740b1373113d580a0c64429de45c7336d24501f02e4438518d91fead564fdb91d961368bd

data/Gemfile

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+ruby "~> 3.3.0"
+
+gem "awesome_print"
+gem "dry-initializer"
+gem "activesupport", "> 7.0.4", "< 7.1.0"
+gem "dry-cli"
+gem "paint"
+gem "tty-command"
+gem "zeitwerk"
+gem "prism"
+gem "parser"
+gem "parser-prism"
+gem "ruby-lsp"
+gem "rspec"
+gem "rspec-expectations"

data/Gemfile.lock

@@ -0,0 +1,78 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.8)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    awesome_print (1.9.2)
+    concurrent-ruby (1.2.2)
+    diff-lcs (1.5.0)
+    dry-cli (1.0.0)
+    dry-initializer (3.1.1)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    language_server-protocol (3.17.0.3)
+    minitest (5.20.0)
+    paint (2.3.0)
+    parser (3.3.0.2)
+      ast (~> 2.4.1)
+      racc
+    parser-prism (0.1.0)
+      parser
+      prism
+    pastel (0.8.0)
+      tty-color (~> 0.5)
+    prism (0.19.0)
+    racc (1.7.3)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    ruby-lsp (0.13.2)
+      language_server-protocol (~> 3.17.0)
+      prism (>= 0.19.0, < 0.20)
+      sorbet-runtime (>= 0.5.5685)
+    sorbet-runtime (0.5.11180)
+    tty-color (0.6.0)
+    tty-command (0.10.1)
+      pastel (~> 0.8)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.6.12)
+
+PLATFORMS
+  arm64-darwin-23
+  ruby
+
+DEPENDENCIES
+  activesupport (> 7.0.4, < 7.1.0)
+  awesome_print
+  dry-cli
+  dry-initializer
+  paint
+  parser
+  parser-prism
+  prism
+  rspec
+  rspec-expectations
+  ruby-lsp
+  tty-command
+  zeitwerk
+
+RUBY VERSION
+   ruby 3.3.0p0
+
+BUNDLED WITH
+   2.5.3

data/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright 2023 Adrian Marin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/avo-linter.gemspec

@@ -0,0 +1,26 @@
+require_relative "lib/avo_linter/version"
+
+Gem::Specification.new do |spec|
+  spec.name        = "avo-linter"
+  spec.version     = AvoLinter::VERSION
+  spec.summary     = "Linter for Avo CMS for Ruby on Rails"
+  spec.description = "The linter scans your Avo app and exposes errors"
+  spec.authors     = ["Adrian Marin"]
+  spec.email       = "adrian@adrianthedev.com"
+  spec.files = Dir["{bin,lib}/**/*", "LICENSE.MD", "readme.md", "avo-linter.gemspec", "Gemfile", "Gemfile.lock", "linter.png"]
+  spec.homepage    = "https://avohq.io"
+  spec.license     = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["bug_tracker_uri"] = "https://github.com/avo-hq/avo-linter/issues"
+    spec.metadata["changelog_uri"] = "https://github.com/avo-hq/avo-linter/releases"
+    spec.metadata["documentation_uri"] = "https://github.com/avo-hq/avo-linter"
+    spec.metadata["homepage_uri"] = "https://avohq.io"
+    spec.metadata["source_code_uri"] = "https://github.com/avo-hq/avo-linter"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+end

data/bin/avo

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$:.unshift(File.expand_path("../", __dir__))
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+
+require_relative "../lib/avo_linter"
+require_relative "../lib/avo_linter/cli"

data/bin/rspec

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+load Gem.bin_path('rspec-core', 'rspec')

data/lib/avo_linter/cli.rb

@@ -0,0 +1,60 @@
+module AvoLinter
+  VERSION = "0.0.1"
+
+  module CLI
+    module Commands
+      extend Dry::CLI::Registry
+
+      class BaseCommand < Dry::CLI::Command
+        def run(command)
+          result = cmd.run(command)
+          halt if result.failed?
+          result
+        rescue TTY::Command::ExitError
+          halt
+        end
+
+        def halt(message: nil)
+          message ||= "#{self.class} failed."
+          yell message
+          exit
+        end
+      end
+
+      class Version < BaseCommand
+        desc "Print version"
+
+        def call(*)
+          puts VERSION
+        end
+      end
+
+      class Lint < BaseCommand
+        desc "Lint gem"
+
+        option :path, aliases: ["-p"], required: false, desc: "Path of your Rails app"
+
+        def call(**)
+          scan = ::AvoLinter::Scanner.scan
+
+          # ap scan
+
+          say "Scan finished!\n"
+
+          if scan.errors?
+            yell "We found a couple of errors."
+            ap scan.error_messages
+          else
+            say "Nothing bad found. Good job!"
+          end
+        end
+      end
+
+      register "version", Version, aliases: ["v", "-v", "--version"]
+
+      register "lint", Lint
+    end
+  end
+end
+
+Dry::CLI.new(AvoLinter::CLI::Commands).call

data/lib/avo_linter/rules/base.rb

@@ -0,0 +1,31 @@
+class AvoLinter::Rules::Base
+  attr_reader :contents
+  attr_reader :errors
+
+  def initialize(contents:, **)
+    @contents = contents
+    @errors = []
+  end
+
+  def apply_rule
+    apply
+
+    self
+  end
+
+  def message = self.class::MESSAGE
+
+  private
+
+  def get_class_body
+    parsed_contents.value.statements.body.first.body.body
+  end
+
+  def parsed_contents
+    Prism.parse contents
+  end
+
+  def error_out(message)
+    @errors << message
+  end
+end

data/lib/avo_linter/rules/fields_as_class_methods.rb

@@ -0,0 +1,14 @@
+class AvoLinter::Rules::FieldsAsClassMethods < AvoLinter::Rules::Base
+  MESSAGE = "You should not use the `field` method as a class method. Please add it in the `def fields` method or use composition in other methods."
+
+  def apply
+    get_class_body.each do |node|
+      if node.instance_of?(Prism::CallNode) && node.name == :field
+        error_out(
+          message:,
+          node:,
+        )
+      end
+    end
+  end
+end

data/lib/avo_linter/scanner.rb

@@ -0,0 +1,42 @@
+class AvoLinter::Scanner
+  AVO_PATHS = {
+    actions: ["app", "avo", "actions", "*.rb"],
+    config: ["config", "*.rb"],
+    cards: ["app", "avo", "cards", "*.rb"],
+    dashboards: ["app", "avo", "dashboards", "*.rb"],
+    fields: ["app", "avo", "fields", "*.rb"],
+    filters: ["app", "avo", "filters", "*.rb"],
+    models: ["app", "models", "*.rb"],
+    resource_controllers: ["app", "controllers", "avo", "*.rb"],
+    resource_tools: ["app", "avo", "resource_tools", "*.rb"],
+    resources: ["app", "avo", "resources", "*.rb"],
+    scopes: ["app", "avo", "scopes", "*.rb"],
+    views: ["app", "views", "avo", "*.rb"]
+  }
+
+  def self.scan(path: Dir.pwd)
+    scan = new
+    AvoLinter::Scanners::ResourceScanner.new(path:, scan:).scan!
+    scan
+  end
+
+  attr_reader :results
+
+  def initialize
+    @results = []
+  end
+
+  def error_messages
+    errors.flatten.map do |error|
+      error[:message]
+    end
+  end
+
+  def errors
+    results.map(&:errors).flatten
+  end
+
+  def errors?
+    errors.present?
+  end
+end

data/lib/avo_linter/scanners/base.rb

@@ -0,0 +1,102 @@
+require "ruby-lsp"
+require "prism"
+require "parser/prism"
+
+class AvoLinter::Scanners::Base
+  attr_reader :path
+  attr_reader :scan
+
+  def initialize(path:, scan:)
+    @path = path
+    @scan = scan
+  end
+
+  # def scan
+  #   puts ["scanning->"].inspect
+
+  #   # files.each do |file|
+  #   #   puts file
+  #   # end
+  #   # ap files
+
+  #   file_path = "/Users/adrian/work/avocado/avohq.io-v3/app/avo/resources/account.rb"
+  #   file_path = "/Users/adrian/work/avocado/gems/avo-linter/account.rb"
+  #   contents = File.read(file_path)
+  #   # puts ["contents->", contents].inspect
+  #   # @index = RubyIndexer::Index.new
+  #   # puts ["@index->", @index].inspect
+  #   # return
+  #   if false
+  #     parsed = Parser::Prism.parse_file file_path
+  #     puts ["parsed->", parsed].inspect
+  #   else
+  #     # parsed = Prism.parse contents
+  #     # fields_tree = parsed.value.statements.body.first.body.body.find do |item|
+  #     #   puts ["item->", item.class].inspect
+  #     #   item.instance_of?(Prism::DefNode) && item.name == :fields
+  #     #   # matches?(item, Prism::DefNode)
+  #     # end
+
+  #     # scan_resource_files
+  #     AvoLinter::Scanners::ResourceScanner.new.scan
+
+  #     # fields =
+  #     # puts ["fields_tree!!->", get_fields_in_fields_method(contents)].inspect
+  #     # puts ["apply->", AvoLinter::Rules::FieldsAsClassMethods.new.apply].inspect
+  #     # puts ["parsed->", parsed.value.statements.body.first.body.body].inspect
+  #   end
+  # end
+
+  private
+
+  def files
+    # # Read ignore patterns from the .gitignore file in the directory
+    gitignore_path = File.join(path, ".gitignore")
+    ignore_patterns = get_ignore_patterns_from_gitignore(gitignore_path)
+    puts ["ignore_patterns->", ignore_patterns].inspect
+
+    get_all_files_in_directory_and_subdirectories(path, ignore_patterns)
+  end
+
+  def paths_to_scan
+    [
+      ["app", "avo", "**", "*.rb"],
+      ["app", "controllers", "avo", "**", "*.rb"],
+      ["app", "models", "**", "*.rb"],
+      ["app", "views", "avo", "**", "*.erb"],
+      ["config", "**", "*.rb"]
+    ]
+  end
+
+  def get_ignore_patterns_from_gitignore(gitignore_path)
+    ignore_patterns = []
+
+    if File.exist?(gitignore_path)
+      File.readlines(gitignore_path).each do |line|
+        # Remove leading and trailing whitespace
+        pattern = line.strip
+        next if pattern.empty? || pattern.start_with?("#") # Skip comments and empty lines
+        ignore_patterns << pattern
+      end
+    end
+
+    ignore_patterns
+  end
+
+  def get_all_files_in_directory_and_subdirectories(directory, ignore_patterns)
+    all_files = []
+
+    # ap paths_to_scan
+    # return []
+    paths_to_scan.each do |path_to_scan|
+      Dir.glob(File.join(*path_to_scan)).each do |file|
+        next if File.directory?(file)
+        # next if ignore_patterns.any? { |pattern| File.fnmatch?(pattern, file) }
+
+        all_files << File.expand_path(file)
+      end
+    end
+
+    all_files.flatten
+  end
+end

data/lib/avo_linter/scanners/resource_scanner.rb

@@ -0,0 +1,39 @@
+class AvoLinter::Scanners::ResourceScanner < AvoLinter::Scanners::Base
+  # def initialize
+
+  # end
+
+  def scan!
+    # puts ["resource_files->", resource_files].inspect
+
+    # errors = []
+    resource_files.map do |path, contents|
+      results = AvoLinter::Rules::FieldsAsClassMethods.new(contents:).apply_rule
+      scan.results << results
+      # scan.errors << results.errors
+    end
+  end
+
+  private
+
+  # def scan_resource_files
+  #   resource_files
+  # end
+
+  def resource_files
+    resource_file_paths.map do |file_path|
+      [file_path, File.read(file_path)]
+    end.to_h
+  end
+
+  def resource_file_paths
+    all_files = []
+
+    Dir.glob(File.join(path, *AvoLinter::Scanner::AVO_PATHS[:resources])).each do |file|
+      next if File.directory?(file)
+      all_files << file
+    end
+
+    all_files
+  end
+end

data/lib/avo_linter/version.rb

@@ -0,0 +1,3 @@
+module AvoLinter
+  VERSION = "0.0.1"
+end

data/lib/avo_linter.rb

@@ -0,0 +1,22 @@
+require "bundler/setup"
+require "dry/cli"
+require "active_support/core_ext/class/attribute"
+require "yaml"
+require "tty-command"
+require "fileutils"
+require "active_support/core_ext/string"
+require "pathname"
+require "rubygems"
+require "zeitwerk"
+require "awesome_print"
+require_relative "support"
+
+loader = Zeitwerk::Loader.for_gem
+loader.ignore("#{__dir__}/support.rb")
+loader.inflector.inflect(
+  "cli" => "CLI"
+)
+loader.setup
+
+module AvoLinter
+end

data/lib/support.rb

@@ -0,0 +1,52 @@
+def say(text)
+  puts "=> #{yellow(text)}"
+end
+
+def yell(text)
+  puts "=> #{red(text)}"
+end
+
+def colorize(text, color_code)
+  "#{color_code}#{text}\e[0m"
+end
+
+def yellow(text)
+  colorize(text, "\e[33m")
+end
+
+def red(text)
+  colorize(text, "\e[31m")
+end
+
+def green(text)
+  colorize(text, "\e[32m")
+end
+
+def gemspec_path
+  Dir["#{Dir.pwd}/*.gemspec"].first
+end
+
+def gemspec
+  Gem::Specification.load(gemspec_path)
+end
+
+def version
+  @version ||= gemspec.version.to_s
+end
+
+def gemspec_name
+  gemspec.name
+end
+
+def cmd
+  TTY::Command.new uuid: false
+end
+
+def change_in_file(file, regex, text_to_put_in_place)
+  text = File.read file
+  File.open(file, "w+") { |f| f << text.gsub(/#{regex}/, text_to_put_in_place) }
+end
+
+def bundler_token
+  @token ||= `bundle config get https://packager.dev/avo-hq`.match(/^.*: "(.*)"$/).captures.first
+end

data/readme.md

@@ -0,0 +1,40 @@
+# Avo Linter
+
+> [!WARNING]
+> This is highly experimental.
+
+This CLI is used by Avo, the Avo LSP (coming soon), and other products to lint the Avo configuration files.
+
+It will show you errors that you might have missed in the Avo files along with improvements that you could make.
+
+![](./linter.png)
+
+## Running it
+
+> [!WARNING]
+> Temporary.
+
+Git clone it
+
+## Overview
+
+The linter uses different techniques to figure out if Avo configuration files are invalid or could be improved
+
+#### Using Prism
+
+The linter is using [prism](https://github.com/ruby/prism) to parse the files and create an AST for each one.
+We the linter is run it will scan the files and return errors it found in the files.
+
+It's doing that by scanning the AST for common patterns using user-defined rules similar to how rubocop is working.
+
+### Installation
+
+Run `bundle install` to install the dependencies.
+
+```bash
+bundle
+```
+
+### Testing
+
+Rspec is used for tests. Run `bin/rspec` to run all tests.

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: avo-linter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Adrian Marin
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-01-11 00:00:00.000000000 Z
+dependencies: []
+description: The linter scans your Avo app and exposes errors
+email: adrian@adrianthedev.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- avo-linter.gemspec
+- bin/avo
+- bin/rspec
+- lib/avo_linter.rb
+- lib/avo_linter/cli.rb
+- lib/avo_linter/rules/base.rb
+- lib/avo_linter/rules/fields_as_class_methods.rb
+- lib/avo_linter/scanner.rb
+- lib/avo_linter/scanners/base.rb
+- lib/avo_linter/scanners/resource_scanner.rb
+- lib/avo_linter/version.rb
+- lib/support.rb
+- linter.png
+- readme.md
+homepage: https://avohq.io
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/avo-hq/avo-linter/issues
+  changelog_uri: https://github.com/avo-hq/avo-linter/releases
+  documentation_uri: https://github.com/avo-hq/avo-linter
+  homepage_uri: https://avohq.io
+  source_code_uri: https://github.com/avo-hq/avo-linter
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Linter for Avo CMS for Ruby on Rails
+test_files: []