couchpillow 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aebdc9cea445fcc41867e0b89beda54aa8f4e317
+  data.tar.gz: ea3f214cabe96aac8e3001c1c48633e7cc9f4fc9
+SHA512:
+  metadata.gz: 102f839f848e55a30e02e9e1e7e5cad6c3d8cef6d641ba5bfa0aaef39d7c18129793dd4e380af6e98c27e03a1dd14b7f1a40e2f1ed47240f4f4f0f9137830b97
+  data.tar.gz: 10c976296156db15b542456e44bfed6d8c8e38d6247ceb62a8674606f109e51427a4810040933267cc13c16db966c6ba3ea134b75d902ea518d05298db973354

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+*.swp

data/README.markdown

@@ -0,0 +1,106 @@
+# CouchPillow
+
+Light and comfortable Document wrapper for Couchbase Server.
+
+
+## Why CouchPillow?
+
+Yet another ORM? Not quite. CouchPillow separates itself from the database
+drivers, making it light and independent from the implementation.
+
+Although it is initially designed to work with Couchbase Server, one can
+easily extend this to other NoSQL drivers as long as they `respond_to?`
+the `set`, `delete`, `replace`, and `get` methods.
+
+
+## Features
+
+- Automatic timestamp
+- Validation
+
+
+## How To Use
+
+    CouchPillow.db = Couchbase.connect(
+      bucket: 'default',
+      host: 'localhost' )
+    doc = CouchPillow::Document.new( { :stuff => 'hello' }, '123' )
+    doc.save!
+    
+    # {
+    #   '_type': 'default',
+    #   'stuff': 'hello',
+    #   'created_at': '2014-07-04 00:00:00 UTC'
+    #   'updated_at': '2014-07-04 00:00:00 UTC'
+    # }
+
+
+Retrieving Documents
+
+    doc = CouchPillow::Document.get('123')
+    doc.stuff # '123'
+  
+
+Overriding `CouchPillow::Document`
+
+    class User < CouchPillow::Document
+      type :user
+    end
+
+    CouchPillow.db = Couchbase.connect(
+      bucket: 'default',
+      host: 'localhost' )
+    doc = User.new( { :email => 'john@email.com' } )
+    doc.email # 'john@email.com'
+    doc.save!
+
+    # {
+    #   '_id': 'fb579b265cc005c47ff420a5c2a15d2b',
+    #   '_type': 'user',
+    #   'email': 'john@email.com',
+    #   'created_at': '2014-07-04 00:00:00 UTC'
+    #   'updated_at': '2014-07-04 00:00:00 UTC'
+    # }
+
+Using validation
+
+    class User < CouchPillow::Document
+      type :user
+      validate_presence :email
+    end
+
+    CouchPillow.db = Couchbase.connect(
+      bucket: 'default',
+      host: 'localhost' )
+    doc = User.new( { :first_name => 'John' } )
+    doc.save!  # raises ValidationError('email is missing')
+    doc.email = 'john@email.com'
+    doc.save! # Success!
+
+Using custom validation blocks
+
+    class User < CouchPillow::Document
+      type :user
+      validate_presence :email
+      validate :phone, 'is not a number', lambda { |v| v.is_a? Numeric }
+    end
+
+    CouchPillow.db = Couchbase.connect(
+      bucket: 'default',
+      host: 'localhost' )
+    doc = User.new
+    doc.email = 'john@email.com'
+    doc.first_name = 'john'
+    doc.phone = '123'
+    doc.save! # raises ValidationError('phone is not a number')
+    doc.phone = 123
+    doc.save! # Success!
+
+What about Design Docs and Views? They are outside the scope of CouchPillow.
+However, given a design doc named `my_design_doc` and a View named `by_email`,
+that returns documents as values, you can easily use it like this:
+
+    CouchPillow.db.design_docs['my_design_doc'].
+      by_email(:body => { :key => 'john@email.com' }).map do |v|
+        new User(v.value, v.id)
+      end

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rake/testtask'
+
+task :default => "build"
+
+Rake::TestTask.new do |t|
+  t.description = "Run tests"
+  t.name = "test"
+  t.pattern = "./test/**/*.rb"
+end
+
+task :build do
+  `gem build couchpillow.gemspec`
+end

