openlogic-couchrest_model 1.0.0

data/.gitignore

@@ -0,0 +1,11 @@
+.DS_Store
+html/*
+pkg
+*.swp
+.rvmrc*
+.bundle
+couchdb.std*
+*.*~
+Gemfile.lock
+spec.out
+*.gem

data/.rspec

@@ -0,0 +1,4 @@
+--colour
+--format
+progress
+mtime

data/Gemfile

@@ -0,0 +1,4 @@
+
+source :rubygems
+gemspec
+

data/LICENSE

@@ -0,0 +1,176 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

data/README.md

@@ -0,0 +1,137 @@
+# CouchRest Model: CouchDB, close to shiny metal with rounded edges
+
+CouchRest Models adds additional functionality to the standard CouchRest Document class such as
+setting properties, callbacks, typecasting, and validations.
+
+## Documentation
+
+Please visit the documentation project at [http://www.couchrest.info](http://www.couchrest.info). You're [contributions](https://github.com/couchrest/couchrest.github.com) to the documentation would be greatly appreciated!
+
+General API: [http://rdoc.info/projects/couchrest/couchrest_model](http://rdoc.info/projects/couchrest/couchrest_model)
+
+See the [update history](https://github.com/couchrest/couchrest_model/blob/master/history.md) for an up to date list of all the changes we've been working on recently.
+
+## Notes
+
+Originally called ExtendedDocument, the new Model structure uses ActiveModel, part of Rails 3, 
+for validations and callbacks.
+
+If your project is still running Rails 2.3, you'll have to continue using ExtendedDocument as 
+it is not possible to load ActiveModel into programs that do not use ActiveSupport 3.0.
+
+CouchRest Model is only properly tested on CouchDB version 1.0 or newer.
+
+*WARNING:* As of April 2011 and the release of version 1.1.0, the default model type key is 'type' instead of 'couchrest-type'. Simply updating your project will not work unless you migrate your data or set the configuration option in your initializers:
+
+    CouchRest::Model::Base.configure do |config|
+      config.model_type_key = 'couchrest-type'
+    end
+
+This is because CouchRest Model's are not couchrest specific and may be used in any other systems such as Javascript, the model type should reflect this. Also, we're all used to `type` being a reserved word in ActiveRecord.
+
+## Install
+
+### Gem
+
+    $ sudo gem install couchrest_model
+
+### Bundler
+
+If you're using bundler, define a line similar to the following in your project's Gemfile:
+
+    gem 'couchrest_model'
+
+### Configuration
+
+CouchRest Model is configured to work out the box with no configuration as long as your CouchDB instance is running on the default port (5984) on localhost. The default name of the database is either the name of your application as provided by the `Rails.application.class.to_s` call (with /application removed) or just 'couchrest' if none is available.
+
+The library will try to detect a configuration file at `config/couchdb.yml` from the Rails root or `Dir.pwd`. Here you can configuration your database connection in a Rails-like way:
+
+    development:
+      protocol: 'https'
+      host: sample.cloudant.com
+      port: 443
+      prefix: project
+      suffix: test
+      username: test
+      password: user
+
+Note that the name of the database is either just the prefix and suffix combined or the prefix plus any text you specifify using `use_database` method in your models with the suffix on the end.
+
+The example config above for example would use a database called "project_test". Heres an example using the `use_database` call:
+
+    class Project < CouchRest::Model::Base
+      use_database 'sample'
+    end
+
+    # The database object would be provided as:
+    Project.database     #=> "https://test:user@sample.cloudant.com:443/project_sample_test"
+
+
+## Generators
+
+### Configuration
+
+    $ rails generate couchrest_model:config
+
+### Model
+
+    $ rails generate model person --orm=couchrest_model
+
+## General Usage 
+
+    require 'couchrest_model'
+
+    class Cat < CouchRest::Model::Base
+
+      property :name,      String
+      property :lives,     Integer, :default => 9
+
+      property :nicknames, [String]
+
+      timestamps!
+
+      view_by :name
+
+    end
+
+    @cat = Cat.new(:name => 'Felix', :nicknames => ['so cute', 'sweet kitty'])
+
+    @cat.new?   # true
+    @cat.save
+
+    @cat['name']   # "Felix"
+
+    @cat.nicknames << 'getoffdamntable'
+
+    @cat = Cat.new
+    @cat.update_attributes(:name => 'Felix', :random_text => 'feline')
+    @cat.new? # false
+    @cat.random_text  # Raises error!
+
+## Development
+
+### Preparations
+
+CouchRest Model now comes with a Gemfile to help with development. If you want to make changes to the code, download a copy then run:
+
+    bundle install
+
+That should set everything up for `rake spec` to be run correctly. Update the couchrest_model.gemspec if your alterations
+use different gems.
+
+### Testing
+
+The most complete documentation is the spec/ directory. To validate your CouchRest install, from the project root directory run `bundle install` to ensure all the development dependencies are available and then `rspec spec` or `bundle exec rspec spec`.
+
+We will not accept pull requests to the project without sufficient tests.
+
+## Contact
+
+Please post bugs, suggestions and patches to the bug tracker at [http://github.com/couchrest/couchrest_model/issues](http://github.com/couchrest/couchrest_model/issues).
+
+Follow us on Twitter: [http://twitter.com/couchrest](http://twitter.com/couchrest)
+
+Also, check [http://twitter.com/#search?q=%23couchrest](http://twitter.com/#search?q=%23couchrest)
+
+

data/Rakefile

@@ -0,0 +1,38 @@
+require 'rubygems'
+require 'bundler'
+require 'rspec/core/rake_task'
+require "rake/rdoctask"
+
+Bundler::GemHelper.install_tasks
+
+desc "Run all specs"
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.rspec_opts = ["--color"]
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+
+desc "Print specdocs"
+RSpec::Core::RakeTask.new(:doc) do |spec|
+  spec.rspec_opts = ["--format", "specdoc"]
+  spec.pattern = 'spec/*_spec.rb'
+end
+
+desc "Generate the rdoc"
+Rake::RDocTask.new do |rdoc|
+  files = ["README.rdoc", "LICENSE", "lib/**/*.rb"]
+  rdoc.rdoc_files.add(files)
+  rdoc.main = "README.rdoc"
+  rdoc.title = "CouchRest: Ruby CouchDB, close to the metal"
+end
+
+desc "Run the rspec"
+task :default => :spec
+
+module Rake
+  def self.remove_task(task_name)
+    Rake.application.instance_variable_get('@tasks').delete(task_name.to_s)
+  end
+end
+
+Rake.remove_task("github:release")
+Rake.remove_task("release")

