mirror of
https://gitea.invidious.io/iv-org/shard-ameba.git
synced 2024-08-15 00:53:29 +00:00
Compare commits
No commits in common. "master" and "v1.6.1" have entirely different histories.
13 changed files with 48 additions and 191 deletions
2
.github/workflows/cd.yml
vendored
2
.github/workflows/cd.yml
vendored
|
@ -61,7 +61,7 @@ jobs:
|
|||
# https://github.com/docker/build-push-action
|
||||
- name: Build and push Docker image
|
||||
id: build-and-push
|
||||
uses: docker/build-push-action@v6
|
||||
uses: docker/build-push-action@v5
|
||||
with:
|
||||
context: .
|
||||
push: true
|
||||
|
|
2
.github/workflows/ci.yml
vendored
2
.github/workflows/ci.yml
vendored
|
@ -19,7 +19,7 @@ jobs:
|
|||
|
||||
steps:
|
||||
- name: Set timezone to UTC
|
||||
uses: szenius/set-timezone@v2.0
|
||||
uses: szenius/set-timezone@v1.2
|
||||
|
||||
- name: Install Crystal
|
||||
uses: crystal-lang/install-crystal@v1
|
||||
|
|
76
Makefile
76
Makefile
|
@ -1,92 +1,34 @@
|
|||
.POSIX:
|
||||
all:
|
||||
|
||||
# Recipes
|
||||
|
||||
## Build ameba
|
||||
## $ make
|
||||
## Run tests
|
||||
## $ make test
|
||||
## Install ameba
|
||||
## $ sudo make install
|
||||
|
||||
-include Makefile.local # for optional local options
|
||||
|
||||
BUILD_TARGET ::= bin/ameba
|
||||
|
||||
DESTDIR ?= ## Install destination dir
|
||||
PREFIX ?= /usr/local## Install path prefix
|
||||
BINDIR ?= $(DESTDIR)$(PREFIX)/bin
|
||||
|
||||
# The crystal command to use
|
||||
CRYSTAL_BIN ?= crystal
|
||||
# The shards command to use
|
||||
SHARDS_BIN ?= shards
|
||||
# The install command to use
|
||||
INSTALL_BIN ?= /usr/bin/install
|
||||
|
||||
PREFIX ?= /usr/local
|
||||
SHARD_BIN ?= ../../bin
|
||||
CRFLAGS ?= -Dpreview_mt
|
||||
|
||||
SRC_SOURCES ::= $(shell find src -name '*.cr' 2>/dev/null)
|
||||
DOC_SOURCE ::= src/**
|
||||
|
||||
.PHONY: all
|
||||
all: build
|
||||
|
||||
.PHONY: build
|
||||
build: ## Build the application binary
|
||||
build: $(BUILD_TARGET)
|
||||
|
||||
$(BUILD_TARGET): $(SRC_SOURCES)
|
||||
build:
|
||||
$(SHARDS_BIN) build $(CRFLAGS)
|
||||
|
||||
docs: ## Generate API docs
|
||||
docs: $(SRC_SOURCES)
|
||||
$(CRYSTAL_BIN) docs -o docs $(DOC_SOURCE)
|
||||
|
||||
.PHONY: lint
|
||||
lint: ## Run ameba on ameba's code base
|
||||
lint: $(BUILD_TARGET)
|
||||
$(BUILD_TARGET)
|
||||
lint: build
|
||||
./bin/ameba
|
||||
|
||||
.PHONY: spec
|
||||
spec: ## Run the spec suite
|
||||
spec:
|
||||
$(CRYSTAL_BIN) spec
|
||||
|
||||
.PHONY: clean
|
||||
clean: ## Remove application binary
|
||||
clean:
|
||||
@rm -f "$(BUILD_TARGET)" "$(BUILD_TARGET).dwarf"
|
||||
rm -f ./bin/ameba ./bin/ameba.dwarf
|
||||
|
||||
.PHONY: install
|
||||
install: ## Install application binary into $DESTDIR
|
||||
install: $(BUILD_TARGET)
|
||||
$(INSTALL_BIN) -m 0755 "$(BUILD_TARGET)" "$(BINDIR)/ameba"
|
||||
install: build
|
||||
mkdir -p $(PREFIX)/bin
|
||||
cp ./bin/ameba $(PREFIX)/bin
|
||||
|
||||
.PHONY: bin
|
||||
bin: build
|
||||
mkdir -p $(SHARD_BIN)
|
||||
cp $(BUILD_TARGET) $(SHARD_BIN)
|
||||
cp ./bin/ameba $(SHARD_BIN)
|
||||
|
||||
.PHONY: test
|
||||
test: ## Run the spec suite and linter
|
||||
test: spec lint
|
||||
|
||||
.PHONY: help
|
||||
help: ## Show this help
|
||||
@echo
|
||||
@printf '\033[34mtargets:\033[0m\n'
|
||||
@grep -hE '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) |\
|
||||
sort |\
|
||||
awk 'BEGIN {FS = ":.*?## "}; {printf " \033[36m%-15s\033[0m %s\n", $$1, $$2}'
|
||||
@echo
|
||||
@printf '\033[34moptional variables:\033[0m\n'
|
||||
@grep -hE '^[a-zA-Z_-]+ \?=.*?## .*$$' $(MAKEFILE_LIST) |\
|
||||
sort |\
|
||||
awk 'BEGIN {FS = " \\?=.*?## "}; {printf " \033[36m%-15s\033[0m %s\n", $$1, $$2}'
|
||||
@echo
|
||||
@printf '\033[34mrecipes:\033[0m\n'
|
||||
@grep -hE '^##.*$$' $(MAKEFILE_LIST) |\
|
||||
awk 'BEGIN {FS = "## "}; /^## [a-zA-Z_-]/ {printf " \033[36m%s\033[0m\n", $$2}; /^## / {printf " %s\n", $$2}'
|
||||
|
|
|
@ -180,28 +180,6 @@ module Ameba::AST
|
|||
end
|
||||
end
|
||||
|
||||
describe "#def?" do
|
||||
context "when check_outer_scopes: true" do
|
||||
it "returns true if outer scope is Crystal::Def" do
|
||||
nodes = as_nodes("def foo; 3.times {}; end")
|
||||
outer_scope = Scope.new nodes.def_nodes.first
|
||||
scope = Scope.new nodes.block_nodes.first, outer_scope
|
||||
scope.def?(check_outer_scopes: true).should be_true
|
||||
end
|
||||
end
|
||||
|
||||
it "returns true if Crystal::Def" do
|
||||
nodes = as_nodes("def foo; end")
|
||||
scope = Scope.new nodes.def_nodes.first
|
||||
scope.def?.should be_true
|
||||
end
|
||||
|
||||
it "returns false otherwise" do
|
||||
scope = Scope.new as_node("a = 1")
|
||||
scope.def?.should be_false
|
||||
end
|
||||
end
|
||||
|
||||
describe "#in_macro?" do
|
||||
it "returns true if Crystal::Macro" do
|
||||
nodes = as_nodes <<-CRYSTAL
|
||||
|
|
|
@ -1,7 +1,11 @@
|
|||
require "../spec_helper"
|
||||
|
||||
module Ameba
|
||||
subject = GlobUtils
|
||||
struct GlobUtilsClass
|
||||
include GlobUtils
|
||||
end
|
||||
|
||||
subject = GlobUtilsClass.new
|
||||
current_file_basename = File.basename(__FILE__)
|
||||
current_file_path = "spec/ameba/#{current_file_basename}"
|
||||
|
||||
|
@ -41,12 +45,6 @@ module Ameba
|
|||
subject.expand(["**/#{current_file_basename}", "**/#{current_file_basename}"])
|
||||
.should eq [current_file_path]
|
||||
end
|
||||
|
||||
it "does not list folders" do
|
||||
subject.expand(["**/*"]).each do |path|
|
||||
fail "#{path.inspect} should be a file" unless File.file?(path)
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
|
|
@ -4,16 +4,6 @@ module Ameba::Rule::Lint
|
|||
subject = SpecFilename.new
|
||||
|
||||
describe SpecFilename do
|
||||
it "passes if relative file path does not start with `spec/`" do
|
||||
expect_no_issues subject, code: "", path: "src/spec/foo.cr"
|
||||
expect_no_issues subject, code: "", path: "src/spec/foo/bar.cr"
|
||||
end
|
||||
|
||||
it "passes if file extension is not `.cr`" do
|
||||
expect_no_issues subject, code: "", path: "spec/foo.json"
|
||||
expect_no_issues subject, code: "", path: "spec/foo/bar.json"
|
||||
end
|
||||
|
||||
it "passes if filename is correct" do
|
||||
expect_no_issues subject, code: "", path: "spec/foo_spec.cr"
|
||||
expect_no_issues subject, code: "", path: "spec/foo/bar_spec.cr"
|
||||
|
|
|
@ -388,30 +388,13 @@ module Ameba::Rule::Lint
|
|||
CRYSTAL
|
||||
end
|
||||
|
||||
it "doesn't report record declaration" do
|
||||
it "doesn't report if this is a record declaration" do
|
||||
expect_no_issues subject, <<-CRYSTAL
|
||||
record Foo, foo : String
|
||||
record Foo, foo = "foo"
|
||||
CRYSTAL
|
||||
end
|
||||
|
||||
it "doesn't report record declarations (generics)" do
|
||||
expect_no_issues subject, <<-CRYSTAL
|
||||
record Foo(T), foo : T
|
||||
record Foo(T), foo = T.new
|
||||
CRYSTAL
|
||||
end
|
||||
|
||||
pending "doesn't report type declaration as a call argument" do
|
||||
expect_no_issues subject, <<-CRYSTAL
|
||||
foo Foo(T), foo : T
|
||||
foo Foo, foo : Nil
|
||||
foo foo : String
|
||||
foo foo : String, bar : Int32?, baz : Bool
|
||||
CRYSTAL
|
||||
end
|
||||
|
||||
it "doesn't report accessor declarations" do
|
||||
it "doesn't report if this is an accessor declaration" do
|
||||
accessor_macros = %w[setter class_setter]
|
||||
%w[getter class_getter property class_property].each do |name|
|
||||
accessor_macros << name
|
||||
|
@ -462,7 +445,7 @@ module Ameba::Rule::Lint
|
|||
expect_issue subject, <<-CRYSTAL
|
||||
class A
|
||||
foo : String? = "foo"
|
||||
# ^^^ error: Useless assignment to variable `foo`
|
||||
# ^^^^^^^^^^^^^^^^^^^^^ error: Useless assignment to variable `foo`
|
||||
|
||||
def method
|
||||
foo = "bar"
|
||||
|
@ -993,7 +976,7 @@ module Ameba::Rule::Lint
|
|||
it "reports if it's not referenced at a top level" do
|
||||
expect_issue subject, <<-CRYSTAL
|
||||
a : String?
|
||||
# ^{} error: Useless assignment to variable `a`
|
||||
# ^^^^^^^^^ error: Useless assignment to variable `a`
|
||||
CRYSTAL
|
||||
end
|
||||
|
||||
|
@ -1001,7 +984,7 @@ module Ameba::Rule::Lint
|
|||
expect_issue subject, <<-CRYSTAL
|
||||
def foo
|
||||
a : String?
|
||||
# ^ error: Useless assignment to variable `a`
|
||||
# ^^^^^^^^^^^ error: Useless assignment to variable `a`
|
||||
end
|
||||
CRYSTAL
|
||||
end
|
||||
|
@ -1010,17 +993,7 @@ module Ameba::Rule::Lint
|
|||
expect_issue subject, <<-CRYSTAL
|
||||
class Foo
|
||||
a : String?
|
||||
# ^ error: Useless assignment to variable `a`
|
||||
end
|
||||
CRYSTAL
|
||||
end
|
||||
|
||||
it "doesn't report if it's referenced in a lib" do
|
||||
expect_no_issues subject, <<-CRYSTAL
|
||||
lib LibFoo
|
||||
struct Foo
|
||||
a : Int32
|
||||
end
|
||||
# ^^^^^^^^^^^ error: Useless assignment to variable `a`
|
||||
end
|
||||
CRYSTAL
|
||||
end
|
||||
|
|
|
@ -180,15 +180,20 @@ module Ameba::AST
|
|||
@visibility || outer_scope.try(&.visibility)
|
||||
end
|
||||
|
||||
{% for type in %w[Def ClassDef ModuleDef EnumDef LibDef FunDef].map(&.id) %}
|
||||
{% method_name = type.underscore %}
|
||||
# Returns `true` if current scope is a {{ method_name[0..-5] }} def, `false` otherwise.
|
||||
def {{ method_name }}?(*, check_outer_scopes = false)
|
||||
node.is_a?(Crystal::{{ type }}) ||
|
||||
!!(check_outer_scopes &&
|
||||
outer_scope.try(&.{{ method_name }}?(check_outer_scopes: true)))
|
||||
end
|
||||
{% end %}
|
||||
# Returns `true` if current scope is a def, `false` otherwise.
|
||||
def def?
|
||||
node.is_a?(Crystal::Def)
|
||||
end
|
||||
|
||||
# Returns `true` if current scope is a class, `false` otherwise.
|
||||
def class_def?
|
||||
node.is_a?(Crystal::ClassDef)
|
||||
end
|
||||
|
||||
# Returns `true` if current scope is a module, `false` otherwise.
|
||||
def module_def?
|
||||
node.is_a?(Crystal::ModuleDef)
|
||||
end
|
||||
|
||||
# Returns `true` if this scope is a top level scope, `false` otherwise.
|
||||
def top_level?
|
||||
|
|
|
@ -173,10 +173,9 @@ module Ameba::AST
|
|||
scope = @current_scope
|
||||
|
||||
case
|
||||
when (scope.top_level? || scope.type_definition?) && record_macro?(node)
|
||||
return false
|
||||
when scope.type_definition? && accessor_macro?(node)
|
||||
return false
|
||||
when scope.top_level? && record_macro?(node) then return false
|
||||
when scope.type_definition? && record_macro?(node) then return false
|
||||
when scope.type_definition? && accessor_macro?(node) then return false
|
||||
when scope.def? && special_node?(node)
|
||||
scope.arguments.each do |arg|
|
||||
ref = arg.variable.reference(scope)
|
||||
|
@ -195,14 +194,7 @@ module Ameba::AST
|
|||
end
|
||||
|
||||
private def record_macro?(node)
|
||||
return false unless node.name == "record"
|
||||
|
||||
case node.args.first?
|
||||
when Crystal::Path, Crystal::Generic
|
||||
true
|
||||
else
|
||||
false
|
||||
end
|
||||
node.name == "record" && node.args.first?.is_a?(Crystal::Path)
|
||||
end
|
||||
|
||||
private def skip?(node)
|
||||
|
|
|
@ -1,8 +1,6 @@
|
|||
module Ameba
|
||||
# Helper module that is utilizes helpers for working with globs.
|
||||
module GlobUtils
|
||||
extend self
|
||||
|
||||
# Returns all files that match specified globs.
|
||||
# Globs can have wildcards or be rejected:
|
||||
#
|
||||
|
@ -22,13 +20,10 @@ module Ameba
|
|||
# expand(["spec/*.cr", "src"]) # => all files in src folder + first level specs
|
||||
# ```
|
||||
def expand(globs)
|
||||
globs
|
||||
.flat_map do |glob|
|
||||
glob += "/**/*.cr" if File.directory?(glob)
|
||||
Dir[glob]
|
||||
end
|
||||
.uniq!
|
||||
.select! { |path| File.file?(path) }
|
||||
globs.flat_map do |glob|
|
||||
glob += "/**/*.cr" if File.directory?(glob)
|
||||
Dir[glob]
|
||||
end.uniq!
|
||||
end
|
||||
|
||||
private def rejected_globs(globs)
|
||||
|
|
|
@ -8,8 +8,6 @@ module Ameba::Rule::Lint
|
|||
# ```
|
||||
# Lint/SpecFilename:
|
||||
# Enabled: true
|
||||
# IgnoredDirs: [spec/support spec/fixtures spec/data]
|
||||
# IgnoredFilenames: [spec_helper]
|
||||
# ```
|
||||
class SpecFilename < Base
|
||||
properties do
|
||||
|
@ -28,10 +26,8 @@ module Ameba::Rule::Lint
|
|||
name = path_.stem
|
||||
path = path_.to_s
|
||||
|
||||
# check only files within spec/ directory
|
||||
# check files only within spec/ directory
|
||||
return unless path.starts_with?("spec/")
|
||||
# check only files with `.cr` extension
|
||||
return unless path.ends_with?(".cr")
|
||||
# ignore files having `_spec` suffix
|
||||
return if name.ends_with?("_spec")
|
||||
|
||||
|
|
|
@ -22,7 +22,7 @@ module Ameba::Rule::Lint
|
|||
|
||||
MSG = "Typo found: %s -> %s"
|
||||
|
||||
BIN_PATH = Process.find_executable("typos") rescue nil
|
||||
BIN_PATH = Process.find_executable("typos")
|
||||
|
||||
def bin_path : String?
|
||||
@bin_path || BIN_PATH
|
||||
|
|
|
@ -39,27 +39,15 @@ module Ameba::Rule::Lint
|
|||
end
|
||||
|
||||
def test(source, node, scope : AST::Scope)
|
||||
return if scope.lib_def?(check_outer_scopes: true)
|
||||
|
||||
scope.variables.each do |var|
|
||||
next if var.ignored? || var.used_in_macro? || var.captured_by_block?
|
||||
next if exclude_type_declarations? && scope.assigns_type_dec?(var.name)
|
||||
|
||||
var.assignments.each do |assign|
|
||||
check_assignment(source, assign, var)
|
||||
next if assign.referenced?
|
||||
issue_for assign.target_node, MSG % var.name
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
private def check_assignment(source, assign, var)
|
||||
return if assign.referenced?
|
||||
|
||||
case target_node = assign.target_node
|
||||
when Crystal::TypeDeclaration
|
||||
issue_for target_node.var, MSG % var.name
|
||||
else
|
||||
issue_for target_node, MSG % var.name
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
|
Loading…
Reference in a new issue