Class: RDoc::Generator::Hanna

Inherits:
Object
  • Object
show all
Defined in:
lib/hanna-nouveau.rb

Constant Summary collapse

STYLE = 
'styles.sass'
LAYOUT = 
'layout.haml'
INDEX_PAGE = 
'index.haml'
CLASS_PAGE = 
'page.haml'
METHOD_LIST_PAGE = 
'method_list.haml'
FILE_PAGE = 
CLASS_PAGE
SECTIONS_PAGE = 
'sections.haml'
FILE_INDEX = 
'file_index.haml'
CLASS_INDEX = 
'class_index.haml'
METHOD_INDEX = 
'method_index.haml'
CLASS_DIR = 
'classes'
FILE_DIR = 
'files'
INDEX_OUT = 
'index.html'
FILE_INDEX_OUT = 
'fr_file_index.html'
CLASS_INDEX_OUT = 
'fr_class_index.html'
METHOD_INDEX_OUT = 
'fr_method_index.html'
STYLE_OUT = 
File.join('css', 'style.css')
DESCRIPTION = 
'a HAML-based HTML generator that scales'

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(store, options) ⇒ Hanna

Returns a new instance of Hanna.



79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/hanna-nouveau.rb', line 79

def initialize( store, options )
  @options = options
  @store = store

  @templatedir = Pathname.new File.expand_path('../hanna-nouveau/template_files', __FILE__)

  @files      = nil
  @classes    = nil
  @methods    = nil
  @attributes = nil

  @basedir = Pathname.pwd.expand_path
end

Class Method Details

.for(options) ⇒ Object 



75
76
77
 
# File 'lib/hanna-nouveau.rb', line 75

def self::for( options )
  new( options )
end

Instance Method Details

#build_javascript_search_index(entries) ⇒ Object 



300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/hanna-nouveau.rb', line 300

def build_javascript_search_index(entries)
  result = "var search_index = [\n"
  entries.each do |entry|
    method_name = entry.name
    module_name = entry.parent_name
    # FIXME link
    html = link_to_method(entry, [classfile(entry.parent), (entry.aref rescue "method-#{entry.html_name}")].join('#'))
    result << "  { method: '#{method_name.downcase}', " +
                    "module: '#{module_name.downcase}', " +
                    "html: '#{html}' },\n"
  end
  result << "]"
  result
end

#class_dir ⇒ Object 



258
259
260
 
# File 'lib/hanna-nouveau.rb', line 258

def class_dir
  CLASS_DIR
end

#classfile(klass) ⇒ Object 



334
335
336
337
 
# File 'lib/hanna-nouveau.rb', line 334

def classfile(klass)
  # FIXME sloooooooow
  Pathname.new(File.join(CLASS_DIR, klass.full_name.split('::')) + '.html')
end

#file_dir ⇒ Object 



262
263
264
 
# File 'lib/hanna-nouveau.rb', line 262

def file_dir
  FILE_DIR
end

#frame_link(content) ⇒ Object

probably should bring in nokogiri/libxml2 to do this right.. not sure if it’s worth it.



250
251
252
253
254
255
256
 
# File 'lib/hanna-nouveau.rb', line 250

def frame_link(content)
  content.gsub(%r!<a href="http://[^>]*>!).each do |tag|
    a_tag, rest = tag.split(' ', 2)
    rest.gsub!(/target="[^"]*"/, '')
    a_tag + ' target="_top" ' + rest
  end
end

#generate ⇒ Object 



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/hanna-nouveau.rb', line 93

def generate
  @outputdir = Pathname.new( @options.op_dir ).expand_path( @basedir )

  @files      = @store.all_files.sort
  @classes    = @store.all_classes_and_modules.sort
  @methods    = @classes.map {|m| m.method_list }.flatten.sort
  @attributes = @classes.map(&:attributes).flatten.sort

  # Now actually write the output
  write_static_files
  generate_indexes
  generate_class_files
  generate_file_files

rescue StandardError => err
  p [ err.class.name, err.message, err.backtrace.join("\n  ") ]
  raise
end

#generate_class_files ⇒ Object 



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/hanna-nouveau.rb', line 182

def generate_class_files
  class_page       = haml_file(templjoin(CLASS_PAGE))
  method_list_page = haml_file(templjoin(METHOD_LIST_PAGE))
  sections_page    = haml_file(templjoin(SECTIONS_PAGE))
  # FIXME refactor

  @classes.each do |klass|
    outfile = classfile(klass)
    stylesheet = Pathname.new(STYLE_OUT).relative_path_from(outfile.dirname)
    sections = {}
    klass.each_section do |section, constants, attributes|
      method_types = []
      alias_types = []
      klass.methods_by_type(section).each do |type, visibilities|
        visibilities.each do |visibility, methods|
          aliases, methods = methods.partition{|x| x.is_alias_for}
          method_types << ["#{visibility.to_s.capitalize} #{type.to_s.capitalize}", methods.sort] unless methods.empty?
          alias_types << ["#{visibility.to_s.capitalize} #{type.to_s.capitalize}", aliases.sort] unless aliases.empty?
        end
      end
      sections[section] = {:constants=>constants, :attributes=>attributes, :method_types=>method_types, :alias_types=>alias_types}
    end

    values = { 
      :file => klass.path, 
      :entry => klass,
      :stylesheet => stylesheet,
      :classmod => klass.type,
      :title => klass.full_name,
      :list_title => nil,
      :description => klass.description,
      :sections => sections
    } 

    result = with_layout(values) do 
      h = {:values => values}
      class_page.to_html(binding, h) do 
        method_list_page.to_html(binding, h) + sections_page.to_html(binding, h)
      end
    end

    # FIXME XXX sanity check
    dir = outfile.dirname
    unless File.directory? dir
      FileUtils.mkdir_p dir
    end

    File.open(outfile, 'w') { |f| f << result }
  end
end

#generate_file_files ⇒ Object 



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
 
# File 'lib/hanna-nouveau.rb', line 147

def generate_file_files
  file_page = haml_file(templjoin(FILE_PAGE))
  method_list_page = haml_file(templjoin(METHOD_LIST_PAGE))

  # FIXME non-Ruby files
  @files.each do |file|
    path = Pathname.new(file.path)
    stylesheet = Pathname.new(STYLE_OUT).relative_path_from(path.dirname)
    
    values = { 
      :file => file, 
      :entry => file,
      :stylesheet => stylesheet,
      :classmod => nil, 
      :title => file.base_name, 
      :list_title => nil,
      :description => file.description
    } 

    result = with_layout(values) do 
      file_page.to_html(binding, :values => values) do 
        method_list_page.to_html(binding, values) 
      end
    end

    # FIXME XXX sanity check
    dir = path.dirname
    unless File.directory? dir
      FileUtils.mkdir_p dir
    end

    File.open(outjoin(file.path), 'w') { |f| f << result }
  end
end

#generate_index(outfile, templfile, index_name, values) ⇒ Object 



132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/hanna-nouveau.rb', line 132

def generate_index(outfile, templfile, index_name, values)
  values.merge!({
    :stylesheet => STYLE_OUT,
    :list_title => "#{index_name} Index"
  })

  index = haml_file(templjoin(templfile))

  File.open(outjoin(outfile), 'w') do |f| 
    f << with_layout(values) do
           index.to_html(binding, values)
         end
  end
end

#generate_indexes ⇒ Object

FIXME refactor



123
124
125
126
127
128
129
130
 
# File 'lib/hanna-nouveau.rb', line 123

def generate_indexes
  @main_page_uri = @files.find { |f| f.name == @options.main_page }.path rescue ''
  File.open(outjoin(INDEX_OUT), 'w') { |f| f << haml_file(templjoin(INDEX_PAGE)).to_html(binding) }

  generate_index(FILE_INDEX_OUT,   FILE_INDEX,   'File',   { :files => @files})
  generate_index(CLASS_INDEX_OUT,  CLASS_INDEX,  'Class',  { :classes => @classes })
  generate_index(METHOD_INDEX_OUT, METHOD_INDEX, 'Method', { :methods => @methods, :attributes => @attributes })
end

#h(html) ⇒ Object 



266
267
268
 
# File 'lib/hanna-nouveau.rb', line 266

def h(html)
  CGI::escapeHTML(html)
end

#haml_file(file) ⇒ Object 



347
348
349
 
# File 'lib/hanna-nouveau.rb', line 347

def haml_file(file)
  Haml::Engine.new(File.read(file), :format => :html4)
end

#link_to(text, url = nil, classname = nil) ⇒ Object 



315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/hanna-nouveau.rb', line 315

def link_to(text, url = nil, classname = nil)
  class_attr = classname ? ' class="%s"' % classname : ''

  if url
      %[<a href="#{url}"#{class_attr}>#{text}</a>]
  elsif classname
      %[<span#{class_attr}>#{text}</span>]
  else
    text
  end
end

#link_to_method(entry, url = nil, classname = nil) ⇒ Object

method_text is in the form of “ago (ActiveSupport::TimeWithZone)”.



328
329
330
331
332
 
# File 'lib/hanna-nouveau.rb', line 328

def link_to_method(entry, url = nil, classname = nil)
  method_name = entry.pretty_name rescue entry.name
  module_name = entry.parent_name rescue entry.name
  link_to %Q(<span class="method_name">#{h method_name}</span> <span class="module_name">(#{h module_name})</span>), url, classname
end

#outjoin(name) ⇒ Object 



339
340
341
 
# File 'lib/hanna-nouveau.rb', line 339

def outjoin(name)
  File.join(@outputdir, name)
end

#render_class_tree(entries, parent = nil) ⇒ Object

XXX may my sins be not visited upon my sons.



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/hanna-nouveau.rb', line 271

def render_class_tree(entries, parent=nil)
  namespaces = { }

  entries.sort.inject('') do |out, klass|
    unless namespaces[klass.full_name]
      if parent
        text = '<span class="parent">%s::</span>%s' % [parent.full_name, klass.name]
      else
        text = klass.name
      end

      if klass.document_self
        out << '<li>'
        out << link_to(text, classfile(klass))
      end

      subentries = @classes.select { |x| x.full_name[/^#{klass.full_name}::/] }
      subentries.each { |x| namespaces[x.full_name] = true }
      out << "\n<ol>" + render_class_tree(subentries, klass) + "\n</ol>"

      if klass.document_self
        out << '</li>'
      end
    end

    out
  end
end

#sanitize_code_blocks(text) ⇒ Object 



238
239
240
241
242
243
244
245
246
 
# File 'lib/hanna-nouveau.rb', line 238

def sanitize_code_blocks(text)
  text.gsub(/<pre>(.+?)<\/pre>/m) do
    code = $1.sub(/^\s*\n/, '')
    indent = code.gsub(/\n[ \t]*\n/, "\n").scan(/^ */).map{ |i| i.size }.min
    code.gsub!(/^#{' ' * indent}/, '') if indent > 0

      "<pre>#{code}</pre>"
  end
end

#templjoin(name) ⇒ Object 



343
344
345
 
# File 'lib/hanna-nouveau.rb', line 343

def templjoin(name)
  File.join(@templatedir, name)
end

#with_layout(values) ⇒ Object 



233
234
235
236
 
# File 'lib/hanna-nouveau.rb', line 233

def with_layout(values)
  layout = haml_file(templjoin(LAYOUT))
  layout.to_html(binding, :values => values) { yield }
end

#write_static_files ⇒ Object 



112
113
114
115
116
117
118
119
120
 
# File 'lib/hanna-nouveau.rb', line 112

def write_static_files
  css_dir = outjoin('css')

  unless File.directory?(css_dir)
    FileUtils.mkdir css_dir
  end

  File.open(File.join(css_dir, 'style.css'), 'w') { |f| f << Sass::Engine.new(File.read(templjoin(STYLE))).to_css }
end