ignored_columns_tasks 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ad7e03cc537a362226785d3937b5e7642eb97720cfa6353272e2b691738bc9f4
+  data.tar.gz: 2c3e07d772548bc75f0051c23ca0290ec3ead2c37a55999ad1a67f610d92fa3c
+SHA512:
+  metadata.gz: 06756504d577020eb1611ab1f361418ca5d90cca980a592b6c7a8f4fa9fdcecd803c91164925b9699e7c3254c5146829b39540d2d515e8bead5738d0f99ebd06
+  data.tar.gz: 39099157082e6e3f5aafc4e7768c4d126197b4e6bab7d5f4be87281dccd285c22e5f92525652d84a33d900ee84dee45b3cba16c5b53f116cfb124b47d37b4704

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+# rspec failure tracking
+.rspec_status

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ignored_columns_tasks.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Skye Shaw
+
+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,67 @@
+# Ignored Columns Tasks
+
+Rails tasks for managing
+[Active Record ignored columns](https://api.rubyonrails.org/v7.0.6/classes/ActiveRecord/ModelSchema/ClassMethods.html#method-i-ignored_columns-3D).
+
+## Installation
+
+Add this line to your application's `Gemfile` in the `:development` group:
+
+```ruby
+group :development do
+  gem "ignored_columns_tasks"
+end
+```
+
+## Usage
+
+All functionality is provided as Rake tasks.
+
+### Generating a Migration to Drop Ignored Columns
+
+This will generate (but not run!) migrations to drop columns currently being ignored. One migration is generated per model:
+
+```
+./bin/rails ignored_columns:migration
+```
+
+If you have ignored columns that must not be dropped add them to the `SKIP_COLUMNS` environment variable:
+
+```
+./bin/rails ignored_columns:migration SKIP_COLUMNS="some_column,another_column"
+```
+
+You can set this once for your project instead of specifying it every time.
+In this case it is recommended to use the `IGNORED_COLUMNS_SKIP_COLUMNS` environment variable.
+
+```sh
+export IGNORED_COLUMNS_SKIP_COLUMNS="some_column,another_column"
+```
+
+This task can also be limited to a single model via the `MODEL` environment variable:
+
+```
+./bin/rails ignored_columns:migration MODEL=User
+```
+
+### Ignored Columns That Have Been Dropped From Your Database
+
+This will print ignored columns that no longer exist the database:
+
+```
+./bin/rails ignored_columns:dropped
+```
+
+This can be limited to a single model via the `MODEL` environment variable:
+
+```
+./bin/rails ignored_columns:dropped MODEL=User
+```
+
+## Author
+
+Skye Shaw (skye.shaw +AT+ gmail)
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ignored_columns_tasks"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ignored_columns_tasks.gemspec

@@ -0,0 +1,30 @@
+require_relative 'lib/ignored_columns_tasks/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ignored_columns_tasks"
+  spec.version       = IgnoredColumnsTasks::VERSION
+  spec.authors       = ["Skye Shaw"]
+  spec.email         = ["skye.shaw@gmail.com"]
+
+  spec.summary       = %q{Rails tasks for managing Active Record ignored columns}
+  spec.description   = %q{Rails tasks to create migrations to remove ignored columns and output dropped columns that are still being ignored}
+  spec.homepage      = "https://github.com/sshaw/ignored_columns_tasks"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/sshaw/ignored_columns_tasks"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+end

data/lib/ignored_columns_tasks/railtie.rb

@@ -0,0 +1,7 @@
+module IgnoredColumnTasks
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load "ignored_columns_tasks/tasks/ignored_columns.rake"
+    end
+  end
+end

data/lib/ignored_columns_tasks/tasks/ignored_columns.rake

@@ -0,0 +1,33 @@
+namespace :ignored_columns do
+  def options
+    optz = {}
+    optz[:model] = ENV["MODEL"].constantize if ENV["MODEL"]
+    optz[:skip_columns] = skip_columns
+    optz
+  end
+
+  def skip_columns
+    skip = nil
+
+    # IGNORED_COLUMNS_SKIP_COLUMNS is our global, namespaced verison
+    # SKIP_COLUMNS is shorter, command-line argument
+    %w[IGNORED_COLUMNS_SKIP_COLUMNS SKIP_COLUMNS].each do |name|
+      if ENV[name]
+        skip ||= []
+        skip.concat(ENV[name].split(/\s*,\s/))
+      end
+    end
+
+    skip
+  end
+
+  desc "Output ignored columns for MODEL that have been dropped, ignoring SKIP_COLUMNS; if MODEL not given output for all"
+  task :dropped => :environment do
+    IgnoredColumnsTasks.dropped(options)
+  end
+
+  desc "Generate a migration to drop ignored columns for MODEL, ignoring SKIP_COLUMNS; if MODEL not given create migrations for all"
+  task :migration => :environment do
+    IgnoredColumnsTasks.migration(options)
+  end
+end

data/lib/ignored_columns_tasks/version.rb

@@ -0,0 +1,3 @@
+module IgnoredColumnsTasks
+  VERSION = "0.0.1"
+end

data/lib/ignored_columns_tasks.rb

@@ -0,0 +1,120 @@
+require "ignored_columns_tasks/version"
+require "rails/generators"
+
+module IgnoredColumnsTasks
+  class Column
+    attr_reader :klass, :name, :data
+
+    def initialize(klass, name, data = nil)
+      @klass = klass
+      @name = name
+      # Aren't using this now outside of exists
+      @data = data
+    end
+
+    def exists?
+      !@data.nil?
+    end
+
+    def to_s
+      name
+    end
+  end
+
+  class << self
+    ##
+    #
+    # Output ignored columns that have been dropped for +model+.
+    # If +model+ is not given output for all classes
+    #
+    # +model+ must a an ActiveRecord::Base subclass
+    #
+    def dropped(options = nil)
+      Rails.application.eager_load!
+
+      ignored = find_columns(options || {})
+      if ignored.none?
+        puts "No ignored columns exist"
+        return
+      end
+
+      dropped = ignored.reject(&:exists?)
+      if dropped.none?
+        puts "No ignored columns have been dropped"
+        return
+      end
+
+      dropped.group_by(&:klass).sort_by { |klass, _| klass.name }.each do |klass, columns|
+        puts "%s: %s" % [klass.name, columns.sort_by(&:name).to_sentence]
+      end
+    end
+
+    ##
+    #
+    # Generate a migration to drop ignored columns for +model+.
+    # If +model+ is not given create migrations for all classes
+    # with ignored columns. 1 migration per class.
+    #
+    # +model+ must a an ActiveRecord::Base subclass
+    #
+    def migration(options = nil)
+      Rails.application.eager_load!
+
+      ignored_columns = find_columns(options || {})
+      if ignored_columns.none?
+        puts "No ignored columns exist"
+        return
+      end
+
+      to_drop = ignored_columns.select(&:exists?)
+      if to_drop.none?
+        puts "No ignored columns to drop"
+        return
+      end
+
+      to_drop.group_by(&:klass).each do |klass, columns|
+        migration = "remove_ignored_columns_from_#{klass.table_name}"
+
+        # Assume Rails does the shell quoting on Column#name?
+        Rails::Generators.invoke("active_record:migration", [migration, columns.map(&:name)])
+      end
+    end
+
+    private
+
+    def all_classes
+      (ApplicationRecord.subclasses + ActiveRecord::Base.subclasses).reject do |klass|
+        klass.abstract_class? || klass.ignored_columns.none?
+      end
+    end
+
+    def class_with_all_columns(klass)
+      ignored = klass.ignored_columns
+
+      klass.ignored_columns = []
+      klass.reset_column_information
+      yield klass, ignored.dup
+    ensure
+      # I mean do we really need to do this?
+      klass.ignored_columns = ignored
+    end
+
+    def find_columns(options)
+      if options[:model]
+        ignored_columns(options[:model], options[:skip_columns])
+      else
+        all_classes.flat_map { |klass| ignored_columns(klass, options[:skip_columns]) }
+      end
+    end
+
+    def ignored_columns(klass, skip = nil)
+      skip ||= []
+      class_with_all_columns klass do |class_with_all, ignored|
+        ignored -= skip if skip.any?
+        ignored.map { |column| Column.new(class_with_all, column, class_with_all.columns_hash[column]) }
+      end
+    end
+  end
+end
+
+require "ignored_columns_tasks/railtie" if defined?(Rails::Railtie)

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: ignored_columns_tasks
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Skye Shaw
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-07-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rails tasks to create migrations to remove ignored columns and output
+  dropped columns that are still being ignored
+email:
+- skye.shaw@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ignored_columns_tasks.gemspec
+- lib/ignored_columns_tasks.rb
+- lib/ignored_columns_tasks/railtie.rb
+- lib/ignored_columns_tasks/tasks/ignored_columns.rake
+- lib/ignored_columns_tasks/version.rb
+homepage: https://github.com/sshaw/ignored_columns_tasks
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/sshaw/ignored_columns_tasks
+  source_code_uri: https://github.com/sshaw/ignored_columns_tasks
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Rails tasks for managing Active Record ignored columns
+test_files: []