ar_virtual_field 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 891a7d54ceef88352b9799d13a9fa27ee5a390e0ecacc634de0140e61565a648
-  data.tar.gz: 138333e6d5f189a1754ad35b50ac7283cabef173df02c37e2f1848bedf18d7c8
+  metadata.gz: ef8b11855497a6f4ed5be9d1717453133c52d9d3691000c29b83d5f3561670ec
+  data.tar.gz: f207d7151c03885d2698b9bf6bc91c166dee17aec39b7d2d8376d74dee5b824f
 SHA512:
-  metadata.gz: c95f69519e4d0c4abaacfcb98c878fc7aedf964d7e9bae19e7054eb80a440284004b03251a002259ebcd7494cbe9dade1e16e9640cd99019a545c35b3882bb69
-  data.tar.gz: 7c424b0acc36049f65192e9ebf7ecaa3f7c62b76c88785494c92cefb5184bb36eeb7e9944d68b5d918e1ffd1e52b174d397f14ce8c82475f2fc4aea39c0d6595
+  metadata.gz: 7aae58b16112adb85dfa95874b1a794049e86a1ac5436a40278825e285bd5004fd7ff4c4ad3c6457a4bc791878c5bea1d4ed223e1de8d41aa719a0d0562228ef
+  data.tar.gz: ef0031c1df9b311373af9a12a4dfab15e4628ad87b79dfed6214a4cc5e94e0c72b4a0453cd930a43a2ac7b214721a489d6c86cf66a9bd41db915464b29f1207d

data/README.md

@@ -14,7 +14,7 @@ gem 'ar_virtual_field'
 
 ## Usage
 
-### Defining a Virtual Field
+### Defining a virtual field
 
 To define a virtual field, use the virtual_field method in your model:
 
@@ -29,9 +29,9 @@ virtual_field :virtual_attribute,
 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 | arel_node` or a lambda returning an SQL `string | arel_node`) to define how the field is computed.
+  - `select`: SQL selection logic (can be a string or arel node or a lambda returning a string or arel_node) 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.
+  - `default`: A default value for the virtual field if the result is nil (optional).
 
 Example:
 
@@ -42,33 +42,32 @@ class User < ApplicationRecord
     select: -> { "COUNT(orders.id)" },
     get: -> { orders.count },
     default: 0
+
+  virtual_field :fullname,
+    select: -> { "name || surname" },
+    get: -> { "#{name}#{surname}" }
 end
-```
 
-### Using the scope in queries:
-```ruby
-users_with_orders = User.with_total_orders
+users_with_orders = User.with_total_orders # queries database once
+
+user = users_with_orders.first
+user.total_orders # => value computed by database
+user.fullname # => value computed by database
 ```
 
-### Scopes and Querying:
+### 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)
+User.with_total_orders.where(ArVirtualField[: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).
+Bug reports and pull requests are welcome on GitHub at https://github.com/emfy0/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/emfy0/ar_virtual_field/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -76,4 +75,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## 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).
+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/emfy0/ar_virtual_field/blob/main/CODE_OF_CONDUCT.md).

data/lib/ar_virtual_field/version.rb

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

data/lib/ar_virtual_field.rb

@@ -1,4 +1,6 @@
-# frozen_string_literal: true
+# frozen_string_litera: true
+
+require "active_record"
 
 module ArVirtualField
   module HelperMethods
@@ -9,9 +11,21 @@ module ArVirtualField
 
       relation.select(*values)
     end
+
+    def self.table_name(name)
+      "#{name}_outer"
+    end
+
+    def self.table_with_column(name)
+      "#{name}_outer.#{name}"
+    end
+  end
+
+  def self.[](field)
+    Arel.sql(HelperMethods.table_with_column(field))
   end
 
-  def virtual_field(name, scope: nil, select:, get:, default:)
+  def virtual_field(name, scope: nil, select:, get:, default: nil)
     name = name.to_s
     current_class = self
     unwrap_arel_expression = -> (exp) { exp.is_a?(Arel::Nodes::NodeExpression) ? exp : Arel.sql(exp) }
@@ -31,9 +45,14 @@ module ArVirtualField
       scope(scope_name, scope)
 
       scope(:"with_#{name}", -> do
-        scope_query = current_class.send(scope_name).select(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}")
+        scope_query = current_class
+          .send(scope_name)
+          .select(select_lambda.().as(name), "#{table_name}.id")
+
+        HelperMethods.select_append(joins(<<~SQL.squish), "#{HelperMethods.table_with_column(name)} AS #{name}")
+          LEFT JOIN (#{scope_query.to_sql}) #{HelperMethods.table_name(name)}
+            ON #{HelperMethods.table_name(name)}.id = #{table_name}.id
+        SQL
       end)
     else
       scope(:"with_#{name}", -> do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ar_virtual_field
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Pavel Egorov