respect 0.1.0

data/test/boolean_schema_test.rb

@@ -0,0 +1,89 @@
+require "test_helper"
+
+class BooleanSchemaTest < Test::Unit::TestCase
+  def test_boolean_schema_validate_type
+    [
+      [ "42", nil, "integer in string" ],
+      [ { "test" => 42 }, nil, "hash" ],
+      [ "true", true, "valid true value" ],
+      [ "false", false, "valid false value" ],
+      [ true, true, "true" ],
+      [ false, false, "false" ],
+      [ "nil", nil, "nil in string" ],
+    ].each do |data|
+      s = Respect::BooleanSchema.new
+      # Check validate_type
+      if data[1].nil?
+        assert_raise(Respect::ValidationError) do
+          s.validate_type(data[0])
+        end
+      else
+        assert_equal data[1], s.validate_type(data[0]), data[2]
+      end
+      # Check sanitized_object
+      assert_nil s.sanitized_object
+      assert_schema_validation_is (data[1].nil? ? false : true), s, data[0], data[2]
+      unless data[1].nil?
+        assert_equal data[1], s.sanitized_object, data[2]
+      end
+    end
+  end
+
+  def test_boolean_schema_accept_constraint_equal_to
+    s_true = Respect::BooleanSchema.new equal_to: true
+    assert_schema_validation_is true, s_true, "true"
+    assert_schema_validation_is false, s_true, "false"
+
+    s_false = Respect::BooleanSchema.new equal_to: false
+    assert_schema_validation_is false, s_false, "true"
+    assert_schema_validation_is true, s_false, "false"
+  end
+
+  def test_failed_validation_reset_sanitized_object
+    s = Respect::BooleanSchema.define equal_to: true
+    assert_schema_validate(s, true)
+    assert_equal(true, s.sanitized_object)
+    assert_schema_invalidate(s, false)
+    assert_equal(nil, s.sanitized_object)
+  end
+
+  def test_allow_nil
+    s = Respect::BooleanSchema.new(allow_nil: true)
+    assert_schema_validate s, nil
+    assert_equal(nil, s.sanitized_object)
+    assert_schema_validate s, true
+    assert_equal(true, s.sanitized_object)
+    assert_schema_validate s, false
+    assert_equal(false, s.sanitized_object)
+    assert_schema_validate s, "true"
+    assert_equal(true, s.sanitized_object)
+    assert_schema_validate s, "false"
+    assert_equal(false, s.sanitized_object)
+  end
+
+  def test_disallow_nil
+    s = Respect::BooleanSchema.new
+    assert !s.allow_nil?
+    exception = assert_exception(Respect::ValidationError) { s.validate(nil) }
+    assert_match exception.message, /\bBooleanSchema\b/
+    assert_equal(nil, s.sanitized_object)
+    assert_schema_validate s, true
+    assert_equal(true, s.sanitized_object)
+    assert_schema_validate s, false
+    assert_equal(false, s.sanitized_object)
+    assert_schema_validate s, "true"
+    assert_equal(true, s.sanitized_object)
+    assert_schema_validate s, "false"
+    assert_equal(false, s.sanitized_object)
+  end
+
+  def test_allow_nil_with_constraint
+    s = Respect::BooleanSchema.new(allow_nil: true, equal_to: false)
+    assert_schema_validate s, nil
+    assert_equal(nil, s.sanitized_object)
+    assert_schema_validate s, false
+    assert_equal(false, s.sanitized_object)
+    assert_schema_invalidate s, true
+    assert_equal(nil, s.sanitized_object)
+  end
+end

data/test/composite_schema_test.rb

@@ -0,0 +1,30 @@
+require "test_helper"
+
+class CompositeSchemaTest < Test::Unit::TestCase
+  def test_failed_validation_reset_sanitized_object
+    s = Respect::PointSchema.new
+    assert_schema_validate(s, { x: 42.5, y: 51.3 })
+    assert_equal(Point.new(42.5, 51.3), s.sanitized_object)
+    assert_schema_invalidate(s, { x: 42.5 })
+    assert_equal(nil, s.sanitized_object)
+  end
+
+  def test_allow_nil
+    s = Respect::PointSchema.new(allow_nil: true)
+    assert s.allow_nil?
+    assert_schema_validate s, nil
+    assert_equal(nil, s.sanitized_object)
+    assert_schema_validate(s, { x: 42.5, y: 51.3 })
+    assert_equal(Point.new(42.5, 51.3), s.sanitized_object)
+  end
+
+  def test_disallow_nil
+    s = Respect::PointSchema.new
+    assert !s.allow_nil?
+    exception = assert_exception(Respect::ValidationError) { s.validate(nil) }
+    assert_match exception.message, /\bPointSchema\b/
+    assert_equal(nil, s.sanitized_object)
+    assert_schema_validate(s, { x: 42.5, y: 51.3 })
+    assert_equal(Point.new(42.5, 51.3), s.sanitized_object)
+  end
+end

