whiny_validation 0.1.1 → 1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 32bde23dcbbaca5f53ebc41921b9d92cdde6f15e
-  data.tar.gz: 0f70d8c5fd63b0b8f50bb4da96db370d38d84a77
+SHA256:
+  metadata.gz: 29b7d8158ea77148918fbe3190467de13a42fc6f8f6f982beac6918a3ff38521
+  data.tar.gz: c5547fa0749947d4a4f9d66ed1f3d5fffd444cf3fd58daca8d7d1e3dae451946
 SHA512:
-  metadata.gz: eb51c01721b684a7b130460d05d83dc0828fb95cc3c0db5018c8639010db864804212339619dc6c700145c2441beded541b760550b343697550364749dcbbc28
-  data.tar.gz: c24c6ee244ca83d0a095869e23886ca00260d2832e501e2bf1c26641ebdc075db302d08867da050f9da636e6644ff21af3614061308bcf6a748007dea51313ac
+  metadata.gz: 3d78905e6eeaf4b159dd248bf4a1497193d6dbd40961598b27f5b7ad97ef798146b37bf5202475566d8cfee43c1c3ef9f9b6130e308217f75fc46b2bee44d58e
+  data.tar.gz: 6dbac61f0b98fadcc58f00afb5290167a05087251aaf4d8871b88cf94ca18d396b5c094e332cd946ad3b4c1a20e442379e351883eb0e5ca27ad88bd4fb9833d5

data/README.md

@@ -6,10 +6,10 @@ to figure it out.
 
 WhinyValidation to the rescue.
 
-When an ActiveRecord model won't save because it's invalid,
+When an ActiveRecord/ActiveModel model won't save because it's invalid,
 this gem writes the validation error messages to the log.
 
-The log shows all the attributes of the ActiveRecord object
+The log shows all the attributes of the ActiveRecord/ActiveModel object
 that failed, along with the error message.
 
 Validation errors are shown in an attractive yellow, which
@@ -18,11 +18,14 @@ stands out nicely if your terminal background is dark.
 It can be useful in development and especially in test mode,
 to understand why a model didn't save.
 
