Fold refinedBy and any into core selector package
authorRandall Leeds <randall@apache.org>
Sat, 9 Jun 2018 20:11:38 +0000 (13:11 -0700)
committerRandall Leeds <randall@apache.org>
Sat, 9 Jun 2018 20:11:38 +0000 (13:11 -0700)
demo/search.js
packages/any/.npmignore [deleted file]
packages/any/LICENSE [deleted file]
packages/any/NOTICE [deleted file]
packages/any/package.json [deleted file]
packages/refinedBy/src/index.mjs [deleted file]
packages/selector/.npmignore [moved from packages/refinedBy/.npmignore with 100% similarity]
packages/selector/LICENSE [moved from packages/refinedBy/LICENSE with 100% similarity]
packages/selector/NOTICE [moved from packages/refinedBy/NOTICE with 100% similarity]
packages/selector/package.json [moved from packages/refinedBy/package.json with 81% similarity]
packages/selector/src/index.mjs [moved from packages/any/src/index.mjs with 54% similarity]

index 82a029b..b6f81cf 100644 (file)
  * the License.
  */
 
-import { createAnySelector } from '@annotator/any';
+import { createRangeSelector } from '@annotator/range';
+import { createAnySelectorCreator } from '@annotator/selector';
+import { createTextQuoteSelector } from '@annotator/text';
 
-const selectorFunc = createAnySelector();
+const allSelectorTypes = {
+  TextQuoteSelector: createTextQuoteSelector,
+  RangeSelector: createRangeSelector,
+};
+
+const selectorFunc = createAnySelectorCreator(allSelectorTypes)();
 
 /**
  * Locate a selector.
diff --git a/packages/any/.npmignore b/packages/any/.npmignore
deleted file mode 100644 (file)
index 281df39..0000000
+++ /dev/null
@@ -1,2 +0,0 @@
-src
-test
diff --git a/packages/any/LICENSE b/packages/any/LICENSE
deleted file mode 100644 (file)
index d14c5bb..0000000
+++ /dev/null
@@ -1,259 +0,0 @@
-
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright [yyyy] [name of copyright owner]
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.
-
-
-Annotator Subcomponents:
-
-Annotator includes a number of subcomponents with separate copyright notices and
-license terms. Your use of the code for the these subcomponents is subject to
-the terms and conditions of the following licenses.
-
-
-For the file packages/fragment/src/fragment.pegjs:
-
-  Copyright (c) 2016 World Wide Web Consortium, (Massachusetts Institute of
-  Technology, European Research Consortium for Informatics and Mathematics, Keio
-  University, Beihang). All Rights Reserved. This work is distributed under the
-  W3C(R) Software License [1] in the hope that it will be useful, but WITHOUT
-  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
-  FOR A PARTICULAR PURPOSE.
-
-  [1] http://www.w3.org/Consortium/Legal/copyright-software
-
-  License
-
-  By obtaining and/or copying this work, you (the licensee) agree that you have
-  read, understood, and will comply with the following terms and conditions.
-
-  Permission to copy, modify, and distribute this work, with or without
-  modification, for any purpose and without fee or royalty is hereby granted,
-  provided that you include the following on ALL copies of the work or portions
-  thereof, including modifications:
-
-      * The full text of this NOTICE in a location viewable to users of the
-        redistributed or derivative work.
-
-      * Any pre-existing intellectual property disclaimers, notices, or terms
-        and conditions. If none exist, the W3C Software and Document Short
-        Notice should be included.
-
-      * Notice of any changes or modifications, through a copyright statement on
-        the new code or document such as "This software or document includes
-        material copied from or derived from [title and URI of the W3C
-        document]. Copyright © [YEAR] W3C® (MIT, ERCIM, Keio, Beihang)."
-
-  Disclaimers
-
-  THIS WORK IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE NO REPRESENTATIONS
-  OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO, WARRANTIES OF
-  MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF THE
-  SOFTWARE OR DOCUMENT WILL NOT INFRINGE ANY THIRD PARTY PATENTS, COPYRIGHTS,
-  TRADEMARKS OR OTHER RIGHTS.
-
-  COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR
-  CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR DOCUMENT.
-
-  The name and trademarks of copyright holders may NOT be used in advertising or
-  publicity pertaining to the work without specific, written prior
-  permission. Title to copyright in this work will at all times remain with
-  copyright holders.
diff --git a/packages/any/NOTICE b/packages/any/NOTICE
deleted file mode 100644 (file)
index 559531f..0000000
+++ /dev/null
@@ -1,5 +0,0 @@
-Apache Annotator
-Copyright 2016-2018 The Apache Software Foundation
-
-This product includes software developed at The Apache Software
-Foundation (http://www.apache.org/).
diff --git a/packages/any/package.json b/packages/any/package.json
deleted file mode 100644 (file)
index c481bc5..0000000
+++ /dev/null
@@ -1,19 +0,0 @@
-{
-  "name": "@annotator/any",
-  "version": "0.0.0",
-  "description": "Utilities for annotation.",
-  "homepage": "https://annotator.apache.org",
-  "license": "Apache-2.0",
-  "author": "Apache Software Foundation",
-  "main": "lib",
-  "repository": {
-    "type": "git",
-    "url": "https://gitbox.apache.org/repos/asf/incubator-annotator.git"
-  },
-  "peerDependencies": {
-    "@babel/runtime": "^7.0.0-beta.40"
-  },
-  "publishConfig": {
-    "access": "public"
-  }
-}
diff --git a/packages/refinedBy/src/index.mjs b/packages/refinedBy/src/index.mjs
deleted file mode 100644 (file)
index f4f8b9a..0000000
+++ /dev/null
@@ -1,37 +0,0 @@
-export function makeRefinable(selector, { createAnySelector }) {
-  async function* refinableSelector({ descriptors, context }) {
-    const matches = selector({ descriptors, context });
-    for await (let match of matches) {
-      const refiningDescriptor = match.descriptor.refinedBy;
-      if (refiningDescriptor) {
-        const anySelector = createAnySelector();
-        const refiningMatches = anySelector({
-          descriptors: [refiningDescriptor],
-          context: matchAsContext(match),
-        });
-        for await (let refiningMatch of refiningMatches) {
-          const refinedMatch = composeMatches(refiningMatch, match);
-          yield refinedMatch;
-        }
-      } else {
-        yield match;
-      }
-    }
-  }
-
-  return refinableSelector;
-}
-
-function matchAsContext(match) {
-  return match[0];
-}
-
-function composeMatches(...matches) {
-  return matches.reverse().reduce((match, refiningMatch) => {
-    const refinedMatch = [...refiningMatch];
-    refinedMatch.index = match.index + refiningMatch.index;
-    refinedMatch.input = match.input;
-    refinedMatch.descriptor = match.descriptor;
-    return refinedMatch;
-  });
-}
similarity index 81%
rename from packages/refinedBy/package.json
rename to packages/selector/package.json
index 08ee262..a25eb6c 100644 (file)
@@ -1,7 +1,7 @@
 {
-  "name": "@annotator/refinedBy",
+  "name": "@annotator/selector",
   "version": "0.0.0",
-  "description": "Utilities for annotation.",
+  "description": "Web Annotation selector for engine.",
   "homepage": "https://annotator.apache.org",
   "license": "Apache-2.0",
   "author": "Apache Software Foundation",
similarity index 54%
rename from packages/any/src/index.mjs
rename to packages/selector/src/index.mjs
index 6772eeb..a7cebba 100644 (file)
  * the License.
  */
 
-import { createTextQuoteSelector } from '@annotator/text';
-import { createRangeSelector } from '@annotator/range';
-import { makeRefinable } from '@annotator/refinedBy';
-
 export function createAnySelectorCreator(selectorCreatorsByType) {
   function selectSelector(type) {
     const selectorCreator = selectorCreatorsByType[type];
@@ -40,9 +36,40 @@ export function createAnySelectorCreator(selectorCreatorsByType) {
   return createAnySelector;
 }
 
-export const allSelectorTypes = {
-  TextQuoteSelector: createTextQuoteSelector,
-  RangeSelector: createRangeSelector,
-};
+export function makeRefinable(selector, { createAnySelector }) {
+  async function* refinableSelector({ descriptors, context }) {
+    const matches = selector({ descriptors, context });
+    for await (let match of matches) {
+      const refiningDescriptor = match.descriptor.refinedBy;
+      if (refiningDescriptor) {
+        const anySelector = createAnySelector();
+        const refiningMatches = anySelector({
+          descriptors: [refiningDescriptor],
+          context: matchAsContext(match),
+        });
+        for await (let refiningMatch of refiningMatches) {
+          const refinedMatch = composeMatches(refiningMatch, match);
+          yield refinedMatch;
+        }
+      } else {
+        yield match;
+      }
+    }
+  }
+
+  return refinableSelector;
+}
+
+function matchAsContext(match) {
+  return match[0];
+}
 
-export const createAnySelector = createAnySelectorCreator(allSelectorTypes);
+function composeMatches(...matches) {
+  return matches.reverse().reduce((match, refiningMatch) => {
+    const refinedMatch = [...refiningMatch];
+    refinedMatch.index = match.index + refiningMatch.index;
+    refinedMatch.input = match.input;
+    refinedMatch.descriptor = match.descriptor;
+    return refinedMatch;
+  });
+}