refactor: improve structure to follow more Roda conventions (#675)

Author: gildesmarais

.rubocop.yml

@@ -2,6 +2,7 @@ require:
   - rubocop-performance
   - rubocop-rspec
   - rubocop-rake
+  - rubocop-thread_safety
 
 AllCops:
   DisplayCopNames: true
@@ -18,3 +19,12 @@ Naming/RescuedExceptionsVariableName:
 
 Layout/ClassStructure:
   Enabled: true
+
+Style/Documentation:
+  AllowedConstants:
+    - App
+
+RSpec/SpecFilePathFormat:
+  Exclude:
+    - 'spec/html2rss/web/app/*_spec.rb'
+    - 'spec/html2rss/web/app/health_check/auth_spec.rb'

Gemfile

@@ -28,6 +28,7 @@ group :development do
   gem 'rubocop-performance', require: false
   gem 'rubocop-rake', require: false
   gem 'rubocop-rspec', require: false
+  gem 'rubocop-thread_safety', require: false
   gem 'yard', require: false
 end
 

Gemfile.lock

@@ -119,6 +119,8 @@ GEM
       rubocop (~> 1.0)
     rubocop-rspec (3.0.4)
       rubocop (~> 1.61)
+    rubocop-thread_safety (0.5.1)
+      rubocop (>= 0.90.0)
     ruby-progressbar (1.13.0)
     sanitize (6.1.3)
       crass (~> 1.0.2)
@@ -165,6 +167,7 @@ DEPENDENCIES
   rubocop-performance
   rubocop-rake
   rubocop-rspec
+  rubocop-thread_safety
   simplecov
   tilt
   vcr

Procfile

@@ -1 +1 @@
-web: bundle exec puma -C config/puma.rb
+web: bundle exec puma -C config/puma.rb -p 3000

README.md

@@ -180,7 +180,7 @@ If you're comfortable with installing Ruby directly on your machine, follow thes
 3. `bundle`
 4. `foreman start`
 
-_html2rss-web_ now listens on port **5000** for requests.
+_html2rss-web_ now listens on port **3000** for requests.
 
 ## Contribute
 

app.rb

@@ -2,126 +2,97 @@
 
 require 'roda'
 require 'rack/cache'
-require 'rack-timeout'
-require_relative 'app/health_check'
-require_relative 'app/local_config'
-require_relative 'app/html2rss_facade'
 
 require_relative 'roda/roda_plugins/basic_auth'
 
-module App
-  ##
-  # This app uses html2rss and serves the feeds via HTTP.
-  #
-  # It is built with [Roda](https://roda.jeremyevans.net/).
-  class App < Roda
-    opts[:check_dynamic_arity] = false
-    opts[:check_arity] = :warn
-
-    use Rack::Timeout
-
-    use Rack::Cache,
-        metastore: 'file:./tmp/rack-cache-meta',
-        entitystore: 'file:./tmp/rack-cache-body',
-        verbose: (ENV.fetch('RACK_ENV', nil) == 'development')
-
-    plugin :content_security_policy do |csp|
-      csp.default_src :none
-      csp.style_src :self
-      csp.script_src :self
-      csp.connect_src :self
-      csp.img_src :self
-      csp.font_src :self
-      csp.form_action :self
-      csp.base_uri :none
-      csp.frame_ancestors :none
-      csp.block_all_mixed_content
-    end
-
-    plugin :default_headers,
-           'Content-Type' => 'text/html',
-           'X-Frame-Options' => 'deny',
-           'X-Content-Type-Options' => 'nosniff',
-           'X-XSS-Protection' => '1; mode=block'
-
-    plugin :error_handler do |error|
-      handle_error(error)
-    end
-
-    plugin :public
-    plugin :render, escape: true, layout: 'layout'
-    plugin :typecast_params
-    plugin :basic_auth
-
-    route do |r|
-      path = RequestPath.new(request)
+module Html2rss
+  module Web
+    ##
+    # This app uses html2rss and serves the feeds via HTTP.
+    #
+    # It is built with [Roda](https://roda.jeremyevans.net/).
+    class App < Roda
+      # TODO: move to helper
+      def self.development?
+        ENV['RACK_ENV'] == 'development'
+      end
 
-      r.root { view 'index' }
+      def development? = self.class.development?
+
+      opts[:check_dynamic_arity] = false
+      opts[:check_arity] = :warn
+
+      use Rack::Cache,
+          metastore: 'file:./tmp/rack-cache-meta',
+          entitystore: 'file:./tmp/rack-cache-body',
+          verbose: development?
+
+      plugin :content_security_policy do |csp|
+        csp.default_src :none
+        csp.style_src :self
+        csp.script_src :self
+        csp.connect_src :self
+        csp.img_src :self
+        csp.font_src :self
+        csp.form_action :self
+        csp.base_uri :none
+        csp.frame_ancestors :none
+        csp.block_all_mixed_content
+      end
 
-      r.public
+      plugin :default_headers,
+             'Content-Type' => 'text/html',
+             'X-Frame-Options' => 'deny',
+             'X-Content-Type-Options' => 'nosniff',
+             'X-XSS-Protection' => '1; mode=block'
 
-      r.get 'health_check.txt' do
-        handle_health_check
-      end
+      plugin :exception_page
+      plugin :error_handler do |error|
+        next exception_page(error) if development?
 
-      r.on String, String do |folder_name, config_name_with_ext|
-        handle_html2rss_configs(path.full_config_name, folder_name, config_name_with_ext)
+        handle_error(error)
       end
 
-      r.on String do |config_name_with_ext|
-        handle_local_config_feeds(path.full_config_name, config_name_with_ext)
+      plugin :hash_branches
+      plugin :public
+      plugin :render, escape: true, layout: 'layout'
+      plugin :typecast_params
+      plugin :basic_auth
+
+      Dir['routes/**/*.rb'].each do |f|
+        if development?
+          Unreloader.require f
+        else
+          require_relative f
+        end
       end
-    end
 
-    private
-
-    def handle_error(error) # rubocop:disable Metrics/MethodLength
-      case error
-      when Html2rss::Config::ParamsMissing,
-           Roda::RodaPlugins::TypecastParams::Error
-        set_error_response('Parameters missing or invalid', 422)
-      when Html2rss::AttributePostProcessors::UnknownPostProcessorName,
-           Html2rss::ItemExtractors::UnknownExtractorName,
-           Html2rss::Config::ChannelMissing
-        set_error_response('Invalid feed config', 422)
-      when ::App::LocalConfig::NotFound,
-           Html2rss::Configs::ConfigNotFound
-        set_error_response('Feed config not found', 404)
-      else
-        set_error_response('Internal Server Error', 500)
-      end
+      route do |r|
+        r.public
 
-      @show_backtrace = ENV.fetch('RACK_ENV', nil) == 'development'
-      @error = error
-      view 'error'
-    end
+        r.hash_branches('')
 
-    def set_error_response(page_title, status)
-      @page_title = page_title
-      response.status = status
-    end
+        r.root { view 'index' }
 
-    def handle_health_check
-      HttpCache.expires_now(response)
+        r.get 'health_check.txt' do
+          handle_health_check
+        end
 
-      with_basic_auth(realm: HealthCheck,
-                      username: HealthCheck::Auth.username,
-                      password: HealthCheck::Auth.password) do
-        HealthCheck.run
-      end
-    end
+        r.on String, String do |folder_name, config_name_with_ext|
+          handle_html2rss_configs(request, folder_name, config_name_with_ext)
+        end
 
-    def handle_local_config_feeds(full_config_name, _config_name_with_ext)
-      Html2rssFacade.from_local_config(full_config_name, typecast_params) do |config|
-        response['Content-Type'] = 'text/xml'
-        HttpCache.expires(response, config.ttl * 60, cache_control: 'public')
+        r.on String do |config_name_with_ext|
+          handle_local_config_feeds(request, config_name_with_ext)
+        end
       end
-    end
 
-    def handle_html2rss_configs(full_config_name, _folder_name, _config_name_with_ext)
-      Html2rssFacade.from_config(full_config_name, typecast_params) do |config|
-        response['Content-Type'] = 'text/xml'
-        HttpCache.expires(response, config.ttl * 60, cache_control: 'public')
+      Dir['helpers/*.rb'].each do |f|
+        if development?
+          Unreloader.require f
+        else
+          require_relative f
+        end
       end
     end
   end

app/health_check.rb

@@ -3,15 +3,21 @@
 require 'parallel'
 require_relative 'local_config'
 require 'securerandom'
+require 'singleton'
 
-module App
-  ##
-  # Checks if the local configs are generatable.
-  module HealthCheck
+module Html2rss
+  module Web
     ##
-    # Contains logic to obtain username and password to be used with HealthCheck endpoint.
-    class Auth
-      class << self
+    # Checks if the local configs are generatable.
+    module HealthCheck
+      ##
+      # Contains logic to obtain username and password to be used with HealthCheck endpoint.
+      class Auth
+        include Singleton
+
+        def self.username = instance.username
+        def self.password = instance.password
+
         def username
           @username ||= fetch_credential('HEALTH_CHECK_USERNAME')
         end
@@ -30,33 +36,33 @@ def fetch_credential(env_var)
           end
         end
       end
-    end
 
-    module_function
+      module_function
 
-    ##
-    # @return [String] "success" when all checks passed.
-    def run
-      broken_feeds = errors
-      broken_feeds.any? ? broken_feeds.join("\n") : 'success'
-    end
+      ##
+      # @return [String] "success" when all checks passed.
+      def run
+        broken_feeds = errors
+        broken_feeds.any? ? broken_feeds.join("\n") : 'success'
+      end
 
-    ##
-    # @return [Array<String>]
-    def errors
-      [].tap do |errors|
-        Parallel.each(LocalConfig.feed_names, in_threads: 4) do |feed_name|
-          Html2rss.feed_from_yaml_config(LocalConfig::CONFIG_FILE, feed_name.to_s).to_s
-        rescue StandardError => error
-          errors << "[#{feed_name}] #{error.class}: #{error.message}"
+      ##
+      # @return [Array<String>]
+      def errors
+        [].tap do |errors|
+          Parallel.each(LocalConfig.feed_names) do |feed_name|
+            Html2rss.feed_from_yaml_config(LocalConfig::CONFIG_FILE, feed_name.to_s)
+          rescue StandardError => error
+            errors << "[#{feed_name}] #{error.class}: #{error.message}"
+          end
         end
       end
-    end
 
-    def format_error(feed_name, error)
-      "[#{feed_name}] #{error.class}: #{error.message}"
-    end
+      def format_error(feed_name, error)
+        "[#{feed_name}] #{error.class}: #{error.message}"
+      end
 
-    private_class_method :format_error
+      private_class_method :format_error
+    end
   end
 end