mensa 0.7.0 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 064c836f400dd147fc8fde3fb1f38a49f7bd447c44e6d7493c055cd6dede6b19
-  data.tar.gz: b6fdbbdce0951fb43fdfd8f574cf6888ebe1c9f4e369752f4a497de85ca8b8f4
+  metadata.gz: ca5c6f3fab08895527058f4cbb70a55608297da85a234c2476d120be6de13882
+  data.tar.gz: f09da64e3c8dfaaf1917e1097845171aa29fab13c18285d3802278d5a7d8bfc9
 SHA512:
-  metadata.gz: f96aca8ee7039304c3292456e0be10722faba2eecac2ba41030f632317998bbf0d1e4d3f649f5a46d675a4d06268dae07d216e536b80294c4990c805160df0b3
-  data.tar.gz: f629a69b4a6177d8aedc58f931fa00d328af953dca50cfd80c282989c40fd2434e2e655b5c1f55611568f893d016b5467b16c2925e8fff293b977be9f53d36fc
+  metadata.gz: 2f9ff2a45fd5d5784a31ee7e96d45b683bc16aecb53947eb6a942f5764d175fcbbc16303103ad3c46f71a571da8c5a8b5e8af9fa82000fdd8bbd025694108263
+  data.tar.gz: 9948a29ea8daee96c71466b33d3e63e4a7dd20496247edf36740c779cf2b2743fbfdedf92f03a391abe5d43544aa32f25825b340b6fb8a8f471bb66432107dda

data/.shipkit.yml

@@ -1,2 +1,2 @@
 ---
-previous_version: 0.6.19
+previous_version: 0.7.1

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 0.7.2
+
+- The verifier's report only lists failures and warnings. `-v`/`--verbose` (or
+  `VERBOSE=1`) on the rake tasks, or `result.to_s(verbose: true)`, lists every
+  check, and the classes in `app/tables` that were skipped as they aren't Mensa
+  tables.
+
 ## 0.7.0
 
 - Filters only offer the operators that work for the column's type in SQL,

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mensa (0.6.19)
+    mensa (0.7.1)
       csv
       importmap-rails
       pagy (>= 43)

data/README.md

@@ -4,7 +4,8 @@ Fast and awesome tables, with pagination, sorting, filtering, batch processing,
 Due to search, it only works with postgresql at the moment.
 
 ![table](./docs/table.png)
-![filters](./docs/filters.png)
+![filters](./docs/filters1.png)
+![filters value](./docs/filters2.png)
 ![columns](./docs/columns.png)
 ![export](./docs/export.png)
 
@@ -448,9 +449,16 @@ bin/rails "mensa:verify[inventories]"   # or InventoriesTable
 bin/rails mensa:verify_all              # every table in app/tables
 ```
 
-The tasks print a report (✓ passed, ✗ failed with the error and SQL, - skipped) and
-exit non-zero when a check failed. Classes and modules that don't descend from
-`Mensa::Base` (e.g. helpers in `app/tables`) are reported as skipped.
+The tasks print a report of the failures (✗, with the error and SQL) and warnings (!)
+and exit non-zero when a check failed. Add `-v`/`--verbose` (or `VERBOSE=1`) to list
+every check (✓ passed, - skipped):
+
+```sh
+bin/rails "mensa:verify[inventories]" -v
+```
+
+Classes and modules that don't descend from `Mensa::Base` (e.g. helpers in
+`app/tables`) are skipped, and only reported as such with `-v`.
 
 #### From tests
 
@@ -504,11 +512,7 @@ end
 
 ## Contributing
 
-```
 Contribution directions go here.
 
