RubyGems - davber_couchrest_extended_document - Versions diffs - 1.0.0 - Mend

davber_couchrest_extended_document 1.0.0

Files changed (71) hide show

data/LICENSE +176 -0
data/README.md +250 -0
data/Rakefile +69 -0
data/THANKS.md +22 -0
data/examples/model/example.rb +144 -0
data/history.txt +165 -0
data/lib/couchrest/casted_array.rb +39 -0
data/lib/couchrest/casted_model.rb +53 -0
data/lib/couchrest/extended_document.rb +262 -0
data/lib/couchrest/mixins.rb +12 -0
data/lib/couchrest/mixins/attribute_protection.rb +74 -0
data/lib/couchrest/mixins/attributes.rb +75 -0
data/lib/couchrest/mixins/callbacks.rb +534 -0
data/lib/couchrest/mixins/class_proxy.rb +120 -0
data/lib/couchrest/mixins/collection.rb +260 -0
data/lib/couchrest/mixins/design_doc.rb +159 -0
data/lib/couchrest/mixins/document_queries.rb +82 -0
data/lib/couchrest/mixins/extended_attachments.rb +73 -0
data/lib/couchrest/mixins/properties.rb +130 -0
data/lib/couchrest/mixins/typecast.rb +174 -0
data/lib/couchrest/mixins/views.rb +148 -0
data/lib/couchrest/property.rb +96 -0
data/lib/couchrest/support/couchrest.rb +19 -0
data/lib/couchrest/support/rails.rb +42 -0
data/lib/couchrest/validation.rb +246 -0
data/lib/couchrest/validation/auto_validate.rb +156 -0
data/lib/couchrest/validation/contextual_validators.rb +78 -0
data/lib/couchrest/validation/validation_errors.rb +125 -0
data/lib/couchrest/validation/validators/absent_field_validator.rb +74 -0
data/lib/couchrest/validation/validators/confirmation_validator.rb +107 -0
data/lib/couchrest/validation/validators/format_validator.rb +122 -0
data/lib/couchrest/validation/validators/formats/email.rb +66 -0
data/lib/couchrest/validation/validators/formats/url.rb +43 -0
data/lib/couchrest/validation/validators/generic_validator.rb +120 -0
data/lib/couchrest/validation/validators/length_validator.rb +139 -0
data/lib/couchrest/validation/validators/method_validator.rb +89 -0
data/lib/couchrest/validation/validators/numeric_validator.rb +109 -0
data/lib/couchrest/validation/validators/required_field_validator.rb +114 -0
data/lib/couchrest_extended_document.rb +23 -0
data/spec/couchrest/attribute_protection_spec.rb +150 -0
data/spec/couchrest/casted_extended_doc_spec.rb +79 -0
data/spec/couchrest/casted_model_spec.rb +424 -0
data/spec/couchrest/extended_doc_attachment_spec.rb +148 -0
data/spec/couchrest/extended_doc_inherited_spec.rb +40 -0
data/spec/couchrest/extended_doc_spec.rb +869 -0
data/spec/couchrest/extended_doc_subclass_spec.rb +101 -0
data/spec/couchrest/extended_doc_view_spec.rb +529 -0
data/spec/couchrest/property_spec.rb +790 -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/more/article.rb +35 -0
data/spec/fixtures/more/card.rb +22 -0
data/spec/fixtures/more/cat.rb +22 -0
data/spec/fixtures/more/course.rb +25 -0
data/spec/fixtures/more/event.rb +8 -0
data/spec/fixtures/more/invoice.rb +17 -0
data/spec/fixtures/more/person.rb +9 -0
data/spec/fixtures/more/question.rb +7 -0
data/spec/fixtures/more/service.rb +12 -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 +49 -0
data/utils/remap.rb +27 -0
data/utils/subset.rb +30 -0
metadata +225 -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/more/article.rb ADDED Viewed

