keymap 0.1.0

data/lib/keymap/errors.rb

@@ -0,0 +1,29 @@
+module Keymap
+
+# Generic Keymap exception class.
+  class KeymapError < StandardError
+  end
+
+# Raised when adapter not specified on connection (or configuration file <tt>config/database.yml</tt>
+# misses adapter field).
+  class AdapterNotSpecified < KeymapError
+  end
+
+# Raised when Keymap cannot find database adapter specified in <tt>config/database.yml</tt> or programmatically.
+  class AdapterNotFound < KeymapError
+  end
+
+# Raised when connection to the database could not been established (for example when <tt>connection=</tt>
+# is given a nil object).
+  class ConnectionNotEstablished < KeymapError
+  end
+
+# The library uses this exception to distinguish a deliberate rollback from other
+# exceptional situations. Normally, raising an exception will cause the
+# +transaction+ method to rollback the database transaction *and* pass on the
+# exception. But if you raise a Rollback exception, then the database transaction
+# will be rolled back, without passing on the exception.
+  class Rollback < KeymapError
+  end
+
+end

data/lib/keymap/version.rb

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

data/spec/functional/abstract_adapter_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Keymap::ConnectionAdapters::ConnectionPool do
+  before do
+    @adapter = Keymap::ConnectionAdapters::AbstractAdapter.new nil, nil
+    @pool = Keymap::ConnectionAdapters::ConnectionPool.new(Keymap::Base::ConnectionSpecification.new({}, nil))
+    @pool.connections << @adapter
+    @adapter.pool = @pool
+  end
+
+  context "a pool manages connections" do
+    it "marks the connections in use when checked out" do
+      @adapter.should eq(@pool.connection)
+      @adapter.in_use?.should be_true
+    end
+    it "marks the connection not in use when checked in" do
+      @adapter.close
+      !@adapter.in_use?.should be_false
+    end
+    it "returns the same connection upon subsequent checkouts if only one connection is pooled" do
+      @adapter.should eq(@pool.connection)
+    end
+  end
+end

data/spec/functional/adapter_spec.rb

@@ -0,0 +1 @@
+require 'spec_helper'

data/spec/rcov.opts

@@ -0,0 +1,2 @@
+--exclude
+spec,bin,/Library/Ruby

data/spec/spec.opts

@@ -0,0 +1,3 @@
+-c
+-b
+-fs

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+$:.unshift File.expand_path("../..", __FILE__)
+
+require 'rubygems'
+require 'rspec/mocks'
+
+$:.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+$:.unshift(File.expand_path("../lib", __FILE__))
+$:.unshift(File.dirname(__FILE__))
+
+require 'active_support'
+require 'keymap'
+require 'simplecov'
+
+SimpleCov.start do
+  add_group 'Libraries', 'lib'
+end
+
+#RSpec.configure do |config|
+#end

data/spec/support/config.rb

@@ -0,0 +1,45 @@
+require 'yaml'
+require 'erubis'
+require 'fileutils'
+require 'pathname'
+
+SPEC_ROOT = File.expand_path(File.dirname(__FILE__))
+
+module KeymapTest
+  class << self
+    def config
+      @config ||= read_config
+    end
+
+    private
+
+    def config_file
+      Pathname.new(ENV['KEYMAP_CONFIG'] || SPEC_ROOT + '/support/config.yml')
+    end
+
+    def read_config
+      unless config_file.exist?
+        FileUtils.cp SPEC_ROOT + '/support/config.example.yml', config_file
+      end
+
+      erb = Erubis::Eruby.new(config_file.read)
+      expand_config(YAML.parse(erb.result(binding)).transform)
+    end
+
+    def expand_config(config)
+      config['connections'].each do |adapter, connection|
+        dbs = [['arunit', 'activerecord_unittest'], ['arunit2', 'activerecord_unittest2']]
+        dbs.each do |name, dbname|
+          unless connection[name].is_a?(Hash)
+            connection[name] = {'database' => connection[name]}
+          end
+
+          connection[name]['database'] ||= dbname
+          connection[name]['adapter'] ||= adapter
+        end
+      end
+
+      config
+    end
+  end
+end

data/spec/support/config.yml

@@ -0,0 +1,10 @@
+default_connection: <%= defined?(JRUBY_VERSION) ? 'jdbcsqlite3' : 'sqlite3' %>
+
+with_manual_interventions: false
+
+connections:
+  redis:
+      adapter:  redis
+      host:     localhost
+      password: kmunit
+      database: kmunit

data/spec/support/connection.rb

@@ -0,0 +1,17 @@
+require 'logger'
+
+module KeymapTest
+  def self.connection_name
+    ENV['KEYMAP_CONN'] || config['default_connection']
+  end
+
+  def self.connection_config
+    config['connections'][connection_name]
+  end
+
+  def self.connect
+    Keymap::Base.logger = Logger.new("debug.log")
+    Keymap::Base.configurations = connection_config
+    Keymap::Base.establish_connection 'kmunit'
+  end
+end

data/spec/unit/test.rb

@@ -0,0 +1,89 @@
+require 'rubygems'
+require 'keymap'
+require 'yaml'
+require 'logger'
+
+Keymap::Base.configurations['redis'] = {
+    :adapter => 'redis',
+    :host => 'localhost'
+}
+
+class User < Keymap::Base
+
+  establish_connection 'redis'
+
+  def test
+    c = self.connection
+    puts 'hi'
+  end
+end
+
+user = User.new
+user.test
+
+#
+#config = {adapter: 'redis',
+#          host: 'localhost'
+#          #database: database,
+#          #username: user,
+#          #password: password,
+#}
+#Keymap::Base.establish_connection(config)
+#Keymap::Base.logger = Logger.new(STDERR)
+#
+#class User < Keymap::Base
+#end
+
+#puts User.count
+# SQL (0.000277)   SELECT count(*) AS count_all FROM users
+# 6
+
+
+#require 'redis'
+#require 'keymap/connection_adapters/redis_adapter'
+#require 'keymap/connection_adapters/abstract/connection_specification'
+#
+#Base.configurations["redis"] = {
+#    :adapter => 'redis',
+#    :host => 'localhost'
+#}
+#
+#Base.establish_connection(
+#    :adapter => "redis",
+#    :host => "localhost"
+#)
+#
+#
+##
+##class Table1 < ActiveRecord::Base
+##  establish_connection "db1"
+##end
+##
+##class Table2 < ActiveRecord::Base
+##  establish_connection "db2"
+##end
+#
+#
+#redis = ConnectionAdapters::RedisAdapter.new nil, nil, {host: "localhost"}
+#puts redis.active?
+#
+#redis.reconnect!
+#puts redis.active?
+#
+#redis.transaction do
+#  tokens = redis.hash 'tokens'
+#  tokens[:auth] = 'no way'
+#  puts tokens[:auth]
+#end
+#
+#redis.transaction do
+#  tokens = redis.hash 'tokens'
+#  tokens.each do |key, value|
+#    puts "#{key},#{value}"
+#  end
+#end
+#
+#redis.disconnect!
+#puts redis.active?
+#
+#

data/tasks/rspec.rb

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+GEM_ROOT = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+
+begin
+
+  require 'rspec/core/rake_task'
+
+  task :default => :spec
+
+  desc "Run all specs in spec directory"
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.rspec_opts = ['--options', "\"#{GEM_ROOT}/.rspec\""]
+    t.pattern = FileList['spec/**/*_spec.rb']
+  end
+
+  desc "Run all functional specs (in functional/ directory)"
+  RSpec::Core::RakeTask.new(:functional) do |t|
+    t.rspec_opts = ['--options', "\"#{GEM_ROOT}/spec/spec.opts\""]
+    t.pattern = FileList['spec/functional/**/*_spec.rb']
+  end
+
+  desc "Run the rspec tests with activesupport loaded"
+  RSpec::Core::RakeTask.new(:spec_activesupport) do |t|
+    t.rspec_opts = ['--options', "\"#{GEM_ROOT}/.rspec\"", "--require active_support/core_ext"]
+    t.pattern = FileList['spec/unit/**/*_spec.rb']
+  end
+
+  namespace :spec do
+    #desc "Run all specs in spec directory with RCov"
+    #RSpec::Core::RakeTask.new(:cov) do |t|
+    #  require 'simplecov'
+    #  SimpleCov.start do
+    #    add_group 'Libraries', 'lib'
+    #  end
+    #end
+
+    desc "Print Specdoc for all specs"
+    RSpec::Core::RakeTask.new(:doc) do |t|
+      t.rspec_opts = %w(--format specdoc --dry-run)
+      t.pattern = FileList['spec/**/*_spec.rb']
+    end
+
+    [:unit].each do |sub|
+      desc "Run the specs under spec/#{sub}"
+      RSpec::Core::RakeTask.new(sub) do |t|
+        t.rspec_opts = ['--options', "\"#{GEM_ROOT}/spec/spec.opts\""]
+        t.pattern = FileList["spec/#{sub}/**/*_spec.rb"]
+      end
+    end
+  end
+
+rescue LoadError
+  STDERR.puts "\n*** RSpec not available. (sudo) gem install rspec to run unit tests. ***\n\n"
+end

metadata

@@ -0,0 +1,247 @@
+--- !ruby/object:Gem::Specification
+name: keymap
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Robert Buck
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: erubis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+description: ActiveRecord like Key-Value Store API for Ruby
+email: buck.robert.j@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- keymap.gemspec
+- lib/keymap.rb
+- lib/keymap/base.rb
+- lib/keymap/connection_adapters/abstract/connection_pool.rb
+- lib/keymap/connection_adapters/abstract/connection_specification.rb
+- lib/keymap/connection_adapters/abstract/transaction_management.rb
+- lib/keymap/connection_adapters/abstract_adapter.rb
+- lib/keymap/connection_adapters/redis_adapter.rb
+- lib/keymap/errors.rb
+- lib/keymap/version.rb
+- spec/data/.gitignore
+- spec/functional/abstract_adapter_spec.rb
+- spec/functional/adapter_spec.rb
+- spec/functional/adapters/redis/connection_spec.rb
+- spec/rcov.opts
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/support/config.rb
+- spec/support/config.yml
+- spec/support/connection.rb
+- spec/unit/.gitignore
+- spec/unit/test.rb
+- tasks/rspec.rb
+homepage: https://github.com/rbuck/keymap
+licenses: []
+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.24
+signing_key: 
+specification_version: 3
+summary: Abstracts choosing a key-value store implementation, and provides a common
+  API.
+test_files:
+- spec/data/.gitignore
+- spec/functional/abstract_adapter_spec.rb
+- spec/functional/adapter_spec.rb
+- spec/functional/adapters/redis/connection_spec.rb
+- spec/rcov.opts
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/support/config.rb
+- spec/support/config.yml
+- spec/support/connection.rb
+- spec/unit/.gitignore
+- spec/unit/test.rb
+- tasks/rspec.rb