backbonify 0.1.0

data/lib/backbonify.rb

@@ -0,0 +1,4 @@
+require "backbonify/engine"
+
+module Backbonify
+end

data/lib/backbonify/engine.rb

@@ -0,0 +1,5 @@
+module Backbonify
+  class Engine < Rails::Engine
+    isolate_namespace Backbonify
+  end
+end

data/lib/backbonify/version.rb

@@ -0,0 +1,3 @@
+module Backbonify
+  VERSION = "0.1.0"
+end

data/lib/generators/backbonify/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate backbonify Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/backbonify/hbs/hbs_generator.rb

@@ -0,0 +1,29 @@
+require 'generators/backbonify/resource_helpers'
+
+module Backbonify
+  module Generators
+    class HbsGenerator < Rails::Generators::NamedBase
+      include Backbonify::Generators::ResourceHelpers
+
+      source_root File.expand_path("../templates", __FILE__)
+      desc "This generator creates a set of Handlebars templates for a model"
+
+      argument :attributes, :type => :array, :default => [], :banner => "field:type field:type"
+
+
+      def create_templates
+        %w(page index show new edit).each do |view|
+          template "#{view}.haml", File.join(backbone_path, "templates", plural_name, "#{view}.jst.hbs.haml")
+        end
+      end
+
+      def create_partials
+        %w(_row _form).each do |view|
+          template "#{view}.haml", File.join(backbone_path, "templates", plural_name, "_#{singular_name}#{view}.jst.hbs.haml")
+        end
+      end
+
+
+    end
+  end
+end

data/lib/generators/backbonify/hbs/templates/_form.haml

@@ -0,0 +1,6 @@
+= form_for <%= singular_name.capitalize %>.new do |f|
+<% attributes.each do |attribute| -%>
+  =f.text_field :<%= attribute.name %>, :placeholder => "<%= attribute.name %>"
+<% end -%>
+
+  = submit_tag

data/lib/generators/backbonify/hbs/templates/_row.haml

@@ -0,0 +1,4 @@
+<% attributes.each do |attribute| -%>
+%td.<%= attribute.name %> {{<%= attribute.name %>}}
+<% end -%>
+

data/lib/generators/backbonify/hbs/templates/edit.haml

@@ -0,0 +1 @@
+{{>  <%= singular_name %>_row}}

data/lib/generators/backbonify/hbs/templates/index.haml

