constant_table_saver 5.1.0 → 5.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0478d2577af80dc5fc4c7bf860321b72c49e2c1
-  data.tar.gz: 27060f22739b2cdb8a0cbf36f56ebe186e9b6333
+  metadata.gz: bd0a0f0466a9358d62172e153ae85c8a88a0e9a9
+  data.tar.gz: b6d62a665e5a4b179101924c320e3ca2dd773e35
 SHA512:
-  metadata.gz: 3784c8649039aca241ae5e3b87b4b94d219c4c159d91b79d261dc1af3fa7795e4368e4ab97535290c0fec3c759d3729a5959988012bb7f10cd7d0b915fd854f2
-  data.tar.gz: 559071bc2fbadd429c6c2634a1f3eb71e27258c9dc260c38a60681527adf3b8436b4945a932cf83b7bc1e9e2c5898132879a87adc34a729a18486d8bd144ae6a
+  metadata.gz: 350eef086260e755159c68fa837515eff1c50f79b90a6044fb3ecdc806b78955faa9ba5716e73ad0b92827e7bad2c3e11666a0914a872e7df086a195c9f7b205
+  data.tar.gz: 0d9a1eed230c95df417727e8693da32e9168b8dd428a49aee3cbf6d08e73e650824c9d453878d01a7de2461e31ad4b40792c142bf3a6267b0bd3c548de3ad4c9

data/README.md

@@ -0,0 +1,85 @@
+ConstantTableSaver
+==================
+
+Loads all records from the table on first use, and thereafter returns the
+cached (and frozen) records for all find calls.
+
+Optionally, creates class-level methods you can use to grab the records,
+named after the name field you specify.
+
+
+Compatibility
+=============
+
+Currently tested against Rails 5.1 (5.1.0beta2) and 5.0 (up to 5.0.2) and 4.2 (up to 4.2.7), on Ruby 2.3.4.
+
+For earlier versions of Rails, use an older version of the gem.
+
+
+Example
+=======
+
+Problem: the following code would load each txn_type individually:
+
+```ruby
+    Txn.all.each {|txn| .. do something with txn.txn_type ..}
+```
+
+You can improve this a bit with standard Rails:
+
+```ruby
+    Txn.preload(:txn_type).all.each {|txn| .. do something with txn.txn_type ..}
+```
+
+This would load the txn_types in one go after the txns query, but would still need a query every time you load txns.
+
+But if you use constant_table_saver, without needing to use a preload:
+
+```ruby
+    class TxnType
+      constant_table
+    end
+
+    Txn.all.each {|txn| .. do something with txn.txn_type ..}
+```
+
+It will no longer requires individual txn_type loads, just every time you start the server (or every request, in development mode).  Most other basic queries are also cached:
+
+```ruby
+    TxnType.all.to_a
+```
+
+But other scopes with options still result in actual queries:
+
+```ruby
+    TxnType.where("name LIKE '%foo%'").to_a
+    TxnType.lock.find(2)
+```
+
+
+You can also use:
+
+```ruby
+    class TxnType
+      constant_table :name => :label
+    end
+```
+
+Which if you have:
+
+```ruby
+    TxnType.create!(:label => "Customer Purchase")
+    TxnType.create!(:label => "Refund")
+```
+
+Means you will also have methods returning those records:
+
+```ruby
+    TxnType.customer_purchase
+    TxnType.refund
+```
+
+Optionally, you can specify a `:name_prefix` and/or `:name_suffix`.
+
+
+Copyright (c) 2010-2017 Will Bryant, Sekuda Ltd, released under the MIT license

data/lib/constant_table_saver/version.rb

@@ -1,3 +1,3 @@
 module ConstantTableSaver
-  VERSION = '5.1.0'
+  VERSION = '5.1.1'
 end

data/test/constant_table_saver_test.rb

@@ -161,7 +161,7 @@ class ConstantTableSaverTest < ActiveSupport::TestCase
   end
   
   test "it passes the options preventing caching to the underlying query methods" do
-    assert_nil nil, ConstantPie.where(:filling => 'unicorn').first
+    assert_nil ConstantPie.where(:filling => 'unicorn').first
     assert_equal [],  ConstantPie.where(:filling => 'unicorn').all
   end
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: constant_table_saver
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 5.1.1
 platform: ruby
 authors:
 - Will Bryant
@@ -74,7 +74,7 @@ files:
 - ".gitignore"
 - Gemfile
 - MIT-LICENSE
-- README
+- README.md
 - Rakefile
 - constant_table_saver.gemspec
 - init.rb

data/README

@@ -1,67 +0,0 @@
-ConstantTableSaver
-==================
-
-Loads all records from the table on first use, and thereafter returns the
-cached (and frozen) records for all find calls.
-
-Optionally, creates class-level methods you can use to grab the records,
-named after the name field you specify.
-
-
-Compatibility
-=============
-
-Currently tested against Rails 5.1 (5.1.0beta2) and 5.0 (up to 5.0.2) and 4.2 (up to 4.2.7), on Ruby 2.3.4.
-
-For earlier versions of Rails, use an older version of the gem.
-
-
-Example
-=======
-
-Txn.all.each {|txn| .. do something with txn.txn_type ..}
- - would load each txn_type individually
-
-Txn.all(:include => :txn_type).each {|txn| .. do something with txn.txn_type ..}
- - would load the txn_types in one go after the txns query, but would still need
-   a query every time you load txns
-
-
-But if you use:
-
-  class TxnType
-    constant_table
-  end
-
-Txn.all.each {|txn| .. do something with txn.txn_type ..}
-  - no longer requires individual txn_type loads, just every time you start the
-    server (or every request, in development mode)
-
-TxnType.all
-  - also cached, but:
-
-TxnType.all(:conditions => "name LIKE '%foo%'")
-TxnType.find(2, :lock => true)
-  - all still result in traditional finds, since you gave options
-
-
-You can also use:
-
-  class TxnType
-    constant_table :name => :label
-  end
-
-Which if you have:
-
-  TxnType.create!(:label => "Customer Purchase")
-  TxnType.create!(:label => "Refund")
-
-Means you will also have methods returning those records:
-
-  TxnType.customer_purchase
-  TxnType.refund
-
-Optionally, you can specify a :name_prefix and/or :name_suffix.
-
-
-Copyright (c) 2010-2013 Will Bryant, Sekuda Ltd, released under the MIT license