RubyGems - utopia - Versions diffs - 1.9.2 → 1.9.3 - Mend

utopia 1.9.2 → 1.9.3

Files changed (133) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7f08603b8fc77e5ffe85cf2f402be73c09502643
-  data.tar.gz: 81540559da3ee6823a0a3f1754c7446b28228b5a
+  metadata.gz: 1144177e365248c9b24dae032a7c40cb7d2d3397
+  data.tar.gz: 9255986187c7c87a7504e0c945fa258b82622dd0
 SHA512:
-  metadata.gz: caa96b4c7e561170b1bcfc4a1d783561d3e46b4e65f8c3ecadce76a3b43846f6d4fa2d26765d644aca197a77206b775ed30bed79f8e1c58bdc97459e90f815ce
-  data.tar.gz: 8e000468cebb8b29e356269e83e3dd6f79cfd7d64f41ad4155ca79943f1e74a28f8b2e3fb3bd1df0da9c7e64da8595f8795c7e1b38bd0c398406716311a67a91
+  metadata.gz: b57a7bec393a3980a1101e62508ce74e066bc2078df20f01084bcc2557615788e244827dd3d056feaf77624094a921e0b284eb7b0d5f02ed841a9d376e36fa0c
+  data.tar.gz: c4c81fa608bbbb2e487c2191d3bd03081f06b2bcebcbb28859d03b6fa7b0cc1e8e602f31575c23c00a447d32dc87d0ef37f09d016aa0e8de3decd0087f736339

data/documentation/.bowerrc CHANGED Viewed

@@ -1,4 +1,4 @@
 {
-  "directory" : "public/_static/components"
+  "directory": "lib/components",
+  "public": "public/_components"
 }

data/documentation/pages/_page.xnode CHANGED Viewed

@@ -14,6 +14,17 @@
 		<link rel="icon" type="image/png" href="/_static/icon.png" />
 		<link rel="stylesheet" href="/_static/site.css" type="text/css" media="screen" />
+		<script src="/_components/jquery/jquery.min.js"></script>
+		<script src="/_components/jquery-syntax/jquery.syntax.min.js"></script>
+		<script type="text/javascript">
+		//<![CDATA[
+			jQuery(function($) {
+				$.syntax();
+			});
+		//]]>
+		</script>
 	</head>
 	<body class="#{attributes[:class]}">

data/documentation/pages/wiki/controller/actions/content.md CHANGED Viewed

