db_memoize 0.3.7 → 0.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97b2b4cd0624780588e5aaa90b93bf26e5f272246b043e076a282461e036188f
-  data.tar.gz: 8d440f2716fad476dbf95dd94698e77cb90099e9be330ffff599b788d1e2be1c
+  metadata.gz: 104a42e53e91c5485d2babe2f22995633965025b6a9bf4790b54d1e7768aef45
+  data.tar.gz: 0301ec4568f6787036176431fbdaa327c7e564287b06b670ddc95396672f79fc
 SHA512:
-  metadata.gz: 063a5479a255e730d6fc4c2f9b89fc007484662ca2e852536603f974daa1fa8017d783ac5bfebe776b39096c3a70e7d65b2266c1efc80c75562ecb94d5f6da69
-  data.tar.gz: a52b4f47e0a15e82769e2188467c543580ad45203e42817b3341e24f11413af7719f1122b3255eeb59c05c9733fdad1b9c0949d53495211de6a7f14249da9eb6
+  metadata.gz: 0fc1493d08f64346c0bc7cb9ff1da76ac0d6a32e6d7c9a42fc56e39f2cf174ab1c18f668410b3fd0015405847aa4cb204605028b41d0c71c13c93830157ec18d
+  data.tar.gz: 73d3a582bb4544a3c813794abe13e1aea4f6c40d298de3808ab648be76280c712fbbf2451061dc043d1fa4cb4e384450eeaf6fdbf70b5b1ce1871392388439ea

data/README.md

