rbbt-rest 1.8.45 → 1.8.46

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 40e90eddb36c53c25372a680f163a3a1e7c06b09
-  data.tar.gz: 809f9e0ee244cad3c4afff02bfde90ce21e313a0
+  metadata.gz: 013635d75dfba290ea900db49c1a5a30d1aa5f3a
+  data.tar.gz: df1f05df4f7ca4e209e9cf8677cbdadc9b0e3f3b
 SHA512:
-  metadata.gz: df5b716ef38910f33193ca6f719a03dbad2ab054b3d2d3c5c03f03b5539f06f6f12ae089c89c04f2fcdbee0e01dcc0f7fa567425900420b4eb3b1063a2a3eabd
-  data.tar.gz: e59d885e8cabc4b0f9a231a16bfd794e057d586c2ec8a778960cac69b54a59dea0e209bcbe84ee5210b604e04be7523b6cce969dff1d62f75744523b4e875fbd
+  metadata.gz: c402f490a4702ee8cef75bf4464a2f6ee2a1644dc89ff397505ca32304045090b8ba1039f6ba16610a90bdbce3d3ebb9ef7836b9177a9a1b2327926a0dbf7a1e
+  data.tar.gz: 210dfe6a670779757b221deecd2b0b820e32cdfe4d6048e0fbf48f78e20d3fba60cedad382f36e4a560403ad918a11f250ad22749996382288c67973d23bda4a

data/lib/rbbt/rest/common/render.rb

@@ -58,20 +58,45 @@ module RbbtRESTHelpers
     raise TemplateMissing, "Template #{ template_file } not found" unless template_file.exists?
     raise TemplateMissing, "Template #{ layout_file } not found" unless layout_file.nil? or layout_file.exists?
     layout_file = layout_file.find if layout_file.respond_to? :find
-    template_file = template_file.find if template_file.respond_to? :find
+    
+    if Path === template_file
+      documentation_file = template_file.annotate((template_file.original || template_file).sub(/haml$/, 'md'))
+      template_file = template_file.find 
+      documentation_file = documentation_file.find
+    else
+      documentation_file = template_file.sub(/haml$/, 'md')
+    end
+
     if layout_file
       Tilt::HamlTemplate.new(layout_file, :filename => layout_file, :ugly => production?).render(self, locals) do
         Log.debug{ "Rendering #{template_file} with layout #{Misc.fingerprint cache_options}" }
         cache(cache, locals.merge(:_template_file => template_file, :user => user).merge(cache_options)) do
-          Tilt::HamlTemplate.new(template_file, :filename => template_file, :ugly => production?).render(self, locals)
+          if Open.exists?(documentation_file)
+            documentation_layout_file = locate_template('documented_section').find
+            markdown = Open.read(documentation_file)
+            Tilt::HamlTemplate.new(documentation_layout_file, :filename => documentation_layout_file, :ugly => production?).render(self, :markdown => markdown) do
+              Tilt::HamlTemplate.new(template_file, :filename => template_file, :ugly => production?).render(self, locals)
+            end
+          else
+            Tilt::HamlTemplate.new(template_file, :filename => template_file, :ugly => production?).render(self, locals)
+          end
         end
       end
     else
       Log.debug{ "Rendering #{template_file} without layout #{Misc.fingerprint cache_options}" }
       cache(cache, locals.merge(:_template_file => template_file, :user => user).merge(cache_options)) do
-        Tilt::HamlTemplate.new(template_file, :filename => template_file, :ugly => production?).render(self, locals)
+        if Open.exists?(documentation_file)
+          markdown = Open.read(documentation_file)
+          documentation_layout_file = locate_template('documented_section').find
+          Tilt::HamlTemplate.new(documentation_layout_file, :filename => documentation_layout_file, :ugly => production?).render(self, :markdown => markdown) do
+            Tilt::HamlTemplate.new(template_file, :filename => template_file, :ugly => production?).render(self, locals)
+          end
+        else
+          Tilt::HamlTemplate.new(template_file, :filename => template_file, :ugly => production?).render(self, locals)
+        end
       end
     end
+
   end
 
   def render_sass(file)

data/lib/rbbt/rest/entity/entity_card.rb

