clivecrous-ramaze 0.3.9.5
Sign up to get free protection for your applications and to get access to all the features.
- data/README.markdown +444 -0
- data/Rakefile +197 -0
- data/bin/ramaze +60 -0
- data/doc/AUTHORS +30 -0
- data/doc/CHANGELOG +5757 -0
- data/doc/COPYING +56 -0
- data/doc/FAQ +92 -0
- data/doc/GPL +339 -0
- data/doc/INSTALL +34 -0
- data/doc/LEGAL +26 -0
- data/doc/ProjectInfo +53 -0
- data/doc/TODO +29 -0
- data/doc/meta/announcement.txt +126 -0
- data/doc/meta/configuration.txt +162 -0
- data/doc/meta/internals.txt +278 -0
- data/doc/meta/users.kml +64 -0
- data/doc/migrate/1110_to_1111.txt +131 -0
- data/doc/readme_chunks/appendix.txt +10 -0
- data/doc/readme_chunks/examples.txt +38 -0
- data/doc/readme_chunks/features.txt +148 -0
- data/doc/readme_chunks/getting_help.txt +5 -0
- data/doc/readme_chunks/getting_started.txt +18 -0
- data/doc/readme_chunks/installing.txt +55 -0
- data/doc/readme_chunks/introduction.txt +18 -0
- data/doc/readme_chunks/principles.txt +56 -0
- data/doc/readme_chunks/thanks.txt +59 -0
- data/doc/tutorial/todolist.html +816 -0
- data/doc/tutorial/todolist.mkd +736 -0
- data/examples/auth/auth.rb +54 -0
- data/examples/auth/template/layout.haml +20 -0
- data/examples/auth/template/login.haml +16 -0
- data/examples/blog/README +3 -0
- data/examples/blog/controller/main.rb +29 -0
- data/examples/blog/model/entry.rb +30 -0
- data/examples/blog/public/styles/blog.css +132 -0
- data/examples/blog/spec/blog.rb +87 -0
- data/examples/blog/start.rb +7 -0
- data/examples/blog/view/edit.xhtml +17 -0
- data/examples/blog/view/index.xhtml +17 -0
- data/examples/blog/view/layout.xhtml +11 -0
- data/examples/blog/view/new.xhtml +16 -0
- data/examples/caching.rb +31 -0
- data/examples/chat/model/history.rb +36 -0
- data/examples/chat/model/message.rb +7 -0
- data/examples/chat/public/js/jquery.js +3436 -0
- data/examples/chat/start.rb +40 -0
- data/examples/chat/view/chat.xhtml +29 -0
- data/examples/chat/view/index.xhtml +6 -0
- data/examples/chat/view/layout.xhtml +12 -0
- data/examples/css.rb +37 -0
- data/examples/element.rb +45 -0
- data/examples/facebook.rb +159 -0
- data/examples/hello.rb +15 -0
- data/examples/httpdigest.rb +50 -0
- data/examples/identity.rb +18 -0
- data/examples/layout.rb +28 -0
- data/examples/linking.rb +29 -0
- data/examples/localization/start.rb +35 -0
- data/examples/memleak_detector.rb +32 -0
- data/examples/nitro_form.rb +23 -0
- data/examples/provide.rb +23 -0
- data/examples/ramaise.rb +132 -0
- data/examples/rammit/spec/rammit.rb +31 -0
- data/examples/rammit/src/controller/main.rb +3 -0
- data/examples/rammit/src/controller/page.rb +16 -0
- data/examples/rammit/src/model.rb +33 -0
- data/examples/rammit/start.rb +8 -0
- data/examples/rammit/template/index.xhtml +14 -0
- data/examples/rammit/template/page/view.xhtml +4 -0
- data/examples/rapaste/Rakefile +35 -0
- data/examples/rapaste/controller/paste.rb +94 -0
- data/examples/rapaste/model/paste.rb +55 -0
- data/examples/rapaste/public/css/active4d.css +114 -0
- data/examples/rapaste/public/css/all_hallows_eve.css +72 -0
- data/examples/rapaste/public/css/amy.css +147 -0
- data/examples/rapaste/public/css/blackboard.css +88 -0
- data/examples/rapaste/public/css/brilliance_black.css +605 -0
- data/examples/rapaste/public/css/brilliance_dull.css +599 -0
- data/examples/rapaste/public/css/cobalt.css +149 -0
- data/examples/rapaste/public/css/dawn.css +121 -0
- data/examples/rapaste/public/css/display.css +197 -0
- data/examples/rapaste/public/css/eiffel.css +121 -0
- data/examples/rapaste/public/css/espresso_libre.css +109 -0
- data/examples/rapaste/public/css/idle.css +62 -0
- data/examples/rapaste/public/css/iplastic.css +80 -0
- data/examples/rapaste/public/css/lazy.css +73 -0
- data/examples/rapaste/public/css/mac_classic.css +123 -0
- data/examples/rapaste/public/css/magicwb_amiga.css +104 -0
- data/examples/rapaste/public/css/pastels_on_dark.css +188 -0
- data/examples/rapaste/public/css/slush_poppies.css +85 -0
- data/examples/rapaste/public/css/spacecadet.css +51 -0
- data/examples/rapaste/public/css/sunburst.css +180 -0
- data/examples/rapaste/public/css/twilight.css +137 -0
- data/examples/rapaste/public/css/zenburnesque.css +91 -0
- data/examples/rapaste/public/js/jquery.js +11 -0
- data/examples/rapaste/spec/rapaste.rb +49 -0
- data/examples/rapaste/start.rb +24 -0
- data/examples/rapaste/view/copy.xhtml +10 -0
- data/examples/rapaste/view/index.xhtml +9 -0
- data/examples/rapaste/view/layout.xhtml +25 -0
- data/examples/rapaste/view/list.xhtml +29 -0
- data/examples/rapaste/view/search.xhtml +41 -0
- data/examples/rapaste/view/view.xhtml +37 -0
- data/examples/rapp.rb +45 -0
- data/examples/rest.rb +28 -0
- data/examples/sequel_form.rb +24 -0
- data/examples/sequel_scaffolding.rb +24 -0
- data/examples/simple.rb +56 -0
- data/examples/simple_auth.rb +23 -0
- data/examples/sourceview/public/coderay.css +104 -0
- data/examples/sourceview/public/images/file.gif +0 -0
- data/examples/sourceview/public/images/folder.gif +0 -0
- data/examples/sourceview/public/images/tv-collapsable-last.gif +0 -0
- data/examples/sourceview/public/images/tv-collapsable.gif +0 -0
- data/examples/sourceview/public/images/tv-expandable-last.gif +0 -0
- data/examples/sourceview/public/images/tv-expandable.gif +0 -0
- data/examples/sourceview/public/images/tv-item-last.gif +0 -0
- data/examples/sourceview/public/images/tv-item.gif +0 -0
- data/examples/sourceview/public/jquery.js +11 -0
- data/examples/sourceview/public/jquery.treeview.css +48 -0
- data/examples/sourceview/public/jquery.treeview.js +223 -0
- data/examples/sourceview/public/sourceview.js +52 -0
- data/examples/sourceview/sourceview.rb +77 -0
- data/examples/sourceview/template/index.haml +59 -0
- data/examples/templates/template/external.amrita +19 -0
- data/examples/templates/template/external.haml +22 -0
- data/examples/templates/template/external.liquid +28 -0
- data/examples/templates/template/external.mab +30 -0
- data/examples/templates/template/external.nag +28 -0
- data/examples/templates/template/external.redcloth +19 -0
- data/examples/templates/template/external.rem +30 -0
- data/examples/templates/template/external.rhtml +28 -0
- data/examples/templates/template/external.tenjin +28 -0
- data/examples/templates/template/external.xsl +57 -0
- data/examples/templates/template/external.zmr +28 -0
- data/examples/templates/template_amrita2.rb +74 -0
- data/examples/templates/template_erubis.rb +53 -0
- data/examples/templates/template_ezamar.rb +50 -0
- data/examples/templates/template_haml.rb +50 -0
- data/examples/templates/template_liquid.rb +65 -0
- data/examples/templates/template_markaby.rb +58 -0
- data/examples/templates/template_nagoro.rb +51 -0
- data/examples/templates/template_redcloth.rb +59 -0
- data/examples/templates/template_remarkably.rb +55 -0
- data/examples/templates/template_tenjin.rb +53 -0
- data/examples/templates/template_xslt.rb +49 -0
- data/examples/todolist/README +1 -0
- data/examples/todolist/public/favicon.ico +0 -0
- data/examples/todolist/public/js/jquery.js +1923 -0
- data/examples/todolist/public/ramaze.png +0 -0
- data/examples/todolist/spec/todolist.rb +132 -0
- data/examples/todolist/src/controller/main.rb +70 -0
- data/examples/todolist/src/element/page.rb +31 -0
- data/examples/todolist/src/model.rb +14 -0
- data/examples/todolist/start.rb +11 -0
- data/examples/todolist/template/index.xhtml +17 -0
- data/examples/todolist/template/new.xhtml +7 -0
- data/examples/upload/start.rb +19 -0
- data/examples/upload/view/index.xhtml +25 -0
- data/examples/whywiki/spec/whywiki.rb +58 -0
- data/examples/whywiki/start.rb +46 -0
- data/examples/whywiki/template/edit.xhtml +14 -0
- data/examples/whywiki/template/show.xhtml +18 -0
- data/examples/wikore/spec/wikore.rb +111 -0
- data/examples/wikore/src/controller.rb +80 -0
- data/examples/wikore/src/model.rb +52 -0
- data/examples/wikore/start.rb +9 -0
- data/examples/wikore/template/index.xhtml +8 -0
- data/examples/wiktacular/README +2 -0
- data/examples/wiktacular/mkd/link/2007-07-20_19-45-51.mkd +1 -0
- data/examples/wiktacular/mkd/link/current.mkd +1 -0
- data/examples/wiktacular/mkd/main/2007-07-20_16-31-33.mkd +1 -0
- data/examples/wiktacular/mkd/main/2007-07-20_19-21-12.mkd +1 -0
- data/examples/wiktacular/mkd/main/2007-07-20_19-23-10.mkd +2 -0
- data/examples/wiktacular/mkd/main/2007-07-20_19-45-07.mkd +2 -0
- data/examples/wiktacular/mkd/main/current.mkd +2 -0
- data/examples/wiktacular/mkd/markdown/current.mkd +3 -0
- data/examples/wiktacular/mkd/testing/2007-07-20_16-43-46.mkd +2 -0
- data/examples/wiktacular/mkd/testing/2007-07-20_19-43-50.mkd +3 -0
- data/examples/wiktacular/mkd/testing/2007-07-21_18-46-01.mkd +11 -0
- data/examples/wiktacular/mkd/testing/2007-07-21_18-46-32.mkd +13 -0
- data/examples/wiktacular/mkd/testing/2007-07-21_18-47-08.mkd +17 -0
- data/examples/wiktacular/mkd/testing/2007-07-21_18-47-54.mkd +17 -0
- data/examples/wiktacular/mkd/testing/current.mkd +17 -0
- data/examples/wiktacular/public/favicon.ico +0 -0
- data/examples/wiktacular/public/screen.css +72 -0
- data/examples/wiktacular/spec/wiktacular.rb +158 -0
- data/examples/wiktacular/src/controller.rb +55 -0
- data/examples/wiktacular/src/model.rb +102 -0
- data/examples/wiktacular/start.rb +8 -0
- data/examples/wiktacular/template/edit.xhtml +6 -0
- data/examples/wiktacular/template/html_layout.xhtml +27 -0
- data/examples/wiktacular/template/index.xhtml +9 -0
- data/examples/wiktacular/template/new.xhtml +6 -0
- data/lib/proto/controller/main.rb +22 -0
- data/lib/proto/public/css/ramaze_error.css +90 -0
- data/lib/proto/public/dispatch.fcgi +11 -0
- data/lib/proto/public/favicon.ico +0 -0
- data/lib/proto/public/js/jquery.js +3436 -0
- data/lib/proto/public/ramaze.png +0 -0
- data/lib/proto/spec/main.rb +24 -0
- data/lib/proto/start.rb +8 -0
- data/lib/proto/start.ru +16 -0
- data/lib/proto/view/error.xhtml +64 -0
- data/lib/proto/view/index.xhtml +34 -0
- data/lib/proto/view/page.xhtml +27 -0
- data/lib/ramaze.rb +108 -0
- data/lib/ramaze/action.rb +153 -0
- data/lib/ramaze/action/render.rb +191 -0
- data/lib/ramaze/adapter.rb +101 -0
- data/lib/ramaze/adapter/base.rb +103 -0
- data/lib/ramaze/adapter/cgi.rb +24 -0
- data/lib/ramaze/adapter/ebb.rb +22 -0
- data/lib/ramaze/adapter/evented_mongrel.rb +7 -0
- data/lib/ramaze/adapter/fcgi.rb +24 -0
- data/lib/ramaze/adapter/lsws.rb +23 -0
- data/lib/ramaze/adapter/mongrel.rb +25 -0
- data/lib/ramaze/adapter/scgi.rb +22 -0
- data/lib/ramaze/adapter/swiftiplied_mongrel.rb +7 -0
- data/lib/ramaze/adapter/thin.rb +22 -0
- data/lib/ramaze/adapter/webrick.rb +52 -0
- data/lib/ramaze/cache.rb +115 -0
- data/lib/ramaze/cache/memcached.rb +71 -0
- data/lib/ramaze/cache/memory.rb +6 -0
- data/lib/ramaze/cache/yaml_store.rb +68 -0
- data/lib/ramaze/contrib.rb +82 -0
- data/lib/ramaze/contrib/auto_params.rb +135 -0
- data/lib/ramaze/contrib/auto_params/get_args.rb +57 -0
- data/lib/ramaze/contrib/email.rb +84 -0
- data/lib/ramaze/contrib/facebook.rb +23 -0
- data/lib/ramaze/contrib/facebook/facebook.rb +171 -0
- data/lib/ramaze/contrib/file_cache.rb +65 -0
- data/lib/ramaze/contrib/gems.rb +65 -0
- data/lib/ramaze/contrib/gettext.rb +113 -0
- data/lib/ramaze/contrib/gettext/mo.rb +155 -0
- data/lib/ramaze/contrib/gettext/parser.rb +46 -0
- data/lib/ramaze/contrib/gettext/po.rb +109 -0
- data/lib/ramaze/contrib/gzip_filter.rb +56 -0
- data/lib/ramaze/contrib/profiling.rb +36 -0
- data/lib/ramaze/contrib/rest.rb +14 -0
- data/lib/ramaze/contrib/sequel/fill.rb +12 -0
- data/lib/ramaze/contrib/sequel_cache.rb +92 -0
- data/lib/ramaze/controller.rb +281 -0
- data/lib/ramaze/controller/error.rb +46 -0
- data/lib/ramaze/controller/main.rb +2 -0
- data/lib/ramaze/controller/resolve.rb +252 -0
- data/lib/ramaze/current.rb +70 -0
- data/lib/ramaze/current/request.rb +204 -0
- data/lib/ramaze/current/response.rb +27 -0
- data/lib/ramaze/current/session.rb +181 -0
- data/lib/ramaze/current/session/flash.rb +79 -0
- data/lib/ramaze/current/session/hash.rb +66 -0
- data/lib/ramaze/dispatcher.rb +137 -0
- data/lib/ramaze/dispatcher/action.rb +41 -0
- data/lib/ramaze/dispatcher/directory.rb +119 -0
- data/lib/ramaze/dispatcher/error.rb +108 -0
- data/lib/ramaze/dispatcher/file.rb +95 -0
- data/lib/ramaze/error.rb +24 -0
- data/lib/ramaze/gestalt.rb +129 -0
- data/lib/ramaze/helper.rb +78 -0
- data/lib/ramaze/helper/aspect.rb +110 -0
- data/lib/ramaze/helper/auth.rb +125 -0
- data/lib/ramaze/helper/cache.rb +140 -0
- data/lib/ramaze/helper/cgi.rb +47 -0
- data/lib/ramaze/helper/flash.rb +59 -0
- data/lib/ramaze/helper/form.rb +281 -0
- data/lib/ramaze/helper/formatting.rb +118 -0
- data/lib/ramaze/helper/httpdigest.rb +49 -0
- data/lib/ramaze/helper/identity.rb +105 -0
- data/lib/ramaze/helper/link.rb +124 -0
- data/lib/ramaze/helper/markaby.rb +31 -0
- data/lib/ramaze/helper/maruku.rb +7 -0
- data/lib/ramaze/helper/nitroform.rb +14 -0
- data/lib/ramaze/helper/pager.rb +366 -0
- data/lib/ramaze/helper/partial.rb +96 -0
- data/lib/ramaze/helper/redirect.rb +82 -0
- data/lib/ramaze/helper/rest.rb +43 -0
- data/lib/ramaze/helper/sendfile.rb +16 -0
- data/lib/ramaze/helper/sequel.rb +55 -0
- data/lib/ramaze/helper/stack.rb +72 -0
- data/lib/ramaze/helper/tagz.rb +19 -0
- data/lib/ramaze/helper/user.rb +78 -0
- data/lib/ramaze/log.rb +27 -0
- data/lib/ramaze/log/analogger.rb +37 -0
- data/lib/ramaze/log/growl.rb +35 -0
- data/lib/ramaze/log/hub.rb +38 -0
- data/lib/ramaze/log/informer.rb +125 -0
- data/lib/ramaze/log/knotify.rb +25 -0
- data/lib/ramaze/log/logger.rb +23 -0
- data/lib/ramaze/log/logging.rb +88 -0
- data/lib/ramaze/log/syslog.rb +36 -0
- data/lib/ramaze/log/xosd.rb +88 -0
- data/lib/ramaze/option.rb +153 -0
- data/lib/ramaze/option/dsl.rb +45 -0
- data/lib/ramaze/option/holder.rb +143 -0
- data/lib/ramaze/option/merger.rb +106 -0
- data/lib/ramaze/route.rb +97 -0
- data/lib/ramaze/setup.rb +50 -0
- data/lib/ramaze/snippets.rb +9 -0
- data/lib/ramaze/snippets/array/put_within.rb +37 -0
- data/lib/ramaze/snippets/binding/locals.rb +13 -0
- data/lib/ramaze/snippets/blankslate.rb +7 -0
- data/lib/ramaze/snippets/dictionary.rb +504 -0
- data/lib/ramaze/snippets/divide.rb +20 -0
- data/lib/ramaze/snippets/kernel/__dir__.rb +23 -0
- data/lib/ramaze/snippets/kernel/acquire.rb +34 -0
- data/lib/ramaze/snippets/kernel/constant.rb +26 -0
- data/lib/ramaze/snippets/kernel/pretty_inspect.rb +15 -0
- data/lib/ramaze/snippets/metaid.rb +17 -0
- data/lib/ramaze/snippets/numeric/filesize_format.rb +25 -0
- data/lib/ramaze/snippets/object/instance_variable_defined.rb +8 -0
- data/lib/ramaze/snippets/object/pretty.rb +6 -0
- data/lib/ramaze/snippets/object/scope.rb +11 -0
- data/lib/ramaze/snippets/object/thread_accessor.rb +5 -0
- data/lib/ramaze/snippets/object/traits.rb +76 -0
- data/lib/ramaze/snippets/ordered_set.rb +40 -0
- data/lib/ramaze/snippets/proc/locals.rb +11 -0
- data/lib/ramaze/snippets/ramaze/caller_info.rb +30 -0
- data/lib/ramaze/snippets/ramaze/caller_lines.rb +51 -0
- data/lib/ramaze/snippets/ramaze/deprecated.rb +7 -0
- data/lib/ramaze/snippets/ramaze/thread_accessor.rb +58 -0
- data/lib/ramaze/snippets/string/camel_case.rb +16 -0
- data/lib/ramaze/snippets/string/color.rb +27 -0
- data/lib/ramaze/snippets/string/each.rb +8 -0
- data/lib/ramaze/snippets/string/esc.rb +29 -0
- data/lib/ramaze/snippets/string/ord.rb +15 -0
- data/lib/ramaze/snippets/string/snake_case.rb +15 -0
- data/lib/ramaze/snippets/string/start_with.rb +8 -0
- data/lib/ramaze/snippets/string/unindent.rb +20 -0
- data/lib/ramaze/snippets/struct/fill.rb +23 -0
- data/lib/ramaze/snippets/struct/values_at.rb +24 -0
- data/lib/ramaze/snippets/symbol/to_proc.rb +24 -0
- data/lib/ramaze/snippets/thread/into.rb +18 -0
- data/lib/ramaze/sourcereload.rb +169 -0
- data/lib/ramaze/spec.rb +1 -0
- data/lib/ramaze/spec/helper.rb +131 -0
- data/lib/ramaze/spec/helper/bacon.rb +7 -0
- data/lib/ramaze/spec/helper/browser.rb +88 -0
- data/lib/ramaze/spec/helper/mock_http.rb +69 -0
- data/lib/ramaze/spec/helper/pretty_output.rb +82 -0
- data/lib/ramaze/spec/helper/requester.rb +63 -0
- data/lib/ramaze/spec/helper/simple_http.rb +434 -0
- data/lib/ramaze/spec/helper/snippets.rb +6 -0
- data/lib/ramaze/store/default.rb +109 -0
- data/lib/ramaze/template.rb +84 -0
- data/lib/ramaze/template/amrita2.rb +45 -0
- data/lib/ramaze/template/builder.rb +28 -0
- data/lib/ramaze/template/erubis.rb +41 -0
- data/lib/ramaze/template/ezamar.rb +42 -0
- data/lib/ramaze/template/ezamar/element.rb +169 -0
- data/lib/ramaze/template/ezamar/engine.rb +76 -0
- data/lib/ramaze/template/ezamar/morpher.rb +135 -0
- data/lib/ramaze/template/ezamar/render_partial.rb +31 -0
- data/lib/ramaze/template/haml.rb +37 -0
- data/lib/ramaze/template/liquid.rb +36 -0
- data/lib/ramaze/template/markaby.rb +52 -0
- data/lib/ramaze/template/nagoro.rb +52 -0
- data/lib/ramaze/template/none.rb +14 -0
- data/lib/ramaze/template/redcloth.rb +25 -0
- data/lib/ramaze/template/remarkably.rb +38 -0
- data/lib/ramaze/template/sass.rb +37 -0
- data/lib/ramaze/template/tagz.rb +79 -0
- data/lib/ramaze/template/tenjin.rb +74 -0
- data/lib/ramaze/template/xslt.rb +100 -0
- data/lib/ramaze/tool.rb +9 -0
- data/lib/ramaze/tool/create.rb +74 -0
- data/lib/ramaze/tool/localize.rb +198 -0
- data/lib/ramaze/tool/mime.rb +25 -0
- data/lib/ramaze/tool/mime_types.yaml +615 -0
- data/lib/ramaze/tool/record.rb +6 -0
- data/lib/ramaze/trinity.rb +13 -0
- data/lib/ramaze/version.rb +14 -0
- data/lib/vendor/bacon.rb +323 -0
- data/rake_tasks/conf.rake +83 -0
- data/rake_tasks/coverage.rake +46 -0
- data/rake_tasks/darcs.rake +14 -0
- data/rake_tasks/gem.rake +85 -0
- data/rake_tasks/git.rake +4 -0
- data/rake_tasks/maintenance.rake +436 -0
- data/rake_tasks/spec.rake +62 -0
- data/spec/contrib/auto_params.rb +121 -0
- data/spec/contrib/profiling.rb +29 -0
- data/spec/contrib/sequel/fill.rb +47 -0
- data/spec/examples/caching.rb +19 -0
- data/spec/examples/css.rb +15 -0
- data/spec/examples/element.rb +15 -0
- data/spec/examples/hello.rb +11 -0
- data/spec/examples/linking.rb +18 -0
- data/spec/examples/simple.rb +45 -0
- data/spec/examples/simple_auth.rb +32 -0
- data/spec/examples/templates/template_amrita2.rb +16 -0
- data/spec/examples/templates/template_erubis.rb +23 -0
- data/spec/examples/templates/template_ezamar.rb +23 -0
- data/spec/examples/templates/template_haml.rb +25 -0
- data/spec/examples/templates/template_liquid.rb +29 -0
- data/spec/examples/templates/template_markaby.rb +23 -0
- data/spec/examples/templates/template_redcloth.rb +28 -0
- data/spec/examples/templates/template_remarkably.rb +23 -0
- data/spec/examples/templates/template_tenjin.rb +28 -0
- data/spec/helper.rb +3 -0
- data/spec/ramaze/action/basics.rb +36 -0
- data/spec/ramaze/action/cache.rb +87 -0
- data/spec/ramaze/action/file_cache.rb +48 -0
- data/spec/ramaze/action/layout.rb +190 -0
- data/spec/ramaze/action/render.rb +32 -0
- data/spec/ramaze/action/view/bar.xhtml +1 -0
- data/spec/ramaze/action/view/instancevars/layout.xhtml +1 -0
- data/spec/ramaze/action/view/other_wrapper.xhtml +1 -0
- data/spec/ramaze/action/view/single_wrapper.xhtml +1 -0
- data/spec/ramaze/action/view/sub/sub_wrapper.xhtml +1 -0
- data/spec/ramaze/adapter.rb +39 -0
- data/spec/ramaze/adapter/ebb.rb +12 -0
- data/spec/ramaze/adapter/mongrel.rb +12 -0
- data/spec/ramaze/adapter/record.rb +31 -0
- data/spec/ramaze/adapter/webrick.rb +12 -0
- data/spec/ramaze/cache.rb +140 -0
- data/spec/ramaze/controller.rb +177 -0
- data/spec/ramaze/controller/actionless_templates.rb +32 -0
- data/spec/ramaze/controller/resolve.rb +32 -0
- data/spec/ramaze/controller/subclass.rb +21 -0
- data/spec/ramaze/controller/template_resolving.rb +113 -0
- data/spec/ramaze/controller/view/greet.xhtml +1 -0
- data/spec/ramaze/controller/view/list.xhtml +1 -0
- data/spec/ramaze/controller/view/other/greet/other.xhtml +1 -0
- data/spec/ramaze/controller/view/other_wrapper.xhtml +1 -0
- data/spec/ramaze/current/request.rb +30 -0
- data/spec/ramaze/current/session.rb +97 -0
- data/spec/ramaze/dispatcher.rb +31 -0
- data/spec/ramaze/dispatcher/directory.rb +55 -0
- data/spec/ramaze/dispatcher/file.rb +60 -0
- data/spec/ramaze/dispatcher/public/favicon.ico +0 -0
- data/spec/ramaze/dispatcher/public/file name.txt +1 -0
- data/spec/ramaze/dispatcher/public/test_download.css +141 -0
- data/spec/ramaze/element.rb +107 -0
- data/spec/ramaze/error.rb +94 -0
- data/spec/ramaze/gestalt.rb +131 -0
- data/spec/ramaze/helper/aspect.rb +92 -0
- data/spec/ramaze/helper/auth.rb +66 -0
- data/spec/ramaze/helper/cache.rb +160 -0
- data/spec/ramaze/helper/cgi.rb +43 -0
- data/spec/ramaze/helper/file.rb +18 -0
- data/spec/ramaze/helper/flash.rb +133 -0
- data/spec/ramaze/helper/form.rb +118 -0
- data/spec/ramaze/helper/formatting.rb +41 -0
- data/spec/ramaze/helper/link.rb +124 -0
- data/spec/ramaze/helper/pager.rb +99 -0
- data/spec/ramaze/helper/partial.rb +76 -0
- data/spec/ramaze/helper/redirect.rb +112 -0
- data/spec/ramaze/helper/stack.rb +73 -0
- data/spec/ramaze/helper/user.rb +43 -0
- data/spec/ramaze/helper/view/locals.xhtml +1 -0
- data/spec/ramaze/helper/view/loop.xhtml +4 -0
- data/spec/ramaze/helper/view/num.xhtml +1 -0
- data/spec/ramaze/helper/view/partial.xhtml +1 -0
- data/spec/ramaze/helper/view/recursive.xhtml +8 -0
- data/spec/ramaze/helper/view/recursive_local_ivars.xhtml +7 -0
- data/spec/ramaze/helper/view/recursive_locals.xhtml +7 -0
- data/spec/ramaze/helper/view/test_template.xhtml +1 -0
- data/spec/ramaze/localize.rb +89 -0
- data/spec/ramaze/log/informer.rb +72 -0
- data/spec/ramaze/log/syslog.rb +10 -0
- data/spec/ramaze/morpher.rb +111 -0
- data/spec/ramaze/params.rb +157 -0
- data/spec/ramaze/public/error404.xhtml +1 -0
- data/spec/ramaze/public/favicon.ico +0 -0
- data/spec/ramaze/public/ramaze.png +0 -0
- data/spec/ramaze/public/test_download.css +141 -0
- data/spec/ramaze/request.rb +185 -0
- data/spec/ramaze/request/ebb.rb +9 -0
- data/spec/ramaze/request/mongrel.rb +9 -0
- data/spec/ramaze/request/thin.rb +9 -0
- data/spec/ramaze/request/webrick.rb +5 -0
- data/spec/ramaze/rewrite.rb +36 -0
- data/spec/ramaze/rewrite/file.css +1 -0
- data/spec/ramaze/route.rb +131 -0
- data/spec/ramaze/session.rb +94 -0
- data/spec/ramaze/store/default.rb +71 -0
- data/spec/ramaze/template.rb +128 -0
- data/spec/ramaze/template/amrita2.rb +50 -0
- data/spec/ramaze/template/amrita2/external.amrita +6 -0
- data/spec/ramaze/template/amrita2/sum.amrita +1 -0
- data/spec/ramaze/template/builder.rb +55 -0
- data/spec/ramaze/template/builder/external.rxml +3 -0
- data/spec/ramaze/template/erubis.rb +41 -0
- data/spec/ramaze/template/erubis/sum.rhtml +1 -0
- data/spec/ramaze/template/ezamar.rb +63 -0
- data/spec/ramaze/template/ezamar/another/long/action.zmr +1 -0
- data/spec/ramaze/template/ezamar/combined.zmr +1 -0
- data/spec/ramaze/template/ezamar/file_only.zmr +1 -0
- data/spec/ramaze/template/ezamar/index.zmr +1 -0
- data/spec/ramaze/template/ezamar/nested.zmr +1 -0
- data/spec/ramaze/template/ezamar/other__index.xhtml +1 -0
- data/spec/ramaze/template/ezamar/some__long__action.zmr +1 -0
- data/spec/ramaze/template/ezamar/sum.zmr +1 -0
- data/spec/ramaze/template/haml.rb +66 -0
- data/spec/ramaze/template/haml/index.haml +5 -0
- data/spec/ramaze/template/haml/locals.haml +2 -0
- data/spec/ramaze/template/haml/with_vars.haml +4 -0
- data/spec/ramaze/template/liquid.rb +99 -0
- data/spec/ramaze/template/liquid/index.liquid +1 -0
- data/spec/ramaze/template/liquid/products.liquid +45 -0
- data/spec/ramaze/template/markaby.rb +61 -0
- data/spec/ramaze/template/markaby/external.mab +8 -0
- data/spec/ramaze/template/markaby/sum.mab +1 -0
- data/spec/ramaze/template/nagoro.rb +64 -0
- data/spec/ramaze/template/nagoro/another/long/action.nag +1 -0
- data/spec/ramaze/template/nagoro/combined.nag +1 -0
- data/spec/ramaze/template/nagoro/file_only.nag +1 -0
- data/spec/ramaze/template/nagoro/index.nag +1 -0
- data/spec/ramaze/template/nagoro/nested.nag +1 -0
- data/spec/ramaze/template/nagoro/some__long__action.nag +1 -0
- data/spec/ramaze/template/nagoro/sum.nag +1 -0
- data/spec/ramaze/template/ramaze/external.test +1 -0
- data/spec/ramaze/template/redcloth.rb +38 -0
- data/spec/ramaze/template/redcloth/external.redcloth +1 -0
- data/spec/ramaze/template/remarkably.rb +58 -0
- data/spec/ramaze/template/remarkably/external.rem +8 -0
- data/spec/ramaze/template/remarkably/sum.rem +1 -0
- data/spec/ramaze/template/sass.rb +69 -0
- data/spec/ramaze/template/sass/file.css.sass +5 -0
- data/spec/ramaze/template/tagz.rb +62 -0
- data/spec/ramaze/template/tagz/external.tagz +8 -0
- data/spec/ramaze/template/tagz/sum.tagz +1 -0
- data/spec/ramaze/template/tenjin.rb +47 -0
- data/spec/ramaze/template/tenjin/external.tenjin +1 -0
- data/spec/ramaze/template/xslt.rb +90 -0
- data/spec/ramaze/template/xslt/concat_words.xsl +16 -0
- data/spec/ramaze/template/xslt/index.xsl +14 -0
- data/spec/ramaze/template/xslt/products.xsl +32 -0
- data/spec/ramaze/template/xslt/ruby_version.xsl +14 -0
- data/spec/snippets/array/put_within.rb +33 -0
- data/spec/snippets/divide.rb +19 -0
- data/spec/snippets/kernel/__dir__.rb +8 -0
- data/spec/snippets/kernel/acquire.rb +71 -0
- data/spec/snippets/kernel/constant.rb +23 -0
- data/spec/snippets/numeric/filesize_format.rb +12 -0
- data/spec/snippets/ordered_set.rb +63 -0
- data/spec/snippets/ramaze/caller_info.rb +39 -0
- data/spec/snippets/ramaze/caller_lines.rb +30 -0
- data/spec/snippets/string/camel_case.rb +25 -0
- data/spec/snippets/string/color.rb +11 -0
- data/spec/snippets/string/snake_case.rb +24 -0
- data/spec/snippets/string/unindent.rb +43 -0
- data/spec/snippets/struct/fill.rb +26 -0
- data/spec/snippets/struct/values_at.rb +44 -0
- data/spec/snippets/symbol/to_proc.rb +13 -0
- data/spec/snippets/thread/into.rb +20 -0
- metadata +789 -0
@@ -0,0 +1,736 @@
|
|
1
|
+
# To-do List Tutorial
|
2
|
+
|
3
|
+
## Step Zero, Introduction
|
4
|
+
|
5
|
+
Welcome to our official tutorial, the mandatory to-do list.
|
6
|
+
I'm writing this while doing the steps to assure it will work for you.
|
7
|
+
|
8
|
+
The tutorial assumes that you have Ramaze installed already. The easiest way to
|
9
|
+
do that is `gem install ramaze`, for other ways of installation please see the
|
10
|
+
documentation at http://ramaze.rubyforge.org
|
11
|
+
|
12
|
+
Should you encounter any problems while doing this tutorial, this might either
|
13
|
+
be because Ramaze changed (which happens very often while it is still young)
|
14
|
+
or I actually made some mistake while writing it.
|
15
|
+
|
16
|
+
In either case it would make me (and all other poor fellows who happen to try
|
17
|
+
this tutorial) very happy if you could spare some time and report the issue
|
18
|
+
either on the Bug tracker at http://rubyforge.org/projects/ramaze or just
|
19
|
+
drop by on IRC ( irc.freenode.org channel: #ramaze ).
|
20
|
+
|
21
|
+
There is also a Mailing list available where you can keep yourself updated on
|
22
|
+
what is going on with little effort, it is also located on the project-page at
|
23
|
+
RubyForge.
|
24
|
+
|
25
|
+
Additionally, we now have added tests for the resulting application that you
|
26
|
+
can find in spec/examples/todolist.rb
|
27
|
+
|
28
|
+
Date of last update: Thu Jan 31 04:37:16 JST 2008
|
29
|
+
|
30
|
+
Thanks in advance.
|
31
|
+
The author of the tutorial, Michael 'manveru' Fellinger
|
32
|
+
|
33
|
+
## First Step, Create
|
34
|
+
|
35
|
+
We are using `ramaze --create todolist` to create a new application.
|
36
|
+
Ramaze will then create the directory and fill it with a skeleton of a quite
|
37
|
+
sophisticated hello-world example out of which we will create the actual
|
38
|
+
to-do list.
|
39
|
+
|
40
|
+
So run:
|
41
|
+
|
42
|
+
$ ramaze --create todolist
|
43
|
+
|
44
|
+
done.
|
45
|
+
|
46
|
+
|
47
|
+
## Second Step, M, like Model
|
48
|
+
|
49
|
+
Ramaze comes at the moment only with a simple wrapper of the YAML::Store.
|
50
|
+
So we are going to base this on the tools available, you can just do the same
|
51
|
+
with your ORM or database-library of choice.
|
52
|
+
|
53
|
+
So first, create a `model/todolist.rb` for our application:
|
54
|
+
|
55
|
+
require 'ramaze/store/default'
|
56
|
+
TodoList = Ramaze::Store::Default.new('todolist.yaml')
|
57
|
+
|
58
|
+
Let's add some items as well to have a base to start from.
|
59
|
+
|
60
|
+
{ 'Laundry' => {:done => false},
|
61
|
+
'Wash dishes' => {:done => false},
|
62
|
+
}.each do |title, value|
|
63
|
+
TodoList[title] = value
|
64
|
+
end
|
65
|
+
|
66
|
+
|
67
|
+
## Third Step, V, like View
|
68
|
+
|
69
|
+
Now let's get our hands dirty and just edit the templates for our to-do list.
|
70
|
+
|
71
|
+
Start with editing `view/index.xhtml`, it is using the default templating
|
72
|
+
of Ramaze, called Ezamar.
|
73
|
+
|
74
|
+
The index.xhtml currently contains a default welcome page, remove the contents.
|
75
|
+
|
76
|
+
Let's put some things in there, I'll explain the syntax as we go, it's quite
|
77
|
+
simple.
|
78
|
+
|
79
|
+
<html>
|
80
|
+
<head>
|
81
|
+
<title>TodoList</title>
|
82
|
+
</head>
|
83
|
+
<body>
|
84
|
+
<h1>TodoList</h1>
|
85
|
+
<ul>
|
86
|
+
<?r
|
87
|
+
TodoList.each do |title, value|
|
88
|
+
status = value[:done] ? 'done' : 'not done'
|
89
|
+
?>
|
90
|
+
<li>#{c title}: #{status}</li>
|
91
|
+
<?r end ?>
|
92
|
+
</ul>
|
93
|
+
</body>
|
94
|
+
</html>
|
95
|
+
|
96
|
+
I will assume that you are familiar with basic Ruby already, so we will
|
97
|
+
concentrate on the things new here.
|
98
|
+
|
99
|
+
`<?r ?>` defines an area of ruby-code. Later, when the template is transformed
|
100
|
+
into pure Ruby it will be evaluated. We iterate over the TodoList model and
|
101
|
+
pass the title and value into a block. In that block we can just get the values
|
102
|
+
of title and status (which we define based on the value) displayed on the
|
103
|
+
page.
|
104
|
+
|
105
|
+
The whole Template would expand to something like this (only showing the
|
106
|
+
interesting part)
|
107
|
+
|
108
|
+
<ul>
|
109
|
+
<li>Laundry: not done</li>
|
110
|
+
<li>Wash dishes: not done</li>
|
111
|
+
</ul>
|
112
|
+
|
113
|
+
That wasn't too bad, huh?
|
114
|
+
|
115
|
+
Now, so we can get our instant pleasure of seeing the result of our (hard) work,
|
116
|
+
let's see how to start ramaze.
|
117
|
+
|
118
|
+
In the `todolist` directory run `ramaze`.
|
119
|
+
|
120
|
+
This will start an instance of Ramaze and run your application on it. You can
|
121
|
+
now access it by browsing to http://localhost:7000/
|
122
|
+
|
123
|
+
7000 is the default-port Ramaze will run on, to change it you can just run
|
124
|
+
`ramaze -p 7070` or similar. Also be sure to look at the output of
|
125
|
+
`ramaze --help` to see some other options.
|
126
|
+
|
127
|
+
|
128
|
+
## Fourth Step, C, like Controller
|
129
|
+
|
130
|
+
The last part of the MVC-paradigm is the Controller.
|
131
|
+
|
132
|
+
Wouldn't it be nice to have a way to add and remove items on our to-do list?
|
133
|
+
Editing the model every time would be quite tiresome and limited.
|
134
|
+
|
135
|
+
Well, come along, I'll introduce you to Controller.
|
136
|
+
|
137
|
+
In the way MVC is structured, the Controller provides the data in a nice way
|
138
|
+
for the View, removing all of the data-preparation and most of the logic from
|
139
|
+
the templates. This makes it firstly simple to change the front end of your
|
140
|
+
application and secondly provides excellent ways of changing the complete
|
141
|
+
Structure of the Model or View independent from each other.
|
142
|
+
|
143
|
+
OK, enough of the theory, you will see the benefits in an instant. Go on and
|
144
|
+
edit the file `controller/main.rb`.
|
145
|
+
|
146
|
+
The contents of it are like following:
|
147
|
+
|
148
|
+
class MainController < Controller
|
149
|
+
def index
|
150
|
+
@welcome = "Welcome to Ramaze!"
|
151
|
+
end
|
152
|
+
|
153
|
+
def notemplate
|
154
|
+
"there is no template associated with this action"
|
155
|
+
end
|
156
|
+
end
|
157
|
+
|
158
|
+
The only methods right now are `#index` and `#notemplate`.
|
159
|
+
The relationship between the methods on the controller and the templates is
|
160
|
+
1:1, so the method `#index` is combined with the template `index.xhtml`. This
|
161
|
+
combination is called an `action`.
|
162
|
+
|
163
|
+
Let's get back to editing and change the method `#index` to this:
|
164
|
+
|
165
|
+
def index
|
166
|
+
@tasks = TodoList.original
|
167
|
+
@tasks.each do |title, value|
|
168
|
+
status = value[:done] ? 'done' : 'not done'
|
169
|
+
@tasks[title] = status
|
170
|
+
end
|
171
|
+
end
|
172
|
+
|
173
|
+
This will take care of the logic inside the template, which now should be
|
174
|
+
changed to do following:
|
175
|
+
|
176
|
+
<html>
|
177
|
+
<head>
|
178
|
+
<title>TodoList</title>
|
179
|
+
</head>
|
180
|
+
<body>
|
181
|
+
<h1>TodoList</h1>
|
182
|
+
<?r if @tasks.empty? ?>
|
183
|
+
No Tasks
|
184
|
+
<?r else ?>
|
185
|
+
<ul>
|
186
|
+
<?r @tasks.each do |title, status| ?>
|
187
|
+
<li>#{c title}: #{status}</li>
|
188
|
+
<?r end ?>
|
189
|
+
</ul>
|
190
|
+
<?r end ?>
|
191
|
+
</body>
|
192
|
+
</html>
|
193
|
+
|
194
|
+
The rest of the template can stay the same.
|
195
|
+
|
196
|
+
Now, if you browse to http://localhost:7000/ again you will not notice any
|
197
|
+
change, which is how it should be. The only change is that if there are no
|
198
|
+
Tasks it will say so.
|
199
|
+
|
200
|
+
Some things you should know:
|
201
|
+
|
202
|
+
* Instance-variables defined in the Controller are available in the View.
|
203
|
+
* The return-value of the Controller does not matter if a template is present.
|
204
|
+
|
205
|
+
## Fifth Step, getting dynamic
|
206
|
+
|
207
|
+
We set out to build the ultimate to-do list, but there are still some things
|
208
|
+
missing. First off, we want to add new tasks, so let's get that done.
|
209
|
+
|
210
|
+
Add a link on the `view/index.xhtml` like this:
|
211
|
+
|
212
|
+
<h1>TodoList</h1>
|
213
|
+
<a href="/new">New Task</a>
|
214
|
+
|
215
|
+
Open a new file `view/new.xhtml` with a form to add a new task.
|
216
|
+
|
217
|
+
<html>
|
218
|
+
<head>
|
219
|
+
<title>TodoList</title>
|
220
|
+
</head>
|
221
|
+
<body>
|
222
|
+
<h1>New Task</h1>
|
223
|
+
<a href="/">Back to TodoList</a>
|
224
|
+
<form method="POST" action="create">
|
225
|
+
Task: <input type="text" name="title" /><br />
|
226
|
+
<input type="submit" />
|
227
|
+
</form>
|
228
|
+
</body>
|
229
|
+
</html>
|
230
|
+
|
231
|
+
We will not need a method for this on our controller, in fact, actions can
|
232
|
+
consist of either method and template or only one of them. The Controller
|
233
|
+
can act as a View and the View can work like you may know it from PHP.
|
234
|
+
|
235
|
+
If you try to use this form you will notice that we have not yet defined a way
|
236
|
+
to actually create the task.
|
237
|
+
|
238
|
+
You will get the default Ramaze error-page instead. Please take your time to
|
239
|
+
explore it and see how Ramaze reacted on the error.
|
240
|
+
|
241
|
+
It will show you the back trace and what state the application is in at the
|
242
|
+
moment, the request and response and the contents of the session. This is very
|
243
|
+
useful for debugging and development, you can provide your own set of
|
244
|
+
error-pages before going into production (or deactivate them fully) though.
|
245
|
+
|
246
|
+
OK, let's implement the action for `#create`, all we want to do is take the
|
247
|
+
requests parameters and create a new task for it, this looks like following on
|
248
|
+
your MainController.
|
249
|
+
|
250
|
+
def create
|
251
|
+
title = request['title']
|
252
|
+
TodoList[title] = {:done => false}
|
253
|
+
redirect Rs()
|
254
|
+
end
|
255
|
+
|
256
|
+
That's all folks!
|
257
|
+
|
258
|
+
We get the title from the request-object, put it into our TodoList as undone
|
259
|
+
and redirect back to the mapping of the current Controller ('/' in this case).
|
260
|
+
|
261
|
+
Now you can create as many tasks as you want, please don't get overworked ;)
|
262
|
+
|
263
|
+
|
264
|
+
## Sixth Step, open and close tasks
|
265
|
+
|
266
|
+
Since the nature of tasks is to be done eventually
|
267
|
+
we will need some way to mark it as done or open tasks again.
|
268
|
+
|
269
|
+
Jump into `view/index.xhtml` and do the following:
|
270
|
+
|
271
|
+
|
272
|
+
<?r @tasks.each do |title, status, toggle| ?>
|
273
|
+
<li>
|
274
|
+
#{c title}: #{status} - [ #{toggle} ]
|
275
|
+
</li>
|
276
|
+
<?r end ?>
|
277
|
+
|
278
|
+
We added a new element here, `toggle`, the Controller should give us
|
279
|
+
a link to change the status corresponding to the status of the task, so off
|
280
|
+
we go and change the index method on the controller once again:
|
281
|
+
|
282
|
+
def index
|
283
|
+
@tasks = []
|
284
|
+
TodoList.original.each do |title, value|
|
285
|
+
if value[:done]
|
286
|
+
status = 'done'
|
287
|
+
toggle = A('Open Task', :href => Rs(:open, title))
|
288
|
+
else
|
289
|
+
status = 'not done'
|
290
|
+
toggle = A('Close Task', :href => Rs(:close, title))
|
291
|
+
end
|
292
|
+
@tasks << [title, status, toggle]
|
293
|
+
end
|
294
|
+
@tasks.sort!
|
295
|
+
end
|
296
|
+
|
297
|
+
Wow, quite some new stuff here. Let me explain that in detail.
|
298
|
+
|
299
|
+
We first decide whether a task is done or not, then go on and provide a link to
|
300
|
+
toggle the status, A and Rs are both methods that help you do that.
|
301
|
+
The result will be something like:
|
302
|
+
|
303
|
+
<a href="/open/Wash+dishes">Close Task</a>
|
304
|
+
|
305
|
+
Rs actually is responsible to build the links href, for more information please
|
306
|
+
take a look at the RDoc for LinkHelper.
|
307
|
+
|
308
|
+
Also, you might have noticed that the tasks were changing order on every reload,
|
309
|
+
which is because we were using an Hash, which are per definition unsorted, so
|
310
|
+
now we use an array to hold our tasks and sort it.
|
311
|
+
|
312
|
+
As usual since the links for open and close don't lead anywhere, add the
|
313
|
+
corresponding methods to the Controller:
|
314
|
+
|
315
|
+
def open title
|
316
|
+
task_status title, false
|
317
|
+
redirect Rs()
|
318
|
+
end
|
319
|
+
|
320
|
+
def close title
|
321
|
+
task_status title, true
|
322
|
+
redirect Rs()
|
323
|
+
end
|
324
|
+
|
325
|
+
private
|
326
|
+
|
327
|
+
def task_status title, status
|
328
|
+
task = TodoList[title]
|
329
|
+
task[:done] = status
|
330
|
+
TodoList[title] = task
|
331
|
+
end
|
332
|
+
|
333
|
+
Oh, now what have we got here?
|
334
|
+
`private` declares that methods from here on are only to be used within the
|
335
|
+
Controller itself, we define an `#task_status` method that takes the title and
|
336
|
+
status to be set so we don't have to repeat that code in `#open` and `#close`
|
337
|
+
and follow the DRY (Don't repeat yourself) paradigm.
|
338
|
+
|
339
|
+
Another thing we have not encountered so far is that you can define your public
|
340
|
+
methods to take parameters on their own, they will be calculated from requests.
|
341
|
+
|
342
|
+
'/open/Wash+dishes'
|
343
|
+
|
344
|
+
will translate into:
|
345
|
+
|
346
|
+
open('Wash dishes')
|
347
|
+
|
348
|
+
Which in turn will call `task_status('Wash dishes', false)`
|
349
|
+
|
350
|
+
That's it, go on and try it :)
|
351
|
+
|
352
|
+
|
353
|
+
## Seventh Step, delete tasks
|
354
|
+
|
355
|
+
Well, creating, opening and closing work now, one of the things you will
|
356
|
+
consider is to delete a task permanently.
|
357
|
+
|
358
|
+
This is just two little changes away, so let's add the link for deletion in our
|
359
|
+
Controller:
|
360
|
+
|
361
|
+
delete = A('Delete', :href => Rs(:delete, title))
|
362
|
+
@tasks << [title, status, toggle, delete]
|
363
|
+
|
364
|
+
and an corresponding method while we're at it:
|
365
|
+
|
366
|
+
def delete title
|
367
|
+
TodoList.delete title
|
368
|
+
redirect Rs()
|
369
|
+
end
|
370
|
+
|
371
|
+
Now jumping to `view/index.xhtml` again, change it so it shows the link:
|
372
|
+
|
373
|
+
<?r @tasks.each do |title, status, toggle, delete| ?>
|
374
|
+
<li>
|
375
|
+
#{c title}: #{status} [ #{toggle} | #{delete} ]
|
376
|
+
</li>
|
377
|
+
<?r end ?>
|
378
|
+
|
379
|
+
Voilà, you now have acquired the Certificate of Ramazeness.
|
380
|
+
|
381
|
+
Just kidding, but that really are the basics, in the next few steps I will
|
382
|
+
explain some more advanced concepts of Ramaze and Ezamar.
|
383
|
+
|
384
|
+
|
385
|
+
## Eighth Step, Elements
|
386
|
+
|
387
|
+
<Page></Page>
|
388
|
+
|
389
|
+
This is called an Element, Ramaze will go and search for a class that matches
|
390
|
+
the name Page and responds to `#render`. Then it will go and hand the content in
|
391
|
+
between to that Element.
|
392
|
+
|
393
|
+
Sounds weird?
|
394
|
+
|
395
|
+
Let us have a look at our templates, they got some repetitive stuff, like:
|
396
|
+
|
397
|
+
<html>
|
398
|
+
<head>
|
399
|
+
<title>TodoList</title>
|
400
|
+
</head>
|
401
|
+
<body>
|
402
|
+
<h1>some title</h1>
|
403
|
+
</body>
|
404
|
+
</html>
|
405
|
+
|
406
|
+
How about replacing that with something short and reusable:
|
407
|
+
|
408
|
+
<Page title="TodoList">
|
409
|
+
your other content
|
410
|
+
</Page>
|
411
|
+
|
412
|
+
Would be nice of course, and when you start having more templates it makes an
|
413
|
+
awful lot of sense being able to change the enclosing stuff in one place.
|
414
|
+
|
415
|
+
So let's apply DRY here as well.
|
416
|
+
|
417
|
+
Take a look at the `src/element/page.rb`
|
418
|
+
|
419
|
+
class Page < Ezamar::Element
|
420
|
+
def render
|
421
|
+
%{
|
422
|
+
<html>
|
423
|
+
<head>
|
424
|
+
<title>Welcome to Ramaze</title>
|
425
|
+
</head>
|
426
|
+
<body>
|
427
|
+
#{content}
|
428
|
+
</body>
|
429
|
+
</html>
|
430
|
+
}
|
431
|
+
end
|
432
|
+
end
|
433
|
+
|
434
|
+
Alright, most things we need are in place already, the most important thing
|
435
|
+
is the `#content` method that we call with `#{content}` inside the string in
|
436
|
+
`#render`.
|
437
|
+
|
438
|
+
Just adopt it to your liking, I'll just use the things we had in our templates
|
439
|
+
so far:
|
440
|
+
|
441
|
+
class Page < Ezamar::Element
|
442
|
+
def render
|
443
|
+
%{
|
444
|
+
<html>
|
445
|
+
<head>
|
446
|
+
<title>TodoList</title>
|
447
|
+
</head>
|
448
|
+
<body>
|
449
|
+
<h1>#{@title}</h1>
|
450
|
+
#{content}
|
451
|
+
</body>
|
452
|
+
</html>
|
453
|
+
}
|
454
|
+
end
|
455
|
+
end
|
456
|
+
|
457
|
+
Please note that instance variables reflecting the parameters are set.
|
458
|
+
|
459
|
+
And let's change our templates as well.
|
460
|
+
|
461
|
+
First the `view/index.xhtml`
|
462
|
+
|
463
|
+
<Page title="TodoList">
|
464
|
+
<a href="/new">New Task</a>
|
465
|
+
<?r if @tasks.empty? ?>
|
466
|
+
No Tasks
|
467
|
+
<?r else ?>
|
468
|
+
<ul>
|
469
|
+
<?r @tasks.each do |title, status, toggle, delete| ?>
|
470
|
+
<li>
|
471
|
+
#{c title}: #{status} [ #{toggle} | #{delete} ]
|
472
|
+
</li>
|
473
|
+
<?r end ?>
|
474
|
+
</ul>
|
475
|
+
<?r end ?>
|
476
|
+
</Page>
|
477
|
+
|
478
|
+
and the `view/new.xhtml`
|
479
|
+
|
480
|
+
<Page title="New Task">
|
481
|
+
<a href="/">Back to TodoList</a>
|
482
|
+
<form method="POST" action="create">
|
483
|
+
Task: <input type="text" name="title" /><br />
|
484
|
+
<input type="submit" />
|
485
|
+
</form>
|
486
|
+
</Page>
|
487
|
+
|
488
|
+
Alright, now just go and look at the result in the browser, try changing
|
489
|
+
the things inside the Element and look at how it behaves.
|
490
|
+
|
491
|
+
|
492
|
+
## Ninth Step, Prettify
|
493
|
+
|
494
|
+
We structure the data inside the list a little bit, in this case into a table,
|
495
|
+
to get it line up properly and look actually structured.
|
496
|
+
|
497
|
+
So, from what we have right now:
|
498
|
+
|
499
|
+
<ul>
|
500
|
+
<?r @tasks.each do |title, status, toggle, delete| ?>
|
501
|
+
<li>
|
502
|
+
#{c title}: #{status} [ #{toggle} | #{delete} ]
|
503
|
+
</li>
|
504
|
+
<?r end ?>
|
505
|
+
</ul>
|
506
|
+
|
507
|
+
To something like this:
|
508
|
+
|
509
|
+
<table>
|
510
|
+
<?r @tasks.each do |title, status, toggle, delete| ?>
|
511
|
+
<tr>
|
512
|
+
<td class="title"> #{c title} </td>
|
513
|
+
<td class="status"> #{status} </td>
|
514
|
+
<td class="toggle"> #{toggle} </td>
|
515
|
+
<td class="delete"> #{delete} </td>
|
516
|
+
</tr>
|
517
|
+
<?r end ?>
|
518
|
+
</table>
|
519
|
+
|
520
|
+
And, since we have proper classes to address some style sheets, jump into the
|
521
|
+
Page element and add some style sheet:
|
522
|
+
|
523
|
+
<head>
|
524
|
+
<title>TodoList</title>
|
525
|
+
<style>
|
526
|
+
table { width: 100%; }
|
527
|
+
tr { background: #efe; width: 100%; }
|
528
|
+
tr:hover { background: #dfd; }
|
529
|
+
td.title { font-weight: bold; width: 60%; }
|
530
|
+
td.status { margin: 1em; }
|
531
|
+
a { color: #3a3; }
|
532
|
+
</style>
|
533
|
+
</head>
|
534
|
+
|
535
|
+
That looks quite a bit nicer, right? And yes, if you don't like tables (though
|
536
|
+
this is an entirely legit use in my opinion) you can just do it like you want,
|
537
|
+
using nested lists or divs/spans, replacing the open/close and delete links with
|
538
|
+
nice images and changing the style according to the status.
|
539
|
+
|
540
|
+
I will leave this as an exercise to the reader.
|
541
|
+
|
542
|
+
|
543
|
+
## Tenth Step, Configuration
|
544
|
+
|
545
|
+
To round up this tutorial a bit, let's introduce you to configuration in Ramaze.
|
546
|
+
This will not go into full depth of possibilities or a total coverage of the
|
547
|
+
options, since they are bound to change over time.
|
548
|
+
|
549
|
+
First of all, the default port Ramaze runs on is 7000, but to make it a usual
|
550
|
+
webserver it has to run on port 80. So, let's add following line in your
|
551
|
+
start.rb right after the lines of require you added before:
|
552
|
+
|
553
|
+
Ramaze::Global.port = 80
|
554
|
+
|
555
|
+
Alright, that wasn't that hard.
|
556
|
+
Let's say now you also want to run Mongrel instead of WEBrick, to get nice a bit
|
557
|
+
of performance:
|
558
|
+
|
559
|
+
Ramaze::Global.adapter = :mongrel
|
560
|
+
|
561
|
+
To do this in a DRY way you could also do following:
|
562
|
+
|
563
|
+
Ramaze::Global.setup do |g|
|
564
|
+
g.port = 80
|
565
|
+
g.adapter = :mongrel
|
566
|
+
end
|
567
|
+
|
568
|
+
It seems to be quite common to put this configuration into separate files so you
|
569
|
+
can just require it on demand. There are other, slightly stronger way to set
|
570
|
+
options, which is either using flags on the ramaze executable, or like this:
|
571
|
+
|
572
|
+
Ramaze.start :port => 80, :adapter => :mongrel
|
573
|
+
|
574
|
+
We haven't started Ramaze directly as of yet, but this allows you to ignore the
|
575
|
+
ramaze executable and just run your application by `ruby start.rb`.
|
576
|
+
|
577
|
+
|
578
|
+
## Eleventh Step, Refactor with AspectHelper
|
579
|
+
|
580
|
+
Now, if you take a closer look at the Controller you will see:
|
581
|
+
|
582
|
+
def create
|
583
|
+
title = request['title']
|
584
|
+
TodoList[title] = {:done => false}
|
585
|
+
redirect R(self)
|
586
|
+
end
|
587
|
+
|
588
|
+
def open title
|
589
|
+
task_status title, false
|
590
|
+
redirect R(self)
|
591
|
+
end
|
592
|
+
|
593
|
+
def close title
|
594
|
+
task_status title, true
|
595
|
+
redirect R(self)
|
596
|
+
end
|
597
|
+
|
598
|
+
def delete title
|
599
|
+
TodoList.delete title
|
600
|
+
redirect R(self)
|
601
|
+
end
|
602
|
+
|
603
|
+
We did some refactoring before, by introducing `#task_status`, but here we have
|
604
|
+
repetition again: `redirect Rs()` _after_ each method did its job.
|
605
|
+
|
606
|
+
However, we can take advantage of one of the helpers Ramaze offers, the
|
607
|
+
AspectHelper.
|
608
|
+
It allows you to easily wrap actions in your controller with other methods
|
609
|
+
|
610
|
+
In your Controller, replace the previous chunk with following:
|
611
|
+
|
612
|
+
def create
|
613
|
+
title = request['title']
|
614
|
+
TodoList[title] = {:done => false}
|
615
|
+
end
|
616
|
+
|
617
|
+
def open title
|
618
|
+
task_status title, false
|
619
|
+
end
|
620
|
+
|
621
|
+
def close title
|
622
|
+
task_status title, true
|
623
|
+
end
|
624
|
+
|
625
|
+
def delete title
|
626
|
+
TodoList.delete title
|
627
|
+
end
|
628
|
+
|
629
|
+
helper :aspect
|
630
|
+
after(:create, :open, :close, :delete){ redirect(Rs()) }
|
631
|
+
|
632
|
+
Alright, that looks a lot nicer already and is definitely easier to maintain.
|
633
|
+
|
634
|
+
There is a symmetrical `before` aspect that you could take advantage of as
|
635
|
+
well, and in case you want to add required authentication for all actions of a
|
636
|
+
Controller you could use `before_all` and `after_all` instead of a list of
|
637
|
+
action-names.
|
638
|
+
|
639
|
+
|
640
|
+
## Twelfth Step, Validation and Errors
|
641
|
+
|
642
|
+
Right now, all kinds of things could still go wrong when you do things like
|
643
|
+
creating tasks with no title at all or try to open/close a task that does not
|
644
|
+
exist. So in this step we will add some little checks for these cases.
|
645
|
+
|
646
|
+
First we head over to the Controller again and take a look at `#create`:
|
647
|
+
|
648
|
+
def create
|
649
|
+
title = request['title']
|
650
|
+
TodoList[title] = {:done => false}
|
651
|
+
end
|
652
|
+
|
653
|
+
Here we just create a new task, no matter what we get. Every seasoned
|
654
|
+
web-developer would advise you to be suspicious about all the input you receive
|
655
|
+
from your users, so let's apply this advice.
|
656
|
+
|
657
|
+
def create
|
658
|
+
if title = request['title']
|
659
|
+
title.strip!
|
660
|
+
if title.empty?
|
661
|
+
failed("Please enter a title")
|
662
|
+
redirect '/new'
|
663
|
+
end
|
664
|
+
TodoList[title] = {:done => false}
|
665
|
+
end
|
666
|
+
end
|
667
|
+
|
668
|
+
First of all we check if we got a request with a value for 'title', if we get
|
669
|
+
none we just let the aspect kick in that will redirect the browser to the index.
|
670
|
+
Next we strip the title of all spaces around it so we can check if it is empty.
|
671
|
+
We will talk about the specifics of our error-handling now.
|
672
|
+
|
673
|
+
Ramaze has a helper called FlashHelper, that will keep a hash associated with
|
674
|
+
the session for one request, afterwards the hash is thrown away. This is
|
675
|
+
specifically useful for giving the user feedback while keeping a stateless
|
676
|
+
approach.
|
677
|
+
|
678
|
+
Let me show you our `#failed` method (it goes in the private section to
|
679
|
+
`#task_status`):
|
680
|
+
|
681
|
+
def failed(message)
|
682
|
+
flash[:error] = message
|
683
|
+
end
|
684
|
+
|
685
|
+
Duh, you may say, wouldn't that fit in the one line instead of the call to
|
686
|
+
`#failed`?
|
687
|
+
Indeed, it would, but let me remind you, we have no checks for changing the
|
688
|
+
status of a task yet. We will need error-handling there as well, so we just keep
|
689
|
+
our code DRY and maintainable by collecting shared behaviour in small pieces.
|
690
|
+
|
691
|
+
Now on to the `#task_status`:
|
692
|
+
|
693
|
+
def task_status title, status
|
694
|
+
unless task = TodoList[title]
|
695
|
+
failed "No such Task: `#{title}'"
|
696
|
+
redirect_referer
|
697
|
+
end
|
698
|
+
|
699
|
+
task[:done] = status
|
700
|
+
TodoList[title] = task
|
701
|
+
end
|
702
|
+
|
703
|
+
That used to look like this:
|
704
|
+
|
705
|
+
def task_status title, status
|
706
|
+
task = TodoList[title]
|
707
|
+
task[:done] = status
|
708
|
+
TodoList[title] = task
|
709
|
+
end
|
710
|
+
|
711
|
+
So in fact all we added is a check whether a task already exists, set an
|
712
|
+
error-message in case it doesn't and redirect to wherever the browser came from.
|
713
|
+
|
714
|
+
But what about actually showing the error-messages we so carefully set? Well,
|
715
|
+
where do we change the view? Right, in the templates. But both templates we have
|
716
|
+
so far (index and new) share this behaviour, so we head over to the Element
|
717
|
+
and add in the right place:
|
718
|
+
|
719
|
+
<body>
|
720
|
+
<h1>#{@title}</h1>
|
721
|
+
<?r if flash[:error] ?>
|
722
|
+
<div class="error">
|
723
|
+
\\#{flash[:error]}
|
724
|
+
</div>
|
725
|
+
<?r end ?>
|
726
|
+
#{content}
|
727
|
+
</body>
|
728
|
+
|
729
|
+
The only thing special about it is the `\\#{flash[:error]}`, we have to escape
|
730
|
+
the `#` so it won't evaluate this immediately but wait until it is really
|
731
|
+
rendered.
|
732
|
+
As a note, If you read this as pure markaby, the double backslash is to output
|
733
|
+
properly to HTML, just use one instead.
|
734
|
+
Again, you can add some nifty style for that.
|
735
|
+
|
736
|
+
To be continued...
|