data/couchpillow.gemspec

@@ -0,0 +1,21 @@
+$:.push File.expand_path("../lib", __FILE__)
+require 'couchpillow/version'
+
+Gem::Specification.new do |s|
+  s.name = "#{CouchPillow::GEM_NAME}"
+  s.version = CouchPillow::VERSION
+  s.authors = ["Albert Tedja"]
+  s.email = "nicho_tedja@yahoo.com"
+  s.homepage = "https://github.com/atedja/pillow"
+  s.summary = "Document wrapper for Couchbase"
+  s.description = "#{CouchPillow::NAME} is a light and comfortable Document wrapper for Couchbase Server."
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {test}/*`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency 'minitest',  '~> 5.3'
+  s.add_development_dependency 'mocha', '~> 1.1'
+
+  s.license = "BSD"
+end

data/lib/couchpillow.rb

@@ -0,0 +1,17 @@
+require 'securerandom'
+require 'json'
+
+module CouchPillow
+
+  def self.db= driver
+    @db = driver
+  end
+
+  def self.db
+    @db || nil
+  end
+
+end
+
+require './lib/couchpillow/document'
+require './lib/couchpillow/version'

data/lib/couchpillow/document.rb

@@ -0,0 +1,153 @@
+module CouchPillow
+  
+  class Document
+
+    class ValidationError < StandardError; end
+
+
+    attr_reader :id
+
+
+    @type = "default"
+
+
+    PRESENCE_LAMBDA = lambda do |value| !value.nil? end
+
+
+    def initialize hash = {}, id = SecureRandom.hex
+      @data = self.class.symbolize(hash)
+      @id = id
+
+      @data[:created_at] and
+        @data[:created_at] = Time.parse(@data[:created_at]) or
+        @data[:created_at] = Time.now.utc
+      @data[:updated_at] = Time.parse(@data[:updated_at]) if @data[:updated_at]
+
+      raise TypeError if @data[:_type] && @data[:_type] != self.class._type
+      @data[:_type] = self.class._type
+    end
+
+
+    # Map hash keys to methods
+    #
+    def method_missing m, *args, &block
+      ms = m.to_s
+      if ms.end_with?("=")
+        ms.gsub!('=', '')
+        @data[ms.to_sym] = args[0]
+      else
+        @data.has_key?(m) and
+          @data[m] or
+          super
+      end
+    end
+
+
+    def respond_to? m
+      ms = m.to_s
+      return true if ms.end_with?("=")
+      @data.has_key?(m) or
+        super
+    end
+
+    def timestamp!
+      @data[:updated_at] = Time.now.utc
+    end
+
+
+    def save!
+      validate
+      sort!
+      timestamp!
+      CouchPillow.db.set @id, @data
+    end
+
+
+    def delete!
+      CouchPillow.db.delete @id
+    end
+
+
+    def sort!
+      @data = @data.sort.to_h
+    end
+
+
+    # Attempt to update this Document. Fails if this Document does not yet
+    # exist in the database.
+    #
+    def update!
+      validate
+      sort!
+      timestamp!
+      CouchPillow.db.replace @id, @data
+    end
+
+
+    def to_json *a
+      h = { :_id => @id }.merge!(@data)
+      h.to_json(*a)
+    end
+
+
+    def validate
+      self.class.validate_keys.each do |k, msg, method|
+        raise ValidationError, "#{k} #{msg}" unless
+          @data.has_key?(k) && method.call(@data[k])
+      end
+    end
+
+
+    def self.get id
+      new(CouchPillow.db.get(id), id)
+    end
+
+
+    def self.type value
+      @type = value.to_s
+    end
+
+
+    def self._type
+      @type
+    end
+
+
+    def self.design_doc value
+      @ddoc = value
+    end
+
+
+    # Validate the presence of a particular key, and the value of that key
+    # cannot be nil.
+    #
+    def self.validate_presence key
+      validate key, "is missing", PRESENCE_LAMBDA
+    end
+
+
+    # Validate the presence of a particular key using a custom validation method.
+    # Implies the Document must contain the key.
+    #
+    def self.validate key, message, block
+      raise ValidationError, "Provide validation method for key #{key}" unless block
+      validate_keys << [key, message, block]
+    end
+
+
+    private
+
+
+    def self.validate_keys
+      @validate_key ||= []
+    end
+
+
+    def self.symbolize hash
+      hash.inject({}) do |memo,(k,v)|
+        memo[k.to_sym] = v
+        memo
+      end
+    end
+  end
+end

data/lib/couchpillow/version.rb

@@ -0,0 +1,5 @@
+module CouchPillow
+  GEM_NAME = "couchpillow"
+  NAME = "CouchPillow"
+  VERSION = "0.1"
+end

data/test/document.rb

@@ -0,0 +1,93 @@
+require 'minitest/autorun'
+require 'minitest/unit'
+require 'mocha/mini_test'
+require './lib/couchpillow.rb'
+
+class TestDocument < Minitest::Test
+
+  class TestDoc < CouchPillow::Document
+    type              :test
+    validate_presence :xyz
+    validate          :xyz, "must be Numeric", lambda { |v| v.is_a? Numeric }
+  end
+
+
+  def mock_time
+    return @time if @time
+    @time = Time.now
+    Time.stubs(:now).returns(@time)
+    @time
+  end
+
+
+  def setup
+    @db = mock('couchbaseserver')
+    @db.stubs(:set)
+    @db.stubs(:delete)
+    @db.stubs(:replace)
+    @db.stubs(:get)
+    CouchPillow.db = @db
+  end
+
+
+  def test_create
+    d = CouchPillow::Document.new
+    d.save!
+  end
+
+
+  def test_timestamp
+    d = CouchPillow::Document.new({}, "1")
+    d.save!
+    assert d.created_at
+    assert d.updated_at
+  end
+
+
+  def test_type
+    d = CouchPillow::Document.new({}, "1")
+    assert_equal "default", d._type
+  end
+
+
+  def test_type_subclasses
+    d = TestDoc.new({}, "1")
+    assert_equal "test", d._type
+  end
+
+
+  def test_validate_presence
+    d = TestDoc.new
+    assert_raises CouchPillow::Document::ValidationError do
+      d.save!
+    end
+
+    d.xyz = 10
+    d.save!
+  end
+
+
+  def test_validate_custom
+    d = TestDoc.new
+    d.xyz = "string"
+    assert_raises CouchPillow::Document::ValidationError do
+      d.save!
+    end
+
+    d.xyz = {}
+    assert_raises CouchPillow::Document::ValidationError do
+      d.save!
+    end
+
+    d.xyz = 123
+    d.save!
+  end
+
+
+  def test_to_json
+    mock_time
+    d = CouchPillow::Document.new({}, "1")
+    assert_equal "{\"_id\":\"1\",\"created_at\":\"#{mock_time.to_s}\",\"_type\":\"default\"}", d.to_json
+  end
+
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: couchpillow
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Albert Tedja
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: CouchPillow is a light and comfortable Document wrapper for Couchbase
+  Server.
+email: nicho_tedja@yahoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- README.markdown
+- Rakefile
+- couchpillow.gemspec
+- lib/couchpillow.rb
+- lib/couchpillow/document.rb
+- lib/couchpillow/version.rb
+- test/document.rb
+homepage: https://github.com/atedja/pillow
+licenses:
+- BSD
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Document wrapper for Couchbase
+test_files: []