collection_json_serializer 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 439dfa592c9b1ac966e6c86e50e2985a6ef0b884
-  data.tar.gz: af50517d57b2d5aa271afc8d6b8e67ea44ed0c48
+  metadata.gz: a43d5f7a36d702aceb4fd3bdd71ff86da64e027c
+  data.tar.gz: 12b188b39d695b9e1edbef6cc7285b3990a7c572
 SHA512:
-  metadata.gz: fa4f479a2761f955b16e14148eae97fdd03a0f3c916d6a9bd7efcd2032fe0971a06c084520d64d10ef417208d6de64efa480c3e5197ae605fbffb3e569d57565
-  data.tar.gz: ced4ab1f38846231334b103d6ecf74ff07246aeeda66bb37e12fa511aaf1ba157d620e743c8e7ee153ff777cf1a32084a768a54e047f3148b3c630de54d358fb
+  metadata.gz: 48434f77b5c372f61c7b4919c1389fc85e10e3e834a0a8f17ae1594d77af316c2b5d4af5e1c5e2ff4201db2d4a8e5e2215e34c3bcaa0bf695c395630c28e8ef9
+  data.tar.gz: ad03089d4119b6e799274cba090f4d5e6909553ad12e49347b48220607ca188ef8275521ca80caf0448345580faeafe2cf12813c07d45a917168833d30cba57e

data/README.md

@@ -30,7 +30,10 @@ As this gem user, you will be mainly writing/generating and mantaining serialize
 class UserSerializer < CollectionJson::Serializer
   href "http://example.com/users",
 
-  template :name, email: { prompt: "My email" }
+  template :name
+  template email: { prompt: "My email" }
+  # This could be written in a single line, too, wrapping the hash:
+  # template :name, { email: { ... } }
 
   # Please note that links can only be passed as hashes
   links dashboard: { href: "http://example.com/my-dashboard" }

data/collection_json_serializer.gemspec

@@ -12,6 +12,7 @@ Gem::Specification.new do |spec|
   spec.description   = %q{CollectionJson::Serializer makes it easy to serialize objects into the Collection+JSON hypermedia type.}
   spec.homepage      = "https://github.com/carlesjove/collection_json_serializer"
   spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.0"
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }

data/lib/collection_json_serializer.rb

@@ -10,9 +10,11 @@ require "collection_json_serializer/items"
 require "collection_json_serializer/spec"
 require "collection_json_serializer/builder"
 
+require "collection_json_serializer/validator/base"
 require "collection_json_serializer/validator"
-require "collection_json_serializer/validator/url"
-require "collection_json_serializer/validator/value"
+require "collection_json_serializer/validator/items_validator"
+require "collection_json_serializer/validator/types/url"
+require "collection_json_serializer/validator/types/value"
 
 require "collection_json_serializer/objects/item"
 require "collection_json_serializer/objects/template"

data/lib/collection_json_serializer/validator.rb

@@ -1,24 +1,8 @@
 module CollectionJson
   class Serializer
-    class Validator
+    class Validator < Validation
       include CollectionJson::Serializer::Support
 
-      attr_accessor :errors
-
-      def initialize(serializer)
-        @serializer = serializer
-        @errors = {}
-        validate
-      end
-
-      def valid?
-        !invalid?
-      end
-
-      def invalid?
-        @errors.any?
-      end
-
       private
 
       def validate
@@ -32,57 +16,8 @@ module CollectionJson
       end
 
       def validate_items
-        validate_items_attributes   if attributes?
-        validate_items_links        if links?
-      end
-
-      def validate_items_attributes
-        @serializer.items.attributes.each do |attr|
-          params = attr.extract_params
-          validate_attributes_values(@serializer.resources, params)
-          validate_attributes_properties(params) if params[:properties]
-        end if @serializer.items? && @serializer.items.attributes?
-      end
-
-      def validate_attributes_values(resources, params)
-        resources.each do |resource|
-          val = extract_value_from(resource, params[:name])
-          if value_is_invalid?(val)
-            error_for :value, root: :attributes, path: [params[:name]]
-          end
-        end
-      end
-
-      def validate_attributes_properties(params)
-        params[:properties].each do |key, value|
-          unless definition[:items][:data].keys.include?(key.to_sym)
-            error_for(
-              :unknown_attribute,
-              root: :attributes,
-              path: [params[:name], key]
-            )
-            next
-          end unless @serializer.uses?(:open_attrs)
-
-          if value_is_invalid?(value)
-            error_for :value, root: :attributes, path: [params[:name], key]
-          end
-        end
-      end
-
-      def validate_items_links
-        @serializer.items.links.each do |attr|
-          params = attr.extract_params
-          params[:properties].keys.each do |key|
-            unless definition[:items][:links].keys.include?(key.to_sym)
-              error_for(
-                :unknown_attribute,
-                root: :items,
-                path: [:links, params[:name], key]
-              )
-            end unless @serializer.uses?(:open_attrs)
-          end
-        end
+        items_validation = ItemsValidator.new(@serializer)
+        @errors.merge!(items_validation.errors)
       end
 
       def validate_href
@@ -199,49 +134,6 @@ module CollectionJson
           end
         end if @serializer.queries.present?
       end
-
-      def value_is_invalid?(value)
-        v = CollectionJson::Serializer::Validator::Value.new(value)
-        v.invalid?
-      end
-
-      def url_is_invalid?(value)
-        v = CollectionJson::Serializer::Validator::Url.new(value)
-        v.invalid?
-      end
-
-      def error_for(kind, root: root, path: [])
-        case kind.to_sym
-        when :url
-          ending = " is an invalid URL"
-        when :value
-          ending = " is an invalid value"
-        when :missing_attribute
-          ending = " is missing"
-        when :unknown_attribute
-          ending = " is an unknown attribute"
-        else
-          ending = " is an invalid value"
-        end
-
-        @errors[root] = [] unless @errors.key? root
-        e = "#{@serializer.class} #{root}"
-        e << ":" + path.join(":") if path.any?
-        e << ending
-        @errors[root] << e
-      end
-
-      def definition
-        CollectionJson::Spec::DEFINITION
-      end
-
-      def attributes?
-        @serializer.items? && @serializer.items.attributes?
-      end
-
-      def links?
-        @serializer.items? && @serializer.items.links?
-      end
     end
   end
 end

data/lib/collection_json_serializer/validator/base.rb

@@ -0,0 +1,69 @@
+module CollectionJson
+  class Serializer
+    class Validation
+      attr_accessor :errors
+
+      def initialize(serializer)
+        @serializer = serializer
+        @errors = {}
+        validate
+      end
+
+      def valid?
+        !invalid?
+      end
+
+      def invalid?
+        @errors.any?
+      end
+
+      private
+
+      def validate
+        raise NotImplementedError, "This should be implemented by validators"
+      end
+
+      def definition
+        CollectionJson::Spec::DEFINITION
+      end
+
+      def value_is_invalid?(value)
+        v = Value.new(value)
+        v.invalid?
+      end
+
+      def url_is_invalid?(value)
+        v = Url.new(value)
+        v.invalid?
+      end
+
+      def href_or_error(object, root: root, path: path)
+        unless object.key?(:href)
+          error_for :missing_attribute, root: root, path: path
+        end
+      end
+
+      def error_for(kind, root: root, path: [])
+        case kind.to_sym
+        when :url
+          ending = " is an invalid URL"
+        when :value
+          ending = " is an invalid value"
+        when :missing_attribute
+          ending = " is missing"
+        when :unknown_attribute
+          ending = " is an unknown attribute"
+        else
+          ending = " is an invalid value"
+        end
+
+        @errors[root] = [] unless @errors.key? root
+        e = "#{@serializer.class} #{root}"
+        e << ":" + path.join(":") if path.any?
+        e << ending
+        @errors[root] << e
+      end
+    end
+  end
+end
+

data/lib/collection_json_serializer/validator/items_validator.rb

