ar_virtual_field 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4ca9b36a6e1b3b4432979509a61c611962b2a696ea0494bc27b856c57436fa29
+  data.tar.gz: 85d952b60c94fbe1be24cefec6432364fac2f144f739040a92575eddfa7ee556
+SHA512:
+  metadata.gz: d072a6c0ee93c4d07114bb8bc9066000c19655484c8a8379e44e2f6bf0819fadd2a5d960078c9241f5dcc72c0202accb250f31b331bf001251c1a89c3051a9b9
+  data.tar.gz: fe351b6577315a727b74e6dbe8c6cf4f685ecf0785002b2fc1e067e1cac9c633e0b64654fe9f31142d7a7b220998b41cf6c95ca094a6939edca9188eb5588ea6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Pavel Egorov
+
+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,79 @@
+# Active Record Virtual Field
+
+Gem provides an easy mechanism to define virtual fields within an ActiveRecord model.
+It allows defining attributes that are not directly stored in the database, but are instead computed or fetched using SQL queries.
+Gem handles both the definition of these fields and the creation of scopes to query models with the virtual field included.
+
+## Installation
+
+Add gem to Gemfile:
+
+```ruby
+gem 'ar_virtual_field'
+```
+
+## Usage
+
+### Defining a Virtual Field
+
+To define a virtual field, use the virtual_field method in your model:
+
+```ruby
+virtual_field :virtual_attribute, 
+  scope: -> { joins(:related_model).where(related_models: { some_column: value }) },
+  select: -> { "SUM(related_models.some_value)" },
+  get: -> { calculate_some_value },
+  default: 0
+```
+
+Parameters:
+  - `name`: The name of the virtual field.
+  - `scope`: A lambda defining a scope that fetches the virtual field value (optional).
+  - `select`: SQL selection logic (can be a string or a lambda returning an SQL string) to define how the field is computed.
+  - `get`: A method to retrieve the value of the virtual field when the field isn't fetched via SQL.
+  - `default`: A default value for the virtual field if the result is nil.
+
+Example:
+
+```ruby
+class User < ApplicationRecord
+  virtual_field :total_orders,
+    scope: -> { joins(:orders).group(:id) },
+    select: -> { "COUNT(orders.id)" },
+    get: -> { orders.count },
+    default: 0
+end
+```
+
+### Using the scope in queries:
+```ruby
+users_with_orders = User.with_total_orders
+```
+
+### Scopes and Querying:
+
+ - `with_#{name}`: Automatically generated scope to include the virtual field in queries. You can use this scope in your ActiveRecord queries like so:
+
+```ruby
+User.with_total_orders.where(total_orders: 5)
+```
+
+This will include the total_orders virtual field in the SQL query and allow filtering by it.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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//ar_virtual_field. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com//ar_virtual_field/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ArVirtualField project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com//ar_virtual_field/blob/main/CODE_OF_CONDUCT.md).

data/lib/ar_virtual_field/version.rb

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

data/lib/ar_virtual_field.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module ArVirtualField
+  module HelperMethods
+    def self.select_append(relation, *values)
+      if relation.select_values.empty?
+        values.unshift(relation.arel_table[Arel.star])
+      end
+
+      relation.select(*values)
+    end
+  end
+
+  def virtual_field(name, scope:, select: nil, get:, default:)
+    name = name.to_s
+    current_class = self
+    unwrap_arel_expression = -> (exp) { exp.is_a?(Arel::Nodes::NodeExpression) ? exp : Arel.sql(exp) }
+
+    select_lambda =
+      case select
+      when Proc
+        -> { unwrap_arel_expression.(select.()) }
+      else
+        arel = unwrap_arel_expression.(select)
+        -> { arel }
+      end
+
+    if scope
+      scope_name = :"_scope_#{name}"
+
+      scope(scope_name, scope)
+
+      scope(:"with_#{name}", -> do
+        scope_query = current_class.send(scope_name)
+
+        if scope_query.group_values.present?
+          scope_query = scope_query.reselect(select_lambda.().as(name), "#{table_name}.id")
+          new_scope = joins("LEFT JOIN (#{scope_query.to_sql}) #{name}_outer ON #{name}_outer.id = #{table_name}.id")
+          HelperMethods.select_append(new_scope, "#{name}_outer.#{name} AS #{name}")
+        else
+          HelperMethods.select_append(send(scope_name), select_lambda.().as(name))
+        end
+      end)
+    else
+      scope(:"with_#{name}", -> do
+        HelperMethods.select_append(self, select_lambda.().as(name))
+      end)
+    end
+
+    method_name = :"ar_virtual_field_#{name}"
+
+    define_method(method_name, &get)
+    define_method(name) do
+      if ActiveRecord::Base.connection.query_cache_enabled
+        attributes.key?(name) ? (self[name] || default) : send(method_name)
+      else
+        send(method_name)
+      end
+    end
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  ActiveRecord::Base.extend(ArVirtualField)
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: ar_virtual_field
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pavel Egorov
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-09-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+description: Adds .virtual_field method to make it easy to define virtual fields
+email:
+- moonmeander47@ya.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/ar_virtual_field.rb
+- lib/ar_virtual_field/version.rb
+homepage: https://github.com/emfy0/ar_virtual_field
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/emfy0/ar_virtual_field
+  source_code_uri: https://github.com/emfy0/ar_virtual_field
+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.4.10
+signing_key:
+specification_version: 4
+summary: Provide an easy mechanism to define virtual fields within an ActiveRecord
+  model
+test_files: []