Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

first commit

  • Loading branch information...
commit a32211b60e71524f57009e3ab94eaded377e588f 0 parents
Elad Ossadon authored October 28, 2010

Showing 67 changed files with 11,035 additions and 0 deletions. Show diff stats Hide diff stats

  1. 2  .gitignore
  2. 3  CHANGELOG.rdoc
  3. 5  Gemfile
  4. 11  Gemfile.lock
  5. 18  LICENSE
  6. 226  README.md
  7. 4  examples/rails3-example/.gitignore
  8. 34  examples/rails3-example/Gemfile
  9. 77  examples/rails3-example/Gemfile.lock
  10. 256  examples/rails3-example/README
  11. 7  examples/rails3-example/Rakefile
  12. 3  examples/rails3-example/app/controllers/application_controller.rb
  13. 63  examples/rails3-example/app/controllers/articles_controller.rb
  14. 2  examples/rails3-example/app/helpers/application_helper.rb
  15. 2  examples/rails3-example/app/helpers/articles_helper.rb
  16. 11  examples/rails3-example/app/views/articles/article.html.ejs
  17. 35  examples/rails3-example/app/views/articles/show_client.html.erb
  18. 4  examples/rails3-example/app/views/articles/show_server_template_in_view.html.erb
  19. 13  examples/rails3-example/app/views/layouts/application.html.erb
  20. 4  examples/rails3-example/config.ru
  21. 42  examples/rails3-example/config/application.rb
  22. 13  examples/rails3-example/config/boot.rb
  23. 22  examples/rails3-example/config/database.yml
  24. 5  examples/rails3-example/config/environment.rb
  25. 26  examples/rails3-example/config/environments/development.rb
  26. 49  examples/rails3-example/config/environments/production.rb
  27. 35  examples/rails3-example/config/environments/test.rb
  28. 7  examples/rails3-example/config/initializers/backtrace_silencers.rb
  29. 10  examples/rails3-example/config/initializers/inflections.rb
  30. 5  examples/rails3-example/config/initializers/mime_types.rb
  31. 7  examples/rails3-example/config/initializers/secret_token.rb
  32. 8  examples/rails3-example/config/initializers/session_store.rb
  33. 5  examples/rails3-example/config/locales/en.yml
  34. 65  examples/rails3-example/config/routes.rb
  35. 7  examples/rails3-example/db/seeds.rb
  36. 2  examples/rails3-example/doc/README_FOR_APP
  37. 26  examples/rails3-example/public/404.html
  38. 26  examples/rails3-example/public/422.html
  39. 26  examples/rails3-example/public/500.html
  40. 0  examples/rails3-example/public/favicon.ico
  41. BIN  examples/rails3-example/public/images/rails.png
  42. 239  examples/rails3-example/public/index.html
  43. 2  examples/rails3-example/public/javascripts/application.js
  44. 965  examples/rails3-example/public/javascripts/controls.js
  45. 974  examples/rails3-example/public/javascripts/dragdrop.js
  46. 1,123  examples/rails3-example/public/javascripts/effects.js
  47. 6,001  examples/rails3-example/public/javascripts/prototype.js
  48. 175  examples/rails3-example/public/javascripts/rails.js
  49. 53  examples/rails3-example/public/javascripts/template.js
  50. 5  examples/rails3-example/public/robots.txt
  51. 0  examples/rails3-example/public/stylesheets/.gitkeep
  52. 6  examples/rails3-example/script/rails
  53. 9  examples/rails3-example/test/functional/articles_controller_test.rb
  54. 9  examples/rails3-example/test/performance/browsing_test.rb
  55. 13  examples/rails3-example/test/test_helper.rb
  56. 4  examples/rails3-example/test/unit/helpers/article_helper_test.rb
  57. 4  examples/rails3-example/test/unit/helpers/articles_helper_test.rb
  58. 0  examples/rails3-example/vendor/plugins/.gitkeep
  59. 1  examples/rails3-example/vendor/plugins/ruby-hybrid-templates
  60. 4  examples/sinatra-example/server.rb
  61. 29  isotope.gemspec
  62. 53  lib/isotope.js
  63. 75  lib/isotope.rb
  64. 9  lib/version.rb
  65. 0  tasks/.gitkeep b/examples/rails3-example/lib/tasks/.gitkeep
  66. 11  test/article.ejs
  67. 105  test/isotope_spec.rb
2  .gitignore
... ...
@@ -0,0 +1,2 @@
  1
+examples/rails3-example/log
  2
+examples/rails3-example/tmp
3  CHANGELOG.rdoc
Source Rendered
... ...
@@ -0,0 +1,3 @@
  1
+== 1.0.0 Initial release, 2010-10-28
  2
+
  3
+* Initial release
5  Gemfile
... ...
@@ -0,0 +1,5 @@
  1
+source :rubygemss
  2
+source :gemcutter
  3
+source "http://gems.github.com"
  4
+
  5
+gem "johnson"
11  Gemfile.lock
... ...
@@ -0,0 +1,11 @@
  1
+GEM
  2
+  remote: http://rubygems.org/
  3
+  remote: http://gems.github.com/
  4
+  specs:
  5
+    johnson (1.2.0)
  6
+
  7
+PLATFORMS
  8
+  ruby
  9
+
  10
+DEPENDENCIES
  11
+  johnson
18  LICENSE
... ...
@@ -0,0 +1,18 @@
  1
+Copyright (c) 2010 Elad Ossadon
  2
+
  3
+Permission is hereby granted, free of charge, to any person obtaining a copy of 
  4
+this software and associated documentation files (the "Software"), to deal in 
  5
+the Software without restriction, including without limitation the rights to 
  6
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of 
  7
+the Software, and to permit persons to whom the Software is furnished to do so, 
  8
+subject to the following conditions:
  9
+
  10
+The above copyright notice and this permission notice shall be included in all 
  11
+copies or substantial portions of the Software.
  12
+
  13
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
  14
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS 
  15
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR 
  16
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 
  17
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 
  18
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
226  README.md
Source Rendered
... ...
@@ -0,0 +1,226 @@
  1
+# Isotope - Ruby Hybrid Template Engine for Client Side and Server Side
  2
+
  3
+## The problem:
  4
+
  5
+Ajax based site developers sometimes struggle with content rendering and role division between server and client.
  6
+
  7
+## Common approaches, pros and cons:
  8
+
  9
+A few approaches to output a rendered template evaluated with an object are:
  10
+
  11
+### Approach #1: Regular ERB Partial
  12
+
  13
+Evaluate a simple ERB partial with a local object, and server it as a **string** to the client, simply by
  14
+
  15
+	<%= render :partial => "article", :object => @article %>
  16
+
  17
+in a view, or from a controller and request it by Ajax.
  18
+
  19
+This partial can look like:
  20
+	
  21
+	<h2><%=article.title%></h2>
  22
+	<div class="content">
  23
+	<%=article.content%>
  24
+	</div>
  25
+	<ul class="tags">
  26
+		<%article.tags.each { |tag|%>
  27
+		<li><%=tag.name%></li>
  28
+		<%}%>
  29
+	</ul>
  30
+		
  31
+#### Pros
  32
+
  33
+* Simple, readable and well known ERB for Rails/Sinatra
  34
+* SEO and accessibility - HTML code is downloaded into the source
  35
+
  36
+#### Cons
  37
+
  38
+* Server side only
  39
+* Requires download of the whole HTML code, can cause performance issues
  40
+* To change data or bind with a different object on client side JS, need to do some DOM traversal, by using a technique like assigning special classes/attributes to data containers (`<div class="content"></div>` and something like `container.querySelect('.content').textContent=article.content;`)
  41
+
  42
+
  43
+### Approach #2: Client Side EJS Template with JSON Objects
  44
+
  45
+Having an EJS template in the HTML code, with techniques such as John Resig's [JavaScript Micro-Templating](http://ejohn.org/blog/javascript-micro-templating/)
  46
+
  47
+	<script type="text/html" id="article-template">
  48
+	<h2><%=item.title%></h2>
  49
+
  50
+	<div class="content">
  51
+	<%=item.content%>
  52
+	</div>
  53
+
  54
+	<ul class="tags">
  55
+		<%item.tags.forEach(function (tag) {%>
  56
+		<li><%=tag.name%></li>
  57
+		<%});%>
  58
+	</ul>
  59
+	</script>
  60
+
  61
+Ask the server for a JSON article and evaluate the template with this object into a string, and place it inside a container, using a techniques as mentioned:
  62
+
  63
+	var results = document.getElementById("results"); // some container on the page
  64
+	results.innerHTML = tmpl("article-template", article); // article is an object, probably a result of an AJAX JSON request
  65
+	
  66
+
  67
+#### Pros
  68
+
  69
+* Fast - requires the server to send only the JSON object and the HTML is downloaded only once as a template
  70
+
  71
+#### Cons
  72
+
  73
+* SEO and accessibility - HTML code isn't in the source of the page but being rendered after load
  74
+
  75
+
  76
+In these two approaches, the developer needs to choose according to the task and the project requirements, or, worse, maintaining two templates, ERB and EJS.
  77
+
  78
+
  79
+## Introducing: Isotope - Ruby Hybrid Template Engine for Client Side and Server Side
  80
+
  81
+So why not combining the two approaches together?
  82
+
  83
+The biggest constraints to be considered are:
  84
+
  85
+* Client side doesn't understand Ruby
  86
+* Ruby can't be translated fully into JavaScript
  87
+* And the most important one: **Template should be maintained in one single file for both client and server uses**
  88
+
  89
+Isotope is from greek - "Equal Place". An equal place of editing a template for both client and server (Thanks @yuvalraz for the name!).
  90
+
  91
+Using [**jbarnette**](http://github.com/jbarnette/)'s [**Johnson**](http://github.com/jbarnette/johnson/) gem, Ruby and JavaScript can interact together!
  92
+
  93
+That means, that ruby code can handle EJS templates and JSON objects. A **great and very inspiring article** is [Write your Rails view in… JavaScript?](http://tenderlovemaking.com/2008/05/06/write-your-rails-view-in-javascript/) by [Aaron Patterson](http://tenderlovemaking.com/).
  94
+
  95
+In this approach, only one template is written in EJS format.
  96
+
  97
+## Usage
  98
+
  99
+There are the methods of using this library:
  100
+
  101
+### On the Client Side
  102
+
  103
+Outputting from the server side (controller or view)
  104
+	
  105
+	<%= Isotope.render_template("full/path/to/article.ejs", :id => "article-template") %>
  106
+	
  107
+*Notice: a full path should be sent as the first variable, so either use `File.join(File.dirname(__FILE__), '../relative/path/to/article.ejs') or with Rails.root.join('app/views/articles/article.ejs')`*
  108
+
  109
+The above code will output:
  110
+
  111
+	<script type="text/x-isotope" id="article-template">
  112
+	<h2><%=item.title%></h2>
  113
+
  114
+	<div class="content">
  115
+	<%=item.content%>
  116
+	</div>
  117
+
  118
+	<ul class="tags">
  119
+		<%item.tags.forEach(function (tag) {%>
  120
+		<li><%=tag.name%></li>
  121
+		<%});%>
  122
+	</ul>
  123
+	</script>
  124
+
  125
+which is easy to evaluate with any JS object using the [mentioned technique](http://ejohn.org/blog/javascript-micro-templating/).
  126
+
  127
+### On the Server Side (The Holy Grail)
  128
+
  129
+Using [Johnson](http://github.com/jbarnette/johnson/), the famous [micro-templating technique](http://ejohn.org/blog/javascript-micro-templating/) and JSONed Ruby objects, this library provides the following functionality:
  130
+
  131
+	<%= Isotope.render_partial("full/path/to/article.js", :locals => { :item => @article }) %>
  132
+
  133
+*Notice: a full path should be sent as the first variable, so either use `File.join(File.dirname(__FILE__), '../relative/path/to/article.ejs') or with Rails.root.join('app/views/articles/article.ejs')`*
  134
+
  135
+This code reads the source of the EJS file, uses Johnson and John Resig's technique and serves a **string** as an output.
  136
+
  137
+
  138
+### Installation:
  139
+
  140
+#### Rails
  141
+
  142
+##### Rails 3.x
  143
+
  144
+	ruby script/rails plugin install git@github.com:elado/isotope.git
  145
+
  146
+Add to your Gemfile
  147
+
  148
+	gem 'json'
  149
+	gem 'johnson'
  150
+
  151
+and run `bundle install`
  152
+
  153
+##### Rails 2.3.x
  154
+
  155
+	ruby script/plugin install git@github.com:elado/isotope.git
  156
+
  157
+Add to config/environment.rb
  158
+
  159
+	config.gem 'json'
  160
+	config.gem 'johnson'
  161
+
  162
+and run `rake gems:install`
  163
+
  164
+##### Server Side Example:
  165
+
  166
+	# ArticlesController
  167
+	
  168
+	def show
  169
+		@article = {
  170
+			:title => "Hello!",
  171
+			:content => "World!",
  172
+			:tags => [
  173
+				{:name => "tag 1"},
  174
+				{:name => "tag 2"},
  175
+				{:name => "tag 3"},
  176
+				{:name => "tag 4"}
  177
+			]
  178
+		} # Or an ActiveRecord fetch
  179
+		
  180
+		render :text => Isotope.render_partial(Rails.root.join('app/views/articles/article.ejs'), :locals => { :item => @article })
  181
+	end
  182
+
  183
+Or, with a view:
  184
+
  185
+	# ArticlesController
  186
+
  187
+	def show
  188
+		@article = {
  189
+			:title => "Hello!",
  190
+			:content => "World!",
  191
+			:tags => [
  192
+				{:name => "tag 1"},
  193
+				{:name => "tag 2"},
  194
+				{:name => "tag 3"},
  195
+				{:name => "tag 4"}
  196
+			]
  197
+		} # Or an ActiveRecord fetch
  198
+	end
  199
+	
  200
+	# views/articles/show.html.erb
  201
+	
  202
+	<%= Isotope.render_partial(Rails.root.join('app/views/articles/article.ejs'), :locals => { :item => @article }) %>
  203
+	
  204
+##### Client Side Example:
  205
+
  206
+	# views/articles/show.html.erb
  207
+	
  208
+	<%= Isotope.render_template(Rails.root.join('app/views/articles/article.ejs'), :id => "article") %>
  209
+	
  210
+
  211
+#### Sinatra
  212
+
  213
+Actually the same usage, more or less.
  214
+
  215
+
  216
+---
  217
+
  218
+---
  219
+
  220
+Would love to hear your comments!
  221
+
  222
+Elad Ossadon
  223
+
  224
+* [http://devign.me](http://devign.me)
  225
+* [http://elad.ossadon.com](http://elad.ossadon.com)
  226
+* [elad@ossadon.com](mailto:elad@ossadon.com)
4  examples/rails3-example/.gitignore
... ...
@@ -0,0 +1,4 @@
  1
+.bundle
  2
+db/*.sqlite3
  3
+log/*.log
  4
+tmp/**/*
34  examples/rails3-example/Gemfile
... ...
@@ -0,0 +1,34 @@
  1
+source 'http://rubygems.org'
  2
+
  3
+gem 'rails', '>=3.0.0'
  4
+
  5
+# gem 'isotope'
  6
+gem 'json'
  7
+gem 'johnson'
  8
+
  9
+# Bundle edge Rails instead:
  10
+# gem 'rails', :git => 'git://github.com/rails/rails.git'
  11
+
  12
+gem 'sqlite3-ruby', :require => 'sqlite3'
  13
+
  14
+# Use unicorn as the web server
  15
+# gem 'unicorn'
  16
+
  17
+# Deploy with Capistrano
  18
+# gem 'capistrano'
  19
+
  20
+# To use debugger
  21
+# gem 'ruby-debug'
  22
+
  23
+# Bundle the extra gems:
  24
+# gem 'bj'
  25
+# gem 'nokogiri'
  26
+# gem 'sqlite3-ruby', :require => 'sqlite3'
  27
+# gem 'aws-s3', :require => 'aws/s3'
  28
+
  29
+# Bundle gems for the local environment. Make sure to
  30
+# put test-only gems in this group so their generators
  31
+# and rake tasks are available in development mode:
  32
+# group :development, :test do
  33
+#   gem 'webrat'
  34
+# end
77  examples/rails3-example/Gemfile.lock
... ...
@@ -0,0 +1,77 @@
  1
+GEM
  2
+  remote: http://rubygems.org/
  3
+  specs:
  4
+    abstract (1.0.0)
  5
+    actionmailer (3.0.0)
  6
+      actionpack (= 3.0.0)
  7
+      mail (~> 2.2.5)
  8
+    actionpack (3.0.0)
  9
+      activemodel (= 3.0.0)
  10
+      activesupport (= 3.0.0)
  11
+      builder (~> 2.1.2)
  12
+      erubis (~> 2.6.6)
  13
+      i18n (~> 0.4.1)
  14
+      rack (~> 1.2.1)
  15
+      rack-mount (~> 0.6.12)
  16
+      rack-test (~> 0.5.4)
  17
+      tzinfo (~> 0.3.23)
  18
+    activemodel (3.0.0)
  19
+      activesupport (= 3.0.0)
  20
+      builder (~> 2.1.2)
  21
+      i18n (~> 0.4.1)
  22
+    activerecord (3.0.0)
  23
+      activemodel (= 3.0.0)
  24
+      activesupport (= 3.0.0)
  25
+      arel (~> 1.0.0)
  26
+      tzinfo (~> 0.3.23)
  27
+    activeresource (3.0.0)
  28
+      activemodel (= 3.0.0)
  29
+      activesupport (= 3.0.0)
  30
+    activesupport (3.0.0)
  31
+    arel (1.0.1)
  32
+      activesupport (~> 3.0.0)
  33
+    builder (2.1.2)
  34
+    erubis (2.6.6)
  35
+      abstract (>= 1.0.0)
  36
+    i18n (0.4.1)
  37
+    johnson (1.2.0)
  38
+    json (1.4.6)
  39
+    mail (2.2.7)
  40
+      activesupport (>= 2.3.6)
  41
+      mime-types
  42
+      treetop (>= 1.4.5)
  43
+    mime-types (1.16)
  44
+    polyglot (0.3.1)
  45
+    rack (1.2.1)
  46
+    rack-mount (0.6.13)
  47
+      rack (>= 1.0.0)
  48
+    rack-test (0.5.6)
  49
+      rack (>= 1.0)
  50
+    rails (3.0.0)
  51
+      actionmailer (= 3.0.0)
  52
+      actionpack (= 3.0.0)
  53
+      activerecord (= 3.0.0)
  54
+      activeresource (= 3.0.0)
  55
+      activesupport (= 3.0.0)
  56
+      bundler (~> 1.0.0)
  57
+      railties (= 3.0.0)
  58
+    railties (3.0.0)
  59
+      actionpack (= 3.0.0)
  60
+      activesupport (= 3.0.0)
  61
+      rake (>= 0.8.4)
  62
+      thor (~> 0.14.0)
  63
+    rake (0.8.7)
  64
+    sqlite3-ruby (1.3.1)
  65
+    thor (0.14.3)
  66
+    treetop (1.4.8)
  67
+      polyglot (>= 0.3.1)
  68
+    tzinfo (0.3.23)
  69
+
  70
+PLATFORMS
  71
+  ruby
  72
+
  73
+DEPENDENCIES
  74
+  johnson
  75
+  json
  76
+  rails (>= 3.0.0)
  77
+  sqlite3-ruby
256  examples/rails3-example/README
... ...
@@ -0,0 +1,256 @@
  1
+== Welcome to Rails
  2
+
  3
+Rails is a web-application framework that includes everything needed to create
  4
+database-backed web applications according to the Model-View-Control pattern.
  5
+
  6
+This pattern splits the view (also called the presentation) into "dumb"
  7
+templates that are primarily responsible for inserting pre-built data in between
  8
+HTML tags. The model contains the "smart" domain objects (such as Account,
  9
+Product, Person, Post) that holds all the business logic and knows how to
  10
+persist themselves to a database. The controller handles the incoming requests
  11
+(such as Save New Account, Update Product, Show Post) by manipulating the model
  12
+and directing data to the view.
  13
+
  14
+In Rails, the model is handled by what's called an object-relational mapping
  15
+layer entitled Active Record. This layer allows you to present the data from
  16
+database rows as objects and embellish these data objects with business logic
  17
+methods. You can read more about Active Record in
  18
+link:files/vendor/rails/activerecord/README.html.
  19
+
  20
+The controller and view are handled by the Action Pack, which handles both
  21
+layers by its two parts: Action View and Action Controller. These two layers
  22
+are bundled in a single package due to their heavy interdependence. This is
  23
+unlike the relationship between the Active Record and Action Pack that is much
  24
+more separate. Each of these packages can be used independently outside of
  25
+Rails. You can read more about Action Pack in
  26
+link:files/vendor/rails/actionpack/README.html.
  27
+
  28
+
  29
+== Getting Started
  30
+
  31
+1. At the command prompt, create a new Rails application:
  32
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
  33
+
  34
+2. Change directory to <tt>myapp</tt> and start the web server:
  35
+       <tt>cd myapp; rails server</tt> (run with --help for options)
  36
+
  37
+3. Go to http://localhost:3000/ and you'll see:
  38
+       "Welcome aboard: You're riding Ruby on Rails!"
  39
+
  40
+4. Follow the guidelines to start developing your application. You can find
  41
+the following resources handy:
  42
+
  43
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
  44
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
  45
+
  46
+
  47
+== Debugging Rails
  48
+
  49
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
  50
+will help you debug it and get it back on the rails.
  51
+
  52
+First area to check is the application log files. Have "tail -f" commands
  53
+running on the server.log and development.log. Rails will automatically display
  54
+debugging and runtime information to these files. Debugging info will also be
  55
+shown in the browser on requests from 127.0.0.1.
  56
+
  57
+You can also log your own messages directly into the log file from your code
  58
+using the Ruby logger class from inside your controllers. Example:
  59
+
  60
+  class WeblogController < ActionController::Base
  61
+    def destroy
  62
+      @weblog = Weblog.find(params[:id])
  63
+      @weblog.destroy
  64
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
  65
+    end
  66
+  end
  67
+
  68
+The result will be a message in your log file along the lines of:
  69
+
  70
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
  71
+
  72
+More information on how to use the logger is at http://www.ruby-doc.org/core/
  73
+
  74
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
  75
+several books available online as well:
  76
+
  77
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
  78
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
  79
+
  80
+These two books will bring you up to speed on the Ruby language and also on
  81
+programming in general.
  82
+
  83
+
  84
+== Debugger
  85
+
  86
+Debugger support is available through the debugger command when you start your
  87
+Mongrel or WEBrick server with --debugger. This means that you can break out of
  88
+execution at any point in the code, investigate and change the model, and then,
  89
+resume execution! You need to install ruby-debug to run the server in debugging
  90
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
  91
+
  92
+  class WeblogController < ActionController::Base
  93
+    def index
  94
+      @posts = Post.find(:all)
  95
+      debugger
  96
+    end
  97
+  end
  98
+
  99
+So the controller will accept the action, run the first line, then present you
  100
+with a IRB prompt in the server window. Here you can do things like:
  101
+
  102
+  >> @posts.inspect
  103
+  => "[#<Post:0x14a6be8
  104
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
  105
+       #<Post:0x14a6620
  106
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
  107
+  >> @posts.first.title = "hello from a debugger"
  108
+  => "hello from a debugger"
  109
+
  110
+...and even better, you can examine how your runtime objects actually work:
  111
+
  112
+  >> f = @posts.first
  113
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
  114
+  >> f.
  115
+  Display all 152 possibilities? (y or n)
  116
+
  117
+Finally, when you're ready to resume execution, you can enter "cont".
  118
+
  119
+
  120
+== Console
  121
+
  122
+The console is a Ruby shell, which allows you to interact with your
  123
+application's domain model. Here you'll have all parts of the application
  124
+configured, just like it is when the application is running. You can inspect
  125
+domain models, change values, and save to the database. Starting the script
  126
+without arguments will launch it in the development environment.
  127
+
  128
+To start the console, run <tt>rails console</tt> from the application
  129
+directory.
  130
+
  131
+Options:
  132
+
  133
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
  134
+  made to the database.
  135
+* Passing an environment name as an argument will load the corresponding
  136
+  environment. Example: <tt>rails console production</tt>.
  137
+
  138
+To reload your controllers and models after launching the console run
  139
+<tt>reload!</tt>
  140
+
  141
+More information about irb can be found at:
  142
+link:http://www.rubycentral.com/pickaxe/irb.html
  143
+
  144
+
  145
+== dbconsole
  146
+
  147
+You can go to the command line of your database directly through <tt>rails
  148
+dbconsole</tt>. You would be connected to the database with the credentials
  149
+defined in database.yml. Starting the script without arguments will connect you
  150
+to the development database. Passing an argument will connect you to a different
  151
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
  152
+PostgreSQL and SQLite 3.
  153
+
  154
+== Description of Contents
  155
+
  156
+The default directory structure of a generated Ruby on Rails application:
  157
+
  158
+  |-- app
  159
+  |   |-- controllers
  160
+  |   |-- helpers
  161
+  |   |-- models
  162
+  |   `-- views
  163
+  |       `-- layouts
  164
+  |-- config
  165
+  |   |-- environments
  166
+  |   |-- initializers
  167
+  |   `-- locales
  168
+  |-- db
  169
+  |-- doc
  170
+  |-- lib
  171
+  |   `-- tasks
  172
+  |-- log
  173
+  |-- public
  174
+  |   |-- images
  175
+  |   |-- javascripts
  176
+  |   `-- stylesheets
  177
+  |-- script
  178
+  |   `-- performance
  179
+  |-- test
  180
+  |   |-- fixtures
  181
+  |   |-- functional
  182
+  |   |-- integration
  183
+  |   |-- performance
  184
+  |   `-- unit
  185
+  |-- tmp
  186
+  |   |-- cache
  187
+  |   |-- pids
  188
+  |   |-- sessions
  189
+  |   `-- sockets
  190
+  `-- vendor
  191
+      `-- plugins
  192
+
  193
+app
  194
+  Holds all the code that's specific to this particular application.
  195
+
  196
+app/controllers
  197
+  Holds controllers that should be named like weblogs_controller.rb for
  198
+  automated URL mapping. All controllers should descend from
  199
+  ApplicationController which itself descends from ActionController::Base.
  200
+
  201
+app/models
  202
+  Holds models that should be named like post.rb. Models descend from
  203
+  ActiveRecord::Base by default.
  204
+
  205
+app/views
  206
+  Holds the template files for the view that should be named like
  207
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
  208
+  eRuby syntax by default.
  209
+
  210
+app/views/layouts
  211
+  Holds the template files for layouts to be used with views. This models the
  212
+  common header/footer method of wrapping views. In your views, define a layout
  213
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
  214
+  Inside default.html.erb, call <% yield %> to render the view using this
  215
+  layout.
  216
+
  217
+app/helpers
  218
+  Holds view helpers that should be named like weblogs_helper.rb. These are
  219
+  generated for you automatically when using generators for controllers.
  220
+  Helpers can be used to wrap functionality for your views into methods.
  221
+
  222
+config
  223
+  Configuration files for the Rails environment, the routing map, the database,
  224
+  and other dependencies.
  225
+
  226
+db
  227
+  Contains the database schema in schema.rb. db/migrate contains all the
  228
+  sequence of Migrations for your schema.
  229
+
  230
+doc
  231
+  This directory is where your application documentation will be stored when
  232
+  generated using <tt>rake doc:app</tt>
  233
+
  234
+lib
  235
+  Application specific libraries. Basically, any kind of custom code that
  236
+  doesn't belong under controllers, models, or helpers. This directory is in
  237
+  the load path.
  238
+
  239
+public
  240
+  The directory available for the web server. Contains subdirectories for
  241
+  images, stylesheets, and javascripts. Also contains the dispatchers and the
  242
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
  243
+  server.
  244
+
  245
+script
  246
+  Helper scripts for automation and generation.
  247
+
  248
+test
  249
+  Unit and functional tests along with fixtures. When using the rails generate
  250
+  command, template test files will be generated for you and placed in this
  251
+  directory.
  252
+
  253
+vendor
  254
+  External libraries that the application depends on. Also includes the plugins
  255
+  subdirectory. If the app has frozen rails, those gems also go here, under
  256
+  vendor/rails/. This directory is in the load path.
7  examples/rails3-example/Rakefile
... ...
@@ -0,0 +1,7 @@
  1
+# Add your own tasks in files placed in lib/tasks ending in .rake,
  2
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
  3
+
  4
+require File.expand_path('../config/application', __FILE__)
  5
+require 'rake'
  6
+
  7
+Rails3Example::Application.load_tasks
3  examples/rails3-example/app/controllers/application_controller.rb
... ...
@@ -0,0 +1,3 @@
  1
+class ApplicationController < ActionController::Base
  2
+  protect_from_forgery
  3
+end
63  examples/rails3-example/app/controllers/articles_controller.rb
... ...
@@ -0,0 +1,63 @@
  1
+require 'isotope'
  2
+
  3
+class ArticlesController < ApplicationController
  4
+  before_filter :find_article
  5
+
  6
+  def show_server_template_in_controller
  7
+		render :text => Isotope.render_partial(Rails.root.join('app/views/articles/article.html.ejs'), :locals => { :item => @articles[0] })
  8
+  end
  9
+
  10
+  def show_server_template_in_view
  11
+    
  12
+  end
  13
+
  14
+  def show_client
  15
+    
  16
+  end
  17
+  
  18
+  def article_object
  19
+    render :json => @articles[rand(@articles.length)]
  20
+  end
  21
+  
  22
+  def article_object_list
  23
+    render :json => @articles
  24
+  end
  25
+  
  26
+private
  27
+
  28
+  def find_article
  29
+		@articles = [
  30
+		  {
  31
+        :title => "Hello!",
  32
+        :content => "World!",
  33
+        :tags => [
  34
+          {:name => "tag 1"},
  35
+          {:name => "tag 2"},
  36
+          {:name => "tag 3"},
  37
+          {:name => "tag 4"}
  38
+        ]
  39
+      },
  40
+      {
  41
+        :title => "Hello 2!",
  42
+        :content => "World 2!",
  43
+        :tags => [
  44
+          {:name => "tag 5"},
  45
+          {:name => "tag 6"},
  46
+          {:name => "tag 7"},
  47
+          {:name => "tag 8"}
  48
+        ]
  49
+      },
  50
+      {
  51
+        :title => "Hello 3!",
  52
+        :content => "World 3!",
  53
+        :tags => [
  54
+          {:name => "tag 9"},
  55
+          {:name => "tag 10"},
  56
+          {:name => "tag 11"},
  57
+          {:name => "tag 12"}
  58
+        ]
  59
+      }
  60
+    ]
  61
+  end
  62
+end
  63
+
2  examples/rails3-example/app/helpers/application_helper.rb
... ...
@@ -0,0 +1,2 @@
  1
+module ApplicationHelper
  2
+end
2  examples/rails3-example/app/helpers/articles_helper.rb
... ...
@@ -0,0 +1,2 @@
  1
+module ArticlesHelper
  2
+end
11  examples/rails3-example/app/views/articles/article.html.ejs
... ...
@@ -0,0 +1,11 @@
  1
+<h2><%=item.title%></h2>
  2
+
  3
+<div class="content">
  4
+<%=item.content%>
  5
+</div>
  6
+
  7
+<ul class="tags">
  8
+	<%item.tags.forEach(function (tag) {%>
  9
+	<li><%=tag.name%></li>
  10
+	<%});%>
  11
+</ul>
35  examples/rails3-example/app/views/articles/show_client.html.erb
... ...
@@ -0,0 +1,35 @@
  1
+<style>
  2
+body { background-color:#eee; }
  3
+* { font-family: "Lucida Grande", Verdana, Arial, Helvetica, sans-serif; font-size:14px; }
  4
+.section-title { color:#39838A; font-size:20px; }
  5
+
  6
+.results {}
  7
+	.results h2 { font-size:16px; }
  8
+</style>
  9
+<script>
  10
+window.addEvent("domready",function () {
  11
+	new Request.JSON({
  12
+		url:"/articles/article_object",
  13
+		onSuccess:function (data) {
  14
+			$("single").set("html",Isotope($("article-template").get("text"),{ item:data }));
  15
+		},
  16
+	}).get();
  17
+
  18
+	new Request.JSON({
  19
+		url:"/articles/article_object_list",
  20
+		onSuccess:function (data) {
  21
+			$("list").set("html",Isotope($("article-template").get("text"), data));
  22
+		},
  23
+	}).get();
  24
+});
  25
+</script>
  26
+
  27
+<%=Isotope.render_template(Rails.root.join('app/views/articles/article.html.ejs'), :id => "article-template").html_safe%>
  28
+
  29
+<h2 class="section-title">Single Example</h2>
  30
+
  31
+<div id="single" class="results"></div>
  32
+
  33
+<h2 class="section-title">List Example</h2>
  34
+
  35
+<div id="list" class="results"></div>
4  examples/rails3-example/app/views/articles/show_server_template_in_view.html.erb
... ...
@@ -0,0 +1,4 @@
  1
+<h1>Articles</h1>
  2
+
  3
+
  4
+<%= Isotope.render_partial(Rails.root.join('app/views/articles/article.html.ejs'), :collection => @articles).html_safe %>
13  examples/rails3-example/app/views/layouts/application.html.erb
... ...
@@ -0,0 +1,13 @@
  1
+<!DOCTYPE html>
  2
+<html>
  3
+<head>
  4
+  	<title>Rails3Example</title>
  5
+	<script src="https://ajax.googleapis.com/ajax/libs/mootools/1.3.0/mootools-yui-compressed.js"></script>
  6
+	<script src="/javascripts/template.js"></script>
  7
+</head>
  8
+<body>
  9
+
  10
+<%= yield %>
  11
+
  12
+</body>
  13
+</html>
4  examples/rails3-example/config.ru
... ...
@@ -0,0 +1,4 @@
  1
+# This file is used by Rack-based servers to start the application.
  2
+
  3
+require ::File.expand_path('../config/environment',  __FILE__)
  4
+run Rails3Example::Application
42  examples/rails3-example/config/application.rb
... ...
@@ -0,0 +1,42 @@
  1
+require File.expand_path('../boot', __FILE__)
  2
+
  3
+require 'rails/all'
  4
+
  5
+# If you have a Gemfile, require the gems listed there, including any gems
  6
+# you've limited to :test, :development, or :production.
  7
+Bundler.require(:default, Rails.env) if defined?(Bundler)
  8
+
  9
+module Rails3Example
  10
+  class Application < Rails::Application
  11
+    # Settings in config/environments/* take precedence over those specified here.
  12
+    # Application configuration should go into files in config/initializers
  13
+    # -- all .rb files in that directory are automatically loaded.
  14
+
  15
+    # Custom directories with classes and modules you want to be autoloadable.
  16
+    # config.autoload_paths += %W(#{config.root}/extras)
  17
+
  18
+    # Only load the plugins named here, in the order given (default is alphabetical).
  19
+    # :all can be used as a placeholder for all plugins not explicitly named.
  20
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
  21
+
  22
+    # Activate observers that should always be running.
  23
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
  24
+
  25
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
  26
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
  27
+    # config.time_zone = 'Central Time (US & Canada)'
  28
+
  29
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
  30
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
  31
+    # config.i18n.default_locale = :de
  32
+
  33
+    # JavaScript files you want as :defaults (application.js is always included).
  34
+    # config.action_view.javascript_expansions[:defaults] = %w(jquery rails)
  35
+
  36
+    # Configure the default encoding used in templates for Ruby 1.9.
  37
+    config.encoding = "utf-8"
  38
+
  39
+    # Configure sensitive parameters which will be filtered from the log file.
  40
+    config.filter_parameters += [:password]
  41
+  end
  42
+end
13  examples/rails3-example/config/boot.rb
... ...
@@ -0,0 +1,13 @@
  1
+require 'rubygems'
  2
+
  3
+# Set up gems listed in the Gemfile.
  4
+gemfile = File.expand_path('../../Gemfile', __FILE__)
  5
+begin
  6
+  ENV['BUNDLE_GEMFILE'] = gemfile
  7
+  require 'bundler'
  8
+  Bundler.setup
  9
+rescue Bundler::GemNotFound => e
  10
+  STDERR.puts e.message
  11
+  STDERR.puts "Try running `bundle install`."
  12
+  exit!
  13
+end if File.exist?(gemfile)
22  examples/rails3-example/config/database.yml
... ...
@@ -0,0 +1,22 @@
  1
+# SQLite version 3.x
  2
+#   gem install sqlite3-ruby (not necessary on OS X Leopard)
  3
+development:
  4
+  adapter: sqlite3
  5
+  database: db/development.sqlite3
  6
+  pool: 5
  7
+  timeout: 5000
  8
+
  9
+# Warning: The database defined as "test" will be erased and
  10
+# re-generated from your development database when you run "rake".
  11
+# Do not set this db to the same as development or production.
  12
+test:
  13
+  adapter: sqlite3
  14
+  database: db/test.sqlite3
  15
+  pool: 5
  16
+  timeout: 5000
  17
+
  18
+production:
  19
+  adapter: sqlite3
  20
+  database: db/production.sqlite3
  21
+  pool: 5
  22
+  timeout: 5000
5  examples/rails3-example/config/environment.rb
... ...
@@ -0,0 +1,5 @@
  1
+# Load the rails application
  2
+require File.expand_path('../application', __FILE__)
  3
+
  4
+# Initialize the rails application
  5
+Rails3Example::Application.initialize!
26  examples/rails3-example/config/environments/development.rb
... ...
@@ -0,0 +1,26 @@
  1
+Rails3Example::Application.configure do
  2
+  # Settings specified here will take precedence over those in config/environment.rb
  3
+
  4
+  # In the development environment your application's code is reloaded on
  5
+  # every request.  This slows down response time but is perfect for development
  6
+  # since you don't have to restart the webserver when you make code changes.
  7
+  config.cache_classes = false
  8
+
  9
+  # Log error messages when you accidentally call methods on nil.
  10
+  config.whiny_nils = true
  11
+
  12
+  # Show full error reports and disable caching
  13
+  config.consider_all_requests_local       = true
  14
+  config.action_view.debug_rjs             = true
  15
+  config.action_controller.perform_caching = false
  16
+
  17
+  # Don't care if the mailer can't send
  18
+  config.action_mailer.raise_delivery_errors = false
  19
+
  20
+  # Print deprecation notices to the Rails logger
  21
+  config.active_support.deprecation = :log
  22
+
  23
+  # Only use best-standards-support built into browsers
  24
+  config.action_dispatch.best_standards_support = :builtin
  25
+end
  26
+
49  examples/rails3-example/config/environments/production.rb
... ...
@@ -0,0 +1,49 @@
  1
+Rails3Example::Application.configure do
  2
+  # Settings specified here will take precedence over those in config/environment.rb
  3
+
  4
+  # The production environment is meant for finished, "live" apps.
  5
+  # Code is not reloaded between requests
  6
+  config.cache_classes = true
  7
+
  8
+  # Full error reports are disabled and caching is turned on
  9
+  config.consider_all_requests_local       = false
  10
+  config.action_controller.perform_caching = true
  11
+
  12
+  # Specifies the header that your server uses for sending files
  13
+  config.action_dispatch.x_sendfile_header = "X-Sendfile"
  14
+
  15
+  # For nginx:
  16
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect'
  17
+
  18
+  # If you have no front-end server that supports something like X-Sendfile,
  19
+  # just comment this out and Rails will serve the files
  20
+
  21
+  # See everything in the log (default is :info)
  22
+  # config.log_level = :debug
  23
+
  24
+  # Use a different logger for distributed setups
  25
+  # config.logger = SyslogLogger.new
  26
+
  27
+  # Use a different cache store in production
  28
+  # config.cache_store = :mem_cache_store
  29
+
  30
+  # Disable Rails's static asset server
  31
+  # In production, Apache or nginx will already do this
  32
+  config.serve_static_assets = false
  33
+
  34
+  # Enable serving of images, stylesheets, and javascripts from an asset server
  35
+  # config.action_controller.asset_host = "http://assets.example.com"
  36
+
  37
+  # Disable delivery errors, bad email addresses will be ignored
  38
+  # config.action_mailer.raise_delivery_errors = false
  39
+
  40
+  # Enable threaded mode
  41
+  # config.threadsafe!
  42
+
  43
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
  44
+  # the I18n.default_locale when a translation can not be found)
  45
+  config.i18n.fallbacks = true
  46
+
  47
+  # Send deprecation notices to registered listeners
  48
+  config.active_support.deprecation = :notify
  49
+end
35  examples/rails3-example/config/environments/test.rb
... ...
@@ -0,0 +1,35 @@
  1
+Rails3Example::Application.configure do
  2
+  # Settings specified here will take precedence over those in config/environment.rb
  3
+
  4
+  # The test environment is used exclusively to run your application's
  5
+  # test suite.  You never need to work with it otherwise.  Remember that
  6
+  # your test database is "scratch space" for the test suite and is wiped
  7
+  # and recreated between test runs.  Don't rely on the data there!
  8
+  config.cache_classes = true
  9
+
  10
+  # Log error messages when you accidentally call methods on nil.
  11
+  config.whiny_nils = true
  12
+
  13
+  # Show full error reports and disable caching
  14
+  config.consider_all_requests_local       = true
  15
+  config.action_controller.perform_caching = false
  16
+
  17
+  # Raise exceptions instead of rendering exception templates
  18
+  config.action_dispatch.show_exceptions = false
  19
+
  20
+  # Disable request forgery protection in test environment
  21
+  config.action_controller.allow_forgery_protection    = false
  22
+
  23
+  # Tell Action Mailer not to deliver emails to the real world.
  24
+  # The :test delivery method accumulates sent emails in the
  25
+  # ActionMailer::Base.deliveries array.
  26
+  config.action_mailer.delivery_method = :test
  27
+
  28
+  # Use SQL instead of Active Record's schema dumper when creating the test database.
  29
+  # This is necessary if your schema can't be completely dumped by the schema dumper,
  30
+  # like if you have constraints or database-specific column types
  31
+  # config.active_record.schema_format = :sql
  32
+
  33
+  # Print deprecation notices to the stderr
  34
+  config.active_support.deprecation = :stderr
  35
+end
7  examples/rails3-example/config/initializers/backtrace_silencers.rb
... ...
@@ -0,0 +1,7 @@
  1
+# Be sure to restart your server when you modify this file.
  2
+
  3
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
  4
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
  5
+
  6
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
  7
+# Rails.backtrace_cleaner.remove_silencers!
10  examples/rails3-example/config/initializers/inflections.rb
... ...
@@ -0,0 +1,10 @@
  1
+# Be sure to restart your server when you modify this file.
  2
+
  3
+# Add new inflection rules using the following format
  4
+# (all these examples are active by default):
  5
+# ActiveSupport::Inflector.inflections do |inflect|
  6
+#   inflect.plural /^(ox)$/i, '\1en'
  7
+#   inflect.singular /^(ox)en/i, '\1'
  8
+#   inflect.irregular 'person', 'people'
  9
+#   inflect.uncountable %w( fish sheep )
  10
+# end
5  examples/rails3-example/config/initializers/mime_types.rb
... ...
@@ -0,0 +1,5 @@
  1
+# Be sure to restart your server when you modify this file.
  2
+
  3
+# Add new mime types for use in respond_to blocks:
  4
+# Mime::Type.register "text/richtext", :rtf
  5
+# Mime::Type.register_alias "text/html", :iphone
7  examples/rails3-example/config/initializers/secret_token.rb
... ...
@@ -0,0 +1,7 @@
  1
+# Be sure to restart your server when you modify this file.
  2
+
  3
+# Your secret key for verifying the integrity of signed cookies.
  4
+# If you change this key, all old signed cookies will become invalid!
  5
+# Make sure the secret is at least 30 characters and all random,
  6
+# no regular words or you'll be exposed to dictionary attacks.
  7
+Rails3Example::Application.config.secret_token = '694b3a4a6dbc5aa7fab31ccc4feda39b8d04dfd58f7e076d99dbd24373ec6074f0307110e5b82232bf071965ae936472196292a31653e480872a07c0061f001a'
8  examples/rails3-example/config/initializers/session_store.rb
... ...
@@ -0,0 +1,8 @@
  1
+# Be sure to restart your server when you modify this file.
  2
+
  3
+Rails3Example::Application.config.session_store :cookie_store, :key => '_rails3-example_session'
  4
+
  5
+# Use the database for sessions instead of the cookie-based default,
  6
+# which shouldn't be used to store highly confidential information
  7
+# (create the session table with "rake db:sessions:create")
  8
+# Rails3Example::Application.config.session_store :active_record_store
5  examples/rails3-example/config/locales/en.yml
... ...
@@ -0,0 +1,5 @@
  1
+# Sample localization file for English. Add more files in this directory for other locales.
  2
+# See http://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
  3
+
  4
+en:
  5
+  hello: "Hello world"
65  examples/rails3-example/config/routes.rb
... ...
@@ -0,0 +1,65 @@
  1
+Rails3Example::Application.routes.draw do
  2
+  get "articles/show_server_template_in_controller"
  3
+  get "articles/show_server_template_in_view"
  4
+
  5
+  get "articles/show_client"
  6
+  get "articles/article_object"
  7
+  get "articles/article_object_list"
  8
+
  9
+  # The priority is based upon order of creation:
  10
+  # first created -> highest priority.
  11
+
  12
+  # Sample of regular route:
  13
+  #   match 'products/:id' => 'catalog#view'
  14
+  # Keep in mind you can assign values other than :controller and :action
  15
+
  16
+  # Sample of named route:
  17
+  #   match 'products/:id/purchase' => 'catalog#purchase', :as => :purchase
  18
+  # This route can be invoked with purchase_url(:id => product.id)
  19
+
  20
+  # Sample resource route (maps HTTP verbs to controller actions automatically):
  21
+  #   resources :products
  22
+
  23
+  # Sample resource route with options:
  24
+  #   resources :products do
  25
+  #     member do
  26
+  #       get 'short'
  27
+  #       post 'toggle'