Bumblebee is born

CHANGES.txt

@@ -0,0 +1,19 @@
+List of changes, please add new entries at the top (with release version, once
+we have that)
+
+14-02-14
+
+Changed folder structure:
+  - moved src/libs into libs because jshint and requirejs were analyzing
+    files that we don't need to analyze
+  - renamed src into js because when the project is exported into ./dist
+    we don't need to rename anything
+
+
+12-02-2014
+
+  - first boiler-plate generated with `yo bbb` command
+  - modified structure, drawing inspiration from:
+    - https://github.com/artsy/ezel
+    - http://12factor.net/
+    - https://github.com/jkat98/benm

Gruntfile.js

@@ -0,0 +1,329 @@
+module.exports = function(grunt) {
+  'use strict';
+
+  grunt.initConfig({
+    pkg: grunt.file.readJSON('package.json'),
+
+    // Wipe out previous builds and test reporting.
+    clean: ['dist/', 'test/reports'],
+
+    // This will install libraries (client-side dependencies)
+    bower: {
+      install: {
+        options: {
+          targetDir: './src/libs'
+        }
+      }
+    },
+
+    // Run your source code through JSHint's defaults.
+    jshint: ['src/js/**/*.js'],
+
+
+    // This task uses James Burke's excellent r.js AMD builder to take all
+    // modules and concatenate them into a single file.
+    requirejs: {
+
+      baseUrl: 'src/js', // this is needed just for the 'stupid' list task
+
+      options: {
+        //baseUrl: 'src/js',
+        //mainConfigFile: 'src/js/config.js',
+        dir: 'dist/js',
+        baseUrl: 'src/js'
+        //appDir:'src/js'
+      },
+
+      release: {
+        options: {
+          generateSourceMaps: true,
+
+          optimize: 'uglify2',
+
+          // Since we bootstrap with nested `require` calls this option allows
+          // R.js to find them.
+          findNestedDependencies: true,
+
+          // Include a minimal AMD implementation shim.
+          name: '../libs/almond/almond',
+
+          // Wrap everything in an IIFE.
+          wrap: true,
+
+          // Do not preserve any license comments when working with source
+          // maps.  These options are incompatible.
+          preserveLicenseComments: false
+        }
+      }
+    },
+
+
+    // Minfiy the distribution CSS. This is of limited value to us, for two
+    // reasons: 1) css imports are not working 2) the task doesn't seem to
+    // be able to discover css files; i have filed a github issue/question
+    cssmin: {
+      combine: {
+        // without this the imports are simply eaten (though css-clean
+        // added support for imports, it doesn't seem to work
+        options: {
+           processImport: false
+        },
+        files: {
+          //cwd: 'dist',
+          'dist/css/style.min.css' : ['src/css/*.css', 'src/js/apps/**/css/*.css']
+        }
+      },
+      minify: {
+        options: {
+          mode: 'gzip',
+          report: 'min'
+        },
+        files: {
+          'dist/foo': ['./dist/src/**/*.css', '!./dist/src/**/*.min.css'],
+        }
+      },
+      test: {
+        options: {
+          mode: 'gzip',
+          report: 'min'
+        },
+        files: {
+          //expand: true,
+          //cwd: 'dist',
+          src: ['./dist/**/*.css', '!./dist/**/*.min.css'],
+          dest: 'dist/',
+          ext: '.min.css'
+        }
+      }
+    },
+
+    // sets up some environment variables; these are important
+    // only for the express task (our webserver)
+    env: {
+      options: {
+        API_ENDPOINT: 'http://adswhy:9000/solr/select',
+      },
+      dev: {
+        HOMEDIR: 'src',
+        //DEBUG: 'express:*'
+      },
+      prod: {
+        HOMEDIR: 'dist',
+      },
+    },
+
+    // start a development webserver 
+    express: {
+
+      options: {
+        // some defaults
+        background:true,
+        delay: 50000
+      },
+      dev: {
+        options: {
+          port: 8000,
+          script: 'server.js',
+        }
+      },
+      prod: {
+        options: {
+          port: 8001,
+          script: 'server.js',
+        }
+      }
+    },
+
+    // this will automatically reload webserver whenever a file is modified
+    watch: {
+      dev: {
+        files:  [ './src/js/**/*.js' ],
+        tasks:  [ 'env:dev', 'express:dev' ],
+        options: {
+          spawn: false // for grunt-contrib-watch v0.5.0+, "nospawn: true" for lower versions. Without this option specified express won't be reloaded
+        }
+      }
+    },
+
+    // modify the html based on the instructions inside the html code
+    // this can be useful to modify links to css, minified version 
+    // of javascript etc...
+    processhtml: {
+      release: {
+        files: {
+          'dist/index.html': ['dist/index.html'], // use dist as source
+          'dist/todo.html': ['dist/todo.html'],
+          'dist/example.html': ['dist/example.html']
+        }
+      }
+    },
+
+    // copy files from src into the distribution folder (but remove
+    // src top level)
+    copy: {
+      release: {
+        files: [
+          {
+            expand: true,
+            src: ['./src/**'],
+            dest: 'dist/',
+            rename: function(dest,src) {
+              //grunt.verbose.writeln('src' + src);
+              return dest + src.replace('/src/', '/');
+            }
+          }
+        ]
+      }
+    },
+
+    // compress whatever we have in the dist and 
+    // store it along-side with it (nginx can serve
+    // such content automatically)
+    compress: {
+      release: {
+        options: {
+          mode: 'gzip'
+        },
+        expand: true,
+        cwd: 'dist/',
+        src: ['**/*.js', '**/*.htm*', '**/*.css'],
+        dest: 'dist/'
+      }
+    },
+
+    // Unit testing is provided by Karma.  Change the two commented locations
+    // below to either: mocha, jasmine, or qunit.
+    karma: {
+      options: {
+        basePath: process.cwd(),
+        singleRun: true,
+        captureTimeout: 7000,
+        autoWatch: true,
+
+        reporters: ['progress', 'coverage'],
+        browsers: ['PhantomJS'],
+
+        // Change this to the framework you want to use.
+        frameworks: ['mocha'],
+
+        plugins: [
+          'karma-jasmine',
+          'karma-mocha',
+          'karma-qunit',
+          'karma-phantomjs-launcher',
+          'karma-coverage'
+        ],
+
+        preprocessors: {
+          'src/js/**/*.js': 'coverage'
+        },
+
+        coverageReporter: {
+          type: 'lcov',
+          dir: 'test/coverage'
+        },
+
+        files: [
+          // You can optionally remove this or swap out for a different expect.
+          'src/libs/chai/chai.js',
+          'src/libs/requirejs/require.js',
+          'test/runner.js',
+
+          {
+            pattern: 'src/js/**/*.*',
+            included: false
+          },
+          // Derives test framework from Karma configuration.
+          {
+            pattern: 'test/<%= karma.options.frameworks[0] %>/**/*.spec.js',
+            included: false
+          }
+
+        ]
+      },
+
+      // This creates a server that will automatically run your tests when you
+      // save a file and display results in the terminal.
+      daemon: {
+        options: {
+          singleRun: false
+        }
+      },
+
+      // This is useful for running the tests just once.
+      run: {
+        options: {
+          singleRun: true
+        }
+      }
+    },
+
+    coveralls: {
+      options: {
+        coverage_dir: 'test/coverage/PhantomJS 1.9.2 (Linux)/'
+      }
+    },
+
+    uglify: {
+      options: {
+        banner: "/*! <%= pkg.name %> <%= grunt.template.today('yyyy-mm-dd') %> */\n"
+      },
+      build: {
+        src: 'src/js/**/*.js',
+        dest: 'dist/<%= pkg.name %>.min.js'
+      }
+    }
+  });
+
+  // Basic environment config
+  grunt.loadNpmTasks('grunt-env');
+
+  // Grunt BBB tasks.
+  grunt.loadNpmTasks('grunt-bbb-requirejs'); // we use 'list' target only, requirejs will get overriden
+
+  // Grunt contribution tasks.
+  grunt.loadNpmTasks('grunt-contrib-clean');
+  grunt.loadNpmTasks('grunt-contrib-jshint');
+  grunt.loadNpmTasks('grunt-contrib-cssmin');
+  grunt.loadNpmTasks('grunt-contrib-copy');
+  grunt.loadNpmTasks('grunt-contrib-compress');
+  grunt.loadNpmTasks('grunt-contrib-uglify');
+  grunt.loadNpmTasks('grunt-contrib-requirejs');
+  grunt.loadNpmTasks('grunt-contrib-connect');
+  grunt.loadNpmTasks('grunt-express-server');
+  grunt.loadNpmTasks('grunt-contrib-watch');
+
+
+  // Third-party tasks.
+  grunt.loadNpmTasks('grunt-karma');
+  grunt.loadNpmTasks('grunt-karma-coveralls');
+  grunt.loadNpmTasks('grunt-processhtml');
+
+
+
+  // deactivated since the code is 'silly' it allows
+  // only for hardcoded targets
+  // grunt.loadNpmTasks('grunt-bbb-styles');
+
+  // Bower tasks
+  grunt.loadNpmTasks('grunt-bower-task');
+
+  // Create an aliased test task.
+  grunt.registerTask('test', ['karma:run']);
+
+  // Create an aliased test task.
+  grunt.registerTask('setup', 'Sets up the development environment', ['bower']);
+
+  // When running the default Grunt command, just lint the code.
+  grunt.registerTask('default', [
+    'dev:env',
+    'clean',
+    'jshint',
+    'copy',
+    'processhtml',
+    'requirejs',
+    //'cssmin',
+  ]);
+
+  grunt.registerTask('server', [ 'env:dev', 'express:dev', 'watch' ])
+};