pamelafox / exportjson.js
Last active

Embed URL

HTTPS clone URL

SSH clone URL

You can clone with HTTPS or SSH.

Download Gist

View exportjson.js
Raw
File suppressed. Click to show.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 
// Includes functions for exporting active sheet or all sheets as JSON object (also Python object syntax compatible).

// Tweak the makePrettyJSON_ function to customize what kind of JSON to export.

 

var FORMAT_ONELINE   = 'One-line';

var FORMAT_MULTILINE = 'Multi-line';

var FORMAT_PRETTY    = 'Pretty';

 

var LANGUAGE_JS      = 'JavaScript';

var LANGUAGE_PYTHON  = 'Python';

 

var STRUCTURE_LIST = 'List';

var STRUCTURE_HASH = 'Hash (keyed by "id" column)';

 

/* Defaults for this particular spreadsheet, change as desired */

var DEFAULT_FORMAT = FORMAT_PRETTY;

var DEFAULT_LANGUAGE = LANGUAGE_JS;

var DEFAULT_STRUCTURE = STRUCTURE_LIST;

 

 

function onOpen() {

  var ss = SpreadsheetApp.getActiveSpreadsheet();

  var menuEntries = [

    {name: "Export JSON for this sheet", functionName: "exportSheet"},

    {name: "Export JSON for all sheets", functionName: "exportAllSheets"},

    {name: "Configure export", functionName: "exportOptions"},

  ];

  ss.addMenu("Export JSON", menuEntries);

}

    

    

function exportOptions() {

  var doc = SpreadsheetApp.getActiveSpreadsheet();

  var app = UiApp.createApplication().setTitle('Export JSON');

  

  var grid = app.createGrid(4, 2);

  grid.setWidget(0, 0, makeLabel(app, 'Language:'));

  grid.setWidget(0, 1, makeListBox(app, 'language', [LANGUAGE_JS, LANGUAGE_PYTHON]));

  grid.setWidget(1, 0, makeLabel(app, 'Format:'));

  grid.setWidget(1, 1, makeListBox(app, 'format', [FORMAT_PRETTY, FORMAT_MULTILINE, FORMAT_ONELINE]));

  grid.setWidget(2, 0, makeLabel(app, 'Structure:'));

  grid.setWidget(2, 1, makeListBox(app, 'structure', [STRUCTURE_LIST, STRUCTURE_HASH]));

  grid.setWidget(3, 0, makeButton(app, grid, 'Export Active Sheet', 'exportSheet'));

  grid.setWidget(3, 1, makeButton(app, grid, 'Export All Sheets', 'exportAllSheets'));

  app.add(grid);

  

  doc.show(app);

}

 

function makeLabel(app, text, id) {

  var lb = app.createLabel(text);

  if (id) lb.setId(id);

  return lb;

}

 

function makeListBox(app, name, items) {

  var listBox = app.createListBox().setId(name).setName(name);

  listBox.setVisibleItemCount(1);

  

  var cache = CacheService.getPublicCache();

  var selectedValue = cache.get(name);

  Logger.log(selectedValue);

  for (var i = 0; i < items.length; i++) {

    listBox.addItem(items[i]);

    if (items[1] == selectedValue) {

      listBox.setSelectedIndex(i);

    }

  }

  return listBox;

}

 

function makeButton(app, parent, name, callback) {

  var button = app.createButton(name);

  app.add(button);

  var handler = app.createServerClickHandler(callback).addCallbackElement(parent);;

  button.addClickHandler(handler);

  return button;

}

 

function makeTextBox(app, name) { 

  var textArea    = app.createTextArea().setWidth('100%').setHeight('200px').setId(name).setName(name);

  return textArea;

}

 

function exportAllSheets(e) {

  

  var ss = SpreadsheetApp.getActiveSpreadsheet();

  var sheets = ss.getSheets();

  var sheetsData = {};

  for (var i = 0; i < sheets.length; i++) {

    var sheet = sheets[i];

    var rowsData = getRowsData_(sheet, getExportOptions(e));

    var sheetName = sheet.getName(); 

    sheetsData[sheetName] = rowsData;

  }

  var json = makeJSON_(sheetsData, getExportOptions(e));

  return displayText_(json);

}

 

function exportSheet(e) {

  var ss = SpreadsheetApp.getActiveSpreadsheet();

  var sheet = ss.getActiveSheet();

  var rowsData = getRowsData_(sheet, getExportOptions(e));

  var json = makeJSON_(rowsData, getExportOptions(e));

  return displayText_(json);

}

  

function getExportOptions(e) {

  var options = {};

  

  options.language = e && e.parameter.language || DEFAULT_LANGUAGE;

  options.format   = e && e.parameter.format || DEFAULT_FORMAT;

  options.structure = e && e.parameter.structure || DEFAULT_STRUCTURE;

  

  var cache = CacheService.getPublicCache();

  cache.put('language', options.language);

  cache.put('format',   options.format);

  cache.put('structure',   options.structure);

  

  Logger.log(options);

  return options;

}

 

function makeJSON_(object, options) {

  if (options.format == FORMAT_PRETTY) {

    var jsonString = JSON.stringify(object, null, 4);

  } else if (options.format == FORMAT_MULTILINE) {

    var jsonString = Utilities.jsonStringify(object);

    jsonString = jsonString.replace(/},/gi, '},\n');

    jsonString = prettyJSON.replace(/":\[{"/gi, '":\n[{"');

    jsonString = prettyJSON.replace(/}\],/gi, '}],\n');

  } else {

    var jsonString = Utilities.jsonStringify(object);

  }

  if (options.language == LANGUAGE_PYTHON) {

    // add unicode markers

    jsonString = jsonString.replace(/"([a-zA-Z]*)":\s+"/gi, '"$1": u"');

  }

  return jsonString;

}

 

function displayText_(text) {

  var app = UiApp.createApplication().setTitle('Exported JSON');

  app.add(makeTextBox(app, 'json'));

  app.getElementById('json').setText(text);

  var ss = SpreadsheetApp.getActiveSpreadsheet(); 

  ss.show(app);

  return app; 

}

 

// getRowsData iterates row by row in the input range and returns an array of objects.

// Each object contains all the data for a given row, indexed by its normalized column name.

// Arguments:

//   - sheet: the sheet object that contains the data to be processed

//   - range: the exact range of cells where the data is stored

//   - columnHeadersRowIndex: specifies the row number where the column names are stored.

//       This argument is optional and it defaults to the row immediately above range; 

// Returns an Array of objects.

function getRowsData_(sheet, options) {

  var headersRange = sheet.getRange(1, 1, sheet.getFrozenRows(), sheet.getMaxColumns());

  var headers = headersRange.getValues()[0];

  var dataRange = sheet.getRange(sheet.getFrozenRows()+1, 1, sheet.getMaxRows(), sheet.getMaxColumns());

  var objects = getObjects_(dataRange.getValues(), normalizeHeaders_(headers));

  if (options.structure == STRUCTURE_HASH) {

    var objectsById = {};

    objects.forEach(function(object) {

      objectsById[object.id] = object;

    });

    return objectsById;

  } else {

    return objects;

  }

}

 

// getColumnsData iterates column by column in the input range and returns an array of objects.

// Each object contains all the data for a given column, indexed by its normalized row name.

// Arguments:

//   - sheet: the sheet object that contains the data to be processed

//   - range: the exact range of cells where the data is stored

//   - rowHeadersColumnIndex: specifies the column number where the row names are stored.

//       This argument is optional and it defaults to the column immediately left of the range; 

// Returns an Array of objects.

function getColumnsData_(sheet, range, rowHeadersColumnIndex) {

  rowHeadersColumnIndex = rowHeadersColumnIndex || range.getColumnIndex() - 1;

  var headersTmp = sheet.getRange(range.getRow(), rowHeadersColumnIndex, range.getNumRows(), 1).getValues();

  var headers = normalizeHeaders_(arrayTranspose_(headersTmp)[0]);

  return getObjects(arrayTranspose_(range.getValues()), headers);

}

 

 

// For every row of data in data, generates an object that contains the data. Names of

// object fields are defined in keys.

// Arguments:

//   - data: JavaScript 2d array

//   - keys: Array of Strings that define the property names for the objects to create

function getObjects_(data, keys) {

  var objects = [];

  for (var i = 0; i < data.length; ++i) {

    var object = {};

    var hasData = false;

    for (var j = 0; j < data[i].length; ++j) {

      var cellData = data[i][j];

      if (isCellEmpty_(cellData)) {

        continue;

      }

      object[keys[j]] = cellData;

      hasData = true;

    }

    if (hasData) {

      objects.push(object);

    }

  }

  return objects;

}

 

