cacheable_delegator 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YTU4MzA2ZTBhYTBkZGJhMzk1OWQxMjE4NzlmZGMzOTk4OWY4MjBjMA==
+  data.tar.gz: !binary |-
+    MTliMjc4YmI3Njk1M2EwYzk1NDUzYWUxMWYyNmRlOWJmYTY0MWRhMg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NzA2ODUwNzM2NGFhZDUxYjYyMTYzYjU4NmU1ZWQzNDVhMDU5OGM1Nzc0OGZj
+    NWMwMDQxZDEyNDU4NjY1OTVlYjJkMmUxODk2MjY0ZDQxOWUxNjBlN2Y3YmFl
+    YTcwZjg4MTM4OGM2OWZiNjk1YWU5NGQ4ODZiMjU0N2RiZjBjZGU=
+  data.tar.gz: !binary |-
+    N2ZjMTQ2YTk4MWM1Nzg2YTk1MzExNTY0MTMxMDQ4Mzc3MGFhNGVhYTU4ZTNk
+    NjAzNWY5N2FkNDRjNzk4MTliOWVmOWE1YTQzMjNiMjI2ZjI1YWZiMTkyYTlj
+    YmU4YjY1OTM3ZjYzMGU2MTNlOGY5YmI5ZjU2ZWFkMTE0M2VmMjE=

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.14.1"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 1.8.7"
+  gem 'activerecord', '~> 3.2.14'
+  gem 'database_cleaner', '~> 1.0.1'
+  gem 'sqlite3'
+end
+
+gem 'pry'
+gem 'activesupport', '~> 3.2.14'

data/Gemfile.lock

