db-cache-store 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1785318f4ba27a34f7b2c5b0492ad0c2beb59dd0
+  data.tar.gz: e58cb046187c93750b45f9dd2b5fbce754aabfcc
+SHA512:
+  metadata.gz: c4a85a4891d329bf9d9fe8b0f159f1b84cf31205d087e343b51f42c1a1a36c33d5d452394b5e03c4797972dcf646a854198fd450b3fc35fcad3d296421a424f6
+  data.tar.gz: 40b21a8b46042b270d6bedfa49e15624419c8dea72d81cb3319c8f15e5081d2c2ef690b46a9cd443b716e1b66ca7ed281fc9e3cfae79f8ea69e92ce94c22c5d9

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in ar_cache_store.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,135 @@
+PATH
+  remote: .
+  specs:
+    db-cache-store (0.1.0)
+      rails (>= 5.0, < 5.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.1.6)
+      actionpack (= 5.1.6)
+      nio4r (~> 2.0)
+      websocket-driver (~> 0.6.1)
+    actionmailer (5.1.6)
+      actionpack (= 5.1.6)
+      actionview (= 5.1.6)
+      activejob (= 5.1.6)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.1.6)
+      actionview (= 5.1.6)
+      activesupport (= 5.1.6)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.1.6)
+      activesupport (= 5.1.6)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.1.6)
+      activesupport (= 5.1.6)
+      globalid (>= 0.3.6)
+    activemodel (5.1.6)
+      activesupport (= 5.1.6)
+    activerecord (5.1.6)
+      activemodel (= 5.1.6)
+      activesupport (= 5.1.6)
+      arel (~> 8.0)
+    activesupport (5.1.6)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (8.0.0)
+    builder (3.2.3)
+    coderay (1.1.2)
+    concurrent-ruby (1.0.5)
+    crass (1.0.4)
+    docile (1.3.0)
+    erubi (1.7.1)
+    globalid (0.4.1)
+      activesupport (>= 4.2.0)
+    i18n (1.0.0)
+      concurrent-ruby (~> 1.0)
+    json (2.1.0)
+    loofah (2.2.2)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.0)
+      mini_mime (>= 0.1.1)
+    method_source (0.9.0)
+    mini_mime (1.0.0)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
+    nio4r (2.3.0)
+    nokogiri (1.8.2)
+      mini_portile2 (~> 2.3.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rack (2.0.4)
+    rack-test (1.0.0)
+      rack (>= 1.0, < 3)
+    rails (5.1.6)
+      actioncable (= 5.1.6)
+      actionmailer (= 5.1.6)
+      actionpack (= 5.1.6)
+      actionview (= 5.1.6)
+      activejob (= 5.1.6)
+      activemodel (= 5.1.6)
+      activerecord (= 5.1.6)
+      activesupport (= 5.1.6)
+      bundler (>= 1.3.0)
+      railties (= 5.1.6)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.1.6)
+      actionpack (= 5.1.6)
+      activesupport (= 5.1.6)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.5.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sprockets (3.7.1)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.3.13)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    websocket-driver (0.6.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  db-cache-store!
+  minitest (>= 5.0.0)
+  pry
+  rake (~> 10.0)
+  simplecov
+  sqlite3
+
+BUNDLED WITH
+   1.16.0

data/README.md

@@ -0,0 +1,56 @@
+# DbCacheStore
+
+Alternative rails cache engine, that will use database with `activerecord`
+
+![What!?](https://media.giphy.com/media/3mJMxWRhmeiGukabki/giphy.gif)
+
+## Install
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'db-cache-store'
+```
+
+## Usage
+
+### Global Usage
+
+It's __NOT__ recommened to use it as global application cache because it's slow.
+
+Supported rails versions: '>= 5.0', '< 5.2'
+
+First you need to genereate table:
+
+```ruby
+DbCacheStore:
+  db_cache_store:migration [TABLE_NAME=db_cache_store_items]
+```
+
+Then declare your cache model and update configuration in application.rb:
+
+```ruby
+class MyCacheRepository < ActiveSupport::Cache::DbItem
+  self.table_name = :cache_items
+end
+```
+
+```ruby
+config.cache_store = :db_cache_store, repository: MyCacheRepository
+```
+
+### Local usage
+
+```ruby
+cache_store = ActiveSupport::Cache.lookup_store(:db_store, repository: MyCacheRepository)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+`rake` will run unit tests
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/caulfield/db-cache-store

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end
+
+task default: %i[test]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "db_cache_store"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/db_cache_store.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "db_cache_store/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "db-cache-store"
+  spec.version       = DbCacheStore::VERSION
+  spec.authors       = ["Sergey Kuchmistov"]
+  spec.email         = ["sergey.kuchmistov@gmail.com"]
+
+  spec.summary       = "Alternative rails cache engine, that will use database server"
+  spec.description   = "Alternative rails cache engine, that will use database server"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'rails', '>= 5.0', '< 5.2'
+ 
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'minitest', '>= 5.0.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'pry'
+end

data/lib/active_support/cache/db_item.rb

@@ -0,0 +1,24 @@
+require 'active_record'
+
+module ActiveSupport
+  module Cache
+    class DbItem < ActiveRecord::Base
+      TABLE_NAME = 'db_cache_store_items'
+
+      self.table_name = TABLE_NAME
+
+      def entry
+        serialized_value = attributes['entry']
+        YAML.load(serialized_value) if serialized_value
+      end
+
+      def value
+        entry.value
+      end
+
+      def expired?
+        entry.expired?
+      end
+    end
+  end
+end

data/lib/active_support/cache/db_store.rb

@@ -0,0 +1,44 @@
+require 'active_support/cache'
+require 'active_support/cache/db_item'
+
+module ActiveSupport
+  module Cache
+    class DbStore < Store
+      attr_reader :repository
+
+      def initialize(options = {})
+        super(options)
+        @repository = options.fetch(:repository, DbItem)
+      end
+
+      def clear(options = {})
+        @repository.update_all(deleted_at: Time.now)
+      end
+
+      def cleanup(options = {})
+        @repository.where.not(expired_at: nil).update_all(deleted_at: Time.now)
+      end
+
+      private
+
+      def read_entry(key, options = {})
+        scope = @repository.where(expired_at: nil).where(deleted_at: nil).order(version: :desc)
+        if options[:version]
+          scope = scope.where(version: options[:version])
+        end
+        scope.find_by(key: key)
+      end
+
+      def write_entry(key, entry, options = nil)
+        @repository.create \
+          key: key,
+          entry: YAML.dump(entry),
+          version: (read_entry(key, options)&.version.to_f + 1)
+      end
+
+      def delete_entry(key, options = nil)
+        read_entry(key)&.touch(:expired_at)
+      end
+    end
+  end
+end

data/lib/db_cache_store.rb

@@ -0,0 +1,6 @@
+require "db_cache_store/version"
+require 'active_support/cache/db_store'
+
+module DbCacheStore
+end
+

data/lib/db_cache_store/version.rb

@@ -0,0 +1,3 @@
+module DbCacheStore
+  VERSION = "0.1.0"
+end

data/lib/generators/db_cache_store/migration_generator.rb

@@ -0,0 +1,27 @@
+require 'rails/generators/base'
+
+module DbCacheStore
+  module Generators
+    class MigrationGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      argument :table_name, type: :string, default: ActiveSupport::Cache::DbItem::TABLE_NAME
+
+      desc "Generates a migration for given TABLE to use it as cache storage."
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      def generate_migration
+        migration_template "migration.rb", "db/migrate/db_cache_store_create_#{table_name}.rb"
+      end
+
+      def migration_version
+        "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+      end
+
+      def self.next_migration_number(dir)
+        Time.now.utc.strftime("%Y%m%d%H%M%S")
+      end
+    end
+  end
+end

data/lib/generators/db_cache_store/templates/migration.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+class DbCacheStoreCreate<%= table_name.camelize %> < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :<%= table_name %>, id: false do |t|
+      t.string :key
+      t.text :entry
+      t.integer :version, default: 1
+
+      t.datetime :expired_at
+      t.datetime :deleted_at
+    end
+
+    add_index :<%= table_name %>, :expired_at
+    add_index :<%= table_name %>, :deleted_at
+    add_index :<%= table_name %>, :key
+  end
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: db-cache-store
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sergey Kuchmistov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: simplecov
+  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: pry
+  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: Alternative rails cache engine, that will use database server
+email:
+- sergey.kuchmistov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- db_cache_store.gemspec
+- lib/active_support/cache/db_item.rb
+- lib/active_support/cache/db_store.rb
+- lib/db_cache_store.rb
+- lib/db_cache_store/version.rb
+- lib/generators/db_cache_store/migration_generator.rb
+- lib/generators/db_cache_store/templates/migration.rb
+homepage: 
+licenses: []
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Alternative rails cache engine, that will use database server
+test_files: []