transponder 0.1.5 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 711ecb27b05b853ceda3452d010e696f41617f25
-  data.tar.gz: 70faafa2005ea3883d93bf765ff54090f3df2d5e
+  metadata.gz: 1b6ecc211a87d26097124c4deb9fca3a54b9802d
+  data.tar.gz: c1310ab65def550c21d6346ab4f1537f1c713495
 SHA512:
-  metadata.gz: eee0d887256fd0b760c58f7ee8f7730a6b963f28227da179215167c3909736fa5c80dbf4e16ff4e1dff72fd529fa5eb6def551a01f9ab271875a71b16c7e79ba
-  data.tar.gz: d709d17bdc3598938a15e8edb6404949859454ea1616095b5d6558bf267c72df976a535c688dfc09b7ce3d31f3917eef77dcb090576e6cdba017bcccd1c10258
+  metadata.gz: 7e1127e6d84815975c27ca5eb1d116862cc1febeba5d9d05e01d753b8e849c82e006f1f65311e99b3db4a2306b4a1d84edad7152da840518039a6265fd6f2ea0
+  data.tar.gz: f89992d48a3389476f527e7a3672d991d85655729e04fd79383ae90d15e6227bdd9f604fc2aded16241ca59872b3967fadac90c6db58938dfc6e0f9fd3adf6d9

data/README.md

@@ -1,6 +1,7 @@
 # Transponder
