legacy_column 0.1.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee20abfdeccbe8272d2ab663d6978c4de1034061750bedc386b9f6538f380f76
-  data.tar.gz: 751edea2ab275196035179d7d15a93fcd02fc6f8d4e1665123334ff59f251baf
+  metadata.gz: a09851d6a69c5fffa341bbcb0fae4b937903c1b26e2a8d36bb9f4a8b2ca9201a
+  data.tar.gz: d458748a4dc483d16d11e8c6f02f4a794b5cc08bfad3f36f42bbba375816f91f
 SHA512:
-  metadata.gz: fd99cfa33049ebdfd7a64bd5589350ae4c963845319b9637afd472f9ee0efae3d6a2e0fe09f14db461cd2f134816dd768829dec347d69da85dfd21ab9ebaa653
-  data.tar.gz: e1bec36f5e7420cbd1eb25b38b8748cff21afba5f32ff4d533c3fd43b185562b39d0b0c2ad2cc29e732bb37e2e7ed506df0100a3f6c8722beb51277bdca13c7a
+  metadata.gz: cf307d3a3da65ed7441173135cce638179e810b12c72b791aea18eeb93248740aba8aaf9dcf8e16a7bf3d2af82390f2ef189d6e01b096710a5bb7176a0c65056
+  data.tar.gz: 4b0427368bbf8969f7eadbe243307d71a4306381af8f5027b1ab0b5ba4fd03969375f3d3e324722aabe81ab7cd2bfd88989571634f28f63abf0955f3fa77f008

data/CLAUDE.md

@@ -0,0 +1,53 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+This is a Ruby gem called `legacy_column` that provides a Rails plugin for warning developers when they attempt to use legacy database columns that should be avoided. The gem uses ActiveSupport::Concern to extend ActiveRecord models with a class method that marks specified columns as legacy and prints warning messages when those columns are modified.
+
+## Core Architecture
+
+- **Main module**: `lib/legacy_column.rb` - The core concern that provides the `legacy_column` class method and warning functionality
+- **Rails integration**: `lib/legacy_column/railtie.rb` - Handles automatic inclusion into ActiveRecord::Base when Rails is present
+- **Version file**: `lib/legacy_column/version.rb` - Contains gem version constant
+- **Entry points**: `init.rb` and `rails/init.rb` - Legacy entry points for older Rails versions
+
+The gem works by:
+1. Including the LegacyColumn concern into ActiveRecord::Base
+2. Adding a `legacy_column` class method that accepts column names and an optional message
+3. Setting up a `before_validation` callback that checks for changes to legacy columns
+4. Printing warnings to stdout when legacy columns are modified
+
+## Development Commands
+
+### Setup
+```bash
+bin/setup          # Install dependencies
+```
+
+### Testing  
+```bash
+bundle exec rake   # Run all tests (default rake task)
+bundle exec rspec  # Run tests directly with RSpec
+```
+
+### Building
+```bash
+bundle exec rake build    # Build the gem
+bundle exec rake install  # Install gem locally
+bundle exec rake release  # Release gem (bumps version, creates git tag, pushes to rubygems)
+```
+
+## Test Database Configuration
+
+The test suite uses SQLite3 with configuration in `spec/db/database.yml` and schema in `spec/db/schema.rb`. Tests create a temporary User model to test the legacy column functionality.
+
+## Dependencies
+
+- **Runtime**: ActiveSupport >= 4.0.0, ActiveRecord >= 4.0.0
+- **Development**: RSpec 3.2+, SQLite3 1.4.2+, Bundler 2.2.33+, Rake 13.0.1+
+
+## CI/CD
+
+CircleCI configuration uses Ruby 2.6.3 and runs `bundle exec rake` to execute the test suite.

data/Gemfile.lock

@@ -1,29 +1,44 @@
 PATH
   remote: .
   specs:
-    legacy_column (0.1.2)
-      activerecord (>= 4.0.0)
-      activesupport (>= 4.0.0)
+    legacy_column (0.3.0)
+      activerecord (>= 5.2.0, < 9.0)
+      activesupport (>= 5.2.0, < 9.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (6.1.4.4)
-      activesupport (= 6.1.4.4)
-    activerecord (6.1.4.4)
-      activemodel (= 6.1.4.4)
-      activesupport (= 6.1.4.4)
-    activesupport (6.1.4.4)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
+    activemodel (8.0.2.1)
+      activesupport (= 8.0.2.1)
+    activerecord (8.0.2.1)
+      activemodel (= 8.0.2.1)
+      activesupport (= 8.0.2.1)
+      timeout (>= 0.4.0)
+    activesupport (8.0.2.1)
+      base64
+      benchmark (>= 0.3)
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
       minitest (>= 5.1)
-      tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
-    concurrent-ruby (1.1.9)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
+    base64 (0.3.0)
+    benchmark (0.4.1)
+    bigdecimal (3.2.3)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.4)
     diff-lcs (1.4.4)
-    i18n (1.8.11)
+    drb (2.2.3)
+    i18n (1.14.7)
       concurrent-ruby (~> 1.0)
-    minitest (5.15.0)
+    logger (1.7.0)
+    mini_portile2 (2.8.9)
+    minitest (5.25.5)
     rake (13.0.1)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
@@ -38,10 +53,13 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
-    sqlite3 (1.4.2)
-    tzinfo (2.0.4)
+    securerandom (0.4.1)
+    sqlite3 (2.7.3)
+      mini_portile2 (~> 2.8.0)
+    timeout (0.4.3)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    zeitwerk (2.5.3)
+    uri (1.0.3)
 
 PLATFORMS
   ruby
@@ -51,7 +69,7 @@ DEPENDENCIES
   legacy_column!
   rake (~> 13.0.1)
   rspec (~> 3.2)
-  sqlite3 (~> 1.4.2)
+  sqlite3 (>= 1.4.0)
 
 BUNDLED WITH
    2.3.4

data/README.md

@@ -7,13 +7,27 @@ A gem that will print a message if a developer is trying to use a column that is
 
 ## Installation
 
+Add this line to your application's Gemfile:
 
 ```ruby
 gem 'legacy_column'
 ```
 
+And then execute:
+```bash
+bundle install
+```
+
+## Compatibility
+
+This gem supports:
+- Ruby 2.7+
+- Rails 5.2+, 6.0+, 6.1+, 7.0+, 7.1+, 7.2+, 8.0+
+
 ## Usage
 
+### Basic Usage
+
 Just list the column names:
 ```ruby
 legacy_column :old_email, :old_phone_number
@@ -24,14 +38,61 @@ A custom message can be added:
 legacy_column :old_email, :old_phone_number, message: 'Do not touch this!!!'
 ```
 
-It will output something like this in rails logs:
+### Read Access Detection
+
+By default, the gem only detects write operations (when columns are modified). To also detect read access, use the `detect_reads` option:
+
+```ruby
+legacy_column :old_email, :old_phone_number, detect_reads: true
+```
+
+This will warn whenever the legacy columns are accessed:
+
+```ruby
+legacy_column :old_status, message: 'This field is deprecated!', detect_reads: true
+
+user.old_status  # Will log a warning about read access
+user.old_status = 'active'  # Will log a warning about write access
+```
+
+### Combined Usage
+
+You can combine read detection with custom messages:
+```ruby
+legacy_column :old_price, :old_name, 
+              message: 'These fields will be removed in v2.0!', 
+              detect_reads: true
+```
+
+## Output Examples
+
+### Write Detection (Default)
+```
+USE of legacy column detected.
+  User => old_email
+  Do not touch this!!!
+```
 
+### Read Detection (When enabled)
 ```
-Use of legacy column detected.
+READ of legacy column detected.
   User => old_email
   Do not touch this!!!
 ```
 
+## Logging
+
+The gem will:
+- Log warnings to `Rails.logger` when Rails is available  
+- Fall back to `puts` for non-Rails environments or when Rails.logger is not available
+
+## Options
+
+| Option | Default | Description |
+|--------|---------|-------------|
+| `message` | `"This column is set as legacy and should not be used anymore."` | Custom warning message |
+| `detect_reads` | `false` | Enable read access detection |
+
 ## Contributing
 Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
 

data/legacy_column.gemspec

@@ -18,10 +18,10 @@ Gem::Specification.new do |spec|
 
   spec.required_rubygems_version = ">= 1.3.4"
 
