transponder 0.9.5 → 0.9.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0c4b109329b9539fda9e7827ec7474cbfe815c68
-  data.tar.gz: 2090f8944db3ff86c63e4c97f626a32f6b262b4d
+  metadata.gz: 6feff04c3e1786bc152beb0e5750d59c2979bf45
+  data.tar.gz: 992b7431c2c704371e50ff763047354b12293a97
 SHA512:
-  metadata.gz: 50a1eaad9dc8e5d3a92bacb0bdd121422bc7cb2ed1a358a1fdbc9a06320afc11eff27a01f001d0e1ec2509b457c030f3810848946cf11608c917fe8ffc36e748
-  data.tar.gz: da4873b9083aeb6c1a1a33612bb24df26a5542209944b9ac9abfbae969387973d10669e74defc3647c41020deaade69bf5b42fb43dac6782a153f328688e4406
+  metadata.gz: dd203125d52101183f4fcf6edac72fe46c40e64510be5a1fddbdbf2d9e8dba2e601282a305a2378bde6cbed06954a089197eb110beb55d96e120bbc76033504f
+  data.tar.gz: 3ab315529d479230a206e4c9bce68b548fe059e5da9340f6b355e8b8edead1a8169188732518fb964b79a2cfe13496f7638a3dfba5a9c25626243c7d1aebf5fd

data/README.md

@@ -1,11 +1,13 @@
 # Transponder
