add getter for @inclusion_field

Author: zetavg

lib/api_helper/includable.rb

@@ -310,6 +310,24 @@ def set_inclusion_field(resource, field, id_field, resource_name: nil,
     }
   end
 
+  # Getter for the data of includable fields
+  #
+  # Params:
+  #
+  # +resource+::
+  #   +Symbol+ the resource name of inclusion data to retrieve
+  #
+  def inclusion_field(resource = nil)
+    # act as a traditional getter if no parameters specified
+    if resource.blank?
+      @inclusion_field ||= ActiveSupport::HashWithIndifferentAccess.new
+
+    # returns the inclusion array if an specific resource is passed in
+    else
+      inclusion_field[resource] || []
+    end
+  end
+
   # Returns the description of the 'include' URL parameter
   def self.include_param_desc(example: nil, default: nil)
     if default.present?
@@ -327,7 +345,7 @@ def self.include_param_desc(example: nil, default: nil)
 
   included do
     if defined? helper_method
-      helper_method :inclusion, :set_inclusion, :set_inclusion_field
+      helper_method :inclusion, :set_inclusion, :set_inclusion_field, :inclusion_field
     end
   end
 end

lib/api_helper/version.rb

@@ -1,3 +1,3 @@
 module APIHelper
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

spec/api_helper/rails/includable_spec.rb

@@ -178,6 +178,48 @@ def index
                })
         end
       end
+
+      describe "inclusion_field" do
+        it "get the properties of includable fields" do
+          # These methods are normally called in the view
+          controller.set_inclusion_field :post, :comments, :comment_ids,
+                                         resource_name: :comment,
+                                         resources_url: '/comments'
+          controller.set_inclusion_field :post, :author, :author_id,
+                                         resource_name: :user,
+                                         resources_url: '/users'
+
+          expect(controller.inclusion_field).to \
+            eq('post' => {
+                 'comments' => {
+                   'field' => :comments,
+                   'id_field' => :comment_ids,
+                   'resource_name' => :comment,
+                   'resources_url' => '/comments'
+                 },
+                 'author' => {
+                   'field' => :author,
+                   'id_field' => :author_id,
+                   'resource_name' => :user,
+                   'resources_url' => '/users'
+                 }
+               })
+
+          expect(controller.inclusion_field(:post)).to \
+            eq('comments' => {
+                 'field' => :comments,
+                 'id_field' => :comment_ids,
+                 'resource_name' => :comment,
+                 'resources_url' => '/comments'
+               },
+               'author' => {
+                 'field' => :author,
+                 'id_field' => :author_id,
+                 'resource_name' => :user,
+                 'resources_url' => '/users'
+               })
+        end
+      end
     end
   end
 end if defined?(Rails)