onsi 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed92bde9b8d7540e7d542621101fedc2cb414aaa07d24c751d57d7b4454b0bcb
-  data.tar.gz: 441c0cd6376b4bcc6c086acb0cbec596fed03f0a190a8096e8dac639be4a28d9
+  metadata.gz: 11cdb10f50e5e342639f7957e3e2cf867decc2773065232c3a880983936a5122
+  data.tar.gz: f37f95aaddd5d3736a7f165b4362876ef7a7a60865bae5183b7b850ba4ad6746
 SHA512:
-  metadata.gz: b1b31fa4f17aad3767d5f4f2b46bf92e52ff6bd9ec7343ab4e742796d41f6791f5944b07378ec3dfd16d11b2b1caca07608fea9ad3dcb911b1a89318d8be15cd
-  data.tar.gz: 4e0e591bc4fea1df9aeedc73b6f558a12e7a41b42f65a780eff24784bad73c709731af923e1fd97d0346295ff911b66584cd11e74584071f6f0bffbbef176aef
+  metadata.gz: fce49cd88116a547bd44bdc835b5def7a2dc5d54b07360d0185bf99008ba66c02a7821dadcc77cf9909bc62549ce57af5d30fd27c1eed9068d67041bdd943638
+  data.tar.gz: 452661c725d56fc43dd03a16499321614063830a4cfc6d4af29fb122d6c8349e71f4d122d8d56637fa80eaee80bc89be3a36e55a7aa6b20415db83ffaae6e2e4

data/.circleci/config.yml

@@ -16,6 +16,7 @@ jobs:
           command: |
             curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
             chmod +x ./cc-test-reporter
+      - run: gem install bundler
       - restore_cache:
           keys:
             - v1-gems-latest-{{ checksum "onsi.gemspec" }}
@@ -44,6 +45,7 @@ jobs:
     working_directory: ~/repo
     steps:
       - checkout
+      - run: gem install bundler
       - restore_cache:
           keys:
             - v1-gems-build_2_5-{{ checksum "onsi.gemspec" }}
@@ -65,6 +67,7 @@ jobs:
     working_directory: ~/repo
     steps:
       - checkout
+      - run: gem install bundler
       - restore_cache:
           keys:
             - v1-gems-build_2_4-{{ checksum "onsi.gemspec" }}
@@ -86,6 +89,7 @@ jobs:
     working_directory: ~/repo
     steps:
       - checkout
+      - run: gem install bundler
       - restore_cache:
           keys:
             - v1-gems-build_2_3-{{ checksum "onsi.gemspec" }}

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    onsi (0.3.0)
+    onsi (0.4.0)
       rails (>= 5.0, < 6.0)
 
 GEM

data/lib/onsi/controller.rb

@@ -17,22 +17,11 @@ module Onsi
 
     def render_resource(resource, opts = {})
       version = opts.delete(:version) || self.class.render_version || Model::DEFAULT_API_VERSION
-      payload = format_resource(resource, version)
+      payload = Resource.render(resource, version)
       render_options = {}
-      render_options[:json] = { data: payload }
+      render_options[:json] = payload
       render_options.merge!(opts)
       render(render_options)
     end
-
-    def format_resource(resource, version)
-      case resource
-      when Onsi::Resource
-        resource
-      when Enumerable
-        resource.map { |res| format_resource(res, version) }
-      else
-        Onsi::Resource.new(resource, version)
-      end
-    end
   end
 end

data/lib/onsi/includes.rb

@@ -0,0 +1,56 @@
+module Onsi
+  class Includes
+    attr_reader :included
+
+    def initialize(included)
+      @included = parse_included(included)
+    end
+
+    def method_missing(name, *args, &block)
+      if name =~ /\Afetch_(.*)/
+        add_fetch_method(name.to_s.gsub(/\Afetch_/, ''), *args, &block)
+      else
+        super
+      end
+    end
+
+    def load_included
+      @load_included ||= {}.tap do |root|
+        included.each do |name|
+          fetcher = fetch_methods[name]
+          next if fetcher.nil?
+          results = fetcher.call
+          root[name] = results
+        end
+      end
+    end
+
+    private
+
+    def fetch_methods
+      @fetch_methods ||= {}
+    end
+
+    def add_fetch_method(name, &block)
+      if block.nil?
+        raise ArgumentError, "Must specify a block for fetch_#{name}"
+      end
+      fetch_methods[name.to_sym] = block
+    end
+
+    def parse_included(included)
+      case included
+      when Enumerable
+        included.map(&:to_sym)
+      when String
+        included.split(',').map(&:to_sym)
+      when Symbol
+        Array(included)
+      when nil
+        []
+      else
+        raise ArgumentError, "Onsi::Includes unknown included type #{included}"
+      end
+    end
+  end
+end

data/lib/onsi/params.rb

@@ -72,8 +72,12 @@ module Onsi
       attributes.to_h.merge(relationships.to_h).with_indifferent_access
     end
 
+    def fetch(key, default = nil)
+      attrs_hash[key] || default
+    end
+
     def require(key)
-      value = attributes.to_h.with_indifferent_access[key]
+      value = attrs_hash[key]
       if value.nil?
         raise MissingReqiredAttribute.new("Missing attribute #{key}", key)
       end
@@ -85,5 +89,11 @@ module Onsi
     rescue ActiveRecord::RecordNotFound
       raise RelationshipNotFound.new("Can't find relationship #{key}", key)
     end
+
+    private
+
+    def attrs_hash
+      @attrs_hash ||= attributes.to_h.with_indifferent_access
+    end
   end
 end

data/lib/onsi/resource.rb

@@ -1,38 +1,107 @@
 module Onsi
   class Resource
