cushion 0.0.3 → 0.0.4

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -1,4 +1,2 @@
 source 'http://rubygems.org'
-
 gemspec
-

data/README.md

@@ -0,0 +1,24 @@
+# Cushion
+
+A HashWithIndifferentAccess with a CouchDB persistence layer.
+
+## Synopsis
+
+Using Cushion is as simple as this:
+
+    hash = Cushion.new('/db/document')
+    hash.load
+    hash[:foo] = 'bar'
+    hash.save
+
+When the document's URI consists only of the database part (`/db`), the id will be a UUID, set by CouchDB on `.save`.
+
+Cushion can also be inherited from, which will lead to the database name being taken from the inheriting classes name. Like this:
+
+    class MyCushion < Cushion; end
+    hash = MyCushion.new
+    hash.save
+
+In this case a document URI doesn't have to be given explicitly (even though, it can be given). For the above example, the URI would be `/my_cushions/<UUID set by CouchDB>`.
+
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/cushion.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'cushion'
+  s.version     = '0.0.4'
+  s.authors     = ['Helge Rausch']
+  s.email       = ['helge@rausch.io']
+  s.homepage    = 'https://github.com/tsujigiri/cushion'
+  s.summary     = %q{A Hash with CouchDB persistence}
+  s.description = %q{A Hash with indifferent access and CouchDB persistence layer}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+
+  s.add_development_dependency 'test-unit'
+  s.add_development_dependency 'shoulda'
+  s.add_development_dependency 'ruby-debug19'
+  s.add_runtime_dependency 'active_support'
+  s.require_paths = ['lib']
+end

data/lib/cushion.rb

@@ -13,33 +13,39 @@ class Cushion < HashWithIndifferentAccess
       uri = args.shift
     end
     if uri.nil?
-      if self.class.ancestors.include?(Cushion)
+      if self.class.ancestors[1..-1].include?(Cushion)
         uri = '/' << self.class.name.underscore.pluralize
       else
         raise "No database URI given"
       end
     end
-    document_uri uri
+    document_location uri
     data = args.shift
     super(data, &block)
   end
 
-  def document_uri uri = nil
-    return @document_uri unless uri
-    uri =~ /(http:\/\/)?(\w+)?:?([0-9]+)?\/(\w+)(\/(\w+))?/
+  def document_location uri = nil
+    return @document_location unless uri
+    uri =~ /(http:\/\/)?([^:\/\?]+)?(:([0-9]+))?\/(\w+)(\/(\w+))?/
 
-    @document_uri = { host: $2 || 'localhost',
-                      port: $3 || 5984 }
+    self.class.server [ $2 || 'localhost', $4 ? $4.to_i : 5984 ]
+    @document_location            = {}
+    @document_location[:database] = $5
+    @id                           = $7
+    @document_location[:uri]      = "/#{@document_location[:database]}/#{@id}" if @id
+  end
 
-    @document_uri[:database] = $4
-    @id                      = $6
-    @document_uri[:uri]      = "/#{@document_uri[:database]}/#{@id}" if @id
+  def self.create_database uri
+    put(uri) unless get(uri)['db_name']
+    database_created true
   end
 
-  def create_database
-    database_uri = "/#{document_uri[:database]}"
-    put(database_uri) unless get(database_uri)['db_name']
-    @database_created = true
+  def self.database_created true_or_false = nil
+    if [ true, false ].include?(true_or_false)
+      @database_created = true_or_false
+    else
+      @database_created
+    end
   end
 
   def revision
@@ -51,46 +57,57 @@ class Cushion < HashWithIndifferentAccess
   end
 
   def load
-    replace(get)
+    replace(self.class.get(document_location[:uri]))
   end
 
   def save
-    create_database unless @database_created
+    unless self.class.database_created
+      self.class.create_database('/' << document_location[:database])
+    end
     if @id.present?
-      response = put(document_uri[:uri], self)
+      copy = @revision ? self.merge(_rev: @revision) : self.dup
+      response = self.class.put(document_location[:uri], copy)
       @revision = response['rev']
     else
-      response = post('/' << document_uri[:database], self)
+      response = self.class.post('/' << document_location[:database], self)
       @id = response['id']
       @revision = response['rev']
+      @document_location[:uri] = "/#{@document_location[:database]}/#{@id}"
     end
+    @revision
   end
 
-  def get uri = document_uri[:uri]
-    JSON.parse(request(Net::HTTP::Get.new(uri)).body)
-  end
-
-  def put uri = document_uri[:uri], data = nil
-    req = Net::HTTP::Put.new(uri)
-    req["content-type"] = "application/json"
-    req.body = data.to_json if data.present?
-    JSON.parse(request(req).body)
-  end
-
-  def post uri = document_uri[:uri], data = nil
-    req = Net::HTTP::Post.new(uri)
-    req["content-type"] = "application/json"
-    req.body = data.to_json if data.present?
-    JSON.parse(request(req).body)
-  end
-
-  def delete uri = document_uri[:uri]
-    JSON.parse(request(Net::HTTP::Delete.new(uri)).body)
-  end
-
-  private
+  class << self
+    def server host_and_port = nil
+      host_and_port.present? ? @server = host_and_port : @server
+    end
 
