activerecord-model_inheritance 1.0.0

data/lib/generators/active_record/model_inheritance/model/model_generator.rb

@@ -0,0 +1,75 @@
+require 'rails/generators'
+require 'active_record/model_inheritance'
+
+module ActiveRecord
+  module ModelInheritance
+    module Generators
+      class ModelGenerator < Rails::Generators::NamedBase
+        source_root File.expand_path('templates', __dir__)
+
+        desc 'Create derived model and definition files'
+
+        argument :derives_from, type: :string, optional: false
+
+        class_option :only_definition,
+                     type: :boolean,
+                     required: false,
+                     default: false,
+                     desc: 'Whether or not to generate only the definition file'
+
+        def generate_model
+          return if skip_generate_model?
+
+          if rails_application?
+            invoke 'model',
+                   [file_path.singularize],
+                   options.merge(
+                     fixture_replacement: false,
+                     migration: false
+                   )
+          else
+            template 'model.erb', ModelInheritance.models_path.join("#{file_path.singularize}.rb")
+          end
+        end
+
+        def inject_configuration_to_model
+          return if skip_generate_model?
+
+          inject_into_class ModelInheritance.models_path.join("#{file_path.singularize}.rb"), class_name do
+            evaluate_template 'model_config.erb'
+          end
+        end
+
+        def create_definition_file
+          template 'definition.erb', ModelInheritance.definitions_path.join("#{table_name}.rb")
+        end
+
+        no_tasks do
+          def evaluate_template source
+            source = File.expand_path find_in_source_paths(source.to_s)
+
+            erb = ERB.new(
+              File.read(source),
+              trim_mode: '-',
+              eoutvar: '@output_buffer'
+            )
+
+            erb.result binding
+          end
+
+          def rails_application?
+            defined?(Rails.application) && Rails.application.present?
+          end
+
+          def skip_generate_model?
+            options[:only_definition]
+          end
+
+          def formatted_base_name
+            "::#{derives_from.camelize}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/generators/active_record/model_inheritance/model/templates/definition.erb

@@ -0,0 +1 @@
+ActiveRecord::ModelInheritance::ViewDefinition.define_derived_view <%= name %>

data/lib/generators/active_record/model_inheritance/model/templates/model.erb

@@ -0,0 +1,2 @@
+class <%= class_name %> < ActiveRecord::Base
+end

data/lib/generators/active_record/model_inheritance/model/templates/model_config.erb

@@ -0,0 +1,3 @@
+  include ActiveRecord::ModelInheritance::Model
+
+  derives_from <%= formatted_base_name %>

data/lib/generators/active_record/model_inheritance/view/templates/create_migration.erb

@@ -0,0 +1,13 @@
+class <%= migration_class_name %> < <%= activerecord_migration_class %>
+  def change
+    create_table <%= formatted_inner_table_name %> do |t|
+      # add your derived model extra fields here
+
+      t.references <%= formatted_base_name %>, foreign_key: true
+
+      t.timestamps
+    end
+
+    create_view <%= formatted_table_name %>
+  end
+end

data/lib/generators/active_record/model_inheritance/view/templates/update_migration.erb

@@ -0,0 +1,5 @@
+class <%= migration_class_name %> < <%= activerecord_migration_class %>
+  def change
+    update_view <%= formatted_table_name %>, version: <%= next_version %>, revert_to_version: <%= current_version %>
+  end
+end

data/lib/generators/active_record/model_inheritance/view/view_generator.rb

@@ -0,0 +1,121 @@
+require 'rails/generators'
+require 'rails/generators/active_record'
+require 'active_record/model_inheritance'
+require 'active_record/model_inheritance/view_definition'
+
+module ActiveRecord
+  module ModelInheritance
+    module Generators
+      class ViewGenerator < Rails::Generators::NamedBase
+        include Rails::Generators::Migration
+
+        desc 'Generate SQL view definition and create initial/update migration'
+
+        source_root File.expand_path('templates', __dir__)
+
+        class_option :skip_migration,
+                     type: :boolean,
+                     required: false,
+                     default: false,
+                     desc: 'Whether or not to generate a migration file'
+
+        def create_view_file
+          create_file ModelInheritance
+                        .views_path
+                        .join("#{table_name}_v#{formatted_next_version}.sql"),
+                      view_definition.to_sql
+        end
+
+        def create_migration_file
+          return if skip_generate_migration?
+
+          if creating?
+            migration_template(
+              'create_migration.erb',
+              ModelInheritance.migrations_path.join("create_#{table_name}.rb")
+            )
+          else
+            migration_template(
+              'update_migration.erb',
+              ModelInheritance.migrations_path.join("update_#{table_name}_to_version_#{formatted_next_version}.rb")
+            )
+          end
+        end
+
+        def self.next_migration_number dir
+          ::ActiveRecord::Generators::Base.next_migration_number dir
+        end
+
+        no_tasks do
+          def current_version
+            @current_version ||= ModelInheritance
+                                   .views_path
+                                   .glob("#{table_name}_v*.sql")
+                                   .last
+                                   .then { |last_version_file| last_version_file&.basename&.to_s }
+                                   .then do |last_version_name|
+                                     version_regex
+                                       .match(last_version_name)
+                                       .try(:[], :version)
+                                       .to_i
+                                   end
+          end
+
+          def next_version
+            @next_version ||= current_version.next
+          end
+
+          def formatted_next_version
+            next_version
+              .to_s
+              .rjust(2, '0')
+          end
+
+          def creating?
+            current_version.zero?
+          end
+
+          def skip_generate_migration?
+            options[:skip_migration]
+          end
+
+          def version_regex
+            %r{\A#{table_name}_v(?<version>\d+)\.sql\z}
+          end
+
+          def formatted_class_name
+            class_name.tr('.:', '').pluralize
+          end
+
+          def migration_class_name
+            if creating?
+              "Create#{formatted_class_name}"
+            else
+              "Update#{formatted_class_name}ToVersion#{next_version}"
+            end
+          end
+
+          def activerecord_migration_class
+            "ActiveRecord::Migration[#{ActiveRecord::Migration.current_version}]"
+          end
+
+          def formatted_inner_table_name
+            ":#{view_definition.model_class.model_inheritance_inner_model.table_name}"
+          end
+
+          def formatted_base_name
+            ":#{view_definition.model_class.model_inheritance_base_model.model_name.singular}"
+          end
+
+          def formatted_table_name
+            ":#{table_name}"
+          end
+
+          def view_definition
+            @view_definition ||= ViewDefinition.from_name table_name
+          end
+        end
+      end
+    end
+  end
+end

data/sig/active_record/model_inheritance/generators/model_generator.rbs

@@ -0,0 +1,23 @@
+module ActiveRecord
+  module ModelInheritance
+    module Generators
+      class ModelGenerator < Rails::Generators::NamedBase
+        def generate_model: () -> void
+
+        def inject_configuration_to_model: () -> void
+
+        def create_definition_file: () -> void
+
+        def evaluate_template: (String source) -> String
+
+        def rails_application?: () -> bool
+
+        def skip_generate_model?: () -> bool
+
+        def formatted_base_name: () -> String
+
+        def formatted_base_reference: () -> String
+      end
+    end
+  end
+end

data/sig/active_record/model_inheritance/generators/view_generator.rbs

@@ -0,0 +1,45 @@
+module ActiveRecord
+  module ModelInheritance
+    module Generators
+      class ViewGenerator < Rails::Generators::NamedBase
+        include Rails::Generators::Migration
+
+        @current_version: Integer
+        @next_version: Integer
+        @view_definition: ViewDefinition
+
+        def create_view_file: () -> void
+
+        def create_migration_file: () -> void
+
+        def self.next_migration_number: (untyped dir) -> untyped
+
+        def current_version: () -> Integer
+
+        def next_version: () -> Integer
+
+        def formatted_next_version: () -> String
+
+        def creating?: () -> bool
+
+        def skip_generate_migration?: () -> bool
+
+        def version_regex: () -> Regexp
+
+        def formatted_class_name: () -> String
+
+        def migration_class_name: () -> String
+
+        def activerecord_migration_class: () -> String
+
+        def formatted_inner_table_name: () -> String
+
+        def formatted_base_name: () -> String
+
+        def formatted_table_name: () -> String
+
+        def view_definition: () -> ViewDefinition
+      end
+    end
+  end
+end

data/sig/active_record/model_inheritance/version.rbs

@@ -0,0 +1,5 @@
+module ActiveRecord
+  module ModelInheritance
+    VERSION: String
+  end
+end

data/sig/active_record/model_inheritance/view_definition.rbs

@@ -0,0 +1,20 @@
+module ActiveRecord
+  module ModelInheritance
+    class ViewDefinition
+      def initialize: (Class model_class, untyped definition) -> void
+
+      def self.define_derived_view: (Class model_class) -> ViewDefinition
+
+      def self.from_model: (Class model_class) -> ViewDefinition
+
+      def self.from_name: (String name) -> ViewDefinition
+
+      attr_reader definition: untyped
+      attr_reader model_class: Class
+
+      def attributes_mapping: -> {base: Array[Symbol], inner: Array[Symbol]}
+
+      def to_sql: -> String
+    end
+  end
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-model_inheritance
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Moku S.r.l.
+- Marco Volpato
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: scenic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+description: An attempt at real inheritance for ActiveRecord models.
+email:
+- info@moku.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/active_record/model_inheritance.rb
+- lib/active_record/model_inheritance/error.rb
+- lib/active_record/model_inheritance/model.rb
+- lib/active_record/model_inheritance/version.rb
+- lib/active_record/model_inheritance/view_definition.rb
+- lib/activerecord/model_inheritance.rb
+- lib/generators/active_record/model_inheritance/generators.rb
+- lib/generators/active_record/model_inheritance/model/model_generator.rb
+- lib/generators/active_record/model_inheritance/model/templates/definition.erb
+- lib/generators/active_record/model_inheritance/model/templates/model.erb
+- lib/generators/active_record/model_inheritance/model/templates/model_config.erb
+- lib/generators/active_record/model_inheritance/view/templates/create_migration.erb
+- lib/generators/active_record/model_inheritance/view/templates/update_migration.erb
+- lib/generators/active_record/model_inheritance/view/view_generator.rb
+- sig/active_record/model_inheritance/generators/model_generator.rbs
+- sig/active_record/model_inheritance/generators/view_generator.rbs
+- sig/active_record/model_inheritance/version.rbs
+- sig/active_record/model_inheritance/view_definition.rbs
+homepage: https://github.com/moku-io/activerecord-model_inheritance
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/moku-io/activerecord-model_inheritance
+  source_code_uri: https://github.com/moku-io/activerecord-model_inheritance
+  changelog_uri: https://github.com/moku-io/activerecord-model_inheritance/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: An attempt at real inheritance for ActiveRecord models.
+test_files: []