inheritance_integer_type 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9a916703b732e9a89a88946d16cf6a29c9674fd0
-  data.tar.gz: 8dcd46dded61c5168d8e964659887bb33768d343
+SHA256:
+  metadata.gz: 5eed88208785bd41ac4e3b7959526aaa500c744d1d00e0914df67fc3d4595e37
+  data.tar.gz: b5309eae3ff8d8b826497ec05390a12b709d3b00fb9e3a6a28be89954b981101
 SHA512:
-  metadata.gz: 2bcf51124af5f9e4ebcf75b30dea1cff9f3e207da988b9b3dea327917e82367541c5ae6f4e852c07251e641f6bf79b316113c1cf01dff492794db13427105838
-  data.tar.gz: 6abd3fc1aebc455713a8127adb040179abc993b73d2ffdf7433444f60d28fa8a367a183436bb334c9dd9509b7c140695bf4b7a3efb904f7bf9a9c95c94d1c487
+  metadata.gz: 1bbd3b8a7f178423902628e11598c65352350c0f8c509e484597c003cee66b2decfa8cdb8fba5a0e322330211d71b3069ff99ba455df0edda2778389a28cb3b0
+  data.tar.gz: afba16f3559dc14dd7cae13c8bbdea82a12f9bd0860a6517d0e0971cb0dcf898a3cd3cbdb8530145254c683922c689c7b15791bb54ba58da4d98fe3c5d8daa8e

data/.github/workflows/ci.yaml

@@ -0,0 +1,47 @@
+---
+name: CI
+
+on:
+  workflow_dispatch:
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version:
+          - 3.0
+          - 3.1
+          - 3.2
+        active-record-version:
+          - 6.1.0
+          - 7.0.0
+          - 7.1.0
+        exclude:
+          - ruby-version: 3.2
+            active-record-version: 6.0.0
+          - ruby-version: 3.2
+            active-record-version: 6.1.0
+          - ruby-version: 3.2
+            active-record-version: 7.0.0
+          - ruby-version: 3.1
+            active-record-version: 6.0.0
+          - ruby-version: 3.1
+            active-record-version: 6.1.0
+          - ruby-version: 3.0
+            active-record-version: 6.0.0
+    env:
+      ACTIVE_RECORD_VERSION: "${{ matrix.active-record-version }}"
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "${{ matrix.ruby-version }}"
+          bundler-cache: true
+      - name: Run tests
+        run: bundle exec rspec --format documentation

data/.github/workflows/gem-push.yaml

@@ -0,0 +1,30 @@
+name: Ruby Gem
+
+on:
+  release:
+    types: [ published ]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby 3.1
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.1
+
+    - name: Publish to RubyGems
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem

data/.gitignore

@@ -24,6 +24,8 @@ build/
 /.bundle/
 /lib/bundler/man/
 
+Gemfile.lock
+
 # for a library or gem, you might want to ignore these files since the code is
 # intended to run in multiple environments; otherwise, check them in:
 # Gemfile.lock

data/.ruby-version

@@ -0,0 +1 @@
+3.1.4

data/Gemfile

@@ -2,3 +2,16 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in inheritance_integer_type.gemspec
 gemspec
+
+ar_version = ENV["ACTIVE_RECORD_VERSION"] || "default"
+
+ar = case ar_version
+when "master"
+  { github: "rails/rails" }
+when "default"
+  ">= 6.0"
+else
+  "~> #{ar_version}"
+end
+
+gem "activerecord", ar

data/README.md

