campchair 0.1.1 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 40f0f2322fed1bd3467b787b7d2ecdb3b924b0a1
+  data.tar.gz: ad56fcf4e38d1b375d480537412f48d060677fda
+SHA512:
+  metadata.gz: 4f83f7ce711c607e35909abbf04d1803e6953b5be15dd4ec93dcb74afc29c8fa83aef9aa657adfb740eee8597580d66994c4e6049dcac093d03bd380b569f8ba
+  data.tar.gz: b160dab7ad0c2d1508ed027ff6d4f8b7a22f62dd691d521604d5d1779c35b29034e66508316b90b4784c51e8c8451912dd2b8d663aa5dfd9e6699c8f34074439

data/Gemfile

@@ -1,4 +1,4 @@
-source "http://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in campchair.gemspec
 gemspec

data/README.md

@@ -1,5 +1,5 @@
 # ⑁ Campchair
-### A fast, ghetto-tech CouchDB-like persistence layer for Ruby
+### A fast LevelDB object-persistence layer for Ruby
 
 [![Build Status](https://secure.travis-ci.org/captainpete/campchair.png?branch=master)](http://travis-ci.org/captainpete/campchair)
 
@@ -9,16 +9,27 @@ Campchair provides some helpers for lazily materialized views,
 and gives you a choice of using ActiveRecord-like models
 or class-based, barebones data-structure access.
 
-Views are described a bit like those found in [CouchDB](http://couchdb.apache.org/).
-Campchair is not a service and has no client-server stuff.
-Parallel access is not supported yet, but that's okay – you can use something
-else for concurrency and use this in your persistence fiber/thread/process.
-
-Persistence happens through [LevelDB](http://code.google.com/p/leveldb/).
+Persistence happens with [LevelDB](http://code.google.com/p/leveldb/).
 Objects are serialized into documents using Ruby's Marshal class.
-This is not append-only and replication is not a feature.
+
+### Update 2014-04
 
 This project was born at [Railscamp 11](http://railscamps.com/).
+Then I forgot about it, and in the interim learned a lot more about concurrent programming, to the point where I'd like to revive this project but would need to change nearly everything about it!
+
+I'm sure you've been there...
+
+### Dependencies
+
+- Needs `leveldb` libraries `brew install leveldb`
+- Needs Ruby ;)
+
+### Current Limitations
+
+- This is not append-only and replication is not a feature.
+- There is no concurrent access.
+- There are no transactions.
+- There is no promise pipeline.
 
 ### As a basic data structure store
 
@@ -106,188 +117,6 @@ fred.save
 People[fred.key] # => { :favourite_colour => 'LSD' }
 ```
 
-### Basic views _not yet implemented_
-
-For views to be available on classes we need to include `Campchair::Views`.
-
-```ruby
-class People # add some views to the people class
-  include Campchair::Views
-
-  # Map to document by id
-  view :all do
-    map { |id, person| emit id, person }
-  end
-
-  # Map to name by doc id
-  view :names do
-    map { |id, person| emit id, person.name }
-  end
-end
-
-People.names
-# ['Fred', 'Jane']
-```
-
-### Using reduce _not yet implemented_
-
-Reduce gets called on groups of map results.
-
-```ruby
-class People
-  # Map to count by doc id
-  # Reduce to sum of counts
-  view :count do
-    map { |id, person| emit id, 1 }
-    reduce do |keys, values|
-      values.inject(0) { |memo, values| memo + values }
-    end
-  end
-end
-
-People.count
-# 2
-```
-
-Reduce happens in stages. Supply a rereduce step to handle reducing reduce
-results. The advantage of rereduce is results can be cached in a b-tree index.
-
-If `rereduce` is supplied then `reduce` is called with a portion of the `map`
-results and those reductions are passed to `rereduce`. If `rereduce` is
-omitted then `reduce` results will not be cached.
-
-```ruby
-class People
-  # Map to location by doc id
-  # Reduce by unique location
-  view :unique_locations do
-    map { |id, person| emit id, person.location }
-    reduce do |keys, values|
-      results = values.uniq
-    end
-    rereduce do |results|
-      results.inject(Set.new) { |memo, values| memo.merge values }
-    end
-  end
-end
-
-People.unique_locations
-# <Set: {"Flinders St Station, Melbourne, Australia"}>
-```
-
-Keep in mind that if `rereduce` is not supplied, `reduce` will always get
-called with the entire keyspace. If the dataset is large this might consume a
-lot of memory.
-
-### Using keys with reduce _not yet implemented_
-
-```ruby
-class People
-  # Map to count by name
-  # Reduce by sum of counts
-  view :count_by_name do
-    map { |id, person| emit name, 1 }
-    reduce do |keys, values|
-      values.inject(0) { |memo, value| memo + value }
-    end
-    rereduce do |results|
-      results.inject(0) { |memo, value| memo + value }
-    end
-  end
-end
-
-People.count_by_name['Jane']
-# 1
-People.count_by_name
-# 2
-```
-
-### Controlling the index _not yet relevant_
-
-It's possible to write reduce methods that return results larger than the
-input. If you're doing this, you're gonna have a bad time. Unless you're sure
-the dataset will remain small enough that the index for each `rereduce` doesn't
-blow out your disk store.
-
-```ruby
-class People
-  # DANGER: this view will blow out the index
-
-  # Map to count by name
-  # Reduce by sum of counts by name
-  view :count_all_by_name do
-    map { |id, person| emit person.name, 1 }
-    reduce do |keys, values|
-      result = Hash.new
-      keys.each_with_index do |key, index|
-        result[key] ||= 0
-        result[key] += values[index]
-      end
-      result # scary, nearly as large as the input
-    end
-    rereduce(:cache => false) do |results|
-      result = {}
-      results.each do |name, count|
-        result[name] ||= 0
-        result[name] += count
-      end
-      result # likewise, this will explode the index
-    end
-  end
-end
-
-People.count_all_by_name['Jane']
-# { 'Jane' => 1 }
-People.count_all_by_name
-# { 'Fred' => 1, 'Jane' => 1 }
-```
-
-### Re-re-reducing _not yet implemented_
-
-Sometimes it's useful to post-process reduce results. Add another rereduce to
-process rereduced values. Only the first rereduce gets called on values it
-produces itself. Subsequent rereduces are chained to the initial result.
-
-```ruby
-clas People
-  # Map to height by location
-  # Reduce by count and sum of heights
-  # Rereduce by the calculating average
-  view :average_height_by_location do
-    map { |id, person| emit location, height }
-    reduce do |keys, values|
-      result = Hash.new
-      keys.each_with_index do |key, index|
-        result[key] ||= { :count => 0, :sum => 0 }
-        result[key][:count] += 1
-        result[key][:sum] += height
-      end
-      result
-    end
-    rereduce do |results|
-      result = { :count => 0, :sum => 0 }
-      results.each do |result|
-        result[:count] += part[:count]
-        result[:sum] += part[:sum]
-      end
-      result
-    end
-    rereduce do |results|
-      count = results.inject(0) { |memo, result| result[:count] }
-      sum = results.inject(0) { |memo, result| result[:sum] }
-      count == 0 ? nil : sum / count
-    end
-  end
-end
-
-People.average_height_by_location
-# 1.690999999
-People.average_height_by_location['Flinders St Station, Melbourne, Australia']
-# 1.690999999
-People.average_height_by_location['Docklands, Melbourne, Australia']
-# nil
-```
-
 ### Custom database path
 
 By default, the folder for db files is 'cddb'.
@@ -306,9 +135,8 @@ end
 
 ### TODO
 
-- Make the README examples work
-- Views spanning views
-- Caching view results
-- Caching reduce results
-- method_missing for `count_by_*, sum_of_*s, min_*, max_*, unique_*s`
-- cache priming
+- Transactions
+- Portable Promise Pipelines
+- Transforms
+- Cache invalidation / Bindings
+

data/Rakefile

@@ -1,9 +1,6 @@
 require 'bundler/gem_tasks'
-
-require 'rspec/core'
 require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
-end
 
+RSpec::Core::RakeTask.new('spec')
 task :default => :spec
+

data/campchair.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |s|
   s.authors     = ["Peter Hollows"]
   s.email       = ["pete@dojo7.com"]
   s.homepage    = "https://github.com/captainpete/campchair"
-  s.summary     = %q{A fast, ghetto-tech CouchDB-like persistence layer for Ruby}
-  s.description = %q{Campchair is a map-reduce framework using levelDB for persistence, and Ruby for everything else.}
+  s.summary     = %q{A fast LevelDB object-persistence layer for Ruby}
+  s.description = %q{Campchair is simple persistence mixin using LevelDB and Marshal to persist Ruby objects.}
 
   s.rubyforge_project = "campchair"
 
@@ -18,8 +18,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency  %q<leveldb-ruby>, ["~> 0.14"]
-
-  s.add_development_dependency  %q<rspec>,  ["~> 2.12.0"]
-  s.add_development_dependency  %q<rake>,   ["~> 10.0.0"]
+  s.add_dependency              'leveldb-ruby', '~> 0.14'
+  s.add_development_dependency  'rspec',        '~> 2.12.0'
+  s.add_development_dependency  'rake',         '~> 10.0.0'
 end

data/lib/campchair.rb

@@ -1,7 +1,6 @@
 require "campchair/version"
 
 module Campchair
-  autoload :Views,  'campchair/views'
   autoload :Store,  'campchair/store'
   autoload :Model,  'campchair/model'
 

data/lib/campchair/version.rb

@@ -1,3 +1,5 @@
 module Campchair
-  VERSION = "0.1.1"
+
+  VERSION = '0.2.0'
+
 end

metadata

@@ -1,75 +1,68 @@
 --- !ruby/object:Gem::Specification
 name: campchair
 version: !ruby/object:Gem::Version
-  version: 0.1.1
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - Peter Hollows
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-14 00:00:00.000000000 Z
+date: 2014-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: leveldb-ruby
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.14'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.14'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.12.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 10.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 10.0.0
-description: Campchair is a map-reduce framework using levelDB for persistence, and
-  Ruby for everything else.
+description: Campchair is simple persistence mixin using LevelDB and Marshal to persist
+  Ruby objects.
 email:
 - pete@dojo7.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - README.md
 - Rakefile
@@ -78,43 +71,39 @@ files:
 - lib/campchair/model.rb
 - lib/campchair/store.rb
 - lib/campchair/version.rb
-- lib/campchair/views.rb
 - spec/.gitkeep
 - spec/campchair/model_spec.rb
 - spec/campchair/store_spec.rb
-- spec/campchair/views_spec.rb
 - spec/campchair_spec.rb
 - spec/integration/readme_examples_spec.rb
 - spec/spec_helper.rb
 - tmp/.gitkeep
 homepage: https://github.com/captainpete/campchair
 licenses: []
+metadata: {}
 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: campchair
-rubygems_version: 1.8.24
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
-summary: A fast, ghetto-tech CouchDB-like persistence layer for Ruby
+specification_version: 4
+summary: A fast LevelDB object-persistence layer for Ruby
 test_files:
 - spec/campchair/model_spec.rb
 - spec/campchair/store_spec.rb
-- spec/campchair/views_spec.rb
 - spec/campchair_spec.rb
 - spec/integration/readme_examples_spec.rb
 - spec/spec_helper.rb

data/lib/campchair/views.rb

@@ -1,4 +0,0 @@
-module Campchair
-  module Views
-  end
-end

data/spec/campchair/views_spec.rb

@@ -1,4 +0,0 @@
-require 'spec_helper'
-
-describe Campchair::Views do
-end