activerecord-data_integrity 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15651ea16d6fc6051e45163a15ff512472c440ee173e4c8c9acd9cf3e45e010f
-  data.tar.gz: 4badc1574b0c1c1329d1f0fdd14e10016a7097113cc6bf098751062d53f68cb3
+  metadata.gz: 4320a7b0ab38a21dea7e1e075970d577b02f9fc790efd8007e0c13aa67b8d7d6
+  data.tar.gz: 9622a1da1fefc7999ff66a4e2c35bac19423725add0253ce0e2e4a166cb09cd8
 SHA512:
-  metadata.gz: 698d90f68b8f72a07f2cbc3e5910d60418a3ac4a2aa881007ebccf5e656d3ee85c52d2140218a42396025cb79d782e6a36406b666ed22dfd6cacd4bbc1df0192
-  data.tar.gz: 41e5fd22054feeb45b1f53ce9df8d00a4d070dc944690d1e79b4c7f3a8e9c797956bb6e35c75c5bd26c5b0be44683a8da43680fc77516e41f49e4f19db46d819
+  metadata.gz: e08de321bc373ec869c0066334d508ac446d76acefbd93a0dc424741168cf98cb38d5c2ae5eb78efe3dae0b0d8aa1049e7057834bb602de4f8e49f62b714d84e
+  data.tar.gz: ff262e55e504360e6c67391d061d85b80652f82afd5be5df5723d4256a24239433f6216f50539435eba8e36a98f1910bdff392a4a91fb5638a260b2ff2bbf616

data/.rubocop.yml

@@ -12,3 +12,7 @@ AllCops:
 
 Metrics/LineLength:
   Max: 110
+
+Metrics/BlockLength:
+  Exclude:
+   - 'spec/**/*'

data/.travis.yml

@@ -12,7 +12,8 @@ script:
 deploy:
   provider: rubygems
   api_key:
-    secure: ILU6srwid/tAV00OmpcR4hpyTHO8TWK4C1wIYxmt+v0f/g8BuzsaZ/iXLM8aXWu7uRGeyp9jV0kA8Dg4KTCq4FlTazo3u2al7wm840h2KhB/mj/QxN8GBIr6hySQaouwRfzVRpVr7KBcHp10ElBd9GXhVm5v5V/j14RYW9wELqwQSyBnAjv2AI8InHJZE+tGnioqqSQHv7bM3fEnOMyd7BGwnvmVIQS2RbW+65i1r8iTFOrR+cpL1lg+q1Kbk0tr1ciEyg0kkNvZ/DUu8AxNMIlZlSdcNL73BN5a/CtJaAclSHbwEr2yGg3fFT61SR20/RmhE45v+crE8sKP+xGxhqkg+GL+LQQ5ouDuHi6r2tLOTMyeVUs402AWBth8dWyd1Xcvbho7owSLlUirYD8clD4Kh+XyfKMC1p4cjJiR4Id1F0089o12GcrwQebaYphnbrCYEtcoC8gts9p1fDiiY9ekrMfh8GcpYIHDmKbmpx79bCRk4Z45qdyOP206df2/pDEqLCEs5YoCP/rNpTi0ft1nRomlBPoX6ZeSrle9f3wbmp49Jrn/j3jENth24jkDpdE7D0Tr8nyGARTR/RG3K3XuXTTkCWQRynSM/CbitnLaRFv4+1ngQnpmiYOzHzcwSpMul9tLnQj3GeMXUawBs/OYD61NgG+FBczIQ295JO8=
+    secure: Q3gyExePLXgWljK9mibX9A2AJR0GMjDJVMLYzJ4hu0vdc6+QwOTFcsDgqdhpqoOfrIBAVT5Hp+ry7slmwB8YzLMvRvM8tft7NjB2kpZE03uitDE9uYoYM9cKnguLDf3B5djLHcEy3T1ujD4wziEeU+SvVyyk/1jb1kSBRu2o4foDdveo8IB5m/DLBkz3YUYUVPd+SlyJPiVTitTRYIO5T2esENhNQHCEro1DVbXUC3e3KHuE38Nwpl6rcm54KCwp8Ji3f6135/XETxhPFRF9L5K6pLwAh6lqxEibspI9bYVOpVfNhqKvjqOY/zn+FHCgSAFIDKU1UQjAsBbYQMpIizL9gow0jQU4z87wM47wvFdZHOPtNEOivqIyiOccFxDT+X5qmqRmUY4FDi3wAqze3WXJkUadpoNPzZ78Xcl2ZVnPKbFMY2Omp7d0ghHkI31WGePKVT37S47vZZeCNPYgfMEWthNJK0Rch6nAGZBnolQoQKB/3n0ue0b3ik0pYgQkrZv/aG/3Dy5Od3aAzI84lRI78AzitiChxNZX+3c8hKtWZteBwHncdxTSeAXf9cZY9c9s7ssJGFoe7DOAWeAU84DhhbCsJ1UL87wOvserpVpaTXVs8tdsP5WSVNUucwl4CE7ewJBwFJMhELVAhzanyCmjFhjc8F2Za9Kpm/xQ7EM=
   gem: activerecord-data_integrity
   on:
     tags: true
+    repo: dsalahutdinov/activerecord-data_integrity

data/README.md

@@ -4,7 +4,7 @@
 # ActiveRecord::DataIntegrity
 
 Checks your ActiveRecord models to match data integrity principles and rules.
-Out of the box it enforces many issues such as the lack of foreign keys.
+Out of the box it detects many issues such as the lack of foreign keys.
 
 ## Intallation
 ```ruby
@@ -29,12 +29,19 @@ Accordance/TablePresence: Stat::Hourly has no underlying table hourly_stats
 ...
 ```
 
