activerecord_base_without_table 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: be21cd5618a56030b694f04f7328e5e4b5f773806ee76a856723af5004609b7d
+  data.tar.gz: beba62e1fa11da71bb91c95e85fd858a7d564aa7a90b59f71fd4276529d42a0c
+SHA512:
+  metadata.gz: be45034ab5e6ffc9bfd5ccbb3166327df61a2e2745a6da089078ecfe85fadf8cc2e4ecc3b17d09fbdd75af8c81037768fcc98a2f483f3664ebe44dc24a2ae4af
+  data.tar.gz: 1dbcb3a7ef8ff4eacd38fdc81c02b6e1a3e62fb34ff919e9bb37b425c1dd0af6b61c6cd70e00607c2f19fc522976a699fe01c72230bb4fc4f8ec7703d30eb28e

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Ryan De Villa
+
+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/Rakefile

@@ -0,0 +1,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActiveRecord::BaseWithoutTable'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.rspec_opts = "-rbyebug --format documentation"
+  end
+rescue LoadError
+end
+
+task default: :spec

data/lib/active_record/attributes_builder_without_table.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# This class exists to support the use of `find_by_sql` on BaseWithoutTable
+# instances. It is highly aware of internal implementation details of
+# ActiveRecord.
+#
+# It ensures that Attributes that have been decorated
+# (e.g. with time zone conversion decorators) at class method evaluation
+# time do not lose their decoration when BaseWithoutTable instances are
+# brought to life via `#instantiate` (by way of `#find_by_sql`).
+#
+# This occurs when ActiveRecord needs to synthesize Attributes for
+# `additional_types` that are not part of the record's schema, which may
+# result from joining in columns from an associated relation in a raw SQL
+# query.
+#
+# Since the NullSchemaCache declares that the record has no schema,
+# all `additional_types` are in need of an Attribute to represent them.
+# However, creating them would clobber the Attributes that were already
+# constructed in the evaluation of the `BaseWithoutTable::column`
+# class method, and remove the decoration that was applied to them at that
+# time.
+module ActiveRecord
+  class AttributesBuilderWithoutTable < SimpleDelegator
+    def build_from_database(values = {}, additional_types = {})
+      super(values, {})
+    end
+  end
+end

data/lib/active_record/base_without_table.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require 'active_record/attributes_builder_without_table'
+require 'active_record/connection_adapters/null_adapter'
+require 'active_record/connection_adapters/null_schema_cache'
+
+module ActiveRecord
+  # Get the power of ActiveRecord models, including validation, without having a
+  # table in the database.
+  #
+  # == Usage
+  #
+  #   class Contact < ActiveRecord::BaseWithoutTable
+  #     column :name, :text
+  #     column :email_address, :text
+  #     column :message, :text
+  #   end
+  #
+  #   validates_presence_of :name, :email_address, :string
+  #
+  # This model can be used just like a regular model based on a table, except it
+  # will never be saved to the database.
+  #
+  class BaseWithoutTable < Base
+    self.abstract_class = true
+
+    class << self
+      def connection
+        ConnectionAdapters::NullAdapter.new(super)
+      end
+
+      def attributes_builder
+        AttributesBuilderWithoutTable.new(super)
+      end
+
+      def table_exists?
+        false
+      end
+
+      def inherited(subclass)
+        subclass.define_singleton_method(:table_name) do
+          "activerecord_base_without_table_#{subclass.name}"
+        end
+        super(subclass)
+      end
+
+      def attribute_names
+        _default_attributes.keys.map(&:to_s)
+      end
+
+      def column(name, sql_type = nil, default = nil, null = true)
+        cast_type = lookup_attribute_type(sql_type)
+        decorated_type = attribute_type_decorations.apply(name, cast_type)
+
+        define_attribute(name.to_s, decorated_type, default: default)
+      end
+
+      def lookup_attribute_type(sql_type)
+        # This is an emulation of the Rails 4.1 runtime behaviour.
+        # Please consider rewriting once we move to Rails 5.1.
+        mapped_sql_type =
+          case sql_type
+          when :datetime
+            :date_time
+          when :datetime_point
+            :integer
+          when :enumerable
+            :value
+          else
+            sql_type
+          end.to_s.camelize
+
+        "::ActiveRecord::Type::#{mapped_sql_type}".constantize.new
+      end
+
+      def gettext_translation_for_attribute_name(attribute)
+        # `rake gettext:store_model_attributes` processes our BaseWithoutTable models, but we have our own rake task
+        # for that. Return right away if calling gettext_translation_for_attribute_name on BaseWithoutTable
+        return "BaseWithoutTable" if self == BaseWithoutTable
+
+        attribute = attribute.to_s
+        if attribute.ends_with?("_id")
+          humanize_class_name(attribute)
+        else
+          "#{self}|#{attribute.split('.').map!(&:humanize).join('|')}"
+        end
+      end
+    end
+  end
+end

data/lib/active_record/connection_adapters/null_adapter.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# This class is a concrete implementation of ConnectionAdapters::AbstractAdapter
+# that eliminates all code paths attempting to open a connection to a real
+# database backend.
+module ActiveRecord
+  module ConnectionAdapters
+    class NullAdapter < SimpleDelegator
+      def schema_cache
+        NullSchemaCache.new
+      end
+    end
+  end
+end

data/lib/active_record/connection_adapters/null_schema_cache.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# When run against a real database backend, ordinarily the SchemaCache
+# would open a connection to the DB and attempt to retrieve schema
+# information from it.
+#
+# Here, we declare that these ActiveRecord classes do not have any
+# database-backed schema or column information. The structure of an
+# ActiveRecord::BaseWithoutTable is purely an in-memory construct
+# and is defined through the use of the `column` class methods.
+module ActiveRecord
+  module ConnectionAdapters
+    class NullSchemaCache
+      def columns(*args)
+        []
+      end
+
+      def columns_hash(*args)
+        {}
+      end
+    end
+  end
+end

data/lib/activerecord_base_without_table.rb

@@ -0,0 +1 @@
+require 'active_record/base_without_table'

data/lib/tasks/base_without_table_migration_harness_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :base_without_table do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: activerecord_base_without_table
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ryan De Villa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.7
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.4
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.5.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.5.2
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 9.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 9.0.6
+description: Test harness for BaseWithoutTable migration to Rails 5
+email:
+- ryand@nulogy.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- Rakefile
+- lib/active_record/attributes_builder_without_table.rb
+- lib/active_record/base_without_table.rb
+- lib/active_record/connection_adapters/null_adapter.rb
+- lib/active_record/connection_adapters/null_schema_cache.rb
+- lib/activerecord_base_without_table.rb
+- lib/tasks/base_without_table_migration_harness_tasks.rake
+homepage: https://nulogy.com
+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.7.7
+signing_key: 
+specification_version: 4
+summary: Test harness for BaseWithoutTable migration to Rails 5
+test_files: []