jsonapi-resources 0.0.10 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f0f3c0056192f7ce0100152a1365750eeec04e3b
-  data.tar.gz: 5d2b1057fc7f624e91eee60ea8a5cbaff019516d
+  metadata.gz: 693f8ed867afa11d9d23f0631bdf2ccd7e19acbe
+  data.tar.gz: 5a0edbc2ab2a5f7c801c3120307c54c7c6a1142a
 SHA512:
-  metadata.gz: 25ff4a750913e3a987e2e0c3b1e366b8195db07d4487d849608637cb0c3cdfc62bbae9ea0553284bba60a12b41de19b6d451f448dd68c32c9b92d8319cde5d9b
-  data.tar.gz: 41a3b01c6367dd22b4ce0f285a2a4cbba91cb84868ab5dbb345498387cc2921c5565edc0c6f095de37a8a56b8b8c093460f6f83f2be3d9c55821869671dd8468
+  metadata.gz: e5f18920d6adee8dd748507071addacc51f58ba2719bf0961fb4fad01de7fb4af229755f90eb22b7c06ec20772fdff835fb6b7234b54c7a341d1eb6885ea879d
+  data.tar.gz: 83901cfc4f1d2dad3883e782bf90cef7cbf62873faba9b872fb84b756ec71c5020bca86acba72cbc72617a55b2cc58bab3b12152a89cf20e5f9e6a2c40aaa9aa

data/lib/jsonapi/request.rb

@@ -207,9 +207,7 @@ module JSONAPI
         elsif association.is_a?(JSONAPI::Association::HasMany)
           keys = []
           if value.is_a?(Array)
-            value.each do |val|
-              keys.push(@resource_klass.resource_for(association.type).verify_key(val, @context))
-            end
+            keys = @resource_klass.resource_for(association.type).verify_keys(value, @context)
           else
             keys.push(@resource_klass.resource_for(association.type).verify_key(value, @context))
           end
@@ -387,11 +385,7 @@ module JSONAPI
     end
 
     def parse_key_array(raw)
-      keys = []
-      raw.split(/,/).collect do |key|
-        keys.push @resource_klass.verify_key(key, @context)
-      end
-      return keys
+      return @resource_klass.verify_keys(raw.split(/,/), context)
     end
 
     def format_key(key)

data/lib/jsonapi/resource.rb

@@ -127,6 +127,9 @@ module JSONAPI
 
         type = base.name.demodulize.sub(/Resource$/, '').underscore
         base._type = type.pluralize.to_sym
+
+        check_reserved_resource_name(base._type, base.name)
+
         # If eager loading is on this is how all the resource types are setup
         # If eager loading is off some resource types will be initialized in
         # _resource_name_from_type
@@ -159,6 +162,8 @@ module JSONAPI
       end
 
       def attribute(attr, options = {})
+        check_reserved_attribute_name(attr)
+
         @_attributes[attr] = options
         define_method attr do
           @model.send(attr)
@@ -302,6 +307,13 @@ module JSONAPI
         return key
       end
 
+      # override to allow for key processing and checking
+      def verify_keys(keys, context = nil)
+        return keys.collect do |key|
+          verify_key(key, context)
+        end
+      end
+
       # override to allow for custom filters
       def verify_custom_filter(filter, value, context = nil)
         return filter, value
@@ -388,10 +400,33 @@ module JSONAPI
 
       private
 
+      def check_reserved_resource_name(type, name)
+        if [:ids, :types, :hrefs, :links].include?(type)
+          warn "[NAME COLLISION] `#{name}` is a reserved resource name."
+          return
+        end
+      end
+
+      def check_reserved_attribute_name(name)
+        # Allow :id since it can be used to specify the format. Since it is a method on the base Resource
+        # an attribute method won't be created for it.
+        if [:type, :href, :links].include?(name.to_sym)
+          warn "[NAME COLLISION] `#{name}` is a reserved key in #{@@resource_types[_type]}."
+        end
+      end
+
+      def check_reserved_association_name(name)
+        if [:id, :ids, :type, :types, :href, :hrefs, :link, :links].include?(name.to_sym)
+          warn "[NAME COLLISION] `#{name}` is a reserved association name in #{@@resource_types[_type]}."
+        end
+      end
+
       def _associate(klass, *attrs)
         options = attrs.extract_options!
 
         attrs.each do |attr|
+          check_reserved_association_name(attr)
+
           @_associations[attr] = klass.new(attr, options)
 
           foreign_key = @_associations[attr].foreign_key

data/lib/jsonapi/resource_controller.rb

@@ -120,11 +120,7 @@ module JSONAPI
     end
 
     def parse_key_array(raw)
-      keys = []
-      raw.split(/,/).collect do |key|
-        keys.push resource_klass.verify_key(key, context)
-      end
-      return keys
+      return resource_klass.verify_keys(raw.split(/,/), context)
     end
 
     # override to set context

data/lib/jsonapi/resources/version.rb

@@ -1,5 +1,5 @@
 module JSONAPI
   module Resources
-    VERSION = "0.0.10"
+    VERSION = "0.0.11"
   end
 end

data/test/fixtures/active_record.rb

@@ -379,9 +379,7 @@ class PostResource < JSONAPI::Resource
   def self.verify_custom_filter(filter, values, context = nil)
     case filter
       when :id
-        values.each do |key|
-          verify_key(key, context)
-        end
+        verify_keys(values, context)
     end
     return filter, values
   end
@@ -476,6 +474,23 @@ class PreferencesResource < JSONAPI::Resource
   has_many :friends, class_name: 'Person'
 end
 
+warn 'start testing Name Collisions'
+# The name collisions only emmit warnings. Exceptions would change the flow of the tests
+
+class LinksResource < JSONAPI::Resource
+
+end
+
+class BadlyNamedAttributesResource < JSONAPI::Resource
+  attributes :type, :href, :links
+
+  has_many :links
+  has_one :href
+  has_one :id
+  has_many :types
+end
+warn 'end testing Name Collisions'
+
 ### DATA
 javascript = Section.create(name: 'javascript')
 ruby = Section.create(name: 'ruby')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-resources
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
 platform: ruby
 authors:
 - Dan Gebhardt
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-11 00:00:00.000000000 Z
+date: 2014-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler