sideshow 0.4.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f7676b04e9e78fe701349274d1afd4c774a3820a
+  data.tar.gz: 00bb1933e79d298dca54726581f2fa1c98005463
+SHA512:
+  metadata.gz: 25b46e11b23b60f893ae1e7cce1c61768151ac6ec26ee5833c056bc67cbe51d0fafaef9458324414ef3cb4bc69101e7a037efd054095058cd29add365e34b65a
+  data.tar.gz: 9516d1a113895f7a7d8fa10f1e61403e890b77250a7ecd8e9d8e7ec34b24d51c19cd3ee91f9b16ff273f3e532efdce1418165a28d36585b5e0a928828b5b3081

data/.bowerrc

@@ -0,0 +1,3 @@
+{
+    "directory": "bower_components"
+}

data/.csslintrc

@@ -0,0 +1,37 @@
+{
+  "important": true,
+  "adjoining-classes": true,
+  "known-properties": true,
+  "box-sizing": true,
+  "box-model": true,
+  "overqualified-elements": true,
+  "display-property-grouping": true,
+  "bulletproof-font-face": true,
+  "compatible-vendor-prefixes": true,
+  "regex-selectors": true,
+  "errors": true,
+  "duplicate-background-images": true,
+  "duplicate-properties": true,
+  "empty-rules": true,
+  "selector-max-approaching": true,
+  "gradients": true,
+  "fallback-colors": true,
+  "font-sizes": true,
+  "font-faces": true,
+  "floats": true,
+  "star-property-hack": true,
+  "outline-none": true,
+  "import": true,
+  "ids": true,
+  "underscore-property-hack": true,
+  "rules-count": true,
+  "qualified-headings": true,
+  "selector-max": true,
+  "shorthand": true,
+  "text-indent": true,
+  "unique-headings": true,
+  "universal-selector": true,
+  "unqualified-attributes": true,
+  "vendor-prefix": true,
+  "zero-units": true
+}

data/.editorconfig

@@ -0,0 +1,27 @@
+# How could I live without http://EditorConfig.org ???
+root = true
+
+# All
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 4
+
+# Scripts 
+[*.js]
+indent_size = 2
+
+#JSON configuration files
+[*.json]
+indent_size = 2
+
+# Ruby source files
+[*.rb]
+indent_size = 2
+
+# Stylesheets
+[*.css,*.scss]
+indent_size = 2
+

data/.gitattributes

@@ -0,0 +1 @@
+* text=auto

data/.gitignore

@@ -0,0 +1,23 @@
+#General
+tmp/
+sideshow.zip
+sideshow.tar.gz
+
+#Node/NPM related
+node_modules
+npm-debug.log
+
+#Bower related
+bower_components/
+
+#Mac OS Files
+.DS_Store
+
+#Sublime specific
+*.sublime-workspace
+
+#NuGet Files
+*.nupkg
+
+#Ruby files
+*.gem

data/BUILDING.md

@@ -0,0 +1,4 @@
+#Building
+
+*Important Note* 
+The entire build process has changed (from pure Shell script to Gulp, from Sass+Compass to Stylus, no more ruby, no more manual configuration...). I'll rewrite this markdown as soon as possible with a complete overview of the brand new build workflow.

data/CHANGELOG.md

