hospital 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4fe2ccd9fe0117efeaf99d430e269bee6e11e27463161d7038f4550ad79dcabb
-  data.tar.gz: 045b72881224032291189022ede2c9eec3aacc8edb52a688d05570e0ad54d871
+  metadata.gz: 3dda421b0e01757d0328884312ef0eb7f3e0f56c93a50ae928b64d2621796578
+  data.tar.gz: f56bb16f35eef2b3211a47fefc2c514b17e0b894f9c6e483fcb0819e914d0b76
 SHA512:
-  metadata.gz: 7ead12b8b24f8aaae387ac81c400950f02d682260a136cecb5f97007e0607a89d55900ccd5e112f82d1137484295990042dfe0f98e91a570755b354ac08e2181
-  data.tar.gz: a269f71f8736c77172da1798f6f78623dccbcb887167193b7b0c998611786df554f5a035e66f2acf2dd6b292b6647caf7d0c822d2fed6301d68c85788c4322c6
+  metadata.gz: 97048efd58fa3d4a758bffca77386b3dd5b94569b2eb953b5087410f5bee68b3fdef7b4cf70b5045e5e094e82e0833100825d88f363846c3b38229df39408fa0
+  data.tar.gz: 4ce02585d62f4fa93d2a2cb03a22abc1be5aa545cbd3157226afcb20dd4ac390a813ad136c98e3608f33dc564d17fcc15fab3266240196da21956c98ac740727

data/lib/hospital/checkup.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Hospital
+  class Checkup
+    attr_reader :code, :condition, :diagnosis, :group, :skipped, :klass, :precondition
+
+    def initialize klass, code, group: :general, title: nil, condition: -> { true }, precondition: false
+      @klass        = klass
+      @code         = code
+      @group        = group
+      @condition    = condition
+      @diagnosis    = Hospital::Diagnosis.new([klass.to_s, title].compact.join(' - '))
+      @precondition = precondition
+    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
+  end
+end

data/lib/hospital/checkup_group.rb

@@ -0,0 +1,53 @@
+require_relative "formatter"
+
+using Formatter
+
+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
+      "\n### #{name.to_s.capitalize.gsub(/_/, ' ')} checks".h1
+    end
+
+    def add_checkup checkup
+      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,14 +1,19 @@
-class Hospital::Diagnosis  
-  attr_reader :infos, :warnings, :errors, :name, :results
+require_relative "formatter"
+
+using Formatter
+
+class Hospital::Diagnosis
+  attr_reader :infos, :warnings, :skips, :errors, :name, :results
 
   def initialize name
-    @name               = name.to_s
+    @name = name.to_s
     reset
   end
 
   def reset
     @infos    = []
     @warnings = []
+    @skips    = []
     @errors   = []
     @results  = []
   end
@@ -27,6 +32,12 @@ class Hospital::Diagnosis
     "[#{vars.map{|v| "'#{v}'"}.join(', ')}]"
   end
 
+  def hide_value value
+    "#{value}"
+      .gsub(/(?<=.{1}).(?=.{2})/, '*')
+      .gsub(/\*{10,}/, '*****...*****')
+  end
+
   class Result
     attr_reader :message, :prefix
 
@@ -38,8 +49,8 @@ class Hospital::Diagnosis
       "#{prefix} #{message.gsub(/\n\z/, '').gsub(/\n/, prefix ? "\n   " : "\n")}"
     end
 
-    def put 
-      puts output
+    def put
+      puts output.indented
     end
   end
 
@@ -48,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
@@ -67,6 +82,12 @@ 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
@@ -74,15 +95,16 @@ class Hospital::Diagnosis
   end
 
   def put_results
-    put_header "Checking #{name}:"
     results.each &:put
   end
 
-  private
-
-  def put_header message
-    puts ''
-    puts "### #{message}"
+  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.rb

@@ -0,0 +1,31 @@
+module Formatter
+  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

@@ -3,13 +3,15 @@
 require_relative '../../hospital'
 
 desc 'Check system setup sanity.'
-task :doctor => :environment do
-  # at_exit { Rake::Task['doctor:summary'].invoke if $!.nil? }
+task :doctor, [:verbose] => :environment do |t, args|
+  verbose = args[:verbose] == "true"
 
   # silence warnings about double constant definitions
   Kernel::silence_warnings do
+    p "eager load all classes" if verbose
     Rails.application.eager_load!
   end
 
-  Hospital.checkup_all
+  p "start checkup" if verbose
+  Hospital.do_checkup_all verbose: verbose
 end

data/lib/hospital/version.rb

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

data/lib/hospital.rb

@@ -1,50 +1,86 @@
 # frozen_string_literal: true
 
+require "byebug"
 require_relative "hospital/version"
+require_relative "hospital/checkup"
+require_relative "hospital/checkup_group"
 require_relative "hospital/diagnosis"
+require_relative "hospital/formatter"
+
+using Formatter
 
 module Hospital
   require_relative 'railtie' if defined?(Rails)
 
   class Error < StandardError; end
 
-  @@checkups    = {}
-  @@diagnosises = {}
+  @@groups = []
 
-  def self.included(base)
-    raise Hospital::Error.new("Cannot include Hospital, please extend instead.")
-  end
+  class << self
 
-  def self.extended(base)
-    @@checkups[base] = -> (diagnosis) do
-      diagnosis.add_warning("#{base}: No checks defined! Please call checkup with a lambda.")
+    def included(klass)
+      raise Hospital::Error.new("Cannot include Hospital, please extend instead.")
     end
-    @@diagnosises[base] = Hospital::Diagnosis.new(base)
-  end
 
-  def checkup &code
-    @@checkups[self] = code
-  end
+    def do_checkup_all verbose: false
+      errcount  = 0
+      warcount  = 0
 
-  def self.checkup klass
-    @@diagnosises[klass].reset
-    @@checkups[klass].call(@@diagnosises[klass])
-    @@diagnosises[klass]
-  end
+      @@groups.each do |group|
+        puts group.header
+        group.run_checkups verbose: verbose
+
+        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.indented
+              diagnosis.put_results
+            elsif verbose
+              puts "Skipped #{diagnosis.name}.".h2.indented
+            end
+          end
+        end
+      end
 
-  def self.checkup_all
-    errcount = 0
-    @@checkups.keys.each do |klass|
-      checkup(klass)
-      diagnosis = @@diagnosises[klass]
-      diagnosis.put_results
-      errcount += diagnosis.errors.count
+      puts <<~END
+
+        #{"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, verbose: false)
+      @@groups.map(&:all_checkups).flatten.select{|cu| cu.klass == klass }.map do |cu|
+        cu.check verbose: verbose
+      end
     end
 
-    puts <<~END
+    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
+      checkup_group
+    end
+  end
+
+  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,
+      group:        group,
+      title:        title,
+      condition:    binding.local_variable_get('if'),
+      precondition: precondition
+    )
 
-      Summary:
-      Errors: #{errcount}
-    END
+    # p "adding #{checkup.inspect} to #{group}"
+    checkup_group.add_checkup checkup
   end
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: hospital
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Alexander
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-21 00:00:00.000000000 Z
-dependencies: []
+date: 2024-01-28 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,7 +49,10 @@ 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/tasks/checkup.rake
 - lib/hospital/version.rb
 - lib/railtie.rb