Commit a8d0681f95721e6bdbe71592e0fa1b5d534ce19a

Johan Sørensen
Sun Jan 13 13:36:27 CET 2008

Tree SHA1: 55da2ec
Parent SHA1: cc85057 (initial public import)
raw diff | raw patch

Added LICENSE and updated README

Diff rendering mode:
inline
side by side


		1	Copyright (c) 2007 Johan Sørensen
		2
		3	Permission is hereby granted, free of charge, to any person obtaining
		4	a copy of this software and associated documentation files (the
		5	"Software"), to deal in the Software without restriction, including
		6	without limitation the rights to use, copy, modify, merge, publish,
		7	distribute, sublicense, and/or sell copies of the Software, and to
		8	permit persons to whom the Software is furnished to do so, subject to
		9	the following conditions:
		10
		11	The above copyright notice and this permission notice shall be
		12	included in all copies or substantial portions of the Software.
		13
		14	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
		15	EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
		16	MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
		17	NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
		18	LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
		19	OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
		20	WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


1		== Welcome to Rails
	1	== Tumbline, the tumblelogging engine that wants to be
2	2
3		Rails is a web-application and persistence framework that includes everything
4		needed to create database-backed web-applications according to the
5		Model-View-Control pattern of separation. This pattern splits the view (also
6		called the presentation) into "dumb" templates that are primarily responsible
7		for inserting pre-built data in between HTML tags. The model contains the
8		"smart" domain objects (such as Account, Product, Person, Post) that holds all
9		the business logic and knows how to persist themselves to a database. The
10		controller handles the incoming requests (such as Save New Account, Update
11		Product, Show Post) by manipulating the model and directing data to the view.
	3	Tumbline is a tumblelogging engine I began to work on but never finished, and probably never will, so I'm releasing it so that maybe someone else will find it usefull.
12	4
13		In Rails, the model is handled by what's called an object-relational mapping
14		layer entitled Active Record. This layer allows you to present the data from
15		database rows as objects and embellish these data objects with business logic
16		methods. You can read more about Active Record in
17		link:files/vendor/rails/activerecord/README.html.
	5	It supports:
	6	* A polymorphic number of post-types (text,links,quotes,photos,chats so far)
	7	* Liquid templates for each tumblelog
	8	* multiple sites/tumblelogs
	9	* Handy bookmarklet
	10	* XML API
	11	* ... And a few other half-baked features
18	12
19		The controller and view are handled by the Action Pack, which handles both
20		layers by its two parts: Action View and Action Controller. These two layers
21		are bundled in a single package due to their heavy interdependence. This is
22		unlike the relationship between the Active Record and Action Pack that is much
23		more separate. Each of these packages can be used independently outside of
24		Rails. You can read more about Action Pack in
25		link:files/vendor/rails/actionpack/README.html.
	13	It doesn't have:
	14	* A good design
	15	* Optimized queries (refactoring of model relations is probably needed)
	16	* Complete UI
	17	* Complete setup of useful template tags/filters/methods
26	18
	19	=== Templates
27	20
28		== Getting Started
	21	A basic main layout template would look something like this:
29	22
30		1. At the command prompt, start a new Rails application using the <tt>rails</tt> command
31		and your application name. Ex: rails myapp
32		(If you've downloaded Rails in a complete tgz or zip, this step is already done)
33		2. Change directory into myapp and start the web server: <tt>script/server</tt> (run with --help for options)
34		3. Go to http://localhost:3000/ and get "Welcome aboard: You’re riding the Rails!"
35		4. Follow the guidelines to start developing your application
	23	<html>
	24	<head>
	25	<title>{{ tumblelog.title }}</title>
	26	</head>
	27	<body>
	28	{% for tumble in tumblelog.tumbles %}
	29	{{ tumble \| render }}
	30	{% endfor %}
	31	</body>
	32	</html>
36	33
	34	And some templates for the different post types (see the ./app/drops/* dir for other methods they support):
	35
	36	Text:
37	37
38		== Web Servers
	38	<div class="text">
	39	<h3>{{ post.title }}</h3>
	40	{{ post.body }}
	41	</div
	42
	43	Quote:
	44	<div class="quote>
	45	<blockquote>{{ quote.body }} </blockquote>
	46	</div>
	47
	48	Link:
	49	<div class="link>
	50	<a href="{{ link.url }}">{{ link.title }}</a>
	51	</div>
	52
	53	Chat:
	54	<div class="conversation">
	55	<h3>{{ conversation.title }}</h3>
	56	<ul>
	57	{% for line in conversation.lines %}
	58	<li><strong>{{ line.user }}:</strong> {{ line.uttering }}</li>
	59	{% endfor %}
	60	</ul>
	61	</div>
	62
	63	---
39	64
40		By default, Rails will try to use Mongrel and lighttpd if they are installed, otherwise
41		Rails will use WEBrick, the webserver that ships with Ruby. When you run script/server,
42		Rails will check if Mongrel exists, then lighttpd and finally fall back to WEBrick. This ensures
43		that you can always get up and running quickly.
	65	Since the app was initially built to run on the tumbline.com domain, you'll need a /etc/hosts entry for "www.tumbline.local" (and any subdomain.tumbline.lcoal you wish to see) mapped to 127.0.0.1.
44	66
45		Mongrel is a Ruby-based webserver with a C component (which requires compilation) that is
46		suitable for development and deployment of Rails applications. If you have Ruby Gems installed,
47		getting up and running with mongrel is as easy as: <tt>gem install mongrel</tt>.
48		More info at: http://mongrel.rubyforge.org
49
50		If Mongrel is not installed, Rails will look for lighttpd. It's considerably faster than
51		Mongrel and WEBrick and also suited for production use, but requires additional
52		installation and currently only works well on OS X/Unix (Windows users are encouraged
53		to start with Mongrel). We recommend version 1.4.11 and higher. You can download it from
54		http://www.lighttpd.net.
55
56		And finally, if neither Mongrel or lighttpd are installed, Rails will use the built-in Ruby
57		web server, WEBrick. WEBrick is a small Ruby web server suitable for development, but not
58		for production.
59
60		But of course its also possible to run Rails on any platform that supports FCGI.
61		Apache, LiteSpeed, IIS are just a few. For more information on FCGI,
62		please visit: http://wiki.rubyonrails.com/rails/pages/FastCGI
63
64
65		== Debugging Rails
66
67		Have "tail -f" commands running on the server.log and development.log. Rails will
68		automatically display debugging and runtime information to these files. Debugging
69		info will also be shown in the browser on requests from 127.0.0.1.
70
71
72		== Debugger
73
74		Debugger support is available through the debugger command when you start your Mongrel or
75		Webrick server with --debugger. This means that you can break out of execution at any point in the code, investigate
76		and change the model, AND then resume execution! Example:
77
78		class WeblogController < ActionController::Base
79		def index
80		@posts = Post.find(:all)
81		debugger
82		end
83		end
84
85		So the controller will accept the action, run the first line, then present you
86		with a IRB prompt in the server window. Here you can do things like:
87
88		>> @posts.inspect
89		=> "[#<Post:0x14a6be8 @attributes={\"title\"=>nil, \"body\"=>nil, \"id\"=>\"1\"}>,
90		#<Post:0x14a6620 @attributes={\"title\"=>\"Rails you know!\", \"body\"=>\"Only ten..\", \"id\"=>\"2\"}>]"
91		>> @posts.first.title = "hello from a debugger"
92		=> "hello from a debugger"
93
94		...and even better is that you can examine how your runtime objects actually work:
95
96		>> f = @posts.first
97		=> #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
98		>> f.
99		Display all 152 possibilities? (y or n)
100
101		Finally, when you're ready to resume execution, you enter "cont"
102
103
104		== Console
105
106		You can interact with the domain model by starting the console through <tt>script/console</tt>.
107		Here you'll have all parts of the application configured, just like it is when the
108		application is running. You can inspect domain models, change values, and save to the
109		database. Starting the script without arguments will launch it in the development environment.
110		Passing an argument will specify a different environment, like <tt>script/console production</tt>.
111
112		To reload your controllers and models after launching the console run <tt>reload!</tt>
113
114
115		== Description of Contents
116
117		app
118		Holds all the code that's specific to this particular application.
119
120		app/controllers
121		Holds controllers that should be named like weblogs_controller.rb for
122		automated URL mapping. All controllers should descend from ApplicationController
123		which itself descends from ActionController::Base.
124
125		app/models
126		Holds models that should be named like post.rb.
127		Most models will descend from ActiveRecord::Base.
128
129		app/views
130		Holds the template files for the view that should be named like
131		weblogs/index.erb for the WeblogsController#index action. All views use eRuby
132		syntax.
133
134		app/views/layouts
135		Holds the template files for layouts to be used with views. This models the common
136		header/footer method of wrapping views. In your views, define a layout using the
137		<tt>layout :default</tt> and create a file named default.erb. Inside default.erb,
138		call <% yield %> to render the view using this layout.
139
140		app/helpers
141		Holds view helpers that should be named like weblogs_helper.rb. These are generated
142		for you automatically when using script/generate for controllers. Helpers can be used to
143		wrap functionality for your views into methods.
144
145		config
146		Configuration files for the Rails environment, the routing map, the database, and other dependencies.
147
148		components
149		Self-contained mini-applications that can bundle together controllers, models, and views.
150
151		db
152		Contains the database schema in schema.rb. db/migrate contains all
153		the sequence of Migrations for your schema.
154
155		doc
156		This directory is where your application documentation will be stored when generated
157		using <tt>rake doc:app</tt>
158
159		lib
160		Application specific libraries. Basically, any kind of custom code that doesn't
161		belong under controllers, models, or helpers. This directory is in the load path.
162
163		public
164		The directory available for the web server. Contains subdirectories for images, stylesheets,
165		and javascripts. Also contains the dispatchers and the default HTML files. This should be
166		set as the DOCUMENT_ROOT of your web server.
167
168		script
169		Helper scripts for automation and generation.
170
171		test
172		Unit and functional tests along with fixtures. When using the script/generate scripts, template
173		test files will be generated for you and placed in this directory.
174
175		vendor
176		External libraries that the application depends on. Also includes the plugins subdirectory.
177		This directory is in the load path.
	67	http://www.tumbline.local:3000/account/new to create an account (check the log for the mail with the activation code in dev mode)
	68	http://www.tumbline.local:3000/tumble to login and tumble something
	69
	70	Enjoy, and let me know if you do anything useful with it!
	71	Johan Sørensen
	72	johan@johansorensen.com

Commit a8d0681f95721e6bdbe71592e0fa1b5d534ce19a

Gitorious