jsonapi-resources 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d1860b6f54c5c18361eee885c58d9a44ca799223
-  data.tar.gz: 75520fb96150d1185d444c474f9b803e1efada5b
+  metadata.gz: 50581a29495af11bb597deb7c7ca7369eb084b77
+  data.tar.gz: 07aff054fd599cfa81fd11c3934900cce12f2317
 SHA512:
-  metadata.gz: f335fd832a84998b16b4c10fb349c87fba4bfbc5e97166e3c7875c6d07ec46a6fe8453aba8d2297d12ab1a9c22ee28355695e009384a7bb3f2f41fd2ade7d8db
-  data.tar.gz: bf31f588b77dfa2c95d9ddcd6461ef984aa329c2c17641082662156b01a36c69aa6f51fcb2741f84886f0ccdee5c9d2f6108966cfd842db8bcae5509ebb44dd1
+  metadata.gz: 626ce6b524027111ef04fed7988313018cb9daa9eda844bf2a05b7cd5b7acf8b45c0dd213aafbeb13dff473a50180037c434a5715092bb624801e3cca1cc5e06
+  data.tar.gz: e08ff693bb02c582ff4685d209c0fee6e7d5fbd0dce21a6b43b614103d4d98ae0c2eba60ae63eafda808d79ef02b10e18faf2d38b81b978e65fd5ec6b8e14328

data/README.md

@@ -54,6 +54,25 @@ class ContactResource < JSONAPI::Resource
 end
 ```
 
+##### Abstract Resources
+
+Resources that are not backed by a model (purely used as base classes for other resources) should be declared as 
+abstract.
+
+Because abstract resources do not expect to be backed by a model, they won't attempt to discover the model class
+or any of its relationships.
+
+```ruby
+class BaseResource < JSONAPI::Resource
+  abstract
+  
+  has_one :creator
+end
+
+class ContactResource < BaseResource
+end
+```
+
 #### Attributes
 
 Any of a resource's attributes that are accessible must be explicitly declared. Single attributes can be declared using

data/lib/jsonapi/request.rb

@@ -234,7 +234,7 @@ module JSONAPI
     end
 
     def parse_sort_criteria(sort_criteria)
-      return unless sort_criteria
+      return unless sort_criteria.present?
 
       @sort_criteria = CSV.parse_line(URI.unescape(sort_criteria)).collect do |sort|
         if sort.start_with?('-')

data/lib/jsonapi/resource.rb

@@ -257,6 +257,7 @@ module JSONAPI
 
     class << self
       def inherited(base)
+        base.abstract(false)
         base._attributes = (_attributes || {}).dup
         base._relationships = (_relationships || {}).dup
         base._allowed_filters = (_allowed_filters || Set.new).dup
@@ -620,10 +621,20 @@ module JSONAPI
         @_paginator = paginator
       end
 
+      def abstract(val = true)
+        @abstract = val
+      end
+
+      def _abstract
+        @abstract
+      end
+
       def _model_class
+        return nil if _abstract
+
         return @model if @model
         @model = _model_name.to_s.safe_constantize
-        fail NameError, "model could not be found for #{self.name}" if @model.nil?
+        warn "[MODEL NOT FOUND] Model could not be found for #{self.name}. If this a base Resource declare it as abstract." if @model.nil?
         @model
       end
 
@@ -675,7 +686,7 @@ module JSONAPI
           check_reserved_relationship_name(attr)
 
           # Initialize from an ActiveRecord model's properties
-          if _model_class < ActiveRecord::Base
+          if _model_class && _model_class < ActiveRecord::Base
             model_association = _model_class.reflect_on_association(attr)
             if model_association
               options[:class_name] ||= model_association.class_name

data/lib/jsonapi/resources/version.rb

@@ -1,5 +1,5 @@
 module JSONAPI
   module Resources
-    VERSION = '0.5.1'
+    VERSION = '0.5.2'
   end
 end

data/test/controllers/controller_test.rb

@@ -205,6 +205,12 @@ class PostsControllerTest < ActionController::TestCase
     assert_equal 3, json_response['data'].size
   end
 
+  def test_sorting_blank
+    get :index, {sort: ''}
+
+    assert_response :success
+  end
+
   def test_sorting_asc
     get :index, {sort: 'title'}
 

data/test/fixtures/active_record.rb

@@ -648,7 +648,11 @@ module Api
 end
 
 ### RESOURCES
-class PersonResource < JSONAPI::Resource
+class BaseResource < JSONAPI::Resource
+  abstract
+end
+
+class PersonResource < BaseResource
   attributes :id, :name, :email
   attribute :date_joined, format: :date_with_timezone
 

data/test/unit/resource/resource_test.rb

@@ -11,6 +11,10 @@ end
 class NoMatchResource < JSONAPI::Resource
 end
 
+class NoMatchAbstractResource < JSONAPI::Resource
+  abstract
+end
+
 class CatResource < JSONAPI::Resource
   attribute :id
   attribute :name
@@ -55,12 +59,25 @@ class ResourceTest < ActiveSupport::TestCase
     assert_equal(PostResource._model_class, Post)
   end
 
+  def test_base_resource_abstract
+    assert BaseResource._abstract
+  end
+
+  def test_derived_not_abstract
+    assert PersonResource < BaseResource
+    refute PersonResource._abstract
+  end
+
   def test_nil_model_class
-    error = assert_raises(NameError) { NoMatchResource._model_class }
-    assert_equal(
-      error.message,
-      "model could not be found for NoMatchResource"
-    )
+    assert_output nil, "[MODEL NOT FOUND] Model could not be found for NoMatchResource. If this a base Resource declare it as abstract.\n" do
+      assert_nil NoMatchResource._model_class
+    end
+  end
+
+  def test_nil_abstract_model_class
+    assert_output nil, '' do
+      assert_nil NoMatchAbstractResource._model_class
+    end
   end
 
   def test_model_alternate

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-resources
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Dan Gebhardt
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-27 00:00:00.000000000 Z
+date: 2015-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler