json_api_ruby 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b11dfa347ef77e800e676368dd1d05cf9178baf
-  data.tar.gz: 4eb50ca1efdbccdab32a6055a02c64c52ff3891c
+  metadata.gz: a42efcc7659bcd6df482b2f0a82f9434e2e65d7e
+  data.tar.gz: 3b111dbabfd9f66e0893af2c0b21f53a480d5711
 SHA512:
-  metadata.gz: 17ee19b48621c454bce815d03529c541242d90349b81dc95b57c3637d3275bf235386fd0fffc82ce6ba7b15ea7e1c6f3c896a241fb7905af5796584f941969ef
-  data.tar.gz: 44f16c8e5e6001217043148803964799fb829933dffb1d84580a6a658b0ef8ef57d061a60f288125576f45738858624b3e4f4ee5cc9dab431a85715d8e7b538e
+  metadata.gz: 78d370d9fb0cbecbb2e46265610d7b8eee525d953bd0c786954d603cebe2800934a8995d944ff4fa9554888d697d43cc360dca217ab1ba5fe891a781f0c9be4f
+  data.tar.gz: ccdf63438c842cd0c6964633b755b45465246be9fb963f670e94af24dcb59334f3f2784cbf5d9a3ff2f7d07294748dc72bf33ebecaac18c67be3fd29ca455190

data/.gitignore

@@ -1 +1,38 @@
 pkg
+
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/CHANGELOG.md

@@ -1,2 +1,5 @@
+0.0.3
+Performance tuning and documentation
+
 0.0.2
 Changed 'class_name' to 'resource_class' for consistency

data/json_api_ruby.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = JsonApi::VERSION
   spec.authors       = ["Tracey Eubanks"]
   spec.email         = ["tracey@bypassmobile.com"]
-  spec.description   = %q{Create JSON API resources when you don't have Rails 4+ available}
-  spec.summary       = %q{Create JSON API resources when you don't have Rails 4+ available}
+  spec.description   = %q{Extremely lightweight implementation of JSON API}
+  spec.summary       = %q{Extremely lightweight implementation of JSON API}
   spec.homepage      = "https://github.com/teubanks/jsonapi_ruby"
   spec.license       = "Free For All"
 

data/lib/json_api_ruby/resource.rb

@@ -13,9 +13,9 @@ module JsonApi
 
     # Can be set using `id_field` in the created resource class like so:
     #
-    # class ObjectResource < JsonApi::Resource
-    #   id_field :uuid
-    # end
+    #   class ObjectResource < JsonApi::Resource
+    #     id_field :uuid
+    #   end
     #
     # defaults to :id
     def id
@@ -42,8 +42,12 @@ module JsonApi
       _model
     end
 
+    # The model that is used to fill out the data and attributes objects
     attr_accessor :_model
 
+    # Includes can be passed in from a request
+    # See:
+    #   http://jsonapi.org/format/#fetching-includes
     attr_reader :includes
 
     def initialize(model, options={})

data/lib/json_api_ruby/resources/base.rb

@@ -4,9 +4,7 @@ module JsonApi
 
     module Base
       attr_reader :relationships
-      def to_hash(options={})
-        options.symbolize_keys
-
+      def to_hash
         resource_hash = identifier_hash
         resource_hash['attributes'] = attributes_hash if attributes_hash.any?
 
@@ -23,7 +21,7 @@ module JsonApi
       # "article.comments" and "article-comments", so, leaving the method here
       # but only supporting the most basic of things
       def parse_for_includes(includes)
-        Array(includes).map {|inc| inc.to_s }
+        Array(includes).map(&:to_s)
       end
 
       def identifier_hash
@@ -39,11 +37,11 @@ module JsonApi
       end
 
       def attributes_hash
-        attrs = {}
-        Array(self.class.fields).each do |attr|
-          attrs[attr.to_s] = send(attr)
+        Array(self.class.fields).inject({}) do |attrs, attr|
+          meth = method(attr)
+          attrs[attr.to_s] = meth.call
+          attrs
         end
-        attrs
       end
 
       # Builds relationship resource classes

data/lib/json_api_ruby/resources/discovery.rb

@@ -2,16 +2,23 @@ module JsonApi
   module Resources
     class Discovery
       def self.resource_for_name(model, options={})
+        @discovered_classes ||= {}
         namespace = options.fetch(:namespace, nil)
         klass = options.fetch(:resource_class, nil)
         parent = options.fetch(:parent_resource, nil)
 
         if klass.blank?
-          # discover it
-          klass = resource_class(model.class.to_s.underscore, namespace: namespace, parent: parent)
+          cached_class = @discovered_classes[model.class.to_s]
+          if cached_class.blank?
+            klass = resource_class(model.class.to_s.underscore, namespace: namespace, parent: parent)
+          else
+            return cached_class
+          end
         end
 
-        Object.const_get(klass)
+        const = Object.const_get(klass)
+        @discovered_classes[model.class.to_s] ||= const
+        const
       rescue NameError
         fail ::JsonApi::ResourceNotFound.new("Could not find resource class `#{klass}'")
       end

data/lib/json_api_ruby/resources/relationships.rb

@@ -3,11 +3,13 @@ module JsonApi
 
     class RelationshipMeta
       # The name of this relationship.
-      #   This name comes from the resource object that defines the
-      #   relationship. Example:
-      #     class ArticleResource < JsonApi::Resource
-      #       has_one :author # this is the name of this relationship
-      #     end
+      #
+      # This name comes from the resource object that defines the
+      # relationship. Example:
+      #
+      #   class ArticleResource < JsonApi::Resource
+      #     has_one :author # this is the name of this relationship
+      #   end
       attr_reader :name
 
       attr_reader :cardinality
@@ -105,6 +107,7 @@ module JsonApi
         {'data' => data}
       end
 
+      # Build the related resources
       def build_resources(options)
         return unless included?
 

data/lib/json_api_ruby/serializer.rb

@@ -64,36 +64,32 @@ module JsonApi
 
     def to_hash
       serialized = {}
-      included_data = []
+      included_resources = []
 
       data_array = @objects.map do |object|
         resource_name  = "#{object.class.to_s.underscore}_resource".classify
         klass_name     = @resource_class || resource_name
         resource_klass = Resources::Discovery.resource_for_name(object, resource_class: klass_name)
         resource       = resource_klass.new(object, include: @includes)
-        included_data += assemble_included_data(resource.relationships)
+        included_resources += resource.relationships.select {|rel| rel.included?}.flat_map {|rel| rel.resources }
+
         resource.to_hash
       end
 
+      included_resources.uniq! do |rel|
+        rel.id + rel.type
+      end
+
       serialized['data'] = data_array
 
       serialized['meta'] = @meta if @meta
-
-      if included_data.present?
-        included_data.uniq! do |inc_data|
-          inc_data['id'] + inc_data['type']
-        end
-        serialized['included'] = included_data
-      end
+      serialized['included'] = assemble_included_data(included_resources)
 
       serialized
     end
 
-    def assemble_included_data(relationships)
-      relationships.flat_map do |relationship|
-        next if relationship.resources.blank?
-        relationship.resources.map(&:to_hash)
-      end.compact
+    def assemble_included_data(included_resources)
+      included_resources.map(&:to_hash)
     end
   end
 end

data/lib/json_api_ruby/version.rb

@@ -1,3 +1,3 @@
 module JsonApi
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_api_ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Tracey Eubanks
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-13 00:00:00.000000000 Z
+date: 2016-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -94,7 +94,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4'
-description: Create JSON API resources when you don't have Rails 4+ available
+description: Extremely lightweight implementation of JSON API
 email:
 - tracey@bypassmobile.com
 executables: []
@@ -151,7 +151,7 @@ rubyforge_project:
 rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
-summary: Create JSON API resources when you don't have Rails 4+ available
+summary: Extremely lightweight implementation of JSON API
 test_files:
 - spec/json_api_ruby/resource_spec.rb
 - spec/json_api_ruby/resources/discover_spec.rb
@@ -160,3 +160,4 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/json_api_matchers.rb
 - spec/support/resource_objects.rb
+has_rdoc: