cached_singleton 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9b4a68ba40df42d54333d5c44f6ea0c016b5070d
+  data.tar.gz: b8c47e7bfd9f418f340cb45ab409ea86b0af2866
+SHA512:
+  metadata.gz: 89525792284ffe0dedf01631f2bef2f969fbba0ff7d3b91476953cf1ccb9f05e5f416f49cba5cc3e5265897abad8b36e2930fb943fd7efa24e03d4b5b061824f
+  data.tar.gz: b9875020570ada543cec2f03520b28097a844f49d0db29b398a24c5bc160ca6052cca830b9f57d9e4d2af9417ba56dc48736c2d98c1db54058c4154f8e510c59

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 telzamek
+
+MIT License
+
+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,29 @@
+# Cached::Singleton
+
+It allows you to create a singleton from an active record
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cached-singleton'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cached-singleton
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/lib/cached_singleton/cached_singleton.rb

@@ -0,0 +1,55 @@
+require "cached_singleton/version"
+
+module CachedSingleton
+  @@cache_strategy = nil
+
+  def self.default_cache_strategy=(cache_strategy)
+    @@cache_strategy = cache_strategy
+  end
+
+  def self.default_cache_strategy
+    unless @@cache_strategy
+      raise RuntimeError.new('default cache strategy not set')
+    end
+    @@cache_strategy
+  end
+
+  def self.included(model)
+    model.class_eval do
+
+      class << self
+        def cache
+          CachedSingleton.default_cache_strategy
+        end
+
+        def singleton_cache_key
+          "/#{self.name}"
+        end
+
+        def instance
+          # Fetch in cache
+          m = self.cache.read(singleton_cache_key)
+          return m if m
+
+          # Get it in from the DB or create it
+          transaction do
+            # We ensure no other process is trying to SELECT and INSERT the same record by locking the entire table (read and write) during the transaction
+            connection.execute("LOCK TABLE #{table_name} IN EXCLUSIVE MODE")
+            m = first || create
+          end
+
+          # Save it in cache if it's in the DB
+          self.cache.write(singleton_cache_key, m) if m.try(:persisted?)
+
+          m
+        end
+      end
+
+      after_commit :expire_cache
+    end
+  end
+
+  def expire_cache
+    self.class.cache.delete(self.class.singleton_cache_key) if (!new_record? || destroyed?)
+  end
+end

data/lib/cached_singleton/version.rb

@@ -0,0 +1,3 @@
+module CachedSingleton
+    VERSION = "0.0.1"
+end

data/lib/cached_singleton.rb

@@ -0,0 +1,2 @@
+require 'cached_singleton/cached_singleton'
+require 'cached_singleton/version'

data/spec/cached_singleton_spec.rb

@@ -0,0 +1,80 @@
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'rack/test'
+require 'minitest/autorun'
+require 'cached_singleton'
+
+class FakeModel
+  def self.after_commit(f)
+  end
+
+  def self.transaction
+    yield
+  end
+
+  def self.connection
+    FakeConnection.new
+  end
+
+  def self.create
+  end
+
+  def self.first
+  end
+
+  def try(s)
+  end
+
+  def self.table_name
+    'table_name'
+  end
+
+  include CachedSingleton
+end
+
+class FakeConnection
+  def execute(r)
+  end
+end
+
+class FakeCache
+  class << self
+    def read(k)
+    end
+
+    def write(k)
+    end
+
+    def delete(k)
+    end
+  end
+end
+
+class CachedSingletonTest < MiniTest::Unit::TestCase
+  include Rack::Test::Methods
+
+  def test_singleton_cache_key
+    assert_equal FakeModel.singleton_cache_key, '/FakeModel'
+  end
+
+  def test_cache
+    CachedSingleton.default_cache_strategy = FakeCache
+    assert_equal FakeModel.cache, FakeCache
+  end
+
+  def test_single_instance_from_cache
+    CachedSingleton.default_cache_strategy = FakeCache
+    FakeCache.stub :read, FakeModel.new do
+      assert_same FakeModel.instance, FakeModel.instance
+    end
+  end
+
+  def test_single_instance_from_db
+    CachedSingleton.default_cache_strategy = FakeCache
+    FakeModel.stub :first, FakeModel.new do
+        assert_same FakeModel.instance, FakeModel.instance
+    end
+  end
+
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: cached_singleton
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Thibault El Zamek, Cédric Darné, Lionel Oto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+description: It allows you to create a singleton from an active record
+email:
+- thibault.elzamek@c4mprod.com, cedric.darne@c4mprod.com, lionel.oto@c4mprod.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/cached_singleton/version.rb
+- lib/cached_singleton/cached_singleton.rb
+- lib/cached_singleton.rb
+- spec/cached_singleton_spec.rb
+homepage: https://github.com/c4mprod/cached_singleton
+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.1.11
+signing_key: 
+specification_version: 4
+summary: It allows you to create a singleton from an active record
+test_files:
+- spec/cached_singleton_spec.rb