fortune-teller 0.1.0 → 0.3.0

package/lib/build-data.js

@@ -0,0 +1,52 @@
+// Regenerates data/fortunes.json from the raw fortune files in fortunes/.
+// The generated file is committed and ships inside the npm tarball, so
+// installing this package never runs a build script.
+//
+//   npm run build
+
+var fs = require('fs');
+var path = require('path');
+
+var ROOT = path.join(__dirname, '..');
+var FORTUNE_FOLDER = path.join(ROOT, 'fortunes');
+var OUTPUT = path.join(ROOT, 'data', 'fortunes.json');
+
+// The npm package ships data/fortunes.json and not fortunes/, so there is
+// nothing to rebuild in an installed copy. Say so and exit, rather than
+// throwing an ENOENT from readdirSync.
+if (!fs.existsSync(FORTUNE_FOLDER)) {
+    console.log('No fortunes/ directory: this package ships prebuilt data.');
+    console.log('Run `npm run build` in a git checkout to regenerate it.');
+    process.exit(0);
+}
+
+function readFolder(folder) {
+    var out = {};
+
+    fs.readdirSync(path.join(FORTUNE_FOLDER, folder)).sort().forEach(function (file) {
+        if (file.indexOf('Makefile') !== -1) return;
+
+        var rel = folder ? folder + '/' + file : file;
+        var full = path.join(FORTUNE_FOLDER, rel);
+
+        if (fs.statSync(full).isDirectory()) {
+            out[file] = readFolder(rel);
+        } else {
+            // Same delimiter the C fortune(1) uses. Every file ends with a
+            // trailing %, so the last element of the split is blank; drop
+            // blanks or fortune() returns an empty string.
+            out[file] = fs.readFileSync(full, 'utf8').split('%\n').filter(function (text) {
+                return /\S/.test(text);
+            });
+        }
+    });
+
+    return out;
+}
+
+var data = readFolder('');
+
+fs.mkdirSync(path.dirname(OUTPUT), { recursive: true });
+fs.writeFileSync(OUTPUT, JSON.stringify(data));
+
+console.log('Wrote %s', path.relative(ROOT, OUTPUT));

package/lib/fortune.js

@@ -1,14 +1,20 @@
-var loader = require('./loader');
+var data = require('../data/fortunes.json');
 
-(function(){
-    var fortune = {};
+var fortunes = [];
 
-    var fortunes = loader.load();
+(function walk(node) {
+    Object.keys(node).forEach(function (key) {
+        if (Array.isArray(node[key])) fortunes = fortunes.concat(node[key]);
+        else walk(node[key]);
+    });
+})(data);
 
-    fortune.fortune = function(){
-        var r = Math.floor(Math.random() * fortunes.list.length);
-        return fortunes.list[r];
-    };
+function fortune() {
+    return fortunes[Math.floor(Math.random() * fortunes.length)];
+}
 
-    module.exports = fortune;
-})();
+// 0.1.x exported an object with a single .fortune() method, so both
+// fortune() and fortune.fortune() have to keep working.
+fortune.fortune = fortune;
+
+module.exports = fortune;

package/lib/fortune.mjs

@@ -0,0 +1,7 @@
+// ESM entry point. The implementation is CommonJS, so this wrapper just
+// re-exports it with real named exports; without it, `import { fortune }`
+// would not be statically analyzable.
+import fortune from './fortune.js';
+
+export default fortune;
+export { fortune };

package/package.json

@@ -1,22 +1,37 @@
 {
   "name": "fortune-teller",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "description": "Fortune for Node.js",
   "main": "./lib/fortune.js",
+  "exports": {
+    ".": {
+      "import": "./lib/fortune.mjs",
+      "require": "./lib/fortune.js",
+      "default": "./lib/fortune.js"
+    },
+    "./package.json": "./package.json"
+  },
   "scripts": {
-    "postinstall": "node lib/convert"
+    "build": "node lib/build-data.js"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/williamfligor/fortune"
+    "url": "git+https://github.com/williamfligor/fortune.git"
   },
   "keywords": [
     "fortune"
   ],
   "author": "William Fligor <will@fligor.us> (http://williamfligor.com/)",
-  "license": "ISC",
+  "license": "BSD-3-Clause",
   "bugs": {
     "url": "https://github.com/williamfligor/fortune/issues"
   },
-  "homepage": "https://github.com/williamfligor/fortune"
+  "homepage": "https://github.com/williamfligor/fortune",
+  "files": [
+    "lib/fortune.js",
+    "lib/fortune.mjs",
+    "lib/build-data.js",
+    "third-party/",
+    "data/"
+  ]
 }

package/third-party/fortune-mod-1.99.1/Notes