@@ -0,0 +1,100 @@
+module CollectionJson
+  class Serializer
+    class Validator
+      class ItemsValidator < Validation
+        include CollectionJson::Serializer::Support
+
+        private
+
+        def validate
+          validate_attributes   if attributes?
+          validate_links        if links?
+        end
+
+        def validate_attributes
+          @serializer.items.attributes.each do |attr|
+            params = attr.extract_params
+            validate_attributes_values(@serializer.resources, params)
+            validate_attributes_properties(params) if params[:properties]
+          end if @serializer.items? && @serializer.items.attributes?
+        end
+
+        def validate_links
+          @serializer.items.links.each do |attr|
+            link = attr.extract_params
+
+            href_or_error(
+              link[:properties],
+              root: :items,
+              path: [link[:name]]
+            )
+
+            link[:properties].each do |key, value|
+              unless definition[:items][:links].keys.include?(key.to_sym)
+                error_for(
+                  :unknown_attribute,
+                  root: :items,
+                  path: [:links, link[:name], key]
+                )
+              end unless @serializer.uses?(:open_attrs)
+
+              case key
+              when :href
+                if url_is_invalid?(value)
+                  error_for(
+                    :url,
+                    root: :items,
+                    path: [:links, link[:name], key]
+                  )
+                end
+              else
+                if value_is_invalid?(value)
+                  error_for(
+                    :value,
+                    root: :items,
+                    path: [:links, link[:name], key]
+                  )
+                end
+              end
+            end
+          end
+        end
+
+        def validate_attributes_values(resources, params)
+          resources.each do |resource|
+            val = extract_value_from(resource, params[:name])
+            if value_is_invalid?(val)
+              error_for :value, root: :attributes, path: [params[:name]]
+            end
+          end
+        end
+
+        def validate_attributes_properties(params)
+          params[:properties].each do |key, value|
+            unless definition[:items][:data].keys.include?(key.to_sym)
+              error_for(
+                :unknown_attribute,
+                root: :attributes,
+                path: [params[:name], key]
+              )
+              next
+            end unless @serializer.uses?(:open_attrs)
+
+            if value_is_invalid?(value)
+              error_for :value, root: :attributes, path: [params[:name], key]
+            end
+          end
+        end
+
+        def attributes?
+          @serializer.items? && @serializer.items.attributes?
+        end
+
+        def links?
+          @serializer.items? && @serializer.items.links?
+        end
+      end
+    end
+  end
+end
+

data/lib/collection_json_serializer/validator/{url.rb → types/url.rb}

@@ -1,12 +1,12 @@
 module CollectionJson
   class Serializer
-    class Validator
+    class Validation
       class Url
         # Stolen from https://github.com/eparreno/ruby_regex/blob/master/lib/ruby_regex.rb
         VALID = /(\A\z)|(\A(http|https):\/\/[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,5}(([0-9]{1,5})?\/.*)?\z)/ix
 
         def initialize(value)
-          @uri = value
+          @uri = value.to_s
         end
 
         def valid?

data/lib/collection_json_serializer/validator/{value.rb → types/value.rb}

@@ -1,6 +1,6 @@
 module CollectionJson
   class Serializer
-    class Validator
+    class Validation
       class Value
         VALID = %w(
           String

data/lib/collection_json_serializer/version.rb

@@ -1,5 +1,5 @@
 module CollectionJson
   class Serializer
-    VERSION = "0.3.2"
+    VERSION = "0.3.3"
   end
 end

data/test/builder/builder_test.rb

@@ -57,6 +57,10 @@ module CollectionJson
                     name: "email",
                     value: "",
                     prompt: "My email"
+                  },
+                  {
+                    name: "password",
+                    value: ""
                   }
                 ]
               },
@@ -138,6 +142,10 @@ module CollectionJson
                     name: "email",
                     value: "",
                     prompt: "My email"
+                  },
+                  {
+                    name: "password",
+                    value: ""
                   }
                 ]
               },

data/test/extensions/open_attrs_test.rb

@@ -23,9 +23,7 @@ module CollectionJson
         ]
         @serializer.items.links = [
           dashboard: {
-            # TODO
-            # This URL shouldn't validate!
-            href: "/my-dashboard",
+            href: "http://example.com/my-dashboard",
             anything: "at all"
           }
         ]
