RubyGems - couchrest_model - Versions diffs - 1.0.0.beta7 - Mend

couchrest_model 1.0.0.beta7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (69) hide show

data/LICENSE +176 -0
data/README.md +320 -0
data/Rakefile +71 -0
data/THANKS.md +19 -0
data/examples/model/example.rb +144 -0
data/history.txt +180 -0
data/lib/couchrest/model.rb +10 -0
data/lib/couchrest/model/associations.rb +207 -0
data/lib/couchrest/model/attribute_protection.rb +74 -0
data/lib/couchrest/model/attributes.rb +75 -0
data/lib/couchrest/model/base.rb +111 -0
data/lib/couchrest/model/callbacks.rb +27 -0
data/lib/couchrest/model/casted_array.rb +39 -0
data/lib/couchrest/model/casted_model.rb +68 -0
data/lib/couchrest/model/class_proxy.rb +122 -0
data/lib/couchrest/model/collection.rb +260 -0
data/lib/couchrest/model/design_doc.rb +126 -0
data/lib/couchrest/model/document_queries.rb +82 -0
data/lib/couchrest/model/errors.rb +23 -0
data/lib/couchrest/model/extended_attachments.rb +73 -0
data/lib/couchrest/model/persistence.rb +141 -0
data/lib/couchrest/model/properties.rb +144 -0
data/lib/couchrest/model/property.rb +96 -0
data/lib/couchrest/model/support/couchrest.rb +19 -0
data/lib/couchrest/model/support/hash.rb +9 -0
data/lib/couchrest/model/typecast.rb +170 -0
data/lib/couchrest/model/validations.rb +68 -0
data/lib/couchrest/model/validations/casted_model.rb +14 -0
data/lib/couchrest/model/validations/locale/en.yml +5 -0
data/lib/couchrest/model/validations/uniqueness.rb +45 -0
data/lib/couchrest/model/views.rb +167 -0
data/lib/couchrest_model.rb +56 -0
data/spec/couchrest/assocations_spec.rb +213 -0
data/spec/couchrest/attachment_spec.rb +148 -0
data/spec/couchrest/attribute_protection_spec.rb +153 -0
data/spec/couchrest/base_spec.rb +463 -0
data/spec/couchrest/casted_model_spec.rb +424 -0
data/spec/couchrest/casted_spec.rb +75 -0
data/spec/couchrest/class_proxy_spec.rb +132 -0
data/spec/couchrest/inherited_spec.rb +40 -0
data/spec/couchrest/persistence_spec.rb +409 -0
data/spec/couchrest/property_spec.rb +804 -0
data/spec/couchrest/subclass_spec.rb +99 -0
data/spec/couchrest/validations.rb +73 -0
data/spec/couchrest/view_spec.rb +463 -0
data/spec/fixtures/attachments/README +3 -0
data/spec/fixtures/attachments/couchdb.png +0 -0
data/spec/fixtures/attachments/test.html +11 -0
data/spec/fixtures/base.rb +139 -0
data/spec/fixtures/more/article.rb +35 -0
data/spec/fixtures/more/card.rb +17 -0
data/spec/fixtures/more/cat.rb +19 -0
data/spec/fixtures/more/course.rb +25 -0
data/spec/fixtures/more/event.rb +8 -0
data/spec/fixtures/more/invoice.rb +14 -0
data/spec/fixtures/more/person.rb +9 -0
data/spec/fixtures/more/question.rb +7 -0
data/spec/fixtures/more/service.rb +10 -0
data/spec/fixtures/more/user.rb +22 -0
data/spec/fixtures/views/lib.js +3 -0
data/spec/fixtures/views/test_view/lib.js +3 -0
data/spec/fixtures/views/test_view/only-map.js +4 -0
data/spec/fixtures/views/test_view/test-map.js +3 -0
data/spec/fixtures/views/test_view/test-reduce.js +3 -0
data/spec/spec.opts +5 -0
data/spec/spec_helper.rb +48 -0
data/utils/remap.rb +27 -0
data/utils/subset.rb +30 -0
metadata +232 -0

data/spec/fixtures/attachments/README ADDED Viewed

@@ -0,0 +1,3 @@
+This is an example README file.
+More of the README, whee.

