Fix rubocop (#884)

* Address more rubocop warnings

Author: ohler55

.rubocop.yml

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 3.15.0 - 2023-06-03
+
+- Added `omit_null_byte` option when dumping.
+
 ## 3.14.3 - 2023-04-07
 
 - Fixed compat parse with optimized Hash when parsing a JSON::GenericObject.

.rubocop_todo.yml

@@ -1,8 +1,13 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 gemspec
 
 group :development do
-  gem "rubocop", "~> 1.47", require: false
-  gem "rubocop-minitest", "~> 0.28.0", require: false
+  gem 'minitest', '~> 5'
+  gem 'rake-compiler', '>= 0.9', '< 2.0'
+  gem 'rubocop', '~> 1.47', require: false
+  gem 'rubocop-minitest', '~> 0.28.0', require: false
+  gem 'test-unit', '~> 3.0'
 end

CHANGELOG.md

@@ -1,4 +1,5 @@
 #!/usr/bin/env rake
+# frozen_string_literal: true
 
 require 'bundler/gem_tasks'
 require 'rake/extensiontask'
@@ -17,21 +18,21 @@ end
 =end
 
 task :test_all => [:clean, :compile] do
-  STDOUT.flush
+  $stdout.flush
   exitcode = 0
   status = 0
 
-  cmds = "ruby test/tests.rb -v && ruby test/tests_mimic.rb -v && ruby test/tests_mimic_addition.rb -v"
+  cmds = 'ruby test/tests.rb -v && ruby test/tests_mimic.rb -v && ruby test/tests_mimic_addition.rb -v'
 
-  STDOUT.syswrite "\n#{'#'*90}\n#{cmds}\n"
+  $stdout.syswrite "\n#{'#'*90}\n#{cmds}\n"
   Bundler.with_original_env do
     status = system(cmds)
   end
   exitcode = 1 unless status
 
   Dir.glob('test/json_gem/*_test.rb').each do |file|
     cmd = "bundle exec ruby -Itest #{file}"
-    STDOUT.syswrite "\n#{'#'*90}\n#{cmd}\n"
+    $stdout.syswrite "\n#{'#'*90}\n#{cmd}\n"
     Bundler.with_original_env do
       ENV['REAL_JSON_GEM'] = '1'
       status = system(cmd)
@@ -46,7 +47,7 @@ end
 task :default => :test_all
 
 begin
-  require "rails/version"
+  require 'rails/version'
 
   Rake::TestTask.new "activesupport#{Rails::VERSION::MAJOR}" do |t|
     t.libs << 'test'
@@ -56,12 +57,13 @@ begin
   end
   Rake::Task[:test_all].enhance ["activesupport#{Rails::VERSION::MAJOR}"]
 
-  Rake::TestTask.new "activerecord" do |t|
+  Rake::TestTask.new 'activerecord' do |t|
     t.libs << 'test'
     t.pattern = 'test/activerecord/*_test.rb'
     t.warning = true
     t.verbose = true
   end
-  Rake::Task[:test_all].enhance ["activerecord"]
-rescue LoadError
+  Rake::Task[:test_all].enhance ['activerecord']
+rescue LoadError => e
+  puts "Rake failed #{e}"
 end

Gemfile

@@ -857,7 +857,7 @@ void oj_dump_cstr(const char *str, size_t cnt, bool is_sym, bool escape1, Out ou
                 break;
             case '6':  // control characters
                 if (*(uint8_t *)str < 0x80) {
-                    if (0 == (uint8_t)*str && Yes == out->opts->skip_null_byte) {
+                    if (0 == (uint8_t)*str && out->opts->dump_opts.omit_null_byte) {
                         break;
                     }
                     APPEND_CHARS(out->cur, "\\u00", 4);

Rakefile

@@ -723,7 +723,6 @@ static struct _options mimic_object_to_json_options = {0,              // indent
                                                        "%0.16g",       // float_fmt
                                                        Qnil,           // hash_class
                                                        Qnil,           // array_class
-                                                       No,             // skip_null_byte
                                                        {
                                                            // dump_opts
                                                            false,     // use
@@ -739,6 +738,7 @@ static struct _options mimic_object_to_json_options = {0,              // indent
                                                            0,         // array_size
                                                            RaiseNan,  // nan_dump
                                                            false,     // omit_nil
+                                                           false,     // omit_null_byte
                                                            100,       // max_depth
                                                        },
                                                        {

ext/oj/dump.c

@@ -97,7 +97,6 @@ VALUE oj_nanosecond_sym;
 VALUE oj_object_class_sym;
 VALUE oj_quirks_mode_sym;
 VALUE oj_safe_sym;
-VALUE oj_skip_null_byte_sym;
 VALUE oj_symbolize_names_sym;
 VALUE oj_trace_sym;
 
@@ -136,6 +135,7 @@ static VALUE newline_sym;
 static VALUE nilnil_sym;
 static VALUE null_sym;
 static VALUE object_sym;
+static VALUE omit_null_byte_sym;
 static VALUE omit_nil_sym;
 static VALUE rails_sym;
 static VALUE raise_sym;
@@ -208,7 +208,6 @@ struct _options oj_default_options = {
     "%0.15g",       // float_fmt
     Qnil,           // hash_class
     Qnil,           // array_class
-    No,             // skip_null_byte
     {
         // dump_opts
         false,      // use
@@ -224,6 +223,7 @@ struct _options oj_default_options = {
         0,          // array_size
         AutoNan,    // nan_dump
         false,      // omit_nil
+        false,      // omit_null_byte
         MAX_DEPTH,  // max_depth
     },
     {
@@ -293,6 +293,7 @@ struct _options oj_default_options = {
  *used
  * - *:array_class* [_Class_|_nil_] Class to use instead of Array on load
  * - *:omit_nil* [_true_|_false_] if true Hash and Object attributes with nil values are omitted
+ * - *:omit_null_byte* [_true_|_false_] if true null bytes in strings will be omitted when dumping
  * - *:ignore* [_nil_|_Array_] either nil or an Array of classes to ignore when dumping
  * - *:ignore_under* [_Boolean_] if true then attributes that start with _ are ignored when dumping in
  *object or custom mode.
@@ -301,7 +302,6 @@ struct _options oj_default_options = {
  * - *:integer_range* [_Range_] Dump integers outside range as strings.
  * - *:trace* [_true,_|_false_] Trace all load and dump calls, default is false (trace is off)
  * - *:safe* [_true,_|_false_] Safe mimic breaks JSON mimic to be safer, default is false (safe is
- * - *:skip_null_byte* [_true_|_false_] if true null bytes in strings will be omitted when dumping
  *off)
  *
  * Return [_Hash_] all current option settings.
@@ -387,11 +387,6 @@ static VALUE get_def_opts(VALUE self) {
         opts,
         cache_keys_sym,
         (Yes == oj_default_options.cache_keys) ? Qtrue : ((No == oj_default_options.cache_keys) ? Qfalse : Qnil));
-    rb_hash_aset(opts,
-                 oj_skip_null_byte_sym,
-                 (Yes == oj_default_options.skip_null_byte)
-                     ? Qtrue
-                     : ((No == oj_default_options.skip_null_byte) ? Qfalse : Qnil));
 
     switch (oj_default_options.mode) {
     case StrictMode: rb_hash_aset(opts, mode_sym, strict_sym); break;
@@ -468,6 +463,7 @@ static VALUE get_def_opts(VALUE self) {
     default: rb_hash_aset(opts, nan_sym, auto_sym); break;
     }
     rb_hash_aset(opts, omit_nil_sym, oj_default_options.dump_opts.omit_nil ? Qtrue : Qfalse);
+    rb_hash_aset(opts, omit_null_byte_sym, oj_default_options.dump_opts.omit_null_byte ? Qtrue : Qfalse);
     rb_hash_aset(opts, oj_hash_class_sym, oj_default_options.hash_class);
     rb_hash_aset(opts, oj_array_class_sym, oj_default_options.array_class);
 
@@ -594,7 +590,6 @@ bool set_yesno_options(VALUE key, VALUE value, Options copts) {
                                {ignore_under_sym, &copts->ignore_under},
                                {oj_create_additions_sym, &copts->create_ok},
                                {cache_keys_sym, &copts->cache_keys},
-                               {oj_skip_null_byte_sym, &copts->skip_null_byte},
                                {Qnil, 0}};
     YesNoOpt         o;
 
@@ -875,6 +870,17 @@ static int parse_options_cb(VALUE k, VALUE v, VALUE opts) {
         } else {
             rb_raise(rb_eArgError, ":omit_nil must be true or false.");
         }
+    } else if (omit_null_byte_sym == k) {
+        if (Qnil == v) {
+            return ST_CONTINUE;
+        }
+        if (Qtrue == v) {
+            copts->dump_opts.omit_null_byte = true;
+        } else if (Qfalse == v) {
+            copts->dump_opts.omit_null_byte = false;
+        } else {
+            rb_raise(rb_eArgError, ":omit_null_byte must be true or false.");
+        }
     } else if (oj_ascii_only_sym == k) {
         // This is here only for backwards compatibility with the original Oj.
         if (Qtrue == v) {
@@ -1289,6 +1295,7 @@ static VALUE dump(int argc, VALUE *argv, VALUE self) {
     oj_out_init(arg.out);
 
     arg.out->omit_nil = copts.dump_opts.omit_nil;
+    arg.out->omit_null_byte = copts.dump_opts.omit_null_byte;
     arg.out->caller   = CALLER_DUMP;
 
     return rb_ensure(dump_body, (VALUE)&arg, dump_ensure, (VALUE)&arg);
@@ -1337,6 +1344,7 @@ static VALUE to_json(int argc, VALUE *argv, VALUE self) {
     oj_out_init(&out);
 
     out.omit_nil = copts.dump_opts.omit_nil;
+    out.omit_null_byte = copts.dump_opts.omit_null_byte;
     // For obj.to_json or generate nan is not allowed but if called from dump
     // it is.
     oj_dump_obj_to_json_using_params(*argv, &copts, &out, argc - 1, argv + 1);
@@ -1977,8 +1985,8 @@ void Init_oj(void) {
     rb_gc_register_address(&oj_quirks_mode_sym);
     oj_safe_sym = ID2SYM(rb_intern("safe"));
     rb_gc_register_address(&oj_safe_sym);
-    oj_skip_null_byte_sym = ID2SYM(rb_intern("skip_null_byte"));
-    rb_gc_register_address(&oj_skip_null_byte_sym);
+    omit_null_byte_sym = ID2SYM(rb_intern("omit_null_byte"));
+    rb_gc_register_address(&omit_null_byte_sym);
     oj_space_before_sym = ID2SYM(rb_intern("space_before"));
     rb_gc_register_address(&oj_space_before_sym);
     oj_space_sym = ID2SYM(rb_intern("space"));

ext/oj/mimic_json.c

@@ -124,6 +124,7 @@ typedef struct _dumpOpts {
     uint8_t array_size;
     char    nan_dump;  // NanDump
     bool    omit_nil;
+    bool    omit_null_byte;
     int     max_depth;
 } *DumpOpts;
 
@@ -165,7 +166,6 @@ typedef struct _options {
     char             float_fmt[7];    // float format for dumping, if empty use Ruby
     VALUE            hash_class;      // class to use in place of Hash on load
     VALUE            array_class;     // class to use in place of Array on load
-    char             skip_null_byte;  // YesNo
     struct _dumpOpts dump_opts;
     struct _rxClass  str_rx;
     VALUE           *ignore;  // Qnil terminated array of classes or NULL
@@ -200,6 +200,7 @@ typedef struct _out {
     uint32_t   hash_cnt;
     bool       allocated;
     bool       omit_nil;
+    bool       omit_null_byte;
     int        argc;
     VALUE     *argv;
     DumpCaller caller;  // used for the mimic json only

ext/oj/oj.c

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+# Oj module is defined in oj.c.
 module Oj
 end