data/THANKS.md

@@ -0,0 +1,21 @@
+CouchRest THANKS
+=====================
+
+CouchRest was originally developed by J. Chris Anderson <jchris@grabb.it>
+and a number of other contributors. Many people further contributed to 
+CouchRest by reporting problems, suggesting various improvements or submitting
+changes. A list of these people is included below.
+
+ * [Matt Aimonetti](http://merbist.com/about/)
+ * [Greg Borenstein](http://ideasfordozens.com)
+ * [Geoffrey Grosenbach](http://nubyonrails.com/)
+ * [Jonathan S. Katz](http://github.com/jkatz)
+ * [Matt Lyon](http://mattly.tumblr.com/)
+ * Simon Rozet (simon /at/ rozet /dot/ name)
+ * [Marcos Tapajós](http://tapajos.me)
+ * [Sam Lown](http://github.com/samlown)
+ * [Will Leinweber](http://github.com/will)
+ 
+Patches are welcome. The primary source for this software project is [on Github](http://github.com/couchrest/couchrest)
+
+A lot of people have active forks - thank you all - even the patches I don't end up using are helpful.

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/benchmarks/dirty.rb

@@ -0,0 +1,118 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'benchmark'
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'couchrest_model'
+
+class BenchmarkCasted < Hash
+  include CouchRest::Model::CastedModel
+  
+  property :name
+end
+
+class BenchmarkModel < CouchRest::Model::Base
+  use_database CouchRest.database!(ENV['BENCHMARK_DB'] || "http://localhost:5984/test")
+
+  property :string, String
+  property :number, Integer
+  property :casted, BenchmarkCasted
+  property :casted_list, [BenchmarkCasted]
+end
+
+# set dirty configuration, return previous configuration setting
+def set_dirty(value)
+  orig = nil
+  CouchRest::Model::Base.configure do |config|
+    orig = config.use_dirty
+    config.use_dirty = value
+  end
+  BenchmarkModel.instance_eval do
+    self.use_dirty = value
+  end
+  orig
+end
+
+def supports_dirty?
+  CouchRest::Model::Base.respond_to?(:use_dirty)
+end
+
+def run_benchmark
+  n = 50000     # property operation count
+  db_n = 1000   # database operation count
+  b = BenchmarkModel.new
+
+  Benchmark.bm(30) do |x|
+
+    # property assigning
+
+    x.report("assign string:") do
+      n.times { b.string = "test" }
+    end
+
+    next if ENV["BENCHMARK_STRING"]
+
+    x.report("assign integer:") do
+      n.times { b.number = 1 }
+    end
+
+    x.report("assign casted hash:") do
+      n.times { b.casted = { 'name' => 'test' } }
+    end
+
+    x.report("assign casted hash list:") do
+      n.times { b.casted_list = [{ 'name' => 'test' }] }
+    end
+
+    # property reading
+
+    x.report("read string") do
+      n.times { b.string }
+    end
+
+    x.report("read integer") do
+      n.times { b.number }
+    end
+
+    x.report("read casted hash") do
+      n.times { b.casted }
+    end
+
+    x.report("read casted hash list") do
+      n.times { b.casted_list }
+    end
+
+    if ENV['BENCHMARK_DB']
+      # db writing
+      x.report("write changed record to db") do
+        db_n.times { |i| b.string = "test#{i}"; b.save }  
+      end
+
+      x.report("write unchanged record to db") do
+        db_n.times { b.save }  
+      end
+
+      # db reading
+      x.report("read record from db") do
+        db_n.times { BenchmarkModel.find(b.id) }
+      end
+
+    end
+
+  end
+end
+
+begin
+  if supports_dirty?
+    if !ENV['BENCHMARK_DIRTY_OFF']
+      set_dirty(true)
+      puts "with use_dirty true"
+      run_benchmark
+    end
+    set_dirty(false)
+    puts "\nwith use_dirty false"
+  end
+
+  run_benchmark
+end