data/test/datetime_schema_test.rb

@@ -0,0 +1,83 @@
+require "test_helper"
+
+class DatetimeSchemaTest < Test::Unit::TestCase
+
+  def test_datetime_schema_creates_datetime_object
+    s = Respect::DatetimeSchema.new
+    assert_nil s.sanitized_object
+    assert_schema_validate s, "2013-12-01T00:00:00+00:00"
+    assert s.sanitized_object.is_a?(DateTime)
+    assert_equal DateTime.rfc3339("2013-12-01T00:00:00+00:00"), s.sanitized_object
+  end
+
+  def test_datetime_schema_relies_on_format_validator
+    doc = "2013-12-01T00:00:00+00:00"
+    Respect::FormatValidator.any_instance.stubs(:validate_datetime).with(doc).at_least_once
+    Respect::DatetimeSchema.new.validate(doc)
+  end
+
+  def test_datetime_schema_validate_iso8601
+    t = Time.now.to_datetime
+    s = Respect::DatetimeSchema.new
+    assert_schema_validate(s, t.iso8601)
+    assert_equal t.to_time.to_i, s.sanitized_object.to_time.to_i
+  end
+
+  def test_failed_validation_reset_sanitized_object
+    s = Respect::DatetimeSchema.new
+    assert_schema_validate(s, "2013-12-01T00:00:00+00:00")
+    assert_not_nil(s.sanitized_object)
+    assert_schema_invalidate(s, "wrong")
+    assert_nil(s.sanitized_object)
+  end
+
+  def test_allow_nil
+    s = Respect::DatetimeSchema.new(allow_nil: true)
+    assert s.allow_nil?
+    assert_schema_validate s, nil
+    assert_equal(nil, s.sanitized_object)
+    assert_schema_validate s, "2013-12-01T00:00:00+00:00"
+    assert_not_nil(s.sanitized_object)
+    assert_schema_invalidate(s, "wrong")
+    assert_nil(s.sanitized_object)
+  end
+
+  def test_disallow_nil
+    s = Respect::DatetimeSchema.new
+    assert !s.allow_nil?
+    exception = assert_exception(Respect::ValidationError) { s.validate(nil) }
+    assert_match exception.message, /\bDatetimeSchema\b/
+    assert_equal(nil, s.sanitized_object)
+    assert_schema_validate s, "2013-12-01T00:00:00+00:00"
+    assert_not_nil(s.sanitized_object)
+    assert_schema_invalidate(s, "wrong")
+    assert_nil(s.sanitized_object)
+  end
+
+  def test_validate_datetime_object
+    s = Respect::DatetimeSchema.new
+    t = Time.now.to_datetime
+    assert_equal(DateTime, t.class)
+    assert_schema_validate s, t
+    assert_equal DateTime, s.sanitized_object.class
+    assert_equal t, s.sanitized_object
+  end
+
+  def test_validate_time_object
+    s = Respect::DatetimeSchema.new
+    t = Time.now
+    assert_equal(Time, t.class)
+    assert_schema_validate s, t
+    assert_equal DateTime, s.sanitized_object.class
+    assert_equal t.to_datetime, s.sanitized_object
+  end
+
+  def test_validate_date_object
+    s = Respect::DatetimeSchema.new
+    t = Time.now.to_date
+    assert_equal(Date, t.class)
+    assert_schema_validate s, t
+    assert_equal Date, s.sanitized_object.class
+    assert_equal t.to_date, s.sanitized_object
+  end
+end

data/test/doc_helper_test.rb

