jchris-couchrest 0.2.2 → 0.7.99

Sign up to get free protection for your applications and to get access to all the features.
Files changed (97) hide show
  1. data/README +39 -0
  2. data/Rakefile +3 -54
  3. data/lib/couchrest.rb +39 -161
  4. data/lib/database.rb +83 -0
  5. data/script/couchdir +58 -0
  6. data/script/couchview +158 -0
  7. data/spec/couchrest_spec.rb +86 -0
  8. data/spec/database_spec.rb +407 -0
  9. metadata +15 -138
  10. data/LICENSE +0 -176
  11. data/README.md +0 -93
  12. data/THANKS.md +0 -18
  13. data/examples/model/example.rb +0 -144
  14. data/examples/word_count/markov +0 -38
  15. data/examples/word_count/views/books/chunked-map.js +0 -3
  16. data/examples/word_count/views/books/united-map.js +0 -1
  17. data/examples/word_count/views/markov/chain-map.js +0 -6
  18. data/examples/word_count/views/markov/chain-reduce.js +0 -7
  19. data/examples/word_count/views/word_count/count-map.js +0 -6
  20. data/examples/word_count/views/word_count/count-reduce.js +0 -3
  21. data/examples/word_count/word_count.rb +0 -46
  22. data/examples/word_count/word_count_query.rb +0 -40
  23. data/examples/word_count/word_count_views.rb +0 -26
  24. data/lib/couchrest/commands/generate.rb +0 -71
  25. data/lib/couchrest/commands/push.rb +0 -103
  26. data/lib/couchrest/core/database.rb +0 -318
  27. data/lib/couchrest/core/design.rb +0 -89
  28. data/lib/couchrest/core/document.rb +0 -96
  29. data/lib/couchrest/core/response.rb +0 -16
  30. data/lib/couchrest/core/server.rb +0 -88
  31. data/lib/couchrest/core/view.rb +0 -4
  32. data/lib/couchrest/helper/pager.rb +0 -103
  33. data/lib/couchrest/helper/streamer.rb +0 -44
  34. data/lib/couchrest/helper/upgrade.rb +0 -51
  35. data/lib/couchrest/mixins.rb +0 -4
  36. data/lib/couchrest/mixins/attachments.rb +0 -31
  37. data/lib/couchrest/mixins/callbacks.rb +0 -483
  38. data/lib/couchrest/mixins/design_doc.rb +0 -64
  39. data/lib/couchrest/mixins/document_queries.rb +0 -48
  40. data/lib/couchrest/mixins/extended_attachments.rb +0 -68
  41. data/lib/couchrest/mixins/extended_document_mixins.rb +0 -6
  42. data/lib/couchrest/mixins/properties.rb +0 -125
  43. data/lib/couchrest/mixins/validation.rb +0 -234
  44. data/lib/couchrest/mixins/views.rb +0 -168
  45. data/lib/couchrest/monkeypatches.rb +0 -119
  46. data/lib/couchrest/more/casted_model.rb +0 -28
  47. data/lib/couchrest/more/extended_document.rb +0 -217
  48. data/lib/couchrest/more/property.rb +0 -40
  49. data/lib/couchrest/support/blank.rb +0 -42
  50. data/lib/couchrest/support/class.rb +0 -191
  51. data/lib/couchrest/validation/auto_validate.rb +0 -163
  52. data/lib/couchrest/validation/contextual_validators.rb +0 -78
  53. data/lib/couchrest/validation/validation_errors.rb +0 -118
  54. data/lib/couchrest/validation/validators/absent_field_validator.rb +0 -74
  55. data/lib/couchrest/validation/validators/confirmation_validator.rb +0 -99
  56. data/lib/couchrest/validation/validators/format_validator.rb +0 -117
  57. data/lib/couchrest/validation/validators/formats/email.rb +0 -66
  58. data/lib/couchrest/validation/validators/formats/url.rb +0 -43
  59. data/lib/couchrest/validation/validators/generic_validator.rb +0 -120
  60. data/lib/couchrest/validation/validators/length_validator.rb +0 -134
  61. data/lib/couchrest/validation/validators/method_validator.rb +0 -89
  62. data/lib/couchrest/validation/validators/numeric_validator.rb +0 -104
  63. data/lib/couchrest/validation/validators/required_field_validator.rb +0 -109
  64. data/spec/couchrest/core/couchrest_spec.rb +0 -201
  65. data/spec/couchrest/core/database_spec.rb +0 -745
  66. data/spec/couchrest/core/design_spec.rb +0 -131
  67. data/spec/couchrest/core/document_spec.rb +0 -311
  68. data/spec/couchrest/core/server_spec.rb +0 -35
  69. data/spec/couchrest/helpers/pager_spec.rb +0 -122
  70. data/spec/couchrest/helpers/streamer_spec.rb +0 -23
  71. data/spec/couchrest/more/casted_extended_doc_spec.rb +0 -40
  72. data/spec/couchrest/more/casted_model_spec.rb +0 -98
  73. data/spec/couchrest/more/extended_doc_attachment_spec.rb +0 -130
  74. data/spec/couchrest/more/extended_doc_spec.rb +0 -509
  75. data/spec/couchrest/more/extended_doc_view_spec.rb +0 -207
  76. data/spec/couchrest/more/property_spec.rb +0 -130
  77. data/spec/couchrest/support/class_spec.rb +0 -59
  78. data/spec/fixtures/attachments/README +0 -3
  79. data/spec/fixtures/attachments/couchdb.png +0 -0
  80. data/spec/fixtures/attachments/test.html +0 -11
  81. data/spec/fixtures/more/article.rb +0 -34
  82. data/spec/fixtures/more/card.rb +0 -20
  83. data/spec/fixtures/more/course.rb +0 -14
  84. data/spec/fixtures/more/event.rb +0 -6
  85. data/spec/fixtures/more/invoice.rb +0 -17
  86. data/spec/fixtures/more/person.rb +0 -8
  87. data/spec/fixtures/more/question.rb +0 -6
  88. data/spec/fixtures/more/service.rb +0 -12
  89. data/spec/fixtures/views/lib.js +0 -3
  90. data/spec/fixtures/views/test_view/lib.js +0 -3
  91. data/spec/fixtures/views/test_view/only-map.js +0 -4
  92. data/spec/fixtures/views/test_view/test-map.js +0 -3
  93. data/spec/fixtures/views/test_view/test-reduce.js +0 -3
  94. data/spec/spec.opts +0 -6
  95. data/spec/spec_helper.rb +0 -26
  96. data/utils/remap.rb +0 -27
  97. data/utils/subset.rb +0 -30
@@ -1,168 +0,0 @@
1
- module CouchRest
2
- module Mixins
3
- module Views
4
-
5
- def self.included(base)
6
- base.extend(ClassMethods)
7
- base.send(:class_inheritable_accessor, :design_doc)
8
- base.send(:class_inheritable_accessor, :design_doc_slug_cache)
9
- base.send(:class_inheritable_accessor, :design_doc_fresh)
10
- end
11
-
12
- module ClassMethods
13
-
14
- # Define a CouchDB view. The name of the view will be the concatenation
15
- # of <tt>by</tt> and the keys joined by <tt>_and_</tt>
16
- #
17
- # ==== Example views:
18
- #
19
- # class Post
20
- # # view with default options
21
- # # query with Post.by_date
22
- # view_by :date, :descending => true
23
- #
24
- # # view with compound sort-keys
25
- # # query with Post.by_user_id_and_date
26
- # view_by :user_id, :date
27
- #
28
- # # view with custom map/reduce functions
29
- # # query with Post.by_tags :reduce => true
30
- # view_by :tags,
31
- # :map =>
32
- # "function(doc) {
33
- # if (doc['couchrest-type'] == 'Post' && doc.tags) {
34
- # doc.tags.forEach(function(tag){
35
- # emit(doc.tag, 1);
36
- # });
37
- # }
38
- # }",
39
- # :reduce =>
40
- # "function(keys, values, rereduce) {
41
- # return sum(values);
42
- # }"
43
- # end
44
- #
45
- # <tt>view_by :date</tt> will create a view defined by this Javascript
46
- # function:
47
- #
48
- # function(doc) {
49
- # if (doc['couchrest-type'] == 'Post' && doc.date) {
50
- # emit(doc.date, null);
51
- # }
52
- # }
53
- #
54
- # It can be queried by calling <tt>Post.by_date</tt> which accepts all
55
- # valid options for CouchRest::Database#view. In addition, calling with
56
- # the <tt>:raw => true</tt> option will return the view rows
57
- # themselves. By default <tt>Post.by_date</tt> will return the
58
- # documents included in the generated view.
59
- #
60
- # CouchRest::Database#view options can be applied at view definition
61
- # time as defaults, and they will be curried and used at view query
62
- # time. Or they can be overridden at query time.
63
- #
64
- # Custom views can be queried with <tt>:reduce => true</tt> to return
65
- # reduce results. The default for custom views is to query with
66
- # <tt>:reduce => false</tt>.
67
- #
68
- # Views are generated (on a per-model basis) lazily on first-access.
69
- # This means that if you are deploying changes to a view, the views for
70
- # that model won't be available until generation is complete. This can
71
- # take some time with large databases. Strategies are in the works.
72
- #
73
- # To understand the capabilities of this view system more compeletly,
74
- # it is recommended that you read the RSpec file at
75
- # <tt>spec/core/model_spec.rb</tt>.
76
-
77
- def view_by(*keys)
78
- self.design_doc ||= Design.new(default_design_doc)
79
- opts = keys.pop if keys.last.is_a?(Hash)
80
- opts ||= {}
81
- ducktype = opts.delete(:ducktype)
82
- unless ducktype || opts[:map]
83
- opts[:guards] ||= []
84
- opts[:guards].push "(doc['couchrest-type'] == '#{self.to_s}')"
85
- end
86
- keys.push opts
87
- self.design_doc.view_by(*keys)
88
- self.design_doc_fresh = false
89
- end
90
-
91
- # returns stored defaults if the there is a view named this in the design doc
92
- def has_view?(view)
93
- view = view.to_s
94
- design_doc && design_doc['views'] && design_doc['views'][view]
95
- end
96
-
97
- # Dispatches to any named view.
98
- def view(name, query={}, &block)
99
- unless design_doc_fresh
100
- refresh_design_doc
101
- end
102
- query[:raw] = true if query[:reduce]
103
- raw = query.delete(:raw)
104
- fetch_view_with_docs(name, query, raw, &block)
105
- end
106
-
107
- def all_design_doc_versions
108
- database.documents :startkey => "_design/#{self.to_s}-",
109
- :endkey => "_design/#{self.to_s}-\u9999"
110
- end
111
-
112
- # Deletes any non-current design docs that were created by this class.
113
- # Running this when you're deployed version of your application is steadily
114
- # and consistently using the latest code, is the way to clear out old design
115
- # docs. Running it to early could mean that live code has to regenerate
116
- # potentially large indexes.
117
- def cleanup_design_docs!
118
- ddocs = all_design_doc_versions
119
- ddocs["rows"].each do |row|
120
- if (row['id'] != design_doc_id)
121
- database.delete_doc({
122
- "_id" => row['id'],
123
- "_rev" => row['value']['rev']
124
- })
125
- end
126
- end
127
- end
128
-
129
- private
130
-
131
- def fetch_view_with_docs(name, opts, raw=false, &block)
132
- if raw || (opts.has_key?(:include_docs) && opts[:include_docs] == false)
133
- fetch_view(name, opts, &block)
134
- else
135
- begin
136
- view = fetch_view name, opts.merge({:include_docs => true}), &block
137
- view['rows'].collect{|r|new(r['doc'])} if view['rows']
138
- rescue
139
- # fallback for old versions of couchdb that don't
140
- # have include_docs support
141
- view = fetch_view(name, opts, &block)
142
- view['rows'].collect{|r|new(database.get(r['id']))} if view['rows']
143
- end
144
- end
145
- end
146
-
147
- def fetch_view view_name, opts, &block
148
- retryable = true
149
- begin
150
- design_doc.view(view_name, opts, &block)
151
- # the design doc could have been deleted by a rouge process
152
- rescue RestClient::ResourceNotFound => e
153
- if retryable
154
- refresh_design_doc
155
- retryable = false
156
- retry
157
- else
158
- raise e
159
- end
160
- end
161
- end
162
-
163
- end # module ClassMethods
164
-
165
-
166
- end
167
- end
168
- end
@@ -1,119 +0,0 @@
1
- require File.join(File.dirname(__FILE__), 'support', 'class')
2
- require File.join(File.dirname(__FILE__), 'support', 'blank')
3
-
4
- # This file must be loaded after the JSON gem and any other library that beats up the Time class.
5
- class Time
6
- # This date format sorts lexicographically
7
- # and is compatible with Javascript's <tt>new Date(time_string)</tt> constructor.
8
- # Note this this format stores all dates in UTC so that collation
9
- # order is preserved. (There's no longer a need to set <tt>ENV['TZ'] = 'UTC'</tt>
10
- # in your application.)
11
-
12
- def to_json(options = nil)
13
- u = self.utc
14
- %("#{u.strftime("%Y/%m/%d %H:%M:%S +0000")}")
15
- end
16
-
17
- # Decodes the JSON time format to a UTC time.
18
- # Based on Time.parse from ActiveSupport. ActiveSupport's version
19
- # is more complete, returning a time in your current timezone,
20
- # rather than keeping the time in UTC. YMMV.
21
- # def self.parse string, fallback=nil
22
- # d = DateTime.parse(string).new_offset
23
- # self.utc(d.year, d.month, d.day, d.hour, d.min, d.sec)
24
- # rescue
25
- # fallback
26
- # end
27
- end
28
-
29
- # Monkey patch for faster net/http io
30
- if RUBY_VERSION.to_f < 1.9
31
- class Net::BufferedIO #:nodoc:
32
- alias :old_rbuf_fill :rbuf_fill
33
- def rbuf_fill
34
- if @io.respond_to?(:read_nonblock)
35
- begin
36
- @rbuf << @io.read_nonblock(65536)
37
- rescue Errno::EWOULDBLOCK
38
- if IO.select([@io], nil, nil, @read_timeout)
39
- retry
40
- else
41
- raise Timeout::TimeoutError
42
- end
43
- end
44
- else
45
- timeout(@read_timeout) do
46
- @rbuf << @io.sysread(65536)
47
- end
48
- end
49
- end
50
- end
51
- end
52
-
53
- module RestClient
54
- def self.copy(url, headers={})
55
- Request.execute(:method => :copy,
56
- :url => url,
57
- :headers => headers)
58
- end
59
-
60
- def self.move(url, headers={})
61
- Request.execute(:method => :move,
62
- :url => url,
63
- :headers => headers)
64
- end
65
-
66
- # class Request
67
- #
68
- # def establish_connection(uri)
69
- # Thread.current[:connection].finish if (Thread.current[:connection] && Thread.current[:connection].started?)
70
- # p net_http_class
71
- # net = net_http_class.new(uri.host, uri.port)
72
- # net.use_ssl = uri.is_a?(URI::HTTPS)
73
- # net.verify_mode = OpenSSL::SSL::VERIFY_NONE
74
- # Thread.current[:connection] = net
75
- # Thread.current[:connection].start
76
- # Thread.current[:connection]
77
- # end
78
- #
79
- # def transmit(uri, req, payload)
80
- # setup_credentials(req)
81
- #
82
- # Thread.current[:host] ||= uri.host
83
- # Thread.current[:port] ||= uri.port
84
- #
85
- # if (Thread.current[:connection].nil? || (Thread.current[:host] != uri.host))
86
- # p "establishing a connection"
87
- # establish_connection(uri)
88
- # end
89
- #
90
- # display_log request_log
91
- # http = Thread.current[:connection]
92
- # http.read_timeout = @timeout if @timeout
93
- #
94
- # begin
95
- # res = http.request(req, payload)
96
- # rescue
97
- # p "Net::HTTP connection failed, reconnecting"
98
- # establish_connection(uri)
99
- # http = Thread.current[:connection]
100
- # require 'ruby-debug'
101
- # debugger
102
- # req.body_stream = nil
103
- #
104
- # res = http.request(req, payload)
105
- # display_log response_log(res)
106
- # result res
107
- # else
108
- # display_log response_log(res)
109
- # process_result res
110
- # end
111
- #
112
- # rescue EOFError
113
- # raise RestClient::ServerBrokeConnection
114
- # rescue Timeout::Error
115
- # raise RestClient::RequestTimeout
116
- # end
117
- # end
118
-
119
- end
@@ -1,28 +0,0 @@
1
- require File.join(File.dirname(__FILE__), '..', 'mixins', 'properties')
2
-
3
- module CouchRest
4
- module CastedModel
5
-
6
- def self.included(base)
7
- base.send(:include, CouchRest::Mixins::Properties)
8
- base.send(:attr_accessor, :casted_by)
9
- end
10
-
11
- def initialize(keys={})
12
- super
13
- keys.each do |k,v|
14
- self[k.to_s] = v
15
- end if keys
16
- apply_defaults # defined in CouchRest::Mixins::Properties
17
- # cast_keys # defined in CouchRest::Mixins::Properties
18
- end
19
-
20
- def []= key, value
21
- super(key.to_s, value)
22
- end
23
-
24
- def [] key
25
- super(key.to_s)
26
- end
27
- end
28
- end
@@ -1,217 +0,0 @@
1
- begin
2
- # still required for Time parsing and pluralization in the validation
3
- require 'extlib'
4
- rescue
5
- puts "CouchRest::ExtendedDocument still requires extlib (not for much longer). This is left out of the gemspec on purpose."
6
- raise
7
- end
8
-
9
- require 'mime/types'
10
- require File.join(File.dirname(__FILE__), "property")
11
- require File.join(File.dirname(__FILE__), '..', 'mixins', 'extended_document_mixins')
12
-
13
- module CouchRest
14
-
15
- # Same as CouchRest::Document but with properties and validations
16
- class ExtendedDocument < Document
17
- include CouchRest::Callbacks
18
- include CouchRest::Mixins::DocumentQueries
19
- include CouchRest::Mixins::Views
20
- include CouchRest::Mixins::DesignDoc
21
- include CouchRest::Mixins::ExtendedAttachments
22
-
23
- def self.inherited(subklass)
24
- subklass.send(:include, CouchRest::Mixins::Properties)
25
- end
26
-
27
- # Accessors
28
- attr_accessor :casted_by
29
-
30
- # Callbacks
31
- define_callbacks :create
32
- define_callbacks :save
33
- define_callbacks :update
34
- define_callbacks :destroy
35
-
36
- def initialize(passed_keys={})
37
- apply_defaults # defined in CouchRest::Mixins::Properties
38
- super
39
- cast_keys # defined in CouchRest::Mixins::Properties
40
- unless self['_id'] && self['_rev']
41
- self['couchrest-type'] = self.class.to_s
42
- end
43
- end
44
-
45
-
46
- # Automatically set <tt>updated_at</tt> and <tt>created_at</tt> fields
47
- # on the document whenever saving occurs. CouchRest uses a pretty
48
- # decent time format by default. See Time#to_json
49
- def self.timestamps!
50
- class_eval <<-EOS, __FILE__, __LINE__
51
- property(:updated_at, :read_only => true, :cast_as => 'Time', :auto_validation => false)
52
- property(:created_at, :read_only => true, :cast_as => 'Time', :auto_validation => false)
53
-
54
- save_callback :before do |object|
55
- object['updated_at'] = Time.now
56
- object['created_at'] = object['updated_at'] if object.new_document?
57
- end
58
- EOS
59
- end
60
-
61
- # Name a method that will be called before the document is first saved,
62
- # which returns a string to be used for the document's <tt>_id</tt>.
63
- # Because CouchDB enforces a constraint that each id must be unique,
64
- # this can be used to enforce eg: uniq usernames. Note that this id
65
- # must be globally unique across all document types which share a
66
- # database, so if you'd like to scope uniqueness to this class, you
67
- # should use the class name as part of the unique id.
68
- def self.unique_id method = nil, &block
69
- if method
70
- define_method :set_unique_id do
71
- self['_id'] ||= self.send(method)
72
- end
73
- elsif block
74
- define_method :set_unique_id do
75
- uniqid = block.call(self)
76
- raise ArgumentError, "unique_id block must not return nil" if uniqid.nil?
77
- self['_id'] ||= uniqid
78
- end
79
- end
80
- end
81
-
82
- # Temp solution to make the view_by methods available
83
- def self.method_missing(m, *args)
84
- if has_view?(m)
85
- query = args.shift || {}
86
- view(m, query, *args)
87
- else
88
- super
89
- end
90
- end
91
-
92
- ### instance methods
93
-
94
- # Returns the Class properties
95
- #
96
- # ==== Returns
97
- # Array:: the list of properties for the instance
98
- def properties
99
- self.class.properties
100
- end
101
-
102
- # Takes a hash as argument, and applies the values by using writer methods
103
- # for each key. It doesn't save the document at the end. Raises a NoMethodError if the corresponding methods are
104
- # missing. In case of error, no attributes are changed.
105
- def update_attributes_without_saving(hash)
106
- hash.each do |k, v|
107
- raise NoMethodError, "#{k}= method not available, use property :#{k}" unless self.respond_to?("#{k}=")
108
- end
109
- hash.each do |k, v|
110
- self.send("#{k}=",v)
111
- end
112
- end
113
-
114
- # Takes a hash as argument, and applies the values by using writer methods
115
- # for each key. Raises a NoMethodError if the corresponding methods are
116
- # missing. In case of error, no attributes are changed.
117
- def update_attributes(hash)
118
- update_attributes_without_saving hash
119
- save
120
- end
121
-
122
- # for compatibility with old-school frameworks
123
- alias :new_record? :new_document?
124
-
125
- # Trigger the callbacks (before, after, around)
126
- # and create the document
127
- # It's important to have a create callback since you can't check if a document
128
- # was new after you saved it
129
- #
130
- # When creating a document, both the create and the save callbacks will be triggered.
131
- def create(bulk = false)
132
- caught = catch(:halt) do
133
- _run_create_callbacks do
134
- _run_save_callbacks do
135
- create_without_callbacks(bulk)
136
- end
137
- end
138
- end
139
- end
140
-
141
- # unlike save, create returns the newly created document
142
- def create_without_callbacks(bulk =false)
143
- raise ArgumentError, "a document requires a database to be created to (The document or the #{self.class} default database were not set)" unless database
144
- set_unique_id if new_document? && self.respond_to?(:set_unique_id)
145
- result = database.save_doc(self, bulk)
146
- (result["ok"] == true) ? self : false
147
- end
148
-
149
- # Creates the document in the db. Raises an exception
150
- # if the document is not created properly.
151
- def create!
152
- raise "#{self.inspect} failed to save" unless self.create
153
- end
154
-
155
- # Trigger the callbacks (before, after, around)
156
- # only if the document isn't new
157
- def update(bulk = false)
158
- caught = catch(:halt) do
159
- if self.new_document?
160
- save(bulk)
161
- else
162
- _run_update_callbacks do
163
- _run_save_callbacks do
164
- save_without_callbacks(bulk)
165
- end
166
- end
167
- end
168
- end
169
- end
170
-
171
- # Trigger the callbacks (before, after, around)
172
- # and save the document
173
- def save(bulk = false)
174
- caught = catch(:halt) do
175
- if self.new_document?
176
- _run_save_callbacks do
177
- save_without_callbacks(bulk)
178
- end
179
- else
180
- update(bulk)
181
- end
182
- end
183
- end
184
-
185
- # Overridden to set the unique ID.
186
- # Returns a boolean value
187
- def save_without_callbacks(bulk = false)
188
- raise ArgumentError, "a document requires a database to be saved to (The document or the #{self.class} default database were not set)" unless database
189
- set_unique_id if new_document? && self.respond_to?(:set_unique_id)
190
- result = database.save_doc(self, bulk)
191
- result["ok"] == true
192
- end
193
-
194
- # Saves the document to the db using save. Raises an exception
195
- # if the document is not saved properly.
196
- def save!
197
- raise "#{self.inspect} failed to save" unless self.save
198
- end
199
-
200
- # Deletes the document from the database. Runs the :destroy callbacks.
201
- # Removes the <tt>_id</tt> and <tt>_rev</tt> fields, preparing the
202
- # document to be saved to a new <tt>_id</tt>.
203
- def destroy(bulk=false)
204
- caught = catch(:halt) do
205
- _run_destroy_callbacks do
206
- result = database.delete_doc(self, bulk)
207
- if result['ok']
208
- self['_rev'] = nil
209
- self['_id'] = nil
210
- end
211
- result['ok']
212
- end
213
- end
214
- end
215
-
216
- end
217
- end