quickery 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f23d071c0950a5aea01e1fbaac6b70b8024afc869309116947c0b9bf093e5869
-  data.tar.gz: ded1a4a4900160e8e614ad09ffcf824b6f7fde68fdc9c2b4d61d1fe2bc650ec1
+  metadata.gz: 6a115d4b653df7ef6ed09fac7b8aab0aa6116935cd621a47d702dc7a8ddfa186
+  data.tar.gz: f6022d80f9303086374ea8b0e7f2f6b68c1467479d4fb28b3793614c8234cdd4
 SHA512:
-  metadata.gz: 0fa75bd9539cfd2095beb17099685c83ef0c617723c829bdbbc6041c791292f1f5d8cd98561aca87e69655c2c1850d4f18e4c4615ef67108c662c6c047ffe0d9
-  data.tar.gz: 8f3be6901dd857c976b1d08e54245f7b9d249dc7738f59e4ddbf411e24bca40e36a43304ebc730af74f7f472ef307982ea165fe6f47dbc657e15a47741785a23
+  metadata.gz: 8ae04a8c8f3d4f032cb3edd612b1935ea0a6c7032c7990731bb8d3ef5c7105210a49f28049ddd5caabaa105a630841c1292b93293e3c01ad68d420449b656f99
+  data.tar.gz: 0defe1360596b9c02c7124e3ec35c7dfa3b432511a5983d3b7a9400318a4bc670687c7ae99bd7fe2c2b3696af1a940d3b2617851d7e62879c7ed56ec656de400

data/README.md

@@ -11,6 +11,7 @@
 
 * **Rails 4 or 5**
 * **(Rails 3 still untested)**
+* `ActiveRecord`
 
 ## Setup
 1. Add the following to your `Gemfile`:
@@ -208,8 +209,12 @@ puts Employee.joins(branch: :company).where(companies: { id: company.id })
 * Possibly support two-way mapping of attributes? So that you can do, say... `employee.update!(branch_company_name: 'somenewcompanyname')`
 * Improve "updates" across the quickery-defined model callbacks, by grouping attributes that will be updated and update in one go, instead of independently updating per each quickery-defined attribute
 
