panko_serializer 0.8.1 → 0.8.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (58) hide show
  1. checksums.yaml +4 -4
  2. data/.github/dependabot.yml +6 -0
  3. data/.github/workflows/docs.yml +6 -6
  4. data/.github/workflows/lint.yml +9 -19
  5. data/.github/workflows/ruby.yml +14 -10
  6. data/.gitignore +2 -0
  7. data/.rubocop.yml +29 -21
  8. data/Appraisals +29 -0
  9. data/Gemfile +12 -14
  10. data/README.md +6 -7
  11. data/Rakefile +3 -1
  12. data/benchmarks/allocs.rb +2 -2
  13. data/benchmarks/benchmarking_support.rb +2 -1
  14. data/benchmarks/bm_ams_0_10.rb +3 -7
  15. data/benchmarks/bm_panko_json.rb +2 -6
  16. data/benchmarks/bm_panko_object.rb +2 -6
  17. data/benchmarks/bm_plain_object.rb +1 -4
  18. data/benchmarks/bm_serialization_descriptor.rb +1 -1
  19. data/benchmarks/bm_to_object.rb +2 -6
  20. data/benchmarks/profile.rb +2 -2
  21. data/benchmarks/sanity.rb +2 -6
  22. data/benchmarks/setup.rb +4 -3
  23. data/benchmarks/type_casts/bm_active_record.rb +10 -39
  24. data/benchmarks/type_casts/bm_panko.rb +3 -6
  25. data/benchmarks/type_casts/support.rb +0 -1
  26. data/docs/docs/associations.md +20 -7
  27. data/docs/docs/attributes.md +29 -23
  28. data/docs/docs/design-choices.md +28 -27
  29. data/docs/docs/getting-started.md +9 -3
  30. data/docs/docs/introduction.md +5 -5
  31. data/docs/docs/performance.md +0 -1
  32. data/docs/docs/response-bag.md +8 -1
  33. data/docs/docusaurus.config.js +86 -0
  34. data/docs/package-lock.json +12607 -18674
  35. data/docs/package.json +14 -7
  36. data/docs/src/css/customTheme.css +9 -0
  37. data/docs/static/CNAME +1 -0
  38. data/ext/panko_serializer/attributes_writer/active_record.c +103 -72
  39. data/ext/panko_serializer/attributes_writer/active_record.h +2 -0
  40. data/ext/panko_serializer/attributes_writer/type_cast/type_cast.c +17 -0
  41. data/gemfiles/7.0.0.gemfile +39 -0
  42. data/gemfiles/7.0.0.gemfile.lock +176 -0
  43. data/gemfiles/7.1.0.gemfile +39 -0
  44. data/gemfiles/7.1.0.gemfile.lock +198 -0
  45. data/gemfiles/7.2.0.gemfile +39 -0
  46. data/gemfiles/7.2.0.gemfile.lock +198 -0
  47. data/gemfiles/8.0.0.gemfile +39 -0
  48. data/gemfiles/8.0.0.gemfile.lock +219 -0
  49. data/lib/panko/serializer.rb +1 -1
  50. data/lib/panko/version.rb +1 -1
  51. data/panko_serializer.gemspec +2 -1
  52. metadata +31 -10
  53. data/.standard.yml +0 -4
  54. data/docs/.DS_Store +0 -0
  55. data/docs/README.md +0 -198
  56. data/docs/core/Footer.js +0 -80
  57. data/docs/i18n/en.json +0 -50
  58. data/docs/siteConfig.js +0 -80
@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
21
21
  "changelog_uri" => "https://github.com/yosiat/panko_serializer/releases"
22
22
  }
23
23
 
24
- spec.required_ruby_version = ">= 2.5.0"
24
+ spec.required_ruby_version = ">= 3.1.0"
25
25
 
26
26
  spec.files = `git ls-files -z`.split("\x0").reject do |f|
27
27
  f.match(%r{^(test|spec|features)/})
@@ -32,4 +32,5 @@ Gem::Specification.new do |spec|
32
32
 
33
33
  spec.add_dependency "oj", "> 3.11.0", "< 4.0.0"
34
34
  spec.add_dependency "activesupport"
35
+ spec.add_development_dependency "appraisal"
35
36
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: panko_serializer
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.8.1
4
+ version: 0.8.3
5
5
  platform: ruby
6
6
  authors:
