Basic Introspection

lib/curly/presenter.rb

@@ -173,6 +173,13 @@ def presenter_for_name(name)
         end
       end
 
+      def presenter_for?(name)
+        presenter_for_name(name)
+        true
+      rescue NameError
+        false
+      end
+
       # Whether a component is available to templates rendered with the presenter.
       #
       # Templates have components which correspond with methods defined on
@@ -199,6 +206,61 @@ def available_components
         methods.map(&:to_s)
       end
 
+      # Gives a description of the presenter.  Gives information about its
+      # components, and what parameters they are allowed.
+      #
+      # Returns a Hash.
+      def description
+        result = {}
+        components = result[:components] = []
+
+        available_components.each do |component|
+          data = { name: component, type: "", parameters: [] }
+
+          if component.end_with?("?")
+            data[:type] = "conditional"
+          elsif presenter_for?(component)
+            data[:type] = "context"
+          elsif presenter_for?(component.singularize)
+            data[:type] = "collection"
+          else
+            data[:type] = "value"
+          end
+
+          instance_method(component.intern).parameters.each do |param|
+            add = {}
+            add[:name] = param[1].to_s
+
+            case param[0]
+            when :keyreq
+              add[:type]     = "keyword"
+              add[:required] = true
+            when :req
+              add[:type]     = "normal"
+              add[:required] = true
+            when :key
+              add[:type]     = "keyword"
+              add[:required] = false
+            when :opt
+              add[:type]     = "normal"
+              add[:required] = false
+            when :block
+              add[:type]     = "block"
+              add[:required] = false
+            else
+              add[:type]     = "unknown"
+              add[:required] = false
+            end
+
+            data[:parameters] << add
+          end
+
+          components << data
+        end
+
+        result
+      end
+
       # The set of view paths that the presenter depends on.
       #
       # Example

spec/presenter_spec.rb

@@ -13,6 +13,26 @@ def monkey
     presents :elephant, default: "Dumbo"
 
     attr_reader :midget, :clown, :elephant
+
+    def alpha(name, age = 12)
+      name
+    end
+
+    def beta(test:, this: "thing")
+      test + this
+    end
+
+    def charlie(&test)
+    end
+
+    def delta?
+      false
+    end
+
+    def cats
+    end
+
+    class CatPresenter < Curly::Presenter; end
   end
 
   class FrenchCircusPresenter < CircusPresenter
@@ -112,6 +132,41 @@ class CircusPresenter::MonkeyPresenter < Curly::Presenter
     end
   end
 
+  describe ".description" do
+    it "gives a hash" do
+      CircusPresenter.description.should be_a Hash
+    end
+
+    it "describes the components" do
+      description = CircusPresenter.description
+
+      description[:components].should have(9).items
+      description[:components].should == [
+        { name: "midget",   type: "value", parameters: [] },
+        { name: "clown",    type: "value", parameters: [] },
+        { name: "elephant", type: "value", parameters: [] },
+
+        { name: "alpha",  type: "value", parameters: [
+          { name: "name", type: "normal", required: true },
+          { name: "age",  type: "normal", required: false }
+        ]},
+
+        {   name: "beta", type: "value", parameters: [
+          { name: "test", type: "keyword", required: true },
+          { name: "this", type: "keyword", required: false }
+        ]},
+
+        { name: "charlie", type: "value", parameters: [
+          { name: "test", type: "block", required: false }
+        ]},
+
+        { name: "delta?", type: "conditional", parameters: [] },
+        { name: "cats", type: "collection", parameters: [] },
+        { name: "monkey",   type: "context", parameters: [] }
+      ]
+    end
+  end
+
   describe ".version" do
     it "sets the version of the presenter" do
       presenter1 = Class.new(Curly::Presenter) do