valid_items 0.0.4 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0bcd92760474c26d012a5c31b37cb539f12c7cdbd15f962551fc9d56a66bb8bc
-  data.tar.gz: 24b7f731c030a5aa187b0d9ab3f84a848fb351c72ea120a42eb2ef38939cfe71
+  metadata.gz: a86c46b0ac4d5908b47494c3a1d56070157c43f7ad2e871a6846193da52a8c1c
+  data.tar.gz: 684cdc601ddf2974c4725ed1aaeba621fb63ca5fad31ec48ef5a6cd7181c0d51
 SHA512:
-  metadata.gz: 2a8f7e5c1cac64cbfdf83f2443ff3069728c5347176a2a427603559968ca67b9273e5d48abfa2e34b2163dac1672e3b8206e8cce1187f4e2e611386a872f57bd
-  data.tar.gz: 3dd1b927af42e8452251da7b19ccce00d8afb5ebf599fc1bfb69c045e1b47fcd10174db53c70202fe2441e5da18375e0e496662907063d8993e5828c325ea0c8
+  metadata.gz: 5ba4d8a619009657fafc8e5acf75125d65d97a3bb45a378ed9123515a6529ab8292be6b4a70042f9e8df50faba359c31f4c2629c54501dd220a0692368b81f9c
+  data.tar.gz: 25c4db1b95ae4cb455c9914d84d8a3846010d7f85a4910afa99f77c12f5012bfd476402bc86318d0e75c1f115855917b01f0266dd5e02232d19f8c2c4868144d

data/.gitignore

@@ -0,0 +1,55 @@
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+developer.md
+# bundler
+.bundle
+Gemfile.lock
+Gemfile.local
+*.gem
+# rbenv
+.ruby-version
+
+
+# jeweler generated
+pkg
+
+# etags
+TAGS
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore:
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+
+# For TextMate
+#*.tmproj
+#tmtags
+
+# For emacs:
+#*~
+#\#*
+#.\#*
+
+# For vim:
+*.swp
+
+# For redcar:
+#.redcar
+
+# For rubinius:
+#*.rbc

data/README.md

@@ -0,0 +1,58 @@
+Valid Items
+=================
+
+Goes through all your Rails ActiveRecord objects and check if they are all still pass your model validations. You may have added new validations to your model since creating your object, or ran update_column in your console to solve a production issue.
+Inspired by a RailsConf talk by Ryan Laughlin and his talk at http://www.rofreg.com/talks/railsconf2018'
+
+
+Installation
+------------
+**ValidItem**'s installation is pretty standard:
+
+```sh
+$ gem install valid_items
+```
+
+If you'd rather install **ValidItem** using `bundler`, don't require it in your `Gemfile`:
+
+```rb
+gem 'valid_items', require: false
+```
+
+
+Example usage
+-------------
+
+```ruby
+require 'valid_items'
+ValidItems.checkup
+ => User id 203: {:name=>["can't be blank"]}
+```
+
+```ruby
+require 'valid_items'
+ValidItems.checkup(email: 'example@example.com')
+ => User id 203: {:name=>["can't be blank"]}  
+# and an email gets sent
+```
+
+```ruby
+require 'valid_items'
+ValidItems.checkup(updated_at: 1.day.ago)
+ => 'ok'
+```
+
+
+```
+Arguments:
+ email: (String)
+ updated_at: (ActiveSupport::TimeWithZone)
+```
+
+Running in development
+----------------------
+Eager Load is required on development, so that valid_items can query all AR models
+```
+Rails.application.eager_load!
+```
+You must have upgraded your Rails app so that all your models inherit from ApplicationRecord rather than ActiveRecord::Base.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc 'Run tests'
+task default: :test

data/VERSION

@@ -0,0 +1 @@
+0.0.11

data/lib/valid_items.rb

@@ -1,23 +1,28 @@
-require 'active_record'
-class ApplicationRecord < ActiveRecord::Base
-  self.abstract_class = true
+# frozen_string_literal: true
+require 'rails/all'
+
+unless Object.const_defined?('ApplicationRecord')
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
 end
+
 class ValidItems
   # Check that all your ActiveRecord Objects are still valid
   #
   # Example:
   #   >> ValidItems.checkup()
   #   => User id 203: {:name=>["can't be blank"]}
-  #   >> ValidItems.checkup(email_report: 'example@example.com')
+  #   >> ValidItems.checkup(email: 'example@example.com')
   #   => User id 203: {:name=>["can't be blank"]}  and an email gets sent
   #   >> ValidItems.checkup(updated_at: 1.day.ago)
   #   => User id 203: {:name=>["can't be blank"]}
   #      Just want to check recent changes, in case of a large db
   #
   # Arguments:
-  #   email_report: (String)
+  #   email: (String)
   #   updated_at: (ActiveSupport::TimeWithZone)
-  def self.checkup(email_report: nil, updated_at: 100.years.ago)
+  def self.checkup(email: nil, updated_at: 100.years.ago)
     issues = []
     ApplicationRecord.descendants.collect(&:name).each do |model|
       model.constantize.where('updated_at > ?', updated_at).find_each do |item|
@@ -26,9 +31,13 @@ class ValidItems
     end
     return 'ok' if issues.blank?
 
-    if email_report.present?
-      mail(to: email_report,
-           subject: 'DB Issues Discovered')
+    if email.present?
+      ActionMailer::Base.mail(
+        from: email,
+        to: email,
+        subject: "DB Issues Discovered in #{Rails.env}",
+        body: issues.join("\r\n")
+      ).deliver
     end
     puts issues
   end

data/valid_items.gemspec

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+version = File.read('VERSION').strip
+
+Gem::Specification.new do |s|
+  s.name        = 'valid_items'
+  s.version     = version
+  s.date        = '2018-05-31'
+  s.summary     = 'Check that all your Rails ActiveRecord Objects still pass their model validations'
+  s.description = 'Goes through all your Rails ActiveRecord objects and check if they are all still pass your model validations. You may have added new validations to your model since creating your object, or ran update_column in your console to solve a production issue. Find issues in your db before others do. Inspired by a RailsConf talk by Ryan Laughlin and his talk at http://www.rofreg.com/talks/railsconf2018'
+  s.authors     = ['Vinny Glennon']
+  s.email       = 'vinnyglennon@gmail.com'
+  s.platform    = Gem::Platform::RUBY
+  s.files       = `git ls-files`.split($/)
+  s.test_files = s.files.grep(%r{^(test)/})
+  s.homepage = 'http://rubygems.org/gems/valid_items'
+  s.require_paths = ["lib"]
+  s.license = 'MIT'
+  s.required_ruby_version = '>= 1.9'
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+  s.add_development_dependency 'rake', '~> 12.0'
+  s.add_development_dependency 'rubocop', '~> 0.50.0'
+  s.add_dependency 'rails', '>= 5', '< 6.0'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: valid_items
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.11
 platform: ruby
 authors:
 - Vinny Glennon
@@ -39,12 +39,12 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.50.0
 - !ruby/object:Gem::Dependency
-  name: actionmailer
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '5'
     - - "<"
       - !ruby/object:Gem::Version
         version: '6.0'
@@ -52,29 +52,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6.0'
-- !ruby/object:Gem::Dependency
-  name: activerecord
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: '4.1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '5'
     - - "<"
       - !ruby/object:Gem::Version
         version: '6.0'
@@ -88,8 +68,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- README.md
+- Rakefile
+- VERSION
 - lib/valid_items.rb
 - test/test_valid_items.rb
+- valid_items.gemspec
 homepage: http://rubygems.org/gems/valid_items
 licenses:
 - MIT