@@ -0,0 +1,13 @@
+%table
+  %thead
+    %tr
+<% attributes.each do |attribute| -%>
+      %th <%= attribute.human_name %>
+<% end -%>
+
+  %tbody
+    {{#each collection}}
+    %tr(id="<%= singular_name %>_{{id}}")
+      {{>  <%= singular_name %>_row}}
+    {{/each}}
+

data/lib/generators/backbonify/hbs/templates/new.haml

@@ -0,0 +1 @@
+{{>  <%= singular_name %>_form}}

data/lib/generators/backbonify/hbs/templates/page.haml

@@ -0,0 +1,6 @@
+.submenu
+  %a.reload(href="#reload") ⟳
+  %a.new.<%= singular_name %>(href="") new <%= singular_name %>
+  %span.filters
+    =# text_field :performance, :film, :placeholder => "film", :class => "search"
+    %span.collectionLength

data/lib/generators/backbonify/hbs/templates/show.haml

@@ -0,0 +1 @@
+{{> <%= singular_name %>_row}}

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

@@ -0,0 +1,57 @@
+require 'generators/backbonify/resource_helpers'
+
+module Backbonify
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Backbonify::Generators::ResourceHelpers
+
+      source_root File.expand_path("../templates", __FILE__)
+      desc "This generator installs backbone.js with a default folder layout in app/assets/javascripts/backbone"
+      class_option :skip_git, :type => :boolean, :aliases => "-G", :default => true,
+                   :desc => "Skip Git ignores and keeps"
+      class_option :skip_require, :type => :boolean, :aliases => "-R", :default => true,
+                   :desc => "Skip injection of requires in app.js (-R), useful for updates"
+
+      def copy_javascripts_libs_to_vendor
+        directory("../../../../../lib/assets/javascripts/", "vendor/assets/javascripts/", :recursive => true)
+      end
+
+
+      def inject_backbone
+        return if options[:skip_requires]
+        inject_into_file "app/assets/javascripts/application.js", :before => "//= require_tree" do
+a = %{
+//= require json2
+//= require jquery
+//= require jquery-ui
+//= require jquery.notice
+//= require handlebars.runtime
+//= require underscore
+//= require backbone
+// require backbone_rails_sync
+//= require backbone_datalink
+//= require backbone.grid
+//= require #{application_name.underscore}
+
+$(function(){
+  window.app = #{application_name}.init()
+});
+
+}
+        end
+      end
+
+      def create_dir_layout
+        %W{routers models views templates}.each do |dir|
+          empty_directory "app/assets/javascripts/#{dir}"
+          create_file "app/assets/javascripts/#{dir}/.gitkeep" unless options[:skip_git]
+        end
+      end
+
+      def create_app_file
+        template "app.js", "app/assets/javascripts/#{application_name.underscore}.js"
+      end
+
+    end
+  end
+end

data/lib/generators/backbonify/install/templates/app.js

@@ -0,0 +1,47 @@
+//= require_self
+//= require_tree ./templates
+//= require_tree ./models
+//= require_tree ./views
+//= require_tree ./routers
+
+var <%= js_app_name %> = (function(){
+
+
+  var initialize = function(){
+    initializeCollections();
+    startListening();
+
+    //new <%= js_app_name %>.Routers.SomeRouter;
+    Backbone.history.start();
+  }
+
+  var initializeCollections = function() {
+    //app.collection = new <%= js_app_name %>.Collections.SomeCollection;
+  }
+
+  var startListening = function() {
+    //app.collection.on("sync", notifySync)
+    //app.collection.on("error", notifyError)
+  }
+
+  var notifySync = function(collection) {
+    $.noticeAdd({text: "Succesfully saved, Yo!"})
+  }
+
+  var notifyError = function(collection) {
+    //_.delay(function() {self.$("input[type='submit']").prop("disabled", false)}, 3000)
+    $.noticeAdd({text: "Error yo, put a date or a film or something"})
+  }
+
+  var app = {
+    init : initialize,
+    Models: {},
+    Collections: {},
+    Routers: {},
+    Views: {}
+  };
+
+
+  return app;
+
+})()

data/lib/generators/backbonify/model/model_generator.rb

@@ -0,0 +1,20 @@
+require 'generators/backbonify/resource_helpers'
+
+module Backbonify
+  module Generators
+    class ModelGenerator < Rails::Generators::NamedBase
+      include Backbonify::Generators::ResourceHelpers
+
+      source_root File.expand_path("../templates", __FILE__)
+      desc "This generator creates a backbone model"
+
+      argument :attributes, :type => :array, :default => [], :banner => "field:type field:type"
+
+      def create_backbone_model
+        template "model.js", "#{backbone_path}/models/#{file_name}.js"
+      end
+
+
+    end
+  end
+end

data/lib/generators/backbonify/model/templates/model.js

@@ -0,0 +1,35 @@
+//
+// MODEL
+//
+<%= model_namespace %> = Backbone.Model.extend({
+  paramRoot: '<%= singular_table_name %>',
+  urlRoot: '<%= route_url %>',
+
+  defaults: {
+<% attributes.each do |attribute| -%>
+    <%= attribute.name %>: null,
+<% end -%>
+    noop:null
+  }
+
+})
+
+<%= collection_namespace %> = Backbone.Collection.extend({
+  model: <%= model_namespace %>,
+  url: '<%= route_url %>',
+
+  // A small decorator for 'fetch' to retain last data passed to it
+  fetch: function(options) {
+    this.fetchOptions = options || {};
+    Backbone.Collection.prototype.fetch.call(this, options);
+  },
+
+  // default_fetch uses the last data past to fetch to reload accordingly
+  default_fetch: function() {
+    this.fetch(this.fetchOptions)
+  }
+
+})
+
+_.extend(<%= collection_namespace %>.prototype, Filter);
+

data/lib/generators/backbonify/resource_helpers.rb

@@ -0,0 +1,63 @@
+module Backbonify
+  module Generators
+    module ResourceHelpers
+
+      def backbone_path
+        "app/assets/javascripts"
+      end
+
+      # => Perf.Models.Performance
+      def model_namespace
+        [js_app_name, "Models", class_name].join(".")
+      end
+
+      # => performance
+      def singular_model_name
+        uncapitalize singular_name.camelize
+      end
+
+      # => performances
+      def plural_model_name
+        uncapitalize(plural_name.camelize)
+      end
+
+      # => Perf.Collections.Performances
+      def collection_namespace
+        [js_app_name, "Collections", plural_name.camelize].join(".")
+      end
+
+      # => Perf.Views.Performances
+      def view_namespace
+        [js_app_name, "Views", plural_name.camelize].join(".")
+      end
+
+      # => Perf.Routers.Performances
+      def router_namespace
+        [js_app_name, "Routers", plural_name.camelize].join(".")
+      end
+
+      def jst(action)
+        "templates/#{plural_name}/#{action}"
+      end
+
+      def js_app_name
+        application_name.camelize
+      end
+
+      # TODO : Add an option so "App" is default
+      def application_name
+        if defined?(Rails) && Rails.application
+          Rails.application.class.name.split('::').first
+        else
+          "application"
+        end
+      end
+
+      # uncapitalize("ABC") => aBC
+      def uncapitalize(str)
+        str[0, 1].downcase << str[1..-1]
+      end
+
+    end
+  end
+end

data/lib/generators/backbonify/router/router_generator.rb

@@ -0,0 +1,44 @@
+require 'generators/backbonify/resource_helpers'
+
+module Backbonify
+  module Generators
+    class RouterGenerator < Rails::Generators::NamedBase
+      include Backbonify::Generators::ResourceHelpers
+
+      source_root File.expand_path("../templates", __FILE__)
+      desc "This generator creates a backbone router (NOT with views and templates for the provided actions)"
+
+      argument :actions, :type => :array, :default => [], :banner => "action action"
+
+      RESERVED_JS_WORDS = %W{
+        break case catch continue debugger default delete do else finally for
+        function if in instanceof new return switch this throw try typeof var void while with
+      }
+
+      def validate_no_reserved_words
+        actions.each do |action|
+          if RESERVED_JS_WORDS.include? action
+             raise Thor::Error, "The name '#{action}' is reserved by javascript " <<
+                                "Please choose an alternative action name and run this generator again."
+          end
+        end
+      end
+
+      def create_router_files
+        template 'router.js', File.join(backbone_path, "routers", class_path, "#{file_name}_router.js")
+      end
+
+      #def create_view_files
+      #  actions.each do |action|
+      #   @action = action
+      #   @view_path = File.join(backbone_path, "views", plural_name, "#{action}_view.js.coffee")
+      #   @jst_path = File.join(backbone_path,"templates", plural_name, "#{action}.jst.ejs")
+      #
+      #   template "view.coffee", @view_path
+      #   template "template.jst", @jst_path
+      #  end
+      #end
+
+    end
+  end
+end

data/lib/generators/backbonify/router/templates/router.js

@@ -0,0 +1,24 @@
+//
+// Router
+//
+<%= router_namespace %>Router = Backbone.Router.extend({
+  routes : {
+    "<%= plural_name %>" : "index",
+    "<%= plural_name %>/:id" : "show"
+  },
+
+  page: null,
+
+  initialize : function() {
+    this.page = new <%= "#{view_namespace}.#{'page'.camelize}View()" %>
+    this.page.display();
+  },
+
+  index : function(){
+    $("#orchestraPage, #contractPage").hide()
+    this.page.slide()
+  },
+
+  show : function(id) {}
+
+});

data/lib/generators/backbonify/router/templates/template.jst

@@ -0,0 +1,2 @@
+<h1><%= class_name %>#<%= @action %></h1>
+<p>Find me in <%= @jst_path %></p>

data/lib/generators/backbonify/router/templates/view.coffee

@@ -0,0 +1,8 @@
+<%= view_namespace %> ||= {}
+
+class <%= view_namespace %>.<%= @action.camelize %>View extends Backbone.View
+  template: JST["<%= jst @action %>"]
+
+  render: ->
+    $(@el).html(@template())
+    return this

data/lib/generators/backbonify/scaffold/scaffold_generator.rb

@@ -0,0 +1,26 @@
+require 'generators/backbonify/resource_helpers'
+
+module Backbonify
+  module Generators
+    class ScaffoldGenerator < Rails::Generators::NamedBase
+      include Backbonify::Generators::ResourceHelpers
+
+      source_root File.expand_path("../templates", __FILE__)
+      desc "This generator creates the client side crud scaffolding"
+
+
+      class_option :model, :default => true, :type => :string
+      hook_for :model
+
+      class_option :router, :default => true, :type => :string
+      hook_for :router
+
+      class_option :views, :default => true, :type => :string
+      hook_for :views
+
+      class_option :js_template, :default => "hbs", :type => :string
+      hook_for :js_template
+
+    end
+  end
+end

data/lib/generators/backbonify/views/templates/edit_view.js

@@ -0,0 +1,34 @@
+//
+// EDIT : <%= singular_name.capitalize %>
+//
+<%= view_namespace %> = <%= view_namespace %> || {};
+
+<%= view_namespace %>.EditView = Grid.EditView.extend({
+  tagName : "tr",
+  className : "new_<%= singular_name %>",
+  template : JST["templates/<%= plural_name %>/show"],
+  cell : null,
+  attribute : null,
+  inputTag : null,
+
+  initialize : function() {
+    var self = this;
+    this.model.bind("sync", this.renderRow, this);
+    //this.slowSaving = _.debounce(function(){ self.model.save() }, 1100);
+  },
+
+
+  _createInputTemplate : function() {
+    if( this.cell.hasClass('address') ) {
+      return "<textarea style='height:25px' name='address'><%%="+ this.attribute+"%></textarea>"
+    } else {
+      return '<input id="<%= singular_name %>_' + this.attribute +
+        '" value="<%%=' + this.attribute +
+        '%>" name="' + this.attribute + '" />'
+    }
+  },
+
+  noop:null
+});
+
+//_.extend(<%= view_namespace %>.EditView.prototype, <%= js_app_name %>.FormHelpers);