7
7
  - Yosi Attias
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-09-10 00:00:00.000000000 Z
11
+ date: 2024-12-15 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: oj
@@ -44,6 +44,20 @@ dependencies:
44
44
  - - ">="
45
45
  - !ruby/object:Gem::Version
46
46
  version: '0'
47
+ - !ruby/object:Gem::Dependency
48
+ name: appraisal
49
+ requirement: !ruby/object:Gem::Requirement
50
+ requirements:
51
+ - - ">="
52
+ - !ruby/object:Gem::Version
53
+ version: '0'
54
+ type: :development
55
+ prerelease: false
56
+ version_requirements: !ruby/object:Gem::Requirement
57
+ requirements:
58
+ - - ">="
59
+ - !ruby/object:Gem::Version
60
+ version: '0'
47
61
  description:
48
62
  email:
49
63
  - yosy101@gmail.com
@@ -53,13 +67,14 @@ extensions:
53
67
  extra_rdoc_files: []
54
68
  files:
55
69
  - ".clang-format"
70
+ - ".github/dependabot.yml"
56
71
  - ".github/workflows/docs.yml"
57
72
  - ".github/workflows/lint.yml"
58
73
  - ".github/workflows/ruby.yml"
59
74
  - ".gitignore"
60
75
  - ".rspec"
61
76
  - ".rubocop.yml"
62
- - ".standard.yml"
77
+ - Appraisals
63
78
  - Gemfile
64
79
  - LICENSE.txt
65
80
  - README.md
@@ -82,9 +97,6 @@ files:
82
97
  - benchmarks/type_casts/bm_active_record.rb
83
98
  - benchmarks/type_casts/bm_panko.rb
84
99
  - benchmarks/type_casts/support.rb
85
- - docs/.DS_Store
86
- - docs/README.md
87
- - docs/core/Footer.js
88
100
  - docs/docs/associations.md
89
101
  - docs/docs/attributes.md
90
102
  - docs/docs/design-choices.md
@@ -92,12 +104,13 @@ files:
92
104
  - docs/docs/introduction.md
93
105
  - docs/docs/performance.md
94
106
  - docs/docs/response-bag.md
95
- - docs/i18n/en.json
107
+ - docs/docusaurus.config.js
96
108
  - docs/package-lock.json
97
109
  - docs/package.json
98
110
  - docs/sidebars.json
99
- - docs/siteConfig.js
111
+ - docs/src/css/customTheme.css
100
112
  - docs/static/.DS_Store
113
+ - docs/static/CNAME
101
114
  - docs/static/css/custom.css
102
115
  - docs/static/img/favicon.ico
103
116
  - docs/static/img/oss_logo.png
@@ -135,6 +148,14 @@ files:
135
148
  - ext/panko_serializer/serialization_descriptor/attribute.h
136
149
  - ext/panko_serializer/serialization_descriptor/serialization_descriptor.c
137
150
  - ext/panko_serializer/serialization_descriptor/serialization_descriptor.h
151
+ - gemfiles/7.0.0.gemfile
152
+ - gemfiles/7.0.0.gemfile.lock
153
+ - gemfiles/7.1.0.gemfile
154
+ - gemfiles/7.1.0.gemfile.lock
155
+ - gemfiles/7.2.0.gemfile
156
+ - gemfiles/7.2.0.gemfile.lock
157
+ - gemfiles/8.0.0.gemfile
158
+ - gemfiles/8.0.0.gemfile.lock
138
159
  - lib/panko/array_serializer.rb
139
160
  - lib/panko/association.rb
140
161
  - lib/panko/attribute.rb
@@ -162,14 +183,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
162
183
  requirements:
163
184
  - - ">="
164
185
  - !ruby/object:Gem::Version
165
- version: 2.5.0
186
+ version: 3.1.0
166
187
  required_rubygems_version: !ruby/object:Gem::Requirement
167
188
  requirements:
168
189
  - - ">="
169
190
  - !ruby/object:Gem::Version
170
191
  version: '0'
171
192
  requirements: []
172
- rubygems_version: 3.4.19
193
+ rubygems_version: 3.5.23
173
194
  signing_key:
174
195
  specification_version: 4
175
196
  summary: High Performance JSON Serialization for ActiveRecord & Ruby Objects
data/.standard.yml DELETED
@@ -1,4 +0,0 @@
1
- ignore:
2
- - "ext/**/*"
3
- - "spec/**/*":
4
- - Lint/ConstantDefinitionInBlock
data/docs/.DS_Store DELETED
Binary file
data/docs/README.md DELETED
@@ -1,198 +0,0 @@
1
- This website was created with [Docusaurus](https://docusaurus.io/).
2
-
3
- # What's In This Document
4
-
5
- - [Get Started in 5 Minutes](#get-started-in-5-minutes)
6
- - [Directory Structure](#directory-structure)
7
- - [Editing Content](#editing-content)
8
- - [Adding Content](#adding-content)
9
- - [Full Documentation](#full-documentation)
10
-
11
- # Get Started in 5 Minutes
12
-
13
- 1. Make sure all the dependencies for the website are installed:
14
-
15
- ```sh
16
- # Install dependencies
17
- $ yarn
18
- ```
19
-
20
- 2. Run your dev server:
21
-
22
- ```sh
23
- # Start the site
24
- $ yarn start
25
- ```
26
-
27
- ## Directory Structure
28
-
29
- Your project file structure should look something like this
30
-
31
- ```
32
- my-docusaurus/
33
- docs/
34
- doc-1.md
35
- doc-2.md
36
- doc-3.md
37
- website/
38
- blog/
39
- 2016-3-11-oldest-post.md
40
- 2017-10-24-newest-post.md
41
- core/
42
- node_modules/
43
- pages/
44
- static/
45
- css/
46
- img/
47
- package.json
48
- sidebars.json
49
- siteConfig.js
50
- ```
51
-
52
- # Editing Content
53
-
54
- ## Editing an existing docs page
55
-
56
- Edit docs by navigating to `docs/` and editing the corresponding document:
57
-
58
- `docs/doc-to-be-edited.md`
59
-
60
- ```markdown
61
- ---
62
- id: page-needs-edit
63
- title: This Doc Needs To Be Edited
64
- ---
65
-
66
- Edit me...
67
- ```
68
-
69
- For more information about docs, click [here](https://docusaurus.io/docs/en/navigation)
70
-
71
- ## Editing an existing blog post
72
-
73
- Edit blog posts by navigating to `website/blog` and editing the corresponding post:
74
-
75
- `website/blog/post-to-be-edited.md`
76
-
77
- ```markdown
78
- ---
79
- id: post-needs-edit
80
- title: This Blog Post Needs To Be Edited
81
- ---
82
-
83
- Edit me...
84
- ```
85
-
86
- For more information about blog posts, click [here](https://docusaurus.io/docs/en/adding-blog)
87
-
88
- # Adding Content
89
-
90
- ## Adding a new docs page to an existing sidebar
91
-
92
- 1. Create the doc as a new markdown file in `/docs`, example `docs/newly-created-doc.md`:
93
-
94
- ```md
95
- ---
96
- id: newly-created-doc
97
- title: This Doc Needs To Be Edited
98
- ---
99
-
100
- My new content here..
101
- ```
102
-
103
- 1. Refer to that doc's ID in an existing sidebar in `website/sidebars.json`:
104
-
105
- ```javascript
106
- // Add newly-created-doc to the Getting Started category of docs
107
- {
108
- "docs": {
109
- "Getting Started": [
110
- "quick-start",
111
- "newly-created-doc" // new doc here
112
- ],
113
- ...
114
- },
115
- ...
116
- }
117
- ```
118
-
119
- For more information about adding new docs, click [here](https://docusaurus.io/docs/en/navigation)
120
-
121
- ## Adding a new blog post
122
-
123
- 1. Make sure there is a header link to your blog in `website/siteConfig.js`:
124
-
125
- `website/siteConfig.js`
126
-
127
- ```javascript
128
- headerLinks: [
129
- ...
130
- { blog: true, label: 'Blog' },
131
- ...
132
- ]
133
- ```
134
-
135
- 2. Create the blog post with the format `YYYY-MM-DD-My-Blog-Post-Title.md` in `website/blog`:
136
-
137
- `website/blog/2018-05-21-New-Blog-Post.md`
138
-
139
- ```markdown
140
- ---
141
- author: Frank Li
142
- authorURL: https://twitter.com/foobarbaz
143
- authorFBID: 503283835
144
- title: New Blog Post
145
- ---
146
-
147
- Lorem Ipsum...
148
- ```
149
-
150
- For more information about blog posts, click [here](https://docusaurus.io/docs/en/adding-blog)
151
-
152
- ## Adding items to your site's top navigation bar
153
-
154
- 1. Add links to docs, custom pages or external links by editing the headerLinks field of `website/siteConfig.js`:
155
-
156
- `website/siteConfig.js`
157
-
158
- ```javascript
159
- {
160
- headerLinks: [
161
- ...
162
- /* you can add docs */
163
- { doc: 'my-examples', label: 'Examples' },
164
- /* you can add custom pages */
165
- { page: 'help', label: 'Help' },
166
- /* you can add external links */
167
- { href: 'https://github.com/facebook/docusaurus', label: 'GitHub' },
168
- ...
169
- ],
170
- ...
171
- }
172
- ```
173
-
174
- For more information about the navigation bar, click [here](https://docusaurus.io/docs/en/navigation)
175
-
176
- ## Adding custom pages
177
-
178
- 1. Docusaurus uses React components to build pages. The components are saved as .js files in `website/pages/en`:
179
- 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:
180
-
181
- `website/siteConfig.js`
182
-
183
- ```javascript
184
- {
185
- headerLinks: [
186
- ...
187
- { page: 'my-new-custom-page', label: 'My New Custom Page' },
188
- ...
189
- ],
190
- ...
191
- }
192
- ```
193
-
194
- For more information about custom pages, click [here](https://docusaurus.io/docs/en/custom-pages).
195
-
196
- # Full Documentation
197
-
198
- Full documentation can be found on the [website](https://docusaurus.io/).
data/docs/core/Footer.js DELETED
@@ -1,80 +0,0 @@
1
- /**
2
- * Copyright (c) 2017-present, Facebook, Inc.
3
- *
4
- * This source code is licensed under the MIT license found in the
5
- * LICENSE file in the root directory of this source tree.
6
- */
7
-
8
- const React = require('react');
9
-
10
- class Footer extends React.Component {
11
- docUrl(doc, language) {
12
- const baseUrl = this.props.config.baseUrl;
13
- const docsUrl = this.props.config.docsUrl;
14
- const docsPart = `${docsUrl ? `${docsUrl}/` : ''}`;
15
- return `${baseUrl}${docsPart}${doc}`;
16
- }
17
-
18
- pageUrl(doc, language) {
19
- const baseUrl = this.props.config.baseUrl;
20
- return baseUrl + (language ? `${language}/` : '') + doc;
21
- }
22
-
23
- render() {
24
- return (
25
- <footer className="nav-footer" id="footer">
26
- <section className="sitemap">
27
- <a href={this.props.config.baseUrl} className="nav-home">
28
- {this.props.config.footerIcon && (
29
- <img
30
- src={this.props.config.baseUrl + this.props.config.footerIcon}
31
- alt={this.props.config.title}
32
- width="66"
33
- height="58"
34
- />
35
- )}
36
- </a>
37
- <div>
38
- <h5>Docs</h5>
39
- <a href={this.docUrl('getting-started.html', this.props.language)}>
40
- Getting Started
41
- </a>
42
- <a href={this.docUrl('attributes.html', this.props.language)}>
43
- Guides
44
- </a>
45
- <a href={this.docUrl('performance.html', this.props.language)}>
46
- Performance
47
- </a>
48
- </div>
49
- <div>
50
- <h5>More</h5>
51
- <a href="https://github.com/yosiat/panko_serializer">GitHub</a>
52
- <a
53
- className="github-button"
54
- href={this.props.config.repoUrl}
55
- data-icon="octicon-star"
56
- data-count-href="/yosiat/panko_serializer/stargazers"
57
- data-show-count="true"
58
- data-count-aria-label="# stargazers on GitHub"
59
- aria-label="Star this project on GitHub">
60
- Star
61
- </a>
62
- {this.props.config.twitterUsername && (
63
- <div className="social">
64
- <a
65
- href={`https://twitter.com/${this.props.config.twitterUsername}`}
66
- className="twitter-follow-button">
67
- Follow @{this.props.config.twitterUsername}
68
- </a>
69
- </div>
70
- )}
71
- </div>
72
- </section>
73
-
74
- <section className="copyright">{this.props.config.copyright}</section>
75
- </footer>
76
- );
77
- }
78
- }
79
-
80
- module.exports = Footer;
data/docs/i18n/en.json DELETED
@@ -1,50 +0,0 @@
1
- {
2
- "_comment": "This file is auto-generated by write-translations.js",
3
- "localized-strings": {
4
- "next": "Next",
5
- "previous": "Previous",
6
- "tagline": "High Performance JSON Serialization for ActiveRecord & Ruby Objects",
7
- "docs": {
8
- "associations": {
9
- "title": "Associations",
10
- "sidebar_label": "Associations"
11
- },
12
- "attributes": {
13
- "title": "Attributes",
14
- "sidebar_label": "Attributes"
15
- },
16
- "design-choices": {
17
- "title": "Design Choices",
18
- "sidebar_label": "Design Choices"
19
- },
20
- "getting-started": {
21
- "title": "Getting Started",
22
- "sidebar_label": "Getting Started"
23
- },
24
- "index": {
25
- "title": "Introduction",
26
- "sidebar_label": "Introduction"
27
- },
28
- "performance": {
29
- "title": "Performance",
30
- "sidebar_label": "Performance"
31
- },
32
- "response-bag": {
33
- "title": "Response",
34
- "sidebar_label": "Response"
35
- }
36
- },
37
- "links": {
38
- "Docs": "Docs"
39
- },
40
- "categories": {
41
- "Panko": "Panko",
42
- "Reference": "Reference"
43
- }
44
- },
45
- "pages-strings": {
46
- "Help Translate|recruit community translators for your project": "Help Translate",
47
- "Edit this Doc|recruitment message asking to edit the doc source": "Edit",
48
- "Translate this Doc|recruitment message asking to translate the docs": "Translate"
49
- }
50
- }
data/docs/siteConfig.js DELETED
@@ -1,80 +0,0 @@
1
- /**
2
- * Copyright (c) 2017-present, Facebook, Inc.
3
- *
4
- * This source code is licensed under the MIT license found in the
5
- * LICENSE file in the root directory of this source tree.
6
- */
7
-
8
- // See https://docusaurus.io/docs/site-config for all the possible
9
- // site configuration options.
10
-
11
-
12
- // List of projects/orgs using your project for the users page.
13
- const users = [
14
- {
15
- caption: 'User1',
16
- // You will need to prepend the image path with your baseUrl
17
- // if it is not '/', like: '/test-site/img/image.jpg'.
18
- image: '/img/undraw_open_source.svg',
19
- infoLink: 'https://www.facebook.com',
20
- pinned: true,
21
- },
22
- ];
23
-
24
- const siteConfig = {
25
- title: 'Panko Serializers',
26
- tagline: 'High Performance JSON Serialization for ActiveRecord & Ruby Objects',
27
- url: 'https://panko.dev',
28
- baseUrl: '/',
29
- repoPath: 'yosiat/panko_serializer',
30
- // For github.io type URLs, you would set the url and baseUrl like:
31
- // url: 'https://facebook.github.io',
32
- // baseUrl: '/test-site/',
33
- customDocsPath: require('path').basename(__dirname) + '/docs',
34
-
35
- repoUrl: 'https://github.com/yosiat/panko_serializer',
36
- projectName: 'panko_serializer',
37
- organizationName: 'yosiat',
38
- cname: 'panko.dev',
39
-
40
- headerLinks: [
41
- {doc: 'index', label: 'Docs'},
42
- ],
43
-
44
- /* Colors for website */
45
- colors: {
46
- //primaryColor: '#3F4C6B',
47
- primaryColor: '#B02B2C',
48
- secondaryColor: '#C3D9FF',
49
- },
50
-
51
- copyright: `Copyright © ${new Date().getFullYear()} Panko Serializer`,
52
-
53
- usePrims: ['ruby'],
54
- highlight: {
55
- // Highlight.js theme to use for syntax highlighting in code blocks.
56
- theme: 'atom-one-dark',
57
- },
58
-
59
- // Add custom scripts here that would be placed in <script> tags.
60
- scripts: ['https://buttons.github.io/buttons.js'],
61
-
62
- // On page navigation for the current documentation page.
63
- onPageNav: 'separate',
64
- // No .html extensions for paths.
65
- cleanUrl: true,
66
-
67
- // Open Graph and Twitter card images.
68
- ogImage: 'img/undraw_online.svg',
69
- twitterImage: 'img/undraw_tweetstorm.svg',
70
-
71
- // Show documentation's last contributor's name.
72
- // enableUpdateBy: true,
73
-
74
- // Show documentation's last update time.
75
- // enableUpdateTime: true,
76
-
77
- // You may provide arbitrary config keys to be used as needed by your
78
- };
79
-
80
- module.exports = siteConfig;