dev: update readme and test-suite configuration (#690)

This pull request includes updates to the `README.md` file and
improvements to the test suite, particularly focusing on the use of
`ClimateControl` for environment variable management and some general
cleanup.

Updates to documentation:

*
[`README.md`](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L51-R52):
Clarified and corrected the usage of environment variables, ensuring
they are correctly quoted and formatted.
[[1]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L51-R52)
[[2]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L86-R87)
[[3]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L96-R97)
[[4]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L155-R157)
*
[`README.md`](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R9):
Added a new feature description for providing stable URLs for feeds
generated by automatic sourcing.

Improvements to test suite:

*
[`spec/html2rss/web/app_spec.rb`](diffhunk://#diff-090562f30c41a91ba9b59502563d84d791cfb29c288708bd2acc51e7c33e8f10R4):
Introduced `ClimateControl` to manage environment variables during
tests, replacing direct `ENV` manipulation.
[[1]](diffhunk://#diff-090562f30c41a91ba9b59502563d84d791cfb29c288708bd2acc51e7c33e8f10R4)
[[2]](diffhunk://#diff-090562f30c41a91ba9b59502563d84d791cfb29c288708bd2acc51e7c33e8f10R43-R54)
*
[`spec/html2rss/web/helpers/auto_source_spec.rb`](diffhunk://#diff-1c878bb09df33c5882ccb5908063682ecd481c30c7a5d0bf97a8be65cb698548L4-R11):
Added `ClimateControl` and corrected the RSpec description format.
*
[`spec/routes/auto_source_spec.rb`](diffhunk://#diff-c88fcacaf08dea9f6768c205b268876e4b05dc517724faacbc6215eafe37f543L7-R7):
Updated to use `RSpec.describe` for consistency.

General cleanup:

*
[`spec/spec_helper.rb`](diffhunk://#diff-89eebfcbc0f14b6d989517837ca1e94fce4e2ce9a03233641cd936f2b8d2ed94L14-L15):
Removed the `EnvHelper` module and associated `ClimateControl` support
file, as they are no longer needed.
[[1]](diffhunk://#diff-89eebfcbc0f14b6d989517837ca1e94fce4e2ce9a03233641cd936f2b8d2ed94L14-L15)
[[2]](diffhunk://#diff-89eebfcbc0f14b6d989517837ca1e94fce4e2ce9a03233641cd936f2b8d2ed94L121-L122)
[[3]](diffhunk://#diff-77b0d409fb1eaea240996a5f235354d577c0624382f9e7c19fdd075636bfd2a9L1-L9)

Author: gildesmarais

.gitignore

@@ -2,3 +2,4 @@ tmp/*
 !tmp/.keep
 .yardoc
 coverage
+spec/examples.txt

README.md

@@ -6,6 +6,7 @@ This web application scrapes websites to build and deliver RSS 2.0 feeds.
 
 **Features:**
 
+- Provides stable URLs for feeds generated by automatic sourcing.
 - [Create your custom feeds](#how-to-build-your-rss-feeds)!
 - Comes with plenty of [included configs](https://github.com/html2rss/html2rss-configs) out of the box.
 - Handles request caching.
@@ -48,7 +49,7 @@ services:
       RACK_ENV: production
       HEALTH_CHECK_USERNAME: health
       HEALTH_CHECK_PASSWORD: please-set-YOUR-OWN-veeeeeery-l0ng-aNd-h4rd-to-gue55-Passw0rd!
-      # AUTO_SOURCE_ENABLED: true
+      # AUTO_SOURCE_ENABLED: 'true'
       # AUTO_SOURCE_USERNAME: foobar
       # AUTO_SOURCE_PASSWORD: A-Unique-And-Long-Password-For-Your-Own-Instance
       ## to allow just requests originating from the local host
@@ -83,7 +84,7 @@ To enable the `auto_source` feature, comment in the env variables in the `docker
 ```yaml
 environment:
   ## … snip ✁
-  AUTO_SOURCE_ENABLED: true
+  AUTO_SOURCE_ENABLED: "true"
   AUTO_SOURCE_USERNAME: foobar
   AUTO_SOURCE_PASSWORD: A-Unique-And-Long-Password-For-Your-Own-Instance
   ## to allow just requests originating from the local host
@@ -93,7 +94,7 @@ environment:
   ## … snap ✃
 ```
 
-Restart the container and open <http://127.0.0.1:3000/auto_source>.
+Restart the container and open <http://127.0.0.1:3000/auto_source/>.
 When asked, enter your username and password.
 
 Then enter the URL of a website and click on the _Generate_ button.
@@ -152,8 +153,8 @@ If you're going to host a public instance, _please, please, please_:
 | `HEALTH_CHECK_PASSWORD`        | default: auto-generated on start   |
 |                                |                                    |
 | `AUTO_SOURCE_ENABLED`          | default: false                     |
-| `AUTO_SOURCE_USERNAME          | no default                         |
-| `AUTO_SOURCE_PASSWORD          | no default                         |
+| `AUTO_SOURCE_USERNAME`         | no default.                        |
+| `AUTO_SOURCE_PASSWORD`         | no default.                        |
 | `AUTO_SOURCE_ALLOWED_ORIGINS`  | no default.                        |
 |                                |                                    |
 | `PORT`                         | default: 3000                      |

spec/html2rss/web/app_spec.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'spec_helper'
+require 'climate_control'
 
 require_relative '../../../app'
 
@@ -39,14 +40,18 @@ def app = described_class
   describe '.development?' do
     subject { described_class.development? }
 
+    around do |example|
+      ClimateControl.modify(RACK_ENV: env) { example.run }
+    end
+
     context 'when RACK_ENV is development' do
-      before { ENV['RACK_ENV'] = 'development' }
+      let(:env) { 'development' }
 
       it { is_expected.to be true }
     end
 
     context 'when RACK_ENV is not development' do
-      before { ENV['RACK_ENV'] = 'test' }
+      let(:env) { 'test' }
 
       it { is_expected.to be false }
     end

spec/html2rss/web/helpers/auto_source_spec.rb

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
 require 'spec_helper'
-require 'rss'
-require 'roda'
 require 'base64'
+require 'climate_control'
+require 'roda'
+require 'rss'
+
 require_relative '../../../../helpers/auto_source'
 
-describe Html2rss::Web::AutoSource do # rubocop:disable RSpec/SpecFilePathFormat
+RSpec.describe Html2rss::Web::AutoSource do # rubocop:disable RSpec/SpecFilePathFormat
   context 'when ENV variables are not set' do
     describe '.enabled?' do
       subject { described_class.enabled? }

spec/routes/auto_source_spec.rb

@@ -4,7 +4,7 @@
 require 'rss'
 require_relative '../../app'
 
-describe Html2rss::Web::App do # rubocop:disable RSpec/SpecFilePathFormat
+RSpec.describe Html2rss::Web::App do # rubocop:disable RSpec/SpecFilePathFormat
   include Rack::Test::Methods
   def app = described_class
 

spec/spec_helper.rb

@@ -11,8 +11,6 @@
   end
 end
 
-require_relative 'support/climate_control'
-
 require 'rack/test'
 require 'vcr'
 
@@ -79,14 +77,14 @@
   #   # Allows RSpec to persist some state between runs in order to support
   #   # the `--only-failures` and `--next-failure` CLI options. We recommend
   #   # you configure your source control system to ignore this file.
-  #   config.example_status_persistence_file_path = "spec/examples.txt"
+  config.example_status_persistence_file_path = 'spec/examples.txt'
   #
   #   # Limits the available syntax to the non-monkey patched syntax that is
   #   # recommended. For more details, see:
   #   #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
   #   #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
   #   #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
-  #   config.disable_monkey_patching!
+  config.disable_monkey_patching!
   #
   #   # This setting enables warnings. It's recommended, but in some cases may
   #   # be too noisy due to issues in dependencies.
@@ -118,6 +116,4 @@
   #   # test failures related to randomization by passing the same `--seed` value
   #   # as the one that triggered the failure.
   #   Kernel.srand config.seed
-
-  config.include(EnvHelper)
 end