hospital 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c2d250697eb93225f8674b4374369688af80a6d32efcbfc70406ae2130d0bba
-  data.tar.gz: bb30e0f93629c922d9723c943061e9dddad28fcab7406ab24496cd5f893a5b6d
+  metadata.gz: c474d0a653f97f57a2e281a594c0e9b45d3e03bd17bd0b4ea80140e79b8d6572
+  data.tar.gz: 24c2232ea33222d4c470c2c736a6bf93745049d332fa07c44970c4f654bcc5eb
 SHA512:
-  metadata.gz: 6ca63659e83bd3a662612b41b2a645776ca06132241fd5033c169f8fb4be1547445fb34e2160731adced86f7ba6a8995f92a6d1fa573751002ce6d2c85869c70
-  data.tar.gz: 91f8b05eddcbfc0fbbc1cb44b7d9a0c340312207267bd4589237480f9fd95a5473af493d0c274d4231c6aaa914fb2820b7e3985039b1ad089eb523764d5ce89c
+  metadata.gz: 05540eb19dbdd3277ef4d76bca4f8692e69c6eba340e0a8f91a8c554dd81bf654fa478c7f9396925eed5e2deca3ac28d75b872cec652b38128b84291a65d3b02
+  data.tar.gz: 0eb85a41d00fe122217b07eef2d6a69f5d8f6dadbbfcd95b21991d0e055c2be35e2aeec4c9d4f4a86d133d50b960f7697746a26cb08e7fb584389905491d5fb3

data/lib/hospital/checkup.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Hospital
+  class Checkup
+    attr_reader :code, :condition, :diagnosis, :group, :skipped, :klass, :precondition
+
+    def initialize klass, code, title: nil, condition: -> { true }, precondition: false
+      @klass        = klass
+      @code         = code
+      @condition    = condition
+      @diagnosis    = Hospital::Diagnosis.new([klass.to_s, title].compact.join(' - '))
+      @precondition = precondition
+      @group        = nil
+    end
+
+    def reset_diagnosis
+      diagnosis.reset
+    end
+
+    def check verbose: false
+      diagnosis.reset
+
+      if condition.nil? || condition.call
+        @skipped = false
+        code.call(diagnosis)
+        diagnosis
+      else
+        @skipped = true
+        nil
+      end
+    rescue StandardError => e
+      diagnosis.add_error "Unrescued exception in #{klass}.checkup:\n#{e.full_message}.\nThis is a bug inside the checkup method that should be fixed!"
+    end
+
+    def success?
+      diagnosis.success?
+    end
+
+    def set_group group
+      @group = group
+    end
+  end
+end

data/lib/hospital/checkup_group.rb

@@ -0,0 +1,55 @@
+require_relative "string_formatter"
+
+using StringFormatter
+
+module Hospital
+  class CheckupGroup
+    attr_reader :name, :checkups, :precondition_checkups, :skipped
+
+    def initialize name
+      @name                   = name
+      @precondition_checkups  = []
+      @checkups               = []
+      @skipped                = false
+    end
+
+    def all_checkups
+      @precondition_checkups + @checkups
+    end
+
+    def header
+      "#{name.to_s.capitalize.gsub(/_/, ' ')} checks"
+    end
+
+    def add_checkup checkup
+      checkup.set_group self
+
+      if checkup.precondition
+        @precondition_checkups << checkup
+      else
+                     @checkups << checkup
+      end
+    end
+
+    def run_checkups verbose: false
+      run_precondition_checkups verbose: verbose
+
+      unless @skipped
+        run_dependent_checkups verbose: verbose
+      end
+    end
+
+    def run_precondition_checkups verbose: false
+      @precondition_checkups.each do |checkup|
+        checkup.check verbose: verbose
+        @skipped = true unless checkup.success?
+      end
+    end
+
+    def run_dependent_checkups verbose: false
+      @checkups.each do |checkup|
+        checkup.check verbose: verbose
+      end
+    end
+  end
+end

data/lib/hospital/diagnosis.rb

@@ -1,5 +1,9 @@
-class Hospital::Diagnosis  
-  attr_reader :infos, :warnings, :errors, :name, :results
+require_relative "string_formatter"
+
+using StringFormatter
+
+class Hospital::Diagnosis
+  attr_reader :infos, :warnings, :skips, :errors, :name, :results
 
   def initialize name
     @name = name.to_s
@@ -9,6 +13,7 @@ class Hospital::Diagnosis
   def reset
     @infos    = []
     @warnings = []
+    @skips    = []
     @errors   = []
     @results  = []
   end
@@ -44,8 +49,8 @@ class Hospital::Diagnosis
       "#{prefix} #{message.gsub(/\n\z/, '').gsub(/\n/, prefix ? "\n   " : "\n")}"
     end
 
-    def put 
-      puts output
+    def put out
+      out.put_diagnosis_result output
     end
   end
 
@@ -54,11 +59,15 @@ class Hospital::Diagnosis
   end
 
   class Warning < Result
-    def prefix; '🟠'; end
+    def prefix; '🟠' end
+  end
+
+  class Skip < Result
+    def prefix; '🟠' end
   end
 
   class Error < Result
-    def prefix; '🔴'; end
+    def prefix; '🔴' end
   end
 
   def add_info message
@@ -73,13 +82,31 @@ class Hospital::Diagnosis
     @results  << warning
   end
 
+  def add_skip message
+    skip = Skip.new message
+    @skips    << skip
+    @results  << skip
+  end
+
   def add_error message
     error = Error.new message
     @errors   << error
     @results  << error
   end
 
-  def put_results
-    results.each &:put
+  def put_results out
+    results.each do |result|
+      result.put out
+    end
+  end
+
+  def success?
+    errors.count == 0 && skips.count == 0
+  end
+
+  def on_success_message message
+    if success?
+      add_info message
+    end
   end
 end

data/lib/hospital/formatter/base.rb

@@ -0,0 +1,11 @@
+module Hospital
+  module Formatter
+    class Base
+      attr_reader :buffer
+
+      def initialize
+        @buffer = ""
+      end
+    end
+  end
+end

data/lib/hospital/formatter/pre.rb

@@ -0,0 +1,31 @@
+require_relative "base"
+
+using StringFormatter
+
+module Hospital
+  module Formatter
+    class Pre < Base
+      def put_group_header text
+        @buffer << "\n\n### #{text}"
+      end
+
+      def put_diagnosis_header text
+        @buffer << "\n\n## #{text}"
+      end
+
+      def put_summary errors_count, warnings_count
+        @buffer <<  <<~END
+          \n\n
+          #### Summary:
+          Errors:   #{errors_count}
+          Warnings: #{warnings_count}
+        END
+      end
+
+      def put_diagnosis_result text
+        @buffer << "\n#{text}"
+      end
+
+    end
+  end
+end

data/lib/hospital/formatter/shell.rb

@@ -0,0 +1,31 @@
+require_relative "base"
+
+using StringFormatter
+
+module Hospital
+  module Formatter
+    class Shell < Base
+      def put_group_header text
+        @buffer << "\n### #{text}".h1
+      end
+
+      def put_diagnosis_header text
+        @buffer << "\n#{text.h2.indented}"
+      end
+
+      def put_summary errors_count, warnings_count
+        @buffer <<  <<~END
+
+          #{"Summary:".h1}
+          #{"Errors:   #{errors_count}".red}
+          #{"Warnings: #{warnings_count}".yellow}
+        END
+      end
+
+      def put_diagnosis_result text
+        @buffer << "\n#{text.indented}"
+      end
+
+    end
+  end
+end

data/lib/hospital/string_formatter.rb

@@ -0,0 +1,31 @@
+module StringFormatter
+  refine String do
+    def bold
+      "\e[1m#{self}\e[0m"
+    end
+
+    def underline
+      "\e[4m#{self}\e[0m"
+    end
+
+    def h1
+      "\n#{self}".underline.bold
+    end
+
+    def h2
+      "\n#{self}".underline
+    end
+
+    def red
+      "\e[31m#{self}\e[0m"
+    end
+
+    def yellow
+      "\e[33m#{self}\e[0m"
+    end
+
+    def indented
+      "#{self}"
+    end
+  end
+end

