panko_serializer 0.7.2 → 0.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 113773350335975bb72a426665ddd642c5e17612418bdc7d01ddf21bfeb27f5d
-  data.tar.gz: 8de6d3fa50c0dbf44ab72b56c613b0ab84c5fe5e2a5dafe1b32fd226dcb1fb25
+  metadata.gz: d5d2ed524b5e6de2f16281cb90c8d6aca2ade9f6ad87429bce588755fb34ed7e
+  data.tar.gz: 4c7f3cab3e5822242c7afabdd3622cfb9db2fde3c51674ed2a2f6545cf4042c5
 SHA512:
-  metadata.gz: 6581eb3745efde92f3ad78e36c89f08e312a9f9156e9248446ab071acb9d7b353a3e3fee43ec5bc4d2d950d49de3e5fdb91ddd151b9f270a63342f1baaabd306
-  data.tar.gz: 6e1a68875a179725664662d02d3c196f9877ca43750c7d2d29328eee63fdb754b931214030aa67778b78a5a88da2b4fafa30fc8247fd84070de5485519e9a5ec
+  metadata.gz: f3f217bfdf440f325d981bab44854d0ee9715907127982f6aa023acbbd0a65286c977115c89b03f1f0c4ebd4dae61497bec06dd25cd530b5884396cd3c0db7ec
+  data.tar.gz: a167d0e32b1fe3287208525cee3291ec13a142dc39c484fdb2542dc4f2999a2d1c72cfacf49eaf98def980576361811279e183a1fbae462542baadbf7981d562

data/.gitignore

@@ -13,5 +13,6 @@
 
 # rspec failure tracking
 .rspec_status
-_docpress
 node_modules
+
+/docs/build/

data/.travis.yml

@@ -21,11 +21,11 @@ install: bundle install --path=vendor/bundle --retry=3
 
 before_install:
   - gem install bundler
-  - nvm install 9
+  - nvm install 12
 
 after_success:
-  - npm install docpress && $(npm bin)/docpress build
-  - if [ -n "$TRAVIS_TAG" -a "$TRAVIS_PULL_REQUEST" = "false" ]; then npm install git-update-ghpages && $(npm bin)/git-update-ghpages yosiat/panko_serializer _docpress; fi
+  - cd docs/ && npm install
+  - if [ -n "$TRAVIS_TAG" -a "$TRAVIS_PULL_REQUEST" = "false" ]; then cd docs/ && npm install && GIT_USER=yosiat CURRENT_BRANCH=news-docs USE_SSH=true npm run publish-gh-pages; fi
   - bundle exec rake benchmarks
 
 matrix:

data/README.md

@@ -4,20 +4,20 @@
 
 Panko is library which is inspired by ActiveModelSerializers 0.9 for serializing ActiveRecord/Ruby objects to JSON strings, fast.
 
-To achieve it's [performance](https://yosiat.github.io/panko_serializer/performance.html):
+To achieve it's [performance](https://panko.dev/docs/performance.html):
 
 * Oj - Panko relies Oj since it's fast and allow to to serialize incrementally using `Oj::StringWriter`
 * Serialization Descriptor - Panko computes most of the metadata ahead of time, to save time later in serialization.
 * Type casting — Panko does type casting by it's self, instead of relying ActiveRecord.
 
-To dig deeper about the performance choices, read [Design Choices](https://yosiat.github.io/panko_serializer/design-choices.html).
+To dig deeper about the performance choices, read [Design Choices](https://panko.dev/docs/design-choices.html).
 
 
 Support
 -------
 
-- [Documentation](https://yosiat.github.io/panko_serializer)
-- [Getting Started](https://yosiat.github.io/panko_serializer/getting-started.html)
+- [Documentation](https://panko.dev/docs)
+- [Getting Started](https://panko.dev/docs/getting-started.html)
 - Join our [slack community](https://pankoserializer.herokuapp.com/)
 
 License

data/benchmarks/bm_panko_json.rb

@@ -12,6 +12,10 @@ class PostFastSerializer < Panko::Serializer
   attributes :id, :body, :title, :author_id, :created_at
 end
 
+class PostFastWithJsonSerializer < Panko::Serializer
+  attributes :id, :body, :title, :author_id, :created_at, :data
+end
+
 class PostFastWithMethodCallSerializer < Panko::Serializer
   attributes :id, :body, :title, :author_id, :method_call
 
@@ -32,7 +36,6 @@ class AuthorWithHasManyFastSerializer < Panko::Serializer
   has_many :posts, serializer: PostFastSerializer
 end
 
-
 def benchmark(prefix, serializer, options = {})
   data = Benchmark.data
   posts = data[:all]
@@ -54,6 +57,7 @@ def benchmark(prefix, serializer, options = {})
 end
 
 benchmark "Simple", PostFastSerializer
+benchmark "SimpleWithJson", PostFastWithJsonSerializer
 benchmark "HasOne", PostWithHasOneFastSerializer
 benchmark "SimpleWithMethodCall", PostFastWithMethodCallSerializer
 benchmark "Except", PostWithHasOneFastSerializer, except: [:title]

data/benchmarks/setup.rb

@@ -25,6 +25,7 @@ ActiveRecord::Schema.define do
     t.text :body
     t.string :title
     t.references :author
+    t.json :data
     t.timestamps(null: false)
   end
 end
@@ -47,7 +48,8 @@ Post.transaction do
     Post.create(
       body: "something about how password restrictions are evil, and less secure, and with the math to prove it.",
       title: "Your bank is does not know how to do security",
-      author: Author.create(name: "Preston Sego")
+      author: Author.create(name: "Preston Sego"),
+      data: { a: 1, b: 2, c: 3 }
     )
   end
 end

data/benchmarks/type_casts/bm_panko.rb

@@ -59,10 +59,10 @@ if ENV["RAILS_VERSION"].start_with? "4.2"
 end
 
 if check_if_exists "ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Json"
-  panko_type_convert ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Json, '{"a":1}', {a:1}
+  panko_type_convert ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Json, '{"a":1}', '{"a":1}'
 end
 if check_if_exists "ActiveRecord::Type::Json"
-  panko_type_convert ActiveRecord::Type::Json, '{"a":1}', {a:1}
+  panko_type_convert ActiveRecord::Type::Json, '{"a":1}', '{"a":1}'
 end
 db_panko_time
 utc_panko_time

data/docs/README.md

@@ -1,11 +1,198 @@
-* [Panko](../README.md)
-* [Getting Started](getting-started.md)
-* Reference
-  * [Attributes](attributes.md)
-  * [Associations](associations.md)
-  * [Response bag](response-bag.md)
-* [Performance](performance.md)
-* [Design Choices](design-choices.md)
+This website was created with [Docusaurus](https://docusaurus.io/).
 
+# What's In This Document
 
+- [Get Started in 5 Minutes](#get-started-in-5-minutes)
+- [Directory Structure](#directory-structure)
+- [Editing Content](#editing-content)
+- [Adding Content](#adding-content)
+- [Full Documentation](#full-documentation)
 
+# Get Started in 5 Minutes
+
+1. Make sure all the dependencies for the website are installed:
+
+```sh
+# Install dependencies
+$ yarn
+```
+
+2. Run your dev server:
+
+```sh
+# Start the site
+$ yarn start
+```
+
+## Directory Structure
+
+Your project file structure should look something like this
+
+```
+my-docusaurus/
+  docs/
+    doc-1.md
+    doc-2.md
+    doc-3.md
+  website/
+    blog/
+      2016-3-11-oldest-post.md
+      2017-10-24-newest-post.md
+    core/
+    node_modules/
+    pages/
+    static/
+      css/
+      img/
+    package.json
+    sidebars.json
+    siteConfig.js
+```
+
+# Editing Content
+
+## Editing an existing docs page
+
+Edit docs by navigating to `docs/` and editing the corresponding document:
+
+`docs/doc-to-be-edited.md`
+
+```markdown
+---
+id: page-needs-edit
+title: This Doc Needs To Be Edited
+---
+
+Edit me...
+```
+
+For more information about docs, click [here](https://docusaurus.io/docs/en/navigation)
+
+## Editing an existing blog post
+
+Edit blog posts by navigating to `website/blog` and editing the corresponding post:
+
+`website/blog/post-to-be-edited.md`
+
+```markdown
+---
+id: post-needs-edit
+title: This Blog Post Needs To Be Edited
+---
+
+Edit me...
+```
+
+For more information about blog posts, click [here](https://docusaurus.io/docs/en/adding-blog)
+
+# Adding Content
+
+## Adding a new docs page to an existing sidebar
+
+1. Create the doc as a new markdown file in `/docs`, example `docs/newly-created-doc.md`:
+
+```md
+---
+id: newly-created-doc
+title: This Doc Needs To Be Edited
+---
+
+My new content here..
+```
+
+1. Refer to that doc's ID in an existing sidebar in `website/sidebars.json`:
+
+```javascript
+// Add newly-created-doc to the Getting Started category of docs
+{
+  "docs": {
+    "Getting Started": [
+      "quick-start",
+      "newly-created-doc" // new doc here
+    ],
+    ...
+  },
+  ...
+}
+```
+
+For more information about adding new docs, click [here](https://docusaurus.io/docs/en/navigation)
+
+## Adding a new blog post
+
+1. Make sure there is a header link to your blog in `website/siteConfig.js`:
+
+`website/siteConfig.js`
+
+```javascript
+headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+```
+
+2. Create the blog post with the format `YYYY-MM-DD-My-Blog-Post-Title.md` in `website/blog`:
+
+`website/blog/2018-05-21-New-Blog-Post.md`
+
+```markdown
+---
+author: Frank Li
+authorURL: https://twitter.com/foobarbaz
+authorFBID: 503283835
+title: New Blog Post
+---
+
+Lorem Ipsum...
+```
+
+For more information about blog posts, click [here](https://docusaurus.io/docs/en/adding-blog)
+
+## Adding items to your site's top navigation bar
+
+1. Add links to docs, custom pages or external links by editing the headerLinks field of `website/siteConfig.js`:
+
+`website/siteConfig.js`
+
+```javascript
+{
+  headerLinks: [
+    ...
+    /* you can add docs */
+    { doc: 'my-examples', label: 'Examples' },
+    /* you can add custom pages */
+    { page: 'help', label: 'Help' },
+    /* you can add external links */
+    { href: 'https://github.com/facebook/docusaurus', label: 'GitHub' },
+    ...
+  ],
+  ...
+}
+```
+
+For more information about the navigation bar, click [here](https://docusaurus.io/docs/en/navigation)
+
+## Adding custom pages
+
+1. Docusaurus uses React components to build pages. The components are saved as .js files in `website/pages/en`:
+1. If you want your page to show up in your navigation header, you will need to update `website/siteConfig.js` to add to the `headerLinks` element:
+
+`website/siteConfig.js`
+
+```javascript
+{
+  headerLinks: [
+    ...
+    { page: 'my-new-custom-page', label: 'My New Custom Page' },
+    ...
+  ],
+  ...
+}
+```
+
+For more information about custom pages, click [here](https://docusaurus.io/docs/en/custom-pages).
+
+# Full Documentation
+
+Full documentation can be found on the [website](https://docusaurus.io/).

data/docs/core/Footer.js

@@ -0,0 +1,81 @@
+/**
+ * Copyright (c) 2017-present, Facebook, Inc.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+const React = require('react');
+
+class Footer extends React.Component {
+  docUrl(doc, language) {
+    const baseUrl = this.props.config.baseUrl;
+    const docsUrl = this.props.config.docsUrl;
+    const docsPart = `${docsUrl ? `${docsUrl}/` : ''}`;
+    return `${baseUrl}${docsPart}${doc}`;
+  }
+
+  pageUrl(doc, language) {
+    const baseUrl = this.props.config.baseUrl;
+    return baseUrl + (language ? `${language}/` : '') + doc;
+  }
+
+  render() {
+    return (
+      <footer className="nav-footer" id="footer">
+        <section className="sitemap">
+          <a href={this.props.config.baseUrl} className="nav-home">
+            {this.props.config.footerIcon && (
+              <img
+                src={this.props.config.baseUrl + this.props.config.footerIcon}
+                alt={this.props.config.title}
+                width="66"
+                height="58"
+              />
+            )}
+          </a>
+          <div>
+            <h5>Docs</h5>
+            <a href={this.docUrl('getting-started.html', this.props.language)}>
+              Getting Started
+            </a>
+            <a href={this.docUrl('attributes.html', this.props.language)}>
+              Guides
+            </a>
+            <a href={this.docUrl('performance.html', this.props.language)}>
+              Performance
+            </a>
+          </div>
+          <div>
+            <h5>More</h5>
+            <a href="https://github.com/yosiat/panko_serializer">GitHub</a>
+            <a href="https://pankoserializer.herokuapp.com/">Slack</a>
+            <a
+              className="github-button"
+              href={this.props.config.repoUrl}
+              data-icon="octicon-star"
+              data-count-href="/yosiat/panko_serializer/stargazers"
+              data-show-count="true"
+              data-count-aria-label="# stargazers on GitHub"
+              aria-label="Star this project on GitHub">
+              Star
+            </a>
+            {this.props.config.twitterUsername && (
+              <div className="social">
+                <a
+                  href={`https://twitter.com/${this.props.config.twitterUsername}`}
+                  className="twitter-follow-button">
+                  Follow @{this.props.config.twitterUsername}
+                </a>
+              </div>
+            )}
+          </div>
+        </section>
+
+        <section className="copyright">{this.props.config.copyright}</section>
+      </footer>
+    );
+  }
+}
+
+module.exports = Footer;

data/docs/{associations.md → docs/associations.md}

@@ -1,4 +1,8 @@
-# Associations
+---
+id: associations
+title: Associations
+sidebar_label: Associations
+---
 
 A serializer can define it's own associations - both `has_many` and `has_one` to serializer under the context of the object.
 

data/docs/{attributes.md → docs/attributes.md}

@@ -1,4 +1,8 @@
-# Attributes
+---
+id: attributes
+title: Attributes
+sidebar_label: Attributes
+---
 
 Attributes allow you to specify which record attributes you want to serialize,
 There are two types of attributes:
@@ -42,7 +46,7 @@ end
 
 Another useful, thing you can pass your serializer is `context`, a `context` is a bag of data whom your serializer may need.
 
-For example, here we will pass the current user:
+For example, here we will pass feature flags:
 ```ruby
 class UserSerializer < Panko::Serializer
   attributes :id, :email

data/docs/{design-choices.md → docs/design-choices.md}

@@ -1,4 +1,8 @@
-# Design Choices
+---
+id: design-choices
+title: Design Choices
+sidebar_label: Design Choices
+---
 
 In short, Panko, is a serializer for ActiveRecord objects (it can't serialize any other object), which strives for high performance & simple API (which is inspired by ActiveModelSerializers).