-[![Build Status](https://www.travis-ci.org/zacksiri/transponder.png?branch=master)](https://www.travis-ci.org/zacksiri/transponder) - Master (current release)
-[![Build Status](https://www.travis-ci.org/zacksiri/transponder.png?branch=develop)](https://www.travis-ci.org/zacksiri/transponder) - Develop (next release)
+[![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/artellectual/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.
 
@@ -19,13 +20,53 @@ 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
+
+    $ rails g transponder:install utilities -t minimal --shared
+
+### 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.
+
+    $ rails g transponder:install application
+
+### 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.
+
+    $ rails g transponder:install application -t full
+
+## Primitives
+
+### 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.
+
+Presenters usually map to your controller action in rails. By default it supports the 7 basic restful actions 
+
++ index
++ new
++ edit
++ show
++ create
++ update
++ destroy
+
+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.
+
+### 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.
+
+Some example of services
 
-Once installing the gem run.
++ File uploader
++ Poller
++ Push notification subscriber
++ Syntax Highlighter
++ Search Bar
 
-    $ rails g transponder:install
+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.
 
-## Documentation
-  + [Slides](http://www.slideshare.net/artellectual/better-ujsforrails)
 
 ## TODO - Whats Coming
 

data/lib/assets/javascripts/transponder.coffee

@@ -1,6 +1,7 @@
 #= require transponder/setup
 #= require transponder/error
 #= require transponder/request
+#= require transponder/response
 #= require transponder/presenter
 #= require transponder/service
 #= require transponder/init

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

@@ -8,7 +8,7 @@ class Transponder.Error
   handleError: (event, xhr, settings, error) ->
     unless xhr.responseText is ""
       @response = JSON.parse(xhr.responseText) 
-      eventType = Transponder.buildEvent ['ujs', @response.namespace, @response.controller, @response.action]
+      eventType = Transponder.buildEvent ['ujs', @response.module, @response.controller, @response.action]
       $(document).trigger(eventType, @response)
 
 class Transponder.InvalidService

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

@@ -3,7 +3,7 @@ class Transponder.Presenter
   params: {}
 
   presenterName: null
-  nameSpace: null
+  module: null
   modelName: null
 
   element: null
@@ -11,13 +11,13 @@ class Transponder.Presenter
 
   constructor: (options = {}) ->
     options.presenterName = @presenterName  unless options.presenterName
-    options.nameSpace =     @nameSpace      unless options.nameSpace
+    options.module =        @module         unless options.module
     options.actions =       @actions        unless options.actions
 
     doc = $(document)
     events = []
     for action in options.actions
-      events.push(Transponder.buildEvent(['ujs', options.nameSpace, options.presenterName, action]))
+      events.push(Transponder.buildEvent(['ujs', options.module, options.presenterName, action]))
     doc.on(events.join(' '), @runAction)
 
   elify: (event, response) ->
@@ -45,8 +45,12 @@ class Transponder.Presenter
   triggerEmpty: (eventName) ->
     console.log "#{eventName} triggered! Override this action in your own presenter"
 
+  triggerEmptyError: (eventName) ->
+    console.log "Error #{eventName} triggered! Override this action in your own presenter"
+
   errorOut: ->
-    console.log "an error has occured!"
+    for key, value of @response.errors
+      @error[key](value)
 
   index: ->
     @triggerEmpty('Index')
@@ -61,4 +65,20 @@ class Transponder.Presenter
   create: ->
     @triggerEmpty('Create')
   destroy: ->
-    @triggerEmpty('Destroy')
+    @triggerEmpty('Destroy')
+
+  error:
+    index: ->
+      @triggerEmptyError('Index')
+    show: ->
+      @triggerEmptyError('Show')
+    new: ->
+      @triggerEmptyError('New')
+    edit: ->
+      @triggerEmptyError('Edit')
+    update: ->
+      @triggerEmptyError('Update')
+    create: ->
+      @triggerEmptyError('Create')
+    destroy: ->
+      @triggerEmptyError('Destroy')

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

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

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

@@ -5,4 +5,5 @@ window.Transponder =
 
   init: ->
     Transponder.eh = new Transponder.Error()
-    Transponder.req = new Transponder.Request()
+    Transponder.req = new Transponder.Request()
+    Transponder.res = new Transponder.Response()

data/lib/generators/transponder.rb

@@ -1,8 +1,9 @@
-require 'rails/generators/base'
+require 'rails/generators'
+require 'rails/generators/named_base'
 
 module Transponder
   module Generators
-    class Base < Rails::Generators::Base
+    class Base < Rails::Generators::NamedBase
       def self.source_root
         @_transponder_source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'transponder', generator_name, 'templates'))
       end

data/lib/generators/transponder/install/install_generator.rb

@@ -1,33 +1,29 @@
 require 'generators/transponder'
-require 'generators/transponder/resource_helpers'
 
 module Transponder
   module Generators
     class InstallGenerator < Base
-      include Transponder::Generators::ResourceHelpers
-
-      def create_services
-        directory 'services',     'app/assets/javascripts/services'
+      class_option :type,   type: :string, default: 'basic', desc: "type of app to generate", aliases: "-t"
+      class_option :shared, type: :boolean, default: false
+ 
+      def create_module
+        directory "#{options[:type]}",     "app/assets/javascripts/#{file_name}"
       end
 
-      def create_presenters
-        directory 'presenters',   'app/assets/javascripts/presenters'
+      def add_setup
+        template "#{options[:type]}_setup.coffee", "app/assets/javascripts/#{file_name}/initializers/setup.coffee"
       end
 
-      def create_helpers
-        directory 'helpers',      'app/assets/javascripts/helpers'
+      def add_manifest
+        template "manifest.coffee", "app/assets/javascripts/#{file_name}/initializers/manifest.coffee" unless options[:shared]
       end
 
-      def create_initializers
-        directory 'initializers', 'app/assets/javascripts/initializers'
+      def add_shared
+        template "#{options[:type]}_shared.coffee", "app/assets/javascripts/#{file_name}/#{file_name}.coffee" if options[:shared]
       end
 
-      def add_setup
-        template 'setup.coffee',    'app/assets/javascripts/initializers/setup.coffee'
-      end 
-
-      def add_manifest
-        template 'manifest.coffee', 'app/assets/javascripts/initializers/manifest.coffee'
+      def add_module_file
+        template "#{options[:type]}.coffee", "app/assets/javascripts/#{file_name}.coffee" unless options[:shared]
       end
     end
   end

data/lib/generators/transponder/install/templates/basic.coffee

@@ -0,0 +1,13 @@
+# this is where you require all the files
+#= require jquery
+#= require jquery_ujs
+#= require turbolinks
+#= require transponder
+
+# this part boots up the transponder app
+#= require <%= file_name %>/initializers/setup
+#= require_tree ./<%= file_name %>/services
+#= require_tree ./<%= file_name %>/helpers
+#= require_tree ./<%= file_name %>/presenters
+#= require <%= file_name %>/initializers/boot
+#= require <%= file_name %>/initializers/manifest

data/lib/generators/transponder/install/templates/basic/initializers/boot.coffee

@@ -0,0 +1,6 @@
+# this file will boot up your transponder app
+
+# presenters
+
+
+# services

data/lib/generators/transponder/install/templates/basic_setup.coffee

@@ -0,0 +1,4 @@
+window.<%= file_name.camelize %> =
+  Helpers: {}
+  Services: {}
+  Presenters: {}

data/lib/generators/transponder/install/templates/basic_shared.coffee

@@ -0,0 +1,6 @@
+#= require initializers/setup
+#= require_tree ./services
+#= require_tree ./helpers
+#= require_tree ./presenters
+#= require initializers/boot
+#= require initializers/manifest 

data/lib/generators/transponder/install/templates/full.coffee

@@ -0,0 +1,17 @@
+# this is where you require all the files
+#= require jquery
+#= require jquery_ujs
+#= require turbolinks
+#= require transponder
+
+# this part boots up the transponder app
+#= require <%= file_name %>/initializers/setup
+#= require_tree ./<%= file_name %>/templates
+#= require_tree ./<%= file_name %>/models
+#= require_tree ./<%= file_name %>/collections
+#= require_tree ./<%= file_name %>/views
+#= require_tree ./<%= file_name %>/services
+#= require_tree ./<%= file_name %>/helpers
+#= require_tree ./<%= file_name %>/presenters
+#= require <%= file_name %>/initializers/boot
+#= require <%= file_name %>/initializers/manifest

data/lib/generators/transponder/install/templates/full/initializers/boot.coffee

@@ -0,0 +1,6 @@
+# this file will boot up your transponder app
+
+# presenters
+
+
+# services

data/lib/generators/transponder/install/templates/full_setup.coffee

@@ -0,0 +1,7 @@
+window.<%= file_name.camelize %> =
+  Models: {}
+  Collections: {}
+  Views: {}
+  Helpers: {}
+  Services: {}
+  Presenters: {}

data/lib/generators/transponder/install/templates/full_shared.coffee

@@ -0,0 +1,10 @@
+#= require initializers/setup
+#= require_tree ./templates
+#= require_tree ./models
+#= require_tree ./collections
+#= require_tree ./views
+#= require_tree ./services
+#= require_tree ./helpers
+#= require_tree ./presenters
+#= require initializers/boot
+#= require initializers/manifest 

data/lib/generators/transponder/install/templates/manifest.coffee

@@ -1,8 +1,8 @@
-Transponder.services_manifest = ->
+<%= file_name.camelize %>.services_manifest = ->
   # fill in your manifest here
   # example:
   # if you want to trigger a service on your entire app
-  # $('body').trigger 'app_name:services:service_name'
+  # $('body').trigger '<%= file_name.downcase %>:services:service_name'
   # 
   # If you want a more fine grained control for 
   # different pages you can add a class to your body 
@@ -13,16 +13,16 @@ Transponder.services_manifest = ->
   #
   # You now have a more fine grained control in 
   # your manifest file
-  # $('body.posts.show').trigger 'app_name:services:service_name'
+  # $('body.posts.show').trigger '<%= file_name.downcase %>:services:service_name'
   #
   # if you need to trigger the same services on multiple pages
   # $('body.posts.show,
   #    body.dashboard.show,
-  #    body.photos.index').trigger 'app_name:services:service_name'
+  #    body.photos.index').trigger '<%= file_name.downcase %>:services:service_name'
   # 
 
-run_ready = ->
-  Transponder.services_manifest()
+<%= file_name.camelize %>.run_ready = ->
+  <%= file_name.camelize %>.services_manifest()
 
-$(document).ready run_ready
-$(document).on 'page:load', run_ready
+$(document).ready <%= file_name.camelize %>.run_ready
+$(document).on 'page:load', <%= file_name.camelize %>.run_ready

data/lib/generators/transponder/install/templates/minimal/initializers/boot.coffee

@@ -0,0 +1 @@
+# services

data/lib/generators/transponder/install/templates/minimal_setup.coffee

@@ -0,0 +1,3 @@
+window.<%= file_name.camelize %> =
+  Helpers: {}
+  Services: {}

data/lib/generators/transponder/install/templates/minimal_shared.coffee

@@ -0,0 +1,5 @@
+#= require initializers/setup
+#= require_tree ./services
+#= require_tree ./helpers
+#= require initializers/boot
+#= require initializers/manifest 

data/lib/generators/transponder/presenter/presenter_generator.rb

@@ -0,0 +1,13 @@
+require 'generators/transponder'
+
+module Transponder
+  module Generators
+    class PresenterGenerator < Base
+      class_option :module_name, type: :string, aliases: '-m', default: 'application'
+
+      def add_presenter
+        template "_presenter.coffee", "app/assets/javascripts/#{options[:module_name]}/presenters/#{file_name}_presenter.coffee"
+      end
+    end
+  end
+end

data/lib/generators/transponder/presenter/templates/_presenter.coffee

@@ -0,0 +1,3 @@
+class <%= options[:module_name].camelize %>.Presenters.<%= file_name.camelize %>Presenter extends Transponder.Presenter
+  presenterName: '<%= file_name %>'
+  module: '<%= options[:module_name] %>'

data/lib/transponder.rb

@@ -1,7 +1,22 @@
 require 'transponder/version'
+require 'transponder/transmission'
 require 'rails'
 
 module Transponder
-  class Engine < Rails::Engine
+  module ViewHelpers
+    def xms_module_name
+      params[:controller].include?('/') ? params[:controller].split('/')[0] : nil
+    end
+
+    def xms_event(module_name: nil, action: nil)
+      _module = module_name || xms_module_name || 'application'
+      _action = action || action_name
+      "ujs:#{_module}:#{controller_name}:#{_action}"
+    end
+  end
+
+  class Engine < ::Rails::Engine
+
   end
 end
+ActionView::Base.send :include, Transponder::ViewHelpers

data/lib/transponder/transmission.rb

@@ -0,0 +1,22 @@
+module Transponder
+  module Transmission
+    extend ActiveSupport::Concern
+
+    included do 
+      after_filter :intercept_js
+
+      def xms_errors object, message: nil
+        render json: { errors: (message || object.errors), 
+                       controller: controller_name, 
+                       action: action_name, 
+                       namespace: params[:controller].split('/')[0] }, status: :unprocessable_entity
+      end
+
+      def intercept_js
+        if request.format == :js
+          response.header['Content-Type'] = "application/transmission"
+        end
+      end
+    end
+  end
+end

data/lib/transponder/version.rb

@@ -1,3 +1,3 @@
 module Transponder
-  VERSION = "0.1.5"
+  VERSION = "0.8.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: transponder
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.8.2
 platform: ruby
 authors:
 - Zack Siri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-15 00:00:00.000000000 Z
+date: 2013-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coffee-rails
@@ -36,19 +36,40 @@ files:
 - lib/assets/javascripts/transponder/init.coffee
 - lib/assets/javascripts/transponder/presenter.coffee
 - lib/assets/javascripts/transponder/request.coffee
+- lib/assets/javascripts/transponder/response.coffee
 - lib/assets/javascripts/transponder/service.coffee
 - lib/assets/javascripts/transponder/setup.coffee
 - lib/generators/transponder.rb
 - lib/generators/transponder/install/USAGE
 - lib/generators/transponder/install/install_generator.rb
-- lib/generators/transponder/install/templates/helpers/.keep
-- lib/generators/transponder/install/templates/initializers/.keep
+- lib/generators/transponder/install/templates/basic.coffee
+- lib/generators/transponder/install/templates/basic/helpers/.keep
+- lib/generators/transponder/install/templates/basic/initializers/boot.coffee
+- lib/generators/transponder/install/templates/basic/presenters/.keep
+- lib/generators/transponder/install/templates/basic/services/.keep
+- lib/generators/transponder/install/templates/basic_setup.coffee
+- lib/generators/transponder/install/templates/basic_shared.coffee
+- lib/generators/transponder/install/templates/full.coffee
+- lib/generators/transponder/install/templates/full/collections/.keep
+- lib/generators/transponder/install/templates/full/helpers/.keep
+- lib/generators/transponder/install/templates/full/initializers/boot.coffee
+- lib/generators/transponder/install/templates/full/models/.keep
+- lib/generators/transponder/install/templates/full/presenters/.keep
+- lib/generators/transponder/install/templates/full/services/.keep
+- lib/generators/transponder/install/templates/full/templates/.keep
+- lib/generators/transponder/install/templates/full/views/.keep
+- lib/generators/transponder/install/templates/full_setup.coffee
+- lib/generators/transponder/install/templates/full_shared.coffee
 - lib/generators/transponder/install/templates/manifest.coffee
-- lib/generators/transponder/install/templates/presenters/.keep
-- lib/generators/transponder/install/templates/services/.keep
-- lib/generators/transponder/install/templates/setup.coffee
-- lib/generators/transponder/resource_helpers.rb
+- lib/generators/transponder/install/templates/minimal/helpers/.keep
+- lib/generators/transponder/install/templates/minimal/initializers/boot.coffee
+- lib/generators/transponder/install/templates/minimal/services/.keep
+- lib/generators/transponder/install/templates/minimal_setup.coffee
+- lib/generators/transponder/install/templates/minimal_shared.coffee
+- lib/generators/transponder/presenter/presenter_generator.rb
+- lib/generators/transponder/presenter/templates/_presenter.coffee
 - lib/transponder.rb
+- lib/transponder/transmission.rb
 - lib/transponder/version.rb
 - README.md
 - LICENSE.txt
@@ -73,7 +94,7 @@ files:
 - test/javascripts/transponder/presenter_test.coffee
 - test/javascripts/transponder/presenters/examples_presenter_test.coffee
 - test/javascripts/transponder/services/calculate_test.coffee
-homepage: http://github.com/zacksiri/transponder
+homepage: http://github.com/artellectual/transponder
 licenses:
 - MIT
 metadata: {}

data/lib/generators/transponder/install/templates/setup.coffee

@@ -1,4 +0,0 @@
-window.<%= application_name.camelize %> =
-  Helpers: {}
-  Services: {}
-  Presenters: {}

data/lib/generators/transponder/resource_helpers.rb

@@ -1,20 +0,0 @@
-module Transponder
-  module Generators
-    module ResourceHelpers
-
-      def js_app_name
-        application_name.downcase
-      end
-
-      # gets the application name
-      def application_name
-        if defined?(Rails) && ::Rails.application
-          ::Rails.application.class.name.split('::').first
-        else
-          "application"
-        end
-      end
-
-    end
-  end
-end