mongo-ejson 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad82ad33cec308c20018042c44a50361619d79813bb866e830126794f35daed1
-  data.tar.gz: 7d2bec415b3328b6c112e382819f3d6c9b0b97fbdbbbf3d40ec4779a8926b36c
+  metadata.gz: 7fe75002ec17489608405072b1cf5e19643bce4732f97fc74c42a7d4c77f331a
+  data.tar.gz: 9ffd4f54c57599d7c97081f6fdf7ee27bd3075bb7ae95cf659910d9e20f1a8af
 SHA512:
-  metadata.gz: 7fcd47f32cbb62d40ea9d268746f4bd7ebb8611a5c044297c16bb4a9dbd14d7d79933f6a0bf4b58d731c93d7bc7abe2dac3cf281ce1a62ea3d956abec3c8a826
-  data.tar.gz: 412d8ed39076c303b704016dfda59d25ad05a7e40a5314a430d59b5fdaf7902fe0a18f019100b9ebbf77a0715f5a455c1a01559d7247f6a758fe130871243199
+  metadata.gz: 4def483883272fd0938a362fd6edd41131f4b9e633aefca1ab3b2f793f9078730eb0026e0010cc602c4152b68faa52a02edb790bef5a6951a714880d32135c9a
+  data.tar.gz: 17cf8d185b2dcfa62e654b6752cba2f0ebd4eba6c0e2665b98117b19698c72786f035ed23f950d4b9abe059c2f4d38527587c12276487ddb9e57ca2e8180c38d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mongo-ejson (0.2.0)
+    mongo-ejson (0.2.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,11 +1,44 @@
 # 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:
@@ -42,6 +75,7 @@ Development:
 
 ## Planned JSON extensions:
 
+* Non-quoted key names: `{_id: 123}`
 * Multi-line comments: `/* */`
 
 ## Issues

data/Rakefile

@@ -22,5 +22,5 @@ end
 
 desc "Prepare assets"
 task :assets => [:test, :compile_js] do
-  mv 'src/ejson.js', 'lib/assets/ejson.js'
+  mv 'src/ejson.js', 'vendor/assets/javascripts/ejson.js'
 end

data/lib/ejson/version.rb

@@ -1,3 +1,3 @@
 class EJSON
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongo-ejson
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Alex Bondar
@@ -83,7 +83,6 @@ files:
 - bin/console
 - bin/setup
 - ejson.gemspec
-- lib/assets/ejson.js
 - lib/ejson.rb
 - lib/ejson/parser_action/abstract.rb
 - lib/ejson/parser_action/abstract_json.rb
@@ -97,6 +96,7 @@ files:
 - lib/ejson/version.rb
 - src/ejson.peg
 - src/ejson.rb
+- vendor/assets/javascripts/ejson.js
 homepage: https://gibhub.com/db-ai/mongo-ejson
 licenses: []
 metadata: