quickery 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f70692a2f4e06fd43908254b29130a6216a7c2601fcd80f82375a31bfd03931
-  data.tar.gz: '079641a4f8fba9b911442849a4d8cff55c39b4668904b76e7e807e6f167b73e8'
+  metadata.gz: f23d071c0950a5aea01e1fbaac6b70b8024afc869309116947c0b9bf093e5869
+  data.tar.gz: ded1a4a4900160e8e614ad09ffcf824b6f7fde68fdc9c2b4d61d1fe2bc650ec1
 SHA512:
-  metadata.gz: f719cb216c2f99ee6268088f630180d4dd190942fa96ae85062a00ff2613342b2cd34a4ac295b8c03ce833bf245c3d76c7fa17459695bc29fb95cf54ee989555
-  data.tar.gz: b7aff203442a9a8b6d16cbb138aaa5193bc2ab409efc769a9eeccc907bc13feee423381e3b76a7cc69d38e2e1afc7988d6dc4abb25ee112995bf8df35862982b
+  metadata.gz: 0fa75bd9539cfd2095beb17099685c83ef0c617723c829bdbbc6041c791292f1f5d8cd98561aca87e69655c2c1850d4f18e4c4615ef67108c662c6c047ffe0d9
+  data.tar.gz: 8f3be6901dd857c976b1d08e54245f7b9d249dc7738f59e4ddbf411e24bca40e36a43304ebc730af74f7f472ef307982ea165fe6f47dbc657e15a47741785a23

data/Gemfile

@@ -4,6 +4,7 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
 group :development, :test do
   gem 'factory_bot_rails', require: false
+  gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw]
 end
 
 # Specify your gem's dependencies in quickery.gemspec

data/README.md

@@ -3,8 +3,6 @@
 [![Build Status](https://travis-ci.org/jrpolidario/quickery.svg?branch=master)](https://travis-ci.org/jrpolidario/quickery)
 [![Gem Version](https://badge.fury.io/rb/quickery.svg)](https://badge.fury.io/rb/quickery)
 
-## About
-
 * Implements Law of Demeter by mapping associated record attributes as own attributes (one-way read-only)
 * Consequently, speeds up SQL queries by removing joins queries between intermediary models, at the cost of slower writes.
 * This is an anti-normalization pattern in favour of actual data-redundancy and faster queries. Use this only as necessary.
@@ -33,8 +31,9 @@
 # app/models/employee.rb
 class Employee < ApplicationRecord
   # say we have the following attributes:
-  #   branch_id:integer
+  #   branch_id:bigint
   #   branch_company_name:string
+
   belongs_to :branch
 
   quickery do
@@ -58,7 +57,8 @@ end
 # app/models/branch.rb
 class Branch < ApplicationRecord
   # say we have the following attributes:
-  #   company_id:integer
+  #   company_id:bigint
+
   belongs_to :company
 end
 
@@ -92,7 +92,7 @@ company.update!(name: 'Mang Inasal')
 puts employee.branch_company_name
 # => 'Jollibee'
 
-# You need to reload the object, if you expect that it's been changed:
+# You may or may not need to reload the object, depending on if you expect that it's been changed:
 employee.reload
 
 puts employee.branch_company_name
@@ -108,6 +108,15 @@ puts employee.branch_company_name
 # => 'McDonalds'
 ```
 
+If you already have "old" records before you've integrated quickery or if you have new quickery-defined attributes, you can update these stale records by using `recreate_quickery_cache!`. See example below:
+
+```ruby
+# rails console
+Employee.find_each do |employee|
+  employee.recreate_quickery_cache!
+end
+```
+
 ## Usage Example 2
 
 * let `Branch` and `Company` model be the same as the Usage Example 1 above
@@ -116,7 +125,7 @@ puts employee.branch_company_name
 # app/models/employee.rb
 class Employee < ApplicationRecord
   belongs_to :branch
-  belongs_to :country, foreign_key: :branch_company_id
+  belongs_to :company, foreign_key: :branch_company_id
 
   quickery do
     branch.company.id == :branch_company_id
@@ -143,7 +152,7 @@ puts Employee.where(company: company)
 # => [#<Employee id: 1>]
 
 # as you may notice, the query above is a lot simpler and faster instead of doing it normally like below (if not using Quickery)
-# you may however still using belongs_to `:through` to achieve the simplified query like above, but it's still a lot slower because of JOINS
+# you may however still use belongs_to `:through` to achieve the simplified query like above, but it's still a lot slower because of JOINS
 puts Employee.joins(branch: :company).where(companies: { id: company.id })
 # => [#<Employee id: 1>]
 ```
@@ -179,7 +188,7 @@ puts Employee.joins(branch: :company).where(companies: { id: company.id })
 * useful if you already have records, and you want these old records to be updated immediately
 * i.e. you can do so something like the following:
     ```ruby
-    Employee.each do |employee|
+    Employee.find_each do |employee|
       employee.recreate_quickery_cache!
     end
     ```
@@ -209,6 +218,8 @@ puts Employee.joins(branch: :company).where(companies: { id: company.id })
 * see [developer_guide.md](developer_guide.md)
 
 ## Changelog
+* 0.1.2
+  * fixed require error for remnant debugging code: 'byebug'
 * 0.1.1
   * Gemspec fixes and travis build fixes.
 * 0.1.0

data/developer_guide.md

@@ -15,6 +15,15 @@ gem push quickery-X.X.X.gem
   * [combustion](https://github.com/pat/combustion)
   * [appraisal](https://github.com/thoughtbot/appraisal)
 
+### Setup
+
+```bash
+# setup development gems
+bundle install
+# setup Apprisal for testing different Rails versions below
+bundle exec appraisal install
+```
+
 ```bash
 # to auto-test specs whenever a spec file has been modified:
 bundle exec guard

data/gemfiles/rails_4.gemfile

@@ -6,6 +6,7 @@ gem "rails", "4.2.10"
 
 group :development, :test do
   gem "factory_bot_rails", require: false
+  gem "tzinfo-data", platforms: [:mingw, :mswin, :x64_mingw]
 end
 
 gemspec path: "../"

data/gemfiles/rails_5.gemfile

@@ -6,6 +6,7 @@ gem "rails", "5.2.1"
 
 group :development, :test do
   gem "factory_bot_rails", require: false
+  gem "tzinfo-data", platforms: [:mingw, :mswin, :x64_mingw]
 end
 
 gemspec path: "../"

data/lib/quickery/active_record_extensions/dsl.rb

@@ -1,4 +1,3 @@
-require 'byebug'
 require 'active_support'
 
 module Quickery

data/lib/quickery/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quickery
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Jules Roman Polidario
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-05 00:00:00.000000000 Z
+date: 2018-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -231,7 +231,6 @@ files:
 - config.ru
 - developer_guide.md
 - gemfiles/.bundle/config
-- gemfiles/rails_3.gemfile
 - gemfiles/rails_4.gemfile
 - gemfiles/rails_5.gemfile
 - lib/quickery.rb

data/gemfiles/rails_3.gemfile

@@ -1,7 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "rails", "3.2.22.5"
-
-gemspec path: "../"