jpbougie-couchrest 0.27

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 (94) hide show
  1. data/LICENSE +176 -0
  2. data/README.md +95 -0
  3. data/Rakefile +74 -0
  4. data/THANKS.md +18 -0
  5. data/examples/model/example.rb +144 -0
  6. data/examples/word_count/markov +38 -0
  7. data/examples/word_count/views/books/chunked-map.js +3 -0
  8. data/examples/word_count/views/books/united-map.js +1 -0
  9. data/examples/word_count/views/markov/chain-map.js +6 -0
  10. data/examples/word_count/views/markov/chain-reduce.js +7 -0
  11. data/examples/word_count/views/word_count/count-map.js +6 -0
  12. data/examples/word_count/views/word_count/count-reduce.js +3 -0
  13. data/examples/word_count/word_count.rb +46 -0
  14. data/examples/word_count/word_count_query.rb +40 -0
  15. data/examples/word_count/word_count_views.rb +26 -0
  16. data/lib/couchrest.rb +200 -0
  17. data/lib/couchrest/commands/generate.rb +71 -0
  18. data/lib/couchrest/commands/push.rb +103 -0
  19. data/lib/couchrest/core/database.rb +304 -0
  20. data/lib/couchrest/core/design.rb +79 -0
  21. data/lib/couchrest/core/document.rb +87 -0
  22. data/lib/couchrest/core/response.rb +16 -0
  23. data/lib/couchrest/core/server.rb +88 -0
  24. data/lib/couchrest/core/view.rb +4 -0
  25. data/lib/couchrest/helper/pager.rb +103 -0
  26. data/lib/couchrest/helper/streamer.rb +44 -0
  27. data/lib/couchrest/helper/upgrade.rb +51 -0
  28. data/lib/couchrest/mixins.rb +4 -0
  29. data/lib/couchrest/mixins/attachments.rb +31 -0
  30. data/lib/couchrest/mixins/callbacks.rb +483 -0
  31. data/lib/couchrest/mixins/class_proxy.rb +112 -0
  32. data/lib/couchrest/mixins/design_doc.rb +94 -0
  33. data/lib/couchrest/mixins/document_queries.rb +44 -0
  34. data/lib/couchrest/mixins/extended_attachments.rb +68 -0
  35. data/lib/couchrest/mixins/extended_document_mixins.rb +7 -0
  36. data/lib/couchrest/mixins/properties.rb +129 -0
  37. data/lib/couchrest/mixins/validation.rb +257 -0
  38. data/lib/couchrest/mixins/views.rb +177 -0
  39. data/lib/couchrest/monkeypatches.rb +113 -0
  40. data/lib/couchrest/more/casted_model.rb +29 -0
  41. data/lib/couchrest/more/extended_document.rb +220 -0
  42. data/lib/couchrest/more/property.rb +40 -0
  43. data/lib/couchrest/support/blank.rb +42 -0
  44. data/lib/couchrest/support/class.rb +176 -0
  45. data/lib/couchrest/support/rails.rb +35 -0
  46. data/lib/couchrest/validation/auto_validate.rb +163 -0
  47. data/lib/couchrest/validation/contextual_validators.rb +78 -0
  48. data/lib/couchrest/validation/validation_errors.rb +118 -0
  49. data/lib/couchrest/validation/validators/absent_field_validator.rb +74 -0
  50. data/lib/couchrest/validation/validators/confirmation_validator.rb +99 -0
  51. data/lib/couchrest/validation/validators/format_validator.rb +117 -0
  52. data/lib/couchrest/validation/validators/formats/email.rb +66 -0
  53. data/lib/couchrest/validation/validators/formats/url.rb +43 -0
  54. data/lib/couchrest/validation/validators/generic_validator.rb +120 -0
  55. data/lib/couchrest/validation/validators/length_validator.rb +134 -0
  56. data/lib/couchrest/validation/validators/method_validator.rb +89 -0
  57. data/lib/couchrest/validation/validators/numeric_validator.rb +104 -0
  58. data/lib/couchrest/validation/validators/required_field_validator.rb +109 -0
  59. data/spec/couchrest/core/couchrest_spec.rb +201 -0
  60. data/spec/couchrest/core/database_spec.rb +699 -0
  61. data/spec/couchrest/core/design_spec.rb +138 -0
  62. data/spec/couchrest/core/document_spec.rb +267 -0
  63. data/spec/couchrest/core/server_spec.rb +35 -0
  64. data/spec/couchrest/helpers/pager_spec.rb +122 -0
  65. data/spec/couchrest/helpers/streamer_spec.rb +23 -0
  66. data/spec/couchrest/more/casted_extended_doc_spec.rb +40 -0
  67. data/spec/couchrest/more/casted_model_spec.rb +142 -0
  68. data/spec/couchrest/more/extended_doc_attachment_spec.rb +130 -0
  69. data/spec/couchrest/more/extended_doc_spec.rb +537 -0
  70. data/spec/couchrest/more/extended_doc_subclass_spec.rb +98 -0
  71. data/spec/couchrest/more/extended_doc_view_spec.rb +338 -0
  72. data/spec/couchrest/more/property_spec.rb +136 -0
  73. data/spec/fixtures/attachments/README +3 -0
  74. data/spec/fixtures/attachments/couchdb.png +0 -0
  75. data/spec/fixtures/attachments/test.html +11 -0
  76. data/spec/fixtures/more/article.rb +34 -0
  77. data/spec/fixtures/more/card.rb +20 -0
  78. data/spec/fixtures/more/cat.rb +18 -0
  79. data/spec/fixtures/more/course.rb +14 -0
  80. data/spec/fixtures/more/event.rb +6 -0
  81. data/spec/fixtures/more/invoice.rb +17 -0
  82. data/spec/fixtures/more/person.rb +8 -0
  83. data/spec/fixtures/more/question.rb +6 -0
  84. data/spec/fixtures/more/service.rb +12 -0
  85. data/spec/fixtures/views/lib.js +3 -0
  86. data/spec/fixtures/views/test_view/lib.js +3 -0
  87. data/spec/fixtures/views/test_view/only-map.js +4 -0
  88. data/spec/fixtures/views/test_view/test-map.js +3 -0
  89. data/spec/fixtures/views/test_view/test-reduce.js +3 -0
  90. data/spec/spec.opts +6 -0
  91. data/spec/spec_helper.rb +38 -0
  92. data/utils/remap.rb +27 -0
  93. data/utils/subset.rb +30 -0
  94. metadata +192 -0