-    attr_reader :object, :version
+    attr_reader :object, :version, :includes
+
+    TYPE_KEY          = 'type'.freeze
+    ID_KEY            = 'id'.freeze
+    ATTRIBUTES_KEY    = 'attributes'.freeze
+    RELATIONSHIPS_KEY = 'relationships'.freeze
+    META_KEY          = 'meta'.freeze
+    DATA_KEY          = 'data'.freeze
+    INCLUDED_KEY      = 'included'.freeze
 
     class InvalidResourceError < StandardError; end
 
-    def initialize(object, version = Model::DEFAULT_API_VERSION)
+    class << self
+      def as_resource(resource, version)
+        case resource
+        when Onsi::Resource
+          resource
+        when Enumerable
+          resource.map { |res| as_resource(res, version) }
+        else
+          Onsi::Resource.new(resource, version)
+        end
+      end
+
+      def render(resource, version)
+        resources = as_resource(resource, version)
+        {}.tap do |root|
+          root[DATA_KEY] = resources.as_json
+          included = all_included(resources)
+          if included.any?
+            root[INCLUDED_KEY] = included
+          end
+        end
+      end
+
+      def all_included(resources)
+        Array(resources).map(&:flat_includes).flatten.uniq do |res|
+          "#{res[TYPE_KEY]}-#{res[ID_KEY]}"
+        end
+      end
+    end
+
+    def initialize(object, version = nil, includes: nil)
       @object  = object
-      @version = version
+      @version = version || Model::DEFAULT_API_VERSION
+      @includes = includes
       validate!
     end
 
     def as_json(_opts = {})
       {}.tap do |root|
-        root['type'] = type
-        root['id']   = object.id.to_s
-        root['attributes'] = generate_attributes
-        rela = generate_relationships
-        root['relationships'] = rela if rela.any?
-        meta = generate_metadata
-        root['meta'] = meta if meta.any?
+        root[TYPE_KEY] = type
+        root[ID_KEY]   = object.id.to_s
+        root[ATTRIBUTES_KEY] = generate_attributes
+        append_relationships(root)
+        append_meta(root)
+        append_includes(root)
       end
     end
 
+    def rendered_includes
+      @rendered_includes ||= perform_render_includes
+    end
+
+    def flat_includes
+      rendered_includes.values.map { |root| root[DATA_KEY] }.flatten
+    end
+
     private
 
     def validate!
-      return if object.class.included_modules.include?(Onsi::Model)
-      raise InvalidResourceError, "Trying to render a #{object.class.name}. But it doesn't include Onsi::Model"
+      unless object.class.included_modules.include?(Onsi::Model)
+        raise InvalidResourceError, "Trying to render a #{object.class.name}. But it doesn't include Onsi::Model"
+      end
+      if includes.present? && !includes.is_a?(Onsi::Includes)
+        raise InvalidResourceError, "Included resources in #{self} is not a Onsi::Includes"
+      end
     end
 
     def type
       object.class.api_renderer(version, for_render: true).type || object.class.name.underscore
     end
 
+    def append_relationships(root)
+      relationships = generate_relationships
+      return unless relationships.any?
+      root[RELATIONSHIPS_KEY] = relationships
+    end
+
+    def append_meta(root)
+      meta = generate_metadata
+      return unless meta.any?
+      root[META_KEY] = meta
+    end
+
+    def append_includes(root)
+      includes = generate_includes
+      return unless includes.any?
+      root[RELATIONSHIPS_KEY] ||= {}
+      root[RELATIONSHIPS_KEY].merge!(includes)
+    end
+
     def generate_attributes
       object.class.api_renderer(version, for_render: true).render_attributes(object)
     end
@@ -44,5 +113,40 @@ module Onsi
     def generate_metadata
       object.class.api_renderer(version, for_render: true).render_metadata(object)
     end
+
+    def generate_includes
+      {}.tap do |root|
+        rendered_includes.each do |key, values|
+          included = values[DATA_KEY]
+          case included
+          when Array
+            root[key] = {}.tap do |subobj|
+              subobj[DATA_KEY] = included.map do |inc|
+                {
+                  TYPE_KEY => inc[TYPE_KEY],
+                  ID_KEY   => inc[ID_KEY]
+                }
+              end
+            end
+          when Hash
+            root[key] = { DATA_KEY => { TYPE_KEY => included[TYPE_KEY], ID_KEY => included[ID_KEY] } }
+          end
+        end
+      end
+    end
+
+    def perform_render_includes
+      included = includes&.load_included
+      {}.tap do |root|
+        Hash(included).each do |key, results|
+          root[key.to_s] = {}
+          root[key.to_s][DATA_KEY] = render_included(results)
+        end
+      end
+    end
+
+    def render_included(resources)
+      Resource.as_resource(resources, version).as_json
+    end
   end
 end

data/lib/onsi/version.rb

@@ -1,3 +1,3 @@
 module Onsi
-  VERSION = '0.3.0'.freeze
+  VERSION = '0.4.0'.freeze
 end

data/lib/onsi.rb

@@ -1,6 +1,7 @@
 require 'onsi/controller'
 require 'onsi/error_responder'
 require 'onsi/errors'
+require 'onsi/includes'
 require 'onsi/model'
 require 'onsi/params'
 require 'onsi/resource'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: onsi
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Skylar Schipper
@@ -166,6 +166,7 @@ files:
 - lib/onsi/controller.rb
 - lib/onsi/error_responder.rb
 - lib/onsi/errors.rb
+- lib/onsi/includes.rb
 - lib/onsi/model.rb
 - lib/onsi/params.rb
 - lib/onsi/resource.rb