smart_ignored_columns 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c67e99e40687eaadf166a0e4c4815f1dedd1c463f9cd62378c6fe260e5510906
+  data.tar.gz: 0d8bca5ce9a22239dd199d174972cd4654b0e3c3100280bdc69c618b596fb71c
+SHA512:
+  metadata.gz: e7a29f49845c5b522708f6d084899fd1795be5ba65c26af296672ab2cc0f54fe7ce5862f553432fadd28b6de1bcf0277cb2c85e6086c41af819bd3efd53208c8
+  data.tar.gz: 50153003d3b09fd17f97aee84f76615ed17e8516700476447898adb745b859180edd320dc2a28502bd1b8152e006500961d6e15414e9884a722fc7caf6900bd5

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## master (unreleased)
+
+## 0.1.0 (2025-08-28)
+
+- First release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 fatkodima
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,56 @@
+# SmartIgnoredColumns
+
+[<img src="tweet.png" alt="Motivational tweet" width="500px"/>](https://x.com/ciaran_lee/status/1953084875193385200)
+
+Now you won't forget to delete those ignored columns.
+
+## Requirements
+
+- ruby 3.2+
+- activerecord 7.2+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "smart_ignored_columns", group: [:development, :test]
+```
+
+## Usage
+
+1. Specify deadlines when ignoring columns:
+
+```ruby
+class User < ApplicationRecord
+  self.ignored_columns += [
+    { name: "first_name", remove_after: "2025-08-24" } # date can be a String or a Date
+  ]
+end
+```
+
+2. Run a check on CI to warn when it is time to remove ignored columns:
+
+```sh
+bundle exec rake smart_ignored_columns:obsolete
+```
+
+If there are any obsolete ignored columns, the check will print them and exit with an error status code.
+
+If you want to print all ignored columns with their deadlines, run:
+
+```sh
+bundle exec rake smart_ignored_columns:list
+```
+
+## Development
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/fatkodima/smart_ignored_columns.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/smart_ignored_columns/extension.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module SmartIgnoredColumns
+  # Includes extension of the `ignored_columns=` method.
+  #
+  module Extension
+    # Extension of the default `ignored_columns=` method with an ability to specify deadlines.
+    #
+    # @example
+    #   class User < ApplicationRecord
+    #     self.ignored_columns += [
+    #       { name: "first_name", remove_after: "2025-08-24" },       # date can be a String
+    #       { name: "bio", remove_after: Date.parse("2025-08-24") },  # or a Date object
+    #     ]
+    #   end
+    #
+    def ignored_columns=(columns)
+      columns = columns.flatten
+
+      all_columns_valid = columns.all? do |column|
+        column.is_a?(Hash) && column.key?(:name) && column.key?(:remove_after)
+      end
+
+      unless all_columns_valid
+        raise ArgumentError, "columns should be an array of hashes, each containing :name and :remove_after options"
+      end
+
+      super(columns.pluck(:name))
+
+      self.smart_ignored_columns += columns.map do |column|
+        IgnoredColumn.new(column[:name], column[:remove_after])
+      end
+    end
+
+    # @private
+    def smart_ignored_columns
+      @smart_ignored_columns || superclass.try(:smart_ignored_columns) || []
+    end
+
+    # @private
+    def smart_ignored_columns=(columns)
+      @smart_ignored_columns = columns
+    end
+  end
+end

data/lib/smart_ignored_columns/ignored_column.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module SmartIgnoredColumns
+  # @private
+  class IgnoredColumn
+    def self.all
+      list = []
+
+      ActiveRecord::Base.descendants.each do |klass|
+        next if klass.abstract_class?
+
+        if klass.smart_ignored_columns.any?
+          list << [klass, klass.smart_ignored_columns]
+        end
+      end
+
+      list
+    end
+
+    def self.obsolete
+      list = []
+
+      all.each do |klass, columns|
+        obsolete_columns = columns.select(&:obsolete?)
+        if obsolete_columns.any?
+          list << [klass, obsolete_columns]
+        end
+      end
+
+      list
+    end
+
+    attr_reader :name, :remove_after
+
+    def initialize(name, remove_after)
+      @name = name.to_s
+
+      @remove_after =
+        if remove_after.is_a?(String)
+          Date.parse(remove_after)
+        else
+          remove_after
+        end
+    end
+
+    def obsolete?
+      @remove_after < Date.today
+    end
+  end
+end

data/lib/smart_ignored_columns/railtie.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module SmartIgnoredColumns
+  # @private
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load "tasks/smart_ignored_columns_tasks.rake"
+    end
+  end
+end

data/lib/smart_ignored_columns/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SmartIgnoredColumns
+  VERSION = "0.1.0"
+end

data/lib/smart_ignored_columns.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "active_record"
+
+require_relative "smart_ignored_columns/ignored_column"
+require_relative "smart_ignored_columns/extension"
+require_relative "smart_ignored_columns/version"
+
+ActiveSupport.on_load(:active_record) do
+  singleton_class.prepend(SmartIgnoredColumns::Extension)
+end
+
+require "smart_ignored_columns/railtie" if defined?(Rails)

data/lib/tasks/smart_ignored_columns_tasks.rake

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+namespace :smart_ignored_columns do
+  desc "Show a list of obsolete `ignored_columns`"
+  task obsolete: :environment do
+    Rails.application.eager_load!
+
+    list = SmartIgnoredColumns::IgnoredColumn.obsolete
+
+    if list.any?
+      puts "The following `ignored_columns` definitions are obsolete and can be removed:\n\n"
+
+      list.each do |klass, ignored_columns|
+        puts klass.name
+        ignored_columns.each do |column|
+          puts " - #{column.name} (remove after #{column.remove_after})"
+        end
+      end
+
+      exit(1)
+    else
+      puts "No obsolete `ignored_columns` definitions found."
+    end
+  end
+
+  desc "Show a list of `ignored_columns`"
+  task list: :environment do
+    Rails.application.eager_load!
+
+    list = SmartIgnoredColumns::IgnoredColumn.all
+
+    if list.any?
+      list.each do |klass, ignored_columns|
+        puts klass.name
+        ignored_columns.each do |column|
+          puts " - #{column.name} (remove after #{column.remove_after})"
+        end
+      end
+    else
+      puts "No `ignored_columns` definitions found."
+    end
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: smart_ignored_columns
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- fatkodima
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-08-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.2'
+description:
+email:
+- fatkodima123@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/smart_ignored_columns.rb
+- lib/smart_ignored_columns/extension.rb
+- lib/smart_ignored_columns/ignored_column.rb
+- lib/smart_ignored_columns/railtie.rb
+- lib/smart_ignored_columns/version.rb
+- lib/tasks/smart_ignored_columns_tasks.rake
+homepage: https://github.com/fatkodima/smart_ignored_columns
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/fatkodima/smart_ignored_columns
+  source_code_uri: https://github.com/fatkodima/smart_ignored_columns
+  changelog_uri: https://github.com/fatkodima/smart_ignored_columns/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: Add deadlines to Active Record `ignored_columns`
+test_files: []