json-spec 0.1.0

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "spec"
+  t.libs << "lib"
+  t.test_files = FileList['spec/**/*-spec.rb']
+end
+
+task :default => :test

data/api_documentation.md

@@ -0,0 +1,611 @@
+# API
+
+## Expressions on the root json expression
+
+### expect_an(:object)
+
+Expects a root object.
+
+```ruby
+expect_an(:object) do
+	...
+end
+```
+
+Example of expected json:
+
+```json
+{}
+```
+
+### expect_a(:list)
+
+Expects a root list.
+
+```ruby
+expect_a(:list) do
+	...
+end
+```
+
+Example of expected json:
+
+```json
+[]
+```
+
+### expect(:any_of)
+
+Expects one among many possible different root expressions.
+
+```ruby
+expect(:any_of)
+	...
+or_also()
+	...
+or_also()
+	...
+end
+```
+
+Example of expected json:
+
+```json
+{}
+or
+[]
+```
+
+## Expressions on an json object
+
+### expect(field_name) .to_be_a(:scalar)
+
+Expects a scalar on a field named field_name
+
+```ruby
+expect('id') .to_be_a(:scalar)
+```
+
+Example of expected json:
+
+```json
+{
+	"id": 123
+}
+```
+
+### expect(field_name) .to_be_an(:object)
+
+Expects an object on a field named field_name
+
+```ruby
+expect('user') .to_be_an(:object) do
+end
+```
+
+Example of expected json:
+
+```json
+{
+	"user": {
+		...
+	}
+}
+```
+
+### expect(field_name) .to_be_a(:list)
+
+Expects a list on a field named field_name
+
+```ruby
+expect(field_name) .to_be_a(:list) do
+	each do
+		...
+	end
+end
+```
+
+Example of expected json:
+
+```json
+{
+	"users": [
+		...
+	]
+}
+```
+
+### expect(field_name) .to_be(:any_of)
+
+Expects one among many possible different expressions on a field named field_name
+
+```ruby
+expect('object_or_list') .to_be(:any_of) do
+	expect_an(:object) do
+		...
+	end
+or_also
+	expect_a(:list) do
+		...
+	end
+end
+```
+
+Example of expected json:
+
+```json
+{
+	"object_or_list": {
+		...
+	}
+	or
+	"object_or_list": [
+		...
+	]
+}
+```
+
+### each_field
+
+Expects a name and an expression on every field of the object
+
+```ruby
+each_field
+	expect_name
+
+# one of the following expressions
+
+	expect(:anything)
+# or
+	expect_a(:scalar)
+# or
+	expect_an(:object) do
+		...
+	end
+# or
+	expect_a(:list) do
+		...
+	end
+# or
+	expect(:any_of) do
+		...
+	or_also
+		...
+	end
+end
+```
+
+Example of expected json:
+
+```json
+{
+	"id": 123
+	or
+	"id": []
+	or
+	"name": 123
+	or
+	"name": []
+	etc
+}
+```
+
+### expect(field_name) .to_be(:anything)
+
+Expects anything scalar on a field named field_name
+
+```ruby
+expect('name') .to_be(:anything)
+```
+
+Example of expected json:
+
+```json
+{
+	"name": "cabeza de termo"
+}
+```
+
+## Expressions on an json list
+
+### expect_a(:scalar)
+
+Expects a scalar on each item of a list
+
+```ruby
+json_list do
+	each do
+		expect_a(:scalar)
+	end
+end
+```
+
+Example of expected json:
+
+```json
+[
+	123
+]
+```
+
+### expect_an(:object)
+
+Expects an object on each item of a list
+
+```ruby
+json_list do
+	each do
+		expect_an(:object) do
+			...
+		end
+	end
+end
+```
+
+Example of expected json:
+
+```json
+[
+	{
+		...
+	}
+]
+```
+
+### expect_a(:list)
+
+Expects a list on each item of a list
+
+```ruby
+json_list do
+	each do
+		expect_a(:list) do
+			...
+		end
+	end
+end
+```
+
+Example of expected json:
+
+```json
+[
+	[
+		...
+	]
+]
+```
+
+### expect(:any_of)
+
+Expects one among many possible different expressions on each item of a list
+
+```ruby
+json_list do
+	each do
+		expect(:any_of)
+			expect_an(:object) do
+				...
+			end
+		or_also
+			expect_a(:list)
+				...
+			end
+		end
+	end
+end
+```
+
+Example of expected json:
+
+```json
+[
+	{
+		...
+	}
+	or
+	[
+		...
+	]
+]
+```
+
+## Library expectations
+
+### .to_exist
+
+Expects an expression to be present. 
+
+```ruby
+expect(...) .to_exist
+```
+
+### .to_be_absent
+
+Expects an expression not to be present. 
+
+```ruby
+expect(...) .to_be_absent
+```
+
+### .to_be_boolean
+
+Expects a value to be a boolean. 
+
+```ruby
+expect(...) .to_be_boolean
+```
+
+### .to_be_float
+
+Expects a value to be a float. 
+
+```ruby
+expect(...) .to_be_float
+```
+
+### .to_be_integer
+
+Expects a value to be an integer. 
+
+```ruby
+expect(...) .to_be_integer
+```
+
+### .to_be_list
+
+Expects a value to be a list. 
+
+```ruby
+expect(...) .to_be_list
+```
+
+### .to_be_number
+
+Expects a value to be an integer or a double. 
+
+```ruby
+expect(...) .to_be_number
+```
+
+### .to_be_scalar
+
+Expects a value to be a number, string, boolean or null. 
+
+```ruby
+expect(...) .to_be_scalar
+```
+
+### .to_be_object
+
+Expects a value to be an object.
+
+```ruby
+expect(...) .to_be_object
+```
+
+### .to_be_string
+
+Expects a value to be a string.
+
+```ruby
+expect(...) .to_be_string
+```
+
+### .to_be_null
+
+Expects a value to be null.
+
+```ruby
+expect(...) .to_be_null
+```
+
+### .not_null
+
+Expects a value not to be null.
+
+```ruby
+expect(...) .not_null
+```
+
+### .to_be_defined
+
+Expects a field to be present and be not null.
+
+```ruby
+expect(...) .to_be_defined
+```
+
+### .not_defined
+
+Expects a value to be null or to be absent.
+
+```ruby
+expect(...) .not_defined
+```
+
+### .to_be_empty
+
+- If the value is an object, expects the object to have no fields
+- If the value is a list, expects the list to have no items
+- If the value is a string, expects the string to be == ''
+- For any other type, raises an error
+
+```ruby
+expect(...) .to_be_empty
+```
+
+### .not_empty
+
+- If the value is an object, expects the object to have at least one field
+- If the value is a list, expects the list to have at least one item
+- If the value is a string, expects the string to have at least one character
+- For any other type, raises an error
+
+```ruby
+expect(...) .not_empty
+```
+
+### .to_be_blank
+
+Expects a value to be blank. Blank means having no printable characters, event if its not empty.
+
+```ruby
+expect(...) .to_be_blank
+```
+
+### .not_blank
+
+Expects a value not to be blank. Not blank means having at least one printable character.
+
+```ruby
+expect(...) .not_blank
+```
+
+### .to_be_equal_to(expected_value)
+
+Expects a value to be equal to the expected_value.
+
+```ruby
+expect(...) ..to_be_equal_to(42)
+```
+
+### .not_equal_to(expected_value)
+
+Expects a value not to be equal to the expected_value.
+
+```ruby
+expect(...) .not_equal_to(42)
+```
+
+### .to_match(pattern)
+
+Expects a value to match the regular expression pattern.
+
+```ruby
+expect(...) .to_match(/[\d]+^/)
+```
+
+### .not_to_match(pattern)
+
+Expects a value not to match the regular expression pattern.
+
+```ruby
+expect(...) .not_to_match(/[\d]+^/)
+```
+
+### .to_be_string_as_integer
+
+Expects a value to be an integer string.
+
+```ruby
+expect(...) .to_be_string_as_integer
+```
+
+### .to_be_string_as_double
+
+Expects a value to be a double string.
+
+```ruby
+expect(...) .to_be_string_as_double
+```
+
+### .to_be_in
+
+Expects a value to be equal to any value of an array of values.
+
+```ruby
+expect(...) .to_be_in([1, 2, 3])
+```
+
+### .not_in
+
+Expects a value to be different to all the values of an array of values.
+
+```ruby
+expect(...) .not_in([1, 2, 3])
+```
+
+### .to_be_email
+
+Expects a value to be a valid email string.
+
+```ruby
+expect(...) .to_be_email
+```
+
+### .to_be_url
+
+Expects a value to be a valid url string.
+
+```ruby
+expect(...) .to_be_url
+```
+
+### .to_be_in_range
+
+Expects a value to be in a range.
+
+```ruby
+expect(...) .to_be_in_range( CabezaDeTermo::JsonSpec::Range.newFrom('(', 0, 10, ']') )
+```
+
+### .not_in_range
+
+Expects a value not to be in a range.
+
+```ruby
+expect(...) .not_in_range( CabezaDeTermo::JsonSpec::Range.newFrom('(', 0, 10, ']') )
+```
+
+### .to_be_between
+
+Expects a value to be between 2 values, including them.
+
+```ruby
+expect(...) .to_be_between(0, 10)
+```
+
+### .not_between
+
+Expects a value not to be between 2 values, including them.
+
+```ruby
+expect(...) .not_between(0, 10)
+```
+
+### .can_be_absent
+
+Allow a field to be absent without failing the expectation.
+
+If the field is absent, stop running other expectations for that field.
+
+If present, run the rest of the expectations on that value.
+
+```ruby
+expect(...) .can_be_absent .to_be_equal_to(42)
+```
+
+### .can_be_null
+
+Allow a value to be null without failing the expectation.
+
+If the value is null, stop running other expectations for that value.
+
+If present, run the rest of the expectations on that value.
+
+```ruby
+expect(...) .can_be_null .to_be_equal_to(42)
+```
+
+### .can_be_undefined
+
+Allow a field to be absent or its value to be null without failing the expectation.
+
+If the field is absent or its value is null, stop running other expectations for that value.
+
+If the field is present and its value is not null, run the rest of the expectations on that value.
+
+```ruby
+expect(...) .can_be_undefined .to_be_equal_to(42)
+```