activerecord_lazy_columns 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b3001f101fd41aa75d33964605b7d0c3b2f9e7376390c298da0a078ec31400d3
+  data.tar.gz: 11d35e89fbef2f2667e4ad14e24dabdedab8c5bcea576627d38a505a4a5c551e
+SHA512:
+  metadata.gz: 8dc46a9789ff339e72480b738abb34e8b510517a7b5210d9e9a9d44bc3b5e2b8f9e8b89d877b33e414d560787f89c29ae3f76d964232158a1ad553ee8a0bd6c0
+  data.tar.gz: c9e2f9cf53ffee1be178750965d49b819d4df5804328b49078b6d9c66050323523e8ab071fcda0da2256880086d1fad4ad5e343ef923a521a4223ddfa9d9868b

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## master (unreleased)
+
+## 0.1.0 (2025-09-16)
+
+- First release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025- fatkodima
+
+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,84 @@
+# ActiverecordLazyColumns
+
+`activerecord_lazy_columns` is a gem that lets you specify columns to be loaded lazily in your Active Record models.
+
+By default, Active Record loads all the columns in each model instance. This gem lets you specify columns
+to be excluded by default. This is useful to reduce the memory taken by Active Record when loading records
+that have large columns if those particular columns are actually not required most of the time.
+In this situation it can also greatly reduce the database query time because loading large BLOB/TEXT columns
+generally means seeking other database pages since they are not stored wholly in the record's page itself.
+
+Notice that a better approach can be moving those columns to new models, since Active Record loads related models
+lazily by default. This gem is an easy workaround.
+
+## Requirements
+
+- ruby 3.2+
+- activerecord 7.2+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "activerecord_lazy_columns"
+```
+
+## Usage
+
+Use `lazy_columns` in your Active Record models to define which columns should be loaded lazily:
+
+```ruby
+class Action < ApplicationRecord
+  lazy_columns :comments
+end
+```
+
+Now, when you fetch some action, the comments are not loaded:
+
+```ruby
+Action.create!(title: "Some action", comments: "Some comments") # => <Action id: 1...>
+action = Action.find(1) # => <Action id: 1, title: "Some action">
+```
+
+And if you try to read the `comments` attribute, it will be loaded into the model:
+
+```ruby
+action.comments # => "Some comments"
+action # => <Action id: 1, title: "Some action", comments: "Some comments"
+```
+
+## How the gem works
+
+This gem does two things:
+
+- Modifies the `default_scope` of the model so that it fetches all the attributes except the ones marked as lazy.
+- Defines a reader method per lazy attribute that will load the corresponding column under demand.
+
+### Eager loading of attributes defined as lazy
+
+The first time you access a lazy attribute, a new database query will be executed to load it. If you are going
+to operate on a number of objects and want to have the lazy attributes eagerly loaded, use Active Record's
+`.select()` in the initial query. For example:
+
+```ruby
+Action.select(:comments)
+```
+
+## Credits
+
+Thanks to the [`lazy_columns` gem](https://github.com/jorgemanrubia/lazy_columns) for the original idea.
+
+## Development
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update
+the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag
+for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/fatkodima/activerecord_lazy_columns.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/activerecord_lazy_columns/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ActiveRecordLazyColumns
+  VERSION = "0.1.0"
+end

data/lib/activerecord_lazy_columns.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require "active_record"
+
+require_relative "activerecord_lazy_columns/version"
+
+module ActiveRecordLazyColumns
+  # Extension for Active Record to add `lazy_columns` method with an ability
+  # to lazily load specific columns.
+  #
+  module ModelExtension
+    attr_writer :lazy_loaded_columns
+
+    def lazy_loaded_columns
+      @lazy_loaded_columns || []
+    end
+
+    # Declare some columns to be loaded lazily.
+    #
+    # @example
+    #   class Action < ApplicationRecord
+    #     lazy_columns :comments
+    #   end
+    #
+    def lazy_columns(*columns)
+      columns = columns.map(&:to_s)
+      self.lazy_loaded_columns = columns
+
+      default_scope { select(column_names - columns) }
+      columns.each { |column| define_lazy_reader_for(column) }
+    end
+
+    private
+      def define_lazy_reader_for(column)
+        define_method(column) do
+          unless has_attribute?(column)
+            value = self.class.unscoped.where(id: [id]).pick(column)
+            write_attribute(column, value)
+            clear_attribute_changes([column])
+          end
+
+          read_attribute(column)
+        end
+      end
+  end
+
+  # @private
+  module RelationExtension
+    def count(column_name = nil)
+      if column_name.nil? && klass.lazy_loaded_columns.any?
+        column_name = :all
+      end
+
+      super
+    end
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  extend ActiveRecordLazyColumns::ModelExtension
+
+  ActiveRecord::Relation.prepend(ActiveRecordLazyColumns::RelationExtension)
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: activerecord_lazy_columns
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- fatkodima
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.2'
+description:
+email:
+- fatkodima123@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/activerecord_lazy_columns.rb
+- lib/activerecord_lazy_columns/version.rb
+homepage: https://github.com/fatkodima/activerecord_lazy_columns
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/fatkodima/activerecord_lazy_columns
+  source_code_uri: https://github.com/fatkodima/activerecord_lazy_columns
+  changelog_uri: https://github.com/fatkodima/activerecord_lazy_columns/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.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: Adds support for lazy-loading columns in Active Record models
+test_files: []