backbone_generator 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 822b87be11c648dbd2259e0e5dccd1f5c81021cc
-  data.tar.gz: e5dc07556f85dbe87db082540021bf8488dc3dab
+  metadata.gz: 111951a96d22aa5ccce24cddd282f237f20c6c7f
+  data.tar.gz: b5ddb1136118fbfa0dc559187c295716dd7a5d6d
 SHA512:
-  metadata.gz: 28047a1acbc2a3eeed88b58017fbeac0dc232c0bc368b426896e47205a7fc66bca28eaf29ac3506a064526c9a19732b126c20c61e06d466f1236067a5d46c034
-  data.tar.gz: b9c5052aadca607d6143364d60ee945bd7cb3e072e0cbe67c61481f49ec0d2a83b6a2b9230801976d2bd84fa925c9bf71d4065acd807f6d27509c41b55ebe682
+  metadata.gz: af6fa38ba1eda90668bc862d8e06fef0d57ccf6d3283d2fb3e530780796761417d59b298c7460e9f93aedbe8410bf56f77262699857dd29fa7986b7285266c7a
+  data.tar.gz: e2064fa585c0485126b2ecc48624d0d7726a43e203d2ac6c3f1aabe63f4deb13c85f499daf20e7196b024f749804f5b87286ab83023a7e8488f2ef465717e82c

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+*.sh

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/LICENSE.txt

@@ -1,5 +1,5 @@
 Copyright (c) 2013 Tawheed Abdul-Raheem
-
+ 
 MIT License
 
 Permission is hereby granted, free of charge, to any person obtaining

data/README.md

@@ -18,13 +18,13 @@ Or install it yourself as:
 
 ## Usage
 
-`backone_generator new app_name`  
-`backone_generator model model_name`  
-`backone_generator view view_name`  
-`backone_generator route route_name`  
-`backone_generator collection collection_name`  
-`backone_generator utility utility_name`  
-`backone_generator library library_name`
+`backbone_generator new app_name`  
+`backbone_generator model model_name`  
+`backbone_generator view view_name`  
+`backbone_generator route route_name`  
+`backbone_generator collection collection_name`  
+`backbone_generator utility utility_name`  
+`backbone_generator library library_name`
 
 ## Contributing
 
@@ -33,3 +33,6 @@ Or install it yourself as:
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## Credit
+Mhd Tahawi for code refactor

data/backbone_generator.gemspec

@@ -2,6 +2,7 @@
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'backbone_generator/version'
+require 'backbone_generator/post_install_message'
 
 Gem::Specification.new do |spec|
   spec.name          = "backbone_generator"
@@ -9,8 +10,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Tawheed Abdul-Raheem"]
   spec.email         = ["tawrahim@gmail.com"]
   spec.description   = %q{Backbone.js generator}
-  spec.summary       = %q{Backbone.js generator}
-  spec.homepage      = ""
+  spec.summary       = %q{Yet another backbone js generator}
+  spec.homepage      = "http://tawrahim.github.io/backbone_generator_web/"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
@@ -18,20 +19,13 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.3"
+  
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rspec", "~> 2.6"
 
-  spec.post_install_message = <<-EOS
-
-==== Release notes for BackboneGenerator gem ====
-
-This gem is NOT yet ready for prime time. PLEASE DO NOT
-USE this gem yet. We are working hard to make dependecy
-management and boiler plate code generation in your
-backbone.js apps seameless.
-
-Tawheed and Mhd
+  spec.add_dependency              "thor"
+  spec.add_dependency              "colorize", "~>0.6.0"
 
-=======================================
-  EOS
+  spec.post_install_message = BackboneGenerator.post_install_message
 end

data/bin/backbone_generator

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "backbone_generator"
+require "backbone_generator/cli"
+
+BackboneGenerator::CLI.start

data/lib/backbone_generator.rb

@@ -1,6 +1,18 @@
+require "thor"
+require "webrick"
+require "colorize"
 require "backbone_generator/version"
+require "backbone_generator/auxilliary"
+require "backbone_generator/generators/collections/collections_generator.rb"
+require "backbone_generator/generators/library/library_generator.rb"
+require "backbone_generator/generators/models/models_generator.rb"
+require "backbone_generator/generators/new/new_generator.rb"
+require "backbone_generator/generators/route/route_generator.rb"
+require "backbone_generator/generators/templates/templates_generator.rb"
+require "backbone_generator/generators/tests/tests_generator.rb"
+require "backbone_generator/generators/utilities/utilities_generator.rb"
+require "backbone_generator/generators/views/views_generator.rb"
 
 module BackboneGenerator
   # Your code goes here...
-  puts "hello world"
 end

data/lib/backbone_generator/auxilliary.rb

@@ -0,0 +1,44 @@
+require "erb"
+
+# Namespace for all the classess
+# @since 0.0.3
+module BackboneGenerator
+
+    class << self
+
+        # This app hold the details of the app
+        @@option_details = {}
+
+        # This code is dummed down version of template_method in the bundler
+        # gem. Original version can be found
+        # @see https://github.com/bundler/bundler/blob/master/lib/bundler/vendor/thor/actions/file_manipulation.rb
+        # God Bless all the great and awesome people who brought us open source
+        # God Bless all the ruby developers out there!
+        def compile_and_copy(source_file, *args)
+            config = args.last.is_a?(Hash) ? args.pop : {}
+            destination = args.first
+            context = instance_eval('binding')
+            content = ERB.new(::File.binread(source_file)).result(context)
+            open(destination, 'w') { |f| f << content }
+        end
+
+        # Function used to start server
+        def start_server(port)
+            root = Dir.getwd
+            server = WEBrick::HTTPServer.new :Port => port, :DocumentRoot => root
+            trap 'INT' do server.shutdown end
+            server.start
+        end
+
+        # Getter for the option_details hash
+        def option_details
+            @@option_details
+        end
+
+        # Setter for the option_details hash
+        def option_details=(value)
+            @@option_details = value
+        end
+
+    end
+end

data/lib/backbone_generator/cli.rb

@@ -0,0 +1,79 @@
+# Namespace for all the classess
+# @since 0.0.3
+module BackboneGenerator
+
+    # Abstract base class for CLI utilities
+    # 
+    # @author Tawheed Abdul-Raheem
+    # @abstract
+    # @since 0.0.3
+    class CLI < Thor
+
+        private
+        def isvalid?
+            if File.exists? ".BACKBONE_GENERATOR_APP"
+                return true
+            else
+                print "error ".red
+                puts "This command must be excuted in the root level of your app"
+                return false
+            end
+        end
+
+        public
+        desc "new app_name", "Create a new backbone.js application named app_name"
+        def new app_name
+            if File.exists? app_name
+                print "error ".red
+                puts "A folder with the name " + app_name + " already exists"
+            else
+                BackboneGenerator::NewGenerator.new app_name 
+            end
+        end
+
+        desc "model model_name", "Create a new backbone.js model named model_name "
+        def model model_name
+            BackboneGenerator::ModelGenerator.create_model(model_name) unless !isvalid?
+        end
+
+        desc "view view_name", "Create a new backbone.js view named view_name"
+        def view view_name
+            BackboneGenerator::ViewGenerator.create_view(view_name) unless !isvalid?
+        end
+
+        desc "route route_name", "Create a new backbone.js route named route_name"
+        def route route_name
+            BackboneGenerator::RouteGenerator.create_route(route_name) unless !isvalid?
+        end
+
+        desc " collection collection_name", "Create a new backbone.js collection named collection_name"	
+        def collection collection_name
+            BackboneGenerator::CollectionGenerator.create_collection(collection_name) unless !isvalid?
+        end
+
+        desc "utility utility_name", "Create a new backbone.js utility  named utility_name"
+        def utility utility_name
+            BackboneGenerator::UtilityGenerator.create_utility(utility_name) unless !isvalid?
+        end
+
+        desc "template template_name", "Create a template associated with a view"
+        def template template_name
+            BackboneGenerator::TemplateGenerator.create_template(template_name) unless !isvalid?
+        end
+
+        desc "library library_name", "Create a new backbone.js library named library_name"
+        def library library_name
+            BackboneGenerator::LibraryGenerator.fetch_library(library_name) unless !isvalid?
+        end
+
+        desc "test test_name", "Create a new jasmine test"
+        def test test_name
+            BackboneGenerator::TestGenerator.create_test(test_name) unless !isvalid?
+        end
+
+        desc "server", "Start a server, it defaults to port 5000 or you can pass a second argumnent for the port"
+        def server(port=5000)
+            BackboneGenerator.start_server(port) unless !isvalid?
+        end
+    end
+end

data/lib/backbone_generator/generators/collections/collections_generator.rb

@@ -0,0 +1,35 @@
+# Namespace for all the classess
+# @since 0.0.3
+module BackboneGenerator
+
+    # Abstract base class for generating
+    # collection A.K.A copying template
+    # @author Tawheed Abdul-Raheem
+    class CollectionGenerator
+
+        class << self
+            def create_collection collection_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/Collection.tt"
+                target_path = "/js/collections/" + collection_name.capitalize + ".Collection.js"
+                collection_hash = {
+                    :app_name  => app_name.slice(0,1).capitalize + app_name.slice(1..-1),
+                    :collection_name => collection_name.slice(0,1).capitalize + collection_name.slice(1..-1),
+                }
+                if File.exist? dir_path + target_path
+                    print "error ".red
+                    puts "Collection with the name specified already exists"
+                else
+                    BackboneGenerator.compile_and_copy(template_path, dir_path + target_path, collection_hash)
+                    print "created ".green
+                    puts  collection_hash[:app_name] + target_path
+                end
+            end
+        end
+    end
+end

data/lib/backbone_generator/generators/collections/template/Collection.tt

@@ -0,0 +1,29 @@
+/**
+ * TODO: add description of class
+ * @author: 
+ * @class: <%= config[:collection_name] %>Collection
+ * */
+
+/* global define */
+var <%= config[:app_name] %> = <%= config[:app_name] %> || {};
+
+(function() {
+    'use strict';
+
+    define([
+        'jquery',
+        'underscore',
+        'backbone',
+        ], function($, _, Backbone) {
+            
+            // Collection is a group of models that have custom methods
+            // that you create for them
+            <%= config[:app_name] %>.<%= config[:collection_name] %>Collection = Backbone.Collection.extend({
+
+                //TODO: Place your collection code here
+                 
+            });
+
+            return <%= config[:app_name] %>.<%= config[:collection_name] %>Collection;
+        });
+}());

data/lib/backbone_generator/generators/library/library_generator.rb

@@ -0,0 +1,17 @@
+# Namespace for all the classess
+# @since 0.0.3
+module BackboneGenerator
+
+    # Abstract base class for fetching
+    # javascript libaries from the internet
+    # @author Tawheed Abdul-Raheem
+    class ModelGenerator
+
+        class << self
+            def fetch_library library_name
+                print "NOTICE ".yellow
+                puts "Will be implemented in the next Release"
+            end
+        end
+    end
+end

data/lib/backbone_generator/generators/models/models_generator.rb

@@ -0,0 +1,35 @@
+# Namespace for all the classess
+# @since 0.0.3
+module BackboneGenerator
+
+    # Abstract base class for generating
+    # models A.K.A copying template
+    # @author Tawheed Abdul-Raheem
+    class ModelGenerator
+
+        class << self
+            def create_model model_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/Model.tt"
+                target_path = "/js/models/" + model_name.capitalize + ".Model.js"
+                model_hash = {
+                    :app_name  => app_name.slice(0,1).capitalize + app_name.slice(1..-1),
+                    :model_name => model_name.slice(0,1).capitalize + model_name.slice(1..-1),
+                }
+                if File.exist? dir_path + target_path
+                    print "error ".red
+                    puts "Model with the name specified already exists"
+                else
+                    BackboneGenerator.compile_and_copy(template_path, dir_path + target_path, model_hash)
+                    print "created ".green
+                    puts  model_hash[:app_name] + target_path
+                end
+            end
+        end
+    end
+end

data/lib/backbone_generator/generators/models/template/Model.tt

@@ -0,0 +1,44 @@
+/**
+ * TODO: add description of class
+ * @author: 
+ * @class: <%= config[:model_name] %>Model
+ * */
+
+/* global define */
+var <%= config[:app_name] %> = <%= config[:app_name] %> || {};
+
+(function() {
+    'use strict';
+
+    define([
+        'jquery',
+        'underscore',
+        'backbone',
+        ], function($, _, Backbone) {
+            
+            <%= config[:app_name] %>.<%= config[:model_name] %>Model = Backbone.Model.extend({
+
+            //TODO: Add any default model object here
+            defaults: {
+                foo: "I am a data memeber"
+            },
+
+            //TODO: Add any initialization code here
+            initialize: function() {
+                console.log("Initializing main <%= config[:model_name] %> model");
+            },
+
+            //TODO: Getters and Setters for the model object
+            getfoo: function() {
+                return this.get('foo');
+            },
+
+            setfoo: function(value) {
+                this.set('foo', value);
+            },
+
+            });
+
+            return <%= config[:app_name] %>.<%= config[:model_name] %>Model;
+        });
+}());

