zn 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 346238f45cbf0b747669a91e1f2f9f6976be1e71
-  data.tar.gz: f9545545d62a6a03d096a49bcdf2363f1f2d9d72
+  metadata.gz: 169966541807052462e0dcc386a5a2946ee19c27
+  data.tar.gz: a9c201bb92ec31de84a59bcf20a552a839feb014
 SHA512:
-  metadata.gz: 2f5309ccf119b54a98d134104565157fe103c33333c6193722f015eead15a422042cc7648bdd3f0fa6136cb7b45cc11b7f7a61ad6ed191f1a7480abbb5eebef1
-  data.tar.gz: 8dc69e5f0c5dd463220a90f9fb7d1a6bab86c138b296720c807d6a3e181ec0a161930914144631bf4d0e13ea13080d1b63344b9a25338f6c6adcd4ef54eefea5
+  metadata.gz: 55f9ee7f95c5be03460fe30bd20ddac9677188200f6b41aec2b6f8ca17715119e3847c109f933eddb0b4bf5f4f3b1097408b75676ad7c68ab848096706e0cbbd
+  data.tar.gz: 82dd515ec234cffc7a43f7a49577c9975c0fb53e699906a3e2da4005c68ad1ff9e495d7a3083789b7640fa6d3e220508ef96833d34932ae011a2c1467f01ef9d

data/Dockerfile

@@ -0,0 +1,17 @@
+FROM ruby:2.4
+
+MAINTAINER Latheesh <latheeshp@gmail.com>
+
+RUN apt-get update && apt-get install -yqq git bash make gcc vim
+
+RUN { echo 'install: --no-document'; echo 'update: --no-document'; } >> /etc/gemrc
+
+WORKDIR /app
+
+COPY . /app
+
+RUN bin/setup
+RUN bin/install
+
+WORKDIR /app
+ENTRYPOINT ["bash"]

data/README.md

@@ -1,39 +1,117 @@
 # Zn
 
-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/zn`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Zn is a tool to search and correlate data sources (JSON files for now).
 
 ## Installation
 
-Add this line to your application's Gemfile:
+### Local
 
-```ruby
-gem 'zn'
+```
+$ git clone https://github.com/lpadukana/zn
+$ bin/setup
+$ bin/install
 ```
 
-And then execute:
-
-    $ bundle
+### Docker
 
-Or install it yourself as:
+```
+$ docker run -it latheeshp/zn:latest
+```
 
-    $ gem install zn
+Note: For latest changes, please use `exe/zn` instead of depending on the installed version.
 
 ## Usage
 
-TODO: Write usage instructions here
+This tool depends on an index to understand the relationship between datasets. An example is available at `spec/fixtures/starwars/index.yml`. In this case, this file defines how `people.json`, `planets.json` and `robots.json` are related.
+
+### Search Examples
+
+```sh
+$ zn search \
+  --config-file=spec/fixtures/starwars/index.yml \
+  --dataset robots \
+  --key id \
+  --value r2
+{"id":"r2","name":"R2-D2","owner_id":"obi"}
+
+# config file can be set using environment variables
+$ export ZN_CONFIG_FILE=spec/fixtures/starwars/index.yml
+
+$ zn search --dataset people --key name --value Kenobi
+{"id":"obi","name":"Obi Wan Kenobi","planet_id":"ste"}
+```
+
+### Search and Associate Example
+
+```sh
+$ export ZN_CONFIG_FILE=spec/fixtures/starwars/index.yml
+
+$ zn search --dataset robots --key id --value r2 | zn associate --dataset robots
+{"id":"r2","name":"R2-D2","owner_id":"obi","owner":{"id":"obi","name":"Obi Wan Kenobi","planet_id":"ste"}}
+
+$ zn search --dataset people --key name --value Kenobi | zn associate --dataset people
+{"id":"obi","name":"Obi Wan Kenobi","planet_id":"ste","robots":[{"id":"r2","name":"R2-D2","owner_id":"obi"},{"id":"c3po","name":"C-3PO","owner_id":"obi"}],"home_planet":{"id":"ste","name":"Stewjon"}}
+```
+
+### Search, Associate and Pretty-print Example
+
+```sh
+$ export ZN_CONFIG_FILE=spec/fixtures/starwars/index.yml
+
+$ zn search --dataset people --key name --value Kenobi | zn associate --dataset people | zn prettify-json
+{
+  "id": "obi",
+  "name": "Obi Wan Kenobi",
+  "planet_id": "ste",
+  "robots": [
+    {
+      "id": "r2",
+      "name": "R2-D2",
+      "owner_id": "obi"
+    },
+    {
+      "id": "c3po",
+      "name": "C-3PO",
+      "owner_id": "obi"
+    }
+  ],
+  "home_planet": {
+    "id": "ste",
+    "name": "Stewjon"
+  }
+}
+```
+
+## Tests
+
+### Rspec
+
+```sh
+$ bin/rspec-test
+```
+
+### Style Checks
+
+```sh
+$ bin/style-check
+```
+
+### Smoke Tests
+
+```sh
+$ bin/smoke-test
+```
 
 ## 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.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/test` 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).