-
-
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-```

data/lib/mensa/verifier/result.rb

@@ -92,12 +92,14 @@ module Mensa
         [table_class.name || table_class.to_s, ("(#{label})" if label)].compact.join(" ")
       end
 
-      def to_s
+      # Lists the failures and warnings, +verbose+ lists every check
+      def to_s(verbose: false)
         return "#{title}\n  - skipped: #{checks.first&.message}" unless mensa_table?
 
         lines = [title]
+        shown = verbose ? checks : checks.select { |check| check.failed? || check.warning? }
 
-        checks.group_by(&:section).each do |section, section_checks|
+        shown.group_by(&:section).each do |section, section_checks|
           lines << "  #{SECTIONS.fetch(section, section.to_s.humanize)}"
           section_checks.each do |check|
             lines << "    #{SYMBOLS[check.status]} #{check.label}#{" (skipped: #{check.message})" if check.skipped?}"

data/lib/mensa/verifier.rb

@@ -94,19 +94,24 @@ module Mensa
       # their reports to +io+ and returns true when all of them passed.
       # Context comes from USER_ID, ACCOUNT_ID and PARAMS (JSON) in +env+, and
       # STRICT=1 makes warnings fail, used by the mensa:verify rake tasks.
-      def run(tables = nil, env: ENV, io: $stdout)
+      # The reports list failures and warnings, +verbose+ (or VERBOSE=1) lists
+      # every check and the classes skipped as they aren't Mensa tables.
+      def run(tables = nil, env: ENV, io: $stdout, verbose: false)
         classes = tables.present? ? Array(tables).map { |table| resolve_table_class(table) } : table_classes
         options = options_from_env(env)
+        verbose ||= %w[1 true yes].include?(env["VERBOSE"].to_s.downcase)
 
         results = classes.flat_map do |klass|
-          verify(klass, **options).each { |result| io.puts(result, "") }
+          verify(klass, **options).each do |result|
+            io.puts(result.to_s(verbose: verbose), "") if verbose || result.mensa_table?
+          end
         end
 
         by_table = results.select(&:mensa_table?).group_by(&:table_class)
         others = results.reject(&:mensa_table?)
-        if results.size > 1
+        if by_table.size > 1 || (verbose && results.size > 1)
           passed = by_table.count { |_table, table_results| table_results.all?(&:success?) }
-          io.puts ["#{passed}/#{by_table.size} tables passed", ("#{others.size} skipped, not a Mensa::Base subclass" if others.any?)].compact.join(", ")
+          io.puts ["#{passed}/#{by_table.size} tables passed", ("#{others.size} skipped, not a Mensa::Base subclass" if verbose && others.any?)].compact.join(", ")
         end
         results.all?(&:success?)
       end

data/lib/mensa/version.rb

@@ -1,3 +1,3 @@
 module Mensa
-  VERSION = "0.7.0"
+  VERSION = "0.7.2"
 end

data/lib/tasks/mensa.rake

@@ -1,13 +1,16 @@
 namespace :mensa do
-  desc "Verify a Mensa table against the database, e.g. mensa:verify[users] (context: USER_ID=, ACCOUNT_ID=, PARAMS='{...}', STRICT=1 fails on warnings)"
+  # -v/--verbose sets Rake.verbose to true, it's a default object otherwise
+  verbose = -> { Rake.verbose == true }
+
+  desc "Verify a Mensa table against the database, e.g. mensa:verify[users] (context: USER_ID=, ACCOUNT_ID=, PARAMS='{...}', STRICT=1 fails on warnings, -v or VERBOSE=1 lists every check)"
   task :verify, [:table] => :environment do |_task, args|
     abort "Usage: bin/rails \"mensa:verify[table_name]\"" if args[:table].blank?
 
-    exit(1) unless Mensa::Verifier.run(args[:table])
+    exit(1) unless Mensa::Verifier.run(args[:table], verbose: verbose.call)
   end
 
-  desc "Verify all Mensa tables in app/tables against the database (context: USER_ID=, ACCOUNT_ID=, PARAMS='{...}', STRICT=1 fails on warnings)"
+  desc "Verify all Mensa tables in app/tables against the database (context: USER_ID=, ACCOUNT_ID=, PARAMS='{...}', STRICT=1 fails on warnings, -v or VERBOSE=1 lists every check)"
   task verify_all: :environment do
-    exit(1) unless Mensa::Verifier.run
+    exit(1) unless Mensa::Verifier.run(verbose: verbose.call)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mensa
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.2
 platform: ruby
 authors:
 - Tom de Grunt
@@ -314,6 +314,8 @@ files:
 - docs/columns.png
 - docs/export.png
 - docs/filters.png
+- docs/filters1.png
+- docs/filters2.png
 - docs/table.png
 - lib/generators/mensa/install_generator.rb
 - lib/generators/mensa/table_generator.rb