@@ -1,7 +1,7 @@
 [![Build Status](https://travis-ci.com/mediapeers/db_memoize.svg?branch=master)](https://travis-ci.com/mediapeers/db_memoize)
 
 # db_memoize
-library to cache (memoize) method return values in database
+A library to cache (memoize) return values of methods in the database.
 
 **Note:** when updating from version 0.1 to 0.2 you need to run a migration on the existing table, see below.
 
@@ -37,7 +37,7 @@ record.hello
 
 will call the original method only once. Consecutive calls will return a cached value.
 
-If the method takes arguments..
+If the method takes arguments...
 
     record.hello('Maria')
     record.hello('John')
@@ -68,7 +68,7 @@ Instead of ActiveRecord instances it's sufficient to pass in the ids of the reco
 
 ### Gotchas
 
-As the cached values themselves are writtten to the database, are ActiveRecord records (of type `DbMemoize::Value`) and are reqistered as an association you can access all of the cached values of an object like this:
+The cached values themselves are active records (of type `DbMemoize::Value`) and are saved in the database.  They are also registered as an association, so you can access all of the cached values of an object like this:
 
     record.memoized_values
 
@@ -82,11 +82,11 @@ DbMemoize by default will write log output to STDOUT. You can change this by set
 
 ### Rake Tasks
 
-To _warmup_ your cache you can pre-generate cached values via a rake task like this (only works for methods not depending on arguments)
+To _warmup_ your cache, you can pre-generate cached values via a rake task like this (only works for methods that do not take arguments):
 
     bundle exec rake db_memoize:warmup class=Letter methods=hello,bye
 
-Similarly you can wipe all cached values for a given class
+Similarly, you can wipe all cached values for a given class:
 
     bundle exec rake db_memoize:clear class=Letter
 
@@ -111,44 +111,14 @@ end
 
 Note that db_memoize needs Postgres. To set up the database needed to run tests, this is what you can do:
 
-    # sudo su postgresql
-    # createuser >>yourusername<<
-    # createdb -O >>yourusername<< db_memoize_test
-
-
-### Updating from 0.1 -> 0.2
-
-You need to run a migration, like the following: 
-
-```
-class FixDbMemoizeTable < ActiveRecord::Migration
-  def up
-    # After updating db_memoize to 0.2 we need to update some structures, depending
-    # on whether or not db_memoize 0.1 or 0.2 was creating the database tables.
-    execute <<-SQL
-    ALTER TABLE memoized_values
-      ALTER COLUMN entity_table_name SET NOT NULL,
-      ALTER COLUMN entity_id SET NOT NULL,
-      ALTER COLUMN method_name SET NOT NULL,
-      ALTER COLUMN created_at SET NOT NULL;
-    DROP INDEX IF EXISTS index_memoized_values_on_entity_table_name_and_entity_id;
-    CREATE INDEX IF NOT EXISTS index_memoized_values_on_entity_id_and_entity_table_name 
-      ON memoized_values(entity_id, entity_table_name);
-    CREATE INDEX IF NOT EXISTS memoized_attributes_idx 
-      ON memoized_values (((arguments_hash IS NULL)))
-    SQL
-  end
-
-  def down
-    execute <<-SQL
-      DROP INDEX memoized_attributes_idx;
-      DROP INDEX index_memoized_values_on_entity_id_and_entity_table_name;
-    SQL
-  end
-end
+```sh
+~/your/path> sudo su postgresql
+~/your/path> createuser >>yourusername<
+~/your/path> createdb -O >>yourusername<< db_memoize_test
 ```
 
-Have fun!
 
+### Updating from earlier versions
 
+It is generally impossible to update from earlier versions and keep the cached data. DbMemoize should always be able to rerun migrations to update database structures to the latest version - feel free to add in as many migrations as you like :)
 

data/VERSION

@@ -1 +1 @@
-0.3.7
+0.3.8

data/lib/db_memoize/migrations.rb

@@ -3,30 +3,27 @@ module DbMemoize
     class << self
       def create_tables(migration)
         migration.execute <<~SQL
-          CREATE TABLE IF NOT EXISTS memoized_values (
+          CREATE SCHEMA IF NOT EXISTS db_memoize;
+
+          CREATE TABLE IF NOT EXISTS db_memoize.memoized_values (
             entity_table_name varchar NOT NULL,
-            entity_id integer NOT NULL,
-            method_name varchar NOT NULL,
-            created_at timestamp without time zone NOT NULL
+            entity_id         integer NOT NULL,
+            method_name       varchar NOT NULL,
+
+            val_string        varchar,
+            val_integer       bigint,
+            val_float         double precision,
+            val_time          timestamp without time zone,
+            val_object        jsonb,
+            val_boolean       boolean,
+            val_nil           boolean,
+            created_at        timestamp without time zone NOT NULL
           );
 
           -- entity_id/entity_table_name should have a better chance to be useful, since
           -- there is more variance in entity_ids than there is in entity_table_names.
-          DROP INDEX IF EXISTS index_memoized_values_on_entity_id_and_entity_table_name;
-          DROP INDEX IF EXISTS index_memoized_values_on_entity_table_name_and_entity_id;
           CREATE UNIQUE INDEX IF NOT EXISTS memoized_attributes_idx2
-            ON memoized_values(entity_id, entity_table_name, method_name);
-
-          ALTER TABLE memoized_values DROP COLUMN IF EXISTS arguments_hash;
-          ALTER TABLE memoized_values DROP COLUMN IF EXISTS value;
-
-          ALTER TABLE memoized_values ADD COLUMN IF NOT EXISTS val_string varchar;
-          ALTER TABLE memoized_values ADD COLUMN IF NOT EXISTS val_integer bigint;
-          ALTER TABLE memoized_values ADD COLUMN IF NOT EXISTS val_float double precision;
-          ALTER TABLE memoized_values ADD COLUMN IF NOT EXISTS val_time timestamp without time zone;
-          ALTER TABLE memoized_values ADD COLUMN IF NOT EXISTS val_object jsonb;
-          ALTER TABLE memoized_values ADD COLUMN IF NOT EXISTS val_boolean boolean;
-          ALTER TABLE memoized_values ADD COLUMN IF NOT EXISTS val_nil boolean;
+            ON db_memoize.memoized_values(entity_id, entity_table_name, method_name);
         SQL
       end
     end

data/lib/db_memoize/value.rb

@@ -5,7 +5,7 @@ require 'json'
 
 module DbMemoize
   class Value < ActiveRecord::Base
-    self.table_name = 'memoized_values'
+    self.table_name = 'db_memoize.memoized_values'
 
     SQL = ::Simple::SQL
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: db_memoize
 version: !ruby/object:Gem::Version
-  version: 0.3.7
+  version: 0.3.8
 platform: ruby
 authors:
 - johannes-kostas goetzinger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-09 00:00:00.000000000 Z
+date: 2018-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simple-sql