zn 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 346238f45cbf0b747669a91e1f2f9f6976be1e71
+  data.tar.gz: f9545545d62a6a03d096a49bcdf2363f1f2d9d72
+SHA512:
+  metadata.gz: 2f5309ccf119b54a98d134104565157fe103c33333c6193722f015eead15a422042cc7648bdd3f0fa6136cb7b45cc11b7f7a61ad6ed191f1a7480abbb5eebef1
+  data.tar.gz: 8dc69e5f0c5dd463220a90f9fb7d1a6bab86c138b296720c807d6a3e181ec0a161930914144631bf4d0e13ea13080d1b63344b9a25338f6c6adcd4ef54eefea5

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/zn-*.gem
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,21 @@
+require:
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.4
+
+Style/FileName:
+  Exclude:
+    - bin/*
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/ClassLength:
+  Max: 130
+
+Bundler/OrderedGems:
+  Enabled: false
+
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.4

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.1

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in zn.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Latheesh Padukana
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# 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
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'zn'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install zn
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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.
+
+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).
+
+## Contributing
+
+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).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'zn'
+
+# 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.
+
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/bin/style-check

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

data/bin/test

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

data/exe/zn

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+exe_dir = File.expand_path(File.dirname(__FILE__))
+lib_dir = File.expand_path(File.join(exe_dir, '../lib'))
+$LOAD_PATH.unshift(lib_dir)
+$LOAD_PATH.uniq!
+
+Signal.trap('SIGPIPE', 'SYSTEM_DEFAULT')
+
+require 'zn/cli'
+
+Zn::Cli.run

data/lib/zn.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'zn/version'
+
+# Top level module
+module Zn
+end

data/lib/zn/associators/belongs_to.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Zn
+  module Associators
+    # BelongsTo associator helps define belongs_to relations between objects
+    class BelongsTo
+      attr_reader :datasets, :dataset_name, :foreign_key, :primary_key, :dataset, :repo
+
+      def initialize(datasets, params)
+        @datasets = datasets
+        @dataset_name = params.fetch('dataset')
+        @foreign_key = params.fetch('foreign_key')
+        @primary_key = params.fetch('primary_key')
+      end
+
+      def associate(object)
+        @dataset ||= datasets.fetch(dataset_name)
+        dataset.search(key: primary_key, value: object[foreign_key], exact: true).to_a.first
+      end
+    end
+  end
+end

data/lib/zn/associators/has_many.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Zn
+  module Associators
+    # HasMany associator helps define has_many relations between objects
+    class HasMany
+      attr_reader :datasets, :dataset_name, :foreign_key, :primary_key, :dataset, :repo
+
+      def initialize(datasets, params)
+        @datasets = datasets
+        @dataset_name = params.fetch('dataset')
+        @foreign_key = params.fetch('foreign_key')
+        @primary_key = params.fetch('primary_key')
+      end
+
+      def associate(object)
+        @dataset ||= datasets.fetch(dataset_name)
+
+        dataset.search(key: foreign_key, value: object.fetch(primary_key), exact: true).to_a
+      end
+    end
+  end
+end

data/lib/zn/cli.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require 'clamp'
+require 'json'
+require 'zn/dataset'
+require 'zn/search_assembly'
+require 'zn/search_assembler'
+require 'zn/repos/json_repo'
+require 'zn/associators/has_many'
+require 'zn/associators/belongs_to'
+
+module Zn
+  # Cli composes a default search assembly and provides a CLI
+  class Cli < Clamp::Command
+    def search_assembly(config_file)
+      assembly = Zn::SearchAssembly.new
+      assembler = Zn::SearchAssembler.new(assembly)
+      assembler.register_repo_class(:json, Zn::Repos::JsonRepo)
+      assembler.register_associator_class(:has_many, Zn::Associators::HasMany)
+      assembler.register_associator_class(:belongs_to, Zn::Associators::BelongsTo)
+      assembler.assemble(config_file)
+      assembly
+    end
+
+    subcommand 'search', 'Search the text in values of the given key' do
+      option ['--exact', '-e'], :flag, 'Search for exact value'
+      option ['--dataset', '-d'], 'DATASET', 'Dataset to search', required: true
+      option ['--key', '-k'], 'KEY', 'Key to search under', required: true
+      option ['--value', '-v'], 'VALUE', 'Search value', required: true
+      option ['--config-file', '-c'], 'CONFIG_FILE', 'Config that defines datasets',
+             required: true, environment_variable: 'ZN_CONFIG_FILE'
+
+      def execute
+        search_assembly(config_file).search(dataset: dataset, key: key, value: value, exact: exact?) do |entity|
+          puts entity.to_json
+        end
+      end
+    end
+
+    subcommand 'associate', 'Find associated entities' do
+      option ['--dataset', '-d'], 'DATASET', 'Dataset to associate from', required: true
+      option ['--config-file', '-c'], 'CONFIG_FILE', 'Config that defines datasets',
+             required: true, environment_variable: 'ZN_CONFIG_FILE'
+
+      def execute
+        entities = STDIN.map do |line|
+          JSON.parse(line)
+        end
+
+        search_assembly(config_file).associate(entities, dataset: dataset) do |entity|
+          puts entity.to_json
+        end
+      end
+    end
+
+    subcommand 'list-keys', 'List keys in a dataset' do
+      option ['--dataset', '-d'], 'DATASET', 'Dataset to search', 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_keys(dataset: dataset)
+      end
+    end
+
+    subcommand 'list-datasets', 'List known datasets' do
+      option ['--config-file', '-c'], 'CONFIG_FILE', 'Config that defines datasets', required: true
+
+      def execute
+        puts search_assembly(config_file).list_datasets
+      end
+    end
+
+    subcommand 'prettify-json', 'Pretty print JSON' do
+      def execute
+        STDIN.each do |line|
+          puts JSON.pretty_generate(JSON.parse(line))
+        end
+      end
+    end
+  end
+end

data/lib/zn/dataset.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module Zn
+  # Holds repo, associators and performs aggregate operations
+  class Dataset
+    extend Forwardable
+    attr_reader :repo, :associators
+
+    def initialize(repo)
+      @repo = repo
+      @associators = {}
+    end
+
+    def add_associator(name, associator)
+      @associators[name] = associator
+    end
+
+    def keys
+      keys = Set.new
+
+      repo.all.each do |entity|
+        keys = keys.merge entity.keys
+      end
+
+      keys.to_a
+    end
+
+    def associations(entity)
+      associators.each_with_object({}) do |(name, associator), hash|
+        hash[name] = associator.associate(entity)
+      end
+    end
+
+    def associate(entities)
+      return enum_for(:associate, entities) unless block_given?
+
+      entities.each do |entity|
+        yield entity, associations(entity)
+      end
+    end
+
+    delegate search: :@repo
+  end
+end

data/lib/zn/repos/json_repo.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'multi_json'
+require 'jq/extend'
+
+module Zn
+  module Repos
+    # JsonRepo abstracts loading of external json data. For more demanding
+    # datasets, repos of other nature can be created later as needed. Examples
+    # of this include loading data asynchronously from json files, loading data
+    # from a database, elasticsearch, etc.
+    class JsonRepo
+      def initialize(params)
+        dir = params.fetch('dir', '.')
+
+        Dir.chdir(dir) do
+          @io = File.new(params.fetch('file'))
+        end
+      end
+
+      def all
+        @all ||= MultiJson.load(@io)
+      end
+
+      def search(params)
+        return enum_for(:search, params) unless block_given?
+
+        key = params.fetch(:key)
+        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
+        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}\"))"
+        end
+      end
+
+      def search_exact_query(key, value)
+        ".[] | select(.#{key}|tostring == \"#{value}\")"
+      end
+    end
+  end
+end

data/lib/zn/search_assembler.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module Zn
+  # Assembles search assembly from config and registered classes
+  class SearchAssembler
+    attr_reader :config_root, :assembly
+
+    def initialize(assembly)
+      @assembly = assembly
+      @repos = {}
+      @associators = {}
+    end
+
+    def register_repo_class(name, repo_class)
+      @repos[name] = repo_class
+    end
+
+    def assemble_repo(repo_params)
+      type = repo_params.fetch('type').to_sym
+      klass = @repos.fetch(type)
+      klass.new(repo_params.merge('dir' => @config_root))
+    end
+
+    def register_associator_class(name, associator_class)
+      @associators[name] = associator_class
+    end
+
+    def assemble_associator(association_params)
+      type = association_params.fetch('type').to_sym
+      klass = @associators.fetch(type)
+      klass.new(assembly.datasets, association_params)
+    end
+
+    def assemble_datasets(dataset_definitions)
+      dataset_definitions.each do |dataset_name, dataset_params|
+        repo = assemble_repo(dataset_params.fetch('repo'))
+        dataset = Dataset.new(repo)
+
+        dataset_params.fetch('associations').each do |associator_name, associator_params|
+          dataset.add_associator(associator_name, assemble_associator(associator_params))
+        end
+
+        @assembly.add_dataset(dataset_name, dataset)
+      end
+    end
+
+    def assemble(config_yml)
+      config = YAML.load_file(config_yml)
+      @config_root = File.dirname(config_yml)
+      dataset_definitions = config.fetch('datasets')
+      assemble_datasets(dataset_definitions)
+    end
+  end
+end

data/lib/zn/search_assembly.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Zn
+  # Provides a higher level API for search and relational logic
+  class SearchAssembly
+    attr_reader :datasets
+
+    def initialize
+      @datasets = {}
+    end
+
+    def add_dataset(name, dataset)
+      @datasets[name] = dataset
+    end
+
+    def dataset_names
+      datasets.keys
+    end
+
+    def dataset_keys(options)
+      dataset(options).keys
+    end
+
+    def associate(entities, options)
+      return enum_for(:associate, entities, options) unless block_given?
+
+      dataset(options).associate(entities) do |entity, associations|
+        yield entity.merge(associations)
+      end
+    end
+
+    def search(options)
+      return enum_for(:search, options) unless block_given?
+
+      dataset(options).search(options) do |result|
+        yield result
+      end
+    end
+
+    private
+
+    def dataset(options)
+      dataset_name = options.fetch(:dataset)
+      datasets.fetch(dataset_name)
+    end
+  end
+end

data/lib/zn/version.rb

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

data/zn.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'zn/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'zn'
+  spec.version = Zn::VERSION
+  spec.authors = ['Latheesh Padukana']
+  spec.email = ['latheeshp@gmail.com']
+
+  spec.summary = 'Search and relate JSON data sources'
+  spec.homepage = 'https://website.zn.todo'
+  spec.license = 'MIT'
+
+  # 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.
+  # spec.metadata['allowed_push_host'] = 'https://gemserver.zn.todo'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'multi_json', '~> 1.12'
+  spec.add_dependency 'ruby-jq', '~> 0.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.49'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.15'
+  spec.add_development_dependency 'pry-byebug', '~> 3.4'
+  spec.add_development_dependency 'pry-stack_explorer', '~> 0.4.9'
+  spec.add_development_dependency 'pry-coolline', '~> 0.2'
+end

metadata

@@ -0,0 +1,209 @@
+--- !ruby/object:Gem::Specification
+name: zn
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Latheesh Padukana
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: ruby-jq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: pry-stack_explorer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.9
+- !ruby/object:Gem::Dependency
+  name: pry-coolline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: 
+email:
+- latheeshp@gmail.com
+executables:
+- zn
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/style-check
+- bin/test
+- exe/zn
+- lib/zn.rb
+- lib/zn/associators/belongs_to.rb
+- lib/zn/associators/has_many.rb
+- lib/zn/cli.rb
+- lib/zn/dataset.rb
+- lib/zn/repos/json_repo.rb
+- lib/zn/search_assembler.rb
+- lib/zn/search_assembly.rb
+- lib/zn/version.rb
+- zn.gemspec
+homepage: https://website.zn.todo
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Search and relate JSON data sources
+test_files: []