with_record 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a85bfdc493cc49684f10c49e2a8ada346bc89525db6e022f2ac194732befd4a0
-  data.tar.gz: ed31f21b9a16b84bb4b97bfc911663b00d5d12bd818e5ea1946241075f4f99d6
+  metadata.gz: 44c03e0867828bf1a25fd554d3890846f04b11dfe7a09dafd77af6442e243ceb
+  data.tar.gz: bc5bb9ae0132ea0da8d352fde7fa4828685f6caaa84611269f7688f1bf23df8a
 SHA512:
-  metadata.gz: 12068099c10ee390ee8db671cc253b1b85c6c3c75a88a9fe67befdb3db7433af8fbdefc65a0a3b512f570a9d2987b1e01fe58327df99e5069b8764c42ed4bfab
-  data.tar.gz: 7902e50a4cd12cdfb1467adf64b80c9c4b9e3c24ef8754ed5eaf14b2c8fe579533f61d63524ff8d4dd11f26d7ec8cd10e9f8cc9f787438a9e6baab87a0cb79ea
+  metadata.gz: 40f932d4c3ffa854adea095f6584488ea1e56a9c971cf95a03dd8c5d8b48c87783f19f4cdab4eb5ed7219b905ca421eddcf668999a3934e4d93df079aa65634f
+  data.tar.gz: 78e709238a2be3939aa156e11f168ed5d670b39a4eb8ea4f6123ed77df8e7a0c35450f2190a952b6204121a89b30526fdd6464e3d12ff13340648f4d606ac34b

data/README.md

@@ -1,8 +1,70 @@
-# WithRecord
-Short description and motivation.
+# with_record
+
+[![RailsJazz](https://github.com/igorkasyanchuk/rails_time_travel/blob/main/docs/my_other.svg?raw=true)](https://www.railsjazz.com)
+[![https://www.patreon.com/igorkasyanchuk](https://github.com/igorkasyanchuk/rails_time_travel/blob/main/docs/patron.svg?raw=true)](https://www.patreon.com/igorkasyanchuk)
+
+This gem could DRY your code and return association/relation with additioanl records. Could be used in case you have form with soft-deleted value. 
+
+**The example of problem:**
+
+You have 2 models: User and Project. User has many projects. Project belongs to "assignee" (or author).
+
+Let's say you have "soft-delete" (for example using paranoia" gem) and deleted user. Same time, all projects are still available (you just have such logic).
+
+Now you want to edit the project. And in the form you have a dropdown with all active users. In this case list will be blank (because user was deleted).
+
+So usually you need to do something like:
+
+```slim
+# just an example with problem (!!!)
+= f.input :assignee_id, as: :select, collection: User.all + [User.unscoped.find_by(id: f.object.assineed_id)]
+```
+
+But now you can do the following:
+```slim
+# just an example with solution
+= f.input :assignee_id, as: :select, collection: User.all.with_record(f.object.assineed_id)
+```
+
+And as a bonus you can also call scopes for example:
+
+```ruby
+User.all.with_record(f.object.assineed_id).ordered` # to return by first_name
+```
+
+Or
+
+```ruby
+@project.users.with_record(42).ordered # to include user by ID
+@project.users.with_records(42, 43, 44).ordered # to include user by ID's
+```
 
 ## Usage
-How to use my plugin.
+
+This gem is adding two methods to ActiveRecord Relations and Associations - `with_record(...)` and `with_records(...)`.
+
+You can do the following:
+
+```ruby
+    u1 = User.create(name: 'John')
+    u2 = User.create(name: 'Bob')
+
+    p1 = u1.projects.create(name: 'apple')
+    p2 = u2.projects.create(name: 'google')
+    p3 = u2.projects.create(name: 'amazon')
+
+    assert_equal u1.projects.with_record(p2), [p1, p2]
+    assert_equal u1.projects.with_records(p2, p3), [p1, p2, p3]
+    assert_equal u1.projects.with_records([p2, p3]), [p1, p2, p3]
+
+    assert_equal Project.where(id: p1.id).with_record(p2), [p1, p2]
+    assert_equal Project.where(id: p1.id).with_records(p2, p3), [p1, p2, p3]
+    assert_equal Project.where(id: p1.id).with_records([p2, p3]), [p1, p2, p3]
+
+    assert_equal Project.where(id: p1.id).with_record(nil), [p1]    
+    assert_equal Project.where(id: p1.id).with_records(nil), [p1]
+ ```
+
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -21,8 +83,22 @@ Or install it yourself as:
 $ gem install with_record
 ```
 
+## How it works and limitations
+
+- it's adding 2 methods to AR Relations and Associations.
+- it's executing original scope, returning and ID's (or other PK values), then adding a new ID into it and returning a new releation
+- joins, includes, ... before call `.with_record` won't be returned in final scope
+
 ## Contributing
-Contribution directions go here.
+
+You are welcome to contribute.
 
 ## License
+
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+[<img src="https://github.com/igorkasyanchuk/rails_time_travel/blob/main/docs/more_gems.png?raw=true"
+/>](https://www.railsjazz.com/)
+
+[<img src="https://github.com/igorkasyanchuk/rails_time_travel/blob/main/docs/more_gems.png?raw=true"
+/>](https://www.railsjazz.com/?utm_source=github&utm_medium=bottom&utm_campaign=with_record)

data/lib/with_record/railtie.rb

@@ -15,10 +15,10 @@ module WithRecord
     end
 
     config.after_initialize do
-      # load models
-      Rails.application.eager_load!
-      ActiveRecord::Relation.send :include, Extension
-      ActiveRecord::Associations::CollectionProxy.send :include, Extension
+      ActiveSupport.on_load(:active_record) do
+        ActiveRecord::Relation.send :include, Extension
+        ActiveRecord::Associations::CollectionProxy.send :include, Extension
+      end
     end
   end
 end

data/lib/with_record/version.rb

@@ -1,3 +1,3 @@
 module WithRecord
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: with_record
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Igor Kasyanchuk
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-03-07 00:00:00.000000000 Z
+date: 2024-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.6
+        version: 2.0.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.6
+        version: 2.0.2
 description: Include more records in your relations/associations, just to DRY your
   code.
 email:
@@ -57,7 +57,7 @@ homepage: https://github.com/igorkasyanchuk/with_record
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -72,8 +72,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Include more records in your relations/associations, just to DRY your code.
 test_files: []