Minor cleanup at 58% test coverage

Signed-off-by: John Rofrano <[email protected]>

Author: rofrano

.gitignore

@@ -5,6 +5,9 @@
 # Log file
 *.log
 
+# Code coverage files
+.coverage
+
 # Gradle files
 .gradle
 

Makefile

@@ -0,0 +1,52 @@
+# Makefile targets for dvelopment an testing
+# Use make help for more info
+
+.PHONY: help
+help: ## Display this help.
+	@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n  make \033[36m<target>\033[0m\n"} /^[a-zA-Z_0-9-]+:.*?##/ { printf "  \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
+
+.PHONY: all
+all: help
+
+##@ Development
+
+.PHONY: venv
+venv: ## Create a Python virtual environment
+	$(info Creating Python 3 virtual environment...)
+	poetry shell
+
+.PHONY: install
+install: ## Install Python dependencies in virtual environment
+	$(info Installing dependencies...)
+	poetry config virtualenvs.in-project true
+	poetry install
+
+.PHONY: lint
+lint: ## Run the linter
+	$(info Running linting...)
+	flake8 cldk --count --select=E9,F63,F7,F82 --show-source --statistics
+	flake8 cldk --count --max-complexity=10 --max-line-length=180 --statistics
+	pylint cldk --max-line-length=180
+
+.PHONY: test
+test: ## Run the unit tests
+	$(info Running tests...)
+	pytest --pspec --cov=cldk --cov-fail-under=50 --disable-warnings
+
+##@ Build
+
+.PHONY: clean
+clean: ## Cleans up from previous compiles
+	$(info Cleaning up compile artifacts...)
+	rm -fr dist
+
+.PHONY: refresh
+refresh: ## Refresh code analyzer
+	$(info Refreshing CodeAnalyzer...)
+	wget $(curl -s https://api.github.com/repos/IBM/codenet-minerva-code-analyzer/releases/latest | grep "browser_download_url" | grep codeanalyzer.jar | cut -d '"' -f 4)
+	mv codeanalyzer.jar cldk/analysis/java/codeanalyzer/jar/codeanalyzer.jar
+
+.PHONY: build
+build: ## Builds a new Python wheel
+	$(info Building artifacts...)
+	poetry build

cldk/analysis/javascript/treesitter/javascript_sitter.py

@@ -184,7 +184,7 @@ def __get_top_level_functions(self, code: str) -> List[JsCallable]:
 
         query = """
         (program [
-            (function_declaration) @function 
+            (function_declaration) @function
             (export_statement (function_declaration) @function.export)
         ])
         """
@@ -210,7 +210,7 @@ def __get_top_level_generators(self, code: str) -> List[JsCallable]:
 
         query = """
         (program [
-            (generator_function_declaration) @generator 
+            (generator_function_declaration) @generator
             (export_statement (generator_function_declaration) @generator.export)
         ])
         """

cldk/models/java/models.py

@@ -184,6 +184,9 @@ class JCallable(BaseModel):
     cyclomatic_complexity: int | None
 
     def __hash__(self):
+        """
+        Returns the hash value of the declaration.
+        """
         return hash(self.declaration)
 
     @model_validator(mode="after")

setup.cfg

@@ -0,0 +1,6 @@
+# Code Quality
+
+[flake8]
+max-line-length = 180
+per-file-ignores =
+    */__init__.py: F401 E402

tests/tree_sitter/javascript/test_javascript_tree_sitter.py

@@ -1,3 +1,23 @@
+################################################################################
+# Copyright IBM Corporation 2024
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+################################################################################
+
+"""
+Javascript Treesitter Tests
+"""
+
 from typing import List
 
 from unittest import TestCase