@@ -0,0 +1,34 @@
+require "test_helper"
+
+class DocHelperTest < Test::Unit::TestCase
+  def test_schema_title_use_doc_parser
+    object = mock()
+    object.extend(Respect::DocHelper)
+    doc = "Hey!"
+    doc.expects(:to_s).returns(doc).once
+    object.stubs(:documentation).returns(doc)
+    Respect::DocParser.any_instance.stubs(:parse).with(doc).returns(Respect::DocParser.new).at_least_once
+    Respect::DocParser.any_instance.stubs(:title).returns("title").at_least_once
+    assert_equal "title", object.title
+  end
+
+  def test_schema_description_use_doc_parser
+    object = mock()
+    object.extend(Respect::DocHelper)
+    doc = "Hey!"
+    doc.expects(:to_s).returns(doc).once
+    object.stubs(:documentation).returns(doc)
+    Respect::DocParser.any_instance.stubs(:parse).with(doc).returns(Respect::DocParser.new).at_least_once
+    Respect::DocParser.any_instance.stubs(:description).returns("desc").at_least_once
+    assert_equal "desc", object.description
+  end
+
+  def test_nil_title_and_description_if_nil_doc
+    object = mock()
+    object.extend(Respect::DocHelper)
+    object.stubs(:documentation).returns(nil)
+    assert_nil object.documentation
+    assert_nil object.title
+    assert_nil object.description
+  end
+end

data/test/doc_parser_test.rb

@@ -0,0 +1,109 @@
+require "test_helper"
+
+class DocParserTest < Test::Unit::TestCase
+  def setup
+    @parser = Respect::DocParser.new
+  end
+
+  def test_full_doc
+    doc = <<-EOS.strip_heredoc
+      A title.
+
+      A description.
+      A long description.
+      EOS
+    @parser.parse(doc)
+    assert_equal "A title.", @parser.title
+    assert_equal "A description.\nA long description.\n", @parser.description
+  end
+
+  def test_no_title
+    doc = <<-EOS.strip_heredoc
+      A description.
+      A long description.
+      EOS
+    @parser.parse(doc)
+    assert_equal nil, @parser.title
+    assert_equal "A description.\nA long description.\n", @parser.description
+  end
+
+  def test_no_desc
+    doc = <<-EOS.strip_heredoc
+      A title.
+      EOS
+    @parser.parse(doc)
+    assert_equal "A title.", @parser.title
+    assert_equal nil, @parser.description
+  end
+
+  def test_no_desc_and_no_newline
+    doc = <<-EOS.strip_heredoc
+      A title.
+
+      A sparse...
+
+      ... description.
+      EOS
+    @parser.parse(doc)
+    assert_equal "A title.", @parser.title
+    desc = <<-EOS.strip_heredoc
+      A sparse...
+
+      ... description.
+      EOS
+    assert_equal desc, @parser.description
+  end
+
+  def test_no_title_but_long_desc
+    doc = <<-EOS.strip_heredoc
+      A first paragraph...
+      ...on several lines.
+
+      A second one...
+      ... on several lines.
+
+
+      And a far away third one...
+      ... on several lines.
+      EOS
+    @parser.parse(doc)
+    assert_equal nil, @parser.title
+    assert_equal doc, @parser.description
+  end
+
+  def test_title_and_empty_desc
+    doc = <<-EOS.strip_heredoc
+      A title with many empty line for desc
+
+
+
+
+      EOS
+    @parser.parse(doc)
+    assert_equal "A title with many empty line for desc", @parser.title
+    assert_equal nil, @parser.description
+  end
+
+  def test_title_separated_by_desc_with_many_lines
+    doc = <<-EOS.strip_heredoc
+      A title with many empty line for desc
+
+
+
+
+      The description finally...
+      come.
+      EOS
+    @parser.parse(doc)
+    assert_equal "A title with many empty line for desc", @parser.title
+    assert_equal "The description finally...\ncome.\n", @parser.description
+  end
+
+  def test_title_with_no_newline
+    doc = "a title"
+    @parser.parse(doc)
+    assert_equal "a title", @parser.title
+    assert_equal nil, @parser.description
+  end
+
+end

data/test/dsl_dumper_test.rb

@@ -0,0 +1,395 @@
+require "test_helper"
+
+class DslDumperTest < Test::Unit::TestCase
+  def test_dump_nested_hashs
+    assert_bijective_dump do
+      <<-EOF.strip_heredoc
+      Respect::Schema.define do |s|
+        s.hash do |s|
+          s.hash "o" do |s|
+            s.integer "i"
+          end
+        end
+      end
+      EOF
+    end
+  end
+
+  def test_dump_hash_with_multiple_integer
+    assert_bijective_dump do
+      <<-EOF.strip_heredoc
+      Respect::Schema.define do |s|
+        s.hash do |s|
+          s.integer "i1"
+          s.integer "i2"
+          s.integer "i3"
+        end
+      end
+      EOF
+    end
+  end
+
+  def test_dump_nested_hash_with_multiple_integer
+    assert_bijective_dump do
+      <<-EOF.strip_heredoc
+      Respect::Schema.define do |s|
+        s.hash do |s|
+          s.hash "o1" do |s|
+            s.integer "i1"
+            s.integer "i2"
+            s.integer "i3"
+          end
+          s.hash "o2" do |s|
+            s.integer "i1"
+            s.integer "i2"
+            s.integer "i3"
+          end
+          s.hash "o3" do |s|
+            s.integer "i1"
+            s.integer "i2"
+            s.integer "i3"
+          end
+        end
+      end
+      EOF
+    end
+  end
+
+  def test_property_name_are_escaped
+    assert_bijective_dump do
+      <<-EOF.strip_heredoc
+      Respect::Schema.define do |s|
+        s.hash do |s|
+          s.string "s\\""
+        end
+      end
+      EOF
+    end
+  end
+
+  def test_dump_terminal_statement
+    PRIMITIVE_STATEMENTS_LIST.each do |statement|
+      assert_bijective_dump("dump statement #{statement}") do
+        <<-EOF.strip_heredoc
+        Respect::Schema.define do |s|
+          s.hash do |s|
+            s.#{statement} "property_name"
+          end
+        end
+        EOF
+      end
+    end
+  end
+
+  def test_dump_array_item
+    PRIMITIVE_STATEMENTS_LIST.each do |statement|
+      assert_bijective_dump("dump statement #{statement}") do
+        <<-EOF.strip_heredoc
+        Respect::Schema.define do |s|
+          s.array do |s|
+            s.#{statement}
+          end
+        end
+        EOF
+      end
+    end
+  end
+
+  def test_dump_array_items
+    PRIMITIVE_STATEMENTS_LIST.each do |statement|
+      assert_bijective_dump("dump statement #{statement}") do
+        <<-EOF.strip_heredoc
+        Respect::Schema.define do |s|
+          s.array do |s|
+            s.items do |s|
+              s.#{statement}
+              s.#{statement}
+            end
+          end
+        end
+        EOF
+      end
+    end
+  end
+
+  def test_dump_array_extra_items
+    PRIMITIVE_STATEMENTS_LIST.each do |statement|
+      assert_bijective_dump("dump statement #{statement}") do
+        <<-EOF.strip_heredoc
+        Respect::Schema.define do |s|
+          s.array do |s|
+            s.extra_items do |s|
+              s.#{statement}
+              s.#{statement}
+            end
+          end
+        end
+        EOF
+      end
+    end
+  end
+
+  def test_dump_array_items_and_extra_items
+    PRIMITIVE_STATEMENTS_LIST.each do |statement|
+      assert_bijective_dump("dump statement #{statement}") do
+        <<-EOF.strip_heredoc
+        Respect::Schema.define do |s|
+          s.array do |s|
+            s.items do |s|
+              s.#{statement}
+              s.#{statement}
+              s.#{statement}
+            end
+            s.extra_items do |s|
+              s.#{statement}
+              s.#{statement}
+              s.#{statement}
+            end
+          end
+        end
+        EOF
+      end
+    end
+  end
+
+  def test_dump_nested_array_with_item
+    assert_bijective_dump do
+      <<-EOF.strip_heredoc
+      Respect::Schema.define do |s|
+        s.array do |s|
+          s.array do |s|
+            s.array do |s|
+              s.array do |s|
+                s.array do |s|
+                  s.integer
+                end
+              end
+            end
+          end
+        end
+      end
+      EOF
+    end
+  end
+
+  def test_dump_nested_array_with_items
+    assert_bijective_dump do
+      <<-EOF.strip_heredoc
+      Respect::Schema.define do |s|
+        s.array do |s|
+          s.items do |s|
+            s.integer
+            s.array do |s|
+              s.items do |s|
+                s.integer
+                s.array do |s|
+                  s.integer
+                end
+              end
+            end
+          end
+        end
+      end
+      EOF
+    end
+  end
+
+  def test_dump_nested_array_with_extra_items
+    assert_bijective_dump do
+      <<-EOF.strip_heredoc
+      Respect::Schema.define do |s|
+        s.array do |s|
+          s.extra_items do |s|
+            s.integer
+            s.array do |s|
+              s.extra_items do |s|
+                s.integer
+                s.array do |s|
+                  s.integer
+                end
+              end
+            end
+          end
+        end
+      end
+      EOF
+    end
+  end
+
+  def test_dump_nested_array_and_hash
+    assert_bijective_dump do
+      <<-EOF.strip_heredoc
+      Respect::Schema.define do |s|
+        s.array do |s|
+          s.hash do |s|
+            s.integer "i"
+            s.array "a" do |s|
+              s.hash do |s|
+                s.integer "i"
+                s.array "a" do |s|
+                  s.integer
+                end
+                s.string "s"
+              end
+            end
+            s.string "s"
+          end
+        end
+      end
+      EOF
+    end
+  end
+
+  def test_dump_terminal_schema
+    PRIMITIVE_STATEMENTS_LIST.each do |statement|
+      assert_bijective_dump("dump statement #{statement}") do
+        <<-EOF.strip_heredoc
+        Respect::Schema.define do |s|
+          s.#{statement}
+        end
+        EOF
+      end
+    end
+  end
+
+  def test_dump_format_helper_statement
+    FORMAT_HELPER_STATEMENTS_LIST.each do |statement|
+      schema = Respect::Schema.define do |s|
+        s.__send__(statement)
+      end
+      expected_result = <<-EOF.strip_heredoc
+        Respect::Schema.define do |s|
+          s.string :format => #{statement.inspect}
+        end
+      EOF
+      assert_equal(expected_result,
+        Respect::DslDumper.new(schema).dump,
+        "dump for statement #{statement}")
+    end
+  end
+
+  def test_dump_statement_with_no_names_and_several_options
+    assert_bijective_dump do
+      <<-EOF.strip_heredoc
+      Respect::Schema.define do |s|
+        s.integer :greater_than => 42, :equal_to => 51
+      end
+      EOF
+    end
+  end
+
+  def test_dump_statement_with_name_and_several_options
+    assert_bijective_dump do
+      <<-EOF.strip_heredoc
+      Respect::Schema.define do |s|
+        s.hash do |s|
+          s.integer "an_int", :greater_than => 42, :equal_to => 51
+        end
+      end
+      EOF
+    end
+  end
+
+  def test_dump_statement_with_name_and_no_options
+    assert_bijective_dump do
+      <<-EOF.strip_heredoc
+      Respect::Schema.define do |s|
+        s.hash do |s|
+          s.integer "an_int"
+        end
+      end
+      EOF
+    end
+  end
+
+  def test_dump_primitive_statement_documentation
+    PRIMITIVE_STATEMENTS_LIST.each do |statement|
+      assert_bijective_dump("dump statement #{statement}") do
+        <<-EOF.strip_heredoc
+        Respect::Schema.define do |s|
+          s.doc <<-EOS.strip_heredoc
+            a title
+
+            a description
+            EOS
+          s.#{statement}
+        end
+        EOF
+      end
+    end
+  end
+
+  def test_dump_primitive_statement_with_no_description
+    PRIMITIVE_STATEMENTS_LIST.each do |statement|
+      assert_bijective_dump("dump statement #{statement}") do
+        <<-EOF.strip_heredoc
+        Respect::Schema.define do |s|
+          s.doc "a title"
+          s.#{statement}
+        end
+        EOF
+      end
+    end
+  end
+
+  def test_dump_primitive_statement_with_no_title
+    PRIMITIVE_STATEMENTS_LIST.each do |statement|
+      assert_bijective_dump("dump statement #{statement}") do
+        <<-EOF.strip_heredoc
+        Respect::Schema.define do |s|
+          s.doc <<-EOS.strip_heredoc
+            a long...
+            ... description
+            EOS
+          s.#{statement}
+        end
+        EOF
+      end
+    end
+  end
+
+  def test_dump_hash_documentation
+    assert_bijective_dump do
+      <<-EOF.strip_heredoc
+      Respect::Schema.define do |s|
+        s.doc <<-EOS.strip_heredoc
+          a title
+
+          a description
+          EOS
+        s.hash do |s|
+          s.integer "i"
+          s.string "s"
+        end
+      end
+      EOF
+    end
+  end
+
+  def test_dump_array_documentation
+    assert_bijective_dump do
+      <<-EOF.strip_heredoc
+      Respect::Schema.define do |s|
+        s.doc <<-EOS.strip_heredoc
+          a title
+
+          a description
+          EOS
+        s.array do |s|
+          s.integer
+        end
+      end
+      EOF
+    end
+  end
+
+  private
+
+  def assert_bijective_dump(message = nil, &block)
+    source = block.call
+    schema = eval(source, block.binding,
+      block.source_location.first, block.source_location[1] + 2)
+    assert schema.is_a?(Respect::Schema), "#{schema.class} should Respect::Schema"
+    assert_equal(source, Respect::DslDumper.new(schema).dump, message)
+  end
+end