@@ -3,11 +3,21 @@ class EntityCard
   attr_accessor :entity
   attr_accessor :name, :long_name, :description, :meta
   attr_accessor :list_container, :action_controller
+  attr_accessor :sections
 
   def initialize(entity)
     @entity = entity
   end
 
+
+  def sections
+    @sections ||= IndiferentHash.setup({})
+  end
+
+  def add_section(name, &block)
+    sections[name] = block
+  end
+
   %w(name long_name description meta).each do |method|
     self.send(:define_method, method.to_sym) do |&block|
       if block
@@ -24,3 +34,4 @@ module EntityRESTHelpers
     partial_render('entity_partials/entity_card', :card => card, :block => block)
   end
 end
+

data/lib/rbbt/rest/entity/entity_list_card.rb

@@ -3,11 +3,20 @@ class EntityListCard
   attr_accessor :list, :list_id
   attr_accessor :meta, :description
   attr_accessor :action_controller, :list_container
+  attr_accessor :sections
 
   def initialize(list, list_id)
     @list, @list_id = list, list_id
   end
 
+  def sections
+    @sections ||= IndiferentHash.setup({})
+  end
+
+  def add_section(name, &block)
+    sections[name] = block
+  end
+
   %w(meta description).each do |method|
     self.send(:define_method, method.to_sym) do |&block|
       if block

data/lib/rbbt/rest/entity/locate.rb

@@ -15,21 +15,14 @@ module EntityRESTHelpers
   end
  
   #{{{ CHECKS
-
-  def reject_template(path, binding)
-    check_file = path.sub(/\.haml$/, '.check')
-
-    if Path === path
-      path.annotate check_file 
-      return false unless check_file.exists?
-    else
-      return false unless File.exists?(check_file)
-    end
-
+  
+  def reject?(check_file, binding)
+    return false if check_file.nil? or not check_file.exists?
     begin
       code = Open.read(check_file)
       accept = eval code, binding, check_file, 0
-      Log.debug{"Checking action template: #{path} - #{accept ? 'accepted' : 'rejected'}"}
+      action = File.basename(check_file).sub('.check', '')
+      Log.debug{"Checking action template: #{action} - #{accept ? 'accepted' : 'rejected'}"}
       return ! accept
     rescue 
       Log.exception $!
@@ -38,51 +31,22 @@ module EntityRESTHelpers
     false
   end
 
-  #{{{ ENTITY
-
-  #def locate_entity_template_from_resource(resource, entity)
-  #  if entity == "Default" 
-  #    path = resource.entity["Default.haml"]
-  #    if path.exists?
-  #      return path
-  #    else
-  #      return nil
-  #    end
-  #  end
-
-  #  entity.annotation_types.each do |annotation|
-  #    path = resource.entity[annotation.to_s + ".haml"]
-  #    return path if path.exists?
-  #  end
-
-  #  nil
-  #end   
-
-  #def locate_entity_template(entity)
-
-  #  if entity.respond_to? :dir and Path === entity.dir
-  #    entity_views = entity.dir.www.views
-
-  #    entity.annotation_types.each do |annotation|
-  #      path = entity_views.entity[annotation.to_s + ".haml"]
-  #      return path if path.exists?
-  #    end
-  #  end
-
-  #  entity_resources.each do |resource|
-  #    path = locate_entity_template_from_resource(resource, entity)
-  #    return path if path and path.exists?
-  #  end
+  def reject_template(path, binding)
+    return false if path.nil?
+    check_file = path.sub(/\.haml$/, '.check')
 
-  #  entity_resources.each do |resource|
-  #    path = locate_entity_template_from_resource(resource, "Default")
-  #    return path if path and path.exists?
-  #  end
+    if Path === path
+      path.annotate check_file 
+      return false unless check_file.exists?
+    else
+      return false unless File.exists?(check_file)
+    end
 
-  #  raise "Template not found for entity: #{ entity } (#{entity.annotation_types * ", "})"
-  #end
+    reject?(check_file, binding)
+  end
 
- 
+  #{{{ ENTITY
+  
   def locate_entity_template(entity)
     resources = resources_for_entity(entity)
 
@@ -99,50 +63,6 @@ module EntityRESTHelpers
     path
   end
 