@@ -1,68 +1,76 @@
-# Controller::Actions
-Actions let you match path patterns in your controller and execute code. In your `controller.rb` simply add:
-	prepend Actions
-If you are adding multiple things, like rewriting, they should come earlier in the chain, e.g:
-	prepend Rewrite, Actions
-A simple CRUD controller might look like:
-	prepend Actions
-	on 'index' do
-		@users = User.all
-	end
-	on 'new' do |request|
-		@user = User.new
-		if request.post?
-			@user.update_attributes(request.params['user'])
-			redirect! "index"
-		end
-	end
-	on 'edit' do |request|
-		@user = User.find(request.params['id'])
-		if request.post?
-			@user.update_attributes(request.params['user'])
-			redirect! "index"
-		end
-	end
-	on 'delete' do |request|
-		User.find(request.params['id']).destroy
-		redirect! "index"
-	end
-## Path Matching
-Path matching works from right to left, and '**' is a greedy operator. Controllers are invoked with a path relative to the controller's `URI_PATH`, so all lookups are relative to the controller.
-<dl>
-	<dt>"*"</dt>
-	<dd>Match a single path element</dd>
-	<dt>"**"<dt>
-	<dd>Match all remaining path elements</dd>
-	<dt>String</dt>
-	<dd>Match a named path component</dd>
-	<dt>Symbol</dt>
-	<dd>Equivalent to ["**", symbol.to_s]</dd>
-</dl>
-## Otherwise Matching
-If no action was matched, it is sometimes useful to perform some specific behaviour. You can specify this by using the otherwise handler:
-	otherwise do |request, path|
-		fail! :teapot
-	end
-If you are doing this to perform some kind of rewriting, it may be preferable to use the [Rewrite](rewrite/) controller layer.
+# Controller::Actions
+Actions let you match path patterns in your controller and execute code. In your `controller.rb` simply add:
+```ruby
+prepend Actions
+```
+If you are adding multiple things, like rewriting, they should come earlier in the chain, e.g:
+```ruby
+prepend Rewrite, Actions
+```
+A simple CRUD controller might look like:
+```ruby
+prepend Actions
+on 'index' do
+	@users = User.all
+end
+on 'new' do |request|
+	@user = User.new
+	if request.post?
+		@user.update_attributes(request.params['user'])
+		redirect! "index"
+	end
+end
+on 'edit' do |request|
+	@user = User.find(request.params['id'])
+	if request.post?
+		@user.update_attributes(request.params['user'])
+		redirect! "index"
+	end
+end
+on 'delete' do |request|
+	User.find(request.params['id']).destroy
+	redirect! "index"
+end
+```
+## Path Matching
+Path matching works from right to left, and '**' is a greedy operator. Controllers are invoked with a path relative to the controller's `URI_PATH`, so all lookups are relative to the controller.
+<dl>
+	<dt><code class="language-ruby">"*"</code></dt>
+	<dd>Match a single path element</dd>
+	<dt><code class="language-ruby">"**"</code></dt>
+	<dd>Match all remaining path elements</dd>
+	<dt><code class="language-ruby">String</code></dt>
+	<dd>Match a named path component, e.g. <code class="language-ruby">"edit"</code>.</dd>
+	<dt><code class="language-ruby">Symbol</code></dt>
+	<dd>Equivalent to <code class="language-ruby">["**", symbol.to_s]</code>, e.g. <code class="language-ruby">:logout</code>.</dd>
+</dl>
+## Otherwise Matching
+If no action was matched, it is sometimes useful to perform some specific behaviour. You can specify this by using the otherwise handler:
+```ruby
+otherwise do |request, path|
+	fail! :teapot
+end
+```
+If you are doing this to perform some kind of rewriting, it may be preferable to use the [Rewrite](rewrite/) controller layer.

data/documentation/pages/wiki/controller/rewrite/content.md CHANGED Viewed

