oj-introspect 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e9fc62ff35dbc50422ea8578a2f053c6c1d5036c071bfe46b5d5d3a34e5a8c7a
+  data.tar.gz: 5106fd71458d000cb2cb06cb0a85f696ab5c6f83327198470e7ce2bf01311a09
+SHA512:
+  metadata.gz: b1dd55782690a0186360b503ebc915eb817d4d9d5257a833653d7a6678d0d7cbf7ad85db8d847bff23dec8ef07de27b6119af5daac7e1ac4a5fd034636e6cbb5
+  data.tar.gz: 88e31090edbb71d09865ae92ddf28cb0559b793836262cfa7440bbea56134c2d2c309064a86cf20c320e65277102c90369393a8016bdb590492db2aead08eeb1

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+*.bundle
+Makefile
+*.o

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at mehmetemininac@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in oj-introspect.gemspec
+gemspec
+
+gem "benchmark-ips"
+gem "pry"
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem "rake-compiler"

data/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: .
+  specs:
+    oj-introspect (0.1.0)
+      oj (~> 3.13)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    benchmark-ips (2.10.0)
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    method_source (1.0.0)
+    oj (3.13.22)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (12.3.3)
+    rake-compiler (1.2.0)
+      rake
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  benchmark-ips
+  oj-introspect!
+  pry
+  rake (~> 12.0)
+  rake-compiler
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Mehmet Emin INAC
+
+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.

data/README.md