+[Read more in this blog
+post on I Like Stuff.](http://ilikestuffblog.com/2014/04/09/whiny-validation/)
+
 ![Whiny Validation](whiny_validation.gif)
 
 ## Compatibility
 
-Ruby 1.9.3 and above.
+Ruby 2.0 and above.
 
 Rails 3.2 and above.
 
@@ -63,6 +66,31 @@ end
 
 Quit your whining.
 
+## FAQ
+
+**Q**: I use Test::Unit because I hate RSpec. Does it work with Test::Unit?<br>
+**A**: Yes. Quit your whining.
+
+**Q**: I use RSpec because I hate Test::Unit. Does it work with RSpec?<br>
+**A**: Yes. Quit your whining.
+
+**Q**: I use ...<br>
+**A**: Yes. It is independent of the test framework you use. Quit your whining.
+
+**Q**: I use ActiveModel but not ActiveRecord. Can I use this gem?<br>
+**A**: Yes. Now the gem works with any ActiveModel-compatible
+    framework. Quit your whining.
+
+**Q**: Why not log to the console in addition to the log file? That would make it more obvious that a test is failing.<br>
+**A**: Because some tests intentionally pass invalid input. You wouldn't want to see those in the console. Quit your whining.
+
+**Q**: Why not raise an error in tests when input is invalid? That would make it more obvious that a test is failing.<br>
+**A**: See previous answer. Quit your whining.
+
+**Q**: I don't want to see validation errors in my production log. Users make mistakes and that shouldn't go in my log.<br>
+**A**: This gem logs at the `debug` level by default. If you're using `debug` in production and still don't want to see
+   this gem's output, put it in a group in your Gemfile. Quit your whining.
+
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -1,2 +1,11 @@
 #!/usr/bin/env rake
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+task :default => :test
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = Dir.glob(File.dirname(__FILE__) + '/test/**/*_test.rb').sort
+  t.warning = true
+  t.verbose = true
+end

data/lib/whiny_validation/version.rb

@@ -1,3 +1,3 @@
 module WhinyValidation
-  VERSION = "0.1.1"
+  VERSION = "1.1"
 end

data/lib/whiny_validation.rb

@@ -1,3 +1,6 @@
+require "active_support/concern"
+require "active_support/notifications"
+require "active_support/log_subscriber"
 require "whiny_validation/version"
 require "whiny_validation/configuration"
 
@@ -15,9 +18,17 @@ module WhinyValidation
   end
 
   class LogSubscriber < ActiveSupport::LogSubscriber
+    def color_mode_options
+      if ActiveSupport.gem_version < Gem::Version.new("7.1.0")
+        true
+      else
+        { bold: true }
+      end
+    end
+
     def validation_failed(event)
       send(WhinyValidation.configuration.log_level) do
-        name = color("Validation failed", YELLOW, true)
+        name = color("Validation failed", YELLOW, color_mode_options)
         object = event.payload[:object]
         error_messages = color(event.payload[:error_messages].map{|message|"    => #{message}"}.join("\n"), YELLOW)
 
@@ -29,8 +40,10 @@ module WhinyValidation
   WhinyValidation::LogSubscriber.attach_to :whiny_validation
 end
 
-module ActiveRecord
-  class Base
-    include WhinyValidation
+if defined?(ActiveRecord)
+  # ActiveRecord is dependent on ActiveSupport so we are good
+  # with calling ActiveSupport
+  ActiveSupport.on_load(:active_record) do
+    ActiveRecord::Base.send(:include, WhinyValidation)
   end
 end

data/test/simple_test.rb

@@ -0,0 +1,35 @@
+require 'test_helper'
+
+class WhinyValidationTest < ActiveSupport::TestCase
+  class Person
+    include ActiveModel::Model
+    include ActiveModel::Validations::Callbacks
+    include WhinyValidation
+
+    attr_accessor :name
+    validates_presence_of :name
+  end
+
+  setup do
+    @io = StringIO.new
+    ActiveSupport::LogSubscriber.logger = Logger.new @io
+  end
+
+  test "logging via Notifications" do
+    ActiveSupport::Notifications.subscribe do |*args|
+      payload = args.last
+      assert_equal payload[:error_messages], payload[:object].errors.full_messages
+    end
+
+    person.valid?
+  end
+
+  test "logging via LogSubscriber" do
+    person.valid?
+    assert @io.string.include? "Name can't be blank"
+  end
+
+  def person
+    Person.new
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+require 'bundler/setup'
+Bundler.require :default
+require 'minitest'
+require 'minitest/mock'
+require 'active_model'
+require 'active_support/test_case'
+require 'active_support/testing/autorun'
+require 'logger'
+require 'stringio'
+
+require 'whiny_validation'

data/whiny_validation.gemspec

@@ -4,8 +4,8 @@ require File.expand_path('../lib/whiny_validation/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.authors       = ["Brian Morearty"]
   gem.email         = ["brian@morearty.org"]
-  gem.description   = %q{When an ActiveRecord model won't save because it's invalid, this gem writes the validation error messages to the log.}
-  gem.summary       = %q{Write ActiveRecord validation error messages to the log}
+  gem.description   = %q{When an ActiveRecord/ActiveModel model won't save because it's invalid, this gem writes the validation error messages to the log.}
+  gem.summary       = %q{Write ActiveRecord/ActiveModel validation error messages to the log}
   gem.homepage      = "https://github.com/BMorearty/whiny_validation"
 
   gem.files         = `git ls-files`.split($\)
@@ -16,7 +16,10 @@ Gem::Specification.new do |gem|
   gem.version       = WhinyValidation::VERSION
 
   gem.add_dependency 'activesupport'
-  gem.add_dependency 'activerecord'
+  gem.add_dependency 'activemodel'
 
   gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'activerecord'
+  gem.add_development_dependency 'minitest'
+  gem.add_development_dependency 'pry-byebug'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: whiny_validation
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: '1.1'
 platform: ruby
 authors:
 - Brian Morearty
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-04-09 00:00:00.000000000 Z
+date: 2023-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -52,8 +52,50 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: When an ActiveRecord model won't save because it's invalid, this gem
-  writes the validation error messages to the log.
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: When an ActiveRecord/ActiveModel model won't save because it's invalid,
+  this gem writes the validation error messages to the log.
 email:
 - brian@morearty.org
 executables: []
@@ -68,12 +110,14 @@ files:
 - lib/whiny_validation.rb
 - lib/whiny_validation/configuration.rb
 - lib/whiny_validation/version.rb
+- test/simple_test.rb
+- test/test_helper.rb
 - whiny_validation.gemspec
 - whiny_validation.gif
 homepage: https://github.com/BMorearty/whiny_validation
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -88,9 +132,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
-summary: Write ActiveRecord validation error messages to the log
-test_files: []
+summary: Write ActiveRecord/ActiveModel validation error messages to the log
+test_files:
+- test/simple_test.rb
+- test/test_helper.rb