@@ -1,64 +1,69 @@
-# Controller::Rewrite
-The `Controller::Rewrite` layer can match and rewrite requests before they processed. This allows you to handle URLs like `/post/15/view` or `/blog/123-pictures-of-my-cat` easily. The basic rewrite operation is to extract some part of the path and optionally executes a block. That means that the path is modified before being passed on to the next layer in the controller, and controller instance variables may be set.
-## Regular Expressions
-In your `controller.rb`:
-	prepend Actions, Rewrite
-	rewrite.extract_prefix permalink: /(?<id>\d+)-(?<title>.*)/ do |request, path, match|
-		# The rewrite matched, but there was no valid post, so we fail:
-		fail! unless @post = Post.find(@permalink[:id])
-		# If the path matched, but there was no suffix, we make it default to the post action:
-		if match.post_match.empty?
-			match.post_match.components << "post"
-		end
-	end
-	on 'post' do
-		# You can do further processing here.
-		fail! unless @post.published?
-		@comments = @post.comments.first(5)
-	end
-	on 'edit' do
-		# You can do further processing here.
-		fail! unless @current_user&.editor?
-	end
-In your `post.xnode`, as an example:
-	<page>
-		<heading>Post #{attributes[:permalink][:id]} about #{attributes[:permalink][:title]}</heading>
-		<p>#{attributes[:post].content}</p>
-	</page>
-Keep in mind, that URLs like `/123-pictures-of-my-cat/edit` will work as expected, and hit the `edit` action of the controller.
-## Restful Resources
-Similar to the above, if we were solely interested in IDs, we could do the following:
-	prepend Actions, Rewrite
-	rewrite.extract_prefix post_id: Integer do |request, path, match|
-		# The rewrite matched, but there was no valid post, so we fail:
-		fail! unless @post = Post.find(@post_id)
-		# If the path matched, but there was no suffix, we make it default to the post action:
-		if match.post_match.empty?
-			match.post_match.components << "post"
-		end
-	end
-This will only match complete integers. Assuming this code is in `/blog/controller.rb`, it would match something like `/blog/123/view` and assign Integer("123") to `@post_id`.
-### Matching.. other things
-It's possible to match using `Integer`, `Float`, `String`, and you can provide your own class which will be instantiated. If it doesn't match, raise an exception and the rewrite rule will fail.
+# Controller::Rewrite
+The <code class="language-ruby">Controller::Rewrite</code> layer can match and rewrite requests before they processed. This allows you to handle URLs like `/post/15/view` or `/blog/123-pictures-of-my-cat` easily. The basic rewrite operation is to extract some part of the path and optionally executes a block. That means that the path is modified before being passed on to the next layer in the controller, and controller instance variables may be set.
+## Regular Expressions
+In your `controller.rb`:
+```ruby
+prepend Rewrite, Actions
+rewrite.extract_prefix permalink: /(?<id>\d+)-(?<title>.*)/ do |request, path, match|
+	# The rewrite matched, but there was no valid post, so we fail:
+	fail! unless @post = Post.find(@permalink[:id])
+	# If the path matched, but there was no suffix, we make it default to the post action:
+	if match.post_match.empty?
+		match.post_match.components << "post"
+	end
+end
+on 'post' do
+	# You can do further processing here.
+	fail! unless @post.published?
+	@comments = @post.comments.first(5)
+end
+on 'edit' do
+	# You can do further processing here.
+	fail! unless @current_user&.editor?
+end
+```
+In your `post.xnode`, as an example:
+```trenni
+<page>
+	<heading>Post #{attributes[:permalink][:id]} about #{attributes[:permalink][:title]}</heading>
+	<p>#{attributes[:post].content}</p>
+</page>
+```
+Keep in mind, that URLs like `/123-pictures-of-my-cat/edit` will work as expected, and hit the `edit` action of the controller.
+## Restful Resources
+Similar to the above, if we were solely interested in IDs, we could do the following:
+```ruby
+prepend Rewrite, Actions
+rewrite.extract_prefix post_id: Integer do |request, path, match|
+	# The rewrite matched, but there was no valid post, so we fail:
+	fail! unless @post = Post.find(@post_id)
+	# If the path matched, but there was no suffix, we make it default to the post action:
+	if match.post_match.empty?
+		match.post_match.components << "post"
+	end
+end
+```
+This will only match complete integers. Assuming this code is in `/blog/controller.rb`, it would match something like `/blog/123/view` and assign <code class="language-ruby">Integer("123")</code> to <code class="language-ruby">@post_id</code>.
+### Matching.. other things
+It's possible to match using <code class="language-ruby">Integer</code>, <code class="language-ruby">Float</code>, <code class="language-ruby">String</code>, and you can provide your own class which will be instantiated. If it doesn't match, raise an exception and the rewrite rule will fail.

data/documentation/pages/wiki/controller.rb CHANGED Viewed

@@ -26,7 +26,12 @@ end
 on '**/edit' do |request, path|
 	if request.post?
 		FileUtils.mkdir_p File.dirname(@page_file)
-		File.write(@page_file, request.params['content'])
+		# Get the content and normalize newlines:
+		content = request.params['content'].gsub /\r\n?/, "\n"
+		File.write(@page_file, content)
+		# Redirect relative to controller.
 		goto! @page_path
 	else
 		@content = read_contents

data/documentation/pages/wiki/development-environment-setup/content.md CHANGED Viewed