@@ -69,7 +67,7 @@ module CollectionJson
                 links: [
                   {
                     rel: "dashboard",
-                    href: "/my-dashboard",
+                    href: "http://example.com/my-dashboard",
                     name: "dashboard",
                     anything: "at all",
                   }

data/test/fixtures/serializers/user_serializer.rb

@@ -1,7 +1,12 @@
 class UserSerializer < CollectionJson::Serializer
   href "http://example.com/users"
-  template :name, email: { prompt: "My email" }
+
+  template :name
+  template email: { prompt: "My email" }
+  template :password
+
   links dashboard: { href: "http://example.com/my-dashboard" }
+
   queries search: {
     href: "http://example.com/search",
     name: false

data/test/minitest_helper.rb

@@ -22,4 +22,45 @@ module TestHelper
     serializer.items.attributes = []
     serializer
   end
+
+  def values_for_test(of_kind)
+    case of_kind
+    when :invalid
+      return [
+        /regex/,
+        :symbol,
+        {},
+        []
+      ]
+    when :valid
+      return [
+        "string",
+        1,
+        1.5,
+        -1,
+        BigDecimal.new(1),
+        (22/7.0).to_r,
+        true,
+        false,
+        nil
+      ]
+    end
+  end
+
+  def urls_for_test(of_kind)
+    case of_kind
+    when :invalid
+      return %w(
+        /hello
+        http:hello
+      )
+    when :valid
+      return %w(
+        http://example.com
+        https://example.com
+        http://my.example.com
+        https://my.example.com/?plus=query_string
+      )
+    end
+  end
 end

data/test/objects/template_test.rb

@@ -16,7 +16,8 @@ module CollectionJson
           def test_that_a_template_can_be_build
             expected = [
               { name: "name", value: "" },
-              { name: "email", value: "", prompt: "My email" }
+              { name: "email", value: "", prompt: "My email" },
+              { name: "password", value: "" }
             ]
 
             assert_equal expected.to_json, @template.create.to_json

data/test/serializer/template_test.rb

@@ -9,7 +9,13 @@ module CollectionJson
       end
 
       def test_template_attributes
-        assert_equal [:name, email: { prompt: "My email" }], @user_serializer.class.template
+        expected = [
+          :name,
+          { email: { prompt: "My email" } },
+          :password
+        ]
+
+        assert_equal expected, @user_serializer.class.template
       end
     end
   end

data/test/validator/invalid_test.rb

@@ -18,13 +18,6 @@ module CollectionJson
           )
           @user.account = @account
 
-          @invalid_value_types = [
-            /regex/,
-            :symbol,
-            {},
-            []
-          ]
-
           @invalid = empty_serializer_for(@user)
         end
 
@@ -79,7 +72,7 @@ module CollectionJson
         def test_that_invalid_attributes_return_values_generate_errors
           @invalid.items.attributes = [:name]
 
-          @invalid_value_types.each do |invalidate|
+          values_for_test(:invalid).each do |invalidate|
             @user.name = invalidate
             assert @invalid.invalid?,
                    "#{invalidate} should be invalid"
@@ -91,7 +84,7 @@ module CollectionJson
         end
 
         def test_that_invalid_attributes_properties_values_generate_errors
-          @invalid_value_types.each do |invalidate|
+          values_for_test(:invalid).each do |invalidate|
             @invalid.items.attributes = [
               name: {
                 prompt: invalidate
@@ -109,7 +102,7 @@ module CollectionJson
 
         # Template
         def test_that_template_values_validate
-          @invalid_value_types.each do |invalidate|
+          values_for_test(:invalid).each do |invalidate|
             @invalid.class.template = [
               name: {
                 prompt: invalidate,
@@ -159,7 +152,7 @@ module CollectionJson
         end
 
         def test_that_queries_values_are_validated
-          @invalid_value_types.each do |invalidate|
+          values_for_test(:invalid).each do |invalidate|
             @invalid.class.queries = [
               search: {
                 href: "http://example.com/",

data/test/validator/items_validator_test.rb

@@ -0,0 +1,56 @@
+require "minitest_helper"
+
+module CollectionJson
+  class Serializer
+    class Validator
+      class ItemsValidator
+        class ItemsValidatorTest < MiniTest::Test
+          include TestHelper
+
+          def setup
+            @user = User.new
+          end
+
+          def test_that_attributes_are_validated
+            values_for_test(:invalid).each do |invalid|
+              @user.name = invalid
+              serializer = empty_serializer_for(@user)
+              serializer.items.attributes = [:name]
+
+              items_validator = ItemsValidator.new(serializer)
+
+              assert items_validator.errors.any?, "should have errors"
+              assert items_validator.errors.key?(:attributes),
+                     "should have key attributes"
+              assert items_validator.errors[:attributes][0].
+                include?("attributes:name is an invalid value")
+            end
+          end
+
+          def test_that_links_are_validated
+            values_for_test(:invalid).each do |invalid|
+              serializer = empty_serializer_for(@user)
+              serializer.items.links = [
+                dashboard: {
+                  href: "invalid url",
+                  rel: invalid
+                }
+              ]
+
+              items_validator = ItemsValidator.new(serializer)
+
+              assert items_validator.errors.any?, "should have errors"
+              assert items_validator.errors.key?(:items),
+                     "should have key items"
+              assert items_validator.errors[:items][0].
+                include?("items:links:dashboard:href is an invalid URL")
+              assert items_validator.errors[:items][1].
+                include?("items:links:dashboard:rel is an invalid value")
+            end
+          end
+        end
+      end
+    end
+  end
+end
+

data/test/validator/url_validator_test.rb

@@ -2,16 +2,21 @@ require "minitest_helper"
 
 module CollectionJson
   class Serializer
-    class Validator
+    class Validation
       class Url
         class TestUrl < Minitest::Test
+          include TestHelper
+
           def test_that_urls_validate
-            invalid = %w(
-              /hello
-              http:hello
-            )
+            urls_for_test(:invalid).each do |url|
+              value = Url.new(url)
+              refute value.valid?
+              assert value.invalid?
+            end
+          end
 
-            invalid.each do |url|
+          def test_that_different_data_types_generate_error
+            values_for_test(:invalid).each do |url|
               value = Url.new(url)
               refute value.valid?
               assert value.invalid?

data/test/validator/validation_test.rb

@@ -0,0 +1,21 @@
+require 'minitest_helper'
+
+module CollectionJson
+  class Serializer
+    class Validation
+      class TestValidation < MiniTest::Test
+        include TestHelper
+
+        def test_that_instantiating_validation_raises_error
+          user = User.new(name: 'Carles Jove')
+          serializer = empty_serializer_for(user)
+
+          assert_raises(NotImplementedError) do
+            Validation.new(serializer)
+          end
+        end
+      end
+    end
+  end
+end
+

data/test/validator/value_validator_test.rb

@@ -2,36 +2,19 @@ require "minitest_helper"
 
 module CollectionJson
   class Serializer
-    class Validator
+    class Validation
       class Value
         class TestValue < Minitest::Test
-          def test_that_values_validate
-            invalid = [
-              /regex/,
-              :symbol,
-              {},
-              []
-            ]
-
-            valid = [
-              "string",
-              1,
-              1.5,
-              -1,
-              BigDecimal.new(1),
-              (22/7.0).to_r,
-              true,
-              false,
-              nil
-            ]
+          include TestHelper
 
-            invalid.each do |v|
+          def test_that_values_validate
+            values_for_test(:invalid).each do |v|
               value = Value.new(v)
               refute value.valid?, "#{v} should be invalid, but was valid"
               assert value.invalid?, "#{v} should be invalid, but was valid"
             end
 
-            valid.each do |v|
+            values_for_test(:valid) do |v|
               value = Value.new(v)
               assert value.valid?, "#{v} should be valid, but was invalid"
               refute value.invalid?, "#{v} should be valid, but was invalid"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: collection_json_serializer
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Carles Jove i Buxeda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-24 00:00:00.000000000 Z
+date: 2015-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -93,8 +93,10 @@ files:
 - lib/collection_json_serializer/spec.rb
 - lib/collection_json_serializer/support.rb
 - lib/collection_json_serializer/validator.rb
-- lib/collection_json_serializer/validator/url.rb
-- lib/collection_json_serializer/validator/value.rb
+- lib/collection_json_serializer/validator/base.rb
+- lib/collection_json_serializer/validator/items_validator.rb
+- lib/collection_json_serializer/validator/types/url.rb
+- lib/collection_json_serializer/validator/types/value.rb
 - lib/collection_json_serializer/version.rb
 - test/builder/builder_test.rb
 - test/extensions/open_attrs_test.rb
@@ -123,7 +125,9 @@ files:
 - test/support/ext_test.rb
 - test/support/support_test.rb
 - test/validator/invalid_test.rb
+- test/validator/items_validator_test.rb
 - test/validator/url_validator_test.rb
+- test/validator/validation_test.rb
 - test/validator/validator_test.rb
 - test/validator/value_validator_test.rb
 homepage: https://github.com/carlesjove/collection_json_serializer
@@ -138,7 +142,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -178,7 +182,9 @@ test_files:
 - test/support/ext_test.rb
 - test/support/support_test.rb
 - test/validator/invalid_test.rb
+- test/validator/items_validator_test.rb
 - test/validator/url_validator_test.rb
+- test/validator/validation_test.rb
 - test/validator/validator_test.rb
 - test/validator/value_validator_test.rb
 has_rdoc: