Foodsoft/foodsoft
1
1
Fork 0
Code Issues 36 Pull requests 5 Projects 1 Releases Wiki Activity

Try to fix markdown formating issue in publish_subscribe.md

Browse source
This commit is contained in:
Julius 2013-12-07 17:14:30 +01:00
parent cdb87a8389
commit 0f141cb709
1 changed files with 5 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
doc/design_patterns/publish_subscribe.md
View file

@ -9,12 +9,15 @@ The process can be divided in two steps: **1.** AJAX database manipulation and *
1. Example: current view `deliveries/_form` offers a link for the AJAX action `StockArticle#new`. This opens a modal filled with `stock_articles/_form`. 1. Example: current view `deliveries/_form` offers a link for the AJAX action `StockArticle#new`. This opens a modal filled with `stock_articles/_form`.
2. AJAX form post addresses the `StockArticle#create` action which handles the database manipulation. 2. AJAX form post addresses the `StockArticle#create` action which handles the database manipulation.
3. The database manipulation is finished by the rendering of, e.g., `stock_articles/create.js.erb`. The key task there is to **publish** the database changes by calling `trigger`, i.e., 3. The database manipulation is finished by the rendering of, e.g., `stock_articles/create.js.erb`. The key task there is to **publish** the database changes by calling `trigger`, i.e.,
$(document).trigger({ $(document).trigger({
type: 'StockArticle#create', type: 'StockArticle#create',
stock_article_id: <%= @stock_article.id %> stock_article_id: <%= @stock_article.id %>
}); });
2. DOM updates for the particular view 2. DOM updates for the particular view
1. Each view has the opportunity to **subscribe** to particular events of the previous step. A very simple example is the update of the `stock_articles/index` view after `StockArticle#destroy`: 1. Each view has the opportunity to **subscribe** to particular events of the previous step. A very simple example is the update of the `stock_articles/index` view after `StockArticle#destroy`:
$(document).on('StockArticle#destroy', function(e) { $(document).on('StockArticle#destroy', function(e) {
$('#stockArticle-' + e.stock_article_id).remove(); $('#stockArticle-' + e.stock_article_id).remove();
}); });
@ -22,6 +25,7 @@ The process can be divided in two steps: **1.** AJAX database manipulation and *
However, in most of the situations you will like to use the full power of the MVC framework in order to read new data from the database and render some partial. Let us consider this slightly more advanced case in the following. However, in most of the situations you will like to use the full power of the MVC framework in order to read new data from the database and render some partial. Let us consider this slightly more advanced case in the following.
The view `stock_articles/index` could listen (amongst others) to `StockArticle#create` like this: The view `stock_articles/index` could listen (amongst others) to `StockArticle#create` like this:
$(document).on('StockArticle#create', function(e) { $(document).on('StockArticle#create', function(e) {
$.ajax({ $.ajax({
url: '#{index_on_stock_article_create_stock_articles_path}', url: '#{index_on_stock_article_create_stock_articles_path}',
@ -30,4 +34,5 @@ The process can be divided in two steps: **1.** AJAX database manipulation and *
contentType: 'application/json; charset=UTF-8' contentType: 'application/json; charset=UTF-8'
}); });
}); });
2. The action `StockArticles#index_on_stock_article_create` is a special helper action to handle DOM updates of the `stock_articles/index` view after the creation of a new `StockArticle` with the given `id`. 2. The action `StockArticles#index_on_stock_article_create` is a special helper action to handle DOM updates of the `stock_articles/index` view after the creation of a new `StockArticle` with the given `id`.