[Perl] Generated Languages.pm as part of the build process (#176)

The Languages.pm file is now generated upon building the release artifacts or when running the test suite. Fixes: #32 Co-authored-by: M.P. Korstanje <[email protected]>
cucumber · Feb 9, 2025 · a14e79a · a14e79a
1 parent 40b4cec
commit a14e79a
Show file tree

Hide file tree

Showing 8 changed files with 36 additions and 26 deletions.
diff --git a/.github/workflows/test-perl.yml b/.github/workflows/test-perl.yml
@@ -38,9 +38,7 @@ jobs:
           working-directory: perl
 
       - name: run tests
-        run: |
-          prove -l
-          AUTHOR_TESTS=1 prove -l
+        run: make test
         working-directory: perl
 
       - name: run acceptance tests

diff --git a/perl/.gitignore b/perl/.gitignore
@@ -6,3 +6,4 @@ perl5/
 .cpanfile_dependencies
 cpanfile.snapshot
 CHANGELOG.md
+lib/Gherkin/Generated/Languages.pm
diff --git a/perl/Makefile b/perl/Makefile
@@ -1,8 +1,9 @@
 SHELL := /usr/bin/env bash
 
 GHERKIN_PARSER = lib/Gherkin/Generated/Parser.pm
+GHERKIN_LANGUAGES = lib/Generated/Languages.pm
 GHERKIN_RAZOR = gherkin-perl.razor
-SOURCE_FILES = $(shell find . -name "*.pm" | grep -v $(GHERKIN_PARSER))
+SOURCE_FILES = $(shell find lib -name "*.pm" | grep -v $(GHERKIN_PARSER) | grep -v $(GHERKIN_LANGUAGES) )
 
 GHERKIN = bin/gherkin
 GHERKIN_GENERATE_TOKENS = bin/gherkin-generate-tokens
@@ -17,6 +18,11 @@ SOURCES      = $(patsubst ../testdata/%,acceptance/testdata/%.source.ndjson,$(GO
 ERRORS       = $(patsubst ../testdata/%,acceptance/testdata/%.errors.ndjson,$(BAD_FEATURE_FILES))
 
 .DEFAULT_GOAL = help
+
+ARTIFACT_DIR = Gherkin-latest
+ARTIFACT_DIR_VERSIONED = Gherkin-$(shell cat VERSION)
+ARTIFACT_TAR_GZ = Gherkin-$(shell cat VERSION).tar.gz
+
 PERL5LIB  = $$PWD/perl5/lib/perl5
 GHERKIN = PERL5LIB=${PERL5LIB} bin/gherkin
 GHERKIN_GENERATE_TOKENS = PERL5LIB=${PERL5LIB} bin/gherkin-generate-tokens
@@ -29,30 +35,36 @@ generate: $(GHERKIN_PARSER) ## Generate gherkin parser files
 clean-generate: ## Remove generated Gherkin parser files ## Generate gherkin parser files
 	rm -f $(GHERKIN_PARSER)
 
-copy-gherkin-languages: # lib/Gherkin/Generated/Languages.pm ## Copy gherkin-languages.json and/or generate derived files
-	echo "TODO: Depends on perl, this task should only depend on jq"
+copy-gherkin-languages:
+	echo "Nothing to do"
 
 clean-gherkin-languages: ## Remove gherkin-languages.json and any derived files
-	# rm -f lib/Gherkin/Generated/Languages.pm
-	echo "TODO: Depends on perl, this task should only depend on jq"
+	echo "Nothing to do"
 
 clean: ## Remove all build artifacts and files generated by the acceptance tests
-	rm -f .built
+	rm -rf $(ARTIFACT_DIR_VERSIONED)
+	rm -rf $(ARTIFACT_DIR)
+	rm -f $(ARTIFACT_TAR_GZ)
 	rm -rf acceptance
 	rm -rf perl5
 
 .DELETE_ON_ERROR:
 
-acceptance: .built $(TOKENS) $(ASTS) $(PICKLES) $(SOURCES) $(ERRORS) ## Build acceptance test dir and compare results with reference
+.PHONY: test
+test: perl5 ## Runs dzil test
+	PATH=$$PATH:perl5/bin PERL5LIB=${PERL5LIB} dzil test
+
+acceptance: $(ARTIFACT_DIR) $(TOKENS) $(ASTS) $(PICKLES) $(ERRORS) $(SOURCES) ## Build acceptance test dir and compare results with reference
 
-.built: perl5 $(SOURCE_FILES)
-	touch $@
+$(ARTIFACT_DIR): $(ARTIFACT_DIR_VERSIONED)
+	cp -r $(ARTIFACT_DIR_VERSIONED) $@
+
+$(ARTIFACT_DIR_VERSIONED): perl5 $(SOURCE_FILES)
+	PATH=$$PATH:perl5/bin PERL5LIB=${PERL5LIB} dzil build
 
 perl5:
 	cpanm --notest --local-lib ./perl5 --installdeps --with-develop .
-
-lib/Gherkin/Generated/Languages.pm:
-	perl helper-scripts/build_languages.pl > $@
+	PATH=$$PATH:perl5/bin PERL5LIB=${PERL5LIB} dzil authordeps --missing | cpanm --notest --local-lib ./perl5
 
 $(GHERKIN_PARSER): $(GHERKIN_RAZOR) ../gherkin.berp
 	berp -g ../gherkin.berp -t $< -o $@ --noBOM

diff --git a/perl/bin/gherkin b/perl/bin/gherkin
@@ -2,7 +2,7 @@
 
 use strict;
 use warnings;
-use lib 'lib';
+use lib 'Gherkin-latest/lib';
 
 use App::gherkin;
 

diff --git a/perl/bin/gherkin-generate-tokens b/perl/bin/gherkin-generate-tokens
@@ -2,7 +2,7 @@
 
 use strict;
 use warnings;
-use lib 'lib';
+use lib 'Gherkin-latest/lib';
 
 use Gherkin::Parser;
 use Gherkin::TokenFormatterBuilder;

diff --git a/perl/cpanfile b/perl/cpanfile
@@ -15,5 +15,5 @@ on 'test' => sub {
 };
 
 on 'develop' => sub {
-   # there are no specific development dependencies...
+    requires "Dist::Zilla";
 };
diff --git a/perl/dist.ini b/perl/dist.ini
@@ -36,10 +36,16 @@ exclude_filename=gherkin-perl.razor
 exclude_filename=Makefile
 exclude_filename=VERSION
 
-[GatherFile]
+[GatherFile / CHANGELOG.md]
 ; explicitly add unversioned files
 root=../
 filename=CHANGELOG.md
 
+[GatherFile / GeneratedLanguages]
+filename=lib/Gherkin/Generated/Languages.pm
+
 [Hook::VersionProvider]
 . = my $v = `cat ./VERSION`; chomp( $v ); $v;
+
+[Run::BeforeBuild]
+run = helper-scripts/build_languages.pl >lib/Gherkin/Generated/Languages.pm
diff --git a/perl/lib/Gherkin/Generated/Languages.pm b/perl/lib/Gherkin/Generated/Languages.pm