mongo-ejson 0.2.0 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad82ad33cec308c20018042c44a50361619d79813bb866e830126794f35daed1
-  data.tar.gz: 7d2bec415b3328b6c112e382819f3d6c9b0b97fbdbbbf3d40ec4779a8926b36c
+  metadata.gz: c98ad3da7747bd6271099b7813fce22ceced579a27dba30492e01a8de63a1a6e
+  data.tar.gz: 41e98def1985407533d220c4453beb3bca2a8cde1482e975298e11fec5ea56bc
 SHA512:
-  metadata.gz: 7fcd47f32cbb62d40ea9d268746f4bd7ebb8611a5c044297c16bb4a9dbd14d7d79933f6a0bf4b58d731c93d7bc7abe2dac3cf281ce1a62ea3d956abec3c8a826
-  data.tar.gz: 412d8ed39076c303b704016dfda59d25ad05a7e40a5314a430d59b5fdaf7902fe0a18f019100b9ebbf77a0715f5a455c1a01559d7247f6a758fe130871243199
+  metadata.gz: b1d75937eaea35dedab3ff4a324a190d060baa5abdcc17727890bc6b2bac99481f8bdd79185b006957dfe051f0ce2da0c36b441ff3385adc1d41135eccbdc2d3
+  data.tar.gz: 2a176c418b1ba1a6bdd1394932f764a7cd110ae2b099a8af6338815998c401c325e3c6b52965c55b78d377e21c10829ca79f5b5b59d31f2054589a3f0cf5800f

data/.gitignore

@@ -6,6 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.gem
 
 # rspec failure tracking
 .rspec_status

data/.rubocop.yml

@@ -0,0 +1,34 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  Exclude:
+    - 'src/**/*'
+    - 'vendor/bundle/**/*'
+
+Metrics/LineLength:
+  Max: 120
+
+Layout/EndOfLine:
+  EnforcedStyle: lf
+
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
+Metrics/BlockLength:
+  Exclude:
+    - '*.gemspec'
+  ExcludedMethods:
+    - describe
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: when_needed
+
+Layout/AlignHash:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table

data/.rubocop_todo.yml

@@ -0,0 +1,13 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2019-02-07 17:38:30 +0300 using RuboCop version 0.63.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.6.1

data/.travis.yml

@@ -1,9 +1,13 @@
----
 sudo: false
 language: ruby
 cache: bundler
 rvm:
+  - 2.7
   - 2.6
   - 2.5
   - jruby-9.2
-before_install: gem install bundler -v 2.0.1
+before_install:
+  - gem install bundler -v 2.0.1
+script:
+  - bundle exec rspec
+  - bundle exec rubocop

data/Gemfile

@@ -1,4 +1,4 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in mongo-ejson.gemspec
 gemspec

data/Gemfile.lock

@@ -1,28 +1,48 @@
 PATH
   remote: .
   specs:
-    mongo-ejson (0.2.0)
+    mongo-ejson (0.2.5)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    bson (4.4.2)
-    bson (4.4.2-java)
-    diff-lcs (1.3)
-    rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
+    ast (2.4.1)
+    bson (4.9.2)
+    bson (4.9.2-java)
+    diff-lcs (1.4.2)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.86.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.0.3, < 1.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.0.3)
+      parser (>= 2.7.0.1)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   java
@@ -32,8 +52,9 @@ DEPENDENCIES
   bson
   bundler (~> 2.0)
   mongo-ejson!
-  rake (~> 10.0)
+  rake (~> 13.0)
   rspec (~> 3.0)
+  rubocop (~> 0.63)
 
 BUNDLED WITH
-   2.0.1
+   2.1.4

data/README.md

@@ -1,57 +1,81 @@
 # mongo-ejson
 
-[![Build Status](https://travis-ci.org/db-ai/mongo-ejson.svg?branch=master)](https://travis-ci.org/db-ai/mongo-ejson)
+[![Build Status](https://travis-ci.org/db-ai/mongo-ejson.svg?branch=master)](https://travis-ci.org/db-ai/mongo-ejson) [![Gem Version](https://badge.fury.io/rb/mongo-ejson.svg)](https://badge.fury.io/rb/mongo-ejson)
 
 This is a parser for mongo "flavoured" JSON, that supports mongo specific literals like `ISODate` or `ObjectId`, as well as some other nasty non-json things.
 
 It can instantiate corresponding BSON objects or produce Extended JSON objects.
 
+## Usage
+
+Add gem to your Gemfile:
+
+    gem 'mongo-ejson'
+
+Require when needed:
+
+    require 'ejson'
+
+You can parse files in two modes: `Wrap` and `BSON`.
+
+In `Wrap` mode, parser will instantiate Struct classes. It's useful when you
+only need to validate provided EJSON code.
+
+    EJSON.parse_wrap(%q|{ "_id": ObjectId('5c520a538628ea8c13261c64') }|)
+    => {"_id"=>#<struct Struct::ObjectId hex="5c520a538628ea8c13261c64">}
+
+To use `BSON` mode you need to install `bson` gem. In this case parser will
+instantiate real BSON objects.
+
+    require 'bson'
+    EJSON.parse_bson(%q|{ "_id": ObjectId('5c520a538628ea8c13261c64') }|)
+    => {"_id"=>BSON::ObjectId('5c520a538628ea8c13261c64')}
+
+You can also use JavaScript parser in your Rails application. At the moment it
+does not build JavaScript object and returns raw parse tree. It is useful only
+for validating the syntax.
+
+Just add it to your `application.js`
+
+    //= require 'ejson'
+
 ## Requirements
 
 Runtime:
-  * Ruby 2.5+
-  * JRuby 9.2+
+
+- Ruby 2.5+
+- JRuby 9.2+
 
 Development:
-  * [canopy](https://github.com/jcoglan/canopy) from master branch
+
+- [canopy](https://github.com/jcoglan/canopy) from master branch
 
 ## Supported literals
 
-* `undefined`
-* `MinKey`
-* `MaxKey`
-* `ObjectId(<object_id_hex_string>)`
-* `BinData(<type_string>, <bindata_base64_string>)`
-* `BinData(<type_integer>, <base64_bindata>)`
-* `Timestamp(<time_interger>, <increment_integer>)`
-* `NumberLong(<value_string>)`
-* `NumberLong(<value_integer>)`
-* `NumberDecimal(<value_string>)`
-* `NumberDecimal(<value_number>)`
-* `ISODate(<time_iso8601_string>)`
-* `ISODate(<time_interger>)`
-* `new Date(<time_iso8601_string>)`
-* `new Date(<time_interger>)`
-* `/<regexp>/<options>`
-* `DBRef(<name_string>, <object_id_hex_string>)`
+- `undefined`
+- `MinKey`
+- `MaxKey`
+- `ObjectId(<object_id_hex_string>)`
+- `BinData(<type_string>, <bindata_base64_string>)`
+- `BinData(<type_integer>, <base64_bindata>)`
+- `Timestamp(<time_interger>, <increment_integer>)`
+- `NumberLong(<value_string>)`
+- `NumberLong(<value_integer>)`
+- `NumberDecimal(<value_string>)`
+- `NumberDecimal(<value_number>)`
+- `ISODate(<time_iso8601_string>)`
+- `ISODate(<time_interger>)`
+- `new Date(<time_iso8601_string>)`
+- `new Date(<time_interger>)`
+- `/<regexp>/<options>`
+- `DBRef(<name_string>, <object_id_hex_string>)`
 
 ## Supported JSON extensions:
 
-* Single quoted strings
-* Single line comments `//`
+- Single quoted strings
+- Single line comments `//`
+- Non-quoted key names: `{_id: 123}`
 
 ## Planned JSON extensions:
 
-* Multi-line comments: `/* */`
-
-## Issues
-
-* String: following not escaped chars should fail, but pass
-
-    * Backspace (must be replaced with `\b`). no fixture
-    * Form feed (must be replaced with `\f`), no fixture
-    * Newline (must be replaced with `\n`)
-    * Carriage return (must be replaced with `\r`), no fixture
-    * Tab (must be replaced with `\t`)
-
-
+- Multi-line comments: `/* */`

data/Rakefile

@@ -1,26 +1,26 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 require 'fileutils'
 
 CANOPY_BIN = ENV.fetch('CANOPY_BIN') { 'canopy' }
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec
 
 task :compile_js do
-  sh %{ #{CANOPY_BIN} src/ejson.peg --lang javascript }
+  sh %( #{CANOPY_BIN} src/ejson.peg --lang javascript )
 end
 
 task :compile_ruby do
-  sh %{ #{CANOPY_BIN} src/ejson.peg --lang ruby }
+  sh %( #{CANOPY_BIN} src/ejson.peg --lang ruby )
 end
 
-desc "Build and run test suite"
-task :test => [:compile_ruby, :spec] do
+desc 'Build and run test suite'
+task test: [:compile_ruby, :spec] do
 end
 
-desc "Prepare assets"
-task :assets => [:test, :compile_js] do
-  mv 'src/ejson.js', 'lib/assets/ejson.js'
+desc 'Prepare assets'
+task assets: [:test, :compile_js, :compile_ruby] do
+  mv 'src/ejson.js', 'vendor/assets/javascripts/ejson.js'
 end

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "ejson"
+require 'bundler/setup'
+require 'ejson'
 
 # 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.
@@ -10,5 +10,5 @@ require "ejson"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/ejson.gemspec

@@ -1,46 +1,47 @@
-
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "ejson/version"
+require 'ejson/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "mongo-ejson"
+  spec.name          = 'mongo-ejson'
   spec.version       = EJSON::VERSION
-  spec.authors       = ["Alex Bondar"]
-  spec.email         = ["mongo-ejson-gem@db-ai.co"]
+  spec.authors       = ['Alex Bondar']
+  spec.email         = ['mongo-ejson-gem@db-ai.co']
 
-  spec.summary       = %q{MongoDB Extended JS(ON) parser}
-  spec.description   = %q{Parses MongoDB favoured JS(ON) string into objects}
-  spec.homepage      = "https://gibhub.com/db-ai/mongo-ejson"
+  spec.summary       = 'MongoDB Extended JS(ON) parser'
+  spec.description   = 'Parses MongoDB favoured JS(ON) string into objects'
+  spec.homepage      = 'https://gibhub.com/db-ai/mongo-ejson'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the
   # 'allowed_push_host' to allow pushing to a single host or delete this
   # section to allow pushing to any host.
   if spec.respond_to?(:metadata)
-    spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org/'
 
-    spec.metadata["homepage_uri"] = spec.homepage
-    spec.metadata["source_code_uri"] = "https://gibhub.com/db-ai/mongo-ejson"
-    spec.metadata["changelog_uri"] = "https://gibhub.com/db-ai/mongo-ejson"
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://gibhub.com/db-ai/mongo-ejson'
+    spec.metadata['changelog_uri'] = 'https://gibhub.com/db-ai/mongo-ejson'
   else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-          "public gem pushes."
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+          'public gem pushes.'
   end
 
   # 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
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`
       .split("\x0")
       .reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.63'
 
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "bson"
+  spec.add_development_dependency 'bson'
 end

data/lib/ejson.rb

@@ -23,14 +23,20 @@ class EJSON
     end
 
     private
+
     def boot_bson
       return if defined? ::BSON
-      require 'bson' rescue nil
 
-      unless defined? ::BSON
-        raise "Can't find constant ::BSON. Seems like gem 'bson' is not " \
-              "loaded. Make sure it's available in your bundle."
+      begin
+        require 'bson'
+      rescue StandardError
+        nil
       end
+
+      return if defined? ::BSON
+
+      raise "Can't find constant ::BSON. Seems like gem 'bson' is not " \
+            "loaded. Make sure it's available in your bundle."
     end
   end
 end

data/lib/ejson/parser_action/abstract_json.rb

@@ -1,37 +1,40 @@
 module ParserAction
   module AbstractJSON
     # JSON Entities
-    def make_root(input, start, _end, elements)
+    def make_root(input, starts_at, _ends_at, elements)
     end
 
-    def make_object(input, start, _end, elements)
+    def make_object(input, starts_at, _ends_at, elements)
     end
 
-    def make_pair(input, start, _end, elements)
+    def make_pair(input, starts_at, _ends_at, elements)
     end
 
-    def make_empty_object(input, start, _end, elements)
+    def make_empty_object(input, starts_at, _ends_at, elements)
     end
 
-    def make_string(input, start, _end, elements)
+    def make_string(input, starts_at, _ends_at, elements)
     end
 
-    def make_array(input, start, _end, elements)
+    def make_identifier(input, starts_at, _ends_at, elements)
     end
 
-    def make_empty_array(input, start, _end, elements)
+    def make_array(input, starts_at, _ends_at, elements)
     end
 
-    def make_number(input, start, _end, elements)
+    def make_empty_array(input, starts_at, _ends_at, elements)
     end
 
-    def make_null(input, start, _end)
+    def make_number(input, starts_at, _ends_at, elements)
     end
 
-    def make_true(input, start, _end)
+    def make_null(input, starts_at, _ends_at)
     end
 
-    def make_false(input, start, _end)
+    def make_true(input, starts_at, _ends_at)
+    end
+
+    def make_false(input, starts_at, _ends_at)
     end
   end
 end