Initial structure + build process

Author: toastercup

.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

.gitignore

@@ -0,0 +1,39 @@
+# IDEs
+*.sublime-*
+.idea
+
+# Built project
+dist
+
+# Caches
+.sass-cache
+
+# Test
+/selenium
+test-results-*.xml
+
+# Logs
+logs
+*.log
+
+# Runtime data
+pids
+*.pid
+*.seed
+.tmp
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# node-waf configuration
+.lock-wscript
+
+# Dependency directories
+node_modules
+bower_components

README.md

@@ -0,0 +1,27 @@
+# Content Snippets
+
+A tool to enable in-page editing of elements, with an adaptable content backend. Drop this into a Web page, compose with a content adapter and credentials via a server framework of your choosing, and begin editing!
+
+### Building/Watching
+
+Install some global dependencies, then project dependencies:
+
+```sh
+$ npm -g install bower gulp
+$ npm install
+$ bower install
+```
+
+Now you can build or watch the project! Built and Compiled assets will be plopped into the `dist` directory.
+
+```sh
+$ gulp build
+or
+$ gulp watch
+or, to minify assets:
+$ gulp compile
+````
+
+### Configuration
+
+Coming soon..

bower.json

@@ -0,0 +1,18 @@
+{
+  "name": "content-snippets",
+  "version": "0.0.1",
+  "ignore": [
+    "**/.*",
+    "node_modules",
+    "components"
+  ],
+  "dependencies": {
+    "riot": "~2.0.15",
+    "q": "~1.3.0",
+    "qajax": "git@github.com:cb-talent-development/qajax#master",
+    "underscore": "1.8.3"
+  },
+  "resolutions": {
+    "q": "~1.3.0"
+  }
+}

gulpfile.js

@@ -0,0 +1,104 @@
+'use strict';
+
+var applicationName = 'content-snippets',
+  basePaths = {
+    src: 'src/app/',
+    dest: 'dist/'
+  },
+  paths = {
+    scripts: {
+      src: basePaths.src,
+      dest: basePaths.dest
+    },
+    styles: {
+      src: basePaths.src + 'sass/',
+      dest: basePaths.dest
+    }
+  },
+  appFiles = {
+    styles: paths.styles.src,
+    scripts: paths.scripts.src + '**/*.js'
+  },
+  vendorFiles = {
+    scripts: 'src/vendor/**/*.js'
+  },
+  destFilenames = {
+    script: applicationName + '.js',
+    style: applicationName + '.css',
+    scriptMin: applicationName + '.min.js',
+    styleMin: applicationName + '.min.css'
+  },
+  gulp = require('gulp'),
+  es = require('event-stream'),
+  bowerFiles = require('main-bower-files'),
+  plugins = require("gulp-load-plugins")({
+    pattern: ['gulp-*', 'gulp.*'],
+    replaceString: /\bgulp[\-.]/
+  });
+
+var changeEvent = function (evt) {
+  plugins.util.log('File', plugins.util.colors.cyan(evt.path.replace(new RegExp('/.*(?=/' + basePaths.src + ')/'), '')), 'was', plugins.util.colors.magenta(evt.type));
+};
+
+var scriptsStream = function () {
+  return gulp.src([appFiles.scripts, vendorFiles.scripts, '!**/tags/**']);
+};
+
+var riotStream = function () {
+  return gulp.src('**/tags/**')
+    .pipe(plugins.riot());
+};
+
+var bowerStream = function () {
+  return gulp.src(bowerFiles({
+    filter: '**/*.js'
+  }));
+};
+
+gulp.task('sass', function () {
+  return plugins.rubySass(appFiles.styles)
+    .on('error', function (err) {
+      new plugins.util.PluginError('SASS', err, {showStack: true});
+    })
+    .pipe(plugins.concat(destFilenames.style))
+    .pipe(plugins.autoprefixer('last 2 versions', 'safari 5', 'ie 8', 'ie 9', 'opera 12.1', 'ios 6', 'android 4', 'Firefox >= 4'))
+    .pipe(plugins.size())
+    .pipe(gulp.dest(paths.styles.dest));
+});
+
+gulp.task('scripts', function () {
+  return es.merge(scriptsStream(), riotStream(), bowerStream())
+    .pipe(plugins.concat(destFilenames.script))
+    .pipe(plugins.size())
+    .pipe(gulp.dest(paths.scripts.dest));
+});
+
+gulp.task('minify-css', ['sass'], function () {
+  return gulp.src(paths.styles.dest + destFilenames.style)
+    .pipe(plugins.combineMq())
+    .pipe(plugins.minifyCss())
+    .pipe(plugins.rename(destFilenames.styleMin))
+    .pipe(gulp.dest(paths.styles.dest));
+});
+
+gulp.task('minify-scripts', ['scripts'], function () {
+  return gulp.src(paths.scripts.dest + destFilenames.script)
+    .pipe(plugins.uglify())
+    .pipe(plugins.rename(destFilenames.scriptMin))
+    .pipe(gulp.dest(paths.scripts.dest));
+});
+
+gulp.task('build', ['sass', 'scripts']);
+
+gulp.task('watch', ['build'], function () {
+  gulp.watch(appFiles.styles + '**/*.scss', ['sass']).on('change', function (evt) {
+    changeEvent(evt);
+  });
+  gulp.watch([appFiles.scripts, vendorFiles.scripts], ['scripts']).on('change', function (evt) {
+    changeEvent(evt);
+  });
+});
+
+gulp.task('compile', ['minify-scripts', 'minify-css']);
+
+gulp.task('default', ['build']);

package.json

@@ -0,0 +1,34 @@
+{
+  "name": "content-snippets",
+  "version": "0.0.1",
+  "description": "A tool to enable in-page editing of elements, with an adaptable content backend",
+  "author": "Alex Tharp <toastercup@gmail.com>",
+  "license": "MIT",
+  "repository": "git://github.com/toastercup/content-snippets.git",
+  "keywords": [
+    "editable",
+    "snippet",
+    "cms",
+    "content"
+  ],
+  "devDependencies": {
+    "event-stream": "~3.3.0",
+    "main-bower-files": "~2.7.0",
+    "gulp": "~3.8.11",
+    "gulp-load-plugins": "~0.10.0",
+    "gulp-autoprefixer": "~2.2.0",
+    "gulp-concat": "~2.5.2",
+    "gulp-ruby-sass": "~1.0.5",
+    "gulp-riot": "~0.2.14",
+    "gulp-size": "~1.2.1",
+    "gulp-util": "~3.0.4",
+    "gulp-uglify": "~1.2.0",
+    "gulp-combine-mq": "~0.4.0",
+    "gulp-minify-css": "~1.1.1",
+    "gulp-rename": "~1.2.2",
+    "gulp-ignore": "~1.2.1"
+  },
+  "engines": {
+    "node": ">=0.10.0"
+  }
+}

src/app/constants.js

@@ -0,0 +1,11 @@
+(function(global) {
+  'use strict';
+
+  global.ACTIONS = {
+  };
+
+  global.settings = {
+    API_ROUTES: {
+    }
+  };
+}(this));

src/app/main.js

@@ -0,0 +1,11 @@
+(function(global) {
+  var stores = {
+  };
+
+  for (var k in stores) {
+    RiotControl.addStore(stores[k]);
+  }
+
+  global.stores = stores;
+
+}(this));

src/app/sass/main.scss

@@ -0,0 +1,46 @@
+(function(global) {
+  'use strict';
+
+  var csrf = document.querySelector("meta[name='csrf-token']").attributes['content'].value;
+
+  function Api(baseUrl) {
+    this.baseUrl = baseUrl || window.location.origin;
+  }
+
+  Api.prototype._request = function(config) {
+    config.headers = config.headers || {};
+
+    if (csrf) {
+      config.headers['X-CSRF-Token'] = csrf;
+    }
+
+    config.headers['Accept'] = 'application/json,text/html';
+
+    return Qajax(config)
+      .then(Qajax.filterSuccess)
+      .then(Qajax.toJSON);
+  };
+
+  Api.prototype.get = function(path) {
+    return this._request({url: this.baseUrl + path, method: 'GET'})
+  };
+
+  Api.prototype.post = function(path, data) {
+    return this._request({url: this.baseUrl + path, method: 'POST', data: data});
+  };
+
+  Api.prototype.delete = function(path) {
+    return Qajax({url: this.baseUrl + path, method: 'DELETE'}).then(Qajax.filterSuccess);
+  };
+
+  Api.prototype.put = function(path, data) {
+    return this._request({url: this.baseUrl + path, method: 'PUT', data: data});
+  };
+
+  Api.prototype.patch = function(path, data) {
+    return this._request({url: this.baseUrl + path, method: 'PATCH', data: data});
+  };
+
+  global.Api = Api;
+
+}(this));

src/app/stores/.keep

@@ -0,0 +1,18 @@
+// https://github.com/nivardus/riot-fluxable-tag
+// Unregisters callbacks on tag unmount
+function fluxableTag(tag, dispatcher) {
+  // callback lookup {fn: 'action'}
+  var callbacks = {};
+
+  tag.on('unmount', function() {
+    for (var fn in callbacks) {
+      dispatcher.off(callbacks[fn], fn);
+    }
+  });
+
+  tag.when = function(action, fn) {
+    fn = fn.bind(tag);
+    dispatcher.on(action, fn);
+    callbacks[fn] = action;
+  };
+}

src/app/tags/.keep

@@ -0,0 +1,16 @@
+// https://github.com/jimsparkman/RiotControl
+var RiotControl = {
+  _stores: [],
+  addStore: function(store) {
+    this._stores.push(store);
+  }
+};
+
+['on','one','off','trigger'].forEach(function(api){
+  RiotControl[api] = function() {
+    var args = [].slice.call(arguments);
+    this._stores.forEach(function(el){
+      el[api].apply(null, args);
+    });
+  };
+});