@@ -1,14 +1,16 @@
-# Development Environment Setup
-Utopia is built on Ruby and Rack. Therefore, Ruby (suggested 2.0+) should be installed and working. Then, simply run:
-	$ gem install utopia
-To install all required dependencies.
-Utopia and it's dependencies are built on Linux and Mac by default, and therefore compatibility with Windows is not guaranteed.
-## Atom Integration
-Utopia uses [Trenni](https://github.com/ioquatix/trenni) for templates and it has a syntax slightly different from ERB. However, there is a [package for Atom](https://atom.io/packages/language-trenni) which provides accurate syntax highlighting.
+# Development Environment Setup
+Utopia is built on Ruby and Rack. Therefore, Ruby (suggested 2.0+) should be installed and working. Then, simply run:
+```bash
+$ gem install utopia
+```
+To install all required dependencies.
+Utopia and it's dependencies are built on Linux and Mac by default, and therefore compatibility with Windows is not guaranteed.
+## Atom Integration
+Utopia uses [Trenni](https://github.com/ioquatix/trenni) for templates and it has a syntax slightly different from ERB. However, there is a [package for Atom](https://atom.io/packages/language-trenni) which provides accurate syntax highlighting.

data/documentation/pages/wiki/server-setup/content.md CHANGED Viewed

@@ -1,40 +1,46 @@
-# Server Setup
-The best deployment platform for Utopia is Linux. Specifically, [Arch Linux](https://www.archlinux.org/) with the following packages:
-- [nginx-mainline-passenger](https://aur.archlinux.org/packages/nginx-mainline-passenger/)
-- [passenger-nginx-module](https://aur.archlinux.org/packages/passenger-nginx-module/)
-There have been issues with the official packages and thus these packages were developed and tested with Utopia deployment in mind.
-## Sample Nginx Configuration
-Create a configuration file for your site, e.g. `/etc/nginx/sites/www.example.com`:
-	server {
-		listen 80;
-		server_name www.example.com;
-		root /srv/http/www.example.com/public;
-		passenger_enabled on;
-	}
-	server {
-		listen 80;
-		server_name example.com;
-		rewrite ^ http://www.example.com$uri permanent;
-	}
-## Deployment via Git
-The preferred method of deployment to a production server is via git. The `utopia` command assists with setup of a remote git repository on the server. It will setup a `git` `post-update` hook which will deploy the site correctly and restart passenger for that site.
-To setup a server for deployment:
-	$ mkdir /srv/http/www.example.com
-	$ cd /srv/http/www.example.com
-	$ sudo -u http utopia server create
-On your development machine, you should setup the git remote:
-	$ git remote add production ssh://remote/srv/http/www.example.com
-	$ git push --set-upstream production master
+# Server Setup
+The best deployment platform for Utopia is Linux. Specifically, [Arch Linux](https://www.archlinux.org/) with the following packages:
+- [nginx-mainline-passenger](https://aur.archlinux.org/packages/nginx-mainline-passenger/)
+- [passenger-nginx-module](https://aur.archlinux.org/packages/passenger-nginx-module/)
+There have been issues with the official packages and thus these packages were developed and tested with Utopia deployment in mind.
+## Sample Nginx Configuration
+Create a configuration file for your site, e.g. `/etc/nginx/sites/www.example.com`:
+```nginx
+server {
+	listen 80;
+	server_name www.example.com;
+	root /srv/http/www.example.com/public;
+	passenger_enabled on;
+}
+server {
+	listen 80;
+	server_name example.com;
+	rewrite ^ http://www.example.com$uri permanent;
+}
+```
+## Deployment via Git
+The preferred method of deployment to a production server is via git. The `utopia` command assists with setup of a remote git repository on the server. It will setup a `git` `post-update` hook which will deploy the site correctly and restart passenger for that site.
+To setup a server for deployment:
+```bash
+$ mkdir /srv/http/www.example.com
+$ cd /srv/http/www.example.com
+$ sudo -u http utopia server create
+```
+On your development machine, you should setup the git remote:
+```bash
+$ git remote add production ssh://remote/srv/http/www.example.com
+$ git push --set-upstream production master
+```

data/documentation/pages/wiki/show.xnode CHANGED Viewed

@@ -3,7 +3,7 @@
 	#{partial 'navigation', path: attributes[:full_path].dirname}
-	#{MarkupString.raw Kramdown::Document.new(self[:content]).to_html}
+	#{MarkupString.raw Kramdown::Document.new(self[:content], input: 'GFM', syntax_highlighter: nil).to_html}
 	<footer>
 		Last Modified: #{File.mtime(self[:page_file]) rescue "N/A"} &mdash;

data/documentation/pages/wiki/your-first-page/content.md CHANGED Viewed

@@ -1,31 +1,36 @@
-# Your First Page
-To setup the default site, simply create a directory and use the `utopia` command:
-	$ mkdir www.example.com
-	$ cd www.example.com
-	$ utopia site create
-	$ rake server
-You will now have a basic template site running on http://localhost:9292.
-## Welcome Page
-Utopia includes a redirection middleware to redirect all root-level requests to a given URI. The default being `/welcome/index`:
-	use Utopia::Redirection::Rewrite,
-		'/' => '/welcome/index'
-This page includes a basic overview of Utopia. Most of it's standard HTML, except for the outer `<page>` tag. Utopia uses the name `page` to lookup the file-system hierarchy. First, it looks for `/welcome/_page.xnode`, and then it looks for `/_page.xnode` which it finds. This page template includes a tag `<content/>` which is replaced with the inner body of the `<page>` tag. This recursive lookup is the heart of Utopia.
-## Links
-Utopia is a content-centric web application platform. It leverages the file-system to provide a mapping between logical resources and files on disk. The primary mode of mapping incoming requests to specific nodes (content) is done using the `links.yaml` file.
-The links file associates metadata with node names for a given directory. This can include things like redirects, titles, descriptions, etc. You can add any metadata you like, to support your specific use-case. The primary use of the links files is to provide site structure, e.g. menus. In addition, they can function as a rudimentary data-store for static information, e.g. a list of applications (each with it's own page), a list of features, etc.
-You'll notice that there is a file `/links.yaml`. This file contains important metadata relating to the `errors` subdirectory. As we don't want these nodes showing up in a top level menu, we mark them as `display: false`
-	errors:
-	    display: false
+# Your First Page
+To setup the default site, simply create a directory and use the `utopia` command:
+```bash
+$ mkdir www.example.com
+$ cd www.example.com
+$ utopia site create
+$ rake server
+```
+You will now have a basic template site running on http://localhost:9292.
+## Welcome Page
+Utopia includes a redirection middleware to redirect all root-level requests to a given URI. The default being `/welcome/index`:
+```ruby
+use Utopia::Redirection::Rewrite,
+	'/' => '/welcome/index'
+```
+This page includes a basic overview of Utopia. Most of it's standard HTML, except for the outer `<page>` tag. Utopia uses the name `page` to lookup the file-system hierarchy. First, it looks for `/welcome/_page.xnode`, and then it looks for `/_page.xnode` which it finds. This page template includes a tag `<content/>` which is replaced with the inner body of the `<page>` tag. This recursive lookup is the heart of Utopia.
+## Links
+Utopia is a content-centric web application platform. It leverages the file-system to provide a mapping between logical resources and files on disk. The primary mode of mapping incoming requests to specific nodes (content) is done using the `links.yaml` file.
+The links file associates metadata with node names for a given directory. This can include things like redirects, titles, descriptions, etc. You can add any metadata you like, to support your specific use-case. The primary use of the links files is to provide site structure, e.g. menus. In addition, they can function as a rudimentary data-store for static information, e.g. a list of applications (each with it's own page), a list of features, etc.
+You'll notice that there is a file `/links.yaml`. This file contains important metadata relating to the `errors` subdirectory. As we don't want these nodes showing up in a top level menu, we mark them as `display: false`
+```yaml
+errors:
+    display: false
+```