deprecation_collector 0.4.0 → 0.5.0

data/lib/deprecation_collector/web/router.rb

@@ -2,19 +2,20 @@
 
 class DeprecationCollector
   class Web
+    # :nodoc:
     module Router
       HTTP_METHODS = %w[GET HEAD POST PUT PATCH DELETE].freeze
       HTTP_METHODS.each do |http_method|
         const_set http_method, http_method
-        class_eval <<~RUBY, __FILE__, __LINE__+1
-          def #{http_method.downcase}(path, &block)
-            route(#{http_method}, path, &block)
-          end
+        class_eval <<~RUBY, __FILE__, __LINE__ + 1
+          def #{http_method.downcase}(path, &block) # def get(path, &block)
+            route(#{http_method}, path, &block)     #   route('GET', path, &block)
+          end                                       # end
         RUBY
       end
 
       def root(&block)
-        route(GET, '/', &block)
+        route(GET, "/", &block)
       end
 
       def route(method, path, &block)
@@ -23,10 +24,10 @@ class DeprecationCollector
 
       def helpers(mod = nil, &block)
         return ActionContext.class_eval(&block) if block
+
         ActionContext.send(:include, mod)
       end
 
-
       ROUTE_PARAMS = "rack.route_params"
       PATH_INFO = "PATH_INFO"
 
@@ -39,35 +40,33 @@ class DeprecationCollector
         path_info = "/" if path_info == "" # some buggy servers may pass empty root path
 
         @routes[request_method.upcase]&.find do |route|
-          params = route.match(request_method, path_info)
+          params = route.match(request_method.upcase, path_info)
           next unless params
+
           env[ROUTE_PARAMS] = params
           break ActionContext.new(request, &route.block)
         end
       end
 
-      def call(env, application=nil)
+      def call(env, application = nil)
         action = match(env)
         unless action
           return [
             404,
-            {"content-type" => "text/plain", "x-cascade" => "pass"},
+            { "content-type" => "text/plain", "x-cascade" => "pass" },
             ["Not Found #{env["REQUEST_METHOD"].inspect} #{env[PATH_INFO].inspect}"]
           ]
         end
 
-        resp = catch(:halt) do
-          action.call(env, application)
-        ensure
-        end
+        resp = catch(:halt) { action.call(env, application) }
 
         return resp if resp.is_a?(Array) # raw rack responses (redirects etc.)
 
         # rendered content goes here
         headers = {
           "content-type" => "text/html",
-          "cache-control" => "private, no-store",
-          # TODO:
+          "cache-control" => "private, no-store"
+          # TODO: locale/csp
           # "content-language" => action.locale,
           # "content-security-policy" => CSP_HEADER
         }
@@ -75,10 +74,11 @@ class DeprecationCollector
         [200, headers, [resp]]
       end
 
+      # :nodoc:
       class Route
         attr_accessor :request_method, :pattern, :block
 
-        NAMED_SEGMENTS_PATTERN = /\/([^\/]*):([^.:$\/]+)/
+        NAMED_SEGMENTS_PATTERN = %r{/([^/]*):([^.:$/]+)}.freeze
 
         def initialize(request_method, pattern, block)
           @request_method = request_method
@@ -92,12 +92,15 @@ class DeprecationCollector
 
         def compile_matcher
           return pattern unless pattern.match?(NAMED_SEGMENTS_PATTERN)
-          regex_pattern = pattern.gsub(NAMED_SEGMENTS_PATTERN, '/\1(?<\2>[^$/]+)') # /some/:id => /some/(?<id>[^$/]+)
 
+          regex_pattern = pattern.gsub(NAMED_SEGMENTS_PATTERN, '/\1(?<\2>[^$/]+)') # /some/:id => /some/(?<id>[^$/]+)
           Regexp.new("\\A#{regex_pattern}\\Z")
         end
 
         def match(request_method, path)
+          # this is actually not needed because of groupping by method, but just in case:
+          return unless self.request_method == request_method
+
           case matcher
           when String
             {} if path == matcher
@@ -108,6 +111,7 @@ class DeprecationCollector
         end
       end
 
+      # :nodoc:
       class ActionContext
         attr_accessor :request
 
@@ -116,7 +120,7 @@ class DeprecationCollector
           @block = block
         end
 
-        def call(env, application)
+        def call(_env, application)
           @web = application.web
           instance_exec(&@block)
         end
@@ -130,27 +134,30 @@ class DeprecationCollector
         end
 
         def params
-          @params ||= Hash.new { |hash, key| hash[key.to_s] if Symbol === key }
-                        .merge!(request.params)
-                        .merge!(route_params.transform_keys(&:to_s))
+          @params ||= Hash.new { |hash, key| hash[key.to_s] if key.is_a?(Symbol) }
+                          .merge!(request.params)
+                          .merge!(route_params.transform_keys(&:to_s))
         end
 
-        def halt(res, content=nil)
-          throw :halt, [res, {"content-type" => "text/plain"}, [content || res.to_s]]
+        def halt(res, content = nil)
+          throw :halt, [res, { "content-type" => "text/plain" }, [content || res.to_s]]
         end
 
         def redirect_to(location)
-          throw :halt, [302, {"location" => "#{request.base_url}#{location}"}, []]
+          throw :halt, [302, { "location" => "#{request.base_url}#{location}" }, []]
         end
 
-        def render(plain: nil, html: nil, json: nil, erb: nil, slim: nil, status: 200, locals: nil, layout: 'layout.html.slim')
-          raise ArgumentError, "provide exactly one render format" unless [plain, html, json, erb, slim].compact.size == 1
+        def render(plain: nil, html: nil, json: nil, erb: nil, slim: nil, # rubocop:disable Metrics
+                   status: 200, locals: nil, layout: "layout.html.slim")
+          unless [plain, html, json, erb, slim].compact.size == 1
+            raise ArgumentError, "provide exactly one render format"
+          end
 
           if json
             json = JSON.generate(json) unless json.is_a?(String)
-            return [status, {"content-type" => "application/json"}, [json]]
+            return [status, { "content-type" => "application/json" }, [json]]
           end
-          return [status, {"content-type" => "text/plain"}, [plain.to_s]] if plain
+          return [status, { "content-type" => "text/plain" }, [plain.to_s]] if plain
 
           _define_locals(locals) if locals
           template = "#{erb}.erb" if erb
@@ -159,44 +166,54 @@ class DeprecationCollector
           html = render_template(layout) { html } if layout
 
           color_scheme_headers = {
-            'Accept-CH' => 'Sec-CH-Prefers-Color-Scheme',
-            'Vary' => 'Sec-CH-Prefers-Color-Scheme',
-            'Critical-CH' => 'Sec-CH-Prefers-Color-Scheme'
+            "Accept-CH" => "Sec-CH-Prefers-Color-Scheme",
+            "Vary" => "Sec-CH-Prefers-Color-Scheme",
+            "Critical-CH" => "Sec-CH-Prefers-Color-Scheme"
           }
 
-          return [status, {"content-type" => "text/html"}.merge(color_scheme_headers), [html.to_s]] if html
+          return [status, { "content-type" => "text/html" }.merge(color_scheme_headers), [html.to_s]] if html
         end
 
         VIEW_PATH = "#{__dir__}/views"
 
         def render_template(template, &block)
-          original_template_name = File.join(VIEW_PATH, template.to_s)
-          template = template.gsub(/\.slim\z/, '.template.rb')
-          template_method_name = "_template_#{template.gsub(/[^\w]/, '_')}"
-          template_filename = File.join(VIEW_PATH, template.to_s)
-
-          if ENV['DEPRECATION_COLLECTOR_RELOAD_WEB_TEMPLATES']
-            require 'slim'
-            puts "Recompiling #{original_template_name}"
-            ActionContext.class_eval { undef_method(template_method_name) } if respond_to?(template_method_name)
-            if original_template_name.end_with?('.slim')
-              File.write(template_filename, Slim::Template.new(original_template_name).precompiled_template)
-            end
-          end
+          template_target = template.gsub(/\.slim\z/, ".template.rb")
+          template_method_name = "_template_#{template_target.gsub(/[^\w]/, "_")}"
+          template_filename = File.join(VIEW_PATH, template_target.to_s)
 
-          unless respond_to?(template_method_name)
-            src = File.read(template_filename)
-            src = ERB.new(src).src if template_filename.end_with?('.erb')
-            ActionContext.class_eval <<-RUBY, template_filename.gsub(/\.template\.rb\z/, '.slim'), 1
-              def #{template_method_name}; #{src}
-              end
-            RUBY
+          if ENV["DEPRECATION_COLLECTOR_RELOAD_WEB_TEMPLATES"]
+            _recompile_template(template, template_filename, template_method_name)
           end
 
+          _load_template(template_filename, template_method_name) unless respond_to?(template_method_name)
+
           send(template_method_name, &block)
         end
 
         private
+
+        def _load_template(template_filename, template_method_name)
+          src = File.read(template_filename)
+          src = ERB.new(src).src if template_filename.end_with?(".erb")
+          src = <<-RUBY
+            def #{template_method_name}; #{src}
+            end
+          RUBY
+          ActionContext.class_eval(src, template_filename.gsub(/\.template\.rb\z/, ".slim"), 1)
+        end
+
+        def _recompile_template(template, template_filename, template_method_name)
+          original_template_name = File.join(VIEW_PATH, template.to_s)
+          puts "Recompiling #{original_template_name}"
+          ActionContext.class_eval { undef_method(template_method_name) } if respond_to?(template_method_name)
+
+          if original_template_name.end_with?(".slim")
+            require "slim"
+            File.write(template_filename, Slim::Template.new(original_template_name).precompiled_template)
+          end
+          template_method_name
+        end
+
         def _define_locals(locals)
           locals&.each { |k, v| define_singleton_method(k) { v } unless singleton_methods.include?(k) }
         end

data/lib/deprecation_collector/web/utils.rb

@@ -1,13 +1,16 @@
+# frozen_string_literal: true
 
 begin
-  require 'cgi/escape'
+  # this is stdgem in ruby 2.7+
+  require "cgi/escape"
 rescue LoadError
+  # optional dependency not present
 end
 
 module Temple
   # @api public
   module Utils
-    extend self
+    extend self # rubocop:disable Style/ModuleFunction
 
     # Returns an escaped copy of `html`.
     # Strings which are declared as html_safe are not escaped.
@@ -31,11 +34,11 @@ module Temple
       # Used by escape_html
       # @api private
       ESCAPE_HTML = {
-        '&'  => '&',
-        '"'  => '"',
-        '\'' => ''',
-        '<'  => '&lt;',
-        '>'  => '&gt;'
+        "&" => "&amp;",
+        '"' => "&quot;",
+        "'" => "&#39;",
+        "<" => "&lt;",
+        ">" => "&gt;"
       }.freeze
 
       ESCAPE_HTML_PATTERN = Regexp.union(*ESCAPE_HTML.keys)

data/lib/deprecation_collector/web/views/index.html.template.rb

@@ -25,8 +25,10 @@ _buf = ''; _buf << ("<header class=\"mb-3\"><h1>Deprecations</h1><a class=\"btn
 ; 
 ; 
 ; total = 0; 
+; by_realm = Hash.new(0); 
 ; @deprecations.each do |deprecation|; 
 ; total += 1; 
+; by_realm[deprecation[:realm]] += 1; 
 ; _buf << ("<tr".freeze); _slim_codeattributes5 = deprecation[:digest]; if _slim_codeattributes5; if _slim_codeattributes5 == true; _buf << (" data-digest=\"\"".freeze); else; _buf << (" data-digest=\"".freeze); _buf << ((::Temple::Utils.escape_html((_slim_codeattributes5))).to_s); _buf << ("\"".freeze); end; end; _buf << ("><td><a".freeze); 
 ; 
 ; _slim_codeattributes6 = deprecation_path(deprecation[:digest]); if _slim_codeattributes6; if _slim_codeattributes6 == true; _buf << (" href=\"\"".freeze); else; _buf << (" href=\"".freeze); _buf << ((::Temple::Utils.escape_html((_slim_codeattributes6))).to_s); _buf << ("\"".freeze); end; end; _buf << (">".freeze); _buf << ((::Temple::Utils.escape_html((deprecation[:count]))).to_s); 
@@ -49,16 +51,16 @@ msg.delete_prefix!("warning: ")
 ; _buf << ("<pre class=\"pre-scrollable p-1\" style=\"overflow: auto; max-width: 700px; max-height: 200px; font-size: 11px\"><code>".freeze); 
 ; _buf << ((::Temple::Utils.escape_html((msg))).to_s); 
 ; _buf << ("</code></pre>".freeze); else; 
-; _buf << ("<div class=\"small\">".freeze); _buf << ((::Temple::Utils.escape_html((msg))).to_s); 
+; _buf << ("<div class=\"msg\">".freeze); _buf << ((::Temple::Utils.escape_html((msg))).to_s); 
 ; _buf << ("</div>".freeze); end; if deprecation.dig(:notes, :comment); 
 ; _buf << ((::Temple::Utils.escape_html((deprecation.dig(:notes, :comment)))).to_s); 
 ; 
 ; end; if deprecation.dig(:context, :action); 
-; _buf << ("<div class=\"small controller\">".freeze); _buf << ((::Temple::Utils.escape_html((deprecation.dig(:context, :action)))).to_s); 
-; _buf << ("</div>".freeze); elsif deprecation.dig(:context, :params, :controller); 
-; _buf << ("<div class=\"small controller\">".freeze); _buf << ((::Temple::Utils.escape_html((deprecation.dig(:context, :params).slice(:controller, :action).values.join('#')))).to_s); 
+; _buf << ("<i class=\"small controller\">".freeze); _buf << ((::Temple::Utils.escape_html((deprecation.dig(:context, :action)))).to_s); 
+; _buf << ("</i>".freeze); elsif deprecation.dig(:context, :params, :controller); 
+; _buf << ("<i class=\"small controller\">".freeze); _buf << ((::Temple::Utils.escape_html((deprecation.dig(:context, :params).slice(:controller, :action).values.join('#')))).to_s); 
 ; 
-; _buf << ("</div>".freeze); end; _buf << ("</td><td class=\"small\">".freeze); 
+; _buf << ("</i>".freeze); end; _buf << ("</td><td class=\"small\">".freeze); 
 ; if deprecation[:gem_traceline]; 
 ; _buf << ("<div class=\"gem_location\">".freeze); 
 ; location, function = deprecation[:gem_traceline].split(':in `', 2); 
@@ -94,6 +96,14 @@ msg.delete_prefix!("warning: ")
 ; if total > 3; 
 ; _buf << ((::Temple::Utils.escape_html((total))).to_s); 
 ; _buf << (" deprecations ".freeze); 
+; end; by_realm.each_pair do |realm, count|; 
+; _buf << ("<a class=\"btn btn-sm btn-outline-secondary\" href=\"?realm=".freeze); _buf << ((::Temple::Utils.escape_html((realm))).to_s); _buf << ("\">".freeze); 
+; _buf << ((::Temple::Utils.escape_html((realm))).to_s); 
+; _buf << (" <div".freeze); _temple_html_attributeremover2 = ''; _temple_html_attributemerger2 = []; _temple_html_attributemerger2[0] = "badge"; _temple_html_attributemerger2[1] = ''; _slim_codeattributes13 = (count == 0 ? 'bg-success' : 'bg-secondary'); if Array === _slim_codeattributes13; _slim_codeattributes13 = _slim_codeattributes13.flatten; _slim_codeattributes13.map!(&:to_s); _slim_codeattributes13.reject!(&:empty?); _temple_html_attributemerger2[1] << ((::Temple::Utils.escape_html((_slim_codeattributes13.join(" ")))).to_s); else; _temple_html_attributemerger2[1] << ((::Temple::Utils.escape_html((_slim_codeattributes13))).to_s); end; _temple_html_attributemerger2[1]; _temple_html_attributeremover2 << ((_temple_html_attributemerger2.reject(&:empty?).join(" ")).to_s); _temple_html_attributeremover2; if !_temple_html_attributeremover2.empty?; _buf << (" class=\"".freeze); _buf << ((_temple_html_attributeremover2).to_s); _buf << ("\"".freeze); end; _buf << (">".freeze); _buf << ((::Temple::Utils.escape_html((count))).to_s); 
+; _buf << ("</div> </a> ".freeze); end; if params[:realm] && params[:realm] != ''; 
+; _buf << ("<a class=\"btn btn-sm btn-outline-primary\" href=\"?realm=\">Other realms     </a> ".freeze); 
+; 
+; 
 ; end; _buf << ("</footer><style>.code_location {\n  cursor: pointer;\n}</style><script>document.querySelectorAll('.code_location').forEach(function(elem){\n  elem.addEventListener('click', function () {\n    let textToCopy = elem.getAttribute('data-copy-value');\n    if(!textToCopy) textToCopy = elem.innerText;\n    console.log(\"Copying\", textToCopy)\n    navigator.clipboard.writeText(textToCopy);\n  }, false);\n});</script>".freeze); 
 ; 
 ; 

data/lib/deprecation_collector/web/views/show.html.template.rb

@@ -2,12 +2,81 @@ _buf = ''; _buf << ("<header class=\"mb-3\"><h1>Deprecation</h1><a class=\"btn b
 ; 
 ; 
 ; _slim_codeattributes1 = deprecations_path; if _slim_codeattributes1; if _slim_codeattributes1 == true; _buf << (" href=\"\"".freeze); else; _buf << (" href=\"".freeze); _buf << ((::Temple::Utils.escape_html((_slim_codeattributes1))).to_s); _buf << ("\"".freeze); end; end; _buf << (">Back</a> <a class=\"btn btn-danger\" data-confirm=\"Delete?\" data-method=\"delete\"".freeze); 
-; _slim_codeattributes2 = deprecation_path(@deprecation[:digest]); if _slim_codeattributes2; if _slim_codeattributes2 == true; _buf << (" href=\"\"".freeze); else; _buf << (" href=\"".freeze); _buf << ((::Temple::Utils.escape_html((_slim_codeattributes2))).to_s); _buf << ("\"".freeze); end; end; _buf << (" rel=\"nofollow\" title=\"Delete\"><span class=\"glyphicon glyphicon-trash insalesicon-trash\"></span>Delete</a> </header><main><div class=\"card p-3\"><pre><code>".freeze); 
+; _slim_codeattributes2 = deprecation_path(@deprecation[:digest]); if _slim_codeattributes2; if _slim_codeattributes2 == true; _buf << (" href=\"\"".freeze); else; _buf << (" href=\"".freeze); _buf << ((::Temple::Utils.escape_html((_slim_codeattributes2))).to_s); _buf << ("\"".freeze); end; end; _buf << (" rel=\"nofollow\" title=\"Delete\"><span class=\"glyphicon glyphicon-trash insalesicon-trash\"></span>Delete</a> </header><main><dl class=\"row\"><dt>Message</dt><dd><code>".freeze); 
 ; 
 ; 
 ; 
 ; 
 ; 
 ; 
-; _buf << ((::Temple::Utils.escape_html((@deprecation.pretty_inspect))).to_s); 
-; _buf << ("</code></pre></div></main>".freeze); _buf
+; 
+; _buf << ((::Temple::Utils.escape_html((@deprecation[:message]))).to_s); 
+; _buf << ("</code></dd><dt>First time</dt><dd>".freeze); 
+; 
+; 
+; _buf << ((::Temple::Utils.escape_html((@deprecation[:first_timestamp]&.yield_self { |time| Time.at(time) }))).to_s); 
+; 
+; _buf << ("</dd>".freeze); if @deprecation[:count] > 1; 
+; _buf << ("<dt>Count</dt><dd>".freeze); 
+; _buf << ((::Temple::Utils.escape_html((@deprecation[:count]))).to_s); 
+; 
+; _buf << ("</dd>".freeze); end; _buf << ("<dt>Realm</dt><dd>".freeze); 
+; _buf << ((::Temple::Utils.escape_html((@deprecation[:realm]))).to_s); 
+; 
+; _buf << ("</dd>".freeze); if @deprecation[:ruby_version]; 
+; _buf << ("<dt>Ruby</dt><dd>".freeze); 
+; _buf << ((::Temple::Utils.escape_html((@deprecation[:ruby_version]))).to_s); 
+; _buf << ("</dd>".freeze); end; if @deprecation[:rails_version]; 
+; _buf << ("<dt>Rails</dt><dd>".freeze); 
+; _buf << ((::Temple::Utils.escape_html((@deprecation[:rails_version]))).to_s); 
+; 
+; _buf << ("</dd>".freeze); end; if @deprecation[:revision]; 
+; _buf << ("<dt>Revision</dt><dd>".freeze); 
+; _buf << ((::Temple::Utils.escape_html((@deprecation[:revision]))).to_s); 
+; _buf << ("</dd>".freeze); end; if @deprecation[:hostname]; 
+; _buf << ("<dt>Hostname</dt><dd>".freeze); 
+; _buf << ((::Temple::Utils.escape_html((@deprecation[:hostname]))).to_s); 
+; 
+; _buf << ("</dd>".freeze); end; if @deprecation[:context]; 
+; _buf << ("<dt>Context</dt><dd><div class=\"card p-3\"><pre><code>".freeze); 
+; 
+; 
+; 
+; _buf << ((::Temple::Utils.escape_html((JSON.pretty_generate(@deprecation[:context])))).to_s); 
+; 
+; _buf << ("</code></pre></div></dd>".freeze); end; if @deprecation[:app_traceline]; 
+; _buf << ("<dt>App traceline</dt><dd>".freeze); 
+; 
+; location, function = @deprecation[:app_traceline].split(':in `', 2); 
+; _buf << ("<code class=\"code_location\">".freeze); _buf << ((::Temple::Utils.escape_html((location))).to_s); 
+; _buf << ("</code> <i>".freeze); _buf << ((::Temple::Utils.escape_html((function.delete_suffix("'")))).to_s); 
+; 
+; _buf << ("</i></dd>".freeze); end; if @deprecation[:gem_traceline]; 
+; _buf << ("<dt>Gem traceline</dt><dd>".freeze); 
+; 
+; location, function = @deprecation[:gem_traceline].split(':in `', 2); 
+; full_gemname = location.delete_prefix('/gems/').gsub(%r{/.*}, ''); 
+; location_in_gem = location.delete_prefix("/gems/#{full_gemname}/"); 
+; _buf << ("<i>".freeze); _buf << ((::Temple::Utils.escape_html((full_gemname))).to_s); 
+; _buf << ("</i> <code class=\"code_location\"".freeze); _slim_codeattributes3 = location_in_gem; if _slim_codeattributes3; if _slim_codeattributes3 == true; _buf << (" data-copy-value=\"\"".freeze); else; _buf << (" data-copy-value=\"".freeze); _buf << ((::Temple::Utils.escape_html((_slim_codeattributes3))).to_s); _buf << ("\"".freeze); end; end; _buf << (">".freeze); _buf << ((::Temple::Utils.escape_html((location_in_gem.delete_prefix('lib/')))).to_s); 
+; _buf << ("</code> <i>".freeze); _buf << ((::Temple::Utils.escape_html((function.delete_suffix("'")))).to_s); 
+; 
+; _buf << ("</i></dd>".freeze); end; if @deprecation[:full_backtrace]; 
+; _buf << ("<dt>Backtrace</dt><dd>".freeze); 
+; 
+; @deprecation[:full_backtrace].each do |trace_line|; 
+; _buf << ("<div class=\"trace-line\">".freeze); 
+; location, function = trace_line.split(':in `', 2); 
+; _buf << ("<code class=\"code_location\">".freeze); _buf << ((::Temple::Utils.escape_html((location))).to_s); 
+; _buf << ("</code> <i>".freeze); _buf << ((::Temple::Utils.escape_html((function.delete_suffix("'")))).to_s); 
+; 
+; _buf << ("</i></div>".freeze); end; _buf << ("</dd>".freeze); end; fields_to_reject = %i[message first_timestamp count realm app_traceline gem_traceline full_backtrace ruby_version rails_version context revision hostname digest_base digest].to_set; 
+; additional_data = @deprecation.reject { |key,_val| fields_to_reject.include?(key) }; 
+; if additional_data.size > 0; 
+; _buf << ("<dt>Additional data <div class=\"card p-3\"><pre><code>".freeze); 
+; 
+; 
+; 
+; _buf << ((::Temple::Utils.escape_html((JSON.pretty_generate additional_data))).to_s); 
+; _buf << ("</code></pre></div></dt>".freeze); end; _buf << ("</dl><a".freeze); _slim_codeattributes4 = deprecation_path(params[:id], format: 'json'); if _slim_codeattributes4; if _slim_codeattributes4 == true; _buf << (" href=\"\"".freeze); else; _buf << (" href=\"".freeze); _buf << ((::Temple::Utils.escape_html((_slim_codeattributes4))).to_s); _buf << ("\"".freeze); end; end; _buf << (">Raw json</a></main>".freeze); 
+; _buf

data/lib/deprecation_collector/web.rb

@@ -4,9 +4,10 @@ require "erb"
 require "rack/content_length"
 require "rack/builder"
 
-require_relative 'web/application'
+require_relative "web/application"
 
 class DeprecationCollector
+  # rack app with a html interface to deprecation collector with a persistent storage like redis
   class Web
     attr_accessor :import_enabled
 
@@ -28,6 +29,7 @@ class DeprecationCollector
     end
 
     private
+
     def build
       web = self
       ::Rack::Builder.new do