@@ -0,0 +1,47 @@
+#Version 0.4.1 the-hobbit (2014-11-27)
+
+##Fixes
+After yanking the version 0.4.0 of the gem and removed the NuGet package too, I'm republishing them...
+
+------------------------------------------------------------
+
+#Version 0.4.0 citizen-kane (2014-11-27)
+
+##General
+Replaced old shell script build with Gulp
+Replaced Sass+Compass with Stylus
+Removed any Ruby dependency
+Distributing Sideshow as a NuGet package, a Ruby Gem and a Bower component.
+
+##Fixes
+Fixed a bug in the polling functions for monitoring subject and targets changes. 
+
+------------------------------------------------------------
+
+#Version 0.3.5 volver (2014-05-29)
+
+##General
+- Added a translation to spanish (thanks for this translation Luis Alfaro de la Fuente!)
+
+##Fixes
+- Fixing a bug with the option autoSkipIntro (when it's true), where in the end of a wizard an exception occurred and Sideshow couldn't close properly.
+- Lifted up the target arrows, to avoid them to cover the target content.
+
+------------------------------------------------------------
+
+#Version 0.3.4 the-untouchables (2014-05-28)
+
+##General
+- Added a configuration option for skipping the intro screen (the tutorials list) if there's just one tutorial available for some context.
+
+------------------------------------------------------------
+
+#Version 0.3.3 raging-bull (2014-01-10)
+
+##General
+- Changed licensing to Apache License 2.0 (Now Sideshow is open source software bro! Yeah!!)
+- Replaced Google Closure by UglifyJS; though Google Closure compress ratio is a higher (when in Advanced Mode), there are some issues with dead code detection and UglifyJS is considerably faster.
+- Changed build script to resolve dependencies in a similar way as Sprocket does
+
+------------------------------------------------------------
+There's no changelog before the 0.3.3 version since we became public in this version.

data/Gulpfile.js

@@ -0,0 +1,404 @@
+//All Requires
+var gulp = require('gulp'),
+    autoprefixer = require('gulp-autoprefixer'),
+    minifycss = require('gulp-minify-css'),
+    jshint = require('gulp-jshint'),
+    uglify = require('gulp-uglify'),
+    csslint = require('gulp-csslint'),
+    rename = require('gulp-rename'),
+    concat = require('gulp-concat'),
+    notify = require('gulp-notify'),
+    livereload = require('gulp-livereload'),
+    open = require('open'),
+    del = require('del'),
+    http = require('http'),
+    ecstatic = require('ecstatic'),
+    util = require('gulp-util'),
+    prettify = require('gulp-prettify'),
+    beautify = require('gulp-beautify'),
+    stylus = require('gulp-stylus'),
+    include = require('gulp-include'),
+    fs = require('fs'),
+    path = require('path'),
+    prompt = require('gulp-prompt'),
+    yuidoc = require('gulp-yuidoc'),
+    bower = require('gulp-bower'),
+    unzip = require('gulp-unzip'),
+    zip = require('gulp-zip'),
+    gzip = require('gulp-gzip'),
+    tar = require('gulp-tar'),
+    run = require('gulp-run'),
+    git = require('gift'),
+    repo = git('./'),
+    webserverPort = 8080,
+    isWin = /^win/.test(process.platform),
+    appRoot = path.resolve('.');
+    //config = require('./gulp/config');
+
+
+
+/* Tasks (will be extracted to separated files) */
+
+//Sideshow's main stylesheet
+gulp.task('style', function(){
+  compileSideshowStylesheets()
+});
+
+//Examples pages Style task
+gulp.task('examples-style', function(){
+  compileExamplesStylesheet();
+});
+
+//Bundle Nexit modules with Browserify
+gulp.task('bundle-scripts', function(){
+  bundleScripts();
+});
+
+//Clean task
+gulp.task('clean', function(cb) {
+  cleanFiles(cb);
+});
+
+//Watch Task
+gulp.task('watch', function() {
+  pollForChanges();
+});
+
+//Webserver task
+gulp.task('webserver', function(){
+  runDevelopmentWebServer();
+});
+
+//Default task
+gulp.task('default', function() {
+  compileSideshowStylesheets();
+  compileExamplesStylesheet();
+  // gulp.start('examples-partials');
+  runDevelopmentWebServer();
+  pollForChanges();
+
+  setTimeout(function(){
+    openInBrowser(util.env.browser);
+  }, 3000);
+});
+
+gulp.task('update-version', function(){
+  updateVersionNumberReferences();
+});
+
+gulp.task('update-bower', function(){
+  updateBowerDependencies();
+});
+
+gulp.task('generate-docs', function() {
+  generateDocumentation();
+});
+
+gulp.task('prepare-build', ['update-version', 'update-bower','clean'], function() {
+  console.log('Remember to edit the CHANGELOG file before doing a complete build.');
+});
+
+gulp.task('complete-build', function() {
+  if(prompt.confirm('Did you run the prepare-build before this?')){
+    compileSideshowStylesheets();
+    compileExamplesStylesheet();
+    bundleScripts(function(){
+      generateDocumentation();
+    });
+  } 
+});
+
+
+gulp.task('pack', function() {
+  zipDistributableFiles();
+  generatePackages();
+});
+
+function zipDistributableFiles(){
+  var distr = gulp.src(['./distr*/**/*', './examples*/**/*', 'example.html']);
+
+  distr
+  .pipe(zip('sideshow.zip'))
+  .pipe(gulp.dest('./'));
+
+  distr
+  .pipe(tar('sideshow.tar'))
+  .pipe(gzip())
+  .pipe(gulp.dest('./'));
+}
+
+function generatePackages(){
+  del(['*.gem', '*.nupkg'], function(){
+    repo.status(function(err, status){
+      if(Object.keys(status.files).length === 0){
+        var versionFilePath = path.join(appRoot, 'VERSION');
+
+        fs.readFile(versionFilePath, 'utf8', function(err, version) {
+          var versionNumber = version.match(/[\d.]+/);
+
+          gulp.src('./')
+          .pipe(run('git tag -a ' + version + ' -m \'' + version + '\''))
+          .pipe(run('git push --all origin'));
+          
+
+          console.log('Building and pushing Sideshow gem');
+          gulp.src('./')
+          .pipe(run('gem build sideshow.gemspec'))
+          .pipe(run('gem push sideshow-' + versionNumber + '.gem'));
+
+          if(isWin){
+            console.log('Packing and pushing Sideshow nuget package');
+            gulp.src('./')
+            .pipe(run('nuget pack sideshow.nuspec'))
+            .pipe(run('nuget push sideshow.' + versionNumber + '.nupkg'));
+          }
+        });
+      } else {
+        console.log('Before packing a new version you must commit your changes.')
+      }
+    });
+  });
+}
+
+function updateBowerDependencies(){
+  bower()
+  .on('end', function(){
+    gulp.src('./bower_components/pagedown/index.zip')
+    .pipe(unzip())
+    .pipe(gulp.dest('./bower_components/pagedown'))
+    .on('end', function(){
+      gulp.src('./bower_components/pagedown/pagedown-*/Markdown.Converter.js')
+      .pipe(uglify())
+      .pipe(rename('pagedown.min.js'))
+      .pipe(gulp.dest('./distr/dependencies'));
+    });
+
+    gulp.src('./bower_components/jquery/dist/jquery.min.js')
+    .pipe(gulp.dest('./distr/dependencies'));
+  });
+}
+
+function compileSideshowStylesheets(){
+  return gulp.src('stylesheets/sideshow.styl')
+        .pipe(stylus())
+        .on('error', errorHandler('sideshow_stylesheet_compiling_error'))
+        .pipe(autoPrefixerConfig())
+        .on('error', errorHandler('sideshow_stylesheet_autoprefixing_error'))
+        .pipe(rename('sideshow.css'))
+        .pipe(gulp.dest('tmp'))
+        .pipe(csslint('.csslintrc'))
+        .pipe(csslint.reporter())
+        .pipe(rename({suffix: '.min'}))
+        .pipe(minifycss())
+        .pipe(gulp.dest('distr/stylesheets'));
+
+        //Font face stylesheet
+        gulp.src('stylesheets/sideshow-fontface.styl')
+        .pipe(stylus())
+        .on('error', errorHandler('fontface_stylesheet_compiling_error'))
+        .pipe(autoPrefixerConfig())
+        .on('error', errorHandler('fontface_stylesheet_autoprefixing_error'))
+        .pipe(rename('sideshow-fontface.min.css'))
+        .pipe(minifycss())
+        .pipe(gulp.dest('distr/fonts'));
+}
+
+function compileExamplesStylesheet(){
+  return gulp.src('examples/stylesheets/styl/example.styl')
+        .pipe(stylus())
+        .on('error', errorHandler('examples_stylesheet_compiling_error'))
+        .pipe(autoPrefixerConfig())
+        .on('error', errorHandler('examples_stylesheet_autoprefixing_error'))
+        .pipe(rename('example.css'))
+        .pipe(gulp.dest('tmp'))
+        .pipe(csslint('.csslintrc'))
+        .pipe(csslint.reporter())
+        .pipe(rename({suffix: '.min'}))
+        .pipe(minifycss())
+        .pipe(gulp.dest('examples/stylesheets'));
+}
+
+function bundleScripts(endCallback){
+  return gulp.src('./src/main.js')
+        .pipe(include())
+        .on('error', errorHandler('jsbuild_error'))
+        .pipe(rename('sideshow.js'))
+        .pipe(beautify({indentSize: 2}))
+        .pipe(gulp.dest('distr/'))
+        .pipe(rename({suffix: '.min'}))
+        .pipe(uglify())
+        .pipe(gulp.dest('./distr/'))
+        .on('end', function(){
+          //adding copyright message in the expanded version
+          gulp.src(['./src/copyright_info.js', './distr/sideshow.js'])
+          .pipe(concat('sideshow.js'))
+          .pipe(gulp.dest('./distr/'));
+
+          //adding copyright message in the minified version
+          gulp.src(['./src/copyright_info.js', './distr/sideshow.min.js'])
+          .pipe(concat('sideshow.min.js'))
+          .pipe(gulp.dest('./distr/'));
+
+          if(endCallback) endCallback();
+        });
+}
+
+function cleanFiles(cb){
+  del(['distr/*.js', 'tmp/*', 'docs/**/*'], cb);
+}
+
+function pollForChanges(){
+  gulp.watch('src/**/*.js', ['bundle-scripts']);
+  gulp.watch('stylesheets/**/*.styl', ['style', 'examples-style']);
+  gulp.watch('examples/stylesheets/styl/**/*.styl', ['examples-style']);
+  gulp.watch('examples/partials/**/*.html', ['examples-partials']);
+
+  // Create LiveReload server
+  livereload.listen();
+
+  // Watch any files in distr/, reload on change
+  gulp.watch(['examples/stylesheets/example.min.css', 'distr/**']).on('change', function(){
+    livereload.changed();
+    notify('Changed.');
+  });
+
+  notify('Running livereload.');
+}
+
+function runDevelopmentWebServer(){
+  http.createServer(
+    ecstatic({ root: __dirname })
+  ).listen(webserverPort);
+
+  notify('Web server started. Listening on port ' + webserverPort + '.');
+}
+
+function openInBrowser(browser){
+  function go(browser){
+    return open('http://localhost:' + webserverPort + '/example.html', browser);
+  }
+
+  if (browser != 'none'){
+    if(browser == 'all'){
+      go('firefox');
+      go('opera');
+      go('safari');
+      go('chrome');  
+    } else if (browser) 
+      go(browser);
+    else
+      go('firefox');
+  }
+}
+
+function updateVersionNumberReferences(){
+  var version = util.env.version || (function(){ throw "A version number must be passed. Please inform the '--version' argument."; })(),
+      name = util.env.name || (function(){ throw "A version name must be passed. Please inform the '--name' argument."; })(),
+      appRoot = path.resolve('.'),
+      versionFilePath = path.join(appRoot, 'VERSION'),
+      yuidocFilePath = path.join(appRoot, 'yuidoc.json'),
+      bowerFilePath = path.join(appRoot, 'bower.json'),
+      gemspecFilePath = path.join(appRoot, 'sideshow.gemspec'),
+      nuspecFilePath = path.join(appRoot, 'sideshow.nuspec'),
+      packageJsonFilePath = path.join(appRoot, 'package.json'),
+      changelogFilePath = path.join(appRoot, 'CHANGELOG.md'),
+      copyrightInfoFilePath = path.join(appRoot, 'src', 'copyright_info.js'),
+      variablesFilePath = path.join(appRoot, 'src', 'general', 'variables.js'),
+      releaseDate = new Date().toISOString().slice(0,10);
+
+  //VERSION file
+  fs.readFile(versionFilePath, 'utf8', function(err, data) {
+    if (err) throw err;
+
+    fs.writeFile(versionFilePath, 'v' + version + '-' + name);
+  });
+
+  //yuidoc.json
+  fs.readFile(yuidocFilePath, 'utf8', function(err, data) {
+    if (err) throw err;
+
+    var json = JSON.parse(data);
+    json.version = version;
+
+    fs.writeFile(yuidocFilePath, JSON.stringify(json, null, 4));
+  });
+
+  //bower.json
+  fs.readFile(bowerFilePath, 'utf8', function(err, data) {
+    if (err) throw err;
+
+    var json = JSON.parse(data);
+    json.version = version;
+
+    fs.writeFile(bowerFilePath, JSON.stringify(json, null, 4));
+  });
+
+  //package.json
+  fs.readFile(packageJsonFilePath, 'utf8', function(err, data) {
+    if (err) throw err;
+
+    var json = JSON.parse(data);
+    json.version = version;
+
+    fs.writeFile(packageJsonFilePath, JSON.stringify(json, null, 4));
+  });
+
+  //sideshow.gemspec
+  fs.readFile(gemspecFilePath, 'utf8', function(err, data) {
+    if (err) throw err;
+
+    fs.writeFile(gemspecFilePath, data.replace(/(s.version\s+=\s+)('[\d.]+')/, "$1'" + version + "'"));
+  });
+
+  //copyright_info.js
+  fs.readFile(copyrightInfoFilePath, 'utf8', function(err, data) {
+    if (err) throw err;
+
+    fs.writeFile(copyrightInfoFilePath, data
+                                        .replace(/(Version: )([\d.]+)/, '$1' + version)
+                                        .replace(/(Date: )([\d-]+)/, '$1' + releaseDate));
+  });
+
+  //CHANGELOG file
+  fs.readFile(changelogFilePath, 'utf8', function(err, data) {
+    if (err) throw err;
+
+    if(data.indexOf('#Version '+ version) == -1){
+      var versionChangelogText = '#Version ' + version + ' ' + name + ' (' + releaseDate + ')' +
+                                 '\n\n##General' + 
+                                 '\n\n##Fixes\n\n' +
+                                 Array(61).join('-') + '\n\n';
+
+      fs.writeFile(changelogFilePath, versionChangelogText + data);
+    }
+  });
+
+  fs.readFile(variablesFilePath, 'utf8', function(err, data) {
+    if (err) throw err;
+
+    fs.writeFile(variablesFilePath, data.replace(/(get VERSION\(\) {\s+return )("[\d.]+")/, '$1"' + version + '"'));
+  });
+
+  fs.readFile(nuspecFilePath, 'utf8', function(err, data) {
+    if (err) throw err;
+
+    fs.writeFile(nuspecFilePath, data.replace(/(<version>)([\d.]+)(<\/version>)/, '$1' + version + '$3'));
+  });
+}
+
+function generateDocumentation(){
+  return gulp.src("./distr/sideshow.js")
+        .pipe(yuidoc())
+        .pipe(gulp.dest("./docs"));
+}
+
+function errorHandler(title){
+  return function(error){
+    console.log((title || 'Error') + ': ' + error.message); 
+    notify((title || 'Error') + ': ' + error.message); 
+  };
+}
+
+function autoPrefixerConfig(){
+  return autoprefixer('last 2 version', 'safari 5', 'ie 9', 'opera 12.1', 'ios 6', 'android 4');
+}