@@ -0,0 +1,44 @@
+# Oj::Introspect
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/oj/introspect`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'oj-introspect'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install oj-introspect
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/oj-introspect. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/oj-introspect/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Oj::Introspect project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/oj-introspect/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rake/extensiontask"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: [:compile, :spec]
+
+Rake::ExtensionTask.new "oj-introspect" do |ext|
+  ext.name = "introspect_ext"
+  ext.lib_dir = "lib/oj/introspect"
+end

data/bin/benchmark

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "oj/introspect"
+require "json"
+require "benchmark/ips"
+
+TEST_JSON = '{ "foo": "bar" }'
+
+INTROSPECT_PARSER = Oj::Parser.introspect
+USUAL_PARSER = Oj::Parser.usual
+
+Benchmark.ips do |b|
+  b.report("Introspected") do
+    INTROSPECT_PARSER.parse(TEST_JSON)
+  end
+
+  b.report("Oj usual") do
+    USUAL_PARSER.parse(TEST_JSON)
+  end
+
+  b.report("stdlib") do
+    JSON.parse(TEST_JSON)
+  end
+
+  b.compare!
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "oj/introspect"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/test_run

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "oj/introspect"
+
+TEST_JSON = '{ "foo": "bar" }'
+
+puts Oj::Parser.introspect.parse(TEST_JSON)

data/ext/oj-introspect/extconf.rb

@@ -0,0 +1,10 @@
+require "mkmf"
+require "bundler"
+
+oj_gemspec = Bundler.definition.specs.find { _1.name == "oj" }
+
+OJ_HEADERS  = oj_gemspec.full_gem_path + "/ext/oj"
+
+dir_config('oj', [OJ_HEADERS], [])
+
+create_makefile("oj-introspect/introspect_ext")

data/ext/oj-introspect/introspect.c

@@ -0,0 +1,194 @@
+#include <ruby.h>
+#include "oj.h"
+#include "parser.h"
+#include "usual.h"
+
+#define BYTE_OFFSETS_STACK_INC_SIZE 256
+
+// Holds the start byte offsets of each JSON object encountered
+struct _byte_offsets {
+    int   length;
+    int   current;
+    long *stack;
+};
+
+typedef struct _introspect_S {
+  struct _usual usual; // inherit all the attributes from `_usual` struct
+  struct _byte_offsets byte_offsets; // I think it's better to encapsulate common fields under a namespace
+
+  void (*delegated_start_func)(struct _ojParser *p);
+  void (*delegated_free_func)(struct _ojParser *p);
+  void (*delegated_open_object_func)(struct _ojParser *p);
+  void (*delegated_open_object_key_func)(struct _ojParser *p);
+  void (*delegated_close_object_func)(struct _ojParser *p);
+} *IntrospectDelegate;
+
+static void dfree(ojParser p) {
+  IntrospectDelegate d = (IntrospectDelegate)p->ctx;
+
+  xfree(d->byte_offsets.stack);
+  d->delegated_free_func(p);
+}
+
+static void start(ojParser p) {
+    IntrospectDelegate d = (IntrospectDelegate)p->ctx;
+
+    d->delegated_start_func(p);
+    // Reset to zero so the parser and delegate can be reused.
+    d->byte_offsets.current = 0;
+}
+
+static void ensure_byte_offsets_stack(IntrospectDelegate d) {
+    if (RB_UNLIKELY(d->byte_offsets.current == (d->byte_offsets.length - 1))) {
+        d->byte_offsets.length += BYTE_OFFSETS_STACK_INC_SIZE;
+        REALLOC_N(d->byte_offsets.stack, long, d->byte_offsets.length + BYTE_OFFSETS_STACK_INC_SIZE);
+    }
+}
+
+static long pop(ojParser p) {
+    IntrospectDelegate d = (IntrospectDelegate)p->ctx;
+
+    return d->byte_offsets.stack[--d->byte_offsets.current];
+}
+
+static void push(ojParser p) {
+    IntrospectDelegate d = (IntrospectDelegate)p->ctx;
+    ensure_byte_offsets_stack(d);
+
+    d->byte_offsets.stack[d->byte_offsets.current++] = p->cur;
+}
+
+static void open_object_introspected(ojParser p) {
+  push(p);
+
+  IntrospectDelegate d = (IntrospectDelegate)p->ctx;
+  d->delegated_open_object_func(p);
+}
+
+static void open_object_key_introspected(ojParser p) {
+  push(p);
+
+  IntrospectDelegate d = (IntrospectDelegate)p->ctx;
+  d->delegated_open_object_key_func(p);
+}
+
+static void set_introspection_values(ojParser p) {
+    IntrospectDelegate d = (IntrospectDelegate)p->ctx;
+
+    volatile VALUE obj = rb_hash_new();
+    rb_hash_aset(obj, ID2SYM(rb_intern("start_byte")), INT2FIX(pop(p)));
+    rb_hash_aset(obj, ID2SYM(rb_intern("end_byte")), INT2FIX(p->cur));
+    rb_hash_aset(*(d->usual.vtail - 1), ID2SYM(rb_intern("__oj_introspection")), obj);
+}
+
+static void close_object_introspected(ojParser p) {
+  IntrospectDelegate d = (IntrospectDelegate)p->ctx;
+  d->delegated_close_object_func(p);
+
+  set_introspection_values(p);
+}
+
+static void init_introspect_parser(ojParser p, VALUE ropts) {
+  IntrospectDelegate d = ALLOC(struct _introspect_S);
+
+  oj_init_usual(p, (Usual)d);
+
+  // now function mangling...
+  d->delegated_free_func = p->free;
+  p->free = &dfree;
+
+  d->delegated_start_func = p->start;
+  p->start = start;
+
+  // We are cheating with the mark, free, and options functions. Since struct
+  // _usual is the first member of struct _introspect the cast to Usual in the
+  // usual.c mark() function should still work just fine.
+
+  // PCO - do you need the location of sub-objects and arrays or just top
+  // level objects?
+  Funcs f = &p->funcs[TOP_FUN];
+  d->delegated_open_object_func = f->open_object;
+  d->delegated_close_object_func = f->close_object;
+  f->open_object  = open_object_introspected;
+  f->close_object = close_object_introspected;
+
+  f = &p->funcs[ARRAY_FUN];
+  f->open_object  = open_object_introspected;
+  f->close_object = close_object_introspected;
+
+  f = &p->funcs[OBJECT_FUN];
+  d->delegated_open_object_key_func = f->open_object;
+  f->open_object  = open_object_key_introspected;
+  f->close_object = close_object_introspected;
+
+  // Init stack
+  d->byte_offsets.current = 0;
+  d->byte_offsets.stack   = ALLOC_N(long, BYTE_OFFSETS_STACK_INC_SIZE);
+  d->byte_offsets.length  = BYTE_OFFSETS_STACK_INC_SIZE;
+
+  // Process options.
+  oj_parser_set_option(p, ropts);
+}
+
+VALUE oj_get_parser_introspect() {
+  VALUE oj_parser = oj_parser_new();
+  struct _ojParser *p;
+  Data_Get_Struct(oj_parser, struct _ojParser, p);
+
+  init_introspect_parser(p, Qnil);
+
+  rb_gc_register_address(&oj_parser);
+
+  return oj_parser;
+}
+
+static VALUE rb_new_introspect_parser(int argc, VALUE *argv, VALUE self) {
+  rb_check_arity(argc, 0, 1);
+
+  VALUE options;
+
+  if(argc == 1) {
+    options = argv[0];
+
+    Check_Type(options, T_HASH);
+  } else {
+    options = rb_hash_new();
+  }
+
+
+  VALUE oj_parser = oj_parser_new();
+  struct _ojParser *p;
+  Data_Get_Struct(oj_parser, struct _ojParser, p);
+
+  init_introspect_parser(p, options);
+
+  // This locks the object in memory and is never recovered. Best to let the
+  // mark function handle it.
+  // rb_gc_register_address(&oj_parser);
+
+  return oj_parser;
+}
+
+// This code is neither Ruby Thread safe nor Ractor safe!
+// I don't really want to write a mutex right now.
+static VALUE rb_get_default_introspect_parser(VALUE self) {
+  VALUE current_thread = rb_funcall(rb_cThread, rb_intern("current"), 0);
+  VALUE thread_parser = rb_funcall(current_thread, rb_intern("[]"), 1, rb_str_new_literal("oj_introspect_parser"));
+
+  if(RTEST(thread_parser))
+    return thread_parser;
+
+  thread_parser = rb_new_introspect_parser(0, NULL, self);
+  rb_funcall(current_thread, rb_intern("[]="), 2, rb_str_new_literal("oj_introspect_parser"), thread_parser);
+
+  return thread_parser;
+}
+
+void Init_introspect_ext() {
+  VALUE oj_module = rb_const_get(rb_cObject, rb_intern("Oj"));
+  VALUE parser_module = rb_const_get(oj_module, rb_intern("Parser"));
+  VALUE introspection_class = rb_define_class_under(oj_module, "Introspect", rb_cObject);
+
+  rb_define_singleton_method(parser_module, "introspect", rb_get_default_introspect_parser, 0);
+  rb_define_singleton_method(introspection_class, "new", rb_new_introspect_parser, -1);
+}

data/lib/oj/introspect/version.rb

@@ -0,0 +1,5 @@
+module Oj
+  class Introspect
+    VERSION = "0.1.0"
+  end
+end

data/lib/oj/introspect.rb

@@ -0,0 +1,9 @@
+require "oj"
+require "oj/introspect/version"
+require "oj/introspect/introspect_ext"
+
+module Oj
+  class Introspect
+    class Error < StandardError; end
+  end
+end

data/oj-introspect.gemspec

@@ -0,0 +1,27 @@
+require_relative 'lib/oj/introspect/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "oj-introspect"
+  spec.version       = Oj::Introspect::VERSION
+  spec.authors       = ["Mehmet Emin INAC"]
+  spec.email         = ["mehmetemininac@gmail.com"]
+
+  spec.summary       = "Oj introspect parser."
+  spec.description   = "Embeds start and end byte offsets of JSON objects into generated Ruby hashes."
+  spec.homepage      = "https://github.com/meinac/oj-introspect"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # spec.metadata["homepage_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "oj", "~>3.13"
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: oj-introspect
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mehmet Emin INAC
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-11-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+description: Embeds start and end byte offsets of JSON objects into generated Ruby
+  hashes.
+email:
+- mehmetemininac@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/benchmark
+- bin/console
+- bin/setup
+- bin/test_run
+- ext/oj-introspect/extconf.rb
+- ext/oj-introspect/introspect.c
+- lib/oj/introspect.rb
+- lib/oj/introspect/version.rb
+- oj-introspect.gemspec
+homepage: https://github.com/meinac/oj-introspect
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Oj introspect parser.
+test_files: []