@@ -0,0 +1,38 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require File.expand_path(File.dirname(__FILE__)) + '/../../couchrest'
4
+
5
+ cr = CouchRest.new("http://127.0.0.1:5984")
6
+ @db = cr.database('word-count-example')
7
+ @word_memoizer = {}
8
+
9
+ def probable_follower_for(word)
10
+ @word_memoizer[word] ||= @db.view('markov/chain-reduce', :startkey => [word,nil], :endkey => [word,{}],:group_level => 2)
11
+
12
+ # puts
13
+ # puts "search #{word} #{wprobs[word]['rows'].length}"
14
+ # @word_memoizer[word]['rows'].sort_by{|r|r['value']}.each{|r|puts [r['value'],r['key']].inspect}
15
+
16
+ rows = @word_memoizer[word]['rows'].select{|r|(r['key'][1]!='')}.sort_by{|r|r['value']}
17
+ row = rows[(-1*[rows.length,5].min)..-1].sort_by{rand}[0]
18
+ row ? row['key'][1] : nil
19
+ end
20
+
21
+
22
+ word = ARGV[0]
23
+ words = [word]
24
+
25
+ while word
26
+ $stdout.print ' ' if words.length > 1
27
+ $stdout.print word
28
+ $stdout.flush
29
+ word = probable_follower_for(word)
30
+ words << word
31
+ end
32
+
33
+ $stdout.print '.'
34
+ $stdout.flush
35
+ puts
36
+
37
+ # `say #{words.join(' ')}`
38
+
@@ -0,0 +1,3 @@
1
+ function(doc) {
2
+ doc.title && doc.chunk && emit([doc.title, doc.chunk],null);
3
+ }
@@ -0,0 +1 @@
1
+ function(doc){if(doc.text && doc.text.match(/united/)) emit([doc.title, doc.chunk],null)}
@@ -0,0 +1,6 @@
1
+ function(doc){
2
+ var words = doc.text.split(/\W/).filter(function(w) {return w.length > 0}).map(function(w){return w.toLowerCase()});
3
+ for (var i = 0, l = words.length; i < l; i++) {
4
+ emit(words.slice(i,4),doc.title);
5
+ }
6
+ }
@@ -0,0 +1,7 @@
1
+ function(key,vs,c){
2
+ if (c) {
3
+ return sum(vs);
4
+ } else {
5
+ return vs.length;
6
+ }
7
+ }
@@ -0,0 +1,6 @@
1
+ function(doc){
2
+ var words = doc.text.split(/\W/).map(function(w){return w.toLowerCase()});
3
+ words.forEach(function(word){
4
+ if (word.length > 0) emit([word,doc.title],1);
5
+ });
6
+ }
@@ -0,0 +1,3 @@
1
+ function(key,values){
2
+ return sum(values);
3
+ }
@@ -0,0 +1,46 @@
1
+ require 'rubygems'
2
+ require 'couchrest'
3
+
4
+ couch = CouchRest.new("http://127.0.0.1:5984")
5
+ db = couch.database('word-count-example')
6
+ db.delete! rescue nil
7
+ db = couch.create_db('word-count-example')
8
+
9
+ books = {
10
+ 'outline-of-science.txt' => 'http://www.gutenberg.org/files/20417/20417.txt',
11
+ 'ulysses.txt' => 'http://www.gutenberg.org/dirs/etext03/ulyss12.txt',
12
+ 'america.txt' => 'http://www.gutenberg.org/files/16960/16960.txt',
13
+ 'da-vinci.txt' => 'http://www.gutenberg.org/dirs/etext04/7ldv110.txt'
14
+ }
15
+
16
+ books.each do |file, url|
17
+ pathfile = File.join(File.dirname(__FILE__),file)
18
+ `curl #{url} > #{pathfile}` unless File.exists?(pathfile)
19
+ end
20
+
21
+
22
+ books.keys.each do |book|
23
+ title = book.split('.')[0]
24
+ puts title
25
+ File.open(File.join(File.dirname(__FILE__),book),'r') do |file|
26
+ lines = []
27
+ chunk = 0
28
+ while line = file.gets
29
+ lines << line
30
+ if lines.length > 10
31
+ db.save({
32
+ :title => title,
33
+ :chunk => chunk,
34
+ :text => lines.join('')
35
+ })
36
+ chunk += 1
37
+ puts chunk
38
+ lines = []
39
+ end
40
+ end
41
+ end
42
+ end
43
+
44
+ # puts "The books have been stored in your CouchDB. To initiate the MapReduce process, visit http://127.0.0.1:5984/_utils/ in your browser and click 'word-count-example', then select view 'words' or 'count'. The process could take about 15 minutes on an average MacBook."
45
+
46
+
@@ -0,0 +1,40 @@
1
+ require 'rubygems'
2
+ require 'couchrest'
3
+
4
+ couch = CouchRest.new("http://127.0.0.1:5984")
5
+ db = couch.database('word-count-example')
6
+
7
+ puts "Now that we've parsed all those books into CouchDB, the queries we can run are incredibly flexible."
8
+ puts "\nThe simplest query we can run is the total word count for all words in all documents:"
9
+ puts "this will take a few minutes the first time. if it times out, just rerun this script in a few few minutes."
10
+ puts db.view('word_count/words').inspect
11
+
12
+ puts "\nWe can also narrow the query down to just one word, across all documents. Here is the count for 'flight' in all three books:"
13
+
14
+ word = 'flight'
15
+ params = {
16
+ :startkey => [word],
17
+ :endkey => [word,{}]
18
+ }
19
+
20
+ puts db.view('word_count/words',params).inspect
21
+
22
+ puts "\nWe scope the query using startkey and endkey params to take advantage of CouchDB's collation ordering. Here are the params for the last query:"
23
+ puts params.inspect
24
+
25
+ puts "\nWe can also count words on a per-title basis."
26
+
27
+ title = 'da-vinci'
28
+ params = {
29
+ :key => [word, title]
30
+ }
31
+
32
+ puts db.view('word_count/words',params).inspect
33
+
34
+
35
+ puts "\nHere are the params for 'flight' in the da-vinci book:"
36
+ puts params.inspect
37
+ puts
38
+ puts 'The url looks like this:'
39
+ puts 'http://127.0.0.1:5984/word-count-example/_view/word_count/count?key=["flight","da-vinci"]'
40
+ puts "\nTry dropping that in your browser..."
@@ -0,0 +1,26 @@
1
+ require 'rubygems'
2
+ require 'couchrest'
3
+
4
+ couch = CouchRest.new("http://127.0.0.1:5984")
5
+ db = couch.database('word-count-example')
6
+
7
+ word_count = {
8
+ :map => 'function(doc){
9
+ var words = doc.text.split(/\W/);
10
+ words.forEach(function(word){
11
+ if (word.length > 0) emit([word,doc.title],1);
12
+ });
13
+ }',
14
+ :reduce => 'function(key,combine){
15
+ return sum(combine);
16
+ }'
17
+ }
18
+
19
+ db.delete db.get("_design/word_count") rescue nil
20
+
21
+ db.save({
22
+ "_id" => "_design/word_count",
23
+ :views => {
24
+ :words => word_count
25
+ }
26
+ })
data/lib/couchrest.rb ADDED
@@ -0,0 +1,200 @@
1
+ # Copyright 2008 J. Chris Anderson
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'rubygems'
16
+ begin
17
+ require 'json'
18
+ rescue LoadError
19
+ raise "You need install and require your own json compatible library since couchrest rest couldn't load the json/json_pure gem" unless Kernel.const_defined?("JSON")
20
+ end
21
+ require 'rest_client'
22
+
23
+ $:.unshift File.dirname(__FILE__) unless
24
+ $:.include?(File.dirname(__FILE__)) ||
25
+ $:.include?(File.expand_path(File.dirname(__FILE__)))
26
+
27
+ $COUCHREST_DEBUG ||= false
28
+
29
+ require 'couchrest/monkeypatches'
30
+
31
+ # = CouchDB, close to the metal
32
+ module CouchRest
33
+ VERSION = '0.27' unless self.const_defined?("VERSION")
34
+
35
+ autoload :Server, 'couchrest/core/server'
36
+ autoload :Database, 'couchrest/core/database'
37
+ autoload :Response, 'couchrest/core/response'
38
+ autoload :Document, 'couchrest/core/document'
39
+ autoload :Design, 'couchrest/core/design'
40
+ autoload :View, 'couchrest/core/view'
41
+ autoload :Model, 'couchrest/core/model'
42
+ autoload :Pager, 'couchrest/helper/pager'
43
+ autoload :FileManager, 'couchrest/helper/file_manager'
44
+ autoload :Streamer, 'couchrest/helper/streamer'
45
+ autoload :Upgrade, 'couchrest/helper/upgrade'
46
+
47
+ autoload :ExtendedDocument, 'couchrest/more/extended_document'
48
+ autoload :CastedModel, 'couchrest/more/casted_model'
49
+
50
+ require File.join(File.dirname(__FILE__), 'couchrest', 'mixins')
51
+
52
+ # The CouchRest module methods handle the basic JSON serialization
53
+ # and deserialization, as well as query parameters. The module also includes
54
+ # some helpers for tasks like instantiating a new Database or Server instance.
55
+ class << self
56
+
57
+ # extracted from Extlib
58
+ #
59
+ # Constantize tries to find a declared constant with the name specified
60
+ # in the string. It raises a NameError when the name is not in CamelCase
61
+ # or is not initialized.
62
+ #
63
+ # @example
64
+ # "Module".constantize #=> Module
65
+ # "Class".constantize #=> Class
66
+ def constantize(camel_cased_word)
67
+ unless /\A(?:::)?([A-Z]\w*(?:::[A-Z]\w*)*)\z/ =~ camel_cased_word
68
+ raise NameError, "#{camel_cased_word.inspect} is not a valid constant name!"
69
+ end
70
+
71
+ Object.module_eval("::#{$1}", __FILE__, __LINE__)
72
+ end
73
+
74
+ # extracted from Extlib
75
+ #
76
+ # Capitalizes the first word and turns underscores into spaces and strips _id.
77
+ # Like titleize, this is meant for creating pretty output.
78
+ #
79
+ # @example
80
+ # "employee_salary" #=> "Employee salary"
81
+ # "author_id" #=> "Author"
82
+ def humanize(lower_case_and_underscored_word)
83
+ lower_case_and_underscored_word.to_s.gsub(/_id$/, "").gsub(/_/, " ").capitalize
84
+ end
85
+
86
+ # todo, make this parse the url and instantiate a Server or Database instance
87
+ # depending on the specificity.
88
+ def new(*opts)
89
+ Server.new(*opts)
90
+ end
91
+
92
+ def parse url
93
+ case url
94
+ when /^http:\/\/(.*)\/(.*)\/(.*)/
95
+ host = $1
96
+ db = $2
97
+ docid = $3
98
+ when /^http:\/\/(.*)\/(.*)/
99
+ host = $1
100
+ db = $2
101
+ when /^http:\/\/(.*)/
102
+ host = $1
103
+ when /(.*)\/(.*)\/(.*)/
104
+ host = $1
105
+ db = $2
106
+ docid = $3
107
+ when /(.*)\/(.*)/
108
+ host = $1
109
+ db = $2
110
+ else
111
+ db = url
112
+ end
113
+
114
+ db = nil if db && db.empty?
115
+
116
+ {
117
+ :host => host || "127.0.0.1:5984",
118
+ :database => db,
119
+ :doc => docid
120
+ }
121
+ end
122
+
123
+ # set proxy for RestClient to use
124
+ def proxy url
125
+ RestClient.proxy = url
126
+ end
127
+
128
+ # ensure that a database exists
129
+ # creates it if it isn't already there
130
+ # returns it after it's been created
131
+ def database! url
132
+ parsed = parse url
133
+ cr = CouchRest.new(parsed[:host])
134
+ cr.database!(parsed[:database])
135
+ end
136
+
137
+ def database url
138
+ parsed = parse url
139
+ cr = CouchRest.new(parsed[:host])
140
+ cr.database(parsed[:database])
141
+ end
142
+
143
+ def put(uri, doc = nil)
144
+ payload = doc.to_json if doc
145
+ begin
146
+ JSON.parse(RestClient.put(uri, payload), :max_nesting => false)
147
+ rescue Exception => e
148
+ if $COUCHREST_DEBUG == true
149
+ raise "Error while sending a PUT request #{uri}\npayload: #{payload.inspect}\n#{e}"
150
+ else
151
+ raise e
152
+ end
153
+ end
154
+ end
155
+
156
+ def get(uri)
157
+ begin
158
+ JSON.parse(RestClient.get(uri), :max_nesting => false)
159
+ rescue => e
160
+ if $COUCHREST_DEBUG == true
161
+ raise "Error while sending a GET request #{uri}\n: #{e}"
162
+ else
163
+ raise e
164
+ end
165
+ end
166
+ end
167
+
168
+ def post uri, doc = nil
169
+ payload = doc.to_json if doc
170
+ begin
171
+ JSON.parse(RestClient.post(uri, payload), :max_nesting => false)
172
+ rescue Exception => e
173
+ if $COUCHREST_DEBUG == true
174
+ raise "Error while sending a POST request #{uri}\npayload: #{payload.inspect}\n#{e}"
175
+ else
176
+ raise e
177
+ end
178
+ end
179
+ end
180
+
181
+ def delete uri
182
+ JSON.parse(RestClient.delete(uri))
183
+ end
184
+
185
+ def copy uri, destination
186
+ JSON.parse(RestClient.copy(uri, {'Destination' => destination}))
187
+ end
188
+
189
+ def paramify_url url, params = {}
190
+ if params && !params.empty?
191
+ query = params.collect do |k,v|
192
+ v = v.to_json if %w{key startkey endkey}.include?(k.to_s)
193
+ "#{k}=#{CGI.escape(v.to_s)}"
194
+ end.join("&")
195
+ url = "#{url}?#{query}"
196
+ end
197
+ url
198
+ end
199
+ end # class << self
200
+ end
@@ -0,0 +1,71 @@
1
+ require 'fileutils'
2
+
3
+ module CouchRest
4
+ module Commands
5
+ module Generate
6
+
7
+ def self.run(options)
8
+ directory = options[:directory]
9
+ design_names = options[:trailing_args]
10
+
11
+ FileUtils.mkdir_p(directory)
12
+ filename = File.join(directory, "lib.js")
13
+ self.write(filename, <<-FUNC)
14
+ // Put global functions here.
15
+ // Include in your views with
16
+ //
17
+ // //include-lib
18
+ FUNC
19
+
20
+ design_names.each do |design_name|
21
+ subdirectory = File.join(directory, design_name)
22
+ FileUtils.mkdir_p(subdirectory)
23
+ filename = File.join(subdirectory, "sample-map.js")
24
+ self.write(filename, <<-FUNC)
25
+ function(doc) {
26
+ // Keys is first letter of _id
27
+ emit(doc._id[0], doc);
28
+ }
29
+ FUNC
30
+
31
+ filename = File.join(subdirectory, "sample-reduce.js")
32
+ self.write(filename, <<-FUNC)
33
+ function(keys, values) {
34
+ // Count the number of keys starting with this letter
35
+ return values.length;
36
+ }
37
+ FUNC
38
+
39
+ filename = File.join(subdirectory, "lib.js")
40
+ self.write(filename, <<-FUNC)
41
+ // Put functions specific to '#{design_name}' here.
42
+ // Include in your views with
43
+ //
44
+ // //include-lib
45
+ FUNC
46
+ end
47
+ end
48
+
49
+ def self.help
50
+ helpstring = <<-GEN
51
+
52
+ Usage: couchview generate directory design1 design2 design3 ...
53
+
54
+ Couchview will create directories and example views for the design documents you specify.
55
+
56
+ GEN
57
+ helpstring.gsub(/^ /, '')
58
+ end
59
+
60
+ def self.write(filename, contents)
61
+ puts "Writing #{filename}"
62
+ File.open(filename, "w") do |f|
63
+ # Remove leading spaces
64
+ contents.gsub!(/^ ( )?/, '')
65
+ f.write contents
66
+ end
67
+ end
68
+
69
+ end
70
+ end
71
+ end