data/lib/hospital/tasks/checkup.rake

@@ -2,17 +2,12 @@
 
 require_relative '../../hospital'
 
+# usage:
+# rake doctor
+# rake doctor[true]
+
 desc 'Check system setup sanity.'
 task :doctor, [:verbose] => :environment do |t, args|
-  # at_exit { Rake::Task['doctor:summary'].invoke if $!.nil? }
-
-  ActiveRecord::Base.connection_pool.disconnect!
-  ActiveSupport.on_load(:active_record) do
-    config = ActiveRecord::Base.configurations[Rails.env]
-    config['pool'] = 100
-    ActiveRecord::Base.establish_connection(config)
-  end
-  
   verbose = args[:verbose] == "true"
 
   # silence warnings about double constant definitions
@@ -20,7 +15,7 @@ task :doctor, [:verbose] => :environment do |t, args|
     p "eager load all classes" if verbose
     Rails.application.eager_load!
   end
-  
+
   p "start checkup" if verbose
-  Hospital.do_checkup_all verbose: verbose
+  puts Hospital::Runner.new(verbose: verbose).do_checkup_all
 end

data/lib/hospital/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Hospital
-  VERSION = "0.5.0"
+  VERSION = "0.7.0"
 end

data/lib/hospital.rb

@@ -1,114 +1,104 @@
 # frozen_string_literal: true
 
+require "byebug"
+require          'require_all'
 require_relative "hospital/version"
+require_relative "hospital/checkup"
+require_relative "hospital/checkup_group"
 require_relative "hospital/diagnosis"
-require_relative "hospital/formatter"
+require_relative "hospital/string_formatter"
+require_relative "hospital/formatter/shell"
+require_relative "hospital/formatter/pre"
 
-using Formatter
+using StringFormatter
 
 module Hospital
   require_relative 'railtie' if defined?(Rails)
 
   class Error < StandardError; end
 
-  class Checkup 
-    attr_reader :code, :condition, :diagnosis, :group, :skipped, :klass
+  @@groups = []
 
-    def initialize klass, code, group: :general, title: nil, condition: -> { true }
-      @klass      = klass
-      @code       = code
-      @group      = group
-      @condition  = condition
-      @diagnosis  = Hospital::Diagnosis.new([klass.to_s, title].compact.join(' - '))
-    end
+  class << self
 
-    def reset_diagnosis
-      diagnosis.reset
+    def included(klass)
+      raise Hospital::Error.new("Cannot include Hospital, please extend instead.")
     end
 
-    def check verbose: false
-      diagnosis.reset
+    # used to call the checkup for a specific class directly (in specs)
+    def do_checkup(klass, verbose: false)
+      @@groups.map(&:all_checkups).flatten.select{|cu| cu.klass == klass }.map do |cu|
+        cu.check verbose: verbose
+      end
+    end
 
-      if condition.nil? || condition.call
-        @skipped = false
-        code.call(diagnosis)
-        diagnosis
-      else
-        @skipped = true
-        nil
+    def find_or_create_checkup_group name
+      unless checkup_group = @@groups.detect{|g| g.name == name }
+        checkup_group = CheckupGroup.new name
+        @@groups << checkup_group
       end
-    rescue StandardError => e
-      diagnosis.add_error "Unrescued exception in #{klass}.checkup:\n#{e.inspect}.\nThis is a bug inside the checkup method that should be fixed!"
+      checkup_group
+    end
+
+    def groups
+      @@groups
     end
   end
 
-  @@checkups = {}
+  def checkup if: -> { true }, group: :general, title: nil, precondition: false, &code
+    checkup_group = Hospital.find_or_create_checkup_group group
+    checkup = Checkup.new(
+      self,
+      code,
+      title:        title,
+      condition:    binding.local_variable_get('if'),
+      precondition: precondition
+    )
+
+    # p "adding #{checkup.inspect} to #{group_name}"
+    checkup_group.add_checkup checkup
+  end
 