+## Options
+
+Check only specified database rules:
+```
+  bundle exec data_integrity --only HasMany/ForeignKey,BelongsTo/ForeignKey
+```
+
 ## Supported Issues
 
 For now tool checks the following issues:
- - [x] The lack of database foreign keys for belongs_to/has_many associations
- - [x] The lack of not-null constraint for the columns with presence validation
- - [x] Inclusion validated colums should have `enum` data type
+ - [x] The lack of database foreign keys for belongs_to/has_many associations (`HasMany/ForeignKey` and `BelongsTo/ForeignKey` rule)
+ - [x] The lack of not-null constraint for the columns with presence validation (`Validation/Presence` rule)
+ - [x] Inclusion validated colums should have `enum` data type (`Validation/Inclusion` rule)
 
 ## Roadmap (TODO & Help Wanted)
 
@@ -42,14 +49,12 @@ For now tool checks the following issues:
  - [ ] presence of `dependend` option set for association and not confliction with underlying `ON DELETE` option of foreign key contraint
  - [ ] check for foreign keys to have bigint data type
  - [ ] presence of index for the foreign keys search
- - [ ] checks for paranoia models and indexes excludion "removed" rows
+ - [ ] checks for paranoia models and indexes exclusion "removed" rows
 
 2) Config for exluding some rules for the specific models (rubocop like)
 
 3) Autofix for the fixing the issue, mostly by generating safe migrations
 
-4) Possibility to run with checking only specific rule
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/activerecord-data_integrity.

data/exe/data_integrity

@@ -4,4 +4,4 @@
 require 'bundler/setup'
 require 'activerecord/data_integrity'
 
-ActiveRecord::DataIntegrity::CLI.new.run
+ActiveRecord::DataIntegrity::CLI.start(ARGV)

data/lib/active_record/data_integrity/cli.rb

@@ -1,12 +1,21 @@
 # frozen_string_literal: true
 
+require 'thor'
+require_relative 'options'
+
 module ActiveRecord
   module DataIntegrity
     # CLI application class
-    class CLI
-      def initialize; end
-
-      def run
+    class CLI < Thor
+      attr_reader :options
+
+      desc 'check [OPTIONS]', 'Runs the data integrity check'
+      method_option :only,
+                    type: :string,
+                    desc: 'List of the rules to check, separated with comma' \
+                          ', e.g. --only BelongsTo/ForeignKey,Accordance/PrimaryKey'
+      def check(_args = ARGV)
+        @options = Options.new(options)
         require_rails
 
         results = cops.map do |cop_class|
@@ -19,11 +28,22 @@ module ActiveRecord
 
         exit(1) if results.include?(false)
       end
+      default_task :check
+
+      desc 'version', 'Print the current version'
+      def version
+        puts ActiveRecord::DataIntegrity::VERSION
+      end
+      map %w[--version -v] => :version
 
       private
 
       def cops
-        @cops ||= ActiveRecord::DataIntegrity::Cop.descendants
+        @cops ||= begin
+          ActiveRecord::DataIntegrity::Cop.descendants.select do |cop|
+            options.only.empty? || cop.cop_name.in?(options.only)
+          end
+        end
       end
 
       def require_rails

data/lib/active_record/data_integrity/collector.rb

@@ -31,8 +31,8 @@ module ActiveRecord
 
         def group_data_by_cop_name
           data.each_with_object({}) do |item, hash|
-            hash[item[:cop].name] ||= []
-            hash[item[:cop].name] << item
+            hash[item[:cop].class.cop_name] ||= []
+            hash[item[:cop].class.cop_name] << item
           end
         end
       end

data/lib/active_record/data_integrity/cop/cop.rb

@@ -11,8 +11,8 @@ module ActiveRecord
         @model = model
       end
 
-      def name
-        self.class.name.gsub('ActiveRecord::DataIntegrity::', '').gsub('::', '/')
+      def self.cop_name
+        name.gsub('ActiveRecord::DataIntegrity::', '').gsub('::', '/')
       end
 
       def log(msg)
@@ -20,7 +20,10 @@ module ActiveRecord
       end
 
       def progress(subresult, false_char = 'E')
-        ActiveRecord::DataIntegrity::Collector.progress(self, subresult ? '.' : false_char)
+        ActiveRecord::DataIntegrity::Collector.progress(
+          self,
+          subresult ? Rainbow('.').green : Rainbow(false_char).red
+        )
       end
     end
   end

data/lib/active_record/data_integrity/options.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'optparse'
+
+module ActiveRecord
+  module DataIntegrity
+    # Options parser
+    class Options
+      def initialize(options)
+        @options = {
+          only: options.only? ? options[:only].to_s.split(',') : nil
+        }
+      end
+
+      def only
+        @options[:only] || []
+      end
+    end
+  end
+end

data/lib/active_record/data_integrity/version.rb

@@ -2,6 +2,6 @@
 
 module ActiveRecord
   module DataIntegrity
-    VERSION = '0.1.0'
+    VERSION = '0.2.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-data_integrity
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Salahutdinov Dmitry
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-16 00:00:00.000000000 Z
+date: 2018-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -198,6 +198,7 @@ files:
 - lib/active_record/data_integrity/cop/has_many/foreign_key.rb
 - lib/active_record/data_integrity/cop/validation/inclusion.rb
 - lib/active_record/data_integrity/cop/validation/presence.rb
+- lib/active_record/data_integrity/options.rb
 - lib/active_record/data_integrity/version.rb
 - lib/activerecord/data_integrity.rb
 homepage: https://github.com/dsalahutdinov/activerecord-data_integrity