coin 0.1.1

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+group :development do
+  gem "micro_test"
+  gem "pry"
+  # gem "pry-stack_explorer"
+end

data/Gemfile.lock

@@ -0,0 +1,27 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.0.8)
+    method_source (0.8.1)
+    micro_test (0.3.1)
+      os
+    os (0.9.6)
+    pry (0.9.10)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.3.1)
+    pry (0.9.10-java)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.3.1)
+      spoon (~> 0.0)
+    slop (3.3.3)
+    spoon (0.0.1)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  micro_test
+  pry

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Nathan Hopkins
+
+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,125 @@
+# Coin
+
+## Memcached? We don't need no stinking Memcached.
+
+... Well, you might depending upon your specific needs.
+But be sure to have a look at Coin before you reach for the sledgehammer.
+
+Coin is an absurdly simple in memory object caching system written in Ruby.
+
+## Why Coin?
+
+* No configuration required
+* No added complexity to your stack
+* Small footprint (under 200 lines)
+* Simple API
+
+Coin uses [Distributed Ruby (DRb)](http://pragprog.com/book/sidruby/the-druby-book)
+to create a simple in memory caching server that addresses many of the same needs as Memcached
+and other similar solutions.
+
+## Quick Start
+
+Installation
+
+```bash
+$ gem install coin
+```
+
+Basic Usage
+
+```ruby
+require "coin"
+Coin.write :foo, true
+Coin.read :foo # => true
+```
+
+## Next Steps
+
+Examples of more advanced usage.
+
+```ruby
+require "coin"
+
+# read and/or assign a default value in a single step
+Coin.read(:bar) { true } # => true
+
+# write data with an explicit expiration (in seconds)
+# this example expires in 5 seconds (default is 300)
+Coin.write :bar, true, 5
+sleep 5
+Coin.read :bar # => nil
+
+# delete an entry
+Coin.write :bar, true
+Coin.delete :bar
+Coin.read :bar # => nil
+
+# read and delete in a single step
+Coin.write :bar, true
+Coin.read_and_delete :bar # => true
+Coin.read :bar # => nil
+
+# determine how many items are in the cache
+10.times do |i|
+  Coin.write "key#{i}", true
+end
+Coin.length # => 10
+
+# clear the cache
+Coin.clear
+Coin.length # => 0
+```
+
+## Deep Cuts
+
+Coin automatically starts a DRb server that hosts the Coin::Vault.
+You can take control of this behavior if needed.
+
+```ruby
+require "coin"
+
+# configure the port that the DRb server runs on (default is 8955)
+Coin.port = 8080
+
+# configure the URI that the DRb server runs on (defaults to druby://localhost:PORT)
+Coin.uri = "druby://10.0.0.100:8080"
+
+# access the DRb server exposing Coin::Vault
+Coin.server # => #<Coin::Vault:0x007fe182852e18>
+
+# determine if the server is running
+Coin.server_running? # => true
+
+# determine the pid of the server process
+Coin.pid # => "63299"
+
+# stop the server
+Coin.stop_server # => true
+
+# start the server
+Coin.start_server # => true
+
+# start the server forcing a restart if the server is already running
+Coin.start_server true # => true
+```
+
+## Run the Tests
+
+```bash
+$ gem install coin
+$ gem unpack coin
+$ cd coin-VERSION
+$ bundle
+$ mt
+```
+
+## Notes
+
+Coin's default behavior launches a single DRb server that provides
+shared access across all processes on a **single machine**.
+
+_It should be relatively simple to update Coin to work across multiple machines,
+so keep an eye peeled for this feature in the future._
+
+![Coin Processes](https://www.lucidchart.com/publicSegments/view/50b8299a-7c5c-4175-8121-6b190a7a0a70/image.png)

data/bin/coin

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby --
+require "drb/drb"
+require "tempfile"
+require File.join(File.dirname(__FILE__), "..", "lib", "coin")
+
+Signal.trap("HUP") do
+  File.delete(Coin.pid_file) if File.exist?(Coin.pid_file)
+  DRb.thread.kill if DRb.thread
+end
+
+if File.exist?(Coin.pid_file)
+  begin
+    Process.kill("HUP", File.read(Coin.pid_file).to_i)
+  rescue Exception => ex
+  end
+end
+
+File.open(Coin.pid_file, "w") do |file|
+  file.write Process.pid
+end
+
+DRb.start_service ENV["COIN_URI"], Coin::Vault.instance
+puts "Coin::Vault listening at: #{ENV["COIN_URI"]}"
+DRb.thread.join

data/lib/coin.rb

@@ -0,0 +1,103 @@
+require "drb/drb"
+require "rbconfig"
+require "forwardable"
+
+Dir[File.join(File.dirname(__FILE__), "coin", "*.rb")].each do |file|
+  require file
+end
+
+module Coin
+  class << self
+    extend Forwardable
+    def_delegators :server, :write, :read_and_delete, :delete, :clear, :length
+
+    def read(key, lifetime=300)
+      value = server.read(key)
+      if value.nil? && block_given?
+        value = yield
+        write(key, value, lifetime)
+      end
+      value
+    end
+
+    attr_writer :port
+    def port
+      @port ||= 8955
+    end
+
+    attr_writer :uri
+    def uri
+      "druby://localhost:#{port}"
+    end
+
+    def server
+      return nil unless ENV["COIN_URI"].nil?
+
+      if server_running?
+        if @server
+          begin
+            @server.ok? if @server
+          rescue DRb::DRbConnError => ex
+            @server = nil
+          end
+        end
+
+        if @server.nil?
+          begin
+            @server = DRbObject.new_with_uri(uri)
+            @server.ok?
+          rescue DRb::DRbConnError => ex
+            @server = nil
+          end
+        end
+      end
+
+      return @server if @server && server_running?
+
+      start_server
+      DRb.start_service
+      @server = DRbObject.new_with_uri(uri)
+    end
+
+    def pid_file
+      "/tmp/coin-pid-63f95cb5-0bae-4f66-88ec-596dfbac9244"
+    end
+
+    def pid
+      File.read(Coin.pid_file) if File.exist?(Coin.pid_file)
+    end
+
+    def server_running?
+      @pid = pid
+      return false unless @pid
+      begin
+        Process.kill(0, @pid.to_i)
+      rescue Errno::ESRCH => ex
+        return false
+      end
+      true
+    end
+
+    def start_server(force=nil)
+      return if server_running? && !force
+      stop_server if force
+      ruby = "#{RbConfig::CONFIG["bindir"]}/ruby"
+      script = File.expand_path(File.join(File.dirname(__FILE__), "..", "bin", "coin"))
+      env = {
+        "COIN_URI" => Coin.uri
+      }
+      pid = spawn(env, "#{ruby} #{script}")
+      Process.detach(pid)
+
+      sleep 0.1 while !server_running?
+      true
+    end
+
+    def stop_server
+      Process.kill("HUP", @pid.to_i) if server_running?
+      sleep 0.1 while server_running?
+      true
+    end
+
+  end
+end

data/lib/coin/vault.rb

@@ -0,0 +1,75 @@
+require "thread"
+require "singleton"
+require "forwardable"
+
+module Coin
+  class Vault
+    extend Forwardable
+    include Singleton
+    def_delegators :@dict, :length
+
+    def read(key)
+      value = @dict[key]
+      value = nil if value && value_expired?(value)
+      return value[:value] if value
+      nil
+    end
+
+    def read_and_delete(key)
+      value = nil
+      @mutex.synchronize do
+        value = read(key)
+        @dict.delete(key)
+      end
+      value
+    end
+
+    def write(key, value, lifetime=300)
+      @mutex.synchronize do
+        @dict[key] = { :value => value, :cached_at => Time.now, :lifetime => lifetime }
+      end
+      value
+    end
+
+    def delete(key)
+      @mutex.synchronize { @dict.delete(key) }
+    end
+
+    def clear
+      @mutex.synchronize { @dict = {} }
+    end
+
+    def ok?
+      true
+    end
+
+    protected
+
+    def initialize
+      @mutex = Mutex.new
+      @dict = {}
+      start_sweeper
+    end
+
+    def start_sweeper
+      Thread.new do
+        loop do
+          sleep 60
+          sweep
+        end
+      end
+    end
+
+    def sweep
+      now = Time.now
+      @dict.each do |key, value|
+        delete(key) if value_expired?(value)
+      end
+    end
+
+    def value_expired?(value)
+      Time.now - value[:cached_at] > value[:lifetime]
+    end
+
+  end
+end

data/lib/coin/version.rb

@@ -0,0 +1,3 @@
+module Coin
+  VERSION = "0.1.1"
+end

data/test/coin_test.rb

@@ -0,0 +1,74 @@
+require File.join(File.dirname(__FILE__), "test_helper")
+
+class CoinTest < MicroTest::Test
+  before do
+    @key = "key-#{SecureRandom.uuid}"
+  end
+
+  after do
+    Coin.stop_server
+  end
+
+  test "stop_server" do
+    Coin.start_server
+    assert Coin.server_running?
+    Coin.stop_server
+    assert Coin.server_running? == false
+  end
+
+  test "server method starts the server" do
+    Coin.stop_server
+    assert !Coin.server_running?
+    Coin.server
+    assert Coin.server_running?
+  end
+
+  test "read access starts the server" do
+    Coin.stop_server
+    assert !Coin.server_running?
+    Coin.read :foo
+    assert Coin.server_running?
+  end
+
+  test "read with assignment block" do
+    value = rand(99999999999)
+    assert Coin.read(@key).nil?
+    Coin.read(@key) { value }
+    assert Coin.read(@key) == value
+  end
+
+  test "read and delete" do
+    value = rand(99999999999)
+    Coin.write @key, value
+    val = Coin.read_and_delete(@key)
+    assert val == value
+    assert Coin.read(@key).nil?
+  end
+
+  test "write with expiration" do
+    Coin.write(@key, true, 1)
+    assert Coin.read(@key)
+    sleep 1
+    assert Coin.read(@key).nil?
+  end
+
+  test "delete" do
+    Coin.write(@key, true)
+    assert Coin.read(@key)
+    Coin.delete(@key)
+    assert Coin.read(@key).nil?
+  end
+
+  test "length" do
+    10.times { |i| Coin.write("key#{i}", rand(9999)) }
+    assert Coin.length >= 10
+  end
+
+  test "clear" do
+    10.times { |i| Coin.write("key#{i}", rand(9999)) }
+    assert Coin.length >= 10
+    Coin.clear
+    assert Coin.length == 0
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'bundler'
+Bundler.require :default, :development
+require File.join(File.dirname(__FILE__), "..", "lib", "coin")

data/test/vault_test.rb

@@ -0,0 +1,43 @@
+require File.join(File.dirname(__FILE__), "test_helper")
+require "securerandom"
+
+class VaultTest < MicroTest::Test
+
+  before do
+    @vault = Coin::Vault.instance
+    @key = "key-#{SecureRandom.uuid}"
+  end
+
+  test "read using an unstored key" do
+    assert @vault.read(@key).nil?
+  end
+
+  test "basic write & read" do
+    value = rand(999999999)
+    @vault.write(@key, value)
+    assert @vault.read(@key) == value
+  end
+
+  test "read_and_delete" do
+    value = rand(999999999)
+    @vault.write(@key, value)
+    val = @vault.read_and_delete(@key)
+    assert @vault.read(@key).nil?
+    assert val == value
+  end
+
+  test "delete" do
+    @vault.write(@key, true)
+    assert @vault.read(@key)
+    @vault.delete(@key)
+    assert @vault.read(@key).nil?
+  end
+
+  test "clear" do
+    10.times { |i| @vault.write("key#{i}", true) }
+    assert @vault.length >= 10
+    @vault.clear
+    assert @vault.length == 0
+  end
+
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: coin
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Nathan Hopkins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-30 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- natehop@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/coin/vault.rb
+- lib/coin/version.rb
+- lib/coin.rb
+- test/coin_test.rb
+- test/test_helper.rb
+- test/vault_test.rb
+- bin/coin
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+homepage: https://github.com/hopsoft/coin
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: An absurdly simple in memory object caching system.
+test_files: []
+has_rdoc: