Module: ResourcesController::InstanceMethods

Defined in:
lib/resources_controller.rb

Instance Method Summary collapse

Instance Method Details

#enclosing_collection_resources ⇒ Object

returns an array of the collection (non singleton) enclosing resources, this is used for generating routes.



630
631
632
 
# File 'lib/resources_controller.rb', line 630

def enclosing_collection_resources
  @enclosing_collection_resources ||= []
end

#enclosing_resource ⇒ Object

returns the immediately enclosing resource



604
605
606
 
# File 'lib/resources_controller.rb', line 604

def enclosing_resource
  enclosing_resources.last
end

#enclosing_resource_name ⇒ Object

returns the name of the immediately enclosing resource



609
610
611
 
# File 'lib/resources_controller.rb', line 609

def enclosing_resource_name
  @enclosing_resource_name
end

#enclosing_resources ⇒ Object

returns an array of the controller’s enclosing (nested in) resources



625
626
627
 
# File 'lib/resources_controller.rb', line 625

def enclosing_resources
  @enclosing_resources ||= []
end

#name_prefix ⇒ Object 



563
564
565
 
# File 'lib/resources_controller.rb', line 563

def name_prefix
  @name_prefix ||= ''
end

#resource ⇒ Object

returns the controller’s current resource.



583
584
585
 
# File 'lib/resources_controller.rb', line 583

def resource
  instance_variable_get("@#{resource_name}")
end

#resource=(record) ⇒ Object

sets the controller’s current resource, and decorates the object with a save hook, so we know if it’s been saved



589
590
591
 
# File 'lib/resources_controller.rb', line 589

def resource=(record)
  instance_variable_set("@#{resource_name}", record)
end

#resource_class ⇒ Object

returns the controller’s resource class



578
579
580
 
# File 'lib/resources_controller.rb', line 578

def resource_class
  resource_specification.klass
end

#resource_name ⇒ Object

name of the singular resource



568
569
570
 
# File 'lib/resources_controller.rb', line 568

def resource_name
  resource_specification.name
end

#resource_saved? ⇒ Boolean

NOTE: This method is overly complicated and unecessary. It’s much clearer just to keep track of record saves yourself, this is here for BC. For an example of how it should be done look at the actions module in github.com/ianwhite/response_for_rc

Has the resource been saved successfully?, if no save has been attempted, save the record and return the result

This method uses the @resource_saved tracking var, or the model’s state itself if that is not available (which means if you do resource.update_attributes, then this method will return the correct result)

Returns:

  • (Boolean) 


644
645
646
647
648
 
# File 'lib/resources_controller.rb', line 644

def resource_saved?
  save_resource if @resource_saved.nil? && !resource.validation_attempted?
  @resource_saved = resource.saved? if @resource_saved.nil?
  @resource_saved
end

#resource_service ⇒ Object

returns the resource service for the controller - this will be lazilly created to a ResourceService, or a SingletonResourceService (if :singleton => true)



615
616
617
 
# File 'lib/resources_controller.rb', line 615

def resource_service
  @resource_service ||= resource_specification.singleton? ? SingletonResourceService.new(self) : ResourceService.new(self)
end

#resource_service=(service) ⇒ Object 



559
560
561
 
# File 'lib/resources_controller.rb', line 559

def resource_service=(service)
  @resource_service = service
end

#resource_specification ⇒ Object

returns the instance resource_specification



620
621
622
 
# File 'lib/resources_controller.rb', line 620

def resource_specification
  self.class.resource_specification
end

#resources ⇒ Object

returns the controller’s current resources collection



594
595
596
 
# File 'lib/resources_controller.rb', line 594

def resources
  instance_variable_get("@#{resources_name}")
end

#resources=(collection) ⇒ Object

sets the controller’s current resource collection



599
600
601
 
# File 'lib/resources_controller.rb', line 599

def resources=(collection)
  instance_variable_set("@#{resources_name}", collection)
end

#resources_name ⇒ Object

name of the resource collection



573
574
575
 
# File 'lib/resources_controller.rb', line 573

def resources_name
  @resources_name ||= resource_specification.name.pluralize
end

#save_resource ⇒ Object

NOTE: it’s clearer to just keep track of record saves yourself, this is here for BC See the comment on #resource_saved?

Save the resource, and keep track of the result



656
657
658
 
# File 'lib/resources_controller.rb', line 656

def save_resource
  @resource_saved = resource.save
end