samlown-couchrest 0.35

Sign up to get free protection for your applications and to get access to all the features.
Files changed (105) hide show
  1. data/LICENSE +176 -0
  2. data/README.md +46 -0
  3. data/Rakefile +67 -0
  4. data/THANKS.md +19 -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/history.txt +114 -0
  17. data/lib/couchrest/commands/generate.rb +71 -0
  18. data/lib/couchrest/commands/push.rb +103 -0
  19. data/lib/couchrest/core/adapters/restclient.rb +35 -0
  20. data/lib/couchrest/core/database.rb +377 -0
  21. data/lib/couchrest/core/design.rb +79 -0
  22. data/lib/couchrest/core/document.rb +84 -0
  23. data/lib/couchrest/core/http_abstraction.rb +48 -0
  24. data/lib/couchrest/core/response.rb +16 -0
  25. data/lib/couchrest/core/rest_api.rb +49 -0
  26. data/lib/couchrest/core/server.rb +88 -0
  27. data/lib/couchrest/core/view.rb +4 -0
  28. data/lib/couchrest/helper/pager.rb +103 -0
  29. data/lib/couchrest/helper/streamer.rb +51 -0
  30. data/lib/couchrest/helper/upgrade.rb +51 -0
  31. data/lib/couchrest/middlewares/logger.rb +263 -0
  32. data/lib/couchrest/mixins/attachments.rb +31 -0
  33. data/lib/couchrest/mixins/attribute_protection.rb +74 -0
  34. data/lib/couchrest/mixins/callbacks.rb +532 -0
  35. data/lib/couchrest/mixins/class_proxy.rb +124 -0
  36. data/lib/couchrest/mixins/collection.rb +260 -0
  37. data/lib/couchrest/mixins/design_doc.rb +103 -0
  38. data/lib/couchrest/mixins/document_queries.rb +80 -0
  39. data/lib/couchrest/mixins/extended_attachments.rb +70 -0
  40. data/lib/couchrest/mixins/extended_document_mixins.rb +9 -0
  41. data/lib/couchrest/mixins/properties.rb +154 -0
  42. data/lib/couchrest/mixins/validation.rb +246 -0
  43. data/lib/couchrest/mixins/views.rb +173 -0
  44. data/lib/couchrest/mixins.rb +4 -0
  45. data/lib/couchrest/monkeypatches.rb +113 -0
  46. data/lib/couchrest/more/casted_model.rb +58 -0
  47. data/lib/couchrest/more/extended_document.rb +310 -0
  48. data/lib/couchrest/more/property.rb +50 -0
  49. data/lib/couchrest/more/typecast.rb +175 -0
  50. data/lib/couchrest/support/blank.rb +42 -0
  51. data/lib/couchrest/support/class.rb +190 -0
  52. data/lib/couchrest/support/rails.rb +42 -0
  53. data/lib/couchrest/validation/auto_validate.rb +157 -0
  54. data/lib/couchrest/validation/contextual_validators.rb +78 -0
  55. data/lib/couchrest/validation/validation_errors.rb +125 -0
  56. data/lib/couchrest/validation/validators/absent_field_validator.rb +74 -0
  57. data/lib/couchrest/validation/validators/confirmation_validator.rb +107 -0
  58. data/lib/couchrest/validation/validators/format_validator.rb +122 -0
  59. data/lib/couchrest/validation/validators/formats/email.rb +66 -0
  60. data/lib/couchrest/validation/validators/formats/url.rb +43 -0
  61. data/lib/couchrest/validation/validators/generic_validator.rb +120 -0
  62. data/lib/couchrest/validation/validators/length_validator.rb +139 -0
  63. data/lib/couchrest/validation/validators/method_validator.rb +89 -0
  64. data/lib/couchrest/validation/validators/numeric_validator.rb +109 -0
  65. data/lib/couchrest/validation/validators/required_field_validator.rb +114 -0
  66. data/lib/couchrest.rb +162 -0
  67. data/spec/couchrest/core/couchrest_spec.rb +184 -0
  68. data/spec/couchrest/core/database_spec.rb +840 -0
  69. data/spec/couchrest/core/design_spec.rb +138 -0
  70. data/spec/couchrest/core/document_spec.rb +275 -0
  71. data/spec/couchrest/core/server_spec.rb +35 -0
  72. data/spec/couchrest/helpers/pager_spec.rb +122 -0
  73. data/spec/couchrest/helpers/streamer_spec.rb +52 -0
  74. data/spec/couchrest/more/attribute_protection_spec.rb +150 -0
  75. data/spec/couchrest/more/casted_extended_doc_spec.rb +79 -0
  76. data/spec/couchrest/more/casted_model_spec.rb +406 -0
  77. data/spec/couchrest/more/extended_doc_attachment_spec.rb +135 -0
  78. data/spec/couchrest/more/extended_doc_inherited_spec.rb +40 -0
  79. data/spec/couchrest/more/extended_doc_spec.rb +797 -0
  80. data/spec/couchrest/more/extended_doc_subclass_spec.rb +98 -0
  81. data/spec/couchrest/more/extended_doc_view_spec.rb +456 -0
  82. data/spec/couchrest/more/property_spec.rb +628 -0
  83. data/spec/fixtures/attachments/README +3 -0
  84. data/spec/fixtures/attachments/couchdb.png +0 -0
  85. data/spec/fixtures/attachments/test.html +11 -0
  86. data/spec/fixtures/more/article.rb +35 -0
  87. data/spec/fixtures/more/card.rb +22 -0
  88. data/spec/fixtures/more/cat.rb +20 -0
  89. data/spec/fixtures/more/course.rb +22 -0
  90. data/spec/fixtures/more/event.rb +8 -0
  91. data/spec/fixtures/more/invoice.rb +17 -0
  92. data/spec/fixtures/more/person.rb +9 -0
  93. data/spec/fixtures/more/question.rb +6 -0
  94. data/spec/fixtures/more/service.rb +12 -0
  95. data/spec/fixtures/more/user.rb +22 -0
  96. data/spec/fixtures/views/lib.js +3 -0
  97. data/spec/fixtures/views/test_view/lib.js +3 -0
  98. data/spec/fixtures/views/test_view/only-map.js +4 -0
  99. data/spec/fixtures/views/test_view/test-map.js +3 -0
  100. data/spec/fixtures/views/test_view/test-reduce.js +3 -0
  101. data/spec/spec.opts +6 -0
  102. data/spec/spec_helper.rb +49 -0
  103. data/utils/remap.rb +27 -0
  104. data/utils/subset.rb +30 -0
  105. metadata +223 -0
@@ -0,0 +1,107 @@
1
+ # Extracted from dm-validations 0.9.10
2
+ #
3
+ # Copyright (c) 2007 Guy van den Berg
4
+ #
5
+ # Permission is hereby granted, free of charge, to any person obtaining
6
+ # a copy of this software and associated documentation files (the
7
+ # "Software"), to deal in the Software without restriction, including
8
+ # without limitation the rights to use, copy, modify, merge, publish,
9
+ # distribute, sublicense, and/or sell copies of the Software, and to
10
+ # permit persons to whom the Software is furnished to do so, subject to
11
+ # the following conditions:
12
+ #
13
+ # The above copyright notice and this permission notice shall be
14
+ # included in all copies or substantial portions of the Software.
15
+ #
16
+ # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
+ # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18
+ # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
+ # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20
+ # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21
+ # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22
+ # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23
+
24
+ module CouchRest
25
+ module Validation
26
+
27
+ ##
28
+ #
29
+ # @author Guy van den Berg
30
+ # @since 0.9
31
+ class ConfirmationValidator < GenericValidator
32
+
33
+ def initialize(field_name, options = {})
34
+ super
35
+ @options = options
36
+ @field_name, @confirm_field_name = field_name, (options[:confirm] || "#{field_name}_confirmation").to_sym
37
+ @options[:allow_nil] = true unless @options.has_key?(:allow_nil)
38
+ end
39
+
40
+ def call(target)
41
+ unless valid?(target)
42
+ error_message = @options[:message] || ValidationErrors.default_error_message(:confirmation, field_name)
43
+ add_error(target, error_message, field_name)
44
+ return false
45
+ end
46
+
47
+ return true
48
+ end
49
+
50
+ def valid?(target)
51
+ field_value = target.send(field_name)
52
+ return true if @options[:allow_nil] && field_value.nil?
53
+ return false if !@options[:allow_nil] && field_value.nil?
54
+
55
+ confirm_value = target.instance_variable_get("@#{@confirm_field_name}")
56
+ field_value == confirm_value
57
+ end
58
+
59
+ end # class ConfirmationValidator
60
+
61
+ module ValidatesIsConfirmed
62
+
63
+ ##
64
+ # Validates that the given attribute is confirmed by another attribute.
65
+ # A common use case scenario is when you require a user to confirm their
66
+ # password, for which you use both password and password_confirmation
67
+ # attributes.
68
+ #
69
+ # @option :allow_nil<Boolean> true/false (default is true)
70
+ # @option :confirm<Symbol> the attribute that you want to validate
71
+ # against (default is firstattr_confirmation)
72
+ #
73
+ # @example [Usage]
74
+ #
75
+ # class Page < Hash
76
+ # include CouchRest::ExtendedModel
77
+ # include CouchRest::Validations
78
+ #
79
+ # property :password, String
80
+ # property :email, String
81
+ # attr_accessor :password_confirmation
82
+ # attr_accessor :email_repeated
83
+ #
84
+ # validates_confirmation_of :password
85
+ # validates_confirmation_of :email, :confirm => :email_repeated
86
+ #
87
+ # # a call to valid? will return false unless:
88
+ # # password == password_confirmation
89
+ # # and
90
+ # # email == email_repeated
91
+ #
92
+ def validates_confirmation_of(*fields)
93
+ opts = opts_from_validator_args(fields)
94
+ add_validator_to_context(opts, fields, CouchRest::Validation::ConfirmationValidator)
95
+ end
96
+
97
+ def validates_is_confirmed(*fields)
98
+ warn "[DEPRECATION] `validates_is_confirmed` is deprecated. Please use `validates_confirmation_of` instead."
99
+ validates_confirmation_of(*fields)
100
+ end
101
+
102
+
103
+
104
+
105
+ end # module ValidatesIsConfirmed
106
+ end # module Validation
107
+ end # module CouchRest
@@ -0,0 +1,122 @@
1
+ # Extracted from dm-validations 0.9.10
2
+ #
3
+ # Copyright (c) 2007 Guy van den Berg
4
+ #
5
+ # Permission is hereby granted, free of charge, to any person obtaining
6
+ # a copy of this software and associated documentation files (the
7
+ # "Software"), to deal in the Software without restriction, including
8
+ # without limitation the rights to use, copy, modify, merge, publish,
9
+ # distribute, sublicense, and/or sell copies of the Software, and to
10
+ # permit persons to whom the Software is furnished to do so, subject to
11
+ # the following conditions:
12
+ #
13
+ # The above copyright notice and this permission notice shall be
14
+ # included in all copies or substantial portions of the Software.
15
+ #
16
+ # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
+ # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18
+ # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
+ # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20
+ # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21
+ # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22
+ # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23
+
24
+ require 'pathname'
25
+ require Pathname(__FILE__).dirname.expand_path + 'formats/email'
26
+ require Pathname(__FILE__).dirname.expand_path + 'formats/url'
27
+
28
+ module CouchRest
29
+ module Validation
30
+
31
+ ##
32
+ #
33
+ # @author Guy van den Berg
34
+ # @since 0.9
35
+ class FormatValidator < GenericValidator
36
+
37
+ FORMATS = {}
38
+ include CouchRest::Validation::Format::Email
39
+ include CouchRest::Validation::Format::Url
40
+
41
+ def initialize(field_name, options = {}, &b)
42
+ super(field_name, options)
43
+ @field_name, @options = field_name, options
44
+ @options[:allow_nil] = false unless @options.has_key?(:allow_nil)
45
+ end
46
+
47
+ def call(target)
48
+ value = target.validation_property_value(field_name)
49
+ return true if @options[:allow_nil] && value.nil?
50
+
51
+ validation = @options[:as] || @options[:with]
52
+
53
+ raise "No such predefined format '#{validation}'" if validation.is_a?(Symbol) && !FORMATS.has_key?(validation)
54
+ validator = validation.is_a?(Symbol) ? FORMATS[validation][0] : validation
55
+
56
+ valid = case validator
57
+ when Proc then validator.call(value)
58
+ when Regexp then value =~ validator
59
+ else
60
+ raise UnknownValidationFormat, "Can't determine how to validate #{target.class}##{field_name} with #{validator.inspect}"
61
+ end
62
+
63
+ return true if valid
64
+
65
+ error_message = @options[:message] || ValidationErrors.default_error_message(:invalid, field_name)
66
+
67
+ field = CouchRest.humanize(field_name)
68
+ error_message = error_message.call(field, value) if error_message.respond_to?(:call)
69
+
70
+ add_error(target, error_message, field_name)
71
+
72
+ false
73
+ end
74
+
75
+ #class UnknownValidationFormat < StandardError; end
76
+
77
+ end # class FormatValidator
78
+
79
+ module ValidatesFormat
80
+
81
+ ##
82
+ # Validates that the attribute is in the specified format. You may use the
83
+ # :as (or :with, it's an alias) option to specify the pre-defined format
84
+ # that you want to validate against. You may also specify your own format
85
+ # via a Proc or Regexp passed to the the :as or :with options.
86
+ #
87
+ # @option :allow_nil<Boolean> true/false (default is true)
88
+ # @option :as<Format, Proc, Regexp> the pre-defined format, Proc or Regexp to validate against
89
+ # @option :with<Format, Proc, Regexp> an alias for :as
90
+ #
91
+ # @details [Pre-defined Formats]
92
+ # :email_address (format is specified in DataMapper::Validation::Format::Email)
93
+ # :url (format is specified in DataMapper::Validation::Format::Url)
94
+ #
95
+ # @example [Usage]
96
+ #
97
+ # class Page
98
+ #
99
+ # property :email, String
100
+ # property :zip_code, String
101
+ #
102
+ # validates_format_of :email, :as => :email_address
103
+ # validates_format_of :zip_code, :with => /^\d{5}$/
104
+ #
105
+ # # a call to valid? will return false unless:
106
+ # # email is formatted like an email address
107
+ # # and
108
+ # # zip_code is a string of 5 digits
109
+ #
110
+ def validates_format_of(*fields)
111
+ opts = opts_from_validator_args(fields)
112
+ add_validator_to_context(opts, fields, CouchRest::Validation::FormatValidator)
113
+ end
114
+
115
+ def validates_format(*fields)
116
+ warn "[DEPRECATION] `validates_format` is deprecated. Please use `validates_format_of` instead."
117
+ validates_format_of(*fields)
118
+ end
119
+
120
+ end # module ValidatesFormat
121
+ end # module Validation
122
+ end # module CouchRest
@@ -0,0 +1,66 @@
1
+ # encoding: binary
2
+
3
+ # Extracted from dm-validations 0.9.10
4
+ #
5
+ # Copyright (c) 2007 Guy van den Berg
6
+ #
7
+ # Permission is hereby granted, free of charge, to any person obtaining
8
+ # a copy of this software and associated documentation files (the
9
+ # "Software"), to deal in the Software without restriction, including
10
+ # without limitation the rights to use, copy, modify, merge, publish,
11
+ # distribute, sublicense, and/or sell copies of the Software, and to
12
+ # permit persons to whom the Software is furnished to do so, subject to
13
+ # the following conditions:
14
+ #
15
+ # The above copyright notice and this permission notice shall be
16
+ # included in all copies or substantial portions of the Software.
17
+ #
18
+ # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
19
+ # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20
+ # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
21
+ # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
22
+ # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
23
+ # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
24
+ # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
25
+
26
+ module CouchRest
27
+ module Validation
28
+ module Format
29
+ module Email
30
+
31
+ def self.included(base)
32
+ CouchRest::Validation::FormatValidator::FORMATS.merge!(
33
+ :email_address => [ EmailAddress, lambda { |field, value| '%s is not a valid email address'.t(value) }]
34
+ )
35
+ end
36
+
37
+ # RFC2822 (No attribution reference available)
38
+ EmailAddress = begin
39
+ alpha = "a-zA-Z"
40
+ digit = "0-9"
41
+ atext = "[#{alpha}#{digit}\!\#\$\%\&\'\*+\/\=\?\^\_\`\{\|\}\~\-]"
42
+ dot_atom_text = "#{atext}+([.]#{atext}*)*"
43
+ dot_atom = "#{dot_atom_text}"
44
+ qtext = '[^\\x0d\\x22\\x5c\\x80-\\xff]'
45
+ text = "[\\x01-\\x09\\x11\\x12\\x14-\\x7f]"
46
+ quoted_pair = "(\\x5c#{text})"
47
+ qcontent = "(?:#{qtext}|#{quoted_pair})"
48
+ quoted_string = "[\"]#{qcontent}+[\"]"
49
+ atom = "#{atext}+"
50
+ word = "(?:#{atom}|#{quoted_string})"
51
+ obs_local_part = "#{word}([.]#{word})*"
52
+ local_part = "(?:#{dot_atom}|#{quoted_string}|#{obs_local_part})"
53
+ no_ws_ctl = "\\x01-\\x08\\x11\\x12\\x14-\\x1f\\x7f"
54
+ dtext = "[#{no_ws_ctl}\\x21-\\x5a\\x5e-\\x7e]"
55
+ dcontent = "(?:#{dtext}|#{quoted_pair})"
56
+ domain_literal = "\\[#{dcontent}+\\]"
57
+ obs_domain = "#{atom}([.]#{atom})*"
58
+ domain = "(?:#{dot_atom}|#{domain_literal}|#{obs_domain})"
59
+ addr_spec = "#{local_part}\@#{domain}"
60
+ pattern = /^#{addr_spec}$/
61
+ end
62
+
63
+ end # module Email
64
+ end # module Format
65
+ end # module Validation
66
+ end # module CouchRest
@@ -0,0 +1,43 @@
1
+ # Extracted from dm-validations 0.9.10
2
+ #
3
+ # Copyright (c) 2007 Guy van den Berg
4
+ #
5
+ # Permission is hereby granted, free of charge, to any person obtaining
6
+ # a copy of this software and associated documentation files (the
7
+ # "Software"), to deal in the Software without restriction, including
8
+ # without limitation the rights to use, copy, modify, merge, publish,
9
+ # distribute, sublicense, and/or sell copies of the Software, and to
10
+ # permit persons to whom the Software is furnished to do so, subject to
11
+ # the following conditions:
12
+ #
13
+ # The above copyright notice and this permission notice shall be
14
+ # included in all copies or substantial portions of the Software.
15
+ #
16
+ # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
+ # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18
+ # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
+ # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20
+ # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21
+ # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22
+ # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23
+
24
+ module CouchRest
25
+ module Validation
26
+ module Format
27
+ module Url
28
+
29
+ def self.included(base)
30
+ CouchRest::Validation::FormatValidator::FORMATS.merge!(
31
+ :url => [ Url, lambda { |field, value| '%s is not a valid URL'.t(value) }]
32
+ )
33
+ end
34
+
35
+ Url = begin
36
+ # Regex from http://www.igvita.com/2006/09/07/validating-url-in-ruby-on-rails/
37
+ /(^$)|(^(http|https):\/\/[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,5}(([0-9]{1,5})?\/.*)?$)/ix
38
+ end
39
+
40
+ end # module Url
41
+ end # module Format
42
+ end # module Validation
43
+ end # module CouchRest
@@ -0,0 +1,120 @@
1
+ # -*- coding: utf-8 -*-
2
+
3
+ # Extracted from dm-validations 0.9.10
4
+ #
5
+ # Copyright (c) 2007 Guy van den Berg
6
+ #
7
+ # Permission is hereby granted, free of charge, to any person obtaining
8
+ # a copy of this software and associated documentation files (the
9
+ # "Software"), to deal in the Software without restriction, including
10
+ # without limitation the rights to use, copy, modify, merge, publish,
11
+ # distribute, sublicense, and/or sell copies of the Software, and to
12
+ # permit persons to whom the Software is furnished to do so, subject to
13
+ # the following conditions:
14
+ #
15
+ # The above copyright notice and this permission notice shall be
16
+ # included in all copies or substantial portions of the Software.
17
+ #
18
+ # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
19
+ # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20
+ # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
21
+ # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
22
+ # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
23
+ # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
24
+ # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
25
+
26
+ module CouchRest
27
+ module Validation
28
+
29
+ # All validators extend this base class. Validators must:
30
+ #
31
+ # * Implement the initialize method to capture its parameters, also calling
32
+ # super to have this parent class capture the optional, general :if and
33
+ # :unless parameters.
34
+ # * Implement the call method, returning true or false. The call method
35
+ # provides the validation logic.
36
+ #
37
+ # @author Guy van den Berg
38
+ class GenericValidator
39
+
40
+ attr_accessor :if_clause, :unless_clause
41
+ attr_reader :field_name
42
+
43
+ # Construct a validator. Capture the :if and :unless clauses when present.
44
+ #
45
+ # @param field<String, Symbol> The property specified for validation
46
+ #
47
+ # @option :if<Symbol, Proc> The name of a method or a Proc to call to
48
+ # determine if the validation should occur.
49
+ # @option :unless<Symbol, Proc> The name of a method or a Proc to call to
50
+ # determine if the validation should not occur
51
+ # All additional key/value pairs are passed through to the validator
52
+ # that is sub-classing this GenericValidator
53
+ #
54
+ def initialize(field, opts = {})
55
+ @if_clause = opts.delete(:if)
56
+ @unless_clause = opts.delete(:unless)
57
+ end
58
+
59
+ # Add an error message to a target resource. If the error corresponds to a
60
+ # specific field of the resource, add it to that field, otherwise add it
61
+ # as a :general message.
62
+ #
63
+ # @param <Object> target the resource that has the error
64
+ # @param <String> message the message to add
65
+ # @param <Symbol> field_name the name of the field that caused the error
66
+ #
67
+ # TODO - should the field_name for a general message be :default???
68
+ #
69
+ def add_error(target, message, field_name = :general)
70
+ target.errors.add(field_name, message)
71
+ end
72
+
73
+ # Call the validator. "call" is used so the operation is BoundMethod and
74
+ # Block compatible. This must be implemented in all concrete classes.
75
+ #
76
+ # @param <Object> target the resource that the validator must be called
77
+ # against
78
+ # @return <Boolean> true if valid, otherwise false
79
+ def call(target)
80
+ raise NotImplementedError, "CouchRest::Validation::GenericValidator::call must be overriden in a subclass"
81
+ end
82
+
83
+ # Determines if this validator should be run against the
84
+ # target by evaluating the :if and :unless clauses
85
+ # optionally passed while specifying any validator.
86
+ #
87
+ # @param <Object> target the resource that we check against
88
+ # @return <Boolean> true if should be run, otherwise false
89
+ def execute?(target)
90
+ if unless_clause = self.unless_clause
91
+ if unless_clause.is_a?(Symbol)
92
+ return false if target.send(unless_clause)
93
+ elsif unless_clause.respond_to?(:call)
94
+ return false if unless_clause.call(target)
95
+ end
96
+ end
97
+
98
+ if if_clause = self.if_clause
99
+ if if_clause.is_a?(Symbol)
100
+ return target.send(if_clause)
101
+ elsif if_clause.respond_to?(:call)
102
+ return if_clause.call(target)
103
+ end
104
+ end
105
+
106
+ true
107
+ end
108
+
109
+ def ==(other)
110
+ self.class == other.class &&
111
+ self.field_name == other.field_name &&
112
+ self.class == other.class &&
113
+ self.if_clause == other.if_clause &&
114
+ self.unless_clause == other.unless_clause &&
115
+ self.instance_variable_get(:@options) == other.instance_variable_get(:@options)
116
+ end
117
+
118
+ end # class GenericValidator
119
+ end # module Validation
120
+ end # module CouchRest
@@ -0,0 +1,139 @@
1
+ # Extracted from dm-validations 0.9.10
2
+ #
3
+ # Copyright (c) 2007 Guy van den Berg
4
+ #
5
+ # Permission is hereby granted, free of charge, to any person obtaining
6
+ # a copy of this software and associated documentation files (the
7
+ # "Software"), to deal in the Software without restriction, including
8
+ # without limitation the rights to use, copy, modify, merge, publish,
9
+ # distribute, sublicense, and/or sell copies of the Software, and to
10
+ # permit persons to whom the Software is furnished to do so, subject to
11
+ # the following conditions:
12
+ #
13
+ # The above copyright notice and this permission notice shall be
14
+ # included in all copies or substantial portions of the Software.
15
+ #
16
+ # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
+ # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18
+ # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
+ # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20
+ # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21
+ # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22
+ # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23
+
24
+ module CouchRest
25
+ module Validation
26
+
27
+ ##
28
+ #
29
+ # @author Guy van den Berg
30
+ # @since 0.9
31
+ class LengthValidator < GenericValidator
32
+
33
+ def initialize(field_name, options)
34
+ super
35
+ @field_name = field_name
36
+ @options = options
37
+
38
+ @min = options[:minimum] || options[:min]
39
+ @max = options[:maximum] || options[:max]
40
+ @equal = options[:is] || options[:equals]
41
+ @range = options[:within] || options[:in]
42
+
43
+ @validation_method ||= :range if @range
44
+ @validation_method ||= :min if @min && @max.nil?
45
+ @validation_method ||= :max if @max && @min.nil?
46
+ @validation_method ||= :equals unless @equal.nil?
47
+ end
48
+
49
+ def call(target)
50
+ field_value = target.validation_property_value(field_name)
51
+ return true if @options[:allow_nil] && field_value.nil?
52
+
53
+ field_value = '' if field_value.nil?
54
+
55
+ # XXX: HACK seems hacky to do this on every validation, probably should
56
+ # do this elsewhere?
57
+ field = CouchRest.humanize(field_name)
58
+ min = @range ? @range.min : @min
59
+ max = @range ? @range.max : @max
60
+ equal = @equal
61
+
62
+ case @validation_method
63
+ when :range then
64
+ unless valid = @range.include?(field_value.size)
65
+ error_message = ValidationErrors.default_error_message(:length_between, field, min, max)
66
+ end
67
+ when :min then
68
+ unless valid = field_value.size >= min
69
+ error_message = ValidationErrors.default_error_message(:too_short, field, min)
70
+ end
71
+ when :max then
72
+ unless valid = field_value.size <= max
73
+ error_message = ValidationErrors.default_error_message(:too_long, field, max)
74
+ end
75
+ when :equals then
76
+ unless valid = field_value.size == equal
77
+ error_message = ValidationErrors.default_error_message(:wrong_length, field, equal)
78
+ end
79
+ end
80
+
81
+ error_message = @options[:message] || error_message
82
+
83
+ add_error(target, error_message, field_name) unless valid
84
+
85
+ return valid
86
+ end
87
+
88
+ end # class LengthValidator
89
+
90
+ module ValidatesLength
91
+
92
+ # Validates that the length of the attribute is equal to, less than,
93
+ # greater than or within a certain range (depending upon the options
94
+ # you specify).
95
+ #
96
+ # @option :allow_nil<Boolean> true/false (default is true)
97
+ # @option :minimum ensures that the attribute's length is greater than
98
+ # or equal to the supplied value
99
+ # @option :min alias for :minimum
100
+ # @option :maximum ensures the attribute's length is less than or equal
101
+ # to the supplied value
102
+ # @option :max alias for :maximum
103
+ # @option :equals ensures the attribute's length is equal to the
104
+ # supplied value
105
+ # @option :is alias for :equals
106
+ # @option :in<Range> given a Range, ensures that the attributes length is
107
+ # include?'ed in the Range
108
+ # @option :within<Range> alias for :in
109
+ #
110
+ # @example [Usage]
111
+ #
112
+ # class Page
113
+ #
114
+ # property high, Integer
115
+ # property low, Integer
116
+ # property just_right, Integer
117
+ #
118
+ # validates_length_of :high, :min => 100000000000
119
+ # validates_length_of :low, :equals => 0
120
+ # validates_length_of :just_right, :within => 1..10
121
+ #
122
+ # # a call to valid? will return false unless:
123
+ # # high is greater than or equal to 100000000000
124
+ # # low is equal to 0
125
+ # # just_right is between 1 and 10 (inclusive of both 1 and 10)
126
+ #
127
+ def validates_length_of(*fields)
128
+ opts = opts_from_validator_args(fields)
129
+ add_validator_to_context(opts, fields, CouchRest::Validation::LengthValidator)
130
+ end
131
+
132
+ def validates_length(*fields)
133
+ warn "[DEPRECATION] `validates_length` is deprecated. Please use `validates_length_of` instead."
134
+ validates_length_of(*fields)
135
+ end
136
+
137
+ end # module ValidatesLength
138
+ end # module Validation
139
+ end # module CouchRest
@@ -0,0 +1,89 @@
1
+ # Extracted from dm-validations 0.9.10
2
+ #
3
+ # Copyright (c) 2007 Guy van den Berg
4
+ #
5
+ # Permission is hereby granted, free of charge, to any person obtaining
6
+ # a copy of this software and associated documentation files (the
7
+ # "Software"), to deal in the Software without restriction, including
8
+ # without limitation the rights to use, copy, modify, merge, publish,
9
+ # distribute, sublicense, and/or sell copies of the Software, and to
10
+ # permit persons to whom the Software is furnished to do so, subject to
11
+ # the following conditions:
12
+ #
13
+ # The above copyright notice and this permission notice shall be
14
+ # included in all copies or substantial portions of the Software.
15
+ #
16
+ # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
+ # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18
+ # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
+ # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20
+ # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21
+ # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22
+ # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23
+
24
+ module CouchRest
25
+ module Validation
26
+
27
+ ##
28
+ #
29
+ # @author Guy van den Berg
30
+ # @since 0.9
31
+ class MethodValidator < GenericValidator
32
+
33
+ def initialize(field_name, options={})
34
+ super
35
+ @field_name, @options = field_name, options.clone
36
+ @options[:method] = @field_name unless @options.has_key?(:method)
37
+ end
38
+
39
+ def call(target)
40
+ result, message = target.send(@options[:method])
41
+ add_error(target, message, field_name) unless result
42
+ result
43
+ end
44
+
45
+ def ==(other)
46
+ @options[:method] == other.instance_variable_get(:@options)[:method] && super
47
+ end
48
+ end # class MethodValidator
49
+
50
+ module ValidatesWithMethod
51
+
52
+ ##
53
+ # Validate using the given method. The method given needs to return:
54
+ # [result::<Boolean>, Error Message::<String>]
55
+ #
56
+ # @example [Usage]
57
+ #
58
+ # class Page
59
+ #
60
+ # property :zip_code, String
61
+ #
62
+ # validates_with_method :in_the_right_location?
63
+ #
64
+ # def in_the_right_location?
65
+ # if @zip_code == "94301"
66
+ # return true
67
+ # else
68
+ # return [false, "You're in the wrong zip code"]
69
+ # end
70
+ # end
71
+ #
72
+ # # A call to valid? will return false and
73
+ # # populate the object's errors with "You're in the
74
+ # # wrong zip code" unless zip_code == "94301"
75
+ #
76
+ # # You can also specify field:
77
+ #
78
+ # validates_with_method :zip_code, :in_the_right_location?
79
+ #
80
+ # # it will add returned error message to :zip_code field
81
+ #
82
+ def validates_with_method(*fields)
83
+ opts = opts_from_validator_args(fields)
84
+ add_validator_to_context(opts, fields, CouchRest::Validation::MethodValidator)
85
+ end
86
+
87
+ end # module ValidatesWithMethod
88
+ end # module Validation
89
+ end # module CouchRest