data/lib/backbone_generator/generators/new/new_generator.rb

@@ -0,0 +1,89 @@
+# Namespace for all the classess
+# @since 0.0.3
+module BackboneGenerator
+
+    # Abstract base class for generating a project
+    # 
+    # @author Tawheed Abdul-Raheem
+    # @abstract
+    # @since 0.0.3
+    class NewGenerator 
+
+        def initialize app_name
+            @app_name = app_name.chomp("/")
+            @target_path = File.join(Dir.getwd, @app_name)
+            @template_path = File.expand_path(File.dirname(__FILE__)) + "/template"
+            Dir.mkdir (@target_path)
+
+            git_user_name = `git config user.name`.chomp
+            git_user_email = `git config user.email`.chomp
+
+            BackboneGenerator.option_details.merge!({
+                :app_name        => @app_name.slice(0,1).capitalize + @app_name.slice(1..-1),
+                :app_path        => @target_path,
+                :author          => git_user_name.empty? ? "TODO: Write your name" : git_user_name,
+                :email           => git_user_email.empty? ? "TODO: Write your email address" : git_user_email,
+            })
+            BackboneGenerator.option_details.freeze
+            copy_static_files
+            copy_compiled_files
+            puts "Initializing git repo in " + Dir.getwd + "/" + app_name
+            Dir.chdir(@target_path) { `git init`; `git add .` }
+        end
+
+        def copy_static_files
+            dot_files = ["/.gitignore", "/.BACKBONE_GENERATOR_APP", "/index.html"]
+            dot_files.each do |file|
+                FileUtils.cp(@template_path + file, @target_path)
+                print "created ".green
+                puts BackboneGenerator.option_details[:app_name] + file
+            end
+
+            js_files = ['/js/collections', '/js/models', '/js/views', '/js/templates', '/js/utilities', '/js/libs', '/js/routes']
+            js_files.each do |file|
+                FileUtils.mkdir_p @target_path + file
+            end
+
+            FileUtils.cp_r(Dir.glob(@template_path + '/js/libs/'), @target_path + '/js/')
+
+            css_img = ["/css", "/img"]
+            css_img.each do |file|
+                FileUtils.cp_r(Dir.glob(@template_path + file), @target_path)
+            end
+
+            # comments to display
+            print "created ".green
+            puts BackboneGenerator.option_details[:app_name] + "/css/main.css"
+            print "created ".green
+            puts BackboneGenerator.option_details[:app_name] + "/img/backbone.png"
+        end
+
+        def copy_compiled_files
+            templates_hash = {
+                "/README.tt"               => "/README.md",
+                "/main.tt"                 => "/js/app.js",
+                "/js/views/Main.View.tt"   => "/js/views/Main.View.js"
+            }
+            templates_hash.each do |key, value|
+                BackboneGenerator.compile_and_copy(@template_path + key, @target_path + value, BackboneGenerator.option_details)
+                print "created ".green
+                puts BackboneGenerator.option_details[:app_name] + value
+            end
+
+            BackboneGenerator::ViewGenerator.create_view("hello")
+            BackboneGenerator::ModelGenerator.create_model("hello")
+            BackboneGenerator::CollectionGenerator.create_collection("hello")
+            BackboneGenerator::RouteGenerator.create_route(BackboneGenerator.option_details[:app_name])
+            BackboneGenerator::UtilityGenerator.create_utility(BackboneGenerator.option_details[:app_name])
+            # This is some hacky stuff! Will remove in future release, Beacuse
+            # the initial template contains a special message from me, there got 
+            # to be a way to replace the message so that it only appears the first time
+            # to resolve this problem, I am simply going to override the contents
+            # of the file with a standard default template
+            open(File.expand_path("..",File.dirname(__FILE__)) + "/templates/template/Template.tt", 'w') do |f|
+                f.puts '<p> I am the template for <%= config[:template_name] %> </p>'
+            end
+
+        end
+    end
+end