+To install this gem onto your local machine, run `bin/install`. To release a new version, update the version number in `version.rb`, and then run `bin/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/lpadukana/zn.
+Bug reports and pull requests are welcome on GitHub at <https://github.com/lpadukana/zn>.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+Available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/bin/install

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+
+set -euxo pipefail
+
+bundle exec rake install

data/bin/release

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+
+set -euxo pipefail
+
+bundle exec rake release

data/bin/rspec-test

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+
+set -euxo pipefail
+
+bundle exec rspec

data/bin/smoke-test

@@ -0,0 +1,140 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+# Smoke-tests
+
+mkdir -p /tmp/zn
+
+fail() {
+  echo -e "\\033[31mFAIL: $*\\033[0m"
+  exit 1
+}
+
+run () {
+  echo -e ">>> \\033[1m$*\\033[0m"
+  sh -c "$@" > >(tee /tmp/zn/stdout) 2> >(tee /tmp/zn/stderr >&2)
+  echo ""
+}
+
+check_output() {
+  if ! grep -q "${*?}" /tmp/zn/stdout; then
+    fail "Expected output: $*"
+  fi
+}
+
+# Exercise help
+run "exe/zn --help"
+check_output "Search the text in values of the given key"
+check_output "Find associated entities"
+check_output "List keys in a dataset"
+check_output "List known datasets"
+check_output "Pretty print JSON"
+check_output "Usage:"
+check_output "Parameters:"
+check_output "Subcommands:"
+check_output "Options:"
+
+run "exe/zn search \
+  --config-file=spec/fixtures/starwars/index.yml \
+  --dataset robots \
+  --key id \
+  --value r2"
+check_output '{"id":"r2","name":"R2-D2","owner_id":"obi"}'
+
+run "exe/zn search \
+  --config-file=spec/fixtures/starwars/index.yml \
+  --dataset robots \
+  --key id \
+  --value r2 |\
+    exe/zn associate \
+    --config-file=spec/fixtures/starwars/index.yml \
+    --dataset robots"
+check_output '{"id":"r2","name":"R2-D2","owner_id":"obi","owner":{"id":"obi","name":"Obi Wan Kenobi","planet_id":"ste"}}'
+
+run "exe/zn search \
+  --config-file=spec/fixtures/starwars/index.yml \
+  --dataset robots \
+  --key id \
+  --value r2 |\
+    exe/zn associate \
+    --config-file=spec/fixtures/starwars/index.yml \
+    --dataset robots |\
+      exe/zn prettify-json"
+check_output '{
+  "id": "r2",
+  "name": "R2-D2",
+  "owner_id": "obi",
+  "owner": {
+    "id": "obi",
+    "name": "Obi Wan Kenobi",
+    "planet_id": "ste"
+  }
+}'
+
+run "exe/zn search \
+  --config-file=spec/fixtures/starwars/index.yml \
+  --dataset people \
+  --key name \
+  --value Obi |\
+    exe/zn associate \
+    --config-file=spec/fixtures/starwars/index.yml \
+    --dataset people |\
+      exe/zn prettify-json"
+check_output '{
+  "id": "obi",
+  "name": "Obi Wan Kenobi",
+  "planet_id": "ste",
+  "robots": \[
+    {
+      "id": "r2",
+      "name": "R2-D2",
+      "owner_id": "obi"
+    },
+    {
+      "id": "c3po",
+      "name": "C-3PO",
+      "owner_id": "obi"
+    }
+  \],
+  "home_planet": {
+    "id": "ste",
+    "name": "Stewjon"
+  }
+}'
+
+run 'exe/zn search \
+  --config-file=spec/fixtures/starwars/index.yml \
+  --dataset planets \
+  --key name \
+  --value "Outer Rim" |\
+    exe/zn associate \
+      --config-file=spec/fixtures/starwars/index.yml \
+      --dataset planets |\
+        exe/zn prettify-json'
+check_output '{
+  "id": "ou-3453",
+  "name": "Outer Rim 3453",
+  "residents": \[
+    {
+      "id": "rev",
+      "name": "Darth Revan",
+      "planet_id": "ou-3453"
+    }
+  \]
+}'
+
+run 'zn list-keys \
+  --config-file spec/fixtures/starwars/index.yml \
+  --dataset robots'
+check_output 'id
+name
+owner_id'
+
+run 'zn list-datasets \
+  --config-file spec/fixtures/starwars/index.yml'
+check_output 'people
+planets
+robots'
+
+echo -e "\\033[32mSUCCESS\\033[0m"

data/bin/test

@@ -2,4 +2,4 @@
 
 set -euxo pipefail
 
-bin/style-check && bundle exec rspec
+bin/style-check && bin/rspec-test

data/lib/zn/cli.rb

@@ -59,15 +59,16 @@ module Zn
              required: true, environment_variable: 'ZN_CONFIG_FILE'
 
       def execute
-        puts search_assembly(config_file).list_keys(dataset: dataset)
+        puts search_assembly(config_file).dataset_keys(dataset: dataset)
       end
     end
 
     subcommand 'list-datasets', 'List known datasets' do
-      option ['--config-file', '-c'], 'CONFIG_FILE', 'Config that defines datasets', required: true
+      option ['--config-file', '-c'], 'CONFIG_FILE', 'Config that defines datasets',
+             required: true, environment_variable: 'ZN_CONFIG_FILE'
 
       def execute
-        puts search_assembly(config_file).list_datasets
+        puts search_assembly(config_file).dataset_names
       end
     end
 

data/lib/zn/dataset.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'forwardable'
+require 'set'
 
 module Zn
   # Holds repo, associators and performs aggregate operations

data/lib/zn/repos/json_repo.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'multi_json'
-require 'jq/extend'
 
 module Zn
   module Repos
@@ -29,25 +28,31 @@ module Zn
         value = params.fetch(:value)
         exact = params.fetch(:exact)
 
-        query = exact ? search_exact_query(key, value) : search_query(key, value)
-
-        all.jq(query).map do |result|
-          yield result
+        if exact
+          search_exact(key, value) { |result| yield result }
+        else
+          search_for_inclusion(key, value) { |result| yield result }
         end
       end
 
       private
 
-      def search_query(key, sub_string)
-        if sub_string.to_s.empty?
-          ".[] | select(.#{key}|tostring == \"\")"
-        else
-          ".[] | select(.#{key}|tostring | contains(\"#{sub_string}\"))"
+      def search_exact(key, value)
+        return enum_for(:search_exact, key, value) unless block_given?
+
+        all.each do |element|
+          yield element if element[key].to_s == value.to_s
         end
       end
 
-      def search_exact_query(key, value)
-        ".[] | select(.#{key}|tostring == \"#{value}\")"
+      def search_for_inclusion(key, value)
+        return enum_for(:search_for_inclusion, key, value) unless block_given?
+
+        return [].each if value.empty?
+
+        all.each do |element|
+          yield element if element[key].to_s.include?(value.to_s)
+        end
       end
     end
   end

data/lib/zn/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Zn
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/zn.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'multi_json', '~> 1.12'
-  spec.add_dependency 'ruby-jq', '~> 0.1'
+  spec.add_dependency 'clamp', '~> 1.1'
 
   spec.add_development_dependency 'bundler', '~> 1.15'
   spec.add_development_dependency 'rake', '~> 10.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zn
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Latheesh Padukana
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-13 00:00:00.000000000 Z
+date: 2017-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -25,19 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.12'
 - !ruby/object:Gem::Dependency
-  name: ruby-jq
+  name: clamp
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -163,12 +163,17 @@ files:
 - ".rubocop.yml"
 - ".ruby-version"
 - ".travis.yml"
+- Dockerfile
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
+- bin/install
+- bin/release
+- bin/rspec-test
 - bin/setup
+- bin/smoke-test
 - bin/style-check
 - bin/test
 - exe/zn