legacy_column 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4f9f7f8aae1c7e54444ac728bd65800583b8dba9c0ced595cebfe6ce61609bc5
+  data.tar.gz: 524f49a0d6a9e99cf75eda7274d044597f11c51815756236c8b66f75aaf0915f
+SHA512:
+  metadata.gz: 263844b58944bf35870e664e5cb4a4e3ec45c1ad055baf16f8e94c7c2c13cae382d4c1c829f59f7e9f832c217960a17d910d77e7da7332842532fa978b04a107
+  data.tar.gz: fd37196e959a15199e2c64feb56d03f13c14a3cab9f9858b8507048c9a4a0a78274cb8e3f864281e9a1dfbbf44e492c8dfe400fcb35911b150ac6d467661a9cf

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    legacy_column (0.1.0)
+      activerecord (>= 4.0.0)
+      activesupport (>= 4.0.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activerecord (6.0.3.2)
+      activemodel (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activesupport (6.0.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    concurrent-ruby (1.1.7)
+    diff-lcs (1.4.4)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.1)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    sqlite3 (1.4.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    zeitwerk (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  legacy_column!
+  rake (~> 13.0.1)
+  rspec (~> 3.2)
+  sqlite3 (~> 1.4.2)
+
+BUNDLED WITH
+   1.17.2

data/README.md

@@ -0,0 +1,41 @@
+[![Build Status](https://circleci.com/gh/logicalgroove/legacy_column.svg?style=shield)](https://app.circleci.com/pipelines/github/logicalgroove/legacy_column)
+[![License](https://img.shields.io/badge/License-MIT-yellowgreen.svg)](https://img.shields.io/badge/License-MIT-yellowgreen.svg)
+
+# LegacyColumn
+
+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.
+
+## Installation
+
+
+```ruby
+gem 'legacy_column'
+```
+
+## Usage
+
+Just list the column names:
+```ruby
+legacy_column :old_email, :old_phone_number
+```
+
+A custom message can be added:
+```ruby
+legacy_column :old_email, :old_phone_number, message: 'Do not touch this!!!'
+```
+
+It will output something like this in rails logs:
+
+```
+Use of legacy column detected.
+  User => old_email
+  Do not touch this!!!
+```
+
+## Contributing
+Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
+
+Please make sure to update tests as appropriate.
+
+## License
+[MIT](https://choosealicense.com/licenses/mit/)

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/init.rb

@@ -0,0 +1,3 @@
+require "legacy_column"
+
+LegacyColumn::Railtie.insert

data/legacy_column.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "legacy_column/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "legacy_column"
+  spec.version       = LegacyColumn::VERSION
+  spec.authors       = ["Aleksander Lopez Yazikov"]
+  spec.email         = ["webodessa@gmail.com"]
+
+  spec.summary       = %q{Warning for your legacy columns.}
+  spec.description   = %q{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.}
+  spec.homepage      = "https://github.com/logicalgroove/legacy_column"
+  spec.license       = "MIT"
+
+  spec.files        = Dir["{lib,spec}/**/*", "[A-Z]*", "init.rb"]
+  spec.require_paths = ["lib"]
+
+  spec.required_rubygems_version = ">= 1.3.4"
+
+  spec.add_dependency "activesupport", [">= 4.0.0"]
+  spec.add_dependency "activerecord", [">= 4.0.0"]
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 13.0.1"
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "sqlite3", "~> 1.4.2"
+end

data/lib/legacy_column.rb

@@ -0,0 +1,37 @@
+# usage:
+# include LegacyColumn
+# legacy_column :pos_type, :pos_user, message: 'Stop what you doing!'
+
+require "active_support/concern"
+
+module LegacyColumn
+  extend ActiveSupport::Concern
+
+  included do
+    class_attribute :legacy_column_names, instance_writer: false, default: nil
+    class_attribute :legacy_column_message, instance_writer: false, default: nil
+  end
+
+  module ClassMethods
+    DEFAULT_MESSAGE = 'This column is set as legacy and should not be used anymore.'
+
+    def legacy_column(*columns, message:nil)
+      return unless columns
+
+      self.legacy_column_names = columns
+      self.legacy_column_message = message || DEFAULT_MESSAGE
+
+      send('before_validation', :legacy_column)
+    end
+  end
+
+  def legacy_column
+    legacy_column_names.each do |column|
+      if changed_attributes.keys.include? column.to_s
+        puts "\n\nUSE of legacy column detected.\n  #{self.class} => #{column}\n  #{legacy_column_message}\n\n"
+      end
+    end
+  end
+end
+
+require "legacy_column/railtie"

data/lib/legacy_column/railtie.rb

@@ -0,0 +1,19 @@
+module LegacyColumn
+  if defined?(Rails::Railtie)
+    require 'rails'
+
+    class Railtie < Rails::Railtie
+      initializer 'legacy_column.extend_active_record' do
+        ActiveSupport.on_load(:active_record) do
+          LegacyColumn::Railtie.insert
+        end
+      end
+    end
+  end
+
+  class Railtie
+    def self.insert
+      ActiveRecord::Base.send(:include, LegacyColumn)
+    end
+  end
+end

data/lib/legacy_column/version.rb

@@ -0,0 +1,3 @@
+module LegacyColumn
+  VERSION = '0.1.0'
+end

data/spec/db/database.yml

@@ -0,0 +1,21 @@
+sqlite:
+  adapter: sqlite
+  database: spec/db/test.sqlite
+
+sqlite3:
+  adapter: sqlite3
+  database: spec/db/test.sqlite3
+
+postgresql:
+  adapter: postgresql
+  username: postgres
+  password: postgres
+  database: nilify_blanks_plugin_test
+  min_messages: ERROR
+
+mysql:
+  adapter: mysql
+  host: localhost
+  username: root
+  password:
+  database: nilify_blanks_plugin_test

data/spec/db/schema.rb

@@ -0,0 +1,9 @@
+ActiveRecord::Schema.define(:version => 0) do
+
+  create_table :users, :force => true do |t|
+    t.string :first_name
+    t.string :last_name
+    t.string :old_email
+    t.string :old_phone_number
+  end
+end

data/spec/legacy_column_spec.rb

@@ -0,0 +1,53 @@
+RSpec.describe LegacyColumn do
+  context 'default message' do
+    before do
+      class User < ActiveRecord::Base
+        legacy_column :old_email, :old_phone_number
+      end
+    end
+
+    it 'should recognize all legacy columns' do
+      expect(User.legacy_column_names).to eq([:old_email, :old_phone_number])
+    end
+
+    it 'should recognize default message' do
+      expect(User.legacy_column_message).to eq('This column is set as legacy and should not be used anymore.')
+    end
+
+    describe 'output' do
+      let(:user) { User.create }
+
+      it 'prints awesome things' do
+        expect {
+          user.update(old_email: 'something')
+        }.to output("\n\nUSE of legacy column detected.\n  User => old_email\n  This column is set as legacy and should not be used anymore.\n\n").to_stdout
+      end
+    end
+  end
+
+  context 'custom message' do
+    before do
+      class User < ActiveRecord::Base
+        legacy_column :old_email, :old_phone_number, message: 'Dont do it!!!'
+      end
+    end
+
+    it 'should recognize all legacy columns' do
+      expect(User.legacy_column_names).to eq([:old_email, :old_phone_number])
+    end
+
+    it 'should recognize default message' do
+      expect(User.legacy_column_message).to eq('Dont do it!!!')
+    end
+
+    describe 'output' do
+      let(:user) { User.create }
+
+      it 'prints awesome things' do
+        expect {
+          user.update(old_email: 'something')
+        }.to output("\n\nUSE of legacy column detected.\n  User => old_email\n  Dont do it!!!\n\n").to_stdout
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+require "rubygems"
+require "rspec"
+require "active_support"
+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'])
+
+# Load Test Schema into the Database
+load(File.dirname(__FILE__) + "/db/schema.rb")
+
+require File.dirname(__FILE__) + '/../init'
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: legacy_column
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aleksander Lopez Yazikov
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-08-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+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:
+- webodessa@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- init.rb
+- legacy_column.gemspec
+- lib/legacy_column.rb
+- lib/legacy_column/railtie.rb
+- lib/legacy_column/version.rb
+- spec/db/database.yml
+- spec/db/schema.rb
+- spec/db/test.sqlite3
+- spec/legacy_column_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/logicalgroove/legacy_column
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.3.4
+requirements: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: Warning for your legacy columns.
+test_files: []