-  def request(req)
-    Net::HTTP.start(document_uri[:host], document_uri[:port]) { |http| http.request(req) }
+    def get uri
+      JSON.parse(request(Net::HTTP::Get.new(uri)).body)
+    end
+ 
+    def put uri, data = nil
+      req = Net::HTTP::Put.new(uri)
+      req["content-type"] = "application/json"
+      req.body = data.to_json if data.present?
+      JSON.parse(request(req).body)
+    end
+ 
+    def post uri, data = nil
+      req = Net::HTTP::Post.new(uri)
+      req["content-type"] = "application/json"
+      req.body = data.to_json if data.present?
+      JSON.parse(request(req).body)
+    end
+ 
+    def delete uri
+      JSON.parse(request(Net::HTTP::Delete.new(uri)).body)
+    end
+ 
+    private
+ 
+    def request(req)
+      Net::HTTP.start(*server) { |http| http.request(req) }
+    end
   end
 end

data/test/cushion_test.rb

@@ -1,6 +1,6 @@
 require 'rubygems'
 require 'bundler'
-Bundler.require(:default, :test)
+Bundler.require(:default, :development)
 require_relative '../lib/cushion'
 
 class CushionTest < Test::Unit::TestCase
@@ -11,11 +11,25 @@ class CushionTest < Test::Unit::TestCase
       @doc = Cushion.new(@doc_uri, { foo: "bar", test: "data" })
     end
 
-    should "create a document" do
-      @doc.save
+    should "save a document with an explicit id" do
+      revision = @doc.save
       doc = Cushion.new(@doc_uri)
+      assert_equal nil, doc[:foo]
       doc.load
       assert_equal "bar", doc[:foo]
+      assert_equal 'test_doc', @doc.id
+      new_revision = revision.to_i + 1
+      assert_match /#{new_revision}-[0-9a-f]{32}/, @doc.save
+    end
+
+    should "save a document without an explicit id" do
+      doc = FooCushion.new(foo: "bar")
+      assert_equal({ database: "foo_cushions" }, doc.document_location)
+      assert revision = doc.save
+      assert_match /\A\/foo_cushions\/[0-9a-f]{32}\Z/, doc.document_location[:uri]
+      assert id = doc.id
+      new_revision = revision.to_i + 1
+      assert_match /#{new_revision}-[0-9a-f]{32}/, doc.save
     end
 
     should "convert to JSON like a hash" do
@@ -23,13 +37,25 @@ class CushionTest < Test::Unit::TestCase
     end
 
     should "find the important parts in the given uri" do
-      @doc.document_uri "/foo"
-      assert_equal "foo", @doc.document_uri[:database]
+      @doc.document_location "/foo"
+      assert_equal "foo", @doc.document_location[:database]
+      assert_equal [ 'localhost', 5984 ], @doc.class.server
+      @doc.document_location "http://example.com/foo"
+      assert_equal "foo", @doc.document_location[:database]
+      assert_equal [ 'example.com', 5984 ], @doc.class.server
+      @doc.document_location "http://example.com:1234/foo"
+      assert_equal "foo", @doc.document_location[:database]
+      assert_equal [ 'example.com', 1234 ], @doc.class.server
+      @doc.document_location "/foo/bar"
+      assert_equal "foo", @doc.document_location[:database]
+      assert_equal "/foo/bar", @doc.document_location[:uri]
+      assert_equal [ 'localhost', 5984 ], @doc.class.server
+      assert_equal 'bar', @doc.id
     end
 
     should "take the database name from the class name when inherited" do
       foo = FooCushion.new
-      assert_equal "foo_cushions", foo.document_uri[:database]
+      assert_equal "foo_cushions", foo.document_location[:database]
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cushion
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-29 00:00:00.000000000Z
+date: 2011-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit
-  requirement: &20647580 !ruby/object:Gem::Requirement
+  requirement: &11099760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *20647580
+  version_requirements: *11099760
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &20647100 !ruby/object:Gem::Requirement
+  requirement: &11099020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,21 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *20647100
+  version_requirements: *11099020
+- !ruby/object:Gem::Dependency
+  name: ruby-debug19
+  requirement: &11098400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *11098400
 - !ruby/object:Gem::Dependency
   name: active_support
-  requirement: &20646620 !ruby/object:Gem::Requirement
+  requirement: &11097680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +54,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *20646620
+  version_requirements: *11097680
 description: A Hash with indifferent access and CouchDB persistence layer
 email:
 - helge@rausch.io
@@ -51,7 +62,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
 - Gemfile
+- README.md
+- Rakefile
+- cushion.gemspec
 - lib/cushion.rb
 - test/cushion_test.rb
 homepage: https://github.com/tsujigiri/cushion
@@ -74,7 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.6
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: A Hash with CouchDB persistence