@@ -22,10 +22,12 @@ class CreateCompanies < ActiveRecord::Migration
 end
 ```
 
-The problem with this approach is that `type` is a string (and by default it is 255 characters). This is a little ridiculous. For comparison, if we had a state machine with X states, would we describe the states with strings `"State1", "State2", etc` or would we just enumerate the state column and make it an integer? This gem will allow us to use an integer for the `type` column. 
+The problem with this approach is that `type` is a string (and by default it is 255 characters). This is a little ridiculous. For comparison, if we had a state machine with X states, would we describe the states with strings `"State1", "State2", etc` or would we just enumerate the state column and make it an integer? This gem will allow us to use an integer for the `type` column.
 
 ## Installation
 
+_Current versions of this gem (>= v0.2.0) only support Ruby 3+ and ActiveRecord >= v6.1. For Ruby <= v2.7 or ActiveRecord <= 6.0, use v0.1.3._
+
 Add this line to your application's Gemfile:
 
     gem 'inheritance_integer_type'
@@ -42,28 +44,28 @@ Or install it yourself as:
 
 The gem is pretty straightforward to use.
 
-First, set the `integer_inheritance` value on each of the subclasses. 
+First, set the `integer_inheritance` value on each of the subclasses.
 ```ruby
 class Firm < Company
   self.integer_inheritance = 1
 end
- 
+
 class Client < Company
   self.integer_inheritance = 2
 end
- 
+
 class PriorityClient < Client
   self.integer_inheritance = 3
 end
 ```
 
 
-Note: The mapping here can start from whatever integer you wish, but I would advise not using 0. The reason being that if you had a new class, for instance `PriorityFirm`,  but forgot to include set the mapping, it would effectively get `to_i` called on it and stored in the database. `"Priority".to_i == 0`, so if your mapping included 0, this would create a weird bug. 
+Note: The mapping here can start from whatever integer you wish, but I would advise not using 0. The reason being that if you had a new class, for instance `PriorityFirm`,  but forgot to include set the mapping, it would effectively get `to_i` called on it and stored in the database. `"Priority".to_i == 0`, so if your mapping included 0, this would create a weird bug.
 
 If you want to convert a polymorphic association that is already a string, you'll need to set up a migration. (Assuming SQL for the time being, but this should be pretty straightforward.)
 ```ruby
 class CompanyToIntegerType < ActiveRecord::Migration
-  
+
   def up
     change_table :companies do |t|
       t.integer :new_type

data/dev.yml

@@ -0,0 +1,11 @@
+---
+version: "2.0"
+
+setup:
+  ruby: 3.1.4
+  bundler: 2.4.21
+
+commands:
+  test:
+    summary: Run the project's specs
+    command: bundle exec rspec spec/

data/inheritance_integer_type.gemspec

@@ -18,10 +18,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
-  spec.add_development_dependency "activerecord"
-  spec.add_development_dependency "mysql2", "0.3.18"
+  spec.add_development_dependency "activerecord", ">= 5.2"
+  spec.add_development_dependency "sqlite3", "~> 1.4"
   spec.add_development_dependency "pry"
 end

data/lib/inheritance_integer_type/extensions.rb

@@ -1,63 +1,53 @@
 module InheritanceIntegerType
   module Extensions
-    extend ActiveSupport::Concern
-    module ClassMethods
-
-      def integer_inheritance=(val)
-        self._inheritance_mapping[val] = sti_name_without_integer_types
-      end
+    def sti_name
+      klass = super
+      self._inheritance_mapping.key(klass) || klass
+    end
 
-      def find_sti_class(type_name)
-        lookup = self._inheritance_mapping[type_name.to_i]
-        if lookup
-          if ActiveRecord::VERSION::MAJOR < 5
-            super(lookup)
-          else
-            begin
-              if store_full_sti_class
-                ActiveSupport::Dependencies.constantize(lookup)
-              else
-                compute_type(lookup)
-              end
-            rescue NameError
-              raise SubclassNotFound,
-                "The single-table inheritance mechanism failed to locate the subclass: '#{type_name}'. " +
-                "This error is raised because the column '#{inheritance_column}' is reserved for storing the class in case of inheritance. " +
-                "Please rename this column if you didn't intend it to be used for storing the inheritance class " +
-                "or overwrite #{name}.inheritance_column to use another column for that information."
+    def find_sti_class(type_name)
+      lookup = self._inheritance_mapping[type_name.to_i]
+      if lookup
+        if ActiveRecord::VERSION::MAJOR < 5
+          super(lookup)
+        else
+          begin
+            if store_full_sti_class
+              lookup.constantize
+            else
+              compute_type(lookup)
             end
+          rescue NameError
+            raise SubclassNotFound,
+              "The single-table inheritance mechanism failed to locate the subclass: '#{type_name}'. " +
+              "This error is raised because the column '#{inheritance_column}' is reserved for storing the class in case of inheritance. " +
+              "Please rename this column if you didn't intend it to be used for storing the inheritance class " +
+              "or overwrite #{name}.inheritance_column to use another column for that information."
           end
-        else
-          super
         end
-      end
-
-      def sti_name_with_integer_types
-        klass = sti_name_without_integer_types
-        self._inheritance_mapping.key(klass) || klass
+      else
+        super
       end
     end
 
-    included do
-      class << self
-        def _inheritance_mapping
-          @_inheritance_mapping ||= (superclass == ActiveRecord::Base ? {} : superclass._inheritance_mapping.dup)
-        end
+    def integer_inheritance=(val)
+      self._inheritance_mapping[val] = method(:sti_name).super_method.call
+    end
 
-        def _inheritance_mapping=(val)
-          @_inheritance_mapping = val
-        end
+    def _inheritance_mapping
+      @_inheritance_mapping ||= (superclass == ActiveRecord::Base ? {} : superclass._inheritance_mapping.dup)
+    end
 
-        def merge_mapping!(mapping)
-          conflicts = _inheritance_mapping.keys & mapping.keys
-          raise ArgumentError.new("Duplicate mapping detected for keys: #{conflicts}") if conflicts.any?
+    def _inheritance_mapping=(val)
+      @_inheritance_mapping = val
+    end
 
-          _inheritance_mapping.merge!(mapping)
-        end
+    def merge_mapping!(mapping)
+      conflicts = _inheritance_mapping.keys & mapping.keys
+      raise ArgumentError.new("Duplicate mapping detected for keys: #{conflicts}") if conflicts.any?
 
-        alias_method_chain :sti_name, :integer_types
-      end
+      _inheritance_mapping.merge!(mapping)
     end
-
   end
+
 end

data/lib/inheritance_integer_type/version.rb

@@ -1,3 +1,3 @@
 module InheritanceIntegerType
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/lib/inheritance_integer_type.rb

@@ -2,10 +2,5 @@ require "inheritance_integer_type/version"
 require "inheritance_integer_type/extensions"
 
 class ActiveRecord::Base
-
-  def self.inherited(child_class)
-    child_class.include InheritanceIntegerType::Extensions
-    super
-  end
-
+  singleton_class.prepend(InheritanceIntegerType::Extensions)
 end

data/overlord.yml

@@ -0,0 +1,3 @@
+tier: 3
+owner: backend-infrastructure
+classification: library

data/spec/inheritance_integer_type_spec.rb

@@ -48,7 +48,7 @@ describe InheritanceIntegerType do
     describe "Has many associations" do
       let(:other) { Other.create }
       before do
-        [base, left, deep].each{|a| a.update_attributes(other: other) }
+        [base, left, deep].each{|a| a.update_attribute(:other, other) }
       end
       subject { other }
       it "properly finds the classes through the association" do

data/spec/spec_helper.rb

@@ -8,9 +8,8 @@ require 'support/other'
 require 'support/belongs_to'
 
 RSpec.configure do |config|
-
   config.before(:suite) do
-    ActiveRecord::Migrator.up "#{File.dirname(__FILE__)}/support/migrations"
+    ActiveRecord::MigrationContext.new("#{File.dirname(__FILE__)}/support/migrations", ::ActiveRecord::SchemaMigration).migrate
   end
 
   # No need to return the run the down migration after the test
@@ -19,7 +18,6 @@ RSpec.configure do |config|
   #   ActiveRecord::Migrator.down "#{File.dirname(__FILE__)}/support/migrations"
   # end
 
-
   config.around do |example|
     ActiveRecord::Base.transaction do
       example.run

data/spec/support/active_record.rb

@@ -2,10 +2,7 @@ require 'active_record'
 Dir["#{File.dirname(__FILE__)}/migrations/*.rb"].each {|f| require f}
 
 config = {
-  :adapter => "mysql2",
-  :host => "localhost",
-  :database => "inheritance_integer_type_test",
-  :username => "iit",
-  :password => ""
+  :adapter => "sqlite3",
+  :database => ":memory:",
 }
 ActiveRecord::Base.establish_connection(config)

data/spec/support/base.rb

@@ -1,6 +1,4 @@
 class Base < ActiveRecord::Base
-  include InheritanceIntegerType::Extensions
-  
   has_many :belongs_to
   belongs_to :other
 

data/spec/support/migrations/1_create_base_table.rb

@@ -1,4 +1,4 @@
-class CreateBaseTable < ActiveRecord::Migration
+class CreateBaseTable < ActiveRecord::Migration[5.2]
 
   def change
     create_table :bases do |t|

data/spec/support/migrations/2_create_belong_to_table.rb

@@ -1,4 +1,4 @@
-class CreateBelongToTable < ActiveRecord::Migration
+class CreateBelongToTable < ActiveRecord::Migration[5.2]
 
   def change
     create_table :belongs_tos do |t|

data/spec/support/migrations/3_create_other_table.rb

@@ -1,4 +1,4 @@
-class CreateOtherTable < ActiveRecord::Migration
+class CreateOtherTable < ActiveRecord::Migration[5.2]
 
   def change
     create_table :others do |t|

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: inheritance_integer_type
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Kyle d'Oliveira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-12 00:00:00.000000000 Z
+date: 2024-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -58,28 +58,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
-  name: mysql2
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.18
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.18
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -102,17 +102,21 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yaml"
+- ".github/workflows/gem-push.yaml"
 - ".gitignore"
+- ".ruby-version"
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - LICENSE.txt
 - README.md
 - Rakefile
+- dev.yml
 - inheritance_integer_type.gemspec
 - lib/inheritance_integer_type.rb
 - lib/inheritance_integer_type/extensions.rb
 - lib/inheritance_integer_type/version.rb
+- overlord.yml
 - spec/inheritance_integer_type_spec.rb
 - spec/spec_helper.rb
 - spec/spec_helper~
@@ -145,8 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 3.3.27
 signing_key: 
 specification_version: 4
 summary: Allow the type field in teh DB to be an integer rather than a string

data/Gemfile.lock

@@ -1,59 +0,0 @@
-PATH
-  remote: .
-  specs:
-    inheritance_integer_type (0.1.2)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activemodel (3.2.11)
-      activesupport (= 3.2.11)
-      builder (~> 3.0.0)
-    activerecord (3.2.11)
-      activemodel (= 3.2.11)
-      activesupport (= 3.2.11)
-      arel (~> 3.0.2)
-      tzinfo (~> 0.3.29)
-    activesupport (3.2.11)
-      i18n (~> 0.6)
-      multi_json (~> 1.0)
-    arel (3.0.3)
-    builder (3.0.4)
-    coderay (1.1.2)
-    diff-lcs (1.2.5)
-    i18n (0.6.9)
-    method_source (0.9.0)
-    multi_json (1.10.1)
-    mysql2 (0.3.18)
-    pry (0.11.3)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    rake (10.3.2)
-    rspec (3.0.0)
-      rspec-core (~> 3.0.0)
-      rspec-expectations (~> 3.0.0)
-      rspec-mocks (~> 3.0.0)
-    rspec-core (3.0.0)
-      rspec-support (~> 3.0.0)
-    rspec-expectations (3.0.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.0.0)
-    rspec-mocks (3.0.1)
-      rspec-support (~> 3.0.0)
-    rspec-support (3.0.0)
-    tzinfo (0.3.39)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  activerecord
-  bundler (~> 1.6)
-  inheritance_integer_type!
-  mysql2 (= 0.3.18)
-  pry
-  rake
-  rspec
-
-BUNDLED WITH
-   1.16.1