-
-  #{{{ ENTITY ACTION
-
-  #def locate_entity_action_template_from_resource(resource, entity, action)
-  #  if entity == "Default" 
-  #    path = resource.entity["Default"][action.to_s + ".haml"]
-  #    raise "This action was rejected: #{ action }" if path and reject_template(path,binding)
-  #    if path.exists?
-  #      return path
-  #    else
-  #      return nil
-  #    end
-  #  end
-
-  #  entity.annotation_types.each do |annotation|
-  #    path = resource.entity[annotation][action.to_s + ".haml"]
-  #    raise "This action was rejected: #{ action }" if path and reject_template(path,binding)
-  #    return path if path.exists?
-  #  end
-
-  #  nil
-  #end   
-
-  #def locate_entity_action_template(entity, action)
-
-  #  if entity.respond_to? :dir and Path === entity.dir
-  #    path = locate_entity_action_template_from_resource(entity.dir.www.views, entity, action)
-  #    return path if path and path.exists?
-  #  end
-
-  #  entity_resources.each do |resource|
-  #    path = locate_entity_action_template_from_resource(resource, entity, action)
-  #    return path if path and path.exists?
-  #  end
-
-  #  entity_resources.each do |resource|
-  #    path = locate_entity_action_template_from_resource(resource, "Default", action)
-  #    raise "This action was rejected: #{ action }" if reject_template(path,binding)
-  #    return path if path and path.exists?
-  #  end
-
-  #  raise "Template not found for action #{action}: #{ entity } (#{entity.annotation_types * ", "})"
-  #end
-
   def locate_entity_action_template(entity, action)
     resources = resources_for_entity(entity)
 
@@ -153,7 +73,8 @@ module EntityRESTHelpers
     types.each do |type|
       next if path
       path = locate_server_file(["entity", type, action]*"/", resources, 'haml')
-      raise "This action was rejected: #{ action }" if reject_template(path,binding)
+      check_file = locate_server_file(["entity", type, action]*"/", resources, 'check')
+      raise "This action was rejected: #{ action }" if reject?(check_file, binding)
     end
 
     raise TemplateMissing, "Template not found for entity action #{action}: #{ entity } (#{entity.annotation_types * ", "})" if path.nil?
@@ -168,9 +89,18 @@ module EntityRESTHelpers
     types << "Default"
 
     paths = types.inject([]) do |acc,type|
