app/models/note_mailer.rb app/views/doc/advanced_search.rhtml app/views/doc/file_contents.rhtml app/views/doc/library.rhtml app/views/doc/partials/_list.rhtml app/views/note_mailer/admin.rhtml app/views/note_mailer/confirm.rhtml db/migrate/005_email_for_notes.rb test/fixtures/note_mailer/admin test/fixtures/note_mailer/confirm test/unit/note_mailer_test.rb @@ -68,3 +68,30 @@ task "doc:api:rails" do RDoc::RDoc.new.document(params + dirs) end + +task "doc:api:rails_vendor" do + params = [] + params << "--fmt=yaml" + params << "--opname=rails-1.1.2" + dirs = [] + dirs << 'vendor/rails/railties/README' + dirs << 'vendor/rails/railties/CHANGELOG' + dirs << 'vendor/rails/railties/MIT-LICENSE' + dirs << 'vendor/rails/activerecord/README' + dirs << 'vendor/rails/activerecord/CHANGELOG' + dirs << 'vendor/rails/activerecord/lib/' + dirs << 'vendor/rails/actionpack/README' + dirs << 'vendor/rails/actionpack/CHANGELOG' + dirs << 'vendor/rails/actionpack/lib/' + dirs << 'vendor/rails/actionmailer/README' + dirs << 'vendor/rails/actionmailer/CHANGELOG' + dirs << 'vendor/rails/actionmailer/lib/' + dirs << 'vendor/rails/actionwebservice/README' + dirs << 'vendor/rails/actionwebservice/CHANGELOG' + dirs << 'vendor/rails/actionwebservice/lib/' +# dirs << 'vendor/rails/activesupport/README' + dirs << 'vendor/rails/activesupport/CHANGELOG' + dirs << 'vendor/rails/activesupport/lib/' + + RDoc::RDoc.new.document(params + dirs) +end Rakefile @@ -2,6 +2,55 @@ class Admin::NotesController < ApplicationController before_filter :login_required helper :notes layout 'admin/admin.rhtml' + + def show + # Start main code + s = File.open("d:\\rails_site_notes.xml").read + array = s.scan(/<entry>.*?<title type="text">New note for - ([^<]*)<\/t.*?d>([^<]*)<\/p.*?l">(.*?)<\/summ.*?e>([^<]*)</m) + + array.each do |entry| + n = Note.new + + if(s == "Index page") + container_name = "index" + note_type = "index" + note_group = "index" + elsif(s =~ /Method/) + m = s.match(/Method ([a-zA-z0-9_]+) of ([a-zA-z0-9_:]+)/) + container_name = m[1] + note_type = "RaMethod" + note_group = m[0] # method name + elseif(s =~ / section of /) + m = s.match(/([a-zA-z0-9_]+) section of ([a-zA-z0-9_:]+)/) + container_name = m[1] + type = get_note_type(m[0]) + note_type = type + note_group = type + else + container_name = m + type = get_container_type(m) + note_type = type + note_group = type + end + + n.container_name = container_name + n.note_type = note_type + n.note_group = note_group + n.email = entry[4] + n.text = entry[3] + n.ip_address = "127.0.0.1" + n.created_at = entry[1] + n.updated_at = entry[1] + n.total_votes = 0 + n_version = "1.8.4" + n.status = 0 + + n.save + end + + puts "done!" + end + def index @note_filter = NoteFilter.new(@params['note_filter']) @@ -27,9 +76,7 @@ class Admin::NotesController < ApplicationController @note = Note.find(@params['id']) end - def show - @note = Note.find(@params['id']) - end + # update a note and expire the cache if necessary def update @@ -63,8 +110,35 @@ class Admin::NotesController < ApplicationController Note.delete(note.id) end end - -private + + # show the list of notes waiting for moderation + def list_moderate + @notes = Note.find(:all, :conditions => ["approved = ?", false]) + end + + def moderate + # get the list of notes to approve + # get the list of notes to delete + # get the list of notes to hide + end +def get_contanier_type(type_string) + container = RaContainer.find_by_name(type_string) + return container.class.to_s +end + +def get_note_type(type_string) + case type_string + when "Method" then return "RaMethod" + when "Children" then return "RaChildren" + when "InFiles" then return "RaInFile" + when "Attributes" then return "RaAttribute" + when "Constants" then return "RaConstant" + when "Includes" then return "RaInclude" + when "Requires" then return "RaRequire" + when "Aliases" then return "RaAlias" + end +end + end \ No newline at end of file app/controllers/admin/notes_controller.rb @@ -1,3 +1,5 @@ +require 'pp' + class Admin::UploadController < ApplicationController before_filter :login_required layout 'admin/admin.rhtml' @@ -13,12 +15,12 @@ class Admin::UploadController < ApplicationController # entry in the hash contains a list of all the library versions @libraries = Hash.new all_libs.each do |l| - unless @libraries[l.name] then @libraries[l.name] = Array.new end - @libraries[l.name].push(l) - end + unless @libraries[l.name] then @libraries[l.name] = Array.new end + @libraries[l.name].push(l) + end end - # delete a library and all of its contents + # delete libraries and all of their associated contents def delete library_ids = @params[:id] @@ -29,20 +31,33 @@ class Admin::UploadController < ApplicationController library = RaLibrary.find(library_id) name = library.name - - RaCodeObject.connection.delete("DELETE ra_code_objects FROM ra_code_objects, ra_containers WHERE ra_code_objects.ra_container_id = ra_containers.id AND ra_containers.ra_library_id = " + library_id) - RaInFile.connection.delete("DELETE ra_in_files FROM ra_in_files, ra_containers WHERE ra_in_files.ra_container_id = ra_containers.id AND ra_containers.ra_library_id = " + library_id) - RaSourceCode.connection.delete("DELETE ra_source_codes FROM ra_source_codes, ra_methods, ra_containers WHERE ra_source_codes.id = ra_methods.ra_source_code_id AND ra_methods.ra_container_id = ra_containers.id AND ra_containers.ra_library_id = " + library_id) - RaComment.connection.delete("DELETE ra_comments FROM ra_comments, ra_methods, ra_containers WHERE ra_comments.id = ra_methods.ra_comment_id AND ra_methods.ra_container_id = ra_containers.id AND ra_containers.ra_library_id = " + library_id) - RaMethod.connection.delete("DELETE ra_methods FROM ra_methods, ra_containers WHERE ra_methods.ra_container_id = ra_containers.id AND ra_containers.ra_library_id = " + library_id) - RaComment.connection.delete("DELETE ra_comments FROM ra_comments, ra_containers WHERE ra_comments.id = ra_containers.ra_comment_id AND ra_containers.ra_library_id =" + library_id) - RaContainer.connection.delete("DELETE FROM ra_containers WHERE ra_library_id = " + library_id) - RaLibrary.connection.delete("DELETE FROM ra_libraries WHERE id =" + library_id) + + # ok this really should be more activerecord'ish + # but I didn't have enough time to do that, so for now we know it works on + # two DBs, mysql and postgres + begin + RaCodeObject.connection.delete("DELETE ra_code_objects FROM ra_code_objects, ra_containers WHERE ra_code_objects.ra_container_id = ra_containers.id AND ra_containers.ra_library_id = " + library_id) + RaInFile.connection.delete("DELETE ra_in_files FROM ra_in_files, ra_containers WHERE ra_in_files.ra_container_id = ra_containers.id AND ra_containers.ra_library_id = " + library_id) + RaSourceCode.connection.delete("DELETE ra_source_codes FROM ra_source_codes, ra_methods, ra_containers WHERE ra_source_codes.id = ra_methods.ra_source_code_id AND ra_methods.ra_container_id = ra_containers.id AND ra_containers.ra_library_id = " + library_id) + RaComment.connection.delete("DELETE ra_comments FROM ra_comments, ra_methods, ra_containers WHERE ra_comments.id = ra_methods.ra_comment_id AND ra_methods.ra_container_id = ra_containers.id AND ra_containers.ra_library_id = " + library_id) + RaMethod.connection.delete("DELETE ra_methods FROM ra_methods, ra_containers WHERE ra_methods.ra_container_id = ra_containers.id AND ra_containers.ra_library_id = " + library_id) + RaComment.connection.delete("DELETE ra_comments FROM ra_comments, ra_containers WHERE ra_comments.id = ra_containers.ra_comment_id AND ra_containers.ra_library_id =" + library_id) + RaContainer.connection.delete("DELETE FROM ra_containers WHERE ra_library_id = " + library_id) + RaLibrary.connection.delete("DELETE FROM ra_libraries WHERE id =" + library_id) + rescue + RaCodeObject.connection.delete("DELETE FROM ra_code_objects WHERE id IN (SELECT ra.id FROM ra_code_objects AS ra, ra_containers AS rc, ra_libraries AS rl WHERE ra.ra_container_id = rc.id AND rc.ra_library_id = rl.id AND rl.id =" + library_id + ")") + RaInFile.connection.delete("DELETE FROM ra_in_files WHERE id in (SELECT ra.id FROM ra_in_files AS ra, ra_containers AS rc, ra_libraries AS rl WHERE ra.ra_container_id = rc.id AND rc.ra_library_id = rl.id AND rl.id =" + library_id + ")") + RaSourceCode.connection.delete("DELETE FROM ra_source_codes WHERE id IN (SELECT rs.id FROM ra_source_codes AS rs, ra_methods AS rm, ra_containers AS rc, ra_libraries AS rl WHERE rs.id = rm.ra_source_code_id AND rm.ra_container_id = rc.id AND rc.ra_library_id = rl.id AND rl.id =" + library_id + ")") + RaComment.connection.delete("DELETE FROM ra_comments WHERE id IN (SELECT rs.id FROM ra_comments AS rs, ra_methods AS rm, ra_containers AS rc, ra_libraries AS rl WHERE rs.id = rm.ra_comment_id AND rm.ra_container_id = rc.id AND rc.ra_library_id = rl.id AND rl.id =" + library_id + ")") + RaMethod.connection.delete("DELETE FROM ra_methods WHERE id IN (SELECT ra.id FROM ra_methods AS ra, ra_containers AS rc, ra_libraries AS rl WHERE ra.ra_container_id = rc.id AND rc.ra_library_id = rl.id AND rl.id =" + library_id + ")") + RaComment.connection.delete("DELETE FROM ra_comments WHERE id IN (SELECT rs.id FROM ra_comments AS rs, ra_containers AS rc, ra_libraries AS rl WHERE rs.id = rc.ra_comment_id AND rc.ra_library_id = rl.id AND rl.id =" + library_id + ")") + RaContainer.connection.delete("DELETE FROM ra_containers WHERE id IN (SELECT rc.id FROM ra_containers AS rc, ra_libraries AS rl WHERE rc.ra_library_id = rl.id AND rl.id =" + library_id + ")") + end # make sure that the highest library version is still marked as the current version libraries = RaLibrary.find(:all, :conditions => ["name = ?", name]) - max_lib = nil - max_ver = 0 + max_lib = nil + max_ver = 0 libraries.each do |lib| if(lib.version > max_ver) max_lib = lib @@ -60,139 +75,179 @@ class Admin::UploadController < ApplicationController redirect_to :action => :list end - # Try and avoid errors for PostgreSQL and maybe other databases too. - # If it fails, we log an exception instead of putting up an error page - # because we can still complete the mission, just slower? - def autocommit(state=true) - begin - ActiveRecord::Base.connection.execute( 'SET AUTOCOMMIT=' + state ? '1' : '0' ) - rescue - begin - ActiveRecord::Base.connection.execute( state ? 'BEGIN' : 'COMMIT' ) - rescue Exception => e - logger.info "Oops. #{e.to_s}\n" + e.backtrace.join + "\n" + # given a directory import all files from that directory + def mass_import + dir = params[:directory] + files = Dir.glob(dir + "/*.out") + + @success = [] + @total_count = 0 + + for file in files + do_import(file) + if(@error) + if(params[:ignore]) + @success << "failed: " + file + " " + @error + next + else + @success << "failed: " + file + " " + @error + break + end end + @success << "success: " + file end + + render :action => :create end + # import a single file def import - - init_classes() - - @connection = ActiveRecord::Base.connection + @total_count = 0 + do_import(params['doc_file'], true) + if(@error) + @success = [@error] + else + @success = ["success: " + params['doc_file'].original_filename] + end + + render :action => :create + end + +private - if(@connection.class.to_s =~ /mysql/i) - # check to see if the connection is MySQL, if so then we have created some - # optimizations for MySql inserts - @connection_type = "mysql" - else - @connection_type = "other" - end - - # Lookup hash used to map ids in the YAML file to database IDs - lookup = {} + # import a single library into the database + def do_import(file, tempfile = false) + init_classes() + + @connection = ActiveRecord::Base.connection + + if(@connection.class.to_s =~ /mysql/i) + # check to see if the connection is MySQL, if so then we have created some + # optimizations for MySql inserts + @connection_type = "mysql" + else + @connection_type = "other" + end - # Lookup hash used to keep columns around so that they do not need to be - # recreated each time - @col_hash = Hash.new + # Lookup hash used to map ids in the YAML file to database IDs + lookup = {} - file_name = @params['doc_file'].original_filename - match = /([a-zA-Z]+)-([0-9]+)\.([0-9]+)\.([0-9]+)\.out/.match(file_name) - if(!match) - @error = "File name must have the format name-major.minor.release.out, ex: rails-1.2.1.out" - render :action => :index - return - end + # Lookup hash used to keep columns around so that they do not need to be + # recreated each time + @col_hash = Hash.new + + # should we be reading the file passed in, or is it a file stream already + if(tempfile) + file_name = file.original_filename + else + file_name = file + end + match = /([a-zA-Z0-9]+)-([0-9]+)\.([0-9]+)\.([0-9]+)\.out/.match(file_name) + if(!match) + @error = "File name must have the format name-major.minor.release.out, ex: rails-1.2.1.out" + return + end - ActiveRecord::Base.connection.transaction do - # Create a new library object - @library = RaLibrary.new({:name => match[1], :major => match[2], :minor => match[3], :release => match[4]}) - @library.current = false - @library.date = DateTime.now - - if(@library.find_lib == nil) - @library.calc_version + # measure the time it takes to do the DB inserts + start = Time.now + count = 0 + # Set the logging level to ERROR so that we do not output SQL when we are debugging + # that really slows things down + loglevel = logger.level + logger.level = Logger::ERROR + + ActiveRecord::Base.connection.transaction do + autocommit(false) + # Create a new library object + @library = RaLibrary.new({:name => match[1], :major => match[2], :minor => match[3], :release => match[4]}) + @library.current = false + @library.date = DateTime.now + + if(@library.find_lib == nil) + @library.calc_version + @library.save! + # ok now we need to see if the library version that we uploaded is the most recent version of this library + higher_version = RaLibrary.find(:first, :conditions => ["name = ? AND version > ?", @library.name, @library.version]) + if(higher_version == nil) + # if our version is the most recent remove the current status from all the current entries + currents = RaLibrary.find(:all, :conditions => ["name = ? AND current = ?", @library.name, true]) + if(currents) + currents.each do |c| + c.current = false + c.save! + end + end + end + # now set the status of this library to be most recent and save it + @library.current = true @library.save! - # ok now we need to see if the library version that we uploaded is the most recent version of this library - higher_version = RaLibrary.find(:first, :conditions => ["name = ? AND version > ?", @library.name, @library.version]) - if(higher_version == nil) - # if our version is the most recent remove the current status from all the current entries - currents = RaLibrary.find(:all, :conditions => ["name = ? AND current = ?", @library.name, true]) - if(currents) - currents.each do |c| - c.current = false - c.save! - end - end - # now set the status of this library to be most recent and save it - @library.current = true - @library.save! - end - - # measure the time it takes to do the DB inserts - start = Time.now + else + @error = "Could not import library " + file_name + " already exists" + return + end + + # Read in the YAML file + if(!tempfile) + file = File.open(file) + end + + yp = YAML::load_documents( file ) { |doc| + # if this is a library record then merge the attributes + # with our library and save it (can provide more information) + if(doc.class.to_s == RaLibrary.to_s) + # if there is a 'main' attribute it will be the name of the + # file that should be displayed as the home page for this library + # this should be translated to the container id + if(doc.attributes['home_page'] != nil) + home_page = RaContainer.find(:first, :conditions => ["full_name = ? AND ra_library_id = ?", doc.home_page, @library.id]) + if(home_page != nil) + @library.main_container_id = home_page.id + end + end + + attr = doc.attributes + attr.delete("home_page") + @library.update_attributes(attr) + else + # Each record has a unique id. This id changes though when we insert it into the + # database. This would not be a problem except that all of the records are associated + # by these ids so when a record is inserted into the DB we need to make sure the associations are + # updated. get_ids takes care of this updating. + # + # IMPORTANT NOTE: This requires that the YAML is written out in the correct order so that we always insert + # a record before we need its id for an association + id = doc.id + get_ids(doc, lookup) + lookup[id] = insert_object(doc) + count = count + 1 + end + } - # Set the logging level to ERROR so that we do not output SQL when we are debugging - # that really slows things down - loglevel = logger.level - logger.level = Logger::ERROR - - autocommit(true) - - count = 0 - # Read in the YAML file - yp = YAML::load_documents( @params['doc_file'] ) { |doc| - - # Each record has a unique id. This id changes though when we insert it into the - # database. This would not be a problem except that all of the records are associated - # by these ids so when a record is inserted into the DB we need to make sure the associations are - # updated. get_ids takes care of this updating. - # - # IMPORTANT NOTE: This requires that the YAML is written out in the correct order so that we always insert - # a record before we need its id for an association. - id = doc.id - get_ids(doc, lookup) - lookup[id] = insert_object(doc) - count = count + 1 - } - - autocommit(false) - - @total_time = Time.now - start - @total_count = count - logger.level = loglevel - else - @error = "Could not import library, already exists" - end - end - - render :action => :create - end - -private - - # Insert an active record object into the DB - def insert_object(obj) - - if(@connection_type == "mysql") - obj.id = nil - # We don't want to use the ActiveRecord::Base.save method because it is slow - # ~1300 inserts on a MySQL DB MyIASM table on windows is 5.7 seconds with this method - # and 17.5 seconds using .save - unless(@col_hash[obj.class.to_s]) - @col_hash[obj.class.to_s] = column_list(obj.attributes.keys) - end - columns = @col_hash[obj.class.to_s] - values = value_list(obj.attributes.values) - - val = @connection.insert "INSERT INTO #{obj.class.table_name} (#{columns}) VALUES (#{values})" - else - # slower but works on PostgreSQL and other DBs where they cannot have a NULL id in the insert - obj.save - obj.id + if(!tempfile) + file.close + end + autocommit(true) end - end + + logger.level = loglevel + @total_time = Time.now - start + @total_count += count + end + + def insert_object(obj) + # We don't want to use the ActiveRecord::Base.save method because it is slow + # ~1300 inserts on a MySQL DB MyIASM table on windows is 5.7 seconds with this method + # and 17.5 seconds using .save + unless(@col_hash[obj.class.to_s]) + @col_hash[obj.class.to_s] = column_list(obj.attributes.keys.reject! { |key| key =~ /^id$/ }) + end + columns = @col_hash[obj.class.to_s] + attributes = obj.attributes + attributes.delete('id') # remove the id column + values = value_list(attributes.values) if attributes + val = @connection.insert "INSERT INTO #{obj.class.table_name} (#{columns}) VALUES (#{values})" if values + end # Create a list of column names from an array of strings def column_list(keys) @@ -202,36 +257,60 @@ private # Create a list of insertable values from an array of strings def value_list(values) - values.map { |v| ActiveRecord::Base.connection.quote(v).gsub('\\n', "\n").gsub('\\r', "\r") }.join(", ") + values.map { |v| ActiveRecord::Base.connection.quote(v).gsub('\n', "\\n").gsub('\r', "\\r") }.join(", ") end # Lookup the database ids for all the associations for this type of object - def get_ids(doc, lookup) - + def get_ids(doc, lookup) case(doc.class.superclass.to_s) when RaCodeObject.to_s doc.ra_container_id = lookup[doc.ra_container_id] + doc.file_id = lookup[doc.file_id] when RaContainer.to_s doc.parent_id = lookup[doc.parent_id] doc.ra_comment_id = lookup[doc.ra_comment_id] - doc.ra_library_id = @library.id + doc.ra_library_id = @library.id end + puts "#{doc.class.to_s} - #{doc.id}" + pp doc.attributes + puts "**" + case(doc.class.to_s) + when RaClass.to_s + doc.file_id = lookup[doc.file_id] + when RaModule.to_s + doc.file_id = lookup[doc.file_id] when RaMethod.to_s doc.ra_container_id = lookup[doc.ra_container_id] doc.ra_comment_id = lookup[doc.ra_comment_id] doc.ra_source_code_id = lookup[doc.ra_source_code_id] + doc.file_id = lookup[doc.file_id] when RaInFile.to_s doc.ra_container_id = lookup[doc.ra_container_id] end end - # if none of these classes has been previously used then the - # YAML load will fail because it will not find the class to be able to - # instantiate it, not sure why this happens, but this here fixes that issue - # by creating an instance of each class needed - def init_classes() + # Try and avoid errors for PostgreSQL and maybe other databases too. + # If it fails, we log an exception instead of putting up an error page + # because we can still complete the mission, just slower? + def autocommit(state=true) + begin + ActiveRecord::Base.connection.execute('SET AUTOCOMMIT = ' + (state ? '1' : '0') ) + rescue + begin + ActiveRecord::Base.connection.execute( state ? 'BEGIN' : 'COMMIT' ) + rescue Exception => e + logger.info "Oops. #{e.to_s}\n" + e.backtrace.join + "\n" + end + end + end + + # if none of these classes has been previously used then the + # YAML load will fail because it will not find the class to be able to + # instantiate it, not sure why this happens, but this here fixes that issue + # by creating an instance of each class needed + def init_classes() c = RaCodeObject.new c = RaInFile.new c = RaFile.new app/controllers/admin/upload_controller.rb @@ -1,91 +1,70 @@ class DocController < ApplicationController + + # turn off sessions to speed things up session :off # cache the main actions for this controller - caches_page :index, :list, :files, :modules, :classes, :libraries + caches_page :index, :container, :library, :list, :libraries, :history, :file_contents + # TODO: Document why the notes helper is needed here? helper :notes # display the index page with an optional home page def index if(RANNOTATE_HOME_PAGE != nil) main_page = RaContainer.find_highest_version(RANNOTATE_HOME_PAGE, 'RaFile') - if(main_page != nil) + if(main_page != nil) @home = main_page end - end - end - - # display a file - def files - if(params[:method]) - method(RaFile.to_s) - render :action => 'method' - else - get_container(RaFile.to_s) - render :action => 'container' - end - end - - # display a module - def modules - if(params[:method]) - method(RaModule.to_s) - render :action => 'method' - else - get_container(RaModule.to_s) - render :action => 'container' end end - # display a class - def classes - if(params[:method]) - method(RaClass.to_s) - render :action => 'method' - else - get_container(RaClass.to_s) - render :action => 'container' - end - end - - - # this is a method that causes a container to display without caching + # display a container given a library name, class/file/module name, method name, version def container - # this is needed because after creating a new note we go back to the container - # page and it gets cached. Howerver the page is in "expanded" mode to show the note that you just added - # this means that the section with your note is expanded out - # this page then gets cached and everyone that goes there after that sees your note - # to solve this problem we use this action that doesn't cache the page - # NOTE: let it be known that page caching can cause extreme headaches - get_container(params[:type]) - end - - # display a method - def method(type) - @container_name = @params[:name] - @version = @params[:version] - @ra_container = RaContainer.find_highest_version(@container_name, type, @version) - @method = RaMethod.find(:first, :include => :ra_comment, :conditions => ["ra_container_id = ? AND name = ?", @ra_container.id, @params[:method]]) - @source_code = RaSourceCode.find(@method.ra_source_code_id).source_code - @page_title = RANNOTATE_SITE_NAME + " " + @container_name + "-" + @method.name - @container_url = url_for(:action => @ra_container.class.type_string.pluralize, :name => @container_name, :method => nil) - end + lib_name = params[:lib_name] + container_name = params[:container] + version = params[:version] + method = params[:method] + + # Depending on what parameters we are given we either display + # the method page, the class/module file page, or the library home page + if(method) + method(lib_name, container_name, version, method) + render :action => 'method' + elsif(container_name) + get_container(lib_name, container_name, version) + else + get_library(lib_name, version) + render :action => 'library' + end + end - # display a list of entries + # display a list of classes/files/methods def list - get_list(params[:type], params[:library], params[:version]) - end + get_list(params[:lib_name], params[:type], params[:version]) + @type = params[:type] + + # if there is no library name then this is a list of all the entries in the system + # so we have to show the library name beside each + if(params[:lib_name] == nil) + @show_library = true + end + + # files are listed in a single column, so they have a separate template + if(params[:type] == 'files') + render :action => 'list_files' + end + end # Used by AJAX to display inline notes - def notes + def notes render_notes(params[:container_name], params[:note_group]) end # Used by AJAX to display inline source code def source_code render_source(params[:source_id]) - end + end # search the database for classes, methods, files def search @@ -95,53 +74,97 @@ class DocController < ApplicationController # list all of the libraries in the system def libraries - all_libs = RaLibrary.find(:all, :order => "name ASC, version DESC") - - # collect all of the libraries into a hash by library name, each - # entry in the hash contains a list of all the library versions - @libraries = Hash.new - all_libs.each do |l| - unless @libraries[l.name] then @libraries[l.name] = Array.new end - @libraries[l.name].push(l) - end - end + @libraries = RaLibrary.find(:all, :order => "name ASC", :group => "name") + end # Display the history for a container def history get_container(@params[:type]) end + # show which files contain which parts of a class + def file_contents + name = @params[:container] + type = @params[:type] + + # get the container + @ra_container = RaContainer.find_by_full_name(name) + + # get all of the code objects and methods that have this container as a parent + code_obj = RaCodeObject.find(:all, :conditions => ["ra_container_id = ?", @ra_container.id], :order => "name ASC") + + # Get all the methods in this container + code_obj += RaMethod.find(:all, :conditions => ["ra_container_id = ? AND visibility = ?", @ra_container.id, RaContainer::VIS_PUBLIC], :order => "name ASC") + + # Get the other containers that this container is parent of + code_obj += RaContainer.find(:all, :conditions => ["parent_id = ?", @ra_container.id], :order => "full_name ASC") + + # group everything by file + @file_contents = {} + + for obj in code_obj + unless @file_contents.has_key?(obj.file_id) + @file_contents[obj.file_id] = {:obj => RaFile.find_by_id(obj.file_id)} + end + + unless @file_contents[obj.file_id].has_key?(obj.class) then @file_contents[obj.file_id][obj.class] = [] end + @file_contents[obj.file_id][obj.class].push(obj) + end + + type = @ra_container.class.type_string + @container_url = url_for(:action => type.pluralize, :container => @ra_container.full_name) + end + ########################### ### START protected methods ########################### protected + + # display the home page for a library + def get_library(lib_name, version) + @library = RaLibrary.find_by_name(lib_name) + get_list(lib_name, params[:type], version) + + # if the library has a main_container_id set then use the description from + # that container for the home page, otherwise use one of the shorter descriptions + if(@library.main_container_id) + main = RaContainer.find_by_id(@library.main_container_id) + @description = main.ra_comment.comment + elsif(@library.long_description) + @description = @library.long_description + elsif(@library.short_description) + @description = @library.short_description + end + end + + # display a method + def method(lib_name, container_name, version, method) + @ra_container = RaContainer.find_highest_version(container_name, version) + @method = RaMethod.find(:first, :include => :ra_comment, :conditions => ["ra_container_id = ? AND name = ?", @ra_container.id, method]) + @source_code = RaSourceCode.find(@method.ra_source_code_id).source_code + @page_title = RANNOTATE_SITE_NAME + " " + @ra_container.full_name + "-" + @method.name + @container_url = "" # get_doc_url(lib_name, container_name, version, method) + end - # get a list of entries to display for the left sidevar - def get_list(type = 'classes', library = nil, version = nil) - # Get what should be displayed in the left sidebar + # get a list of entries to display for the list pages + def get_list(library, type = 'classes', version = nil) case type - when 'files' - @list = RaContainer.find_all_highest_version([RaFile.to_s], library, version) + when 'files' + @list = RaContainer.find_all_highest_version([RaFile.to_s], library, version) when 'methods' @list = RaMethod.find_all_highest_version() else @list = RaContainer.find_all_highest_version([RaClass.to_s, RaModule.to_s], library, version) - end - @version = version - @library = library - @type = type - - if(type == 'files') - render :action => 'list_files' - end + end end # Get a container (file,class, module) and everything necessary to display it's documentation - def get_container(cont_type) - @container_name = @params[:name] - @version = @params[:version] # this can be nil if the most recent version is requested + def get_container(lib_name, container_name, version) + @container_name = container_name + @library = lib_name + @version = version # this can be nil if the most recent version is requested @expand = @params[:expand] - @ra_container = RaContainer.find_highest_version(@container_name, cont_type, @version) + @ra_container = RaContainer.find_highest_version(@container_name, lib_name, @version) unless(@ra_container) @error = "Could not find: " + @container_name return @@ -150,10 +173,10 @@ class DocController < ApplicationController @page_title = RANNOTATE_SITE_NAME + " " + @container_name # Get all the methods in this container (and join with their comments) - methods = RaMethod.find(:all, :include => :ra_comment, :conditions => ["ra_container_id = ?", @ra_container.id], :order => "name ASC") + methods = RaMethod.find(:all, :include => [:ra_comment, :file_container], :conditions => ["ra_container_id = ?", @ra_container.id], :order => "ra_methods.name ASC") # Divide up the methods into public/protected and class/instance - @ra_methods = {} + @ra_methods = {} methods.each do |method| # Don't display private methods if(method.visibility.to_i == RaContainer::VIS_PRIVATE) then next end @@ -167,6 +190,7 @@ class DocController < ApplicationController @ra_visibilities = ['Public Class', 'Public Instance', 'Protected Class', 'Protected Instance', 'Private Class', 'Private Instance'] # Get all of the other code objects that this container contains + # join with the file_id so that we can display the files the code objects were defined in results = RaCodeObject.find(:all, :conditions => ["ra_container_id = ?", @ra_container.id], :order => "name ASC") # Divide up the code objects into the various types @@ -191,13 +215,9 @@ class DocController < ApplicationController end @container_type = @ra_container.class.type_string - @container_url = url_for(:action => @ra_container.class.type_string.pluralize, :name => @container_name) + @container_url = "" # get_doc_url(lib_name, container_name, version, method) end - -# def get_special_docs() -# container = RaContainer.find_highest_version("README OR CHANGELOG OR LICENSE") -# end - + # execute a search and return the results # results are put in the @search_results class variable and @result_count contains the total result count # if something goes wrong then the class variable @error contains the error message @@ -220,20 +240,20 @@ class DocController < ApplicationController end temp = RaContainer.find(:all, :limit => 100, - :conditions => ["LOWER(rc.full_name) LIKE ? AND rl.id = rc.ra_library_id AND rl.current = ?", name, true], + :conditions => ["LOWER(rc.full_name) LIKE ? AND rl.id = rc.ra_library_id AND rl.current = ?", name, true], :select => 'rc.*', :joins => "rc, ra_libraries AS rl", - :order => 'rc.full_name ASC' + :order => 'rc.full_name ASC' ) - temp.push(RaMethod.find(:all, :limit => 100, - :conditions => ["LOWER(ram.name) LIKE ? AND ram.ra_container_id = rc.id AND rc.ra_library_id = rl.id AND rl.current = ?", name, true], + temp.push(RaMethod.find(:all, :limit => 100, + :conditions => ["LOWER(ram.name) LIKE ? AND ram.ra_container_id = rc.id AND rc.ra_library_id = rl.id AND rl.current = ?", name, true], :joins => 'ram, ra_containers AS rc, ra_libraries AS rl', :select => 'ram.*, rc.full_name AS container_name, rc.type AS container_type', :order => 'ram.name ASC' ) ) - temp.push(RaCodeObject.find(:all, :limit => 100, + temp.push(RaCodeObject.find(:all, :limit => 100, :conditions => ["LOWER(rco.name) LIKE ? AND rco.type IN('RaConstant', 'RaMethod', 'RaAttribute') AND rco.ra_container_id = rc.id AND rc.ra_library_id = rl.id AND rl.current = ?", name, true], :joins => 'rco, ra_containers AS rc, ra_libraries AS rl', :select => 'rco.*, rc.full_name AS container_name, rc.type AS container_type', app/controllers/doc_controller.rb @@ -40,7 +40,7 @@ class HistoryController < ApplicationController # Get all versions of this container container_versions = RaContainer.find(:all, :include => [:ra_comment, :ra_library], :conditions => ["full_name = ? AND type = ?", @container_name, type], - :order => "version ASC") + :order => "version ASC") unless(container_versions && container_versions.length > 0) @error = "Could not find: " + type + " " + @container_name + " for history" app/controllers/history_controller.rb @@ -1,6 +1,6 @@ class NotesController < ApplicationController - # cache_sweeper :note_sweeper, :only => [:create] + cache_sweeper :note_sweeper, :only => [:preview] caches_page :list_new # Display a list of notes @@ -43,13 +43,13 @@ class NotesController < ApplicationController @note.skip_ban_validation = true @note.valid? - if @params['create'] && @note.errors.empty? + if @params['create'] && @note.errors.empty? create - end + end end # Save the note to the DB - def create + def create note_params = get_note_params(params[:note][:ref_id], params[:note][:ref_type]) @note = Note.new(note_params.merge(params[:note])) @@ -57,11 +57,16 @@ class NotesController < ApplicationController if !@note.save render :action => 'preview' else - NoteSweeper.expire_cache(self, @note) + send_note_edit_email(@note) render :action => 'success' end end + # Send an email + def send_note_edit_email + + end + # Save a vote for a note and then show the success page if it was a success def vote ip = request.remote_ip; @@ -126,7 +131,6 @@ private when RaAlias.to_s then return get_codeobj_params(id, type_string) when "index" then return get_index_params() end - return {} end app/controllers/notes_controller.rb @@ -1,38 +1,15 @@ # Methods added to this helper will be available to all templates in the application. module ApplicationHelper - # limit the length of some text and add .. if it becomes too long - def limit_length(text, max_length) - if(text == nil) - return nil - end - - if(text.length > max_length) - return text[0,max_length] + ".." - end - - return text - end - - - # Display errors in a nicely formatted box - def display_errors_for(object_name, options = {}) - options = options.symbolize_keys - object = instance_variable_get("@#{object_name}") - - unless object.errors.empty? - content_tag("div", - content_tag("p", "There were problems with the following fields:") + - content_tag("ul", object.errors.full_messages.collect { |msg| content_tag("li", msg) }), - "id" => options[:id] || "errorExplanation", "class" => options[:class] || "errorExplanation" - ) - end - end + def link_to_library(lib) + link_params = {:controller => 'doc', :action => 'container', :lib_name => lib.name, :container => nil} + return link_to(lib.name, link_params) + end # Given the name and type of a container (type = class,file, etc..) # link to that type def link_to_container_by_name(type, name) - link_params = {:controller => "doc", :action=> type.pluralize, :name => name} + link_params = {:controller => 'doc', :action=>'container', :container => name} if(@version) link_params[:version] = @version end @@ -50,7 +27,7 @@ module ApplicationHelper def link_to_container(ra_container, max_length = 300) action = ra_container.class.type_string.pluralize - link_params = {:controller => "doc", :action => action, :name => ra_container.full_name} + link_params = {:controller => 'doc', :action => 'container', :lib_name => ra_container.ra_library.name, :container => ra_container.full_name} if(@version) link_params[:version] = @version end @@ -67,16 +44,14 @@ module ApplicationHelper # If this is a child of a container object (method, constant etc.) then link to it's container def link_to_container_child(child) container_name = child.container_name - container_type = child.container_type # If we haven't done a database join to pre-retrieve these values then we get them here # this could involve another DB query if no join with the container table has been done - if(container_name == nil || container_type == nil) + if(container_name == nil) container_type = child.ra_container.class.to_s - container_name = child.ra_container.full_name end - link_params = {:controller => 'doc', :action => RaContainer.type_to_route(container_type), :name => container_name } + link_params = {:controller => 'doc', :lib_name => child.ra_library.name, :container => container_name } if(@version) link_params[:version] = @version end @@ -92,17 +67,58 @@ module ApplicationHelper end - def link_to_method(method_name, container_type) - link_params = {:controller => 'doc', :action => container_type.pluralize, :method => method_name} + def link_to_method(method, container, title = nil) + route = RaContainer.type_to_route(container.class.to_s) + link_params = {:controller => 'doc', :action => 'container', :lib_name => container.ra_library.name, :container => container.full_name, :method => method.name} + other_params = {} + + if(title != nil) + other_params[:title] = title + end + if(@version) link_params[:version] = @version end - link_to(method_name, link_params) + + link_to(method.name, link_params, other_params) end # get the current library version def get_current_version() return RaLibrary.find(:first, :conditions => ["current = ?", true]) end + + def get_all_libs() + RaLibrary.find(:all, :conditions => ["current = ?", true], :order => "name ASC") + end + + # limit the length of some text and add .. if it becomes too long + def limit_length(text, max_length) + if(text == nil) + return nil + end + + if(text.length > max_length) + return text[0,max_length] + ".." + end + + return text + end + + + # Display errors in a nicely formatted box + def display_errors_for(object_name, options = {}) + options = options.symbolize_keys + object = instance_variable_get("@#{object_name}") + + unless object.errors.empty? + content_tag("div", + content_tag("p", "There were problems with the following fields:") + + content_tag("ul", object.errors.full_messages.collect { |msg| content_tag("li", msg) }), + "id" => options[:id] || "errorExplanation", "class" => options[:class] || "errorExplanation" + ) + end + end + end app/helpers/application_helper.rb @@ -3,20 +3,33 @@ require 'rdoc/markup/simple_markup/to_html' module DocHelper - # return the number of notes in a certain category, or 0 if there are none - def get_count(note_count, category) - note_count[category] ? note_count[category] : 0 + # Display the parameters for calling a method + def display_method_parameters(method) + if(method.call_seq != nil && method.call_seq.length > 0) + method.call_seq.split("\n") + return end + + if(method.block_parameters) + end + + return + end + + # return the number of notes in a certain category, or 0 if there are none + def get_count(note_count, category) + note_count[category] ? note_count[category] : 0 + end # markup the source code using the syntax helper - def markup_source_code(code) - begin - syntax = Syntax::Convertors::HTML.for_syntax "ruby" - return syntax.convert(code) - rescue - return code - end - end + def markup_source_code(code) + begin + syntax = Syntax::Convertors::HTML.for_syntax "ruby" + return syntax.convert(code) + rescue + return "<pre>" + code + "</pre>" + end + end # show a link to display the source code for a method def show_source_link(method_id, source_id) @@ -96,26 +109,23 @@ module DocHelper end # Markup the rdoc comments for display - def markup(str, remove_para=false) + def markup_rdoc(str, remove_para=false) return '' unless str -# unless defined? @markup # only define the markup object once + unless defined? @markup # only define the markup object once @markup = SM::SimpleMarkup.new - # TODO: This does not work, previously it depended on us being able to check if something was defined before we would link it - # here though it is too expensive to do that for each entry as it would involve a DB lookup - # instead we should do it at the time we are generating the inserts into the DB and place special - # markers around those things to be hyperlinked - - # class names, variable names, file names, or instance variables - -# @markup.add_special(/( + # class names, variable names, file names, or instance variables + @markup.add_special(/(\#\w+[!?=]? + | \b([A-Z]\w+::\w+) + )/x, :CROSSREF) + +# TODO: Some of these crossreferences are very expensive +# for some of them we need to do searches for each match to see if it exists +# with page links this is not so bad, but with other things it could be epxensive +# at doc generation time we should use a hashtable to speed this up # \b([A-Z]\w*(::\w+)*[.\#]\w+) # A::B.meth -# | \b([A-Z]\w+(::\w+)*) # A::B.. -# \#\w+[!?=]? # #meth_name # | \b\w+([_\/\.]+\w+)+[!?=]? # meth_name -# )/x, -# :CROSSREF) # external hyperlinks # @markup.add_special(/((link\.)\S+\w)/, :HYPERLINK) @@ -123,18 +133,19 @@ module DocHelper # and links of the form <text>[<url>] @markup.add_special(/(((\{.*?\})|\b\S+?)\[\S+?\.\S+?\])/, :TIDYLINK) -# end + end -# unless defined? @html_formatter + unless defined? @html_formatter @html_formatter = Hyperlinker.new(self) -# end + end - # Convert leading comment markers to spaces, but only if all non-blank lines have them - if str =~ /^(?>\s*)[^\#]/ + # Remove leading comment markers if all blank lines have them + if str =~ /^(?>\s*)[^\#]/ content = str - else - content = str.gsub(/^\s*(#+)/) { $1.tr('#',' ') } - end + else + content = str.gsub(/^\s*#+/, '') + content.gsub!(/^ /, '') + end res = @markup.convert(content, @html_formatter) if remove_para @@ -155,17 +166,17 @@ module DocHelper # We're invoked when any text matches the CROSSREF pattern # (defined in MarkUp). If we fine the corresponding reference, - # generate a hyperlink. - def handle_special_CROSSREF(special) - name = special.text - if name[0,1] == '#' - name = name[1..-1] - end + # generate a hyperlink. + def handle_special_CROSSREF(special) + name = special.text + if name[0,1] == '#' + name = name[1..-1] + end - if /([A-Z].*)[.\#](.*)/ =~ name - ref = @dochelper.link_to(name, {:controller => 'doc', :action => 'search', :name => $1}) + if /([A-Z].*)[.\#](.*)/ =~ name + ref = @dochelper.link_to(name, {:controller => 'doc', :action => 'search', :name => $1, :exact => 1}) else - ref = @dochelper.link_to(name, {:controller => 'doc', :action => 'search', :name => name}) + ref = @dochelper.link_to(name, {:controller => 'doc', :action => 'search', :name => name, :exact => 1}) end ref end app/helpers/doc_helper.rb @@ -23,8 +23,8 @@ module NotesHelper def get_return_url(note) container_type = note.get_container().class.to_s container = RaContainer.type_to_route(container_type) - container_params = {:controller => 'doc', :action => container, :name => note.container_name, :anchor => 'note_' + note.id.to_s} - code_obj_params = {:controller => 'doc', :action => 'container', :type => container_type, :name => note.container_name} + container_params = {:controller => 'doc', :action => container, :container => note.container_name, :anchor => 'note_' + note.id.to_s} + code_obj_params = {:controller => 'doc', :action => 'container', :type => container_type, :container => note.container_name} case note.note_type when RaModule.to_s then return url_for(container_params) @@ -58,18 +58,15 @@ module NotesHelper text += " ... " end end - - # Extract anything between <ruby></ruby> tags and syntax highlight it - syntax = Syntax::Convertors::HTML.for_syntax "ruby" - - # To prevent the ruby code from being mangled by the rest of the text substitutions - # we save it in an instance variable and then re-add it later - @rubycode = [] - text.gsub!(/<ruby>(.*?)<\/ruby>/m ) { @rubycode.push($1); "!CODE_EXTRACT!" } - + # Kill all HTML elements text.gsub!(/</,"&lt;") text.gsub!(/>/,"&gt;") + + # To prevent the ruby code from being mangled by the rest of the text substitutions + # we save it in an instance variable and then re-add it later + @rubycode = [] + text.gsub!(/<ruby>(.*?)<\/ruby>/m ) { @rubycode.push($1); "!CODE_EXTRACT!" } # Take care of newlines text.gsub!(/(\r\n|\n|\r)/, "\n") # lets make them newlines crossplatform @@ -77,10 +74,14 @@ module NotesHelper text.gsub!(/([^\n])(\n)([^\n])/, '\1\2<br/>\3') # turn single newline into <br /> text.gsub!(/\n\n/, "<br/><br/>\n") # turn two newlines into paragraph + # Extract anything between <ruby></ruby> tags and syntax highlight it + syntax = Syntax::Convertors::HTML.for_syntax "ruby" + # Now place back in the ruby code that we extracted + @rubycode.reverse!() text.gsub!(/!CODE_EXTRACT!/) { syntax.convert(@rubycode.pop()) } - # auto link any links + # auto link any links text = auto_link(text, :all, :rel => "nofollow", :target=> "_blank") return text end app/helpers/notes_helper.rb @@ -1,7 +1,5 @@ -# TODO: this sweeper is not working.. url_for is not working inside the expire_page method -# TODO: so I added the expire code directly inside the notes controller class NoteSweeper < ActionController::Caching::Sweeper -# observe Note + observe Note def after_save(note) expire_cache(note) @@ -11,55 +9,17 @@ class NoteSweeper < ActionController::Caching::Sweeper expire_cache(note) end - # TODO: This should really be a sweeper, but it is not working inside my sweeper - def self.expire_cache(controller, note) - container = RaContainer.type_to_route(note.ra_container.class.to_s) - - if(note.note_type == "index") - page_params = {:controller => 'doc', :action => "index"} - controller.expire_page(page_params) - elsif(note.note_type == "RaMethod") - page_params = {:controller => 'doc', :action => container, :name => note.container_name } - - # Expire the container page - controller.expire_page(page_params) - - # expire the container with version page - versioned = page_params.merge({:version => note.version}) - controller.expire_page(versioned) - - # Expire the method page - method = page_params.merge({:method => note.note_group}) - controller.expire_page(method) - - # Expire the method with version page - method_versioned = method.merge({:version => note.note_group}) - controller.expire_page(method_versioned) - else - page_params = {:controller => 'doc', :action => container, :name => note.container_name } - # expire the container page - controller.expire_page(page_params) - - # expire the container with version page - versioned = page_params.merge({:version => note.version}) - controller.expire_page(versioned) - end - - # expire the RSS page - controller.expire_page(:controller => 'notes', :action => 'rss') - - # expire the newest notes page - controller.expire_page(:controller => 'notes', :action => 'list_new') - end - private + # TODO: Expire the following + # :index, :container, :library, :list, :libraries + def expire_cache(note) - container = RaContainer.type_to_route(note.ra_container.class.to_s) + container = RaContainer.type_to_route(note.ra_container.class.to_s) if(note.note_type == "index") page_params = {:controller => 'doc', :action => "index"} - expire_page(page_params) + expire_page(page_params) elsif(note.note_type == "RaMethod") page_params = {:controller => 'doc', :action => container, :name => note.container_name } @@ -85,7 +45,13 @@ private # expire the container with version page versioned = page_params.merge({:version => note.version}) expire_page(versioned) - end + end + + # expire the RSS page + expire_page(:controller => 'notes', :action => 'rss') + + # expire the newest notes page + expire_page(:controller => 'notes', :action => 'list_new') end app/models/note_sweeper.rb @@ -30,14 +30,13 @@ class RaContainer < ActiveRecord::Base end end - def RaContainer.find_highest_version(full_name, type, library = nil) - if(library == nil) + def RaContainer.find_highest_version(full_name, library_name = nil, version = nil) + if(library_name == nil) result = RaContainer.find_by_sql(["SELECT rc.* FROM ra_containers AS rc, ra_libraries AS rl WHERE " + - "full_name = ? AND type = ? AND ra_library_id = rl.id AND rl.current = ? ORDER BY full_name ASC", full_name, type, true]) + "full_name = ? AND ra_library_id = rl.id AND rl.current = ? ORDER BY full_name ASC", full_name, true]) else - version = RaLibrary.ver_string_to_int(library) result = RaContainer.find_by_sql(["SELECT rc.* FROM ra_containers AS rc, ra_libraries AS rl WHERE " + - "full_name = ? AND type = ? AND ra_library_id = rl.id AND rl.version = ? ORDER BY full_name ASC", full_name, type, version]) + "full_name = ? AND ra_library_id = rl.id AND rl.name = ? ORDER BY full_name ASC", full_name, library_name]) end if(result) app/models/ra_container.rb @@ -33,7 +33,7 @@ class RaLibrary < ActiveRecord::Base # A helper method to find the a library when you have the name and release information def find_lib - return RaLibrary.find(:first, :conditions => ["name = ? AND major = ? AND minor = ? AND `release` = ?", name, major, minor, release]) + return RaLibrary.find(:first, :conditions => ["name = ? AND major = ? AND minor = ? AND `release` = ?", name, major, minor, release]) end # on create checks to see if a library with this version and name exists already app/models/ra_library.rb @@ -1,6 +1,7 @@ class RaMethod < ActiveRecord::Base belongs_to :ra_container belongs_to :ra_comment + belongs_to :file_container, :foreign_key => 'file_id', :class_name => 'RaFile' def RaMethod.type_string 'method' @@ -12,17 +13,29 @@ class RaMethod < ActiveRecord::Base def container_type @attributes['container_type'] - end + end + + # this is a helper method for getting the library that a method is in + # uses the piggybacked variable if available + def ra_library + if(ra_library_name != nil) + # when listing methods this helper checks to see if we already have the name of the library + return RaLibrary.new({:name => ra_library_name}) + else + return ra_container.ra_library + end + end def container? return false end def RaMethod.find_all_highest_version() - RaMethod.find_by_sql("SELECT rm.*, rc.full_name AS container_name, rc.type AS container_type FROM ra_methods AS rm, ra_containers AS rc, ra_libraries AS rl " + - "WHERE rm.ra_container_id = rc.id AND rc.ra_library_id = rl.id AND rl.current = 1 " + - "ORDER BY rm.name ASC" - ) + # TODO: Another find_by_sql that needs to be Active Recordized + RaMethod.find_by_sql("SELECT rm.*, rc.full_name AS container_name, rc.type AS container_type, rl.name AS ra_library_name FROM ra_methods AS rm, ra_containers AS rc, ra_libraries AS rl " + + "WHERE rm.ra_container_id = rc.id AND rc.ra_library_id = rl.id AND rl.current = 1 " + + "ORDER BY rm.name ASC" + ) end # Get a string with the visibility of this method Public Instance / Private Instance etc. app/models/ra_method.rb @@ -1,30 +1,40 @@ -<% if @error %> -Error: <%= @error %><p> -<% end %> +<% if(@success) %> -<% if @library %> -<% display_errors_for 'library' %> -<% end %> + <% if @total_count %> + <br/>Successfully uploaded <%= @total_count %> records + <p> + <% end %> +<% for value in @success %> +<%= value %><br/> +<% end + end %> +<p> <b>Import documentation</b> <p> <%= form_tag({:action=>'import'}, :multipart => true)%> - Select file: <input type="file" name="doc_file" /><br/> - <input type="submit" value="Upload" /> - - <% if @total_time %> - <p>Successfully uploaded <%= @total_count %> records in <%= @total_time %> seconds - <% end %> + Select file: <input type="file" name="doc_file" /> <input type="submit" value="Upload" /> </form> <p> +or +<br/> +<%= form_tag({:action=>'mass_import'}, :multipart => true)%> + Enter directory: <input type="text" name="directory" /> <input type="submit" value="Upload" /> + <input type="hidden" name="ignore" value="true" /> +</form> +<p> +Note if you enter a directory then Rannotate will attempt to import *.out from that directory. The +directory also has to be a directory on the server where Rannotate is running (not your computer.) +<p> <b>Generating Documentation</b><br/> Documentation is generated for Rannotate by the custom rannotate rdoc generator. <br/><br/> -1. Copy all files and directories from the <i>rdoc_extension</i> directory into your +1. Copy the <i>yaml_generator.rb</i> from the <i>rdoc_extension</i> directory into your <i>[ruby]/lib/ruby/1.8/rdoc/generators</i> directory. <br/><br/> 2. Command line to generate documentation:<br/> <i>rdoc --fmt=yaml --opname=activerecord-1.1.13 directory</i><br/><br/> The last parameter is the name of the directory to process<br/> fmt = Which RDoc generator to use<br/> -opname = What is the name of the output file (the output file will be put in doc/[name].out) \ No newline at end of file +opname = What is the name of the output file (the output file will be put in doc/[name].out) +<br/><br/> \ No newline at end of file app/views/admin/upload/create.rhtml @@ -1,11 +1,18 @@ <%= form_tag :action => 'delete' %> +<b>Libraries:</b><p> +<table> <% @libraries.each do |name,ver_array| %> -Library - <%= name.capitalize %><br/> +<tr><td> +<%= name.capitalize %> [edit] +</td> +<td> <% ver_array.each do |ver| %> <%= check_box :id, ver.id %> <%= ver.current ? "* " : "" %>ver <%= ver.ver_string %><br/> <% end %> -<br/> +</td> +</tr> <% end %> +</table> <%= submit_tag "Delete selected libraries" %> <%= end_form_tag %> * - This is the default library and version that is displayed when you are browsing the site. \ No newline at end of file app/views/admin/upload/list.rhtml @@ -11,12 +11,12 @@ <br/> [ <a href="#notessec"><%= pluralize(get_count(@note_count, @ra_container.class.to_s), "Note") %></a> ] [ <%= link_to 'History', {:action => 'history', :name => @container_name, :type => @ra_container.class.to_s } %> ] +[ <%= link_to 'Show Files', {:action => 'file_contents', :container => @container_name, :type => @ra_container.class.to_s } %> ] <% if(@ra_container.ra_comment.comment.length > 0) %> -<div class="section_title" onClick="<%= show_or_hide("comment") %>">Comments</div> -<div class="comment" id="comment"><%= markup(@ra_container.ra_comment.comment) %></div> +<div class="section_title" onClick="<%= show_or_hide("comment") %>"><%= @ra_container.class.type_string.capitalize %> Description</div> +<div class="comment" id="comment"><%= markup_rdoc(@ra_container.ra_comment.comment) %></div> <% end %> -<% if(@ra_in_files.length > 0) %><%= render :partial => 'doc/partials/in_file' %><% end %> <% if(@ra_code_objects[RaRequire]) %><%= render :partial => 'doc/partials/require' %><% end %> <% if(@ra_code_objects[RaInclude]) %><%= render :partial => 'doc/partials/include' %><% end %> <% if(@ra_code_objects[RaConstant]) %><%= render :partial => 'doc/partials/constant' %><% end %> app/views/doc/container.rhtml @@ -3,19 +3,16 @@ </div> <div id="body_content_wide" style="padding-left: 10px;"> -<div style="font-size: 110%"> -<% @libraries.each do |name,ver_array| %> -<h2>Library - <%= name.capitalize %> -<span style="font-size: 80%">[<%= link_to 'history', {:controller => 'history', :action => :library, :name => name} %>]</span> -</h2> -<% ver_array.each do |ver| %> -ver <%= ver.ver_string %> - [<%= link_to 'files', {:action => 'list', :type => 'files', :library => name, :version => ver.ver_string} %>] -[<%= link_to 'classes', {:action => 'list', :type => 'classes', :library => name, :version => ver.ver_string} %>] -[<%= link_to 'methods', {:action => 'list', :type => 'methods', :library => name, :version => ver.ver_string} %>] -<%= ver.current ? "* " : "" %><br/> +<h2>Libraries</h2> +<table> +<tr style="font-size: 70%"> +<td><b>Name</b></td> +<td><b>Description<b></td> +</tr> +<% @libraries.each do |library| %> +<tr style="font-size: 70%"> +<td><%= link_to_library(library) %></a> </td> +<td><%= library.short_description %></td> +</tr> <% end %> -<br/> -<% end %> -* - Default library and version that is displayed when you are browsing the site. -</div> -</div> +</div> \ No newline at end of file app/views/doc/libraries.rhtml @@ -38,7 +38,7 @@ <td align="left"> <% end end %> -<%= link_to_doc(entry) %><br/> +<%= link_to_doc(entry) %> <% if(@show_library) %>(<%= entry.ra_library.name %>) <% end %><br/> <% count = count + 1 # if we crossed a column boundary then output a new column if(count != @list.length && count % rows_per_col == 0) %> app/views/doc/list.rhtml @@ -7,11 +7,11 @@ <span class="container_header"><%= @method.name %><%= @method.parameters %></span> <% if(@version) then %>Ver: <%= @version %><% end %> <br/>From: <a href="<%= @container_url %>"><%= @container_name %></a> <% if(@version) then %>Version <%= @version %><% end %> +Defined in: <%= link_to_container @method.file_container %> - -<div class="section_title" onClick="<%= show_or_hide("commentssec") %>">Comments</div> +<div class="section_title" onClick="<%= show_or_hide("commentssec") %>">Method Description</div> <div id="commentssec" class="description"> -<p><%= markup(@method.ra_comment.comment) %></p> +<p><%= markup_rdoc(@method.ra_comment.comment) %></p> </div> <div class="section_title" onClick="<%= show_or_hide("sourcesec") %>">Sourcecode</div> @@ -21,10 +21,11 @@ <a name="notessec"></a> <div class="section_title" onClick="<%= show_or_hide("usercommentsec") %>"> -<span class="note_link"> <%= link_to('Add New Note', {:controller => 'notes', :action => 'new', :id => @method.id, :type => 'RaMethod'}) %></span> +<span class="note_link"> <%= link_to('Add New Note', {:controller => 'notes', :action => 'new', :id => @method.id, :type => 'RaMethod'}) %></span> User Added Notes - </div> - <div id="usercommentsec"> +</div> + +<div id="usercommentsec"> <%= render_notes(@container_name, @method.name) %> </div> app/views/doc/method.rhtml @@ -15,7 +15,7 @@ <tr valign='top'> <td class='attr-rw'>[<%= attribute.read_write %>]</td> <td class='attr-name'><a name="attr_<%= attribute.name %>"></a><%= attribute.name %></td> - <td class='attr-desc'><%= markup(attribute.comment) %></td> + <td class='attr-desc'><%= markup_rdoc(attribute.comment) %></td> </tr> <% end %> </table> app/views/doc/partials/_attribute.rhtml @@ -20,7 +20,7 @@ <% if constant.comment && constant.comment.length > 0 %> <tr valign='top'> <td>&nbsp;</td> - <td colspan="2" class="attr-desc"><%= markup(constant.comment) %></td> + <td colspan="2" class="attr-desc"><%= markup_rdoc(constant.comment) %></td> </tr> <% end %> <% end %> app/views/doc/partials/_constant.rhtml @@ -1,3 +1,6 @@ +<h2>Library</h2> +Defined in library <%= link_to_library(@ra_container.ra_library) %> +<br/><br/> <% if @ra_children.length > 0 %> <h2>Child Classes and Modules</h2> <% for child in @ra_children %> app/views/doc/partials/_container_sidebar.rhtml @@ -8,10 +8,10 @@ <div class="method"> <h2> <a name="<%= method.name %>"></a> - <b><%= link_to_method(method.name, @container_type) %></b> <%= method.parameters %> + <b><%= link_to_method(method, @ra_container, 'Defined In File: ' + method.file_container.full_name) %></b> <%= method.parameters %> </h2> <div class="description"> - <%= markup(method.ra_comment.comment) %> + <%= markup_rdoc(method.ra_comment.comment) %> </div> [ <%= show_source_link(method.id, method.ra_source_code_id) %> ] [ <%= show_notes_link(@ra_container.full_name, method.name, method.id, "RaMethod") %> ] app/views/doc/partials/_method.rhtml @@ -6,9 +6,9 @@ <p> <h2>Browse Docs</h2> -[<%= link_to "Classes/Modules", :controller => 'doc', :action => "list", :type => "classes" %>]<br/> -[<%= link_to "Methods", :controller => 'doc', :action => "list", :type => "methods" %>]<br/> -[<%= link_to "Files", :controller => 'doc', :action => "list", :type => "files" %>]<br/> +[<%= link_to "All Classes/Modules", :controller => 'doc', :action => "list", :type => "classes" %>]<br/> +[<%= link_to "All Methods", :controller => 'doc', :action => "list", :type => "methods" %>]<br/> +[<%= link_to "All Files", :controller => 'doc', :action => "list", :type => "files" %>]<br/> [<%= link_to "Libraries", :controller => 'doc', :action => "libraries" %>]<br/> <p> <h2>Site Links</h2> @@ -24,6 +24,12 @@ <a href="http://rails.outertrack.com">Rannotated Rails Docs</a><br/> <a href="http://www.conorhunt.com/techblog/">Rannotate Blog</a></br/> <p> +<h2>Libraries</h2> +<% libs = get_all_libs() %> +<% for lib in libs %> +<%= link_to_library(lib) %> [<%= lib.ver_string %>]<br/> +<% end%> +<p> <span style="font-size: 80%;"> This site powered by <a href="http://rannotate.rubyforge.org">Rannotate</a><br/> </p> \ No newline at end of file app/views/doc/partials/_nav_sidebar.rhtml @@ -1,5 +1,5 @@ <div class="sourcecode"> <div class="ruby"> -<pre><%= markup_source_code(@source_code) %></pre> +<%= markup_source_code(@source_code) %> </div> </div> app/views/doc/partials/_source_code.rhtml @@ -11,9 +11,9 @@ <div id="header"> <span class="header_search_links"> <%= form_tag :controller => 'doc', :action => 'search', :name => nil %> - [<%= link_to "Files", :controller => 'doc', :action => "list", :type => "files" %>] - [<%= link_to "Classes", :controller => 'doc', :action => "list", :type => "classes" %>] - [<%= link_to "Methods", :controller => 'doc', :action => "list", :type => "methods" %>] + [<%= link_to "All Files", :controller => 'doc', :action => "list", :type => "files" %>] + [<%= link_to "All Classes", :controller => 'doc', :action => "list", :type => "classes" %>] + [<%= link_to "All Methods", :controller => 'doc', :action => "list", :type => "methods" %>] [<%= link_to "Libraries", :controller => 'doc', :action => "libraries" %>] <input type="text" name="name" size="20"/>&nbsp;<%= submit_tag "search" %> <%= end_form_tag %> app/views/layouts/doc.rhtml @@ -10,9 +10,9 @@ <div id="header"> <span class="header_search_links"> <%= form_tag :controller => 'doc', :action => 'search', :name => nil %> - [<%= link_to "Files", :controller => 'doc', :action => 'list', :type => 'files' %>] - [<%= link_to "Classes", :controller => 'doc', :action => 'list', :type => 'classes' %>] - [<%= link_to "Methods", :controller => 'doc', :action => 'list', :type => 'methods' %>] + [<%= link_to "All Files", :controller => 'doc', :action => 'list', :type => 'files' %>] + [<%= link_to "All Classes", :controller => 'doc', :action => 'list', :type => 'classes' %>] + [<%= link_to "All Methods", :controller => 'doc', :action => 'list', :type => 'methods' %>] [<%= link_to "Libraries", :controller => 'doc', :action => 'libraries' %>] <input type="text" name="name" size="20"/>&nbsp;<%= submit_tag 'search' %> <%= end_form_tag %> app/views/layouts/notes.rhtml @@ -1,21 +1,23 @@ <a name="note_<%= @note.id %>"></a> <div class="note"> - <div class="note_header"> +<div class="note_header"> <strong><%= mangle_email_for_display(@note.email) %></strong><br /> + <% if(@hide_vote == nil) %> - <span style="float: right; font-size: 80%;"> -<%= if @note.total_votes >= 0 then '+' else '' end %><%= @note.total_votes %> vote [<%= link_to('up', :controller => 'notes', :action => 'vote', :value => NoteVote::USEFUL, :id => @note.id) %>] - [<%= link_to('down', :controller => 'notes', :action => 'vote', :type => NoteVote::NOT_USEFUL, :id => @note.id) %>] - [<%= link_to('spam', :controller => 'notes', :action => 'vote', :type => NoteVote::SPAM, :id => @note.id) %>] - </span> +<span style="float: right; font-size: 80%;"> +<%= if @note.total_votes >= 0 then '+' else '' end %> +<%= @note.total_votes %> vote [<%= link_to('up', :controller => 'notes', :action => 'vote', :value => NoteVote::USEFUL, :id => @note.id) %>] +[<%= link_to('down', :controller => 'notes', :action => 'vote', :type => NoteVote::NOT_USEFUL, :id => @note.id) %>] +[<%= link_to('spam', :controller => 'notes', :action => 'vote', :type => NoteVote::SPAM, :id => @note.id) %>] +</span> <% end %> Added To Version <%= @note.version %> on <a href="#"><%= @note.created_at.strftime("%d-%b-%Y %H:%M") %></a> </strong> - </div> - <div class="note_text"> - <div class="ruby"> - <%= fix_note_for_display(@note.text) %> - </div><!-- ruby --> - </div><!-- text --> +</div> +<div class="note_text"> +<div class="ruby"> +<%= fix_note_for_display(@note.text) %> +</div><!-- ruby --> +</div><!-- text --> </div><!-- note --> app/views/notes/_note.rhtml @@ -1,36 +1,18 @@ development: adapter: mysql database: rannotate - host: + host: localhost username: root - password: - port: - sslcert: - sslcapath: - sslcipher: - socket: localhost - sslkey: - schema_order: - dbfile: - + test: adapter: mysql database: rannotate_test - host: - username: rails - password: rails - port: - sslcert: - sslcapath: - sslcipher: - socket: localhost - sslkey: - schema_order: - dbfile: + host: localhost + username: root production: adapter: mysql database: rannotate_prod username: rails password: rails - socket: /var/lib/mysql/mysql.sock + socket: /var/lib/mysql/mysql.sock \ No newline at end of file config/database.yml @@ -36,6 +36,11 @@ Rails::Initializer.run do |config| # (enables use of different database adapters for development and test environments) # config.active_record.schema_format = :ruby + # RANNOTATE addition + # For Rannotate we use page caching extensively. In order to make things simpler for + # expiration we want all of the cached pages to be in a separate folder + config.action_controller.page_cache_directory = RAILS_ROOT+"/public/cache/" + # See Rails::Configuration for more options end @@ -52,6 +57,9 @@ end # Rannotate Configuration Options # ******************************* +# Specify the default library to display on the site +RANNOTATE_DEFAULT_LIB = '' + # Specify the name of the container to use as a home page # REQUIRED: but can be nil for the default index RANNOTATE_HOME_PAGE = 'vendor/rails/railties/README' config/environment.rb @@ -2,37 +2,32 @@ ActionController::Routing::Routes.draw do |map| # Add your own custom routes here. # The priority is based upon order of creation: first created -> highest priority. - # Here's a sample route: - # map.connect 'products/:id', :controller => 'catalog', :action => 'view' - # Keep in mind you can assign values other than :controller and :action - - # You can have the root of your site routed by hooking up '' - map.connect '', :controller => "doc" - map.connect 'admin/', :controller => "admin/upload" + # Route / to /doc/index + map.connect '', :controller => "doc" + + # routing urls for container/library browsing + map.connect 'lib/:lib_name/:container/:method', :controller => 'doc', :action => 'container', + :container => nil, :method => nil + + # routing urls for container/library browsing + map.connect 'lib/:lib_name/:version/:container/:method', :controller => 'doc', :action => 'container', + :name => nil, :method => nil, :requirements => {:version => /\d\.\d\.\d/} - # routing rules to give nice URLs to class and modules with version numbers - map.connect 'class/:name/:version', :controller => 'doc', :action => 'classes', :requirements => {:version => /\d\.\d\.\d/} - map.connect 'file/:name/:version', :controller => 'doc', :action => 'files', :requirements => {:version => /\d\.\d\.\d/} - map.connect 'module/:name/:version', :controller => 'doc', :action => 'modules', :requirements => {:version => /\d\.\d\.\d/} + # route to list all classes/files/methods for a library + map.connect 'lib/:lib_name/list/:type', :controller => 'doc', :action => 'list' - # routing ruls to give nice ULRs to class and modules with methods and version numbers - map.connect 'class/:name/:method/:version', :controller => 'doc', :action => 'classes', :method => nil, :version => nil - map.connect 'file/:name/:method/:version', :controller => 'doc', :action => 'files', :method => nil, :version => nil - map.connect 'module/:name/:method/:version', :controller => 'doc', :action => 'modules', :method => nil, :version => nil + # routing rule to give nice url to history links for both libraries and for classes/modules in that library + map.connect 'lib/:lib_name/:name/history', :controller => 'doc', :action=> 'history', :name => nil - # routing rule to match the list types with possible version numbers - map.connect 'list/:type/:library/:version', :controller => 'doc', :action => 'list', :library => nil, :version => nil + # route to list all classes/files/methods in the system + map.connect 'list/:type/:version', :controller => 'doc', :action => 'list' - # routing rule to give nice url to history of library links - map.connect 'history/library/:name', :controller => 'history', :action=> 'library' + # Route to the admin portion of the site + map.connect 'admin/', :controller => 'admin/upload' - # routing rule to give nice URL to history links - map.connect 'history/:type/:name', :controller => 'doc', :action => 'history' + # default route (id must be a number) + map.connect ':controller/:action/:id' # routing rule to search for anything that doesn't match the above map.connect '/:name', :controller => 'doc', :action => 'search' - - # default route (id must be a number) - map.connect ':controller/:action/:id' - -end +end \ No newline at end of file config/routes.rb @@ -1,5 +1,5 @@ class InitialSchema < ActiveRecord::Migration - def self.up + def self.up create_table "bans", :force => true do |t| t.column "ip_filter", :string, :limit => 16 end db/migrate/001_initial_schema.rb @@ -2,11 +2,12 @@ class NoteContainer < ActiveRecord::Migration def self.up # Removing the container_id from the note - #remove_column :notes, :ra_container_id + + # remove_column :notes, :ra_container_id end def self.down # Removing the container_id from the note - #add_column :notes, :ra_container_id + # add_column :notes, :ra_container_id end end db/migrate/003_note_container.rb @@ -1,45 +1,25 @@ -HTML { - PADDING: 0px; MARGIN: 0px; -} -BODY { - PADDING: 0px; MARGIN: 0px; FONT: 1em "Lucida Grande", Helvetica, sans-serif; -} -A { - COLOR: #213449 -} -TABLE { - PADDING: 0px; MARGIN: 0px; BORDER: 0px; BORDER-COLLAPSE: collapse; -} -TD, TR { - PADDING: 0px; MARGIN: 0px; -} -FORM { - DISPLAY: inline; -} -FORM INPUT { - FONT-SIZE: 80%; -} -H1,H2,H3,H4,H5,H6 { - MARGIN: 0 0 0 0px; - } - IMG { - BORDER: 0px; -} - - #wrap { +HTML { PADDING: 0px; MARGIN: 0px; } +BODY { PADDING: 0px; MARGIN: 0px; FONT: 1em "Lucida Grande", Helvetica, sans-serif; } +A { COLOR: #213449 } +TABLE { PADDING: 0px; MARGIN: 0px; BORDER: 0px; BORDER-COLLAPSE: collapse; } +TD, TR { PADDING: 0px; MARGIN: 0px; } +FORM { DISPLAY: inline; } +FORM INPUT { FONT-SIZE: 80%; } +H1,H2,H3,H4,H5,H6 { MARGIN: 0 0 0 0px; } +IMG { BORDER: 0px; } + +#wrap { margin:0 0 0 0; background: #fafaea; - } - - #header { +} +#header { width: 100%; - font-size: 80%; + font-size: 80%; background-color: #213449; padding: 5px; color: #ffff66; - vertical-align:middle; - } - + vertical-align:middle; +} .header_link { font-size: 140%; color: #ffff66; @@ -100,14 +80,15 @@ H1,H2,H3,H4,H5,H6 { } .section_title { - margin: 10 0 10 0px; font-size: 120%; font-weight: bold; color: #ffff66; + margin: 10 0 10 0px; font-size: 120%; font-weight: bold; color: #ffff66; padding: 0.3em; background: #213449; + cursor: pointer; } - .comment H1, H2 { - margin: 0px 0px 5px; font-size: 120%; color: #555; border-bottom: #ccc 1px dotted; - } +.comment H1, H2 { + margin: 0px 0px 5px; font-size: 120%; color: #555; border-bottom: #ccc 1px dotted; +} .comment PRE { padding: 0.5em; border: 1px dotted black; @@ -168,6 +149,7 @@ H1,H2,H3,H4,H5,H6 { } .sourcecode { + font-size: 110%; padding: 0.5em; border: 1px dotted black; background: #fafaea; public/stylesheets/docs.css @@ -41,14 +41,14 @@ module Generators # sequences used to generate unique ids for inserts @seq = 1 - + # An output filename must be specified on the commandline @output_file = @options.op_name - if @output_file == nil || !(@output_file =~ /[a-zA-Z]+-[0-9]+\.[0-9]+\.[0-9]+/) + if @output_file == nil || !(@output_file =~ /[a-zA-Z0-9]+-[0-9]+\.[0-9]+\.[0-9]+/) puts "Error:" puts "You must specify an output filename on the command line." puts "and it must have the format: name-[major]-[minor]-[release" - puts "(matching the regex: [a-zA-Z]+-[0-9]+\.[0-9]+\.[0-9]+)" + puts "(matching the regex: [a-zA-Z0-9]+-[0-9]+\.[0-9]+\.[0-9]+)" puts "Ex: rdoc --fmt=yaml --opname=rannotate-1.2.1" exit end @@ -74,24 +74,24 @@ module Generators def process_file(file) putc('.') id = create_file(file) - + # Process all of the objects that this file contains - file.method_list.each { |child| process_method(child, file, id) } - file.aliases.each { |child| process_alias(child, file, id) } - file.constants.each { |child| process_constant(child, file, id) } - file.requires.each { |child| process_require(child, file, id) } - file.includes.each { |child| process_include(child, file, id) } - file.attributes.each { |child| process_attribute(child, file, id) } + file.method_list.each { |child| process_method(child, file, id, id) } + file.aliases.each { |child| process_alias(child, file, id, id) } + file.constants.each { |child| process_constant(child, file, id, id) } + file.requires.each { |child| process_require(child, file, id, id) } + file.includes.each { |child| process_include(child, file, id, id) } + file.attributes.each { |child| process_attribute(child, file, id, id) } # Recursively process contained subclasses and modules - file.each_classmodule do |child| - process_class_or_module(child, file, id) + file.each_classmodule do |child| + process_class_or_module(child, file, id, id) end end # Process classes and modiles - def process_class_or_module(obj, parent, parent_id) + def process_class_or_module(obj, parent, parent_id, file_id) # One important note about the code_objects.rb structure. A class or module # definition can be spread a cross many files in Ruby so code_objects.rb handles # this by keeping only *one* reference to each class or module that has a definition @@ -100,25 +100,28 @@ module Generators # twice. So we need to keep track of what classes/modules we have # already seen and make sure we don't create two INSERT statements for the same # object. - if(!@already_processed.has_key?(obj.full_name)) then - id = create_class_or_module(obj, parent_id) - @already_processed[obj.full_name] = id - - # Process all of the objects that this class or module contains - obj.method_list.each { |child| process_method(child, obj, id) } - obj.aliases.each { |child| process_alias(child, obj, id) } - obj.constants.each { |child| process_constant(child, obj, id) } - obj.requires.each { |child| process_require(child, obj, id) } - obj.includes.each { |child| process_include(child, obj, id) } - obj.attributes.each { |child| process_attribute(child, obj, id) } - obj.in_files.each { |child| process_in_file(child, obj, id) } + if(@already_processed.has_key?(obj.full_name)) + id = @already_processed[obj.full_name] + else + id = create_class_or_module(obj, parent_id, file_id) + @already_processed[obj.full_name] = id end - id = @already_processed[obj.full_name] + # Process all of the objects that this class or module contains + obj.method_list.each { |child| process_method(child, obj, id, file_id) } + obj.aliases.each { |child| process_alias(child, obj, id, file_id) } + obj.constants.each { |child| process_constant(child, obj, id, file_id) } + obj.requires.each { |child| process_require(child, obj, id, file_id) } + obj.includes.each { |child| process_include(child, obj, id, file_id) } + obj.attributes.each { |child| process_attribute(child, obj, id, file_id) } + obj.in_files.each { |child| process_in_file(child, obj, id) } + # Recursively process contained subclasses and modules - obj.each_classmodule do |child| - process_class_or_module(child, obj, id) + obj.each_classmodule do |child| + process_class_or_module(child, obj, id, file_id) end + + # @ loop would happen when we process a class that contains itself as a class or module end def output_yaml(c) @@ -134,9 +137,9 @@ module Generators end def create_file(obj) - comment_id = create_comment(obj) + comment_id = create_comment(obj) - id = get_next_id(:files) + id = get_next_id(:files) c = RaFile.new({ 'name' => obj.file_relative_name, 'type' => 'RaFile', @@ -151,7 +154,7 @@ module Generators return id end - def create_class_or_module(obj, parent_id) + def create_class_or_module(obj, parent_id, file_id) comment_id = create_comment(obj) if(obj.is_module?) @@ -169,6 +172,7 @@ module Generators 'id' => id, 'ra_comment_id' => comment_id, 'ra_library_id' => 0, + 'file_id' => file_id, 'full_name' => obj.full_name, 'parent_id' => parent_id, 'superclass' => obj.superclass @@ -178,7 +182,7 @@ module Generators return id end - def process_method(obj, parent, parent_id) + def process_method(obj, parent, parent_id, file_id) comment_id = create_comment(obj) source_id = get_next_id(:source) @@ -192,7 +196,9 @@ module Generators 'visibility' => VISIBILITY[obj.visibility], 'name' => obj.name, 'ra_container_id' => parent_id, + 'file_id' => file_id, 'parameters' => obj.params, + 'call_seq' => obj.call_seq, 'singleton' => bool_to_int(obj.singleton), 'force_documentation' => bool_to_int(obj.force_documentation), 'block_parameters' => obj.block_params, @@ -215,16 +221,17 @@ module Generators }) output_yaml(c) - return id + return id end - def process_alias(obj, parent, parent_id) + def process_alias(obj, parent, parent_id, file_id) id = get_next_id(:aliases) c = RaAlias.new({ 'id' => id, 'name' => obj.old_name, 'ra_container_id' => parent_id, + 'file_id' => file_id, 'type' => 'RaAlias', 'value' => obj.new_name, 'comment' => obj.comment @@ -233,13 +240,14 @@ module Generators return id end - def process_constant(obj, parent, parent_id) + def process_constant(obj, parent, parent_id, file_id) id = get_next_id(:constants) c = RaConstant.new({ 'id' => id, 'name' => obj.name, 'ra_container_id' => parent_id, + 'file_id' => file_id, 'type' => 'RaConstant', 'value' => obj.value, 'comment' => obj.comment @@ -248,7 +256,7 @@ module Generators return id end - def process_attribute(obj, parent, parent_id) + def process_attribute(obj, parent, parent_id, file_id) id = get_next_id(:attributes) c = RaAttribute.new({ @@ -257,6 +265,7 @@ module Generators 'visibility' => VISIBILITY[obj.visibility], 'name' => obj.name, 'ra_container_id' => parent_id, + 'file_id' => file_id, 'type' => 'RaAttribute', 'comment' => obj.comment }) @@ -264,12 +273,13 @@ module Generators return id end - def process_require(obj, parent, parent_id) + def process_require(obj, parent, parent_id, file_id) id = get_next_id(:requires) c = RaRequire.new({ 'id' => id, 'name' => obj.name, 'ra_container_id' => parent_id, + 'file_id' => file_id, 'type' => 'RaRequire', 'comment' => obj.comment }) @@ -277,12 +287,13 @@ module Generators return id end - def process_include(obj, parent, parent_id) + def process_include(obj, parent, parent_id, file_id) id = get_next_id(:includes) c = RaInclude.new({ 'id' => id, 'name' => obj.name, 'ra_container_id' => parent_id, + 'file_id' => file_id, 'type' => 'RaInclude', 'comment' => obj.comment }) @@ -322,7 +333,6 @@ end # The classes below emulate the ActiveRecord models used by Rannotate # We emulate them so that we can output them to YAML and easily import them in the Rails App -# TODO: Investigate importing the active record models instead of creating these mock objects class RaFile def initialize(attr) rdoc_extension/yaml_generator.rb script/breakpointer script/console script/destroy script/generate script/performance/benchmarker script/performance/profiler script/process/reaper script/process/spawner script/process/spinner script/runner script/server app/views/doc/partials/_in_file.rhtml db/migrate/005_add_file_id.rb 9f87402f533a3060d814921e08195a7803d855b8 conor conor@016420e5-f504-0410-9c4b-e4e4ac7be119 http://github.com/conorh/rannotate/commit/70c83cc50dd35737f6193565fe28461434c39707 70c83cc50dd35737f6193565fe28461434c39707 2007-04-23T21:25:40-07:00 2007-04-23T21:25:40-07:00 imported local changes git-svn-id: file:///Users/conorhunt/Code/Rails/svndavrepo/rannotate/trunk@153 016420e5-f504-0410-9c4b-e4e4ac7be119 2d072307ff98864f92f10a25759eecc79c3ea4d6 conor conor@016420e5-f504-0410-9c4b-e4e4ac7be119