// Returns an Array of normalized Strings.

// Arguments:

//   - headers: Array of Strings to normalize

function normalizeHeaders_(headers) {

  var keys = [];

  for (var i = 0; i < headers.length; ++i) {

    var key = normalizeHeader_(headers[i]);

    if (key.length > 0) {

      keys.push(key);

    }

  }

  return keys;

}

 

// Normalizes a string, by removing all alphanumeric characters and using mixed case

// to separate words. The output will always start with a lower case letter.

// This function is designed to produce JavaScript object property names.

// Arguments:

//   - header: string to normalize

// Examples:

//   "First Name" -> "firstName"

//   "Market Cap (millions) -> "marketCapMillions

//   "1 number at the beginning is ignored" -> "numberAtTheBeginningIsIgnored"

function normalizeHeader_(header) {

  var key = "";

  var upperCase = false;

  for (var i = 0; i < header.length; ++i) {

    var letter = header[i];

    if (letter == " " && key.length > 0) {

      upperCase = true;

      continue;

    }

    if (!isAlnum_(letter)) {

      continue;

    }

    if (key.length == 0 && isDigit_(letter)) {

      continue; // first character must be a letter

    }

    if (upperCase) {

      upperCase = false;

      key += letter.toUpperCase();

    } else {

      key += letter.toLowerCase();

    }

  }

  return key;

}

 

// Returns true if the cell where cellData was read from is empty.

// Arguments:

//   - cellData: string

function isCellEmpty_(cellData) {

  return typeof(cellData) == "string" && cellData == "";

}

 

// Returns true if the character char is alphabetical, false otherwise.

function isAlnum_(char) {

  return char >= 'A' && char <= 'Z' ||

    char >= 'a' && char <= 'z' ||

    isDigit_(char);

}

 

// Returns true if the character char is a digit, false otherwise.

function isDigit_(char) {

  return char >= '0' && char <= '9';

}

 

// Given a JavaScript 2d Array, this function returns the transposed table.

// Arguments:

//   - data: JavaScript 2d Array

// Returns a JavaScript 2d Array

// Example: arrayTranspose([[1,2,3],[4,5,6]]) returns [[1,4],[2,5],[3,6]].

function arrayTranspose_(data) {

  if (data.length == 0 || data[0].length == 0) {

    return null;

  }

 

  var ret = [];

  for (var i = 0; i < data[0].length; ++i) {

    ret.push([]);

  }

 

  for (var i = 0; i < data.length; ++i) {

    for (var j = 0; j < data[i].length; ++j) {

      ret[j][i] = data[i][j];

    }

  }

 

  return ret;

}
jlnewton87 commented

Found this reading the article about you on lifehacker (http://lifehacker.com/5985434/im-pamela-fox-product-engineer-at-coursera-and-this-is-how-i-work). I have used Coursera once, and hope to have that pleasure again in the near future. Coursera blows away the online course management system used at the university in which I am currently enrolled (Kennesaw State University, GA). I love your coding style. A couple of colleagues and I are making a move towards naturally-documented code, of which I feel this is a great example. Keep up the great work. It is awesome to find another developer who is not dead set on making their code impossible to understand by mere humans!

ralfharing commented

Not sure if there's a nice way to notify you on this (doesn't seem like there are pull requests for gists) but I added a quick error message at https://gist.github.com/ralfharing/5810205/revisions .

kaartz commented

Hi, is it possible to export a sheet to XML?

ongzexuan commented

This has been very useful! Thanks a lot :)

v3nt commented

mmm - getting an error "The coordinates or dimensions of the range are invalid. Details Dismiss" and details are 'Message details
The coordinates or dimensions of the range are invalid.' Tried selecting just a few rows or all of them but the same error comes up.

righi commented

@pamelafox A million thank yous for this awesome script.

@v3nt I had the same "The coordinates or dimensions of the range are invalid." error, but it went away when I marked the top row as a header by freezing it. (View > Freeze Rows > Freeze Row 1)

nats-ohchewy commented

Is there a way to make the JSON open in the browser so you can copy the link?

dannyboyukliev commented

I'm getting an error "prettyJSON is not defined." when I'm trying to use the Multiline format of JSON output.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.