-## Contributing
-* pull requests and forks are very much welcomed! :) Let me know if you find any bug! Thanks
+## Other Similar Gems
+See [my detailed comparisons](other_similar_gems_comparison.md)
+
+* [persistize](https://github.com/bebanjo/persistize)
+* [activerecord-denormalize](https://github.com/ursm/activerecord-denormalize)
+* [flattery](https://github.com/evendis/flattery)
 
 ## License
 * MIT
@@ -217,7 +222,18 @@ puts Employee.joins(branch: :company).where(companies: { id: company.id })
 ## Developer Guide
 * see [developer_guide.md](developer_guide.md)
 
+## Contributing
+* pull requests and forks are very much welcomed! :) Let me know if you find any bug! Thanks
+
+1. Fork it
+2. Create your feature branch (git checkout -b my-new-feature)
+3. Commit your changes (git commit -am 'Add some feature')
+4. Push to the branch (git push origin my-new-feature)
+5. Create new Pull Request
+
 ## Changelog
+* 0.1.3
+  * fixed Quickery not always working properly because of Rails autoloading; fixed by eager loading all Models (`app/models/*/**/*.rb`)
 * 0.1.2
   * fixed require error for remnant debugging code: 'byebug'
 * 0.1.1

data/lib/quickery/railtie.rb

@@ -0,0 +1,17 @@
+module Quickery
+  class Railtie < Rails::Railtie
+    # Need to eager load all models so that all quickery callbacks and dependencies will be considered
+    config.after_initialize do |app|
+      # unless Rails app is already set to eager_load
+      unless app.config.eager_load
+        models_load_path = File.join(Rails.root, 'app', 'models')
+
+        # copied from https://apidock.com/rails/Rails/Engine/eager_load%21/class
+        matcher = /\A#{Regexp.escape(models_load_path.to_s)}\/(.*)\.rb\Z/
+        Dir.glob("#{models_load_path}/**/*.rb").sort.each do |file|
+          app.require_dependency file.sub(matcher, '\1')
+        end
+      end
+    end
+  end
+end

data/lib/quickery/version.rb

@@ -1,3 +1,3 @@
 module Quickery
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

data/other_similar_gems_comparison.md

@@ -0,0 +1,128 @@
+# Quickery
+## Other Similar Gems Comparison
+
+* [persistize v0.5.0](https://github.com/bebanjo/persistize) :
+  * Pros against Quickery:
+    * Flexible custom methods / dependencies
+    * supports `has_many` and `belongs_to` while Quickery only supports `belongs_to` (currently)
+  * Cons against Quickery:
+    * It is not documented, but you'll need to do `Rails.application.eager_load!` first or something similar, to first load all the models as otherwise defined `persistize` across the models will be autoloaded, and therefore will not work properly. Quickery already does this eager loading of models out of the box. For more info, see [lib/quickery/railtie.rb](lib/quickery/railtie.rb)
+    * loops through each children records and update each attribute which can get very slow with lots of children associated records, and therefore as many number of SQL UPDATE queries vs Quickery which uses `update_all` which is just one update query, and does not loop through children records:
+
+      ```ruby
+      # app/models/project.rb
+      class Project < ActiveRecord::Base
+        has_many :tasks
+      end
+
+      # app/models/task.rb
+      class Task < ActiveRecord::Base
+        belongs_to :project
+
+        def project_name
+          project.name
+        end
+
+        persistize :project_name, depending_on: :project
+      end
+
+      # rails console
+      project = Project.create(name: 'someproject')
+      task_1 = Task.create(project: project)
+      task_2 = Task.create(project: project)
+
+      project.update(name: 'newprojectname')
+      # for as many number of tasks records that belongs to the `project` above, the `update` above will also have the same number of SQL update queries, and can be very slow:
+      # SQL (0.1ms) UPDATE "tasks" SET "project_name" = $1 WHERE "tasks"."id" = $2 [["project_name", "newprojectname"], ["id", 1]]
+      # SQL (0.1ms) UPDATE "tasks" SET "project_name" = $1 WHERE "tasks"."id" = $2 [["project_name", "newprojectname"], ["id", 2]]
+      ```
+
+    * because you are using custom methods in persistize, every time you update any of the `depending_on` records, the methods you defined are executed even if the updated attribute/s are not depended upon by the methods: i.e. extending from `persistize` github page:
+
+      ```ruby
+      # app/models/project.rb
+      class Project < ActiveRecord::Base
+        has_many :tasks
+      end
+
+      # app/models/task.rb
+      class Task < ActiveRecord::Base
+        belongs_to :project
+
+        def project_name
+          puts "Task(id: #{id}) project_name has been executed"
+          project.name
+        end
+
+        persistize :project_name, depending_on: :project
+      end
+
+      # rails console
+      project = Project.create(name: 'someproject')
+      task_1 = Task.create(project: project)
+      task_2 = Task.create(project: project)
+
+      project.update(someotherattribute: 'somevalue')
+      # => Task(id: 1) project_name has been executed
+      # => Task(id: 2) project_name has been executed
+      ```
+
+    * does not support nested associated dependencies for `belongs_to`, but only supports for nested associated dependencies for `has_many` (if using `through: `):
+
+      ```ruby
+      # app/models/project.rb
+      class Project < ActiveRecord::Base
+        has_many :tasks
+      end
+
+      # app/models/task.rb
+      class Task < ActiveRecord::Base
+        belongs_to :project
+        has_many :subtasks
+      end
+
+      # app/models/subtask.rb
+      class Subtask < ActiveRecord::Base
+        belongs_to :task
+
+        def task_name
+          task.name
+        end
+
+        def task_project_name
+          task.project.name
+        end
+
+        # works as expected:
+        persistize :task_name, :depending_on => [:task]
+        # not supported:
+        persistize :task_project_name, :depending_on => { task: :project }
+      end
+      ```
+
+* [activerecord-denormalize v0.2.0](https://github.com/ursm/activerecord-denormalize) :
+  * Pros against Quickery:
+    * *possibly there are pros, but because I could not test this because it seems to not support Rails 4 and 5 (see cons below)*
+  * Cons against Quickery:
+    * Rails 5 seems to be not supported (most likely because last commit was 6 years ago). I was getting `Gem Load Error is: wrong number of arguments (given 0, expected 1)` when doing `rails g model message sender:references{polymorphic} _sender:hstore`
+    * Rails 4 seems to be also not supported. I was getting `ArgumentError (wrong number of arguments (given 1, expected 0))` when doing `User.create` inside rails console.
+
+* [flattery v0.1.0](https://github.com/evendis/flattery) :
+  * Pros against Quickery:
+    * allows custom update method
+    * allows "updates" as a background process
+  * Cons against Quickery:
+    * Rails 5 is not part of its supported list in their github page. And just to try it out on a Rails 5 app, `Flattery::ValueProvider` did not seem to work, because values are not pushed to the `:notes`'s `:category_name` values.
+    * Using Rails 4, does not support nested associated dependencies for `belongs_to`:
+
+      ```ruby
+      class Note < ActiveRecord::Base
+        belongs_to :category, :inverse_of => :notes
+
+        include Flattery::ValueCache
+        # one-level works:
+        flatten_value category: :name
+        # nested not supported:
+        flatten_value category: { user: :email }
+      end
+      ```

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quickery
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Jules Roman Polidario
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-08 00:00:00.000000000 Z
+date: 2018-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -238,7 +238,9 @@ files:
 - lib/quickery/association_builder.rb
 - lib/quickery/callbacks_builder.rb
 - lib/quickery/quickery_builder.rb
+- lib/quickery/railtie.rb
 - lib/quickery/version.rb
+- other_similar_gems_comparison.md
 - quickery.gemspec
 homepage: https://github.com/jrpolidario/quickery
 licenses: