Starting as Open Source

Author: ghostganz

.gitignore

@@ -0,0 +1,6 @@
+/node_modules/
+
+# IntelliJ
+/.idea/
+# Emacs
+*~

CHANGELOG.md

@@ -0,0 +1,3 @@
+## 1.0.0 - YYYY-MM-DD
+
+First public version.

CONTRIBUTING.md

@@ -0,0 +1,32 @@
+# Guidance on how to contribute
+
+> All contributions to this project will be released under the MIT License.
+> By submitting a pull request or filing a bug, issue, or
+> feature request, you are agreeing to comply with this waiver of copyright interest.
+> Details can be found in [LICENSE](LICENSE).
+
+
+There are two primary ways to help:
+ - Using the issue tracker, and
+ - Changing the code-base.
+
+
+## Using the issue tracker
+
+Use the issue tracker to suggest feature requests, report bugs, and ask questions.
+This is also a great way to connect with the developers of the project as well
+as others who are interested in this solution.
+
+Use the issue tracker to find ways to contribute. Find a bug or a feature, mention in
+the issue that you will take on that effort, then follow the _Changing the code-base_
+guidance below.
+
+
+## Changing the code-base
+
+Generally speaking, you should fork this repository, make changes in your
+own fork, and then submit a pull-request. All new code should have associated unit
+tests that validate implemented features and the presence or lack of defects.
+Additionally, the code should follow any stylistic and architectural guidelines
+prescribed by the project. In the absence of such guidelines, mimic the styles
+and patterns in the existing code-base.

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Sveriges Television AB
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,155 @@
+
+# graphql-defragmentizer
+
+*Library for building [GraphQL](https://github.com/graphql/graphql-js) queries
+from fragments in JavaScript.*
+
+It combines the main query, the fragments and their sub-fragments into one
+valid query. Useful for React apps, if you want each component to specify
+its own data requirements, but still want to run a single GraphQL query.
+
+It can be used on React components in a way similar to [`prop-types`](https://github.com/facebook/prop-types)
+declarations.
+
+There's no dependency on React and can be used by all kinds of GraphQL clients.
+
+### Status
+
+We're using it in production at [SVT](https://www.svt.se/opensource/) and will likely fix problems if we encounter any.
+[Contributions](CONTRIBUTING.md) are welcome!  
+
+## API
+
+### `` createQuery`...` ``
+
+Creates a GraphQL `Document` from a template string.
+
+Values are usually fragments (created by `createFragment`). Fragments must be placed where
+you would normally place the _name_ of a fragment.
+
+If the values aren't fragments, they'll be appended to the query (with `String()` conversion).
+
+The query and the fragments (and their sub-fragments) will be recursively combined into a
+valid GraphQL query, combining any duplicate fragments into one.
+
+If you don't use fragments, it's mostly identical to the `` gql`...` `` function
+of [`graphql-tag`](https://github.com/apollographql/graphql-tag).
+
+Usage:
+
+    const query = createQuery`
+      query MyQuery {
+        someQuery {
+          ... ${myFragment}
+        }
+      }`;
+
+### `` createFragment`...` ``
+
+Creates a fragment from a template string, for use by `createQuery` or a parent `createFragment` call.
+
+The template string must be a valid GraphQL fragment definition, but without the _name_. It can have
+other fragments as values.
+
+If the values aren't fragments, they'll be appended to the fragment (with `String()` conversion).
+
+Usage:
+
+    const fragment = createFragment`
+      ... on MyThing {
+        name
+        friends {
+          ... ${friendFragment}
+        }
+      }`;
+
+## Example with React
+
+Showing a latest news list on a web page:
+
+Main.js:
+
+    import { createQuery } from 'graphql-defragmentizer';
+    import { graphql } from 'react-apollo';
+
+    const MainQuery = createQuery`
+      query MainQuery {
+        main {
+          latestNews {
+            ...${LatestNews.fragments.latestNews}
+          }
+          mainTitle
+        }
+      }
+    `;
+
+    function Main({ mainTitle, latestNews }) {
+        return
+          <div>
+            <h1>{mainTitle}</h1>
+            <p><LatestNews latestNews={latestNews} /></p>
+          </div>
+    }
+
+    export default graphql(MainQuery,
+      props: props => ({
+        latestNews: props.data.main.latestNews,
+        mainTitle: props.data.main.mainTitle 
+      })
+    )(Main);
+
+LatestNews.js:
+    
+    import { createFragment } from 'graphql-defragmentizer';
+
+    export default function LatestNews({ latestNews }) {
+      return latestNews.map((item) => {
+         <a href={url}>{title}</a>
+      }
+    }
+
+    LatestNews.fragments = {
+      latestNews: createFragment`
+        ... on LatestNewsItem {
+          title
+          url
+        }
+      `
+    };
+    
+This would build a query like this:
+
+    query MainQuery {
+      main {
+        latestNews {
+          ...fragment_fevfrc
+        }
+        mainTitle
+      }
+    }
+    
+    fragment fragment_fevfrc on LatestNewsItem {
+      title
+      url
+    }
+
+The name "fragment_fevfrc" is created by hashing the contents and type of the
+fragment, so two identical fragments will be merged into one.
+
+## License
+
+Copyright (c) 2019 Sveriges Television AB.
+
+graphql-defragmentizer is released under the [MIT License](LICENSE).
+
+## Getting involved
+
+Feel free to issue pull requests or file issues. For more details, see [CONTRIBUTING](CONTRIBUTING.md) 
+
+## Primary Maintainer
+
+Anders Kindberg [https://github.com/ghostganz](https://github.com/ghostganz)
+
+## Credits
+
+Original implementation by [Emil Broman](https://github.com/emilniklas).

index.js

@@ -0,0 +1,94 @@
+/* eslint no-bitwise: 0 */
+
+const { parse } = require('graphql/language/parser');
+
+function nonSecureHash(s) {
+  let hash = 0;
+  for (let i = 0; i < s.length; i++) {
+    let char = s.charCodeAt(i);
+    const mixed = (hash << 5) - hash;
+    hash = mixed + char;
+    hash = hash & hash; // Convert to 32bit integer
+  }
+  return hash;
+}
+
+class NotFragment {
+  constructor(value) {
+    this.name = String(value);
+  }
+
+  collectFragments(acc) {
+    return acc;
+  }
+}
+
+class Fragment {
+  constructor(segments, childFragments) {
+    this.segments = segments;
+    this.childFragments = childFragments.map(f => {
+      if (!(f instanceof Fragment)) {
+        return new NotFragment(f);
+      }
+      return f;
+    });
+
+    const hash = nonSecureHash([...segments, ...this.childNames()].join(''));
+    this.name = `fragment_${Math.abs(hash).toString(36)}`;
+  }
+
+  format() {
+    return `fragment ${this.name} ${interleaveStrings(
+      this.segments,
+      this.childNames()
+    ).replace('...', '')}`;
+  }
+
+  childNames() {
+    return this.childFragments.map(f => f.name);
+  }
+
+  collectFragments(acc) {
+    const children = this.childFragments.reduce(
+      (acc, f) => f.collectFragments(acc),
+      acc
+    );
+    return [this, ...children];
+  }
+}
+
+function createFragment(segments, ...childFragments) {
+  return new Fragment(segments, childFragments);
+}
+
+function interleaveStrings(array1, array2) {
+  return array1.map((string, i) => string + (array2[i] || '')).join('');
+}
+
+function uniqueFragments(collectedFragments) {
+  const uniqueFragmentMap = {};
+  for (const fragment of collectedFragments) {
+    uniqueFragmentMap[fragment.name] = fragment;
+  }
+  return Object.keys(uniqueFragmentMap)
+    .sort()
+    .map(name => uniqueFragmentMap[name]);
+}
+
+function createQuery(segments, ...childFragments) {
+  const root = new Fragment([], childFragments);
+  const collectedFragments = root.collectFragments([]);
+  collectedFragments.shift(); // Skip root
+
+  const fragmentsString = uniqueFragments(collectedFragments)
+    .map(fragment => fragment.format())
+    .join('\n');
+  const clonedSegments = segments.slice();
+  clonedSegments[clonedSegments.length - 1] += fragmentsString;
+  return parse(interleaveStrings(clonedSegments, root.childNames()));
+}
+
+module.exports = {
+  createQuery,
+  createFragment
+};

package.json

@@ -0,0 +1,22 @@
+{
+  "name": "graphql-defragmentizer",
+  "version": "1.0.0",
+  "description": "Library for building GraphQL queries from fragments. Goes nicely with React.",
+  "main": "index.js",
+  "scripts": {
+    "test": "jest test.js"
+  },
+  "keywords": [
+    "graphql",
+    "react",
+    "apollo"
+  ],
+  "author": "Sveriges Television AB (https://www.svt.se/opensource/)",
+  "license": "MIT",
+  "dependencies": {
+    "graphql": "^14.4.2"
+  },
+  "devDependencies": {
+    "jest": "^24.9.0"
+  }
+}