1. Sites
  2. Users
  3. Login
  4. Home
About
Shim
Site_logo
EPF Wiki (307 )
Designed to be used together with Eclipse Process Framework (EPF)
Copyright (c) 2006 Logica Result Centre
About EPF Wiki

EPF Wiki is Wiki technology designed to be used together with Eclipse Process Framework (EPF). This offers the best of two distinct worlds: the worlds of Wikis and powerfull process frameworks. It combines a modular method construction approach and the flexibility and ease of use that is the defining characteristic of a wiki.

  • EPF Wiki enhances EPFC published process descriptions with Wiki functions using Javascript (wiki.js)
  • EPF Wiki is a Web Application created using Ruby On Rails Framework
  • EPF Wiki is Wiki technology that works on plain HTML (no Wiki markup language) easy editable using commonly available browser-based WYSIWYG HTML editors (e.g. TinyMCE)

Properties
Application Name EPF Wiki
Revision 307
Rails Version 2.2.2
Database Schema Version 7
TO DO

(in /home/user/epf.eclipse.org_2/releases/20090413072651)
app/controllers/application.rb:
* [ 33] [TODO] don't send error email when action error causes an error
* [ 34] [TODO] do something with errors generated by bots?
* [ 63] [TODO] to have caching of pages per user group add something like :params => params.merge( :utype=> 'admin' )
* [ 79] [TODO] should be flash.now?

app/controllers/login_controller.rb:
* [100] [TODO] security enhancement: require the old password
* [101] [TODO] like to use flash.now here but functional tests will fail! Is a bug?

app/controllers/pages_controller.rb:
* [ 23] [TODO] check that we really need this
* [ 33] [TODO] add 'Compare with previous' link
* [ 97] [TODO] this is not used?
* [110] [TODO] these kind of statement are no longer necessary,
* [153] [TODO] force post method
* [204] [TODO] a better name would be source_version_id?
* [217] [TODO] his will cause an error in new.rhtml. Implement test
* [225] [TODO] improved security - move authorisation check to Checkout.undo?
* [247] [TODO] Implement test
* [291] [TODO] be able to quickly retrieve a list of pages based on content type in a site

app/controllers/portal_controller.rb:
* [ 82] [FIXME] Bugzilla 231125

app/controllers/sites_controller.rb:
* [117] [TODO] doesn't seem possible to pass local variables to background so we just update all for now
* [118] [TODO] does not seem to move stuff to the background for some reason

app/controllers/users_controller.rb:
* [ 46] [TODO] caching of this page
* [ 82] [TODO] Cannot destroy user with versions and comments,

app/helpers/application_helper.rb:
* [ 38] [TODO] a better name for this method
* [188] [TODO] below incorrect

app/models/baseline_process.rb:
* [ 68] [TODO] exclude CVS directories from zip and put library.xmi in root
* [ 84] [TODO] obsolete?
* [118] [TODO] do this for Wikis as well, including status

app/models/checkout.rb:
* [ 65] [TODO] rename HEAD_PATTERN -> HEAD_REGEXP
* [ 89] [TODO] workaround for 250148: No-wrap should be part of CSS file https://bugs.eclipse.org/bugs/show_bug.cgi?id=250148
* [ 91] [TODO] set title equal to pageTitle?
* [117] [TODO] step 4 does not seem to work anymore with current version of OpenUP (EPF)
* [118] [TODO] move to version as part of checkout
* [120] [TODO] is this right? document this

app/models/comment.rb:
* [ 26] [TODO] remove these redundant properties

app/models/configuration.rb:
* [ 23] [TODO] ScmConfiguration.status(bp)

app/models/cvs_configuration.rb:
* [ 46] [TODO] REMOVE log_entries = bp.co_and_publish_log_entries
* [ 71] [TODO] REMOVE
* [ 76] [TODO] REMOVE

app/models/cvs_diff_item.rb:
* [ 15] [TODO] only doing to revision but actually there can be more than ...
* [ 53] [TODO] for some reason self.path does not end with .xmi when self.rel_path does end with .xmi, which is impossible (but still occuring)

app/models/da_text.rb:
* [ 24] [TODO] problably there is a better way to do this

app/models/difference_analysis.rb:
* [ 15] [TODO] remove after migration
* [ 28] [TODO]
* [ 33] [TODO] unclear what validates associated does,
* [ 44] [TODO] R? 1 transaction. This should be 1 transaction.
* [ 87] [TODO] R? compare status IGNORED

app/models/difference_analysis_item.rb:
* [ 15] [TODO] remove after migration

app/models/notification.rb:
* [ 24] [TODO] user class as third parameter?

app/models/notifier.rb:
* [157] [TODO] replace with notification

app/models/page.rb:
* [ 62] [TODO] use regular expressions the right way
* [ 98] [TODO] http://maintainable.com/articles/rails_logging_tips

app/models/site.rb:
* [ 27] [TODO] remove after migration
* [ 29] [TODO] validate :user not :user_id
* [ 31] [TODO] Folde can contain . (dot) because it is created from a filename
* [ 46] [TODO]
* [ 87] [TODO] check if index.htm is in root
* [ 88] [TODO] rename unzip_upload to unzip
* [166] [TODO] werkt niet op de productie/staging omgeving. Daar worden slechts de symbolic links verwijderd

app/models/sweeper.rb:
* [ 19] [TODO] more advanced expiration

app/models/update.rb:
* [ 21] [TODO] validates_presence_of :user, :baseline_process, :wiki

app/models/user.rb:
* [ 7] [TODO] disabled this, because this causes some error and we are not using Bugzilla integration

app/models/version.rb:
* [ 24] [TODO] not necessary?
* [ 66] [TODO] this doesn't add value
* [ 82] [TODO] use page.last_version
* [116] [TODO] remove? This should not be necessary, see html
* [117] [TODO] remove?
* [127] [TODO] Workaround for Tidy adding title attributes which causes false changes
* [196] [TODO] implement
* [206] [TODO] implement

app/models/wiki.rb:
* [119] [TODO] notify users that want to be notified (add about notify_baseline_updates column to users)
* [120] [TODO] Change 68 - Update should continue with checkouts and should not overwrite not harvested changes
* [188] [TODO] update_id <> ?
* [204] [TODO] anomaly, the following line shouldn't be necessary but is, in some cases.
* [241] [TODO]
* [259] [TODO] rename to snippets

app/models/wiki_page.rb:
* [ 22] [TODO] database change -> rename page_id to wiki_page_id
* [ 27] [TODO] not working, find out why
* [ 35] [TODO] (but now now) anomaly works in the console but not in the application or in tests. Then is always returns nil. Replaced with method
* [ 41] [TODO] anomaly. the above statement does not work. Comments is always nil. When I change the key
* [ 49] [FIXME] Bugzilla 231125
* [ 54] [TODO] causes error when there are checkouts?
* [ 72] [TODO] not sure if this is used
* [ 81] [TODO] new_using_template when there is already a checkout causes error without clear message
* [113] [TODO] don't think this is working, but there is a workaround
* [137] [TODO] this method should also do the html stuff
* [146] [TODO] this is not possible although I really don't know why
* [193] [TODO] Bugzilla 231125
* [243] [TODO] add check that if the page is a new page (tool = 'Wiki'), the user needs to be set

lib/generic.rb:
* [103] [TODO] is Tidy ignoring this option
* [116] [TODO] integrate new tidy dll when it is available. Note: this will improve generated diffs with xhtmldiff
* [178] [TODO] maybe twice if already done as part of update

lib/sitemap.rb:
* [ 42] [TODO] don't understand where to_s comes from
* [ 66] [TODO] een page can be without versions?
* [ 83] [TODO] don't understand where to_s comes from
* [133] [TODO] don't understand where to_s comes from
* [147] [TODO] don't understand where to_s comes from

test/functional/comments_controller_test.rb:
* [ 61] [TODO] test update

test/functional/feedbacks_controller_test.rb:
* [ 50] [TODO] cannot test this because the controller uses request.referer

test/functional/pages_controller_test.rb:
* [185] [TODO] Bug 218832 - RTE

test/functional/portal_controller_test.rb:
* [134] [TODO] more advanced archives test

test/functional/uploads_controller_test.rb:
* [ 89] [TODO] test this, currently we cannot test this because use of request.referer causes errors: "The error occurred while evaluating nil.[]"

test/functional/users_controller_test.rb:
* [235] [TODO] implement test

test/integration/creating_sites_and_wikis_test.rb:
* [ 59] [TODO] http://blog.finalist.com/2007/02/12/test-driven-development-met-ruby-on-rails/
* [ 79] [TODO] can't test this because we use flash.now, this only works without 'now'
* [126] [TODO] test for sending of email
* [135] [TODO] expected to not be nil.
* [214] [TODO] cleanup

test/integration/setup_and_sign_in_test.rb:
* [143] [TODO] Rails bug?
* [144] [TODO] Rails bug?
* [163] [TODO] we can't use cookies[:epfwiki_id] anymore?

test/test_helper.rb:
* [100] [TODO] implement functional test for confirm message

test/unit/checkout_test.rb:
* [ 39] [TODO] 5. we cannot checkout a page in a site that has not been wikified yet
* [ 40] [TODO] 6. we can supply a note with a checkout
* [ 41] [TODO] 7. checkout removes
* [ 51] [TODO] test for message, how "RuntimeError: Versions can only be created in Wiki sites"
* [ 76] [TODO] mixed results with this, caused by page.checkout, that doesn't seem to work
* [101] [TODO] 5. don't supply html which will checkin using the version file

test/unit/configuration_test.rb:
* [ 55] [TODO] REMOVE
* [ 57] [TODO] REMOVE

test/unit/notifier_test.rb:
* [ 35] [TODO] include all record types:

test/unit/user_test.rb:
* [250] [TODO] fails
* [291] [TODO] we can update attributes

test/unit/version_test.rb:
* [190] [TODO] (but now now) note part of it is in the previous test

Statistics
 (in /home/user/epf.eclipse.org_2/releases/20090413072651)
+----------------------+-------+-------+---------+---------+-----+-------+
| Name                 | Lines |   LOC | Classes | Methods | M/C | LOC/M |
+----------------------+-------+-------+---------+---------+-----+-------+
| Controllers          |  1718 |  1210 |      14 |     106 |   7 |     9 |
| Helpers              |   283 |   225 |       1 |      16 |  16 |    12 |
| Models               |  3008 |  1875 |      29 |     179 |   6 |     8 |
| Libraries            |   563 |   391 |       0 |      24 |   0 |    14 |
| Integration tests    |   457 |   321 |       2 |       5 |   2 |    62 |
| Functional tests     |  1632 |  1081 |      23 |      67 |   2 |    14 |
| Unit tests           |  1845 |  1298 |      13 |      60 |   4 |    19 |
+----------------------+-------+-------+---------+---------+-----+-------+
| Total                |  9506 |  6401 |      82 |     457 |   5 |    12 |
+----------------------+-------+-------+---------+---------+-----+-------+
  Code LOC: 3701     Test LOC: 2700     Code to Test Ratio: 1:0.7

EPF Wiki Environment Variables
EPFWIKI_APP_NAMEEPF Wiki
EPFWIKI_AUTH_METHODSvalidemail
EPFWIKI_DIFFS_PATH/home/user/epf.eclipse.org_2/releases/20090413072651/public/production_diffs/
EPFWIKI_EDITORtinymce
EPFWIKI_GOOGLE_CUSTOM_SEARCHY
EPFWIKI_HOSTepf.eclipse.org
EPFWIKI_MAIL_ACCOUNTepf-dev@epfwiki.net
EPFWIKI_MAIL_PW
EPFWIKI_MAIL_SERVERmail.epfwiki.net
EPFWIKI_MARKDOWN_BAT_FILE/home/user/epf.eclipse.org_2/releases/20090413072651/script/other/html2text.bat
EPFWIKI_PUBLIC_FOLDERpublic
EPFWIKI_REPLY_ADDRESSno-reply@epf.eclipse.org
EPFWIKI_ROOT_DIR/home/user/epf.eclipse.org_2/releases/20090413072651/
EPFWIKI_SITES_FOLDERbp
EPFWIKI_SITES_PATH/home/user/epf.eclipse.org_2/releases/20090413072651/public/bp
EPFWIKI_TEMPLATES_DIR/home/user/epf.eclipse.org_2/releases/20090413072651/public/templates/
EPFWIKI_WIKIS_FOLDERwikis
EPFWIKI_WIKIS_PATH/home/user/epf.eclipse.org_2/releases/20090413072651/public/wikis
Other Environment Variables
CUR_REQUEST_URI/dispatch.lsapi
CVS_LIBRARY_XMI_FILES_PATH/home/user/epf_libraries
DOCUMENT_ROOT/home/user/epf.eclipse.org_2/releases/20090413072651/public
EPF_WORKSPACE/home/user/epfc_workspace
EQUINOX_JAR_PATH/home/user/epfc_1.5.0.2/plugins/org.eclipse.equinox.launcher_1.0.1.R33x_v20080118.jar
GATEWAY_INTERFACECGI/1.2
HTTP_ACCEPTtext/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
HTTP_ACCEPT_CHARSETISO-8859-1,utf-8;q=0.7,*;q=0.7
HTTP_ACCEPT_ENCODINGgzip
HTTP_ACCEPT_LANGUAGEen-us,en;q=0.5
HTTP_CACHE_CONTROLno-cache
HTTP_CONNECTIONclose
HTTP_COOKIEEPFWiki@epf.eclipse.org=c0bd84eb220b64b477d96f93b8e36ba2
HTTP_HOSTepf.eclipse.org
HTTP_PRAGMAno-cache
HTTP_USER_AGENTCCBot/1.0 (+http://www.commoncrawl.org/bot.html)
HTTP_X_CC_IDccc03-01
PATH/bin:/usr/bin
PATH_INFO/other/about
QUERY_STRING
RAILS_ENVproduction
REDIRECT_STATUS404
REDIRECT_URL/other/about.html
REMOTE_ADDR38.107.191.102
REMOTE_PORT60076
REQUEST_METHODGET
REQUEST_PATH/other/about
REQUEST_URI/other/about
SCRIPT_NAME/
SERVER_ADDR209.217.126.111
SERVER_NAMEepf.eclipse.org
SERVER_PORT80
SERVER_PROTOCOLHTTP/1.1
SERVER_SOFTWARELiteSpeed