-[![Build Status](https://travis-ci.org/artellectual/transponder.png?branch=master)](https://travis-ci.org/artellectual/transponder) - Master (current release)
+[![Build Status](https://travis-ci.org/xpdr/transponder.png?branch=master)](https://travis-ci.org/artellectual/transponder) - Master (current release)
 
-[![Build Status](https://travis-ci.org/artellectual/transponder.png?branch=develop)](https://travis-ci.org/artellectual/transponder) - Develop (upcoming release)
+[![Build Status](https://travis-ci.org/xpdr/transponder.png?branch=develop)](https://travis-ci.org/artellectual/transponder) - Develop (upcoming release)
 
-Transponder is a opinionated javascript library for assisting in working with front end heavy rails app.
+![Transponder Banner](http://transponder.s3-ap-northeast-1.amazonaws.com/transponder-banner.png)
 
-Transponder uncompressed is about 8kb uncompressed / 2kb minified & compressed (gzip) 
+Transponder is a opinionated library for assisting in working with front end heavy rails app.
+
+8kb uncompressed / 2kb minified & compressed (gzip) (client side library)
 
 ## Installation
 
@@ -21,65 +23,95 @@ Or install it yourself as:
 
     $ gem install transponder
 
-## Usage
-There are 3 types of transponder module, minimal, basic, full by using the ```-t``` flag you can specify which type you want to use. If you don't specify a ```-t``` flag it will generate a basic module.
 
-### Minimal
-Minimal transponder modules are good for generating modules that will contain only services that will be used by other modules. Generally recommended to use in combination with the ```--shared``` flag
+## Generate a basic Module 
+
+A transponder module provides some basic structure for your javascript code
+```
+rails g transponder:install application
+```
+This will generate a transponder 'module' in your ```app/assets/javascripts``` folder by the name of 'application', you can change the ```application``` to something else, but we recommend sticking with defaults until you understand more about transponder.
+
+## Generate a Presenter
+
+Presenters is perhaps one of the most important thing about Transponder, it allows you to use your server side templates in your client side code, cleanly and allows better reuseability of code.
+
+```
+rails g transponder:presenter contacts
+```
+
+Running this command will generate a presenter in your Transponder module ```application/presenters``` with the name ```contacts_presenter.coffee```
+
 
-    $ rails g transponder:install utilities -t minimal --shared
+## How is this better than Rails UJS?
 
-### Basic
-Basic transponder modules come with 3 basic things, helpers, services, and presenters. If you want to work with rails controller you will need to use the basic module type.
+Typically with Rails UJS you would create a view with something like this 
 
-    $ rails g transponder:install application
+Lets say you have a basic contacts_controller.rb
 
-### Full
-Full transponder modules come with transponder's primitives and placeholders for a backbone app, it will setup the integration for a backbone app into your transponder module.
+```ruby
+class ContactsController < ApplicationController
+  respond_to :json, :html, :js
 
-    $ rails g transponder:install application -t full
+  def index
+    @contacts = Contact.all
+    respond_with @contacts
+  end
+end
+```
 
-## Primitives
+In your ```index.js.erb``` you would then have something like this 
 
-### Presenters
-Presenter's jobs are to take the response from the server usually html fragment that is rendered by rails and output it to the screen. The reason why we have presenters is so that we can do things to the content before outputting it.
+```js
+$('#contacts').html("<%= j render @contacts %>");
+```
 
-Presenters usually map to your controller action in rails. By default it supports the 7 basic restful actions 
+This Javascript code is evaled in the browser and content of the node with the id ```#contacts``` gets replaced with server side template that came from ```<%= j render @contacts %>``` This is fine however it has a few problems. First of all if you use coffeescript it has to be compiled in real time as its responding which adds to your response time. Secondly if you want to do more complex things in your response things can get very messy. Code reuse isn't that great either.
 
-+ index
-+ new
-+ edit
-+ show
-+ create
-+ update
-+ destroy
+With Transponder you have a consistent way of working with your server side template. Lets take a look at the difference
 
-However you can override this and add your own custom presenter actions if you want. Its not necessary that the presenter action maps to your rails controller action.
+In your ```index.js.erb``` transponder version would look something like this.
 
-#### Presenter in Action
+```js
+["#contacts", "<%= xms_event %>", "<%= j render @contacts %>"]
+```
 
+Your server side response code using transponder will mostly likely look something like this. There is consistency to it. The first element is the DOM node you want to manipulate, the second element is what will allow the client side Transponder code to know which Presenter is responsible for this response and lastly we have the server side generated content.
 
-### Services
-Services are things that apply to alot of items on the page. You could think of these parts of the page as 'widget' and they all have a certain kind of behavior. The behavior of these widgets can be defined by services. Each widget can have the behavior of multiple services.
+### So what happens once this response gets to the client
 
-Some example of services
+Well in our presenter we would do something like this 
 
-+ File uploader
-+ Poller
-+ Push notification subscriber
-+ Syntax Highlighter
-+ Search Bar
+```coffee
+class Application.Presenters.ContactsPresenter extends Transponder.Presenter
+  presenterName: 'contacts'
+  module: 'application'
 
-Services are very modular and they can be applied to multiple widgets in a page without conflicting with each other and without rebinding widgets that already have these behaviors.
+  index: ->
+    $(@element).html(@response)
+    # ... do more stuff ...
+```
 
+The first 3 lines of code are generated by the presenter generator you were just using before the only line of code you should pay attention to here is the last 2. Basically the ```@element``` is the dom element you specified in ```index.js.erb``` and the ```@response``` is the content that was rendered by the server.
+
+In the presenter you can do pretty much anything you want to your response before it gets output to the DOM. This gives a nice structure and consistency to the whole pattern. It allows you to mix server side templates with full client side programmability.
+
+Testing is also much easier as now you've shifted the responsibility of the client side behavior to the client. We have more documentation coming on how to test your presenters.
+
+## Example App
+
+Here is a link to a more typical example with a controller / presenter that is more fleshed out. [Presenters: Typical Example](https://github.com/xpdr/transponder/wiki/Presenters:-Typical-Example). The code in the link is the controller / presenter code for this app here 
++ [kontax on heroku](http://kontax.herokuapp.com)
++ [kontax on github](http://github.com/xpdr/kontax)
+
+Kontax is an example app for showcasing what Transponder is capable of doing. The larger and more complex an app becomes the more transponder shines. Especially if you want to build apps that need real time stuff.
 
 ## TODO - Whats Coming
 
-  + Clean up some APIs
   + Add Documentation
   + Video Screencasts
-  + More Generators
-  + Example Rails Project
+  + Add more features to Kontax
+  + More documentation on Services
 
 ## Contributing
 
@@ -90,5 +122,4 @@ Services are very modular and they can be applied to multiple widgets in a page
 5. Create new Pull Request
 
 ## Credits
-Gem developed by [Zack Siri](http://github.com/zacksiri) of [Artellectual](http://www.artellectual.com)
-
+Gem developed by [Zack Siri](http://github.com/zacksiri) of [Artellectual](http://www.artellectual.com)

data/lib/assets/javascripts/transponder/response.coffee

@@ -2,7 +2,7 @@ class Transponder.Response
   payload: {}
 
   constructor: ->
-    $(document).on 'ajax:complete', (event, xhr, status) =>
+    $(document).ajaxComplete (event, xhr, status) =>
       if xhr.getResponseHeader('Content-Type') is 'application/transmission'
         @payload.raw = JSON.parse(@cleanContent(xhr.responseText))
         element    = @payload.raw[0]

data/lib/generators/transponder/service/service_generator.rb

@@ -25,7 +25,7 @@ module Transponder
       def add_service_to_manifest
         manifest_file = File.join(javascripts_path, options[:module_name], 'initializers/manifest.coffee')
         insert_into_file manifest_file, 
-                         "  $(body).trigger '#{options[:module_name].downcase}:services:#{file_name.downcase}'\n",
+                         "  $('body').trigger '#{options[:module_name].downcase}:services:#{file_name.downcase}'\n",
                          after: "#{options[:module_name].camelize}.services_manifest = ->\n"
       end
     end

data/lib/transponder/version.rb

@@ -1,3 +1,3 @@
 module Transponder
-  VERSION = "0.9.5"
+  VERSION = "0.9.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: transponder
 version: !ruby/object:Gem::Version
-  version: 0.9.5
+  version: 0.9.6
 platform: ruby
 authors:
 - Zack Siri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-04 00:00:00.000000000 Z
+date: 2013-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coffee-rails