@@ -0,0 +1,178 @@
+#	$NetBSD: Notes,v 1.2 1995/03/23 08:28:26 cgd Exp $
+#	@(#)Notes	8.1 (Berkeley) 5/31/93
+
+Warning:
+	The fortunes contained in the fortune database have been collected
+	haphazardly from a cacophony of sources, in number so huge it
+	boggles the mind.  It is impossible to do any meaningful quality
+	control on attributions, or lack thereof, or exactness of the quote.
+	Since this database is not used for profit, and since entire works
+	are not published, it falls under fair use, as we understand it.
+	However, if any half-assed idiot decides to make a profit off of
+	this, they will need to double check it all, and nobody not involved
+	of such an effort makes any warranty that anything in the database
+	bears any relation to the real world of literature, law, or other
+	bizzarrity.
+
+==> GENERAL INFORMATION
+	By default, fortune retrieves its fortune files from the directory
+/usr/local/share/games/fortune.  A fortune file has two parts: the source file
+(which contains the fortunes themselves) and the data file which describes
+the fortunes.  The data fil always has the same name as the fortune file
+with the string ".dat" concatenated, e.g. if "fort" is a standard fortune
+database, then "fort.dat" is the data file which describes it.  See
+strfile(8) for more information on creating the data files.
+	Fortunes are split into potentially offensive and not potentially
+offensive parts.  The offensive version of a file has the same name as the
+non-offensive version but exists in the offensive fortunes directory 
+(/usr/local/share/games/fortune/off by default).  The fortune program
+automatically assumes that any file in the offensive fortune directory
+is potentially offensive, and should therefore only be displayed if
+explicitly requested, either with the -o option, by specifying a file name
+on the command line, or by appending "-o" to the name.
+	Potentially offensive fortune files should NEVER be maintained in
+clear text on the system.  They are rotated (see caesar(6)) 13 positions.
+To create a new, potentially offensive database, use caesar to rotate it,
+and then create its data file with the -x option to strfile(8).  The fortune
+program automatically decrypts the text when it prints entries from such
+databases.
+	Anything which would not make it onto network prime time programming
+(or which would only be broadcast if some discredited kind of guy said it)
+MUST be in the potentially offensive database.  Fortunes containing any
+explicit language (see George Carlin's recent updated list) MUST be in the
+potentially offensive database.  Political and religious opinions are often
+sequestered in the potentially offensive section as well.  Anything which
+assumes as a world view blatantly racist, mysogynist (sexist), or homophobic
+ideas should not be in either, since they are not really funny unless *you*
+are racist, mysogynist, or homophobic.
+	The point of this is that people have should have a reasonable
+expectation that, should they just run "fortune", they will not be offended.
+We know that some people take offense at anything, but normal people do have
+opinions, too, and have a right not to have their sensibilities offended by
+a program which is supposed to be entertaining.  People who run "fortune
+-o" or "fortune -a" are saying, in effect, that they are willing to have
+their sensibilities tweaked.  However, they should not have their personal
+worth seriously (i.e., not in jest) assaulted.  Jokes which depend for their
+humor on racist, mysogynist, or homophobic stereotypes *do* seriously
+assault individual personal worth, and in an general entertainment medium
+we should be able to get by without it.
+
+==> FORMATTING
+	This file describes the format for fortunes in the database.  This
+is done in detail to make it easier to keep track of things.  Any rule given
+here may be broken to make a better joke.
+
+[All examples are indented by one tab stop -- KCRCA]
+
+Numbers should be given in parentheses, e.g.,
+
+	(1)	Everything depends.
+	(2)	Nothing is always.
+	(3)	Everything is sometimes.
+
+Attributions are two tab stops, followed by two hyphens, followed by a
+space, followed by the attribution, and are *not* preceded by blank
+lines.  Book, journal, movie, and all other titles are in quotes, e.g.,
+
+	$100 invested at 7% interest for 100 years will become $100,000, at
+	which time it will be worth absolutely nothing.
+			-- Lazarus Long, "Time Enough for Love"
+
+Attributions which do not fit on one (72 char) line should be continued
+on a line which lines up below the first text of the attribution, e.g.,
+
+			-- A very long attribution which might not fit on one
+			   line, "Ken Arnold's Stupid Sayings"
+
+Single paragraph fortunes are in left justified (non-indented) paragraphs
+unless they fall into another category listed below (see example above).
+Longer fortunes should also be in left justified paragraphs, but if this
+makes it too long, try indented paragraphs, with indentations of either one
+tab stop or 5 chars.  Indentations of less than 5 are too hard to read.
+
+Laws have the title left justified and capitalized, followed by a colon,
+with all the text of the law itself indented one tab stop, initially
+capitalized, e.g.,
+
+	A Law of Computer Programming:
+		Make it possible for programmers to write in English and
+		you will find the programmers cannot write in English.
+
+Limericks are indented as follows, all lines capitalized:
+
+	A computer, to print out a fact,
+	Will divide, multiply, and subtract.
+		But this output can be
+		No more than debris,
+	If the input was short of exact.
+
+Accents precede the letter they are over, e.g., "`^He" for e with a grave
+accent.  Underlining is done on a word-by-word basis, with the underlines
+preceding the word, e.g., "__^H^Hhi ____^H^H^H^Hthere".
+
+No fortune should run beyond 72 characters on a single line without good
+justification (er, no pun intended).  And no right margin justification,
+either.  Sorry.  For BSD people, there is a program called "fmt" which can
+make this kind of formatting easier.
+
+Definitions are given with the word or phrase left justified, followed by
+the part of speech (if appropriate) and a colon.  The definition starts
+indented by one tab stop, with subsequent lines left justified, e.g.,
+
+	Afternoon, n.:
+		That part of the day we spend worrying about how we wasted
+	the morning.
+
+Quotes are sometimes put around statements which are funnier or make more
+sense if they are understood as being spoken, rather than written,
+communication, e.g.,
+
+	"All my friends and I are crazy.  That's the only thing that
+	keeps us sane."
+
+Ellipses are always surrounded by spaces, except when next to punctuation,
+and are three dots long.
+
+	"... all the modern inconveniences ..."
+			-- Mark Twain
+
+Human initials always have spaces after the periods, e.g, "P. T.  Barnum",
+not "P.T. Barnum".  However, "P.T.A.", not "P. T. A.".
+
+All fortunes should be attributed, but if and only if they are original with
+somebody.  Many people have said things that are folk sayings (i.e., are
+common among the folk (i.e., us common slobs)).  There is nothing wrong with
+this, of course, but such statements should not be attributed to individuals
+who did not invent them.
+
+Horoscopes should have the sign indented by one tab stop, followed by the
+dates of the sign, with the text left justified below it, e.g.,
+
+		AQUARIUS (Jan 20 - Feb 18)
+	You have an inventive mind and are inclined to be progressive.  You
+	lie a great deal.  On the other hand, you are inclined to be
+	careless and impractical, causing you to make the same mistakes over
+	and over again.  People think you are stupid.
+
+Single quotes should not be used except as quotes within quotes.  Not even
+single quotes masquerading as double quotes are to be used, e.g., don't say
+``hi there'' or `hi there' or 'hi there', but "hi there".  However, you
+*can* say "I said, `hi there'".
+
+A long poem or song can be ordered as follows in order to make it fit on a
+screen (fortunes should be 19 lines or less if at all possible) (numbers
+here are stanza numbers):
+
+	11111111111111111111
+	11111111111111111111
+	11111111111111111111			22222222222222222222
+	11111111111111111111			22222222222222222222
+						22222222222222222222
+	33333333333333333333			22222222222222222222
+	33333333333333333333
+	33333333333333333333			44444444444444444444
+	33333333333333333333			44444444444444444444
+						44444444444444444444
+						44444444444444444444
+
+

package/third-party/fortune-mod-1.99.1/README.md

@@ -0,0 +1,19 @@
+# fortune-mod 1.99.1 notices
+
+Verbatim from the `fortune-mod-1.99.1` tarball
+(<https://github.com/shlomif/fortune-mod/archive/refs/tags/fortune-mod-1.99.1.tar.gz>,
+sha256 `22bfb63917192718df8929e2cb2beb5e85e7e1afbd643e6280cc138116f77a33`), so
+the attribution travels with the package instead of pointing at a tarball.
+
+- `fortune.c.license` — `fortune/fortune.c`, lines 1-37: the 4-clause BSD notice
+  for fortune(6), copyright 1986, 1993 The Regents of the University of
+  California, derived from software contributed to Berkeley by Ken Arnold.
+  Berkeley rescinded the advertising clause for its own code in 1999, so it is
+  usually quoted as BSD 3-Clause today. It covers the C program, not the
+  quotations.
+- `Notes` — `Notes` (NetBSD, `$NetBSD: Notes,v 1.2 1995/03/23 08:28:26 cgd Exp $`):
+  the only statement upstream makes about the database, which was collected
+  haphazardly, has uncheckable attributions, and is used under fair use.
+
+The release contains no `COPYING` or `LICENSE` file, and no file under
+`datfiles/` carries a notice.

package/third-party/fortune-mod-1.99.1/fortune.c.license

@@ -0,0 +1,37 @@
+/*      $NetBSD: fortune.c,v 1.8 1995/03/23 08:28:40 cgd Exp $  */
+
+/*-
+ * Copyright (c) 1986, 1993
+ *	The Regents of the University of California.  All rights reserved.
+ *
+ * This code is derived from software contributed to Berkeley by
+ * Ken Arnold.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ * 3. All advertising materials mentioning features or use of this software
+ *    must display the following acknowledgement:
+ *	This product includes software developed by the University of
+ *	California, Berkeley and its contributors.
+ * 4. Neither the name of the University nor the names of its contributors
+ *    may be used to endorse or promote products derived from this software
+ *    without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ */

package/.npmignore

@@ -1,27 +0,0 @@
-# Logs
-logs
-*.log
-
-# Runtime data
-pids
-*.pid
-*.seed
-
-# 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
-
-# Compiled binary addons (http://nodejs.org/api/addons.html)
-build/Release
-
-# Dependency directory
-# Deployed apps should consider commenting this line out:
-# see https://npmjs.org/doc/faq.html#Should-I-check-my-node_modules-folder-into-git
-node_modules
-
-build