Crystal combined `unreachable` tallies

README.md

This gist contains a database with combined tallies of methods call counts in https://github.com/crystal-lang/crystal It uses a new compiler feature crystal tool unreachable --tallies, proposed in crystal-lang/crystal#13969 It helps identify unreachable methods across multiple entry points (compiler, compiler_spec and std_spec) .

The following query finds the most interesting entries in this dataset, methods that are never called. Excluded are library methods, deprecated methods and pseudo methods in Crystal::Macros.

SELECT name, file, line, length
FROM combined
WHERE
  count = 0
  AND annotations NOT LIKE '%@[Deprecated'
  AND name NOT LIKE 'Crystal::Macros%'
  AND name NOT LIKE 'Lib%'

Open in Datasette Lite

Makefile

## Generate database of def tallies
##   $ make

SOURCES := $(shell find src -name '*.cr')
SPEC_SOURCES := $(shell find spec -name '*.cr')

CRYSTAL := bin/crystal
SQLITE := sqlite3
SQLITE-UTILS := sqlite-utils

.PHONY: all
all: ## Generates a database of def tallies
all: csv

unreachable-tallies-%.csv: spec/%.cr $(SOURCES) $(SPEC_SOURCES)
	$(CRYSTAL) tool unreachable -i src --format=csv --tallies $< > $@

unreachable-tallies-compiler.csv: src/compiler/crystal.cr $(SOURCES)
	$(CRYSTAL) tool unreachable -i src --format=csv --tallies $< > $@

unreachable.db: unreachable-tallies-std_spec.csv unreachable-tallies-compiler_spec.csv unreachable-tallies-compiler.csv
	rm -f $@
	$(SQLITE) $@ < scripts/unreachable.sql
	$(SQLITE-UTILS) insert $@ tallies unreachable-tallies-std_spec.csv --csv --convert 'row["entrypoint"] = "spec/std_spec.cr"'
	@echo
	$(SQLITE-UTILS) insert $@ tallies unreachable-tallies-compiler_spec.csv --csv --convert 'row["entrypoint"] = "spec/compiler_spec.cr"'
	@echo
	$(SQLITE-UTILS) insert $@ tallies unreachable-tallies-compiler.csv --csv --convert 'row["entrypoint"] = "src/compiler/crystal.cr"'
	@echo

.PHONY: csv
csv: unreachable-compiler.csv unreachable-stdlib.csv

unreachable-compiler.csv: unreachable.db
	@echo "SELECT name, file, line, length FROM combined \
	WHERE	count = 0 AND annotations NOT LIKE '%@[Deprecated' \
	AND name NOT LIKE 'Crystal::Macros%'	AND name NOT LIKE 'Lib%' \
	AND file LIKE 'src/compiler/%' \
	ORDER BY file" | $(SQLITE) --csv --header $< > $@

unreachable-stdlib.csv: unreachable.db
	@echo "SELECT name, file, line, length FROM combined \
	WHERE	count = 0 AND annotations NOT LIKE '%@[Deprecated' \
	AND name NOT LIKE 'Crystal::Macros%'	AND name NOT LIKE 'Lib%' \
	AND file NOT LIKE 'src/compiler/%' \
	ORDER BY file" | $(SQLITE) --csv --header $< > $@

.PHONY: clean
clean:
	rm -f unreachable-*.csv unreachable.db

.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}'

unreachable-compiler.csv

unreachable-stdlib.csv

unreachable.db

unreachable.sql