integer-inheritance 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4b45f29a1e3866e71502397408bce1fd83ff247f
+  data.tar.gz: bb7c0d11682b315014cfade5cdffe384a57a9db9
+SHA512:
+  metadata.gz: a01fb9fb9789a115cfff74479174575f996e23e3dad4a854bf24d7b0629abd73813cffa95a788e50effdf04c8d9073d11b0a6ff276b9007659e7a9582978d447
+  data.tar.gz: b2cf3a17be2b06f48a1578a1cc193a40837bf2c33137eeddcf710c4ae26f06eca135af9901d65fa63f21ea562f070dca5fd5f63ce6e9904b5fca882d79566664

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea

data/Gemfile

@@ -0,0 +1,7 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in integer-inheritance.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Yaroslav Konoplov
+
+MIT License
+
+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,30 @@
+```ruby
+  class Post < ActiveRecord::Base
+    uses_integer_inheritance
+  end
+
+  class Article < Post
+  end
+
+  class Publication < Post
+  end
+
+  # Add to initializers or to some script that is not reloaded:
+  # (this adds support for reloading in development mode. See ActionDispatch::Reloader)
+  IntegerInheritance.describe do
+
+    # Use full class name here (only strings!)
+    with 'Post' do
+      map 1, to: 'Post'
+      map 2, to: 'Article'
+
+      # You can specify more than one type
+      map 3, 4, to: 'Publication'
+    end
+  end
+```
+
+## Gemfile
+```ruby
+gem 'integer-inheritance', '~> 1.0'
+```

data/integer-inheritance.gemspec

@@ -0,0 +1,21 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+Gem::Specification.new do |s|
+  s.name            = 'integer-inheritance'
+  s.version         = '1.0.1'
+  s.authors         = ['Yaroslav Konoplov']
+  s.email           = ['eahome00@gmail.com']
+  s.summary         = 'Single table inheritance mechanism built on integer types'
+  s.description     = 'Single table inheritance mechanism built on integer types'
+  s.homepage        = 'http://github.com/yivo/integer-inheritance'
+  s.license         = 'MIT'
+
+  s.executables     = `git ls-files -z -- bin/*`.split("\x0").map{ |f| File.basename(f) }
+  s.files           = `git ls-files -z`.split("\x0")
+  s.test_files      = `git ls-files -z -- {test,spec,features}/*`.split("\x0")
+  s.require_paths   = ['lib']
+
+  s.add_dependency 'activesupport', '>= 3.0', '< 6.0'
+  s.add_dependency 'activerecord',  '>= 3.0', '< 6.0'
+end

data/lib/integer-inheritance.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+require 'active_support/concern'
+require 'active_support/core_ext/string'
+require 'active_record'
+
+require 'integer-inheritance/macro'
+require 'integer-inheritance/extension'
+require 'integer-inheritance/evaluator'
+require 'integer-inheritance/column_types'
+
+module IntegerInheritance
+  class << self
+    def mappings
+      @mappings ||= {}
+    end
+
+    def describe(&block)
+      Evaluator.instance.instance_eval(&block)
+    end
+
+    attr_accessor :default_column
+  end
+
+  self.default_column = 'inheritance_type'
+end
+
+class ActiveRecord::Base
+  include IntegerInheritance::Macro
+end
+
+class ActiveRecord::ConnectionAdapters::TableDefinition
+  include IntegerInheritance::ColumnTypes
+end

data/lib/integer-inheritance/column_types.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+module IntegerInheritance
+  module ColumnTypes
+    def inheritance_column(*args)
+      options      = { null: false, index: true, limit: 1, default: 1 }.merge!(args.extract_options!)
+      column_names = args.presence || [IntegerInheritance.default_column]
+      column_names.each { |name| column(name, :integer, options) }
+    end
+  end
+end

data/lib/integer-inheritance/evaluator.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+module IntegerInheritance
+  class Evaluator
+    include Singleton
+
+    def with(base_class_name, &block)
+      @mapping = {}
+      instance_eval(&block)
+      (IntegerInheritance.mappings[base_class_name.to_s] ||= {}).merge!(@mapping)
+    ensure
+      @mapping = nil
+    end
+
+    def map(*sti_types, to:)
+      full_class_name = to.to_s
+      sti_types.each { |t| @mapping[t.to_i] = full_class_name }
+    end
+  end
+end

data/lib/integer-inheritance/extension.rb

@@ -0,0 +1,55 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+module IntegerInheritance
+  module Extension
+    extend ActiveSupport::Concern
+
+    included do
+      cattr_accessor :inheritance_mapping, instance_accessor: false
+      self.inheritance_mapping = {}
+    end
+
+    def as_json(options = {})
+      json = super(options)
+      col  = self.class.inheritance_column
+      json[col] = send(col)
+      json
+    end
+
+    module ClassMethods
+
+      # http://apidock.com/rails/ActiveRecord/Inheritance/ClassMethods/sti_name
+      def sti_name
+        inheritance_mapping.key(super)
+      end
+
+      alias inheritance_type sti_name
+
+      # http://apidock.com/rails/ActiveRecord/Inheritance/ClassMethods/find_sti_class
+      def find_sti_class(type)
+        lookup = inheritance_mapping[type.to_i]
+        lookup ? super(lookup) : super
+      end
+
+    private
+      # lib/active_record/inheritance.rb
+      def subclass_from_attributes(attrs)
+        col  = inheritance_column
+        type = col.is_a?(Symbol) ? attrs[col] || attrs[col.to_s] : attrs[col] || attrs[col.to_sym]
+
+        return if type.nil?
+
+        return if type == inheritance_type
+
+        subclass = inheritance_mapping[type].safe_constantize
+        unless descendants.include?(subclass)
+          raise ActiveRecord::SubclassNotFound, %{ Invalid single-table inheritance type:
+                                                   either subclass can't be mapped to #{type}
+                                                   either #{subclass} is not a subclass of #{name} }.squish
+        end
+        subclass
+      end
+    end
+  end
+end

data/lib/integer-inheritance/macro.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+module IntegerInheritance
+  module Macro
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def uses_integer_inheritance(options = {})
+        include IntegerInheritance::Extension unless respond_to?(:inheritance_mapping)
+
+        self.inheritance_column = options.fetch(:column, IntegerInheritance.default_column)
+
+        # This is workaround for ActionDispatch::Reloader (in development environment)
+        class_name = name
+        mapping    = IntegerInheritance.mappings[class_name]
+        self.inheritance_mapping = mapping if mapping
+        IntegerInheritance.mappings[class_name] = self.inheritance_mapping
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: integer-inheritance
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Yaroslav Konoplov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description: Single table inheritance mechanism built on integer types
+email:
+- eahome00@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- integer-inheritance.gemspec
+- lib/integer-inheritance.rb
+- lib/integer-inheritance/column_types.rb
+- lib/integer-inheritance/evaluator.rb
+- lib/integer-inheritance/extension.rb
+- lib/integer-inheritance/macro.rb
+homepage: http://github.com/yivo/integer-inheritance
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Single table inheritance mechanism built on integer types
+test_files: []