-  spec.add_dependency "activesupport", [">= 4.0.0"]
-  spec.add_dependency "activerecord", [">= 4.0.0"]
+  spec.add_dependency "activesupport", [">= 5.2.0", "< 9.0"]
+  spec.add_dependency "activerecord", [">= 5.2.0", "< 9.0"]
   spec.add_development_dependency "bundler", ">= 2.2.33"
   spec.add_development_dependency "rake", "~> 13.0.1"
   spec.add_development_dependency "rspec", "~> 3.2"
-  spec.add_development_dependency "sqlite3", "~> 1.4.2"
+  spec.add_development_dependency "sqlite3", ">= 1.4.0"
 end

data/lib/legacy_column/version.rb

@@ -1,3 +1,3 @@
 module LegacyColumn
-  VERSION = '0.1.2'
+  VERSION = '0.3.0'
 end

data/lib/legacy_column.rb

@@ -10,25 +10,54 @@ module LegacyColumn
   included do
     class_attribute :legacy_column_names, instance_writer: false, default: nil
     class_attribute :legacy_column_message, instance_writer: false, default: nil
+    class_attribute :legacy_column_detect_reads, instance_writer: false, default: false
   end
 
   module ClassMethods
     DEFAULT_MESSAGE = 'This column is set as legacy and should not be used anymore.'
 
-    def legacy_column(*columns, message: nil)
+    def legacy_column(*columns, message: nil, detect_reads: false)
       return unless columns
 
       self.legacy_column_names = columns
       self.legacy_column_message = message || DEFAULT_MESSAGE
+      self.legacy_column_detect_reads = detect_reads
 
       send('before_validation', :legacy_column)
+      
+      if detect_reads
+        setup_read_detection(columns)
+      end
+    end
+
+    private
+
+    def setup_read_detection(columns)
+      mod = Module.new do
+        columns.each do |column|
+          define_method(column) do
+            # Log read access
+            if defined?(Rails) && Rails.logger
+              Rails.logger.warn "\n\nREAD of legacy column detected.\n  #{self.class} => #{column}\n  #{legacy_column_message}\n\n"
+            else
+              puts "\n\nREAD of legacy column detected.\n  #{self.class} => #{column}\n  #{legacy_column_message}\n\n"
+            end
+            super()  # Call original getter
+          end
+        end
+      end
+      prepend(mod)
     end
   end
 
   def legacy_column
     legacy_column_names.each do |column|
-      if changed_attributes.key?(column.to_s)
-        puts "\n\nUSE of legacy column detected.\n  #{self.class} => #{column}\n  #{legacy_column_message}\n\n"
+      if changes_to_save.key?(column.to_s)
+        if defined?(Rails) && Rails.logger
+          Rails.logger.warn "\n\nUSE of legacy column detected.\n  #{self.class} => #{column}\n  #{legacy_column_message}\n\n"
+        else
+          puts "\n\nUSE of legacy column detected.\n  #{self.class} => #{column}\n  #{legacy_column_message}\n\n"
+        end
       end
     end
   end

data/spec/db/schema.rb

@@ -6,4 +6,21 @@ ActiveRecord::Schema.define(:version => 0) do
     t.string :old_email
     t.string :old_phone_number
   end
+
+  create_table :products, :force => true do |t|
+    t.decimal :old_price
+    t.string :old_name
+  end
+
+  create_table :items, :force => true do |t|
+    t.string :old_status
+  end
+
+  create_table :orders, :force => true do |t|
+    t.decimal :old_total
+  end
+
+  create_table :accounts, :force => true do |t|
+    t.decimal :old_balance
+  end
 end

data/spec/legacy_column_spec.rb

@@ -50,4 +50,124 @@ RSpec.describe LegacyColumn do
       end
     end
   end