data/spec/fixtures/attachments/couchdb.png ADDED Viewed

Binary file

data/spec/fixtures/attachments/test.html ADDED Viewed

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Test</title>
+  </head>
+  <body>
+    <p>
+      Test
+    </p>
+  </body>
+</html>

data/spec/fixtures/base.rb ADDED Viewed

@@ -0,0 +1,139 @@
+class WithDefaultValues < CouchRest::Model::Base
+  use_database TEST_SERVER.default_database
+  property :preset, Object, :default => {:right => 10, :top_align => false}
+  property :set_by_proc, Time, :default => Proc.new{Time.now}
+  property :tags, [String], :default => []
+  property :read_only_with_default, :default => 'generic', :read_only => true
+  property :default_false, TrueClass, :default => false
+  property :name
+  timestamps!
+end
+class WithSimplePropertyType < CouchRest::Model::Base
+  use_database TEST_SERVER.default_database
+  property :name, String
+  property :preset, String, :default => 'none'
+  property :tags, [String]
+  timestamps!
+end
+class WithCallBacks < CouchRest::Model::Base
+  use_database TEST_SERVER.default_database
+  property :name
+  property :run_before_validate
+  property :run_after_validate
+  property :run_before_save
+  property :run_after_save
+  property :run_before_create
+  property :run_after_create
+  property :run_before_update
+  property :run_after_update
+  before_validate do |object|
+    object.run_before_validate = true
+  end
+  after_validate do |object|
+    object.run_after_validate = true
+  end
+  before_save do |object|
+    object.run_before_save = true
+  end
+  after_save do |object|
+    object.run_after_save = true
+  end
+  before_create do |object|
+    object.run_before_create = true
+  end
+  after_create do |object|
+    object.run_after_create = true
+  end
+  before_update do |object|
+    object.run_before_update = true
+  end
+  after_update do |object|
+    object.run_after_update = true
+  end
+  property :run_one
+  property :run_two
+  property :run_three
+  before_save :run_one_method, :run_two_method do |object|
+    object.run_three = true
+  end
+  def run_one_method
+    self.run_one = true
+  end
+  def run_two_method
+    self.run_two = true
+  end
+  attr_accessor :run_it
+  property :conditional_one
+  property :conditional_two
+  before_save :conditional_one_method, :conditional_two_method, :if => proc { self.run_it }
+  def conditional_one_method
+    self.conditional_one = true
+  end
+  def conditional_two_method
+    self.conditional_two = true
+  end
+end
+class WithTemplateAndUniqueID < CouchRest::Model::Base
+  use_database TEST_SERVER.default_database
+  unique_id do |model|
+    model['important-field']
+  end
+  property :preset, :default => 'value'
+  property :has_no_default
+end
+class WithGetterAndSetterMethods < CouchRest::Model::Base
+  use_database TEST_SERVER.default_database
+  property :other_arg
+  def arg
+    other_arg
+  end
+  def arg=(value)
+    self.other_arg = "foo-#{value}"
+  end
+end
+class WithAfterInitializeMethod < CouchRest::Model::Base
+  use_database TEST_SERVER.default_database
+  property :some_value
+  def after_initialize
+    self.some_value ||= "value"
+  end
+end
+class WithUniqueValidation < CouchRest::Model::Base
+  use_database DB
+  property :title
+  validates_uniqueness_of :title
+end
+class WithUniqueValidationProxy < CouchRest::Model::Base
+  use_database DB
+  property :title
+  validates_uniqueness_of :title, :proxy => 'proxy'
+end
+class WithUniqueValidationView < CouchRest::Model::Base
+  use_database DB
+  attr_accessor :code
+  unique_id :code
+  def code
+    self["_id"] ||= @code
+  end
+  property :title
+  validates_uniqueness_of :code, :view => 'all'
+end

data/spec/fixtures/more/article.rb ADDED Viewed

@@ -0,0 +1,35 @@
+class Article < CouchRest::Model::Base
+  use_database DB
+  unique_id :slug
+  provides_collection :article_details, 'Article', 'by_date', :descending => true, :include_docs => true
+  view_by :date, :descending => true
+  view_by :user_id, :date
+  view_by :tags,
+    :map =>
+      "function(doc) {
+        if (doc['couchrest-type'] == 'Article' && doc.tags) {
+          doc.tags.forEach(function(tag){
+            emit(tag, 1);
+          });
+        }
+      }",
+    :reduce =>
+      "function(keys, values, rereduce) {
+        return sum(values);
+      }"
+  property :date, Date
+  property :slug, :read_only => true
+  property :title
+  property :tags, [String]
+  timestamps!
+  before_save :generate_slug_from_title
+  def generate_slug_from_title
+    self['slug'] = title.downcase.gsub(/[^a-z0-9]/,'-').squeeze('-').gsub(/^\-|\-$/,'') if new?
+  end
+end

data/spec/fixtures/more/card.rb ADDED Viewed

@@ -0,0 +1,17 @@
+class Card < CouchRest::Model::Base
+  # Set the default database to use
+  use_database DB
+  # Official Schema
+  property :first_name
+  property :last_name,        :alias     => :family_name
+  property :read_only_value,  :read_only => true
+  property :cast_alias,       Person,  :alias  => :calias
+  timestamps!
+  # Validation
+  validates_presence_of :first_name
+end

data/spec/fixtures/more/cat.rb ADDED Viewed

@@ -0,0 +1,19 @@
+class CatToy < Hash
+  include ::CouchRest::Model::CastedModel
+  property :name
+  validates_presence_of :name
+end
+class Cat < CouchRest::Model::Base
+  # Set the default database to use
+  use_database DB
+  property :name, :accessible => true
+  property :toys, [CatToy], :default => [], :accessible => true
+  property :favorite_toy, CatToy, :accessible => true
+  property :number
+end

data/spec/fixtures/more/course.rb ADDED Viewed

@@ -0,0 +1,25 @@
+require File.join(FIXTURE_PATH, 'more', 'question')
+require File.join(FIXTURE_PATH, 'more', 'person')
+class Course < CouchRest::Model::Base
+  use_database TEST_SERVER.default_database
+  property :title, String
+  property :questions, [Question]
+  property :professor, Person
+  property :participants, [Object]
+  property :ends_at, Time
+  property :estimate, Float
+  property :hours, Integer
+  property :profit, BigDecimal
+  property :started_on, :type => Date
+  property :updated_at, :type => DateTime
+  property :active, :type => TrueClass
+  property :very_active, :type => TrueClass
+  property :klass, :type => Class
+  view_by :title
+  view_by :title, :active
+  view_by :dept, :ducktype => true
+end

data/spec/fixtures/more/event.rb ADDED Viewed

@@ -0,0 +1,8 @@
+class Event < CouchRest::Model::Base
+  use_database DB
+  property :subject
+  property :occurs_at, Time, :init_method => 'parse'
+  property :end_date, Date, :init_method => 'parse'
+end

data/spec/fixtures/more/invoice.rb ADDED Viewed

@@ -0,0 +1,14 @@
+class Invoice < CouchRest::Model::Base
+  # Set the default database to use
+  use_database DB
+  # Official Schema
+  property :client_name
+  property :employee_name
+  property :location
+  # Validation
+  validates_presence_of :client_name, :employee_name
+  validates_presence_of :location, :message => "Hey stupid!, you forgot the location"
+end

data/spec/fixtures/more/person.rb ADDED Viewed

@@ -0,0 +1,9 @@
+class Person < Hash
+  include ::CouchRest::Model::CastedModel
+  property :pet, Cat
+  property :name, [String]
+  def last_name
+    name.last
+  end
+end

data/spec/fixtures/more/question.rb ADDED Viewed

@@ -0,0 +1,7 @@
+class Question < Hash
+  include ::CouchRest::Model::CastedModel
+  property :q
+  property :a
+end

data/spec/fixtures/more/service.rb ADDED Viewed

@@ -0,0 +1,10 @@
+class Service < CouchRest::Model::Base
+  # Set the default database to use
+  use_database DB
+  # Official Schema
+  property :name
+  property :price, Integer
+  validates_length_of :name, :minimum => 4, :maximum => 20
+end

data/spec/fixtures/more/user.rb ADDED Viewed

@@ -0,0 +1,22 @@
+class User < CouchRest::Model::Base
+  # Set the default database to use
+  use_database DB
+  property :name, :accessible => true
+  property :admin                     # this will be automatically protected
+end
+class SpecialUser < CouchRest::Model::Base
+  # Set the default database to use
+  use_database DB
+  property :name                      # this will not be protected
+  property :admin, :protected => true
+end
+# There are two modes of protection
+#  1) Declare accessible poperties, assume all the rest are protected
+#    property :name, :accessible => true
+#    property :admin                     # this will be automatically protected
+#
+#  2) Declare protected properties, assume all the rest are accessible
+#    property :name                      # this will not be protected
+#    property :admin, :protected => true

data/spec/fixtures/views/lib.js ADDED Viewed

@@ -0,0 +1,3 @@
+function globalLib() {
+  return "fixture";
+};

data/spec/fixtures/views/test_view/lib.js ADDED Viewed

@@ -0,0 +1,3 @@
+function justThisView() {
+  return "fixture";
+};

data/spec/fixtures/views/test_view/only-map.js ADDED Viewed

@@ -0,0 +1,4 @@
+function(doc) {
+  //include-lib
+  emit(null, null);
+};

data/spec/fixtures/views/test_view/test-map.js ADDED Viewed

@@ -0,0 +1,3 @@
+function(doc) {
+  emit(null, null);
+};

data/spec/fixtures/views/test_view/test-reduce.js ADDED Viewed

@@ -0,0 +1,3 @@
+function(ks,vs,co) {
+  return vs.length;
+};

data/spec/spec.opts ADDED Viewed

@@ -0,0 +1,5 @@
+--colour
+--format
+progress
+--loadby
+mtime

data/spec/spec_helper.rb ADDED Viewed

@@ -0,0 +1,48 @@
+require "rubygems"
+require "spec" # Satisfies Autotest and anyone else not using the Rake tasks
+require File.join(File.dirname(__FILE__), '..','lib','couchrest_model')
+# check the following file to see how to use the spec'd features.
+unless defined?(FIXTURE_PATH)
+  FIXTURE_PATH = File.join(File.dirname(__FILE__), '/fixtures')
+  SCRATCH_PATH = File.join(File.dirname(__FILE__), '/tmp')
+  COUCHHOST = "http://127.0.0.1:5984"
+  TESTDB    = 'couchrest-model-test'
+  TEST_SERVER    = CouchRest.new
+  TEST_SERVER.default_database = TESTDB
+  DB = TEST_SERVER.database(TESTDB)
+end
+class Basic < CouchRest::Model::Base
+  use_database TEST_SERVER.default_database
+end
+def reset_test_db!
+  DB.recreate! rescue nil
+  DB
+end
+Spec::Runner.configure do |config|
+  config.before(:all) { reset_test_db! }
+  config.after(:all) do
+    cr = TEST_SERVER
+    test_dbs = cr.databases.select { |db| db =~ /^#{TESTDB}/ }
+    test_dbs.each do |db|
+      cr.database(db).delete! rescue nil
+    end
+  end
+end
+def couchdb_lucene_available?
+  lucene_path = "http://localhost:5985/"
+  url = URI.parse(lucene_path)
+  req = Net::HTTP::Get.new(url.path)
+  res = Net::HTTP.new(url.host, url.port).start { |http| http.request(req) }
+  true
+ rescue Exception => e
+  false
+end

data/utils/remap.rb ADDED Viewed

@@ -0,0 +1,27 @@
+require 'rubygems'
+require 'couchrest'
+# set the source db and map view
+source = CouchRest.new("http://127.0.0.1:5984").database('source-db')
+source_view = 'mydesign/view-map'
+# set the target db
+target = CouchRest.new("http://127.0.0.1:5984").database('target-db')
+pager = CouchRest::Pager.new(source)
+# pager will yield once per uniq key in the source view
+pager.key_reduce(source_view, 10000) do |key, values|
+  # create a doc from the key and the values
+  example_doc = {
+    :key => key,
+    :values => values.uniq
+  }
+  target.save(example_doc)
+  # keep us up to date with progress
+  puts k if (rand > 0.9)
+end