Sorry, but the page you were trying to view does not exist.
141 |It looks like this was the result of either:
142 |HTML5 Boilerplate is a professional front-end template for building fast, robust, and adaptable web apps or sites.
53 | 54 |Sleek, intuitive, and powerful mobile first front-end framework for faster and easier web development.
56 | 57 | <% if (includeModernizr) { -%> 58 |Modernizr is an open-source JavaScript library that helps you build the next generation of HTML5 and CSS3-powered websites.
60 | <% } -%> 61 |Backbone.js gives structure to web applications by providing models, collections, views and connects it all to your existing API over a RESTful JSON interface.
65 | 66 |A utility library delivering consistency, customization, performance, & extras.
68 | 69 | <% if (includeRequireJS) { -%> 70 |RequireJS is a JavaScript file and module loader. It is optimized for in-browser use, but it can be used in other JavaScript environments, like Rhino and Node.
72 | <% } -%> 73 |You now have
85 |Your content here.
2 | 3 | -------------------------------------------------------------------------------- /generators/templates/collection.js: -------------------------------------------------------------------------------- 1 | /*global <%= appClassName %>, Backbone*/ 2 | 3 | <%= appClassName %>.Collections = <%= appClassName %>.Collections || {}; 4 | 5 | (function () { 6 | 'use strict'; 7 | 8 | <%= appClassName %>.Collections.<%= className %> = Backbone.Collection.extend({ 9 | 10 | model: <%= appClassName %>.Models.<%= className %> 11 | 12 | }); 13 | 14 | })(); 15 | -------------------------------------------------------------------------------- /generators/templates/model.js: -------------------------------------------------------------------------------- 1 | /*global <%= appClassName %>, Backbone*/ 2 | 3 | <%= appClassName %>.Models = <%= appClassName %>.Models || {}; 4 | 5 | (function () { 6 | 'use strict'; 7 | 8 | <%= appClassName %>.Models.<%= className %> = Backbone.Model.extend({ 9 | 10 | url: '', 11 | 12 | initialize: function() { 13 | }, 14 | 15 | defaults: { 16 | }, 17 | 18 | validate: function(attrs, options) { 19 | }, 20 | 21 | parse: function(response, options) { 22 | return response; 23 | } 24 | }); 25 | 26 | })(); 27 | -------------------------------------------------------------------------------- /generators/templates/requirejs/collection.js: -------------------------------------------------------------------------------- 1 | /*global define*/ 2 | 3 | define([ 4 | 'underscore', 5 | 'backbone', 6 | 'models/<%= className %>' 7 | ], function (_, Backbone, <%= className %>Model) { 8 | 'use strict'; 9 | 10 | var <%= className %>Collection = Backbone.Collection.extend({ 11 | model: <%= className %>Model 12 | }); 13 | 14 | return <%= className %>Collection; 15 | }); 16 | -------------------------------------------------------------------------------- /generators/templates/requirejs/model.js: -------------------------------------------------------------------------------- 1 | /*global define*/ 2 | 3 | define([ 4 | 'underscore', 5 | 'backbone' 6 | ], function (_, Backbone) { 7 | 'use strict'; 8 | 9 | var <%= className %>Model = Backbone.Model.extend({ 10 | url: '', 11 | 12 | initialize: function() { 13 | }, 14 | 15 | defaults: { 16 | }, 17 | 18 | validate: function(attrs, options) { 19 | }, 20 | 21 | parse: function(response, options) { 22 | return response; 23 | } 24 | }); 25 | 26 | return <%= className %>Model; 27 | }); 28 | -------------------------------------------------------------------------------- /generators/templates/requirejs/router.js: -------------------------------------------------------------------------------- 1 | /*global define*/ 2 | 3 | define([ 4 | 'jquery', 5 | 'backbone' 6 | ], function ($, Backbone) { 7 | 'use strict'; 8 | 9 | var <%= className %>Router = Backbone.Router.extend({ 10 | routes: { 11 | } 12 | 13 | }); 14 | 15 | return <%= className %>Router; 16 | }); 17 | -------------------------------------------------------------------------------- /generators/templates/requirejs/view.js: -------------------------------------------------------------------------------- 1 | /*global define*/ 2 | 3 | define([ 4 | 'jquery', 5 | 'underscore', 6 | 'backbone', 7 | 'templates' 8 | ], function ($, _, Backbone, JST) { 9 | 'use strict'; 10 | 11 | var <%= className %>View = Backbone.View.extend({ 12 | template: JST['<%= jst_path %>'], 13 | 14 | tagName: 'div', 15 | 16 | id: '', 17 | 18 | className: '', 19 | 20 | events: {}, 21 | 22 | initialize: function () { 23 | this.listenTo(this.model, 'change', this.render); 24 | }, 25 | 26 | render: function () { 27 | this.$el.html(this.template(this.model.toJSON())); 28 | } 29 | }); 30 | 31 | return <%= className %>View; 32 | }); 33 | -------------------------------------------------------------------------------- /generators/templates/router.js: -------------------------------------------------------------------------------- 1 | /*global <%= appClassName %>, Backbone*/ 2 | 3 | <%= appClassName %>.Routers = <%= appClassName %>.Routers || {}; 4 | 5 | (function () { 6 | 'use strict'; 7 | 8 | <%= appClassName %>.Routers.<%= className %> = Backbone.Router.extend({ 9 | 10 | }); 11 | 12 | })(); 13 | -------------------------------------------------------------------------------- /generators/templates/view.ejs: -------------------------------------------------------------------------------- 1 |Your content here.
2 | 3 | -------------------------------------------------------------------------------- /generators/templates/view.js: -------------------------------------------------------------------------------- 1 | /*global <%= appClassName %>, Backbone, JST*/ 2 | 3 | <%= appClassName %>.Views = <%= appClassName %>.Views || {}; 4 | 5 | (function () { 6 | 'use strict'; 7 | 8 | <%= appClassName %>.Views.<%= className %> = Backbone.View.extend({ 9 | 10 | template: JST['<%= jst_path %>'], 11 | 12 | tagName: 'div', 13 | 14 | id: '', 15 | 16 | className: '', 17 | 18 | events: {}, 19 | 20 | initialize: function () { 21 | this.listenTo(this.model, 'change', this.render); 22 | }, 23 | 24 | render: function () { 25 | this.$el.html(this.template(this.model.toJSON())); 26 | } 27 | 28 | }); 29 | 30 | })(); 31 | -------------------------------------------------------------------------------- /generators/view/index.js: -------------------------------------------------------------------------------- 1 | /*jshint latedef:false */ 2 | var path = require('path'); 3 | var util = require('util'); 4 | var pascalCase = require('pascal-case'); 5 | var yeoman = require('yeoman-generator'); 6 | var scriptBase = require('../../script-base'); 7 | 8 | var ViewGenerator = scriptBase.extend({ 9 | constructor: function () { 10 | scriptBase.apply(this, arguments); 11 | 12 | var dirPath = this.options.coffee ? '../templates/coffeescript/' : '../templates'; 13 | this.sourceRoot(path.join(__dirname, dirPath)); 14 | }, 15 | 16 | writing: { 17 | createViewFiles: function () { 18 | var templateFramework = this.config.get('templateFramework') || 'lodash'; 19 | var templateExt = '.ejs'; 20 | if (templateFramework === 'mustache') { 21 | templateExt = '-template.mustache'; 22 | } else if (templateFramework === 'handlebars') { 23 | templateExt = '.hbs'; 24 | } 25 | this.jst_path = this.env.options.appPath + '/scripts/templates/' + this.name + templateExt; 26 | 27 | this.template('view.ejs', this.jst_path); 28 | if (templateFramework === 'mustache') { 29 | this.jst_path = this.name + '-template'; 30 | } 31 | 32 | this._writeTemplate( 33 | 'view', 34 | path.join(this.env.options.appPath + '/scripts/views', this.name), 35 | { 36 | appClassName: pascalCase(this.appname), 37 | className: pascalCase(this.name), 38 | 'jst_path': this.jst_path 39 | } 40 | ); 41 | 42 | if (!this.options.requirejs) { 43 | this._addScriptToIndex('views/' + this.name); 44 | } 45 | }, 46 | 47 | composeTest: function () { 48 | this._generateTest('view'); 49 | } 50 | } 51 | }); 52 | 53 | module.exports = ViewGenerator; 54 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "generator-backbone", 3 | "version": "0.4.2", 4 | "description": "Scaffold out a Backbone.js project", 5 | "keywords": [ 6 | "yeoman-generator", 7 | "scaffold", 8 | "framework", 9 | "mvc", 10 | "backbone" 11 | ], 12 | "author": "Yeoman", 13 | "main": "generators/app/index.js", 14 | "repository": "yeoman/generator-backbone", 15 | "scripts": { 16 | "test": "mocha --reporter spec" 17 | }, 18 | "dependencies": { 19 | "ejs": "^2.3.0", 20 | "html-wiring": "^1.0.0", 21 | "mkdirp": "^0.5.1", 22 | "param-case": "^1.1.0", 23 | "pascal-case": "^1.1.0", 24 | "yeoman-generator": "^0.21.1" 25 | }, 26 | "peerDependencies": { 27 | "generator-mocha": ">=0.1.3", 28 | "generator-backbone-mocha": ">=0.0.2" 29 | }, 30 | "devDependencies": { 31 | "mocha": "*" 32 | }, 33 | "engines": { 34 | "node": ">=0.10.0" 35 | }, 36 | "license": "BSD", 37 | "files": [ 38 | "generators/all", 39 | "generators/app", 40 | "generators/collection", 41 | "generators/model", 42 | "generators/router", 43 | "generators/templates", 44 | "generators/view", 45 | "script-base.js", 46 | "util.js" 47 | ] 48 | } 49 | -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 | # Backbone.js generator [](http://travis-ci.org/yeoman/generator-backbone) [](https://coveralls.io/r/yeoman/generator-backbone?branch=master) 2 | 3 | A Backbone generator for Yeoman that provides a functional boilerplate Backbone app out of the box. You also get access to a number of sub-generators which can be used to easily create individual models, views, collections and so on. 4 | 5 | Optional RequireJS (AMD) support has recently been added as a prompt when using the generator on new projects. 6 | 7 | 8 | ## Usage 9 | 10 | Install: `npm install -g generator-backbone` 11 | 12 | Make a new directory and `cd` into it: 13 | ``` 14 | mkdir my-new-project && cd $_ 15 | ``` 16 | 17 | Run `yo backbone`, optionally passing an app name: 18 | ``` 19 | yo backbone [app-name] 20 | ``` 21 | 22 | ## Generators 23 | 24 | Available generators: 25 | 26 | - backbone:model 27 | - backbone:view 28 | - backbone:collection 29 | - backbone:router 30 | - backbone:all 31 | 32 | ## Typical workflow 33 | 34 | ``` 35 | yo backbone # generates your application base and build workflow 36 | yo backbone:model blog 37 | yo backbone:collection blog 38 | yo backbone:router blog 39 | yo backbone:view blog 40 | grunt serve 41 | ``` 42 | 43 | Also checkout this [NetTuts write-up](http://net.tutsplus.com/tutorials/javascript-ajax/building-apps-with-the-yeoman-workflow/) for a guide to building Backbone.js apps using this generator. 44 | 45 | 46 | ## Options 47 | 48 | * `--appPath` 49 | 50 | Generate scaffold into a custom directory. 51 | 52 | * `--coffee` 53 | 54 | Generate scaffolds in CoffeeScript. By default check if project uses CoffeeScript. 55 | 56 | * `--requirejs` 57 | 58 | Generate scaffolds using RequireJS (AMD) Loader. By default check if project uses RequireJS. 59 | 60 | * `--skip-install` 61 | 62 | Skips the automatic execution of `bower` and `npm` after 63 | scaffolding has finished. 64 | 65 | * `--test-framework=[framework]` 66 | 67 | Defaults to `mocha`. Can be switched for 68 | another supported testing framework like `jasmine`. 69 | 70 | * `--template-framework=[framework]` 71 | 72 | Defaults to `lodash` templating with grunt-contrib-jst. 73 | `handlebars` and `mustache` are also supported. 74 | 75 | ## A note regarding JST templates and strict mode 76 | 77 | If you use strict mode in your app and JST templates the default grunt-jst implementation will cause your app to error out as the templates will be precompiled using a 'with' statement. 78 | 79 | This can be addressed by changing the jst grunt task as follows: 80 | 81 | ``` 82 | jst: { 83 | compile: { 84 | options: 85 | { 86 | templateSettings: 87 | { 88 | variable: 'data' 89 | } 90 | }, 91 | files: { 92 | '.tmp/scripts/templates.js': ['<%= yeoman.app %>/scripts/templates/*.ejs'] 93 | } 94 | } 95 | }, 96 | ``` 97 | A result of this change is that your template variable definitions must also be updated from `<%= templateVariable %>` to `<%= data.templateVariable %>`. More information on this can be found in the [Underscore documentation](http://underscorejs.org/#template). 98 | 99 | ## Contribute 100 | 101 | See the [contributing docs](https://github.com/yeoman/yeoman/blob/master/contributing.md) 102 | 103 | When submitting an issue, please follow the [guidelines](https://github.com/yeoman/yeoman/blob/master/contributing.md#issue-submission). Especially important is to make sure Yeoman is up-to-date, and providing the command or commands that cause the issue. 104 | 105 | When submitting a bugfix, write a test that exposes the bug and fails before applying your fix. Submit the test alongside the fix. 106 | 107 | When submitting a new feature, add tests that cover the feature. 108 | 109 | 110 | ## License 111 | 112 | [BSD license](http://opensource.org/licenses/bsd-license.php) 113 | -------------------------------------------------------------------------------- /script-base.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | var path = require('path'); 3 | var util = require('util'); 4 | var yeoman = require('yeoman-generator'); 5 | var backboneUtils = require('./util.js'); 6 | 7 | var ScriptBase = yeoman.generators.NamedBase.extend({ 8 | constructor: function (name) { 9 | yeoman.generators.NamedBase.apply(this, arguments); 10 | 11 | this.appname = this.config.get('appName') || path.basename(process.cwd()); 12 | this.env.options.appPath = this.config.get('appPath') || 'app'; 13 | 14 | this.options.coffee = this.config.get('coffee') || false; 15 | 16 | if (typeof this.env.options.coffee === 'undefined') { 17 | this.env.options.coffee = this.options.coffee; 18 | } 19 | 20 | // check if --requirejs option provided or if require is setup 21 | if (typeof this.env.options.requirejs === 'undefined') { 22 | this.option('requirejs'); 23 | 24 | this.options.requirejs = this.config.get('includeRequireJS') || false; 25 | 26 | this.env.options.requirejs = this.options.requirejs; 27 | } 28 | 29 | }, 30 | 31 | _addScriptToIndex: function (script) { 32 | try { 33 | var appPath = this.env.options.appPath; 34 | var fullPath = this.destinationPath(path.join(appPath, 'index.html')); 35 | 36 | backboneUtils.rewriteFile({ 37 | file: fullPath, 38 | needle: '', 39 | splicable: [ 40 | '' 41 | ] 42 | }); 43 | } catch (e) { 44 | this.log('\n Unable to find ' + fullPath + '. Reference to ' + script + '.js ' + 'not added.\n'); 45 | } 46 | }, 47 | 48 | _setupSourceRootAndSuffix: function () { 49 | var sourceRoot = '/generators/templates'; 50 | this.scriptSuffix = '.js'; 51 | 52 | if (this.env.options.coffee || this.options.coffee) { 53 | sourceRoot = '/generators/templates/coffeescript'; 54 | this.scriptSuffix = '.coffee'; 55 | } 56 | 57 | if (this.env.options.requirejs || this.options.requirejs) { 58 | sourceRoot += '/requirejs'; 59 | } 60 | 61 | this.sourceRoot(path.join(__dirname, sourceRoot)); 62 | }, 63 | 64 | _writeTemplate: function (source, destination, data) { 65 | 66 | this._setupSourceRootAndSuffix(); 67 | var ext = this.scriptSuffix; 68 | this.fs.copyTpl( 69 | this.templatePath(source + ext), 70 | this.destinationPath(destination + ext), 71 | data 72 | ); 73 | }, 74 | 75 | _canGenerateTests: function () { 76 | return this.config.get('testFramework') === 'mocha' && !this.config.get('includeRequireJS'); 77 | }, 78 | 79 | _generateTest: function (type) { 80 | if (this._canGenerateTests()) { 81 | this.composeWith('backbone-mocha:' + type, { arguments: [this.name] }, { 82 | coffee: this.config.get('coffee'), 83 | ui: this.config.get('ui') 84 | }); 85 | } 86 | } 87 | }); 88 | 89 | module.exports = ScriptBase; 90 | -------------------------------------------------------------------------------- /test/helper.js: -------------------------------------------------------------------------------- 1 | var yeoman = require('yeoman-generator'); 2 | var helpers = yeoman.test; 3 | var path = require('path'); 4 | var fs = require('fs'); 5 | 6 | exports.createSubGenerator = function (config, type, asserts, deps) { 7 | deps = deps || []; 8 | helpers.run(path.join(__dirname, '../generators/' + type)) 9 | .inDir(path.join(__dirname, 'temp'), function () { 10 | fs.writeFileSync('.yo-rc.json', config); 11 | }) 12 | .withArguments(['foo']) 13 | .withGenerators(deps) 14 | .on('end', asserts); 15 | }; 16 | 17 | exports.createAppGenerator = function (config, prompts, done) { 18 | 19 | prompts = prompts || { features: ['sassBootstrap']}; 20 | 21 | var options = { skipInstall: true }; 22 | 23 | var deps = [ 24 | [helpers.createDummyGenerator(), 'mocha:app'] 25 | ]; 26 | helpers.run(path.join(__dirname, '../generators/app')) 27 | .inDir(path.join(__dirname, 'temp'), function () { 28 | fs.writeFileSync('.yo-rc.json', config); 29 | }) 30 | .withPrompts(prompts) 31 | .withOptions(options) 32 | .withGenerators(deps) 33 | .on('end', done); 34 | }; 35 | -------------------------------------------------------------------------------- /test/test-apppath.js: -------------------------------------------------------------------------------- 1 | /*global describe:true, beforeEach:true, it:true */ 2 | 'use strict'; 3 | var path = require('path'); 4 | var yeoman = require('yeoman-generator'); 5 | var helpers = yeoman.test; 6 | var assert = yeoman.assert; 7 | var fs = require('fs'); 8 | var test = require('./helper.js'); 9 | 10 | var config = [ 11 | '{', 12 | ' "generator-backbone": {', 13 | ' "appPath": "public",', 14 | ' "appName": "Temp"', 15 | ' }', 16 | '}' 17 | ].join('\n'); 18 | 19 | describe('backbone generator with appPath option', function () { 20 | beforeEach(function (done) { 21 | var deps = [ 22 | [helpers.createDummyGenerator(), 'mocha:app'] 23 | ]; 24 | helpers.run(path.join(__dirname, '../generators/app')) 25 | .inTmpDir(function () { 26 | fs.writeFileSync('.yo-rc.json', config); 27 | }) 28 | .withArguments(['temp']) 29 | .withOptions({skipInstall: true, appPath: 'public'}) 30 | .withPrompts({features: ['sassBootstrap']}) 31 | .withGenerators(deps) 32 | .on('end', done); 33 | 34 | }); 35 | 36 | describe('create expected files', function () { 37 | it('in path specified by --appPath', function () { 38 | var expectedContent = [ 39 | ['bower.json', /"name": "temp"/], 40 | ['Gruntfile.js', /app: 'public'/] 41 | ]; 42 | 43 | var expected = [ 44 | 'public/404.html', 45 | 'public/favicon.ico', 46 | 'public/robots.txt', 47 | 'public/index.html', 48 | '.gitignore', 49 | '.gitattributes', 50 | '.bowerrc', 51 | '.jshintrc', 52 | '.editorconfig', 53 | '.yo-rc.json', 54 | 'public/scripts/main.js', 55 | 'public/styles/main.scss' 56 | ]; 57 | 58 | assert.file(expected); 59 | assert.fileContent(expectedContent); 60 | }); 61 | }); 62 | 63 | describe('creates model', function () { 64 | it('without failure', function (done) { 65 | test.createSubGenerator(config, 'model', function () { 66 | assert.fileContent( 67 | 'public/scripts/models/foo.js', /Models.Foo = Backbone.Model.extend\(\{/ 68 | ); 69 | done(); 70 | }); 71 | }); 72 | }); 73 | 74 | describe('creates collection', function () { 75 | it('without failure', function (done) { 76 | test.createSubGenerator(config, 'collection', function () { 77 | assert.fileContent( 78 | 'public/scripts/collections/foo.js', /Collections.Foo = Backbone.Collection.extend\(\{/ 79 | ); 80 | done(); 81 | }); 82 | }); 83 | }); 84 | 85 | describe('creates router', function () { 86 | it('without failure', function (done) { 87 | test.createSubGenerator(config, 'router', function () { 88 | assert.fileContent( 89 | 'public/scripts/routes/foo.js', /Routers.Foo = Backbone.Router.extend\(\{/ 90 | ); 91 | done(); 92 | }); 93 | }); 94 | }); 95 | 96 | describe('creates view', function () { 97 | it('without failure', function (done) { 98 | 99 | test.createSubGenerator(config, 'view', function () { 100 | assert.fileContent( 101 | 'public/scripts/views/foo.js', /Views.Foo = Backbone.View.extend\(\{(.|\n)*public\/scripts\/templates\/foo.ejs/ 102 | ); 103 | assert.file('public/scripts/templates/foo.ejs'); 104 | done(); 105 | }); 106 | }); 107 | }); 108 | 109 | }); 110 | -------------------------------------------------------------------------------- /test/test-coffee-requirejs.js: -------------------------------------------------------------------------------- 1 | /*global describe:true, beforeEach:true, it:true */ 2 | 'use strict'; 3 | var path = require('path'); 4 | var yeoman = require('yeoman-generator'); 5 | var helpers = yeoman.test; 6 | var assert = yeoman.assert; 7 | var fs = require('fs'); 8 | var test = require('./helper.js'); 9 | 10 | var config = [ 11 | '{', 12 | ' "generator-backbone": {', 13 | ' "appPath": "app",', 14 | ' "appName": "Temp",', 15 | ' "coffee": "true",', 16 | ' "includeRequireJS": "true"', 17 | ' }', 18 | '}' 19 | ].join('\n'); 20 | 21 | describe('Backbone generator test with --coffee and --requirejs option', function () { 22 | beforeEach(function (done) { 23 | 24 | var prompts = { 25 | features: ['sassBootstrap', 'coffee', 'requirejs'] 26 | }; 27 | 28 | test.createAppGenerator(config, prompts, done); 29 | }); 30 | 31 | it('creates expected files', function () { 32 | var expectedContent = [ 33 | ['bower.json', /("name": "temp")(|.|\n)*(requirejs)/], 34 | ['app/index.html', /(Bootstrap)(|.|\n)*(RequireJS)/i] 35 | ]; 36 | var expected = [ 37 | 'Gruntfile.js', 38 | 'app/404.html', 39 | 'app/favicon.ico', 40 | 'app/robots.txt', 41 | '.gitignore', 42 | '.gitattributes', 43 | '.bowerrc', 44 | '.jshintrc', 45 | '.editorconfig', 46 | '.yo-rc.json', 47 | 'app/scripts/main.coffee' 48 | ]; 49 | 50 | assert.file(expected); 51 | assert.fileContent(expectedContent); 52 | 53 | }); 54 | 55 | describe('creates model in coffeescript with rjs', function () { 56 | it('without failure', function (done) { 57 | 58 | test.createSubGenerator(config, 'model', function () { 59 | assert.fileContent( 60 | 'app/scripts/models/foo.coffee', /class FooModel extends Backbone.Model/ 61 | ); 62 | done(); 63 | }); 64 | }); 65 | }); 66 | 67 | describe('creates collection in coffeescript with rjs', function () { 68 | it('without failure', function (done) { 69 | 70 | test.createSubGenerator(config, 'collection', function () { 71 | assert.fileContent( 72 | 'app/scripts/collections/foo.coffee', /class FooCollection extends Backbone.Collection/ 73 | ); 74 | done(); 75 | }); 76 | }); 77 | }); 78 | 79 | describe('creates router in coffeescript with rjs', function () { 80 | it('without failure', function (done) { 81 | 82 | test.createSubGenerator(config, 'router', function () { 83 | assert.fileContent( 84 | 'app/scripts/routes/foo.coffee', /class FooRouter extends Backbone.Router/ 85 | ); 86 | done(); 87 | }); 88 | 89 | }); 90 | }); 91 | 92 | describe('creates view in coffeescript with rjs', function () { 93 | it('without failure', function (done) { 94 | 95 | test.createSubGenerator(config, 'view', function () { 96 | assert.fileContent( 97 | 'app/scripts/views/foo.coffee', /class FooView extends Backbone.View(.|\n)*app\/scripts\/templates\/foo.ejs/ 98 | ); 99 | assert.file('app/scripts/templates/foo.ejs'); 100 | done(); 101 | }); 102 | 103 | }); 104 | }); 105 | 106 | }); 107 | -------------------------------------------------------------------------------- /test/test-coffee.js: -------------------------------------------------------------------------------- 1 | /*global describe:true, beforeEach:true, it:true */ 2 | 'use strict'; 3 | var path = require('path'); 4 | var yeoman = require('yeoman-generator'); 5 | var helpers = yeoman.test; 6 | var assert = yeoman.assert; 7 | var fs = require('fs'); 8 | var test = require('./helper.js'); 9 | 10 | var config = [ 11 | '{', 12 | ' "generator-backbone": {', 13 | ' "appPath": "app",', 14 | ' "appName": "Temp",', 15 | ' "coffee": "true"', 16 | ' }', 17 | '}' 18 | ].join('\n'); 19 | 20 | describe('Backbone generator test with --coffee option', function () { 21 | beforeEach(function (done) { 22 | var prompts = { 23 | features: ['sassBootstrap', 'coffee'] 24 | }; 25 | 26 | test.createAppGenerator(config, prompts, done); 27 | }); 28 | 29 | it('creates expected files', function () { 30 | var expectedContent = [ 31 | ['bower.json', /"name": "temp"/] 32 | ]; 33 | var expected = [ 34 | 'Gruntfile.js', 35 | 'app/404.html', 36 | 'app/favicon.ico', 37 | 'app/robots.txt', 38 | 'app/index.html', 39 | '.gitignore', 40 | '.gitattributes', 41 | '.bowerrc', 42 | '.jshintrc', 43 | '.editorconfig', 44 | '.yo-rc.json', 45 | 'app/scripts/main.coffee' 46 | ]; 47 | 48 | assert.file(expected); 49 | assert.fileContent(expectedContent); 50 | 51 | }); 52 | 53 | describe('creates model in coffeescript', function () { 54 | it('without failure', function (done) { 55 | 56 | test.createSubGenerator(config, 'model', function () { 57 | assert.fileContent( 58 | 'app/scripts/models/foo.coffee', /class Temp.Models.Foo extends Backbone.Model/ 59 | ); 60 | done(); 61 | }); 62 | }); 63 | }); 64 | 65 | describe('creates collection in coffeescript', function () { 66 | it('without failure', function (done) { 67 | 68 | test.createSubGenerator(config, 'collection', function () { 69 | assert.fileContent( 70 | 'app/scripts/collections/foo.coffee', /class Temp.Collections.Foo extends Backbone.Collection/ 71 | ); 72 | done(); 73 | }); 74 | }); 75 | }); 76 | 77 | describe('creates router in coffeescript', function () { 78 | it('without failure', function (done) { 79 | 80 | test.createSubGenerator(config, 'router', function () { 81 | assert.fileContent( 82 | 'app/scripts/routes/foo.coffee', /class Temp.Routers.Foo extends Backbone.Router/ 83 | ); 84 | done(); 85 | }); 86 | }); 87 | }); 88 | 89 | describe('creates view in coffeescript', function () { 90 | it('without failure', function (done) { 91 | 92 | test.createSubGenerator(config, 'view', function () { 93 | assert.fileContent( 94 | 'app/scripts/views/foo.coffee', /class Temp.Views.Foo extends Backbone.View/ 95 | ); 96 | assert.file('app/scripts/templates/foo.ejs'); 97 | done(); 98 | }); 99 | }); 100 | }); 101 | }); 102 | -------------------------------------------------------------------------------- /test/test-foo.js: -------------------------------------------------------------------------------- 1 | /*global describe:true, beforeEach:true, it:true */ 2 | 'use strict'; 3 | var path = require('path'); 4 | var yeoman = require('yeoman-generator'); 5 | var helpers = yeoman.test; 6 | var assert = yeoman.assert; 7 | var fs = require('fs'); 8 | var test = require('./helper.js'); 9 | 10 | var config = [ 11 | '{', 12 | ' "generator-backbone": {', 13 | ' "appPath": "app",', 14 | ' "appName": "Temp"', 15 | ' }', 16 | '}' 17 | ].join('\n'); 18 | 19 | describe('Backbone generator test', function () { 20 | beforeEach(function (done) { 21 | var prompts = { 22 | features: ['sassBootstrap'] 23 | }; 24 | 25 | test.createAppGenerator(config, prompts, done); 26 | }); 27 | 28 | it('every generator can be required without throwing', function () { 29 | // not testing the actual run of generators yet 30 | this.all = require('../generators/all'); 31 | this.app = require('../generators/app'); 32 | this.collection = require('../generators/collection'); 33 | this.model = require('../generators/model'); 34 | this.router = require('../generators/router'); 35 | this.view = require('../generators/view'); 36 | }); 37 | 38 | describe('create expected files', function () { 39 | it('in path /app', function () { 40 | var expectedContent = [ 41 | ['bower.json', /"name": "temp"/] 42 | ]; 43 | var expected = [ 44 | 'Gruntfile.js', 45 | 'app/404.html', 46 | 'app/favicon.ico', 47 | 'app/robots.txt', 48 | 'app/index.html', 49 | '.gitignore', 50 | '.gitattributes', 51 | '.bowerrc', 52 | '.jshintrc', 53 | '.editorconfig', 54 | '.yo-rc.json', 55 | 'app/scripts/main.js', 56 | 'app/styles/main.scss' 57 | ]; 58 | 59 | assert.file(expected); 60 | assert.fileContent(expectedContent); 61 | }); 62 | }); 63 | 64 | describe('creates backbone model', function () { 65 | it('without failure', function (done) { 66 | 67 | test.createSubGenerator(config, 'model', function () { 68 | assert.fileContent( 69 | 'app/scripts/models/foo.js', /Models.Foo = Backbone.Model.extend\(\{/ 70 | ); 71 | done(); 72 | }); 73 | }); 74 | }); 75 | 76 | describe('creates backbone collection', function () { 77 | it('without failure', function (done) { 78 | 79 | test.createSubGenerator(config, 'collection', function () { 80 | assert.fileContent( 81 | 'app/scripts/collections/foo.js', /Collections.Foo = Backbone.Collection.extend\(\{/ 82 | ); 83 | done(); 84 | }); 85 | }); 86 | }); 87 | 88 | describe('creates backbone router', function () { 89 | it('without failure', function (done) { 90 | 91 | test.createSubGenerator(config, 'router', function () { 92 | assert.fileContent( 93 | 'app/scripts/routes/foo.js', /Routers.Foo = Backbone.Router.extend\(\{/ 94 | ); 95 | done(); 96 | }); 97 | }); 98 | }); 99 | 100 | describe('creates backbone view', function () { 101 | it('without failure', function (done) { 102 | 103 | test.createSubGenerator(config, 'view', function () { 104 | assert.fileContent( 105 | 'app/scripts/views/foo.js', /Views.Foo = Backbone.View.extend\(\{(.|\n)*app\/scripts\/templates\/foo.ejs/ 106 | ); 107 | assert.file('app/scripts/templates/foo.ejs'); 108 | done(); 109 | }); 110 | }); 111 | }); 112 | 113 | describe('creates backbone all', function () { 114 | it('without failure', function (done) { 115 | 116 | // mocks composed generators to test for their execution 117 | var hasBeenCalled = {}; 118 | var depNames = [ 119 | 'backbone:model', 120 | 'backbone:collection', 121 | 'backbone:router', 122 | 'backbone:view' 123 | ]; 124 | var deps = depNames.map(function (name) { 125 | return [ 126 | yeoman.Base.extend({ 127 | exec: function () { 128 | hasBeenCalled[name] = true; 129 | testDepsBeenCalled(); 130 | } 131 | }), 132 | name 133 | ]; 134 | }); 135 | 136 | // tests that all dependencies have been called, will timeout otherwise 137 | var testDepsBeenCalled = function () { 138 | var allDepsCalled = depNames.every(function (name) { 139 | return hasBeenCalled[name]; 140 | }); 141 | if (allDepsCalled) { 142 | assert(true); 143 | done(); 144 | } 145 | }; 146 | 147 | // runs backbone:all generator 148 | test.createSubGenerator(config, 'all', testDepsBeenCalled, deps); 149 | }); 150 | }); 151 | 152 | 153 | }); 154 | -------------------------------------------------------------------------------- /test/test-handlebars.js: -------------------------------------------------------------------------------- 1 | /*global describe:true, beforeEach:true, it:true */ 2 | 'use strict'; 3 | var path = require('path'); 4 | var yeoman = require('yeoman-generator'); 5 | var helpers = yeoman.test; 6 | var assert = yeoman.assert; 7 | var fs = require('fs'); 8 | var test = require('./helper.js'); 9 | 10 | var config = [ 11 | '{', 12 | ' "generator-backbone": {', 13 | ' "appPath": "app",', 14 | ' "appName": "Temp",', 15 | ' "templateFramework": "handlebars"', 16 | ' }', 17 | '}' 18 | ].join('\n'); 19 | 20 | describe('Backbone generator with handlebars', function () { 21 | 22 | describe('creates backbone view', function () { 23 | it('without failure', function (done) { 24 | 25 | test.createSubGenerator(config, 'view', function () { 26 | assert.fileContent( 27 | 'app/scripts/views/foo.js', /Views.Foo = Backbone.View.extend\(\{(.|\n)*app\/scripts\/templates\/foo.hbs/ 28 | ); 29 | assert.file('app/scripts/templates/foo.hbs'); 30 | done(); 31 | }); 32 | }); 33 | }); 34 | }); 35 | -------------------------------------------------------------------------------- /test/test-mustache.js: -------------------------------------------------------------------------------- 1 | /*global describe:true, beforeEach:true, it:true */ 2 | 'use strict'; 3 | var path = require('path'); 4 | var yeoman = require('yeoman-generator'); 5 | var helpers = yeoman.test; 6 | var assert = yeoman.assert; 7 | var fs = require('fs'); 8 | var test = require('./helper.js'); 9 | 10 | var config = [ 11 | '{', 12 | ' "generator-backbone": {', 13 | ' "appPath": "app",', 14 | ' "appName": "Temp",', 15 | ' "templateFramework": "mustache"', 16 | ' }', 17 | '}' 18 | ].join('\n'); 19 | 20 | describe('Backbone generator with mustache', function () { 21 | 22 | it('creates backbone view', function (done) { 23 | 24 | test.createSubGenerator(config, 'view', function () { 25 | assert.fileContent( 26 | 'app/scripts/views/foo.js', /Views.Foo = Backbone.View.extend\(\{(.|\n)*foo-template/ 27 | ); 28 | assert.file('app/scripts/templates/foo-template.mustache'); 29 | done(); 30 | }); 31 | }); 32 | }); 33 | -------------------------------------------------------------------------------- /test/test-requirejs.js: -------------------------------------------------------------------------------- 1 | /*global describe:true, beforeEach:true, it:true */ 2 | 'use strict'; 3 | var path = require('path'); 4 | var yeoman = require('yeoman-generator'); 5 | var helpers = yeoman.test; 6 | var assert = yeoman.assert; 7 | var fs = require('fs'); 8 | var test = require('./helper.js'); 9 | 10 | var config = [ 11 | '{', 12 | ' "generator-backbone": {', 13 | ' "appPath": "app",', 14 | ' "appName": "Temp",', 15 | ' "includeRequireJS": "true"', 16 | ' }', 17 | '}' 18 | ].join('\n'); 19 | 20 | describe('Backbone generator with RequireJS', function () { 21 | 22 | beforeEach(function (done) { 23 | var prompts = { 24 | features: ['sassBootstrap', 'requirejs'] 25 | }; 26 | test.createAppGenerator(config, prompts, done); 27 | }); 28 | 29 | describe('creates expected files', function () { 30 | it('with sassBootstrap', function () { 31 | var expectedContent = [ 32 | ['bower.json', /("name": "temp")(|.|\n)*(requirejs)/], 33 | ['app/index.html', /(Bootstrap)(|.|\n)*(RequireJS)/i], 34 | ['app/scripts/main.js', /bootstrap/] 35 | ]; 36 | var expected = [ 37 | 'Gruntfile.js', 38 | 'app/404.html', 39 | 'app/favicon.ico', 40 | 'app/robots.txt', 41 | '.gitignore', 42 | '.gitattributes', 43 | '.bowerrc', 44 | '.jshintrc', 45 | '.editorconfig' 46 | ]; 47 | 48 | assert.file(expected); 49 | assert.fileContent(expectedContent); 50 | 51 | }); 52 | 53 | it('without sassBootstrap', function () { 54 | var expectedContent = [ 55 | ['bower.json', /("name": "temp")(|.|\n)*(requirejs)/], 56 | ['Gruntfile.js', /requirejs/], 57 | ['app/index.html', /(RequireJS)/i] 58 | ]; 59 | var expected = [ 60 | 'app/404.html', 61 | 'app/favicon.ico', 62 | 'app/robots.txt', 63 | '.gitignore', 64 | '.gitattributes', 65 | '.bowerrc', 66 | '.jshintrc', 67 | '.editorconfig', 68 | '.yo-rc.json', 69 | 'Gruntfile.js', 70 | 'package.json' 71 | ]; 72 | 73 | assert.file(expected); 74 | assert.fileContent(expectedContent); 75 | }); 76 | }); 77 | 78 | describe('creates model', function () { 79 | it('without failure', function (done) { 80 | test.createSubGenerator(config, 'model', function () { 81 | assert.fileContent( 82 | 'app/scripts/models/foo.js', /var FooModel = Backbone.Model.extend\(\{/ 83 | ); 84 | done(); 85 | }); 86 | }); 87 | }); 88 | 89 | describe('creates collection', function () { 90 | it('without failure', function (done) { 91 | test.createSubGenerator(config, 'collection', function () { 92 | assert.fileContent( 93 | 'app/scripts/collections/foo.js', /var FooCollection = Backbone.Collection.extend\(\{/ 94 | ); 95 | done(); 96 | }); 97 | }); 98 | }); 99 | 100 | describe('creates router', function () { 101 | it('without failure', function (done) { 102 | test.createSubGenerator(config, 'router', function () { 103 | assert.fileContent( 104 | 'app/scripts/routes/foo.js', /var FooRouter = Backbone.Router.extend\(\{/ 105 | ); 106 | done(); 107 | }); 108 | }); 109 | }); 110 | 111 | describe('creates backbone view', function () { 112 | it('without failure', function (done) { 113 | test.createSubGenerator(config, 'view', function () { 114 | assert.fileContent( 115 | 'app/scripts/views/foo.js', /var FooView = Backbone.View.extend\(\{(.|\n)*app\/scripts\/templates\/foo.ejs/ 116 | ); 117 | assert.file('app/scripts/templates/foo.ejs'); 118 | done(); 119 | }); 120 | }); 121 | }); 122 | 123 | describe('creates script tag without usemin block', function() { 124 | it('without failure', function() { 125 | var unexpectedContent = [ 126 | ['app/index.html', /(((?!build).|\n)*requirejs)+((?!build).|\n)*?/i], 127 | ]; 128 | assert.noFileContent(unexpectedContent); 129 | }); 130 | }); 131 | }); 132 | -------------------------------------------------------------------------------- /util.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | var path = require('path'); 3 | var fs = require('fs'); 4 | 5 | function escapeRegExp(str) { 6 | return str.replace(/[\-\[\]\/\{\}\(\)\*\+\?\.\\\^\$\|]/g, '\\$&'); 7 | } 8 | 9 | function rewrite(args) { 10 | // check if splicable is already in the body text 11 | var re = new RegExp(args.splicable.map(function (line) { 12 | return '\s*' + escapeRegExp(line); 13 | }) 14 | .join('\n')); 15 | 16 | if (re.test(args.haystack)) { 17 | return args.haystack; 18 | } 19 | 20 | var lines = args.haystack.split('\n'); 21 | 22 | var otherwiseLineIndex = 0; 23 | lines.forEach(function (line, i) { 24 | if (line.indexOf(args.needle) !== -1) { 25 | otherwiseLineIndex = i; 26 | } 27 | }); 28 | 29 | var spaces = 0; 30 | while (lines[otherwiseLineIndex].charAt(spaces) === ' ') { 31 | spaces += 1; 32 | } 33 | 34 | var spaceStr = ''; 35 | while ((spaces -= 1) >= 0) { 36 | spaceStr += ' '; 37 | } 38 | 39 | lines.splice(otherwiseLineIndex, 0, args.splicable.map(function (line) { 40 | return spaceStr + line; 41 | }).join('\n')); 42 | 43 | return lines.join('\n'); 44 | } 45 | 46 | function rewriteFile(args) { 47 | args.haystack = fs.readFileSync(args.file, 'utf8'); 48 | var body = rewrite(args); 49 | 50 | fs.writeFileSync(args.file, body); 51 | } 52 | 53 | module.exports = { 54 | rewrite: rewrite, 55 | rewriteFile: rewriteFile 56 | }; 57 | --------------------------------------------------------------------------------