-      acc += glob_all_server_files(["entity", type, "*.haml"]*"/", resources).reject{|path|
-        reject_template(path,binding)
+      all_files  = glob_all_server_files(["entity", type, "*.haml"]*"/", resources)
+      all_checks = glob_all_server_files(["entity", type, "*.check"]*"/", resources)
+      rejected = []
+      all_checks.each do |check_file|
+        rejected << File.basename(check_file).sub('.check', '') if reject?(check_file, binding)
+      end
+
+      accepted = all_files.reject{|path|
+        rejected.include? File.basename(path).sub('.haml', '')
       }
+
+      acc += accepted
     end
 
     if check
@@ -192,93 +122,8 @@ module EntityRESTHelpers
     actions
   end
 
-  #def find_all_entity_action_templates_from_resource(resource, entity)
-  #  if entity == "Default" 
-  #    resource.entity["Default"].glob("*.haml").sort
-  #  else
-  #    entity.annotation_types.collect do |annotation|
-  #      resource.entity[annotation].glob('*.haml')
-  #    end.compact.flatten.sort
-  #  end
-  #end   
-
-  #def find_all_entity_action_templates(entity, check = false)
-  #  paths = []
-
-  #  if entity.respond_to? :dir and Path === entity.dir
-  #    paths.concat find_all_entity_action_templates_from_resource(entity.dir.www.views, entity)
-  #  end
-
-  #  entity_resources.each do |resource|
-  #    paths.concat find_all_entity_action_templates_from_resource(resource, entity)
-  #  end
-
-  #  entity_resources.each do |resource|
-  #    paths.concat find_all_entity_action_templates_from_resource(resource, "Default")
-  #  end
-
-  #  if check
-  #    paths = paths.reject do |path|
-  #      (path.basename == "edit.haml" or path.basename == 'new.haml') 
-  #    end
-  #  end
-
-  #  actions = paths.collect{|file| file.basename.sub('.haml', '') }.uniq
-
-  #  actions.select! do |action|
-  #    begin
-  #      locate_entity_action_template(entity, action)
-  #    rescue Exception
-  #      false
-  #    end
-  #  end if check
-  #  
-  #  actions
-  #end
   #{{{ ENTITY LIST
-
-  #def locate_entity_list_template_from_resource(resource, list)
-  #  if list == "Default" 
-  #    path = resource.entity_list["Default.haml"]
-  #    if path.exists?
-  #      return path
-  #    else
-  #      return nil
-  #    end
-  #  end
-
-  #  list.annotation_types.each do |annotation|
-  #    path = resource.entity_list[annotation.to_s + ".haml"]
-  #    return path if path.exists?
-  #  end
-
-  #  nil
-  #end   
-
-  #def locate_entity_list_template(list)
-
-  #  if list.respond_to? :dir and Path === list.dir
-  #    list_views = list.dir.www.views
-
-  #    list.annotation_types.each do |annotation|
-  #      path = list_views.entity_list[annotation.to_s + ".haml"]
-  #      return path if path.exists?
-  #    end
-  #  end
-
-  #  entity_resources.each do |resource|
-  #    path = locate_entity_list_template_from_resource(resource, list)
-  #    return path if path and path.exists?
-  #  end
-
-  #  entity_resources.each do |resource|
-  #    path = locate_entity_list_template_from_resource(resource, "Default")
-  #    return path if path and path.exists?
-  #  end
-
-  #  raise "Template not found for list (#{list.annotation_types * ", "})"
-  #end
-
+  
   def locate_entity_list_template(list)
     resources = resources_for_entity(list)
 
@@ -295,96 +140,6 @@ module EntityRESTHelpers
     path
   end
 
-
-
-  #{{{ ENTITY LIST ACTION
- 
- 
-  #def locate_entity_list_action_template_from_resource(resource, list, action)
-  #  if list == "Default" 
-  #    path = resource.entity_list["Default"][action.to_s + ".haml"]
-  #    raise "This action was rejected: #{ action }" if path and reject_template(path,binding)
-  #    if path.exists?
-  #      return path
-  #    else
-  #      return nil
-  #    end
-  #  end
-
-  #  list.annotation_types.each do |annotation|
-  #    path = resource.entity_list[annotation][action.to_s + ".haml"]
-  #    raise "This action was rejected: #{ action }" if path and reject_template(path,binding)
-  #    return path if path.exists?
-  #  end
-
-  #  nil
-  #end   
-
-  #def locate_entity_list_action_template(list, action)
-
-  #  if list.respond_to? :dir and Path === list.dir
-  #    path = locate_entity_list_action_template_from_resource(list.dir.www.views, list, action)
-  #    return path if path and path.exists?
-  #  end
-
-  #  entity_resources.each do |resource|
-  #    path = locate_entity_list_action_template_from_resource(resource, list, action)
-  #    return path if path and path.exists?
-  #  end
-
-  #  entity_resources.each do |resource|
-  #    path = locate_entity_list_action_template_from_resource(resource, "Default", action)
-  #    return path if path and path.exists?
-  #  end
-
-  #  raise "Template not found for list #{ action } (#{list.annotation_types * ", "})"
-  #end
-
-  #def find_all_entity_list_action_templates_from_resource(resource, entity)
-
-  #  if entity == "Default" 
-  #    resource.entity_list["Default"].glob("*.haml").sort
-  #  else
-  #    entity.annotation_types.collect do |annotation|
-  #      resource.entity_list[annotation].glob('*.haml')
-  #    end.compact.flatten.sort
-  #  end
-  #end   
-
-  #def find_all_entity_list_action_templates(list, check = false)
-  #  paths = []
-
-  #  if list.respond_to? :dir and Path === list.dir
-  #    paths.concat find_all_entity_list_action_templates_from_resource(list.dir.www.views, list)
-  #  end
-
-  #  entity_resources.each do |resource|
-  #    paths.concat find_all_entity_list_action_templates_from_resource(resource, list)
-  #  end
-
-  #  entity_resources.each do |resource|
-  #    paths.concat find_all_entity_list_action_templates_from_resource(resource, "Default")
-  #  end
-
-  #  if check
-  #    paths = paths.reject do |path|
-  #      (path.basename == "edit.haml" or path.basename == 'new.haml') 
-  #    end
-  #  end
-
-  #  actions = paths.collect{|file| file.basename.sub('.haml', '') }.uniq
-
-  #  actions.select! do |action|
-  #    begin
-  #      locate_entity_list_action_template(list, action)
-  #    rescue Exception
-  #      false
-  #    end
-  #  end if check
-  #  
-  #  actions
-  #end
-
   def locate_entity_list_action_template(list, action)
     resources = resources_for_entity(list)
 
@@ -434,38 +189,8 @@ module EntityRESTHelpers
     actions
   end
 
-  #{{{ ENTITY MAP
-
-  #def locate_entity_map_template_from_resource(resource, type)
-  #  if type == "Default" 
-  #    path = resource.entity_map["Default.haml"]
-  #    if path.exists?
-  #      return path
-  #    else
-  #      return nil
-  #    end
-  #  end
-
-  #  path = resource.entity_map[type.to_s + ".haml"]
-  #  return path if path.exists?
-
-  #  nil
-  #end   
-
-  #def locate_entity_map_template(type, column)
-  #  entity_resources.each do |resource|
-  #    path = locate_entity_map_template_from_resource(resource, type)
-  #    return path if path and path.exists?
-  #  end
-
-  #  entity_resources.each do |resource|
-  #    path = locate_entity_map_template_from_resource(resource, "Default")
-  #    return path if path and path.exists?
-  #  end
-
-  #  raise "Template not found for list (#{type}--#{column})"
-  #end
 
+  #{{{ ENTITY MAP
 
   def locate_entity_map_template(type, column = nil)
     resources = entity_resources
@@ -483,81 +208,6 @@ module EntityRESTHelpers
     path
   end
 
-
-  #{{{ ENTITY MAP ACTION
- 
-  #def locate_entity_map_action_template_from_resource(resource, map, action)
-  #  field = map.key_field
-
-  #  if map.entity_templates[field] 
-  #    annotation_types = map.entity_templates[field].annotation_types
-  #  else
-  #    annotation_types = [Entity.formats[field]].compact
-  #  end
-
-  #  annotation_types += ["Default"]
-
-  #  annotation_types.each do |annotation|
-  #    path = resource.entity_map[annotation][action.to_s + ".haml"]
-  #    raise "This action was rejected: #{ action }" if path and reject_template(path,binding)
-  #    return path if path.exists?
-  #  end
-
-  #  nil
-  #end   
-
-  #def locate_entity_map_action_template(map, action)
-
-  #  entity_resources.each do |resource|
-  #    path = locate_entity_map_action_template_from_resource(resource, map, action)
-  #    return path if path and path.exists?
-  #  end
-
-  #  raise "Template not found for map #{ action } (#{map.key_field * ", "})"
-  #end
-
-  #def find_all_entity_map_action_templates_from_resource(resource, map)
-  #  field = map.key_field
-
-  #  if map.entity_templates[field] 
-  #    annotation_types = map.entity_templates[field].annotation_types
-  #  else
-  #    annotation_types = [Entity.formats[field]].compact
-  #  end
-
-  #  annotation_types += ["Default"]
-
-  #  annotation_types.collect do |annotation|
-  #    resource.entity_map[annotation].glob('*.haml')
-  #  end.compact.flatten
-  #end   
-
-  #def find_all_entity_map_action_templates(map, check = false)
-  #  paths = []
-
-  #  entity_resources.each do |resource|
-  #    paths.concat find_all_entity_map_action_templates_from_resource(resource, map)
-  #  end
-
-  #  if check
-  #    paths = paths.reject do |path|
-  #      (path.basename == "edit.haml" or path.basename == 'new.haml')
-  #    end
-  #  end
-
-  #  actions = paths.collect{|file| file.basename.sub('.haml', '') }.uniq
-
-  #  actions.select! do |action|
-  #    begin
-  #      locate_entity_map_action_template(map, action)
-  #    rescue Exception
-  #      false
-  #    end
-  #  end if check
-  #  
-  #  actions
-  #end
-   
   def locate_entity_map_action_template(map, action)
     resources = entity_resources