backbone_generator 0.0.3 → 0.0.4

data/lib/backbone_generator/generators/new/template/js/views/Main.View.tt

@@ -0,0 +1,39 @@
+/**
+ * TODO: add description of class
+ * @author: <%= config[:author] %>
+ * @class: MainView
+ * */
+
+/* global define */
+var <%= config[:app_name] %> = <%= config[:app_name] %> || {};
+
+(function() {
+    'use strict';
+
+    define([
+        'jquery',
+        'underscore',
+        'backbone',
+        'views/Hello.View',
+        ], function($, _, Backbone) {
+            
+            <%= config[:app_name] %>.MainView = Backbone.View.extend({
+
+                //TODO: Put all event listener code here
+                events: {
+                },
+
+                //TODO: Put all initialization code here
+                initialize: function() {
+                    this.helloView = new <%= config[:app_name] %>.HelloView();
+                },
+
+                //TODO: Put all render logic here
+                render: function() {
+                },
+
+            });
+
+            return <%= config[:app_name] %>.MainView;
+        });
+}());

data/lib/backbone_generator/generators/new/template/main.tt

@@ -0,0 +1,45 @@
+/**
+ * TODO: add description of class
+ * @author: <%= config[:author] %> 
+ * @class: main.js
+ * */
+
+/* global require */
+(function() {
+    'use strict';
+
+    require.config({
+        shim: {
+            underscore: {
+                exports: '_'
+            },
+            backbone: {
+                deps: ['underscore', 'jquery'],
+                exports: 'Backbone'
+            }
+        },
+        paths: {
+            jquery: 'libs/jquery/jquery-2.0.3.min',
+            underscore: 'libs/underscore/underscore-1.5.2',
+            backbone: 'libs/backbone/backbone-1.1.0',
+            text: 'libs/requirejs-text/text-2.0.10'
+        },
+        urlArgs : "v=2"
+
+    });
+
+    require([
+            'backbone',
+            'views/Main.View',
+            'routes/<%= config[:app_name] %>.Route',
+    ], function (Backbone,  <%= config[:app_name] %>MainView, <%= config[:app_name] %>Routes) {
+        /*jshint nonew:false*/
+        
+        // Initialize routing and start Backbone.history()
+        new <%= config[:app_name] %>Routes();
+        Backbone.history.start();
+
+        // Initialize the main application view
+        new <%= config[:app_name] %>MainView();
+    });
+}());

data/lib/backbone_generator/generators/route/route_generator.rb

@@ -0,0 +1,36 @@
+# Namespace for all the classess
+# @since 0.0.3
+module BackboneGenerator
+
+    # Abstract base class for generating
+    # routes A.K.A copying template
+    # @author Tawheed Abdul-Raheem
+    class RouteGenerator
+
+        class << self
+            def create_route route_name
+                app_name  = BackboneGenerator.option_details[:app_name] || File.basename(Dir.getwd).chomp("/")
+                if BackboneGenerator.option_details[:app_name]
+                    dir_path = File.join(Dir.getwd, app_name)
+                else
+                    dir_path = File.join(Dir.getwd)
+                end
+                template_path = File.expand_path(File.dirname(__FILE__)) + "/template/Routes.tt"
+                target_path = "/js/routes/" + route_name + ".Route.js"
+                route_hash = {
+                    :app_name  => app_name.slice(0,1).capitalize + app_name.slice(1..-1),
+                    :route_name => route_name.slice(0,1).capitalize + route_name.slice(1..-1),
+                }
+
+                if File.exists? dir_path + target_path
+                    print "error ".red
+                    puts "Route with the name specified already exists"
+                else
+                    BackboneGenerator.compile_and_copy(template_path, dir_path + target_path, route_hash)
+                    print "created ".green
+                    puts  route_hash[:app_name] + target_path
+                end
+            end
+        end
+    end
+end

data/lib/backbone_generator/generators/route/template/Routes.tt

@@ -0,0 +1,27 @@
+/**
+ * TODO: add description of class
+ * @author: 
+ * @class: <%= config[:route_name] %>Route
+ * */
+
+/* global define */
+var <%= config[:app_name] %> = <%= config[:app_name] %> || {};
+
+/* global define */
+(function() {
+    'use strict';
+
+    define([
+        'jquery',
+        'underscore',
+        'backbone',
+        ], function($, _, Backbone) {
+            
+            <%= config[:app_name] %>.<%= config[:route_name]%>Route = Backbone.Router.extend({
+
+                //TODO: Define all your routes here
+            });
+
+            return <%= config[:app_name] %>.<%= config[:route_name] %>Route;
+        });
+}());

data/lib/backbone_generator/generators/templates/template/Template.tt

@@ -0,0 +1,10 @@
+<h1>Aloha! fellow javascripters</h1>
+
+<p>This app was generated with the <code>backbone_generator</code> gem</p>
+<p>This view was dynamically inserted into the DOM using the awesomeness of
+<code>backbone.js</code></p> I think its really cool that you are writting 
+javascript code that is maintainable. This view is located in <code>js/templates/Hello.Template.html</code>
+
+<h2>Getting started</h2>
+<p>Please view this  <a href="http://tawrahim.github.io/backbone_generator_web">tutorial</a> on how to get started. If you like the project, please star it on <a href="https://github.com/tawrahim/backbone_generator">Github</a> so that other awesomene people like you can also find it.</p>
+<p>Thanks <a href="http://github.com/tawrahim">Tawheed</a>!</p>

data/lib/backbone_generator/generators/templates/templates_generator.rb

@@ -0,0 +1,35 @@
+# Namespace for all the classess
+# @since 0.0.3
+module BackboneGenerator
+
+    # Abstract base class for generating
+    # utility A.K.A copying template
+    # @author Tawheed Abdul-Raheem
+    class TemplateGenerator
+
+        class << self
+            def create_template template_name
+                app_name  = BackboneGenerator.option_details[:app_name] || File.basename(Dir.getwd).chomp("/")
+                if BackboneGenerator.option_details[:app_name]
+                    dir_path = File.join(Dir.getwd, app_name)
+                else
+                    dir_path = File.join(Dir.getwd)
+                end
+                template_path = File.expand_path(File.dirname(__FILE__)) + "/template/Template.tt"
+                target_path = "/js/templates/" + template_name.capitalize + ".Template.html"
+                template_hash = {
+                    :app_name  => app_name.slice(0,1).capitalize + app_name.slice(1..-1),
+                    :template_name => template_name.slice(0,1).capitalize + template_name.slice(1..-1),
+                }
+                if File.exist? dir_path + target_path
+                    print "error ".red
+                    puts "View with the name specified already exists"
+                else
+                    BackboneGenerator.compile_and_copy(template_path, dir_path + target_path, template_hash)
+                    print "created ".green
+                    puts  template_hash[:app_name] + target_path
+                end
+            end
+        end
+    end
+end

data/lib/backbone_generator/generators/tests/template/mainview.js

@@ -0,0 +1,48 @@
+/**
+ * This file is responsible for rendering
+ * all the ports on the system
+ * @author: Tawheed Abdul-Raheem
+ * @class: SANBLaze.PortView
+ *
+ **/
+
+/* global define */
+var SANBLaze = SANBLaze || {};
+
+(function() {
+    'use strict';
+
+    define([
+        'jquery',
+        'underscore',
+        'backbone',
+        'views/Port.View',
+        ], function($, _, Backbone) {
+
+            SANBLaze.AllPortsView = Backbone.View.extend({
+
+            // Instead of generating a new element, bind to the
+            // the existing element present in the HTML
+            el: '.nav',
+
+            // Initialization
+            initialize: function() {
+                this.collection = SANBLaze.PortView();
+            },
+
+            // Rendering the app
+            render: function() {
+                this.renderPort();
+            },
+
+            // Render a port by creating a PortView and appending
+            // the element it renders
+            renderPort: function() {
+                var portView = new SANBLaze.PortView();
+                this.$el.append(portView.render().el);
+            }
+            });
+
+            return SANBLaze.AllPortsView;
+        });
+}());

data/lib/backbone_generator/generators/tests/tests_generator.rb

@@ -0,0 +1,17 @@
+# Namespace for all the classess
+# @since 0.0.3
+module BackboneGenerator
+
+    # Abstract base class for generating
+    # tests A.K.A copying template
+    # @author Tawheed Abdul-Raheem
+    class TestGenerator
+
+        class << self
+            def create_test test_name
+                print "NOTICE ".yellow
+                puts "Will be implemented in the next Release"
+            end
+        end
+    end
+end

data/lib/backbone_generator/generators/utilities/template/Utility.tt

@@ -0,0 +1,28 @@
+/**
+ * TODO: add description of class
+ * @author: 
+ * @class: <%= config[:utility_name] %>Utility
+ * */
+
+/* global define */
+var <%= config[:app_name] %> = <%= config[:app_name] %> || {};
+
+(function() {
+    'use strict';
+
+    define([
+        'jquery',
+        'underscore',
+        ], function($, _) {
+
+            <%= config[:app_name] %>.<%= config[:utility_name] %>Utility = {
+                
+                //TODO: Define all your utility methods here
+                sayHello: function() {
+                    console.log('Hello from the main utility');
+                }
+            };
+
+            return <%= config[:app_name] %>.<%= config[:utility_name] %>Utility;
+        });
+}());

data/lib/backbone_generator/generators/utilities/utilities_generator.rb

@@ -0,0 +1,35 @@
+# Namespace for all the classess
+# @since 0.0.3
+module BackboneGenerator
+
+    # Abstract base class for generating
+    # utility A.K.A copying template
+    # @author Tawheed Abdul-Raheem
+    class UtilityGenerator
+
+        class << self
+            def create_utility utility_name
+                app_name  = BackboneGenerator.option_details[:app_name] || File.basename(Dir.getwd).chomp("/")
+                if BackboneGenerator.option_details[:app_name]
+                    dir_path = File.join(Dir.getwd, app_name)
+                else
+                    dir_path = File.join(Dir.getwd)
+                end
+                utility_hash = {
+                    :app_name  => app_name.slice(0,1).capitalize + app_name.slice(1..-1),
+                    :utility_name => utility_name.slice(0,1).capitalize + utility_name.slice(1..-1),
+                }
+                template_path = File.expand_path(File.dirname(__FILE__)) + "/template/Utility.tt"
+                target_path = "/js/utilities/" +  utility_hash[:app_name] + "." + utility_name + "Utility.js"
+                if File.exist? dir_path + target_path
+                    print "error ".red
+                    puts "Utility with the name specified already exists"
+                else
+                    BackboneGenerator.compile_and_copy(template_path, dir_path + target_path, utility_hash)
+                    print "created ".green
+                    puts  utility_hash[:app_name] + target_path
+                end
+            end
+        end
+    end
+end

data/lib/backbone_generator/generators/views/template/View.tt

@@ -0,0 +1,50 @@
+/**
+ * TODO: add description of class
+ * @author: 
+ * @class: <%= config[:view_name] %>.js
+ * */
+
+/* global define */
+var <%= config[:app_name] %> = <%= config[:app_name] %> || {};
+
+(function() {
+    'use strict';
+
+    define([
+        'jquery',
+        'underscore',
+        'backbone',
+        'text!templates/<%= config[:view_name] %>.Template.html',
+        ], function($, _, Backbone, <%= config[:view_name].downcase %>Template) {
+
+            <%= config[:app_name] %>.<%= config[:view_name] %>View = Backbone.View.extend({
+
+            //Declare a hash to hold your model data
+            model: {},
+
+            //TODO: Change the el tag to match your needs
+            el: "#hello_div",
+
+            template: _.template(<%= config[:view_name].downcase %>Template),
+
+            //TODO: Put all event listener code here
+            events: {
+            },
+
+            //TODO: Put all initialization code here
+            initialize: function() {
+                this.render();
+            },
+
+            //TODO: Put all render logic here
+            render: function() {
+                this.$el.html(this.template);
+                return this;
+            },
+
+
+            });
+
+            return <%= config[:app_name] %>.<%= config[:view_name] %>View;
+        });
+}());

data/lib/backbone_generator/generators/views/views_generator.rb

@@ -0,0 +1,36 @@
+# Namespace for all the classess
+# @since 0.0.3
+module BackboneGenerator
+
+    # Abstract base class for generating
+    # views A.K.A copying template
+    # @author Tawheed Abdul-Raheem
+    class ViewGenerator
+
+        class << self
+            def create_view view_name
+                app_name  = BackboneGenerator.option_details[:app_name] || File.basename(Dir.getwd).chomp("/")
+                if BackboneGenerator.option_details[:app_name]
+                    dir_path = File.join(Dir.getwd, app_name)
+                else
+                    dir_path = File.join(Dir.getwd)
+                end
+                template_path = File.expand_path(File.dirname(__FILE__)) + "/template/View.tt"
+                target_path = "/js/views/" + view_name.capitalize + ".View.js"
+                view_hash = {
+                    :app_name  => app_name.slice(0,1).capitalize + app_name.slice(1..-1),
+                    :view_name => view_name.slice(0,1).capitalize + view_name.slice(1..-1),
+                }
+                if File.exist? dir_path + target_path
+                    print "error ".red
+                    puts "View with the name specified already exists"
+                else
+                    BackboneGenerator.compile_and_copy(template_path, dir_path + target_path, view_hash)
+                    print "created ".green
+                    puts  view_hash[:app_name] + target_path
+                    BackboneGenerator::TemplateGenerator.create_template(view_name)
+                end
+            end
+        end
+    end
+end

data/lib/backbone_generator/post_install_message.rb

@@ -0,0 +1,21 @@
+module BackboneGenerator
+  class << self
+    def post_install_message
+      footer = <<'EOS'
+
+======== Release notes for BackboneGenerator ===========
+
+Thank you very much for downloading the backbone_generator
+gem. I would like to hear your feedback on possible bugs
+and also potential features that you would like to see in
+the next release!
+
+Happy Coding :-)
+- Tawheed 
+
+==========================================================
+
+EOS
+    end
+  end
+end

data/lib/backbone_generator/version.rb

@@ -1,3 +1,3 @@
 module BackboneGenerator
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end