-  class << self
+  class Runner
+    attr_reader :verbose
 
-    def included(klass)
-      raise Hospital::Error.new("Cannot include Hospital, please extend instead.")
-    end
+    def initialize verbose: false, formatter: :shell
+      @verbose    = verbose
+      @formatter  = case formatter
+        when :pre then Formatter::Pre
+        else           Formatter::Shell
+      end
 
-    def extended(klass)
-      # only relevant if the class does not yet define a real checkup method
-      @@checkups[klass] = Checkup.new klass, -> (diagnosis) do
-        diagnosis.add_warning("#{klass}: No checks defined! Please call checkup with a lambda.")
-      end, group: :general
+      @out = @formatter.new
+      # @out.put_group_header "using formatter #{@formatter}"
     end
 
-    def do_checkup_all verbose: false
+    def do_checkup_all
       errcount  = 0
       warcount  = 0
 
-      threads = @@checkups.map do |klass, checkup|
-        Thread.new do
-          Thread.current.report_on_exception = false
-          checkup.check(verbose: verbose)
-        end
-      end
-
-      threads.each &:join
+      Hospital.groups.each do |group|
+        @out.put_group_header group.header
+        group.run_checkups verbose: verbose
 
-      @@checkups.group_by{|klass, checkup| checkup.group}.map do |group, checkups|
-        puts group_header(group)
-        first = false
-
-        checkups.each do |klass, checkup|
+        group.all_checkups.each do |checkup|
           if diagnosis = checkup.diagnosis
             errcount += diagnosis.errors.count
             warcount += diagnosis.warnings.count
 
-            if !checkup.skipped
-              puts "Checking #{diagnosis.name}:".h2
-              diagnosis.put_results
+            if !checkup.skipped && (!checkup.group.skipped || checkup.precondition)
+              @out.put_diagnosis_header "Checking #{diagnosis.name}:"
+              diagnosis.put_results @out
             elsif verbose
-              puts "Skipped #{diagnosis.name}.".h2
+              @out.put_diagnosis_header "Skipped #{diagnosis.name}."
             end
           end
         end
       end
 
-      puts <<~END
+      @out.put_summary errcount, warcount
 
-        #{"Summary:".h1}
-        #{"Errors:   #{errcount}".red}
-        #{"Warnings: #{warcount}".yellow}
-      END
-    end
-
-    # used to call the checkup for a specific class directly (in specs)
-    def do_checkup(klass)
-      @@checkups[klass].check
-    end
-
-    def group_header group
-      "### #{group.to_s.capitalize.gsub(/_/, ' ')} checks".h1
+      @out.buffer
     end
   end
-
-  def checkup if: -> { true }, group: :general, title: nil, &code
-    @@checkups[self] = Checkup.new self, code, group: group, title: title, condition: binding.local_variable_get('if')
-  end
-
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: hospital
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Alexander
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-26 00:00:00.000000000 Z
-dependencies: []
+date: 2024-03-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: require_all
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Imagine a team of little doctors creating diagnoses and creating a useful
   report.
 email:
@@ -21,8 +49,13 @@ files:
 - LICENSE.txt
 - README.md
 - lib/hospital.rb
+- lib/hospital/checkup.rb
+- lib/hospital/checkup_group.rb
 - lib/hospital/diagnosis.rb
-- lib/hospital/formatter.rb
+- lib/hospital/formatter/base.rb
+- lib/hospital/formatter/pre.rb
+- lib/hospital/formatter/shell.rb
+- lib/hospital/string_formatter.rb
 - lib/hospital/tasks/checkup.rake
 - lib/hospital/version.rb
 - lib/railtie.rb

data/lib/hospital/formatter.rb

@@ -1,19 +0,0 @@
-module Formatter
-  refine String do
-    def h1
-      "\n\e[4m\e[1m#{self}\e[0m"
-    end
-
-    def h2
-      "\n\e[4m#{self}\e[0m"
-    end
-
-    def red
-      "\e[31m#{self}\e[0m"
-    end
-
-    def yellow
-      "\e[33m#{self}\e[0m"
-    end
-  end
-end