@@ -0,0 +1,35 @@
+class Article < CouchRest::ExtendedDocument
+  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_field}] == 'Article' && doc.tags) {
+          doc.tags.forEach(function(tag){
+            emit(tag, 1);
+          });
+        }
+      }",
+    :reduce =>
+      "function(keys, values, rereduce) {
+        return sum(values);
+      }"
+  property :date, :type => 'Date'
+  property :slug, :read_only => true
+  property :title
+  property :tags, :type => ['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,22 @@
+class Card < CouchRest::ExtendedDocument
+  # Include the validation module to get access to the validation methods
+  include CouchRest::Validation
+  # set the auto_validation before defining the properties
+  auto_validate!
+  # 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,22 @@
+class CatToy < Hash
+  include ::CouchRest::CastedModel
+  include ::CouchRest::Validation
+  property :name
+  validates_presence_of :name
+end
+class Cat < CouchRest::ExtendedDocument
+  include ::CouchRest::Validation
+  # 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::ExtendedDocument
+  use_database TEST_SERVER.default_database
+  property :title, :cast_as => 'String'
+  property :questions, :cast_as => ['Question']
+  property :professor, :cast_as => 'Person'
+  property :participants, :type => ['Object']
+  property :ends_at, :type => 'Time'
+  property :estimate, :type => 'Float'
+  property :hours, :type => 'Integer'
+  property :profit, :type => 'BigDecimal'
+  property :started_on, :type => 'Date'
+  property :updated_at, :type => 'DateTime'
+  property :active, :type => 'Boolean'
+  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::ExtendedDocument
+  use_database DB
+  property :subject
+  property :occurs_at, :cast_as => 'Time', :init_method => 'parse'
+  property :end_date,  :cast_as => 'Date', :init_method => 'parse'
+end

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

@@ -0,0 +1,17 @@
+class Invoice < CouchRest::ExtendedDocument
+  # Include the validation module to get access to the validation methods
+  include CouchRest::Validation
+  # 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::CastedModel
+  property :pet, :cast_as => 'Cat'
+  property :name, :type => ['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::CastedModel
+  property :q
+  property :a
+end

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

@@ -0,0 +1,12 @@
+class Service < CouchRest::ExtendedDocument
+  # Include the validation module to get access to the validation methods
+  include CouchRest::Validation
+  auto_validate!
+  # Set the default database to use
+  use_database DB
+  # Official Schema
+  property :name, :length => 4...20
+  property :price, :type => 'Integer'
+end

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

@@ -0,0 +1,22 @@
+class User < CouchRest::ExtendedDocument
+  # Set the default database to use
+  use_database DB
+  property :name, :accessible => true
+  property :admin                     # this will be automatically protected
+end
+class SpecialUser < CouchRest::ExtendedDocument
+  # 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,49 @@
+require "rubygems"
+require "spec" # Satisfies Autotest and anyone else not using the Rake tasks
+require File.join(File.dirname(__FILE__), '..','lib','couchrest_extended_document')
+# 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-test'
+  REPLICATIONDB = 'couchrest-test-replication'
+  TEST_SERVER    = CouchRest.new
+  TEST_SERVER.default_database = TESTDB
+  DB = TEST_SERVER.database(TESTDB)
+end
+class Basic < CouchRest::ExtendedDocument
+  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

data/utils/subset.rb ADDED Viewed

@@ -0,0 +1,30 @@
+require 'rubygems'
+require 'couchrest'
+# subset.rb replicates a percentage of a database to a fresh database.
+# use it to create a smaller dataset on which to prototype views.
+# specify the source database
+source = CouchRest.new("http://127.0.0.1:5984").database('source-db')
+# specify the target database
+target = CouchRest.new("http://127.0.0.1:5984").database('target-db')
+# pager efficiently yields all view rows
+pager = CouchRest::Pager.new(source)
+pager.all_docs(1000) do |rows|
+  docs = rows.collect do |r|
+    # the percentage of docs to clone
+    next if rand > 0.1
+    doc = source.get(r['id'])
+    doc.delete('_rev')
+    doc
+  end.compact
+  puts docs.length
+  next if docs.empty?
+  puts docs.first['_id']
+  target.bulk_save(docs)
+end

metadata ADDED Viewed

@@ -0,0 +1,225 @@
+--- !ruby/object:Gem::Specification
+name: davber_couchrest_extended_document
+version: !ruby/object:Gem::Version
+  hash: 23
+  prerelease: false
+  segments:
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors:
+- J. Chris Anderson
+- Matt Aimonetti
+- Marcos Tapajos
+- Will Leinweber
+- Sam Lown
+- David Bergman
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2010-08-14 00:00:00 -04:00
+default_executable:
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: couchrest
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        hash: 23
+        segments:
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        hash: 17
+        segments:
+        - 1
+        - 15
+        version: "1.15"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        hash: 3
+        segments:
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency
+  name: builder
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        hash: 15
+        segments:
+        - 2
+        - 1
+        - 2
+        version: 2.1.2
+  type: :runtime
+  version_requirements: *id004
+description: CouchRest::ExtendedDocument provides aditional features to the standard CouchRest::Document class such as properties, view designs, callbacks, typecasting and validations.
+email: davber@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+- THANKS.md
+files:
+- LICENSE
+- README.md
+- Rakefile
+- THANKS.md
+- examples/model/example.rb
+- history.txt
+- lib/couchrest/casted_array.rb
+- lib/couchrest/casted_model.rb
+- lib/couchrest/extended_document.rb
+- lib/couchrest/mixins.rb
+- lib/couchrest/mixins/attribute_protection.rb
+- lib/couchrest/mixins/attributes.rb
+- lib/couchrest/mixins/callbacks.rb
+- lib/couchrest/mixins/class_proxy.rb
+- lib/couchrest/mixins/collection.rb
+- lib/couchrest/mixins/design_doc.rb
+- lib/couchrest/mixins/document_queries.rb
+- lib/couchrest/mixins/extended_attachments.rb
+- lib/couchrest/mixins/properties.rb
+- lib/couchrest/mixins/typecast.rb
+- lib/couchrest/mixins/views.rb
+- lib/couchrest/property.rb
+- lib/couchrest/support/couchrest.rb
+- lib/couchrest/support/rails.rb
+- lib/couchrest/validation.rb
+- lib/couchrest/validation/auto_validate.rb
+- lib/couchrest/validation/contextual_validators.rb
+- lib/couchrest/validation/validation_errors.rb
+- lib/couchrest/validation/validators/absent_field_validator.rb
+- lib/couchrest/validation/validators/confirmation_validator.rb
+- lib/couchrest/validation/validators/format_validator.rb
+- lib/couchrest/validation/validators/formats/email.rb
+- lib/couchrest/validation/validators/formats/url.rb
+- lib/couchrest/validation/validators/generic_validator.rb
+- lib/couchrest/validation/validators/length_validator.rb
+- lib/couchrest/validation/validators/method_validator.rb
+- lib/couchrest/validation/validators/numeric_validator.rb
+- lib/couchrest/validation/validators/required_field_validator.rb
+- lib/couchrest_extended_document.rb
+- spec/couchrest/attribute_protection_spec.rb
+- spec/couchrest/casted_extended_doc_spec.rb
+- spec/couchrest/casted_model_spec.rb
+- spec/couchrest/extended_doc_attachment_spec.rb
+- spec/couchrest/extended_doc_inherited_spec.rb
+- spec/couchrest/extended_doc_spec.rb
+- spec/couchrest/extended_doc_subclass_spec.rb
+- spec/couchrest/extended_doc_view_spec.rb
+- spec/couchrest/property_spec.rb
+- spec/fixtures/attachments/README
+- spec/fixtures/attachments/couchdb.png
+- spec/fixtures/attachments/test.html
+- spec/fixtures/more/article.rb
+- spec/fixtures/more/card.rb
+- spec/fixtures/more/cat.rb
+- spec/fixtures/more/course.rb
+- spec/fixtures/more/event.rb
+- spec/fixtures/more/invoice.rb
+- spec/fixtures/more/person.rb
+- spec/fixtures/more/question.rb
+- spec/fixtures/more/service.rb
+- spec/fixtures/more/user.rb
+- spec/fixtures/views/lib.js
+- spec/fixtures/views/test_view/lib.js
+- spec/fixtures/views/test_view/only-map.js
+- spec/fixtures/views/test_view/test-map.js
+- spec/fixtures/views/test_view/test-reduce.js
+- spec/spec.opts
+- spec/spec_helper.rb
+- utils/remap.rb
+- utils/subset.rb
+has_rdoc: true
+homepage: http://github.com/couchrest/couchrest_extended_document
+licenses: []
+post_install_message:
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      hash: 3
+      segments:
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      hash: 3
+      segments:
+      - 0
+      version: "0"
+requirements: []
+rubyforge_project:
+rubygems_version: 1.3.7
+signing_key:
+specification_version: 3
+summary: Extend CouchRest Document class with useful features.
+test_files:
+- spec/couchrest/attribute_protection_spec.rb
+- spec/couchrest/casted_extended_doc_spec.rb
+- spec/couchrest/casted_model_spec.rb
+- spec/couchrest/extended_doc_attachment_spec.rb
+- spec/couchrest/extended_doc_inherited_spec.rb
+- spec/couchrest/extended_doc_spec.rb
+- spec/couchrest/extended_doc_subclass_spec.rb
+- spec/couchrest/extended_doc_view_spec.rb
+- spec/couchrest/property_spec.rb
+- spec/fixtures/more/article.rb
+- spec/fixtures/more/card.rb
+- spec/fixtures/more/cat.rb
+- spec/fixtures/more/course.rb
+- spec/fixtures/more/event.rb
+- spec/fixtures/more/invoice.rb
+- spec/fixtures/more/person.rb
+- spec/fixtures/more/question.rb
+- spec/fixtures/more/service.rb
+- spec/fixtures/more/user.rb
+- spec/spec_helper.rb
+- examples/model/example.rb