jgrep 1.3.3 → 1.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 711064ad1e5b72d951cd8d049d289a58576224be
+  data.tar.gz: 2d44d135f26ce88962e4d8bdf9620b7fee13d0c6
+SHA512:
+  metadata.gz: d32d99fe10154f48e699a5074af1fd6c0a26af7d9df839b200a7f4dfc0c4003b7806ba6fde87d893c151245c34fd7217663b365bb1796b546401f9357d7286d6
+  data.tar.gz: 1feb21dd1c0e1efc87431ff4be35e197a3e0c604f19f3d6e49bec2a6de665af3e45500ce8839d77e272c0e3b301ecc216ed226b4fa5039a01beb88d11ea01602

data/CHANGELOG.markdown

@@ -0,0 +1,10 @@
+# Changelog
+
+## 1.4.0
+* Expressions support matching true/false booleans (Boyan Tabakov)
+* `--slice` option added to jgrep to get array elements (Jon McKenzie)
+* `-i` option to read file supported without a TTY (Jon McKenzie)
+* `-n` streaming option from 1.3.2 reinstated
+* Performance fix: string splitting replaced with character access
+* Performance fix: regexes replaced with simpler string methods
+* Tests fixed and enabled on Travis CI

data/COPYING

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2011 P.Loubser
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.markdown

@@ -0,0 +1,244 @@
+JGrep is a command line tool and API for parsing JSON documents based on logical expressions.
+
+###Installation:###
+
+jgrep is available as a gem:
+
+    gem install jgrep
+
+###JGrep binary usage:###
+
+    jgrep [expression] -i foo.json
+
+or
+
+    cat "foo.json" | jgrep [expression]
+
+###Flags:###
+
+    -s, --simple [FIELDS]   : Greps the JSON and only returns the value of the field(s) specified
+    -c, --compat            : Returns the JSON in its non-pretty flat form
+    -n, --stream            : Specify continuous input
+    -f, --flatten           : Flatten the results as much as possible
+    -i, --input [FILENAME]  : Target JSON file to use as input
+    -q, --quiet             : Quiet; don't write to stdout.  Exit with zero status if match found.
+    -v, --verbose           : Verbose output that will list a document if it fails to parse
+        --start FIELD       : Starts the grep at a specific key in the document
+        --slice [RANGE]     : A range of the form 'n' or 'n..m', indicating which documents to extract from the final output
+
+###Expressions###
+
+JGrep uses the following logical symbols to define expressions.
+
+    'and' :
+        - [statement] and [statement]
+
+        Evaluates to true if both statements are true
+
+    'or' :
+        - [statement] and [statement]
+
+        Evaluates true if either statement is true
+
+    'not' :
+        - ! [statement]
+        - not [statement]
+
+        Inverts the value of statement
+
+    '+'
+        - +[value]
+
+        Returns true if value is present in the json document
+
+    '-'
+        - -[value]
+
+        Returns true if value is not present in the json doument
+
+    '(' and ')'
+
+        - (expression1) and expression2
+
+        Performs the operations inside the perentheses first.
+
+###Statements:###
+
+A statement is defined as some value in a json document compared to another value.
+Available comparison operators are '=', '<', '>', '<=', '>='
+
+Examples:
+
+    foo.bar=1
+    foo.bar>0
+    foo.bar<=1.3
+
+###Complex expressions:###
+
+Given a json document, {"foo":1, "bar":null}, the following are examples of valid expressions
+
+Examples:
+
+    +foo
+
+... returns true
+
+    -bar
+
+... returns false
+
+    +foo and !(foo=2)
+
+... returns true
+
+    !(foo>=2 and bar=null) or !(bar=null)
+
+... returns true
+
+###CLI missing an expression###
+
+If JGrep is executed without a set expression, it will return an unmodified JSON document. The
+-s flag can still be applied to the result.
+
+###In document comparison:###
+
+If a document contains an array, the '[' and ']' operators can be used to define a comparison where
+statements are checked for truth on a per element basis which will then be combined.
+
+Example:
+
+    [foo.bar1=1 and foo.bar2=2]
+
+on
+
+    [
+      {
+        "foo":  [
+          {
+            "bar1":1
+          },
+          {
+            "bar2":2
+          }
+        ]
+      },
+      {
+        "foo":  [
+          {
+            "bar1":0
+          },
+          {
+            "bar2":0
+          }
+        ]
+      }
+    ]
+
+will return
+
+    [
+      {
+        "foo": [
+          {
+            "bar1": 1
+          },
+          {
+            "bar2": 2
+          }
+        ]
+      }
+    ]
+
+
+**Note**: In document comparison cannot be nested.
+
+###The -s flag###
+
+The s flag simplifies the output returned by JGrep. Given a JSON document
+
+    [{"a":1, "b":2, "c":3}, {"a":3, "b":2, "c":1}]
+
+a JGrep invocation like
+
+    cat my.json | jgrep "a=1" -s b
+
+will output
+
+    1
+
+The s flag can also be used with multiple field, which will return JSON as output which only contain the specified fields.
+**Note**: Separate fields by a space and enclose all fields in quotes (see example below) 
+
+Given:
+
+    [{"a":1, "b":2, "c":3}, {"a":3, "b":2, "c":1}]
+
+a JGrep invocation like
+
+    cat my.json | jgrep "a>0" -s "a c"
+
+will output
+
+    [
+      {
+        "a" : 1,
+        "c" : 3
+      },
+      {
+        "a" : 3,
+        "c" : 1
+      }
+    ]
+
+###The --start flag###
+
+Some documents do not comply to our expected format, they might have an array embedded deep in a field.  The --start
+flag lets you pick a starting point for the grep.
+
+An example document can be seen here:
+
+    {"results": [
+                  {"name":"Jack", "surname":"Smith"},
+                  {"name":"Jill", "surname":"Jones"}
+                ]
+    }
+
+This document does not comply to our standard but does contain data that can be searched - the _results_ field.
+We can use the --start flat to tell jgrep to start looking for data in that field:
+
+<pre>
+$ cat my.json | jgrep --start results name=Jack -s surname
+Smith
+</pre>
+
+### The --slice flag
+
+Allows the user to provide an int or range to slice an array of
+results with, in particular so a single element can be extracted, e.g.
+
+    $ echo '[{"foo": {"bar": "baz"}}, {"foo": {"bar":"baz"}}]' |
+        jgrep "foo.bar=baz" --slice 0
+    {
+      "foo": {
+        "bar": "baz"
+      }
+    }
+
+### The --stream flag
+
+With the --stream or -n flag, jgrep will process multiple JSON inputs (newline
+separated) until standard input is closed.  Each JSON input will be processed
+as usual, but the output immediately printed.
+
+###JGrep Gem usage:###
+
+    require 'jgrep'
+
+    json = File.read("yourfile.json")
+    expression = "foo=1 or bar=1"
+
+    JGrep::jgrep(json, expression)
+
+    sflags = "foo"
+
+    JGrep::jgrep(json, expression, sflags)