valhammer 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99b18cba7d288d8e79e530a793fd4e6ee68e73fcce75b11d7c1f75425a0c112d
-  data.tar.gz: dc7099bf3d0230ea68958c6f5db7b2e740c8de83f7ff0484d3f93bbde2c6dff5
+  metadata.gz: 5a5c5adbed9b66cb80eb994a6d9595a56cbf1de28e0f105b5440687a53805c63
+  data.tar.gz: b94ce0e81bfe18c2ba9f85967aa29b0facc3433357694304189d8e1c9ce43d2d
 SHA512:
-  metadata.gz: 123317e5a6dcbb7e122ededd970645fb74500c2d2f7bfa8d33b811aa762a7aa647e501e65c85630ef1dbd91ab44cbff498b21651873ff57e94b153e2a60272f2
-  data.tar.gz: 810a0bc83526e3388c83a4e9f9296124b17e9660c55b377b7311a1dcefd4377e0b5119ebb2100e1a761b0fb727e984124336ecd52f7511387bf12abc4d3856eb
+  metadata.gz: 38d4db5e578d88ea9ad8f23a411a0a1edfa32366fdbbcc3ced400c6414750dfcb8d929b6ae29a9a46b898d2596217e1784c446eca8f1bf42c1feb818c58d2518
+  data.tar.gz: 83898470fcc987c4f81d71b2d302ff0f327dd19241b04bd3afd3bd45003bedcf3b22b898767a6ce28f73ae643c0fe9ad031529d58f334cf3899004405fedc8e4

data/README.md

@@ -264,6 +264,14 @@ end
 In this case, it is not possible for valhammer to determine the behaviour of the
 `where` clause, so the validation must be manually created.
 
+## Logging
+
+To make Valhammer tell you exactly what it's doing, turn on verbose mode:
+
+```ruby
+Valhammer.config.verbose = true
+```
+
 ## Contributing
 
 Refer to [GitHub Flow](https://guides.github.com/introduction/flow/) for

data/lib/valhammer/configuration.rb

@@ -0,0 +1,14 @@
+require 'singleton'
+
+module Valhammer
+  class Configuration
+    include Singleton
+
+    def initialize
+      @verbose = false
+    end
+
+    attr_accessor :verbose
+    alias verbose? verbose
+  end
+end

data/lib/valhammer/validations.rb

@@ -64,8 +64,6 @@ module Valhammer
     end
 
     def valhammer_validations(column, opts)
-      logger.debug("Valhammer generating options for #{valhammer_info(column)}")
-
       validations = {}
       valhammer_presence(validations, column, opts)
       valhammer_inclusion(validations, column, opts)
@@ -73,8 +71,10 @@ module Valhammer
       valhammer_numeric(validations, column, opts)
       valhammer_length(validations, column, opts)
 
-      logger.debug("Valhammer options for #{valhammer_log_key(column)} " \
-                   "are: #{validations.inspect}")
+      if Valhammer.config.verbose?
+        logger.debug("Valhammer options for #{valhammer_log_key(column)} " \
+                     "are: #{validations.inspect}")
+      end
       validations
     end
 

data/lib/valhammer/version.rb

@@ -1,3 +1,3 @@
 module Valhammer
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.1.0'.freeze
 end

data/lib/valhammer.rb

@@ -1,7 +1,10 @@
 require 'valhammer/version'
+require 'valhammer/configuration'
+require 'valhammer/validations'
+require 'valhammer/railtie' if defined?(Rails::Railtie)
 
 module Valhammer
+  def self.config
+    Configuration.instance
+  end
 end
-
-require 'valhammer/validations'
-require 'valhammer/railtie' if defined?(Rails::Railtie)

data/spec/lib/valhammer/validations_spec.rb

@@ -291,6 +291,58 @@ RSpec.describe Valhammer::Validations do
     end
   end
 
+  describe 'logging' do
+    before do
+      hammerable =
+        Class.new(ActiveRecord::Base) do
+          self.table_name = :organisations
+        end
+
+      def self.logger
+        # Hook for specs to spy on log output
+      end
+
+      stub_const 'Hammerable', hammerable
+    end
+
+    context 'when verbose' do
+      around do |example|
+        Valhammer.config.verbose = true
+        example.run
+      ensure
+        Valhammer.config.verbose = false
+      end
+
+      it 'logs information about validations' do
+        logger = spy(:debug)
+        allow(Hammerable).to receive(:logger).and_return(logger)
+
+        Hammerable.valhammer
+
+        expect(logger).to have_received(:debug).with(
+          'Valhammer options for `organisations`.`name` are: {:presence=>true}'
+        )
+        expect(logger).to have_received(:debug).with(
+          'Valhammer options for `organisations`.`country` are: {:presence=>true}'
+        )
+        expect(logger).to have_received(:debug).with(
+          'Valhammer options for `organisations`.`city` are: {:presence=>true}'
+        )
+      end
+    end
+
+    context 'when quiet' do
+      it 'does not log' do
+        logger = spy(:debug)
+        allow(Hammerable).to receive(:logger).and_return(logger)
+
+        Hammerable.valhammer
+
+        expect(logger).not_to have_received(:debug)
+      end
+    end
+  end
+
   context 'sanity check' do
     let(:organisation) do
       Organisation.create!(name: 'Enhanced Collaborative Methodologies Pty Ltd',

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: valhammer
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Shaun Mangelsdorf
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-12-12 00:00:00.000000000 Z
+date: 2023-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -192,7 +192,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - s.mangelsdorf@gmail.com
 executables: []
@@ -209,6 +209,7 @@ files:
 - README.md
 - Rakefile
 - lib/valhammer.rb
+- lib/valhammer/configuration.rb
 - lib/valhammer/railtie.rb
 - lib/valhammer/validations.rb
 - lib/valhammer/version.rb
@@ -229,7 +230,7 @@ homepage: https://github.com/ausaccessfed/valhammer
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -244,8 +245,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Automatically validate ActiveRecord models based on the database schema.
 test_files: