database_cached_attribute 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e3ef5688041c2ebdebee855e718969bc6cd71689
+  data.tar.gz: 9d6ddf4d939944de4cd165123d61d3a9c8cd0e15
+SHA512:
+  metadata.gz: dabf006f76c29f149f7a0cf8663d5f18753270c129e075ed2ca440de752f40a10c6b3a907d4c88a6ea74879638094551b7b668e5c8bd54c3e5c7e7270ec9f1a1
+  data.tar.gz: 523acfca93ff269e49dc7631c89a2f480647de6ad29e4734f7dbb934a67bc31b85c70680acfee13e825e89b529d3d69391b2b81c829b364aac2803257066c0da

data/.travis.yml

@@ -0,0 +1 @@
+language: ruby

data/Gemfile

@@ -0,0 +1,14 @@
+source "https://rubygems.org"
+
+# Declare your gem's dependencies in database_cached_attribute.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'debugger'

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Charles Smith (github.com/twohlix/)
+
+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.md

@@ -0,0 +1,6 @@
+database_cached_attribute
+=========================
+[![Code Climate](https://codeclimate.com/github/twohlix/database_cached_attribute.png)](https://codeclimate.com/github/twohlix/database_cached_attribute)
+[![Build Status](https://travis-ci.org/twohlix/database_cached_attribute.png?branch=master)](https://travis-ci.org/twohlix/database_cached_attribute)
+
+Ruby gem that adds simple functions to invalidate single columns as a cache on an ActiveRecord models.

data/Rakefile

@@ -0,0 +1,25 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'DatabaseCachedAttribute'
+  rdoc.options << '--line-numbers'
+  #rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.rspec_opts = '--colour'
+end
+
+task default: :spec

data/lib/database_cached_attribute.rb

@@ -0,0 +1,81 @@
+require 'active_support/concern'
+
+# DatabaseCachedAttribute adds a method to add a set of easy to use cache invalidation 
+# methods/callbacks for specified attributes
+# 
+# On the model where you possibly may want to cache things from this model that may
+# be heavy to create:
+#   include DatabaseCachedAttribute
+#   database_cached_attribute :attribute_name, :another_attribute_name
+# This will create the methods
+#   invalidate_attribute_name(optional_object)
+#   invalidate_another_attribute_name(optional_object)
+#   cache_attribute_name(optional_object)
+#   cache_another_attribute_name(optional_object)
+# Which means invalidating that attribute is easy, say when you add an associated object
+#   has_many :things, before_add: :invalidate_attribute, before_remove: :invalidate_other_attribute
+#   
+module DatabaseCachedAttribute
+  extend ActiveSupport::Concern
+
+  included do
+    # Cache invalidation by column
+    def invalidate_cache (column_name)
+      self[column_name.to_sym] = nil
+      update_cache column_name.to_sym
+    end
+
+    # Update cache by column
+    def update_cache (column_name)
+      save if only_change?(column_name) && persisted?
+    end
+    
+    # Determines if the provided column name is the only change
+    def only_change? (column_name)
+      changes.length == 1 && changes.has_key?(column_name)
+    end
+
+    # Determines if the provided column names are the only changes
+    def only_changes? (*column_names)
+      return false if changes.length != column_names.length
+
+      column_names.each do |column_name|
+        return false if !changes.has_key?(column_name)
+      end
+
+      true
+    end
+
+    # Determines if the changes, if any, are only in the list of column names provided
+    def only_changes_in? (*column_names)
+      return false if changes.length > column_names.length
+
+      our_changes = changes.slice column_names
+      return false if our_changes.length < changes.length
+
+      true
+    end
+  end
+
+  module ClassMethods
+    # Sets up cache invalidation callbacks for the provided attributes
+    def database_cached_attribute(*attrs)
+      attrs.each do |attr|
+        define_method("invalidate_#{attr}") do |arg=nil| # default arg to allow before_blah callbacks
+          invalidate_cache attr.to_sym
+        end
+
+        define_method("only_#{attr}_changed?") do 
+          only_change? attr.to_sym
+        end
+
+        define_method("cache_#{attr}") do
+          update_cache attr.to_sym
+        end
+      end
+    end
+  end
+
+
+
+end

data/lib/database_cached_attribute/version.rb

@@ -0,0 +1,7 @@
+module DatabaseCachedAttribute
+  VERSION         = "0.1.0"
+  VERSION_ARRAY   = VERSION.split(/\./).map { |x| x.to_i } # :nodoc:
+  VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
+  VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:
+  VERSION_BUILD   = VERSION_ARRAY[2] # :nodoc:
+end

data/lib/tasks/database_cached_attribute_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :database_cached_attribute do
+#   # Task goes here
+# end

data/spec/database_cached_attribute_spec.rb

@@ -0,0 +1,144 @@
+require 'temping'
+require 'database_cached_attribute'
+
+ActiveRecord::Base.establish_connection("sqlite3:///:memory:")
+
+Temping.create :no_include_class do
+  with_columns do |t|
+    t.string :string_attribute
+    t.integer :integer_attribute
+  end
+end
+Temping.create :include_class do
+  include DatabaseCachedAttribute
+  database_cached_attribute :string_attribute
+  database_cached_attribute :integer_attribute
+
+  with_columns do |t|
+    t.string :string_attribute
+    t.integer :integer_attribute
+  end
+end
+
+describe DatabaseCachedAttribute do
+  # JUST INCLUDED TESTS
+  context "included" do
+    before do
+      @test_obj = IncludeClass.new
+    end
+
+    it "creates functions for invalidating cache" do
+      expect(@test_obj.respond_to? :invalidate_cache).to eq(true)
+    end
+
+    it "creates functions for saving cache" do
+      expect(@test_obj.respond_to? :update_cache)
+    end
+
+    it "using database_cached_attribute in the model adds nice functions to invalidate cache" do
+      expect(@test_obj.respond_to? :invalidate_string_attribute).to eq(true)
+      expect(@test_obj.respond_to? :invalidate_integer_attribute).to eq(true)
+      expect(@test_obj.respond_to? :invalidate_non_attribute).to eq(false)
+    end
+
+    it "using database_cached_attribute in the model adds nice functions to save caches" do
+      expect(@test_obj.respond_to? :cache_string_attribute).to eq(true)
+      expect(@test_obj.respond_to? :cache_integer_attribute).to eq(true)
+      expect(@test_obj.respond_to? :cache_non_attribute).to eq(false)
+    end
+  end
+
+  # NEW OBJECT TESTS
+  context "new objects not yet saved" do
+    before(:each) do
+      @test_obj = IncludeClass.new
+      @test_obj.string_attribute = "original string"
+      expect(@test_obj.new_record?).to eq(true)
+      expect(@test_obj.persisted?).to eq(false)
+    end
+
+    it "does not persist cache updates" do
+      @test_obj.cache_string_attribute
+      @test_obj.string_attribute = "new string"
+      @test_obj.cache_string_attribute
+      expect(@test_obj.new_record?).to eq(true)
+      expect(@test_obj.persisted?).to eq(false)
+    end
+
+    it "does not persist cache invalidations" do
+      @test_obj.invalidate_string_attribute
+      @test_obj.string_attribute = "new string"
+      @test_obj.invalidate_string_attribute
+      expect(@test_obj.new_record?).to eq(true)
+      expect(@test_obj.persisted?).to eq(false)
+    end
+
+    it "using .invalidate_attribute_name does change the data" do
+      expect(@test_obj.string_attribute).to eq("original string")
+      @test_obj.invalidate_string_attribute
+      expect(@test_obj.string_attribute).to eq(nil)
+    end
+
+    it "using .cache_attribute_name does not change the data" do
+      expect(@test_obj.string_attribute).to eq("original string")
+      @test_obj.cache_string_attribute
+      expect(@test_obj.string_attribute).to eq("original string")
+    end
+  end
+
+  # SAVED OBJECT TESTS
+  context "objects persisted in the database" do
+    before(:each) do
+      @test_obj = IncludeClass.new
+      @test_obj.string_attribute = "original string"
+      @test_obj.save
+      expect(@test_obj.new_record?).to eq(false)
+      expect(@test_obj.persisted?).to eq(true)
+    end
+
+    it "persists a cache invalidation" do
+      expect(@test_obj.string_attribute).to eq("original string")
+      @test_obj.invalidate_string_attribute
+      expect(@test_obj.string_attribute).to eq(nil)
+      @compare_obj = IncludeClass.last
+      expect(@compare_obj.id).to eq(@test_obj.id)
+      expect(@compare_obj.string_attribute).to eq(nil)
+    end
+
+    it "persists a cache update" do
+      expect(@test_obj.string_attribute).to eq("original string")
+      @test_obj.string_attribute = "new string"
+      @test_obj.cache_string_attribute
+      expect(@test_obj.string_attribute).to eq("new string")
+      
+      @compare_obj = IncludeClass.last
+      expect(@compare_obj.id).to eq(@test_obj.id)
+      expect(@compare_obj.string_attribute).to eq("new string")
+    end
+
+    it "does not persist cache invalidation with other changes" do
+      expect(@test_obj.string_attribute).to eq("original string")
+      @test_obj.integer_attribute = 1337
+      @test_obj.invalidate_string_attribute
+      expect(@test_obj.string_attribute).to eq(nil)
+      @compare_obj = IncludeClass.last
+      expect(@compare_obj.id).to eq(@test_obj.id)
+      expect(@compare_obj.string_attribute).to eq("original string")
+      expect(@compare_obj.integer_attribute).to eq(nil)
+    end
+
+    it "does not persist cache updates with other changes" do
+      expect(@test_obj.string_attribute).to eq("original string")
+      @test_obj.string_attribute = "new string"
+      @test_obj.integer_attribute = 1337
+      @test_obj.cache_string_attribute
+      expect(@test_obj.string_attribute).to eq("new string")
+      
+      @compare_obj = IncludeClass.last
+      expect(@compare_obj.id).to eq(@test_obj.id)
+      expect(@compare_obj.string_attribute).to eq("original string")
+      expect(@compare_obj.integer_attribute).to eq(nil)
+    end
+  end
+  
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: database_cached_attribute
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Charles Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: temping
+  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: Provides simple methods on an ActiveRecord model using an ActiveRecord
+  concern to invalidate/save single_column caches.
+email:
+- twohlix@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/database_cached_attribute.rb
+- lib/tasks/database_cached_attribute_tasks.rake
+- lib/database_cached_attribute/version.rb
+- LICENSE
+- Rakefile
+- README.md
+- Gemfile
+- spec/database_cached_attribute_spec.rb
+- .travis.yml
+homepage: http://github.com/twohlix/database_cached_attribute/
+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.3
+signing_key: 
+specification_version: 4
+summary: ActiveRecord Concern to make db caching on ActiveRecord Models simpler
+test_files:
+- spec/database_cached_attribute_spec.rb
+- .travis.yml