Module: Nitro::Publishable

Included in:
Controller
Defined in:
lib/nitro/publishable.rb

Class Method Summary collapse

Class Method Details

.included(base) ⇒ Object 



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/nitro/publishable.rb', line 43

def self.included(base)
  super

  base.module_eval do
    include Render
    include Aspects
    include Flashing
    include Helpers

    # The collection of 'models' ie classes that are linked
    # to this Publishable/Controller.
    
    ann :self, :models => []

    # This is a helper that 'links' one or more classes to this
    # controller. In practice it annotates each class with the 
    # controller and stores the controller's list of 'models'.
    
    def self.model *classes
      for c in classes
        c.ann :self, :controller => self
        self.ann.self.models! << c
      end
    end
  end

  base.helper(EncodeUrl)

  # Aliases an action
  #--
  # gmosx, FIXME: better implementation needed.
  # gmosx, FIXME: copy all annotations.
  #++

  base.module_eval do
    def self.alias_action(new, old)
      alias_method new, old
      ann new, :template => old        
    end
  end

  # Return the 'action' methods for this Controller.
  # Some dangerous methods from ancestors are removed.
  # All private methods are ignored.
  #--
  # gmosx, TODO: maybe we should optimize this method.
  #++

  base.module_eval do
    def self.action_methods
      classes = self.ancestors - [Object, Kernel, Render, Controller, Caching]

      classes.delete(PP::ObjectMixin) if defined?(PP::ObjectMixin)
      
      methods =  classes.inject([]) do |action_methods, klass| 
        action_methods + klass.public_instance_methods(false) 
      end
      
      return methods
    end
  end
      
  # Use the method_missing hook to compile the actions
  # for this controller.

  base.module_eval do
    def method_missing(action, *args)
      if Compiler.new(self.class).compile(action)
        send(action, *args)
      else
        super
      end
    end
  end    

  # Does this publishable respond to the given action?
  
  base.module_eval do
    class << self
      def respond_to_action?(action)
        action_methods.include?(action.to_s)              
      end
      alias action? respond_to_action?
    end
  end

  # Does this publishable respond to the given template?
  
  base.module_eval do
    class << self
      def respond_to_template?(action)
        Compiler.new(self).template?(action.to_s)
      end
      alias template? respond_to_template?
    end
  end
      
  # Does this class respond to the given action? 
  # Also looks for templates in the template root.
  #
  # Prefer to use the compiler for this.
  #--
  # THINK: maybe move template? here
  #++

  base.module_eval do
    class << self
      def respond_to_action_or_template?(sym)
        #--
        # gmosx, FIXME: optimize this!
        #++
        return self.respond_to_action?(sym) || self.respond_to_template?(sym) 
      end
    end
  end
      
  base.module_eval do
    class << self
      # Override this method to customize the template_root.
      # Typically used in controllers defined in reusable Parts.
      # Call super to include the parent class's customizations.
      #
      # def setup_template_root(path)
      #   super
      #   @template_root << "custom/route/#{path}"
      #   @template_root << "another/route/#{path}"
      # end  
      
      def setup_template_root(path)
      end
      
      def mount_at(path)
        # Store the mount_path (where the controller is mounted).
        
        @mount_path = path
        
        # Update template_root. Unshift the PROTO_TEMPLATE_ROOT, 
        # and unshift a template_root relative to the 
        # application template root.
      
        @template_root = []
        @template_root << File.join(Compiler::PROTO_TEMPLATE_ROOT, path).gsub(/\/$/, '')
        setup_template_root(path)
        @template_root << File.join(Nitro::Template.root, path).gsub(/\/$/, '')
        @template_root.reverse!
      end
      alias_method :mount, :mount_at

      # Returns the path where this controller is mounted.
      
      def mount_path
        @mount_path
      end
      alias mount_point mount_path
    end
  end
  
end