keymap 0.1.0 → 0.2.0

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+script: bundle exec rake spec
+rvm:
+  - 1.9.2
+gemfile:
+ - Gemfile
+notifications:
+  recipients:
+    - buck.robert.j@gmail.com
+branches:
+  only:
+    master

data/README.rdoc

@@ -0,0 +1,93 @@
+= Keymap
+
+Helping Ruby developers and their companies, unlock their key-value store data,
+through associative and sequential based access, providing unprecedented support
+for map reduce behaviors, native to the Ruby language.
+
+A NoSQL database abstraction similar in design to ActiveRecord but solely
+focussed on NoSQL databases. These are the goals for this project:
+
+1. Provide a simple abstraction layer over NoSQL databases, allowing easy
+   migration from one to another without having to rewrite application code.
+
+2. Provide a natural Ruby integration with NoSQL database, allowing direct
+   use of Enumerable operations on returned values (implying returned values
+   are always lists or hashes, or are manipulated to be represented in these
+   forms).
+
+{<img src="https://secure.travis-ci.org/rbuck/keymap.png?branch=master" alt="Continuous Integration Status" />}[http://travis-ci.org/rbuck/keymap]
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'keymap'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install keymap
+
+== Usage
+
+TBD
+
+== 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
+
+== Writing New Adapters
+
+1. Create a new adapter file named #{database_name}_adapter.rb, placing it
+   in the connection adapters directory.
+2. Add an entry to the list of supported databases in the Rakefile.
+3. Add test configuration entries in the spec/support/config.yml file.
+4. Verify all tests pass when the KEYCONN=#{database_name} environment
+   variable is set.
+
+== Configure databases
+
+Copy test/config.example.yml to test/config.yml and edit as needed. Or just run the tests for
+the first time, which will do the copy automatically and use the default (sqlite3).
+
+You can build postgres and mysql databases using the build_postgresql and build_mysql rake tasks.
+
+== Running the tests
+
+You can run a particular test file from the command line, e.g.
+
+  $ ruby -Itest test/cases/base_test.rb
+
+To run a specific test:
+
+  $ ruby -Itest test/cases/base_test.rb -n test_something_works
+
+You can run with a database other than the default you set in test/config.yml, using the ARCONN
+environment variable:
+
+  $ ARCONN=postgresql ruby -Itest test/cases/base_test.rb
+
+You can run all the tests for a given database via rake:
+
+  $ rake test_mysql
+
+The 'rake test' task will run all the tests for mysql, mysql2, sqlite3 and postgresql.
+
+== Identity Map
+
+By default the tests run with the Identity Map turned off. But all tests should pass whether or
+not the identity map is on or off. You can turn it on using the IM env variable:
+
+  $ IM=true ruby -Itest test/case/base_test.rb
+
+== Config file
+
+By default, the config file is expected to be at the path test/config.yml. You can specify a
+custom location with the ARCONFIG environment variable.

data/Rakefile

@@ -48,7 +48,7 @@ desc "Release version #{Keymap::VERSION}"
 task :release => [:tag, :push]
 
 desc "Provides tasks for each adapter type, e.g. test_redis"
-%w( redis ).each do |adapter|
+%w(  ).each do |adapter|
   Rake::TestTask.new("test_#{adapter}") { |t|
     adapter_short = adapter[/^[a-z0-9]+/]
     t.libs << 'test'
@@ -63,13 +63,27 @@ desc "Provides tasks for each adapter type, e.g. test_redis"
   # Set the connection environment for the adapter
   namespace adapter do
     task :test => "test_#{adapter}"
-    task(:env) { ENV['KEYMAPPCONN'] = adapter }
+    task(:env) { ENV['KEYCONN'] = adapter }
   end
 
   # Make sure the adapter test evaluates the env setting task
   task "test_#{adapter}" => "#{adapter}:env"
 end
 
+namespace :redis do
+  task :start_server do
+    config = KeymapTest.config['connections']['redis']
+    puts %x( echo "daemonize yes\nport #{config['test']['port']}\ndir #{File.dirname(__FILE__)}" | redis-server - )
+  end
+
+  task :stop_server do
+    config = KeymapTest.config['connections']['redis']
+    puts %x( redis-cli -p #{config['test']['port']} shutdown )
+  end
+
+  task :restart_server => [:stop_server, :start_server]
+end
+
 desc "Prints lines of code metrics"
 task :lines do
   lines, codelines, total_lines, total_codelines = 0, 0, 0, 0

data/circle.yml

@@ -0,0 +1,9 @@
+machine:
+  timezone:
+    America/New_York
+  ruby:
+    version: ruby-1.9.3-p125
+
+test:
+  post:
+    - bundle exec rake spec

data/keymap.gemspec

@@ -23,6 +23,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency "activesupport", "~> 3.2.8"
 
   %w(rake rdoc simplecov).each { |gem| spec.add_development_dependency gem }
+  %w(ruby-prof).each { |gem| spec.add_development_dependency gem }
   %w(rspec rspec-core rspec-expectations rspec-mocks).each { |gem| spec.add_development_dependency gem, "~> 2.11.0" }
-
 end

data/lib/keymap/base.rb

@@ -25,22 +25,18 @@ module Keymap
     #
     #   development:
     #     adapter: redis
-    #     database: db/development.sqlite3
     #
     #   production:
     #     adapter: redis
-    #     database: db/production.sqlite3
     #
     # ...would result in Keymap::Base.configurations to look like this:
     #
     #   {
     #      'development' => {
-    #         'adapter'  => 'sqlite3',
-    #         'database' => 'db/development.sqlite3'
+    #         'adapter'  => 'redis',
     #      },
     #      'production' => {
-    #         'adapter'  => 'sqlite3',
-    #         'database' => 'db/production.sqlite3'
+    #         'adapter'  => 'redis',
     #      }
     #   }
     cattr_accessor :configurations, :instance_writer => false

data/lib/keymap/connection_adapters/abstract/connection_specification.rb

@@ -122,8 +122,8 @@ module Keymap
 
       # Returns the configuration of the associated connection as a hash:
       #
-      #  ActiveRecord::Base.connection_config
-      #  # => {:pool=>5, :timeout=>5000, :database=>"db/development.sqlite3", :adapter=>"sqlite3"}
+      #  Keymap::Base.connection_config
+      #  # => {:pool=>5, :timeout=>5000, :adapter=>"redis"}
       #
       # Please use only for reading.
       def connection_config

data/lib/keymap/connection_adapters/abstract/data_management.rb

@@ -0,0 +1,15 @@
+module Keymap
+  module ConnectionAdapters
+    module DataManagement #:nodoc:
+
+      def list (key)
+        nil
+      end
+
+      def delete(key)
+        false
+      end
+
+    end
+  end
+end

data/lib/keymap/connection_adapters/abstract/transaction_management.rb

@@ -1,8 +1,22 @@
 require 'keymap/errors'
 
 module Keymap
+
   module ConnectionAdapters # :nodoc:
+
     module TransactionManagement
+      # Checks whether there is currently no transaction active. This is done
+      # by querying the database driver, and does not use the transaction
+      # house-keeping information recorded by #increment_open_transactions and
+      # friends.
+      #
+      # Returns true if there is no transaction active, false if there is a
+      # transaction active, and nil if this information is unknown.
+      #
+      # Not all adapters supports transaction state introspection.
+      def outside_transaction?
+        nil
+      end
 
       # Runs the given block in a database transaction, and returns the result
       # of the block.

data/lib/keymap/connection_adapters/abstract_adapter.rb

@@ -1,7 +1,6 @@
 require 'monitor'
 require 'active_support/callbacks'
 require 'active_support/dependencies/autoload'
-require 'keymap/connection_adapters/abstract/transaction_management'
 
 module Keymap
 
@@ -14,12 +13,15 @@ module Keymap
       autoload :ConnectionHandler, 'keymap/connection_adapters/abstract/connection_pool'
       autoload :ConnectionManagement, 'keymap/connection_adapters/abstract/connection_pool'
       autoload :ConnectionSpecification
+      autoload :TransactionManagement
+      autoload :DataManagement
     end
 
     class AbstractAdapter
 
       include ActiveSupport::Callbacks
       include TransactionManagement
+      include DataManagement
       include MonitorMixin
 
       define_callbacks :checkout, :checkin

data/lib/keymap/connection_adapters/redis_adapter.rb

@@ -70,42 +70,84 @@ module Keymap
         raw_connection.discard
       end
 
-      # Retrieves the hash whose name is identified by key.
-      def hash (key)
-        coll = KeyStoreHash.new
-        coll.connection = raw_connection
-        coll.key = key
-        coll
-        #
-        # Perhaps there is a more experienced ruby developer who could help with this.
-        # I'd rather do the following but could not figure out how to get it to work:
-        #
-        #def create_getter(connection, key)
-        #  lambda { |field| connection.hget key, field }
-        #end
-        #
-        #def create_setter(connection, key)
-        #  lambda { |field, value| connection.hset key, field, value }
-        #end
-        #
-        #coll.class.send :define_method, "[]", create_getter(raw_connection, key)
-        #coll.class.send :define_method, "[]=", create_setter(raw_connection, key)
-        #coll
+      def delete(key)
+        raw_connection.del(key) != 0
+      end
+
+      # todo idea: add an optional argument where we specify the data type for elements in the collection
+      def list (key)
+        List.new(raw_connection, key)
       end
     end
 
     private
 
-    class KeyStoreHash < Hash
+    class List
+
+      include Enumerable
+
+      attr_reader :connection, :key
+
+      def initialize(connection, key)
+        @connection = connection
+        @key = key
+        self << nil # sentinel to force creation of an "empty list"
+      end
+
+      def each
+        if block_given?
+          step_size = 100
+          (0..length % step_size).step(step_size) do |step|
+            first = step_size * step
+            last = first + step_size
+            list = connection.lrange key, first + 1, last
+            list.each do |item|
+              yield item
+            end
+          end
+        else
+          ::Enumerable::Enumerator.new(self, :each)
+        end
+      end
+
+      def <<(value)
+        connection.rpush key, value
+        self
+      end
+
+      alias :push :<<
+
+      def [](index)
+        connection.lindex key, index + 1
+      end
+
+      def []=(index, value)
+        connection.lset key, index + 1, value
+      end
 
-      attr_accessor :connection, :key
+      def length
+        connection.llen(key) -1
+      end
+
+      alias size length
+
+      def empty?()
+        length != 1
+      end
+
+      def pop()
+        connection.rpop key unless length == 0
+      end
 
-      def [] (field)
-        connection.hget key, field
+      def delete(value)
+        value = connection.lrem(key, 0, value) == 0 ? nil : value
+        yield value if block_given?
+        value
       end
 
-      def []=(field, value)
-        connection.hset key, field, value
+      def delete_if(&block)
+        # todo
+        self
       end
     end
 

data/lib/keymap/version.rb

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

data/spec/functional/list_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe Keymap::Base do
+  before do
+    @connection = Keymap::Base.connection
+  end
+
+  context "a connection yields enumerable lists" do
+
+    before(:each) do
+      @connection.delete :what
+    end
+
+    after(:each) do
+      @connection.delete :what
+    end
+
+    it "adds an empty list automatically upon assignment" do
+      list = @connection.list :what
+      list.nil?.should be_false
+    end
+
+    it "lists support an empty? operation" do
+      list = @connection.list :what
+      list.respond_to?(:empty?).should be_true
+    end
+
+    it "lists are empty upon creation" do
+      list = @connection.list :what
+      list.empty?.should be_true
+    end
+
+    it "returns false when trying to delete a key that does not exist" do
+      exists = @connection.delete :what
+      exists.should be_false
+    end
+
+    it "returns true when trying to delete a key that does exist" do
+      @connection.list :what
+      exists = @connection.delete :what
+      exists.should be_true
+    end
+
+    it "lists implement enumerable" do
+      list = @connection.list :what
+      list.respond_to?(:each).should be_true
+    end
+
+    it "lists support pop" do
+      list = @connection.list :what
+      list << 1
+      list.pop.to_i.should eq(1)
+    end
+
+    it "lists support append operators and inject" do
+      list = @connection.list :what
+      (0..10).each do |value|
+        list << value
+      end
+      sum = list.inject(0) do |result, item|
+        result + item.to_i
+      end
+      sum.should eq(55)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -15,5 +15,7 @@ SimpleCov.start do
   add_group 'Libraries', 'lib'
 end
 
-#RSpec.configure do |config|
-#end
+require 'support/config'
+require 'support/connection'
+
+KeymapTest.connect

data/spec/support/config.rb

@@ -14,12 +14,12 @@ module KeymapTest
     private
 
     def config_file
-      Pathname.new(ENV['KEYMAP_CONFIG'] || SPEC_ROOT + '/support/config.yml')
+      Pathname.new(ENV['KEYMAP_CONFIG'] || File.join(SPEC_ROOT, 'config.yml'))
     end
 
     def read_config
       unless config_file.exist?
-        FileUtils.cp SPEC_ROOT + '/support/config.example.yml', config_file
+        FileUtils.cp(File.join(SPEC_ROOT, 'config.example.yml'), config_file)
       end
 
       erb = Erubis::Eruby.new(config_file.read)
@@ -27,18 +27,6 @@ module KeymapTest
     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

data/spec/support/config.yml

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

data/spec/support/connection.rb

@@ -2,7 +2,7 @@ require 'logger'
 
 module KeymapTest
   def self.connection_name
-    ENV['KEYMAP_CONN'] || config['default_connection']
+    ENV['KEYCONN'] || config['default_connection']
   end
 
   def self.connection_config
@@ -12,6 +12,6 @@ module KeymapTest
   def self.connect
     Keymap::Base.logger = Logger.new("debug.log")
     Keymap::Base.configurations = connection_config
-    Keymap::Base.establish_connection 'kmunit'
+    Keymap::Base.establish_connection 'test'
   end
 end

data/tasks/rspec.rb

@@ -1,7 +1,7 @@
 require 'rubygems'
 require 'rake'
 
-GEM_ROOT = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+GEM_ROOT ||= File.expand_path(File.join(File.dirname(__FILE__), ".."))
 
 begin
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: keymap
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -107,6 +107,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-prof
+  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
@@ -179,15 +195,18 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - LICENSE.txt
-- README.md
+- README.rdoc
 - Rakefile
+- circle.yml
 - 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/data_management.rb
 - lib/keymap/connection_adapters/abstract/transaction_management.rb
 - lib/keymap/connection_adapters/abstract_adapter.rb
 - lib/keymap/connection_adapters/redis_adapter.rb
@@ -197,6 +216,7 @@ files:
 - spec/functional/abstract_adapter_spec.rb
 - spec/functional/adapter_spec.rb
 - spec/functional/adapters/redis/connection_spec.rb
+- spec/functional/list_spec.rb
 - spec/rcov.opts
 - spec/spec.opts
 - spec/spec_helper.rb
@@ -236,6 +256,7 @@ test_files:
 - spec/functional/abstract_adapter_spec.rb
 - spec/functional/adapter_spec.rb
 - spec/functional/adapters/redis/connection_spec.rb
+- spec/functional/list_spec.rb
 - spec/rcov.opts
 - spec/spec.opts
 - spec/spec_helper.rb

data/README.md

@@ -1,47 +0,0 @@
-# Keymap
-
-A NoSQL database abstraction similar in design to ActiveRecord but solely
-focussed on NoSQL databases. These are the goals for this project:
-
-1. Provide a simple abstraction layer over NoSQL databases, allowing easy
-   migration from one to another without having to rewrite application code.
-
-2. Provide a natural Ruby integration with NoSQL database, allowing direct
-   use of Enumerable operations on returned values (implying returned values
-   are always lists or hashes, or are manipulated to be represented in these
-   forms).
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'keymap'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install keymap
-
-## Usage
-
-TBD
-
-## 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
-
-## Writing New Adapters
-
-1. Create a new adapter file named #{database_name}_adapter.rb, placing it
-   in the connection adapters directory.
-2. Add an entry to the list of supported databases in the Rakefile.
-3. Add test configuration entries in the spec/support/config.yml file.
-4. Verify all tests pass when the KEYMAP_CONN=#{database_name} environment
-   variable is set.