the_schema_is 0.0.4 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 054c02711e49163e9600e925da6c9bab7007b276528472834e3383326284f5c9
-  data.tar.gz: 837d5d1f3910505a3ac0e2aa4ff7742ff960555ed0edd27dfa2a7f7b7f75d996
+  metadata.gz: 4e9f1550133bd9ad6932e9940f55a7921b956a228dda93b14029e98d7d83d10b
+  data.tar.gz: 35903ce14ac034af1649d2a92be07f063fb1c224dcd48c92a8b4c696827b8968
 SHA512:
-  metadata.gz: 2042bfe76d1813cc7ad043b4947fa885162e4630e27d4bdb30b5ff961de77ad9fd9e01ae36d348ddf25fa55d63d58157cb0256d1ebad80ec7fd9246368201d60
-  data.tar.gz: da567e5da9f013be952177ce79d2ba6f2ed1431f342723360f660b0dda909d02a120ad9bcfd6dfa5d9b039e74948f005655151280e10c1dd3509af27b6897d2e
+  metadata.gz: 24b95d5aac99fbc31fc87b7fdf7254450a6cee7f862d155d1a7a0d7539e89b2b1b105016f6f245e6a40cd913edb3e20430d9f7fab46ba47964be289c1e436596
+  data.tar.gz: 652544c051f292ddaaf7cde3bd7ce4a68702590f6efe79eb7fd9196dec78b726cb1cb19ca206cf0e354bc11ccbfb189b3580e7ac91c353bdafc0150c2a6ebefc

data/Changelog.md

@@ -1,5 +1,16 @@
 # the-schema-is changes
 
+## 2024-12-22 - 0.0.6
+
+* Drop support for Ruby < 2.7;
+* Ensure support for all Ruby versions from 2.7 to 3.4-dev (replace memoist with memery);
+* Slightly update code with the new Rubocop.
+
+## 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

@@ -15,7 +15,7 @@ module TheSchemaIs
       extend RuboCop::AST::NodePattern::Macros
 
       class << self
-        extend Memoist
+        include Memery
 
         def search(pattern, node)
           search_methods[pattern].then { |m| instance.send(m, node) }
@@ -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
 
@@ -68,8 +70,7 @@ module TheSchemaIs
 
         Model.new(
           class_name: class_name,
-          table_name: table_name ||
-            table_prefix.+(ActiveSupport::Inflector.tableize(class_name)),
+          table_name: table_name || table_prefix + ActiveSupport::Inflector.tableize(class_name),
           source: definition_node,
           schema: schema_node,
           table_name_node: name_node&.first
@@ -95,6 +96,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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'memoist'
+require 'memery'
 require 'rubocop'
 require 'backports/latest'
 
@@ -15,13 +15,17 @@ 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
+      include Memery
+
+      memoize def fetch_schema(path, remove_definition_attrs: [])
+        Cops::Parser.schema(path, remove_definition_attrs: remove_definition_attrs)
+      end
     end
   end
 
   module Common
-    extend Memoist
+    include Memery
 
     def self.included(cls)
       cls.define_singleton_method(:badge) do
@@ -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
@@ -183,7 +189,7 @@ module TheSchemaIs
     def register_offense(_node)
       return if model.schema.nil? || schema.nil?
 
-      extra_columns.each do |_, col|
+      extra_columns.each_value do |col|
         add_offense(col.source, message: MSG % col.name) do |corrector|
           src_range = col.source.loc.expression
           end_pos = col.source.next_sibling.then { |n|

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.6
 platform: ruby
 authors:
 - Victor Shepelev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-16 00:00:00.000000000 Z
+date: 2024-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backports
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: memoist
+  name: memery
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -137,7 +137,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="