+
+  context 'read detection enabled' do
+    before do
+      class Product < ActiveRecord::Base
+        legacy_column :old_price, :old_name, detect_reads: true
+      end
+    end
+
+    it 'should recognize detect_reads setting' do
+      expect(Product.legacy_column_detect_reads).to eq(true)
+    end
+
+    describe 'read access detection' do
+      let(:product) do
+        # Create product without triggering write detection by using update_attribute
+        p = Product.create
+        p.update_attribute(:old_price, 100)
+        p.update_attribute(:old_name, 'Test Product')
+        p
+      end
+
+      it 'detects read access to legacy columns' do
+        expect {
+          product.old_price
+        }.to output(/READ of legacy column detected.*Product => old_price.*This column is set as legacy and should not be used anymore/m).to_stdout
+      end
+
+      it 'detects read access to multiple legacy columns' do
+        expect {
+          product.old_name
+        }.to output(/READ of legacy column detected.*Product => old_name.*This column is set as legacy and should not be used anymore/m).to_stdout
+      end
+
+      it 'still returns the actual attribute value' do
+        # Capture output but test return value
+        value = nil
+        expect {
+          value = product.old_price
+        }.to output(/READ of legacy column detected/).to_stdout
+        expect(value).to eq(100)
+      end
+    end
+  end
+
+  context 'read detection with custom message' do
+    before do
+      class Item < ActiveRecord::Base  
+        legacy_column :old_status, message: 'Stop reading this!', detect_reads: true
+      end
+    end
+
+    describe 'read access detection with custom message' do
+      let(:item) do
+        i = Item.create
+        i.update_attribute(:old_status, 'active')
+        i
+      end
+
+      it 'shows custom message for read access' do
+        expect {
+          item.old_status
+        }.to output(/READ of legacy column detected.*Item => old_status.*Stop reading this!/m).to_stdout
+      end
+    end
+  end
+
+  context 'read detection disabled (default)' do
+    before do
+      class Order < ActiveRecord::Base
+        legacy_column :old_total  # detect_reads defaults to false
+      end
+    end
+
+    it 'should not detect reads when disabled' do
+      expect(Order.legacy_column_detect_reads).to eq(false)
+    end
+
+    describe 'no read access detection' do
+      let(:order) do
+        o = Order.create
+        o.update_attribute(:old_total, 50)
+        o
+      end
+
+      it 'does not detect read access when disabled' do
+        expect {
+          order.old_total
+        }.to_not output.to_stdout
+      end
+
+      it 'still returns the actual attribute value' do
+        expect(order.old_total).to eq(50)
+      end
+    end
+  end
+
+  context 'combined read and write detection' do
+    before do
+      class Account < ActiveRecord::Base
+        legacy_column :old_balance, message: 'Legacy account field!', detect_reads: true
+      end
+    end
+
+    describe 'both read and write detection' do
+      let(:account) { Account.create }
+
+      it 'detects write access' do
+        expect {
+          account.update(old_balance: 1000)
+        }.to output("\n\nUSE of legacy column detected.\n  Account => old_balance\n  Legacy account field!\n\n").to_stdout
+      end
+
+      it 'detects read access' do
+        account.update_attribute(:old_balance, 1000)  # Set without triggering write detection
+        expect {
+          account.old_balance
+        }.to output(/READ of legacy column detected.*Account => old_balance.*Legacy account field!/m).to_stdout
+      end
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -5,8 +5,14 @@ require "active_record"
 require "yaml"
 
 config = YAML::load(IO.read(File.join(File.dirname(__FILE__), 'db', 'database.yml')))
-ActiveRecord::Base.configurations = {'test' => config[ENV['DB'] || 'sqlite3']}
-ActiveRecord::Base.establish_connection(ActiveRecord::Base.configurations['test'])
+db_config = config[ENV['DB'] || 'sqlite3']
+
+if ActiveRecord::VERSION::MAJOR >= 6
+  ActiveRecord::Base.establish_connection(db_config)
+else
+  ActiveRecord::Base.configurations = {'test' => db_config}
+  ActiveRecord::Base.establish_connection(ActiveRecord::Base.configurations['test'])
+end
 
 # Load Test Schema into the Database
 load(File.dirname(__FILE__) + "/db/schema.rb")

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: legacy_column
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Aleksander Lopez Yazikov
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-30 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,28 +15,40 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 5.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 5.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 5.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 5.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -84,16 +95,16 @@ dependencies:
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.2
+        version: 1.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.2
+        version: 1.4.0
 description: A gem that will print a message if a developer is trying to use a column
   that is from a legacy system but has to stay there.
 email:
@@ -102,6 +113,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CLAUDE.md
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -120,7 +132,6 @@ homepage: https://github.com/logicalgroove/legacy_column
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -135,8 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.4
 requirements: []
-rubygems_version: 3.2.27
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Warning for your legacy columns.
 test_files: []