cacheable_delegator 0.1.0 → 1.0.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YTU4MzA2ZTBhYTBkZGJhMzk1OWQxMjE4NzlmZGMzOTk4OWY4MjBjMA==
+    YTY0OTYzZmI1MjFmYmQ4YTMwZDk0MDNjMTFkNzZhYTAyNTMzMzJjYw==
   data.tar.gz: !binary |-
-    MTliMjc4YmI3Njk1M2EwYzk1NDUzYWUxMWYyNmRlOWJmYTY0MWRhMg==
+    YzgxYjBmZjVjMzUxMjEzMDA4NjY4ZjZjYTc2Nzk3OTRiMDI2YWFkMQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    NzA2ODUwNzM2NGFhZDUxYjYyMTYzYjU4NmU1ZWQzNDVhMDU5OGM1Nzc0OGZj
-    NWMwMDQxZDEyNDU4NjY1OTVlYjJkMmUxODk2MjY0ZDQxOWUxNjBlN2Y3YmFl
-    YTcwZjg4MTM4OGM2OWZiNjk1YWU5NGQ4ODZiMjU0N2RiZjBjZGU=
+    NDQ4YTI3Mjg0NzE0ZDk3NDI3NGZjMjA5MzMwMmI3NjM3MDFkYjNiYmVhMTYz
+    ZDA1Mzk2M2U2MDQ0OGJiNzcyMmIyNTk0OWM3ZDc3YTk2ZWRiMGE1MmVhNDI1
+    NTVhNzU2YjI2OTYyMmI4YzVmM2MwMzQ1OTg2ZTA1OTRiNWM4NDY=
   data.tar.gz: !binary |-
-    N2ZjMTQ2YTk4MWM1Nzg2YTk1MzExNTY0MTMxMDQ4Mzc3MGFhNGVhYTU4ZTNk
-    NjAzNWY5N2FkNDRjNzk4MTliOWVmOWE1YTQzMjNiMjI2ZjI1YWZiMTkyYTlj
-    YmU4YjY1OTM3ZjYzMGU2MTNlOGY5YmI5ZjU2ZWFkMTE0M2VmMjE=
+    NGRlZjEzODY2YWUxNGJmYzAwNzlkZmEyZDZkZmQzYzgyMzlkMGZhODc0OGEy
+    YzUzNmI5NDFmMzJiNGZhYWEwYTU5ZTViMTM3YmIzNWJkOTIzMmI3YWY3Mjk5
+    NGRlNjMwMjc0NzljYjZjM2IzYjliZjE4NTRjNWM2MjUzYTg4NWI=

data/Gemfile

@@ -14,3 +14,4 @@ end
 
 gem 'pry'
 gem 'activesupport', '~> 3.2.14'
+gem 'active_record_inline_schema'

data/Gemfile.lock

@@ -1,6 +1,9 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    active_record_inline_schema (0.6.1)
+      activerecord (>= 3)
+      activesupport
     activemodel (3.2.14)
       activesupport (= 3.2.14)
       builder (~> 3.0.0)
@@ -80,6 +83,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  active_record_inline_schema
   activerecord (~> 3.2.14)
   activesupport (~> 3.2.14)
   bundler (~> 1.0)

data/VERSION

@@ -1 +1 @@
-0.1.0
+1.0.0

data/cacheable_delegator.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "cacheable_delegator"
-  s.version = "0.1.0"
+  s.version = "1.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Dan Nguyen"]
@@ -28,7 +28,9 @@ Gem::Specification.new do |s|
     "cacheable_delegator.gemspec",
     "lib/cacheable_delegator.rb",
     "spec/cacheable_delegator_spec.rb",
-    "spec/spec_helper.rb"
+    "spec/mixin_active_record_inline_schema_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/spec_records.rb"
   ]
   s.homepage = "http://github.com/dannguyen/cacheable_delegator"
   s.licenses = ["MIT"]
@@ -42,6 +44,7 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<pry>, [">= 0"])
       s.add_runtime_dependency(%q<activesupport>, ["~> 3.2.14"])
+      s.add_runtime_dependency(%q<active_record_inline_schema>, [">= 0"])
       s.add_development_dependency(%q<rspec>, ["~> 2.14.1"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.8.7"])
@@ -51,6 +54,7 @@ Gem::Specification.new do |s|
     else
       s.add_dependency(%q<pry>, [">= 0"])
       s.add_dependency(%q<activesupport>, ["~> 3.2.14"])
+      s.add_dependency(%q<active_record_inline_schema>, [">= 0"])
       s.add_dependency(%q<rspec>, ["~> 2.14.1"])
       s.add_dependency(%q<bundler>, ["~> 1.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.8.7"])
@@ -61,6 +65,7 @@ Gem::Specification.new do |s|
   else
     s.add_dependency(%q<pry>, [">= 0"])
     s.add_dependency(%q<activesupport>, ["~> 3.2.14"])
+    s.add_dependency(%q<active_record_inline_schema>, [">= 0"])
     s.add_dependency(%q<rspec>, ["~> 2.14.1"])
     s.add_dependency(%q<bundler>, ["~> 1.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.8.7"])

data/lib/cacheable_delegator.rb

@@ -1,19 +1,66 @@
 require 'active_record'
 require 'active_support'
+require 'active_record_inline_schema'
 
 module CacheableDelegator
   extend ActiveSupport::Concern
 
+  EXCLUDED_FIELDS = [:id, :cache_created_at, :cache_updated_at, :source_record_id, :source_record_type]
+  COL_ATTRIBUTES_TO_UPGRADE = [:limit, :name, :null, :precision, :scale, :sql_type, :type]
+
   included do 
-    class_attribute :cached_class
+    class_attribute :source_class
   end
 
   module ClassMethods
-    def cache_and_delegate(klass)
+
+    def build_cache(source_obj)
+      att_hsh = self.value_column_names.inject({}) do |hsh, cname|
+        hsh[cname] = source_obj.send cname
+        hsh
+      end
+
+      obj = self.new(att_hsh)
+      obj.source_record = source_obj
+
+      obj
+    end
+
+    def create_cache(obj)
+      c = build_cache(obj)
+      c.save 
+
+      c
+    end
+
+    def cache_and_delegate(klass, opts={}, &blk)
       raise ArgumentError, "Must pass in a class, not a #{klass}" unless klass.is_a?(Class)
-      self.cached_class = klass
+      self.source_class = klass
+      belongs_to :source_record, class_name: self.source_class.to_s      
+
+      self.source_class
+    end
+
+
+    def source_columns
+      source_class.columns.reject{|c| EXCLUDED_FIELDS.any?{|f| f.to_s == c.name }}
+    end
+
+    # value columns are just columns that aren't in EXCLUDED_FIELDS
+    def value_column_names
+      self.column_names - EXCLUDED_FIELDS.map{|f| f.to_s}
+    end
+
+
+    # assumes @@source_class has been set
+    def upgrade_schema!
+      source_columns.each do |source_col|
+        source_col_atts = COL_ATTRIBUTES_TO_UPGRADE.inject({}){|hsh, att| hsh[att.to_sym] = source_col.send att; hsh  }
+
+        col source_col.name, source_col_atts
+      end
 
-      belongs_to :source_record, class_name: self.cached_class.to_s
+      self.auto_upgrade!( :gentle => true )
     end
   end
 

data/spec/cacheable_delegator_spec.rb

@@ -9,9 +9,9 @@ describe CacheableDelegator do
         expect{ MyCachedRecord.cache_and_delegate("X::Foo") }.to raise_error ArgumentError
       end
 
-      it 'should set the :cached_class attribute' do 
+      it 'should set the :source_class attribute' do 
         MyCachedRecord.cache_and_delegate MyRecord
-        expect(MyCachedRecord.cached_class).to eq MyRecord
+        expect(MyCachedRecord.source_class).to eq MyRecord
       end
     end
   end
@@ -38,7 +38,10 @@ describe CacheableDelegator do
       it 'will use its own :foo, without :delegate_ prefix' do 
         @cache_record.foo = 'baz'
         expect(@cache_record.foo).to eq 'baz'
-      end     
+      end
     end
   end
+
+
+
 end

data/spec/mixin_active_record_inline_schema_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+
+describe CacheableDelegator do
+
+  context 'compatability with active_record_inline_schema' do 
+    context 'create schema based on @@source_class ' do 
+
+      describe '.upgrade_schema! effects' do
+        describe 'default call' do 
+          before(:each) do 
+            MyCachedRecord.upgrade_schema!
+          end
+
+          after(:each) do 
+            reload_records!
+          end
+
+          it 'should mimic column names' do 
+            # in spec_records.rb, the default call is invoked
+            expect(MyCachedRecord.column_names).to include( 'awesome_value', 'name', 'address', 'question')
+          end
+
+          it 'should not erase anything on upgrades' do 
+            expect(MyCachedRecord.column_names).to include( 'foo', 'foo_double_awesome_value', 'source_record_id')
+          end
+
+          it 'should mimic column types and attributes' do 
+            a_col = MyCachedRecord.columns.find{|c| c.name == 'address'}
+            expect(a_col.limit).to eq 42
+            expect(a_col.type).to eq :string
+          end
+        end
+      end
+
+      it 'should allow addition of different columns'
+      it 'should allow exclusion of specified columns'
+    end
+
+
+    context 'record building' do 
+      before(:each) do
+        MyCachedRecord.upgrade_schema!
+
+        @source = MyRecord.create awesome_value: 88
+        @cache = MyCachedRecord.build_cache(@source)
+      end
+
+
+      describe '#build_cache' do 
+        
+
+        it 'should have same awesome_value as its source_object' do 
+          expect(@cache.awesome_value).to eq 88
+        end
+
+        it 'should also have expected derived awesome_value in its column' do 
+          expect(@cache.foo_double_awesome_value).to eq @source.foo_double_awesome_value
+        end
+
+        it 'should be associated to source_object' do 
+          expect(@cache.source_record).to be @source
+        end
+      end
+
+      describe '#create_cache' do
+        it 'should be a saved record' do 
+          savedcache = MyCachedRecord.create_cache(@source)
+          expect(savedcache.valid?).to be_true
+          expect(savedcache.new_record?).to be_false
+        end
+
+      
+        context 'duplicating associated records' do 
+          it 'should only duplicate one level down'
+        end
+
+      end
+
+
+
+    end
+
+    context 'maintanence' do 
+    end
+
+  end
+
+
+end

data/spec/spec_helper.rb

@@ -6,45 +6,10 @@ require 'pry'
 require 'database_cleaner'
 DatabaseCleaner.strategy = :truncation
 
-ActiveRecord::Base.establish_connection(
-  :adapter => "sqlite3",
-  :database => ":memory:"
-)
-ActiveRecord::Migration.verbose = false
-
-
-
-ActiveRecord::Schema.define do
-  create_table :my_records do |t|
-    t.integer :values
-  end
-  create_table :my_cached_records do |t|  
-    t.string  :foo
-    t.integer :double_values
-    t.integer :source_record_id
-    t.string  :source_record_type
-  end
-end
-
-
-class MyRecord < ActiveRecord::Base
 
-  def foo
-    "This is foo"
-  end
-
-  def double_values
-    values * 2
-  end
-
-end
-
-
-class MyCachedRecord < ActiveRecord::Base
-  include CacheableDelegator
-  cache_and_delegate MyRecord
-end
+ActiveRecord::Migration.verbose = false
 
+require 'spec_records'
 
 
 RSpec.configure do |config|

data/spec/spec_records.rb

@@ -0,0 +1,52 @@
+module SpecBootstrap
+  def reload_records!
+    load(__FILE__)
+  end
+end
+include SpecBootstrap
+
+
+ActiveRecord::Base.establish_connection(
+  :adapter => "sqlite3",
+  :database => ":memory:"
+)
+ActiveRecord::Schema.define do
+
+
+  drop_table :my_records if ActiveRecord::Base.connection.table_exists?(:my_records)
+   
+  create_table :my_records, force: true do |t|
+    t.integer :awesome_value
+    t.string  :name
+    t.string  :address, limit: 42
+    t.boolean :question
+  end
+
+  drop_table :my_cached_records if ActiveRecord::Base.connection.table_exists?(:my_cached_records)
+  create_table :my_cached_records, force: true do |t|  
+    t.string  :foo
+    t.integer :foo_double_awesome_value
+    t.integer :source_record_id
+    t.string  :source_record_type
+  end
+end
+
+
+class MyRecord < ActiveRecord::Base
+  def foo
+    "This is foo"
+  end
+
+  def foo_double_awesome_value
+    awesome_value * 2
+  end
+end
+MyRecord.reset_column_information
+
+
+class MyCachedRecord < ActiveRecord::Base
+  include CacheableDelegator
+  cache_and_delegate MyRecord
+end
+MyCachedRecord.reset_column_information
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cacheable_delegator
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Dan Nguyen
@@ -38,6 +38,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 3.2.14
+- !ruby/object:Gem::Dependency
+  name: active_record_inline_schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -141,7 +155,9 @@ files:
 - cacheable_delegator.gemspec
 - lib/cacheable_delegator.rb
 - spec/cacheable_delegator_spec.rb
+- spec/mixin_active_record_inline_schema_spec.rb
 - spec/spec_helper.rb
+- spec/spec_records.rb
 homepage: http://github.com/dannguyen/cacheable_delegator
 licenses:
 - MIT