relaxo-model 0.3.9 → 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 111d2212cc180cfad8ca53997c1a03722559694b
+  data.tar.gz: 5b37cb150db297bd854dca03c63101e9421f01a5
+SHA512:
+  metadata.gz: 41532378165e1cbe27bd01ad15ca6274ab2c91c0d84f359af78cc0f83996d165692fc47cd228443f69e90a8d53d986d6d545f3b3588346c3fb618f71b17ebf2a
+  data.tar.gz: 9711fc150ce1e2b82f72b6249d193c84b73485ac175927c560697d3a768ff8785763dabdba2a690a9ab6554deeb888a1bbb383c04c17b40c5d34c45672a53382

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in relaxo-model.gemspec
+gemspec

data/README.md

@@ -7,6 +7,8 @@ Relaxo Model
 
 Relaxo Model provides a framework for business logic on top of Relaxo/CouchDB. While it supports some traditional ORM style patterns, it is primary focus is to model business processes and logic.
 
+* This framework is pretty experimental right now and subject to change. Incompatible changes will be marked by the version number `x.y.z`, where changes in `x` indiciate fundamental API changes and changes in `y` indicate minor changes or additions that shouldn't cause breakage. *
+
 Basic Usage
 -----------
 
@@ -15,9 +17,9 @@ Here is a simple example of a traditional ORM style model:
 	require 'relaxo'
 	require 'relaxo/model'
 
-	$database = Relaxo.connect("http://localhost:5984/test")
+	database = Relaxo.connect("http://localhost:5984/test")
 
-	$trees = [
+	trees = [
 		{:name => 'Hinoki', :planted => Date.parse("1948/4/2")},
 		{:name => 'Rimu', :planted => Date.parse("1962/8/7")}
 	]
@@ -32,13 +34,13 @@ Here is a simple example of a traditional ORM style model:
 		view :all, 'catalog/tree', Tree
 	end
 
-	$trees.each do |doc|
-		tree = Tree.create($database, doc)
+	trees.each do |doc|
+		tree = Tree.create(database, doc)
 	
 		tree.save
 	end
 
-	Tree.all($database).each do |tree|
+	Tree.all(database).each do |tree|
 		puts "A #{tree.name} was planted on #{tree.planted.to_s}."
 
 		# Expected output:

data/lib/relaxo/model/document.rb

@@ -40,12 +40,12 @@ module Relaxo
 			TYPE = 'type'
 			
 			def self.included(child)
-				# $stderr.puts "#{self} included -> #{child} extend ClassMethods"
 				child.send(:include, Component)
 				child.send(:extend, ClassMethods)
 			end
 			
 			module ClassMethods
+				# Create a new document with a particular specified type.
 				def create(database, properties = nil)
 					instance = self.new(database, {TYPE => @type})
 
@@ -60,6 +60,7 @@ module Relaxo
 					return instance
 				end
 
+				# Fetch a record or create a model object from a hash of attributes.
 				def fetch(database, id_or_attributes)
 					if Hash === id_or_attributes
 						instance = self.new(database, id_or_attributes)
@@ -98,8 +99,8 @@ module Relaxo
 			def after_save
 			end
 
-			# Reconnect this document with a new database session, typically used for updating an existing model within a session. Changes to the original object may be lost.
-			def attach(database)
+			# Duplicate the model object, and possibly change the database it is connected to. You will potentially have two objects referring to the same record.
+			def dup(database = @database)
 				clone = self.class.new(database, @attributes.dup)
 				
 				clone.after_fetch
@@ -107,6 +108,7 @@ module Relaxo
 				return clone
 			end
 
+			# Save the model object, raises `ValidationErrors` if there are validation errors.
 			def save
 				before_save
 

data/lib/relaxo/model/properties/attribute.rb

@@ -23,6 +23,7 @@ require 'date'
 module Relaxo
 	module Model
 		module Properties
+			# Handle conversions for standard datatypes.
 			class Attribute
 				@@attributes = {}
 

data/lib/relaxo/model/version.rb

@@ -20,12 +20,6 @@
 
 module Relaxo
 	module Model
-		module VERSION
-			MAJOR = 0
-			MINOR = 3
-			TINY  = 9
-
-			STRING = [MAJOR, MINOR, TINY].join('.')
-		end
+		VERSION = "0.4.0"
 	end
 end

data/rakefile.rb

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

data/relaxo-model.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'relaxo/model/version'
+
+Gem::Specification.new do |spec|
+	spec.name          = "relaxo-model"
+	spec.version       = Relaxo::Model::VERSION
+	spec.authors       = ["Samuel Williams"]
+	spec.email         = ["samuel.williams@oriontransfer.co.nz"]
+	spec.description   = <<-EOF
+		Relaxo Model provides a framework for business logic on top of
+		Relaxo/CouchDB. While it supports some traditional ORM style patterns, it is
+		primary focus is to model business processes and logic.
+	EOF
+	spec.summary       = "A model layer for CouchDB with minimal global state."
+	spec.homepage      = "http://www.codeotaku.com/projects/relaxo/model"
+	spec.license       = "MIT"
+
+	spec.files         = `git ls-files`.split($/)
+	spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+	spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+	spec.require_paths = ["lib"]
+
+	spec.add_development_dependency "bundler", "~> 1.3"
+	spec.add_development_dependency "rake"
+	
+	spec.add_dependency("relaxo", "~> 0.4.0")
+end

metadata

@@ -1,74 +1,104 @@
 --- !ruby/object:Gem::Specification
 name: relaxo-model
 version: !ruby/object:Gem::Version
-  version: 0.3.9
-  prerelease: 
+  version: 0.4.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-31 00:00:00.000000000 Z
+date: 2013-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: relaxo
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: 
-email: samuel.williams@oriontransfer.co.nz
+- !ruby/object:Gem::Dependency
+  name: relaxo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+description: "\t\tRelaxo Model provides a framework for business logic on top of\n\t\tRelaxo/CouchDB.
+  While it supports some traditional ORM style patterns, it is\n\t\tprimary focus
+  is to model business processes and logic.\n"
+email:
+- samuel.williams@oriontransfer.co.nz
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- Gemfile
+- README.md
+- lib/relaxo/model.rb
 - lib/relaxo/model/base.rb
 - lib/relaxo/model/component.rb
 - lib/relaxo/model/document.rb
+- lib/relaxo/model/properties.rb
 - lib/relaxo/model/properties/attribute.rb
 - lib/relaxo/model/properties/bcrypt.rb
 - lib/relaxo/model/properties/bigdecimal.rb
 - lib/relaxo/model/properties/composite.rb
 - lib/relaxo/model/properties/latinum.rb
-- lib/relaxo/model/properties.rb
 - lib/relaxo/model/recordset.rb
 - lib/relaxo/model/version.rb
-- lib/relaxo/model.rb
-- README.md
-homepage: http://www.oriontransfer.co.nz/gems/relaxo
-licenses: []
+- rakefile.rb
+- relaxo-model.gemspec
+homepage: http://www.codeotaku.com/projects/relaxo/model
+licenses:
+- MIT
+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: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.6
 signing_key: 
-specification_version: 3
-summary: Relaxo Model is a high level business logic framework for CouchDB/Relaxo.
+specification_version: 4
+summary: A model layer for CouchDB with minimal global state.
 test_files: []
-has_rdoc: