the_schema_is 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 054c02711e49163e9600e925da6c9bab7007b276528472834e3383326284f5c9
-  data.tar.gz: 837d5d1f3910505a3ac0e2aa4ff7742ff960555ed0edd27dfa2a7f7b7f75d996
+  metadata.gz: 8735d476459a14d53240641bec87d03d7dbcd7bd5d3c8508135bde7739a04e80
+  data.tar.gz: 5cb9c6f68830db4c556aabe538611f448c581fd2c94efb15bf6eda0c0ce04511
 SHA512:
-  metadata.gz: 2042bfe76d1813cc7ad043b4947fa885162e4630e27d4bdb30b5ff961de77ad9fd9e01ae36d348ddf25fa55d63d58157cb0256d1ebad80ec7fd9246368201d60
-  data.tar.gz: da567e5da9f013be952177ce79d2ba6f2ed1431f342723360f660b0dda909d02a120ad9bcfd6dfa5d9b039e74948f005655151280e10c1dd3509af27b6897d2e
+  metadata.gz: c4ad68960b63c360ec9becc3f733e157a6547d55e318b7de37ac9d9ff3f872c436a07729759eeba126613fb812a291f7b76a1b782fa83a82c85977e91f066493
+  data.tar.gz: c37d853e5dfbb790264e146cd07849e959880b46559a92e5b578036b0cb906de4a4db74d4d744c4b8013763782c67f5bb0592f8bd2bb22ed702348ab42fdb1b3

data/Changelog.md

@@ -1,5 +1,10 @@
 # the-schema-is changes
 
+## 2021-11-04 - 0.0.5
+
+* Support `enum` column type;
+* Add `RemoveDefinitions` config key for leaner `the_schema_is` definitions (avoiding huge index descriptions in models).
+
 ## 2021-09-15 - 0.0.4
 
 * Get rid of [Fast](https://jonatas.github.io/fast/) dependency. It is cool, but we switched to use Rubocop's own `NodePattern` to lessen the dependency burden (Fast was depending on [astrolabe](https://github.com/yujinakayama/astrolabe) which wasn't updated in 6 years, locking parser dependency to old version and making Fast incompatible with newer Rubocop);

data/README.md

@@ -134,8 +134,9 @@ TheSchemaIs:
 Currently available settings are:
 
 * `TablePrefix` to help `the_schema_is` deduce table name from class name;
-* `Schema` to set path to schema (by default `db/schema.rb`)
-* `BaseClass` to help `the_schema_is` guess what is a model class (by default `ApplicationRecord` and `ActiveRecord::Base`).
+* `Schema` to set path to schema (by default `db/schema.rb`);
+* `BaseClass` to help `the_schema_is` guess what is a model class (by default `ApplicationRecord` and `ActiveRecord::Base`);
+* `RemoveDefinitions`: list of definition keys to remove (for example, `[index, foreign_key, limit]`) when copying definitions into models; this might be desirable for leaner `the_schema_is` statements, displaying only field types/names.
 
 So, if you have your custom-named base class, you should do:
 

data/config/defaults.yml

@@ -6,6 +6,7 @@ TheSchemaIs:
   Schema: db/schema.rb
   BaseClass: ['ActiveRecord::Base', 'ApplicationRecord']
   TablePrefix: ''
+  RemoveDefinitions: []
 
 TheSchemaIs/Presence:
    Description: "Check presence of the_schema_is statement in ActiveRecord models"

data/lib/the_schema_is/cops/node_util.rb

@@ -66,7 +66,7 @@ module TheSchemaIs
         end
 
         def find_parent(type)
-          Enumerator.produce(parent, &:parent).slice_after { |n| n && n.type == type }.first.last
+          Enumerator.produce(parent, &:parent).find { |n| n && n.type == type }
         end
       end
     end

data/lib/the_schema_is/cops/parser.rb

@@ -15,7 +15,7 @@ module TheSchemaIs
                                  float integer json string text time timestamp virtual].freeze
       POSTGRES_COLUMN_TYPES = %i[jsonb inet cidr macaddr hstore uuid].freeze
 
-      COLUMN_DEFS = (STANDARD_COLUMN_TYPES + POSTGRES_COLUMN_TYPES + %i[column]).freeze
+      COLUMN_DEFS = (STANDARD_COLUMN_TYPES + POSTGRES_COLUMN_TYPES + %i[enum column]).freeze
 
       Model = Struct.new(:class_name, :table_name, :source, :schema, :table_name_node,
                          keyword_init: true)
@@ -33,9 +33,11 @@ module TheSchemaIs
         RuboCop::AST::ProcessedSource.new(code, 2.7).ast
       end
 
-      def self.schema(path)
+      def self.schema(path, remove_definition_attrs: [])
         ast = parse(File.read(path))
 
+        ast = remove_attributes(ast, remove_definition_attrs) unless remove_definition_attrs.empty?
+
         ast.ast_search('(block (send nil? :create_table (str $_) _) _ $_)').to_h
       end
 
@@ -95,6 +97,29 @@ module TheSchemaIs
           end
         }.compact
       end
+
+      # Removes unnecessary column definitions from further comparison, using schema source tree editing
+      def self.remove_attributes(ast, attrs_to_remove)
+        buf = ast.loc.expression.source_buffer
+        src = buf.source
+        rewriter = ::Parser::Source::TreeRewriter.new(buf)
+
+        # FIXME: Two nested cycles can be simplifid to just look for column definition, probably
+        ast.ast_search('(block (send nil? :create_table (str _) _) _ $_)').each do |table_def|
+          table_def.children.each do |col|
+            dfn = col.children[3] or next
+            dfn.children
+               .select { |c| attrs_to_remove.include?(c.children[0].children[0]) }
+               .each do |c|
+              prev_comma = c.source_range.begin_pos.step(by: -1).find { |pos| src[pos] == ',' }
+              range = ::Parser::Source::Range.new(buf, prev_comma, c.source_range.end_pos)
+              rewriter.remove(range)
+            end
+          end
+        end
+
+        RuboCop::AST::ProcessedSource.new(rewriter.process, 2.7).ast
+      end
     end
   end
 end

data/lib/the_schema_is/cops.rb

@@ -15,8 +15,12 @@ module TheSchemaIs
   using Cops::NodeRefinements
 
   module Cops
-    def self.schema_cache
-      @schema_cache ||= Hash.new { |h, path| h[path] = Cops::Parser.schema(path) }
+    class << self
+      extend Memoist
+
+      memoize def fetch_schema(path, remove_definition_attrs: [])
+        Cops::Parser.schema(path, remove_definition_attrs: remove_definition_attrs)
+      end
     end
   end
 
@@ -59,7 +63,9 @@ module TheSchemaIs
     end
 
     memoize def schema
-      Cops.schema_cache.dig(schema_path, model.table_name)
+      attrs_to_remove = cop_config['RemoveDefinitions']&.map(&:to_sym) || []
+      # It is OK if it returns Nil, just will be handled by "schema is absent" cop
+      Cops.fetch_schema(schema_path, remove_definition_attrs: attrs_to_remove)[model.table_name]
     end
 
     memoize def model_columns

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: the_schema_is
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Victor Shepelev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-16 00:00:00.000000000 Z
+date: 2021-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backports