@@ -0,0 +1,90 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.2.14)
+      activesupport (= 3.2.14)
+      builder (~> 3.0.0)
+    activerecord (3.2.14)
+      activemodel (= 3.2.14)
+      activesupport (= 3.2.14)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.14)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    addressable (2.3.5)
+    arel (3.0.2)
+    builder (3.0.4)
+    coderay (1.0.9)
+    database_cleaner (1.0.1)
+    diff-lcs (1.2.4)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    git (1.2.6)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.19)
+    httpauth (0.2.0)
+    i18n (0.6.5)
+    jeweler (1.8.8)
+      builder
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
+      rake
+      rdoc
+    json (1.8.0)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    method_source (0.8.2)
+    multi_json (1.8.1)
+    multi_xml (0.5.5)
+    multipart-post (1.2.0)
+    nokogiri (1.5.10)
+    oauth2 (0.9.2)
+      faraday (~> 0.8)
+      httpauth (~> 0.2)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rack (1.5.2)
+    rake (10.1.0)
+    rdoc (4.0.1)
+      json (~> 1.4)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.5)
+    rspec-expectations (2.14.3)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.3)
+    slop (3.4.6)
+    sqlite3 (1.3.8)
+    tzinfo (0.3.37)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 3.2.14)
+  activesupport (~> 3.2.14)
+  bundler (~> 1.0)
+  database_cleaner (~> 1.0.1)
+  jeweler (~> 1.8.7)
+  pry
+  rspec (~> 2.14.1)
+  sqlite3

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Dan Nguyen
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,19 @@
+= cacheable_delegator
+
+Description goes here.
+
+== Contributing to cacheable_delegator
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2013 Dan Nguyen. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "cacheable_delegator"
+  gem.homepage = "http://github.com/dannguyen/cacheable_delegator"
+  gem.license = "MIT"
+  gem.summary = %Q{Create a cache model}
+  gem.description = %Q{Create a cache model for your active records}
+  gem.email = "dansonguyen@gmail.com"
+  gem.authors = ["Dan Nguyen"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "cacheable_delegator #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/cacheable_delegator.gemspec

@@ -0,0 +1,72 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "cacheable_delegator"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Dan Nguyen"]
+  s.date = "2013-10-09"
+  s.description = "Create a cache model for your active records"
+  s.email = "dansonguyen@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "cacheable_delegator.gemspec",
+    "lib/cacheable_delegator.rb",
+    "spec/cacheable_delegator_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/dannguyen/cacheable_delegator"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "2.0.5"
+  s.summary = "Create a cache model"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    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_development_dependency(%q<rspec>, ["~> 2.14.1"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.7"])
+      s.add_development_dependency(%q<activerecord>, ["~> 3.2.14"])
+      s.add_development_dependency(%q<database_cleaner>, ["~> 1.0.1"])
+      s.add_development_dependency(%q<sqlite3>, [">= 0"])
+    else
+      s.add_dependency(%q<pry>, [">= 0"])
+      s.add_dependency(%q<activesupport>, ["~> 3.2.14"])
+      s.add_dependency(%q<rspec>, ["~> 2.14.1"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.7"])
+      s.add_dependency(%q<activerecord>, ["~> 3.2.14"])
+      s.add_dependency(%q<database_cleaner>, ["~> 1.0.1"])
+      s.add_dependency(%q<sqlite3>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<pry>, [">= 0"])
+    s.add_dependency(%q<activesupport>, ["~> 3.2.14"])
+    s.add_dependency(%q<rspec>, ["~> 2.14.1"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.7"])
+    s.add_dependency(%q<activerecord>, ["~> 3.2.14"])
+    s.add_dependency(%q<database_cleaner>, ["~> 1.0.1"])
+    s.add_dependency(%q<sqlite3>, [">= 0"])
+  end
+end
+

data/lib/cacheable_delegator.rb

@@ -0,0 +1,43 @@
+require 'active_record'
+require 'active_support'
+
+module CacheableDelegator
+  extend ActiveSupport::Concern
+
+  included do 
+    class_attribute :cached_class
+  end
+
+  module ClassMethods
+    def cache_and_delegate(klass)
+      raise ArgumentError, "Must pass in a class, not a #{klass}" unless klass.is_a?(Class)
+      self.cached_class = klass
+
+      belongs_to :source_record, class_name: self.cached_class.to_s
+    end
+  end
+
+
+  DELEGATING_REGEX = /^delegate_(\w+)/
+
+
+  def method_missing(foo, *args, &block)
+    if foomatch = foo.to_s.match(DELEGATING_REGEX)
+      foo = foomatch[1].to_s
+      
+      self.source_record.send(foo, *args, &block)
+    else
+      super
+    end
+  end
+
+  def respond_to?(meth, x=false)
+    if meth.match(DELEGATING_REGEX)
+      true
+    else
+      super
+    end
+  end
+
+end
+

data/spec/cacheable_delegator_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe CacheableDelegator do
+
+  context 'class methods' do 
+
+    describe '.cache_and_delegate' do 
+      it 'should accept only a class to cache' do 
+        expect{ MyCachedRecord.cache_and_delegate("X::Foo") }.to raise_error ArgumentError
+      end
+
+      it 'should set the :cached_class attribute' do 
+        MyCachedRecord.cache_and_delegate MyRecord
+        expect(MyCachedRecord.cached_class).to eq MyRecord
+      end
+    end
+  end
+
+
+  context 'delegations' do 
+    context 'it should delegate all the things' do 
+      before(:each) do 
+        @my_record = MyRecord.create
+        @cache_record = MyCachedRecord.create
+        @cache_record.source_record = @my_record
+
+        @cache_record.save
+      end
+
+      it 'should have a :source_record through the #belongs_to relation' do 
+        expect(@cache_record.source_record).to eq @my_record
+      end
+
+      it 'delegate_:column will :delegate to its object' do
+        expect(@cache_record.delegate_foo).to eq @my_record.foo
+      end
+
+      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

data/spec/spec_helper.rb

@@ -0,0 +1,75 @@
+# Configure Rails Envinronment
+
+require 'cacheable_delegator'
+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
+
+
+
+RSpec.configure do |config|
+
+  config.filter_run_excluding skip: true 
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus => true
+
+  config.mock_with :rspec
+
+   # Use color in STDOUT
+  config.color_enabled = true
+
+  # Use color not only in STDOUT but also in pagers and files
+  config.tty = true
+
+  # Use the specified formatter
+  config.formatter = :documentation # :progress, :html, :textmate
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+end
+

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: cacheable_delegator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dan Nguyen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.14
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.14
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.7
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.14
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.14
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Create a cache model for your active records
+email: dansonguyen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- cacheable_delegator.gemspec
+- lib/cacheable_delegator.rb
+- spec/cacheable_delegator_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/dannguyen/cacheable_delegator
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.5
+signing_key: 
+specification_version: 4
+summary: Create a cache model
+test_files: []