From 7dfccf75233b44521a0f59608a1e525f7c27f30b Mon Sep 17 00:00:00 2001 From: Luke Hill Date: Mon, 16 Sep 2024 16:46:04 +0100 Subject: [PATCH 1/7] Future proof cucumber messages dep --- ruby/cucumber-html-formatter.gemspec | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ruby/cucumber-html-formatter.gemspec b/ruby/cucumber-html-formatter.gemspec index 02134ab6..c4f12f48 100644 --- a/ruby/cucumber-html-formatter.gemspec +++ b/ruby/cucumber-html-formatter.gemspec @@ -24,7 +24,7 @@ Gem::Specification.new do |s| 'source_code_uri' => 'https://github.com/cucumber/html-formatter' } - s.add_runtime_dependency 'cucumber-messages', '> 19', '< 27' + s.add_dependency 'cucumber-messages', '> 19', '< 28' s.add_development_dependency 'cucumber-compatibility-kit', '~> 15.2' s.add_development_dependency 'rake', '~> 13.2' From 5bd9ed813158eec3c4bb130be038bdf65b534eb3 Mon Sep 17 00:00:00 2001 From: Luke Hill Date: Mon, 16 Sep 2024 16:52:01 +0100 Subject: [PATCH 2/7] Hardcode location to assets template --- ruby/lib/cucumber/html_formatter/formatter.rb | 2 +- ruby/lib/cucumber/html_formatter/template_writer.rb | 5 +++-- ruby/spec/cucumber/html_formatter/template_writer_spec.rb | 6 +++++- 3 files changed, 9 insertions(+), 4 deletions(-) diff --git a/ruby/lib/cucumber/html_formatter/formatter.rb b/ruby/lib/cucumber/html_formatter/formatter.rb index 55ad0ee8..398c78e8 100644 --- a/ruby/lib/cucumber/html_formatter/formatter.rb +++ b/ruby/lib/cucumber/html_formatter/formatter.rb @@ -58,7 +58,7 @@ def post_message end def template_writer - @template_writer ||= TemplateWriter.new(AssetsLoader.template) + @template_writer ||= TemplateWriter.new end end end diff --git a/ruby/lib/cucumber/html_formatter/template_writer.rb b/ruby/lib/cucumber/html_formatter/template_writer.rb index dbf29389..80710b84 100644 --- a/ruby/lib/cucumber/html_formatter/template_writer.rb +++ b/ruby/lib/cucumber/html_formatter/template_writer.rb @@ -4,9 +4,10 @@ module Cucumber module HTMLFormatter class TemplateWriter attr_reader :template + private :template - def initialize(template) - @template = template + def initialize + @template = AssetsLoader.template end def write_between(from, to) diff --git a/ruby/spec/cucumber/html_formatter/template_writer_spec.rb b/ruby/spec/cucumber/html_formatter/template_writer_spec.rb index 50fb65f8..5c3e86b4 100644 --- a/ruby/spec/cucumber/html_formatter/template_writer_spec.rb +++ b/ruby/spec/cucumber/html_formatter/template_writer_spec.rb @@ -2,7 +2,11 @@ describe Cucumber::HTMLFormatter::TemplateWriter do describe '#write_between' do - subject(:template_writer) { described_class.new(template) } + subject(:template_writer) { described_class.new } + + before do + allow(Cucumber::HTMLFormatter::AssetsLoader).to receive(:template).and_return(template) + end let(:template) { 'Some template {{here}} with content after' } From 1ede259ffe8ef0dec3062d4386a9abd6c83d8f2f Mon Sep 17 00:00:00 2001 From: Luke Hill Date: Mon, 16 Sep 2024 16:52:54 +0100 Subject: [PATCH 3/7] Change instance methods to class ones in test syntax --- ruby/spec/cucumber/html_formatter/assets_loader_spec.rb | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/ruby/spec/cucumber/html_formatter/assets_loader_spec.rb b/ruby/spec/cucumber/html_formatter/assets_loader_spec.rb index bd6688ef..9c61e84f 100644 --- a/ruby/spec/cucumber/html_formatter/assets_loader_spec.rb +++ b/ruby/spec/cucumber/html_formatter/assets_loader_spec.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true describe Cucumber::HTMLFormatter::AssetsLoader do - describe '#template' do + describe '.template' do it 'reads the content of assets/index.mustache.html' do expect(File).to receive(:read).with(a_string_ending_with('assets/index.mustache.html')) @@ -9,7 +9,7 @@ end end - describe '#css' do + describe '.css' do it 'reads the content of assets/main.css' do expect(File).to receive(:read).with(a_string_ending_with('assets/main.css')) @@ -17,7 +17,7 @@ end end - describe '#script' do + describe '.script' do it 'reads the content of assets/main.js' do expect(File).to receive(:read).with(a_string_ending_with('assets/main.js')) From 12f8676419988b6455c7030be9cb6cac2227a549 Mon Sep 17 00:00:00 2001 From: Luke Hill Date: Mon, 16 Sep 2024 16:55:05 +0100 Subject: [PATCH 4/7] Add rubocop linter into CI --- .github/workflows/lint-ruby.yml | 0 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 .github/workflows/lint-ruby.yml diff --git a/.github/workflows/lint-ruby.yml b/.github/workflows/lint-ruby.yml new file mode 100644 index 00000000..e69de29b From 675f8738e88849aa9c1d03f06b258220dc1e0706 Mon Sep 17 00:00:00 2001 From: Luke Hill Date: Mon, 16 Sep 2024 16:56:11 +0100 Subject: [PATCH 5/7] Move linting into regular tets-ruby workflow --- .github/workflows/lint-ruby.yml | 0 .github/workflows/test-ruby.yml | 10 ++++++++++ 2 files changed, 10 insertions(+) delete mode 100644 .github/workflows/lint-ruby.yml diff --git a/.github/workflows/lint-ruby.yml b/.github/workflows/lint-ruby.yml deleted file mode 100644 index e69de29b..00000000 diff --git a/.github/workflows/test-ruby.yml b/.github/workflows/test-ruby.yml index 91ef6990..27150258 100644 --- a/.github/workflows/test-ruby.yml +++ b/.github/workflows/test-ruby.yml @@ -11,6 +11,16 @@ on: workflow_call: jobs: + rubocop: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: ruby/setup-ruby@v1 + with: + ruby-version: '2.6' + bundler-cache: true + - run: bundle exec rubocop + test-ruby: runs-on: ${{ matrix.os }} strategy: From d5fa1ea52a22410f61abf110d5829e111107ecca Mon Sep 17 00:00:00 2001 From: Luke Hill Date: Mon, 16 Sep 2024 16:59:52 +0100 Subject: [PATCH 6/7] Add changelog for both changes --- CHANGELOG.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 68d7d781..40d1da20 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,11 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/). ## [Unreleased] +### Added +- Run `rubocop` linting tests in CI for ruby ([#329](https://github.com/cucumber/html-formatter/pull/329)) + +### Changed +- [Ruby] Alter asset template location scanner in codebase to be hardcoded (Was always only in one location) ([#329](https://github.com/cucumber/html-formatter/pull/329)) ## [21.7.0] - 2024-08-12 ### Changed From f386b109f3c209236f95ff73014a91df68a30c7c Mon Sep 17 00:00:00 2001 From: Luke Hill Date: Mon, 16 Sep 2024 17:15:58 +0100 Subject: [PATCH 7/7] Remove rubocop pipeline temporarily now we know it activates and wait until ruby 3.0+ minimum to re-enable it --- .github/workflows/test-ruby.yml | 20 +++++++++++--------- CHANGELOG.md | 3 --- 2 files changed, 11 insertions(+), 12 deletions(-) diff --git a/.github/workflows/test-ruby.yml b/.github/workflows/test-ruby.yml index 27150258..eb215d97 100644 --- a/.github/workflows/test-ruby.yml +++ b/.github/workflows/test-ruby.yml @@ -11,15 +11,17 @@ on: workflow_call: jobs: - rubocop: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - - uses: ruby/setup-ruby@v1 - with: - ruby-version: '2.6' - bundler-cache: true - - run: bundle exec rubocop +# TODO: LH - Implement this when ruby version for html-formatter becomes a minimum of v3.0 +# This will save a lot of aggravation +# rubocop: +# runs-on: ubuntu-latest +# steps: +# - uses: actions/checkout@v4 +# - uses: ruby/setup-ruby@v1 +# with: +# ruby-version: '2.6' +# bundler-cache: true +# - run: bundle exec rubocop test-ruby: runs-on: ${{ matrix.os }} diff --git a/CHANGELOG.md b/CHANGELOG.md index 40d1da20..852e80f4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,9 +6,6 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/). ## [Unreleased] -### Added -- Run `rubocop` linting tests in CI for ruby ([#329](https://github.com/cucumber/html-formatter/pull/329)) - ### Changed - [Ruby] Alter asset template location scanner in codebase to be hardcoded (Was always only in one location) ([#329](https://github.com/cucumber/html-formatter/pull/329))