Embed meta in comment instead of filename.

refs #55 #65

Signed-off-by: Eric Wang <[email protected]>

Author: skygragon

Diff for: lib/commands/submit.js

@@ -47,14 +47,13 @@ cmd.handler = function(argv) {
   if (!fs.existsSync(argv.filename))
     return log.error('File ' + argv.filename + ' not exist!');
 
-  // use the 1st section in filename as keyword
-  // e.g. two-sum.cpp, or two-sum.78502271.ac.cpp
-  const keyword = file.name(argv.filename).split('.')[0];
+  const meta = file.meta(argv.filename);
 
-  core.getProblem(keyword, function(e, problem) {
+  core.getProblem(meta.id, function(e, problem) {
     if (e) return log.fail(e);
 
     problem.file = argv.filename;
+    problem.lang = meta.lang;
 
     core.submitProblem(problem, function(e, results) {
       if (e) return log.fail(e);

Diff for: lib/commands/test.js

@@ -57,11 +57,9 @@ function runTest(argv) {
   if (!fs.existsSync(argv.filename))
     return log.error('File ' + argv.filename + ' not exist!');
 
-  // use the 1st section in filename as keyword
-  // e.g. two-sum.cpp, or two-sum.78502271.ac.cpp
-  const keyword = file.name(argv.filename).split('.')[0];
+  const meta = file.meta(argv.filename);
 
-  core.getProblem(keyword, function(e, problem) {
+  core.getProblem(meta.id, function(e, problem) {
     if (e) return log.fail(e);
 
     if (!problem.testable)
@@ -74,6 +72,7 @@ function runTest(argv) {
       return log.fail('missing testcase?');
 
     problem.file = argv.filename;
+    problem.lang = meta.lang;
 
     log.info('\nInput data:');
     log.info(problem.testcase);

Diff for: lib/core.js

@@ -1,5 +1,4 @@
 'use strict';
-var path = require('path');
 var util = require('util');
 
 var _ = require('underscore');
@@ -107,31 +106,26 @@ core.starProblem = function(problem, starred, cb) {
 };
 
 core.exportProblem = function(problem, opts) {
-  // copy problem attrs thus we can render it in template
-  const input = _.extend({}, problem);
+  const data = _.extend({}, problem);
 
-  input.code = opts.code.replace(/\r\n/g, '\n');
-  input.comment = h.langToCommentStyle(opts.lang);
-  input.percent = input.percent.toFixed(2);
-  input.testcase = util.inspect(input.testcase || '');
+  // unify format before rendering
+  data.app = require('./config').app;
+  if (!data.fid) data.fid = data.id;
+  if (!data.lang) data.lang = opts.lang;
+  data.code = (opts.code || data.code || '').replace(/\r\n/g, '\n');
+  data.comment = h.langToCommentStyle(data.lang);
+  data.percent = data.percent.toFixed(2);
+  data.testcase = util.inspect(data.testcase || '');
 
   if (opts.tpl === 'detailed') {
     // NOTE: wordwrap internally uses '\n' as EOL, so here we have to
     // remove all '\r' in the raw string.
-    const desc = input.desc.replace(/\r\n/g, '\n').replace(/^ /mg, '⁠');
-    const wrap = require('wordwrap')(79 - input.comment.line.length);
-    input.desc = wrap(desc).split('\n');
+    const desc = data.desc.replace(/\r\n/g, '\n').replace(/^ /mg, '⁠');
+    const wrap = require('wordwrap')(79 - data.comment.line.length);
+    data.desc = wrap(desc).split('\n');
   }
 
-  const tplfile = path.join(file.codeDir('templates'), opts.tpl + '.tpl');
-  let output = _.template(file.data(tplfile))(input);
-
-  if (file.isWindows()) {
-    output = output.replace(/\n/g, '\r\n');
-  } else {
-    output = output.replace(/\r\n/g, '\n');
-  }
-  return output;
+  return file.render(opts.tpl, data);
 };
 
 module.exports = core;

Diff for: lib/file.js

@@ -2,6 +2,7 @@
 var fs = require('fs');
 var path = require('path');
 
+var _ = require('underscore');
 var mkdirp = require('mkdirp');
 
 const file = {}
@@ -61,7 +62,7 @@ file.listCodeDir = function(dir) {
   });
 };
 
-/// general dirs & files
+/// general dirs & files ///
 file.mkdir = function(fullpath) {
   if (fs.existsSync(fullpath)) return;
   mkdirp.sync(fullpath);
@@ -79,4 +80,56 @@ file.data = function(fullpath) {
   return fs.existsSync(fullpath) ? fs.readFileSync(fullpath).toString() : null;
 };
 
+/// templates & metadata ///
+file.render = function(tpl, data) {
+  const tplfile = path.join(this.codeDir('templates'), tpl + '.tpl');
+  let result = _.template(this.data(tplfile))(data);
+
+  if (this.isWindows()) {
+    result = result.replace(/\n/g, '\r\n');
+  } else {
+    result = result.replace(/\r\n/g, '\n');
+  }
+  return result;
+};
+
+file.metaByName = function(filename) {
+  const m = {};
+
+  // expect the 1st section in filename as id
+  // e.g. 1.two-sum.cpp
+  m.id = file.name(filename).split('.')[0];
+
+  // HACK: compatible with old ext
+  if (filename.endsWith('.py3') || filename.endsWith('.python3.py'))
+    m.lang = 'python3';
+  else
+    m.lang = require('./helper').extToLang(filename);
+
+  return m;
+};
+
+file.meta = function(filename) {
+  const m = {};
+
+  // first look into the file data
+  const line = this.data(filename).split('\n')
+    .find(x => x.indexOf(' @lc ') >= 0) || '';
+  line.split(' ').forEach(function(x) {
+    const v = x.split('=');
+    if (v.length == 2) {
+      m[v[0]] = v[1];
+    }
+  });
+
+  // otherwise, look into file name
+  if (!m.id || !m.lang) {
+    const olddata = this.metaByName(filename);
+    m.id = m.id || olddata.id;
+    m.lang = m.lang || olddata.lang;
+  }
+
+  return m;
+};
+
 module.exports = file;

Diff for: lib/helper.js

@@ -40,7 +40,7 @@ const LANGS = [
   {lang: 'kotlin',     ext: '.kt',         style: 'c'},
   {lang: 'mysql',      ext: '.sql',        style: '#'},
   {lang: 'python',     ext: '.py',         style: '#'},
-  {lang: 'python3',    ext: '.python3.py', style: '#'},
+  {lang: 'python3',    ext: '.py',         style: '#'},
   {lang: 'ruby',       ext: '.rb',         style: '#'},
   {lang: 'scala',      ext: '.scala',      style: 'c'},
   {lang: 'swift',      ext: '.swift',      style: 'c'}
@@ -124,14 +124,8 @@ h.langToExt = function(lang) {
 };
 
 h.extToLang = function(fullpath) {
-  // HACK: compatible with old ext
-  if (fullpath.endsWith('.py3')) return 'python3';
-
-  const res = _.chain(LANGS)
-    .filter(x => fullpath.endsWith(x.ext))
-    .sortBy(x => -x.ext.length)
-    .value();
-  return res.length ? res[0].lang : 'unknown';
+  const res = LANGS.find(x => fullpath.endsWith(x.ext));
+  return res ? res.lang : 'unknown';
 };
 
 h.langToCommentStyle = function(lang) {

Diff for: lib/plugins/leetcode.js

@@ -182,7 +182,7 @@ function runCode(opts, problem, cb) {
 
   opts.body = opts.body || {};
   _.extendOwn(opts.body, {
-    lang:        h.extToLang(problem.file),
+    lang:        problem.lang,
     question_id: parseInt(problem.id, 10),
     test_mode:   false,
     typed_code:  file.data(problem.file)

Diff for: templates/detailed.tpl

@@ -1,5 +1,7 @@
 <%= comment.start %>
-<%= comment.line %> [<%= id %>] <%= name %>
+<%= comment.line %> @lc app=<%= app %> id=<%= fid %> lang=<%= lang %>
+<%= comment.line %>
+<%= comment.line %> [<%= fid %>] <%= name %>
 <%= comment.line %>
 <%= comment.line %> <%= link %>
 <%= comment.line %>

Diff for: test/test_core.js

@@ -205,6 +205,8 @@ describe('core', function() {
     it('should detailed ok with cpp', function() {
       const expected = [
         '/*',
+        ' * @lc app=leetcode id=2 lang=cpp',
+        ' *',
         ' * [2] Add Two Numbers',
         ' *',
         ' * https://leetcode.com/problems/add-two-numbers',
@@ -250,6 +252,8 @@ describe('core', function() {
 
     it('should detailed ok with ruby', function() {
       const expected = [
+        '#',
+        '# @lc app=leetcode id=2 lang=ruby',
         '#',
         '# [2] Add Two Numbers',
         '#',

Diff for: test/test_file.js

@@ -55,4 +55,48 @@ describe('file', function() {
       assert.equal(file.data('non-exist'), null);
     });
   }); // #dirAndFiles
+
+  describe('#meta', function() {
+    it('should meta ok within file content', function() {
+      file.data = x => [
+        '/ *',
+        '  * @lc app=leetcode id=123 lang=javascript',
+        '  * /'
+      ].join('\n');
+      const meta = file.meta('dummy');
+      assert.equal(meta.app, 'leetcode')
+      assert.equal(meta.id, '123');
+      assert.equal(meta.lang, 'javascript');
+    });
+
+    it('should meta ok within file name', function() {
+      file.data = x => [
+        '/ *',
+        '  * no meta app=leetcode id=123 lang=javascript',
+        '  * /'
+      ].join('\n');
+      const meta = file.meta('321.dummy.py');
+      assert(!meta.app)
+      assert.equal(meta.id, '321');
+      assert.equal(meta.lang, 'python');
+    });
+
+    it('should meta ok within deprecated file name', function() {
+      file.data = x => [
+        '/ *',
+        '  * no meta app=leetcode id=123 lang=javascript',
+        '  * /'
+      ].join('\n');
+
+      var meta = file.meta('111.dummy.py3');
+      assert(!meta.app)
+      assert.equal(meta.id, '111');
+      assert.equal(meta.lang, 'python3');
+
+      meta = file.meta('222.dummy.python3.py');
+      assert(!meta.app)
+      assert.equal(meta.id, '222');
+      assert.equal(meta.lang, 'python3');
+    });
+  }); // #meta
 });

Diff for: test/test_helper.js

@@ -129,7 +129,7 @@ describe('helper', function() {
       assert.equal(h.langToExt('javascript'), '.js');
       assert.equal(h.langToExt('mysql'), '.sql');
       assert.equal(h.langToExt('python'), '.py');
-      assert.equal(h.langToExt('python3'), '.python3.py');
+      assert.equal(h.langToExt('python3'), '.py');
       assert.equal(h.langToExt('ruby'), '.rb');
       assert.equal(h.langToExt('scala'), '.scala');
       assert.equal(h.langToExt('swift'), '.swift');
@@ -147,8 +147,6 @@ describe('helper', function() {
       assert.equal(h.extToLang('file.java'), 'java');
       assert.equal(h.extToLang('c:/file.js'), 'javascript');
       assert.equal(h.extToLang('c:/Users/skygragon/file.py'), 'python');
-      assert.equal(h.extToLang('c:/Users/skygragon/file.py3'), 'python3');
-      assert.equal(h.extToLang('c:/Users/skygragon/file.python3.py'), 'python3');
       assert.equal(h.extToLang('~/file.rb'), 'ruby');
       assert.equal(h.extToLang('/tmp/file.scala'), 'scala');
       assert.equal(h.extToLang('~/leetcode/file.swift'), 'swift');