zendesk-james-moriarty 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bff655df3f7d9258995bd2aa623fff010338981e
-  data.tar.gz: a55461e6ecfeebd9683394efb7199c6e45db044f
+  metadata.gz: 6c093cf970fccbd0cbf10a9e788a955935afe2ca
+  data.tar.gz: 434ceec002f574baad3fbf011eeeb9f38f91efe8
 SHA512:
-  metadata.gz: 122144bf42ae753bd066237e265dae99a232e15a92cc962815e03177a12e6bf7a4468d59208aff00c9d62aba3cbfaad9a7cfe01a7b23d9676033ee8b7b962c4e
-  data.tar.gz: 8167ab4e76ac920c90e1dc668886203923ed85ccca1c5c255dac7bf2db0dde181a77be64fc642bf539796172222a5cbb430826da8275fb51c519aacfa987c88b
+  metadata.gz: cb18d346d96019596d0208703b8196a53dac2b356e65c056cad7e9235f7752d7c27e311c0c998a47713cbac3cd0146d839288d6602c592a37303baea34d18530
+  data.tar.gz: 31c0de873ab6b4df5ec610cf40fee3e379f445a73e73b20f1b94678fd2c593b350d9278b60bf6607646542d77e8dde02afafdb6e9227adebdbfd24060b11b4d5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    zendesk (0.1.0)
+    zendesk-james-moriarty (0.1.0)
       activesupport (~> 5.0)
       slop (~> 4.0)
       terminal-table (~> 1.8.0)
@@ -77,7 +77,7 @@ DEPENDENCIES
   rspec (~> 3.0)
   rubocop (~> 0.71.0)
   simplecov (~> 0.16.1)
-  zendesk!
+  zendesk-james-moriarty!
 
 BUNDLED WITH
    2.0.2

data/README.md

@@ -1,29 +1,42 @@
 # Zendesk
 
-[![Build Status](https://travis-ci.com/jamesmoriarty/zendesk.svg?token=kWz41FX2t394aCfgBXSy&branch=master)](https://travis-ci.com/jamesmoriarty/zendesk)
+[![Build Status](https://travis-ci.com/jamesmoriarty/zendesk.svg?token=kWz41FX2t394aCfgBXSy&branch=master)](https://travis-ci.com/jamesmoriarty/zendesk) [![Gem Version](https://badge.fury.io/rb/zendesk-james-moriarty.svg)](https://badge.fury.io/rb/zendesk-james-moriarty)
 
-## Development
-
-### Tests
+## Install
 
 ```
-rake
+gem install zendesk-james-moriarty
 ```
 
 ### Usage
 
 ```
-$ ./exe/zendesk
-usage: ./exe/zendesk [options]
-    -f, --files    json file paths to load e.g. users.json
-    -c, --command  command expression e.g _id=101
+$ zendesk 
+usage: zendesk [options]
+    -f, --files    json file paths to load
+    -c, --command  command expression to execute
     --version      print the version
+
+examples:
+
+  # search field "_id" for value equal to "101" in "organizations.json".
+  zendesk --command _id=101 --files data/organizations.json
+
+  # search field "domain_names" for value equal to "zentix.com" using default fixtures.
+  zendesk --command domain_names=zentix.com
+
+  # search with multiple command expressions.
+  zendesk --command "_id=101 _id=102" --files data/organizations.json
+
+  # search with multiple file paths.
+  zendesk --command "_id=101" --files data/organizations.json --files data/users.json
+
 ```
 
 A command with specific files:
 
 ```
-$ ./exe/zendesk -f data/organizations.json -f data/tickets.json -c "_id=101"  
+zendesk -f data/organizations.json -f data/tickets.json -c "_id=101"  
 +----------------+----------------------------------------------------------+
 |                               Organizations                               |
 +----------------+----------------------------------------------------------+
@@ -36,7 +49,7 @@ $ ./exe/zendesk -f data/organizations.json -f data/tickets.json -c "_id=101"
 A command with the default fixtures:
 
 ```
-./exe/zendesk -c "_id=101"  
+zendesk -c "_id=101"  
 +----------------+----------------------------------------------------------+
 |                               Organizations                               |
 +----------------+----------------------------------------------------------+
@@ -46,10 +59,40 @@ A command with the default fixtures:
 ...
 ```
 
+## Development
+
+### Tests
+
+```
+rake
+```
+
+### Usage
+
+```
+$ ./exe/zendesk
+usage: ./exe/zendesk [options]
+...
+```
+
 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).
 
+## Design
+
+Below is a diagram illustrating the transforms as vertices and the data as edges.
+
+![alt text](./docs/graphviz.png "Graphviz diagram")
+
+- `LoadFiles` -> `Execute` have a common `Strategy` abstraction to allow for a different underlying implementation. This will hopefully help scale with more data.
+- `ParseCommand` abstracts user input and give a common command AST input across different strategies.
+- `Print` can be more abstracted and provide different outputs like JSON, CSV, ...
+- In an attempt to separate Behaviour and Data:
+  - I've tried to write "pure functions" when possible.
+  - I've been attempting to reduce side effects by making some objects immutable. 
+- I've tried to incorporate things like SOLID without making the code feel anemic. 
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/zendesk.

data/lib/zendesk/command_line.rb

@@ -4,34 +4,61 @@ require 'slop'
 
 require 'zendesk/version'
 require 'zendesk/processer'
-require 'zendesk/printer/simple'
-require 'zendesk/printer/table'
+require 'zendesk/printer'
 
 module Zendesk
   module CommandLine
     extend self
 
+    HELP_TEXT = <<~TXT
+
+      examples:
+          
+        # search field "_id" for value equal to "101" in "organizations.json".
+        zendesk --command _id=101 --files data/organizations.json
+          
+        # search field "domain_names" for value equal to "zentix.com" using default fixtures.
+        zendesk --command domain_names=zentix.com
+          
+        # search with multiple command expressions.
+        zendesk --command "_id=101 _id=102" --files data/organizations.json
+          
+        # search with multiple file paths.
+        zendesk --command "_id=101" --files data/organizations.json --files data/users.json
+
+    TXT
+
     def run
       opts = Slop.parse do |opts|
-        opts.array '-f', '--files', 'json file paths to load e.g. Users.json', default: default_file_paths
-        opts.string '-c', '--command', 'command expression e.g _id=101'
+        opts.array '-f', '--files', '"path/to/file.json"', default: default_file_paths
+        opts.string '-c', '--command', '"<FIELD>=<VALUE>"'
+        opts.string '-s', '--strategy', '"ruby", "sqlite3" supported', default: 'ruby'
+        opts.string '-p', '--printer', '"table", "json" supported', default: 'table'
+
+        opts.on '-h', '--help' do
+          puts opts
+
+          puts HELP_TEXT
 
+          exit
+        end
+        
         opts.on '--version', 'print the version' do
           puts Zendesk::VERSION
 
           exit
         end
-      end
 
-      if opts[:command].blank?
-        puts opts
 
-        exit
       end
 
-      results = Zendesk::Processor.process(opts[:command], opts[:files])
+      results = Zendesk::Processor.process(opts[:command], opts[:files], opts[:strategy])
+
+      Zendesk::Printer.get(opts[:printer]).print(results)
+    rescue Exception => e
+      puts e.message
 
-      Printer::Table.print(results)
+      exit
     end
 
     private

data/lib/zendesk/command_parser.rb

@@ -5,7 +5,7 @@ module Zendesk
     extend self
 
     def parse(command)
-      command_ast = tokenize command
+      command_ast = do_parse do_tokenize command
 
       raise Zendesk::Error, 'invalid command' if command_ast.empty?
 
@@ -16,9 +16,12 @@ module Zendesk
 
     private
 
-    def tokenize(command)
-      exps = command.split(' ')
-      exps.map { |exp| exp.split('=') }.each_with_object({}) do |(field, value), ast|
+    def do_tokenize(command)
+      exps = command.split(/\=| /).each_slice(2)
+    end
+
+    def do_parse(tokens)
+      tokens.each_with_object({}) do |(field, value), ast|
         ast['='] ||= []
         ast['='] << [field, value]
       end

data/lib/zendesk/printer.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'zendesk/printer/json'
+require 'zendesk/printer/table'
+
+module Zendesk
+  module Printer
+    module_function
+
+    def get(printer_string)
+      const_get printer_string.classify
+    rescue NameError => e
+      raise Zendesk::Error, "unknown printer '#{printer_string}'"
+    end
+  end
+end

data/lib/zendesk/printer/{simple.rb → json.rb}

@@ -2,7 +2,7 @@
 
 module Zendesk
   module Printer
-    module Simple
+    module Json
       module_function
 
       def print(results)

data/lib/zendesk/processer.rb

@@ -1,30 +1,31 @@
 # frozen_string_literal: true
 
 require 'zendesk/command_parser'
-require 'zendesk/strategy/simple'
+require 'zendesk/strategy'
 
 module Zendesk
   module Processor
     extend self
 
-    def process(command, file_paths, strategy = Strategy::Simple)
-      command_ast = CommandParser.parse(command)
-      db          = strategy.load(file_paths)
-      results     = strategy.exec(db, command_ast)
+    def process(command_string, file_paths, strategy_string)
+      command_ast = CommandParser.parse(command_string)
+      strategy    = Strategy.get(strategy_string)
+      db          = strategy.load_files(file_paths)
+      results     = strategy.execute(db, command_ast)
 
-      do_exec_related strategy, db, results
+      do_execute_related strategy, db, results
     rescue Errno::ENOENT => e
       raise Zendesk::Error, e.message
     end
 
     private
 
-    def do_exec_related(strategy, db, results)
+    def do_execute_related(strategy, db, results)
       results.keys.each do |table_name|
         results[table_name].each do |row|
           command_ast = CommandParser.parse("#{table_name.chomp('s')}_id=#{row['_id']}")
 
-          results = strategy.exec(db, command_ast, results)
+          results = strategy.execute(db, command_ast, results)
         end
       end
 

data/lib/zendesk/strategy.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'zendesk/strategy/ruby'
+require 'zendesk/strategy/sqlite3'
+
+module Zendesk
+  module Strategy
+    module_function
+
+    def get(strategy_string)
+      const_get strategy_string.classify
+    rescue NameError => e
+      raise Zendesk::Error, "unknown strategy '#{strategy_string}'"
+    end
+  end
+end

data/lib/zendesk/strategy/ruby.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Zendesk
+  module Strategy
+    module Ruby
+      extend self
+
+      def load_files(file_paths)
+        db = Hash.new { |hash, key| hash[key] = [] }
+
+        file_paths.inject(db) do |db, file_path|
+          table_name = File.basename file_path, '.json'
+          table_data = JSON.load File.read file_path
+
+          table_data.each_with_object(db) do |row, db|
+            db[table_name] << row
+          end
+        end
+      end
+
+      def execute(db, command_ast, results = Hash.new { |hash, key| hash[key] = [] })
+        db.keys.each do |table_name|
+          db[table_name].each do |row|
+            command_ast.each do |op, context|
+              matched = match_op(op, context, row)
+
+              results[table_name] << row if matched
+            end
+          end
+        end
+
+        results
+      end
+
+      private
+
+      def match_op(op, context, row)
+        case op
+        when '='
+          context.any? { |(field, value)| match_eq row, field, value }
+        else
+          raise Zendesk::Error, "unknown command \"#{op}\""
+        end
+      end
+
+      def match_eq(row, field, value)
+        case row[field]
+        when Array
+          row[field].include?(value)
+        else
+          row[field].to_s == value.to_s
+        end
+      end
+    end
+  end
+end

data/lib/zendesk/strategy/sqlite3.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Zendesk
+  module Strategy
+    module Sqlite3
+      module_function
+
+      def load_files(_file_paths)
+        raise NotImplementedError
+      end
+
+      def execute(_db, _command_ast, _results = {})
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/zendesk/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zendesk-james-moriarty
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - James Moriarty
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-16 00:00:00.000000000 Z
+date: 2019-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -159,15 +159,18 @@ files:
 - data/organizations.json
 - data/tickets.json
 - data/users.json
+- docs/graphviz.png
 - exe/zendesk
 - lib/zendesk.rb
 - lib/zendesk/command_line.rb
 - lib/zendesk/command_parser.rb
-- lib/zendesk/frozen_hash.rb
-- lib/zendesk/printer/simple.rb
+- lib/zendesk/printer.rb
+- lib/zendesk/printer/json.rb
 - lib/zendesk/printer/table.rb
 - lib/zendesk/processer.rb
-- lib/zendesk/strategy/simple.rb
+- lib/zendesk/strategy.rb
+- lib/zendesk/strategy/ruby.rb
+- lib/zendesk/strategy/sqlite3.rb
 - lib/zendesk/version.rb
 - zendesk.gemspec
 homepage: https://github.com/jamesmoriarty/zendesk

data/lib/zendesk/frozen_hash.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module Zendesk
-  class FrozenHash < Hash
-    def initialize
-      super
-
-      freeze
-    end
-
-    def add(table_name, row)
-      new_data = deep_dup
-      new_data[table_name] ||= []
-      new_data[table_name] << row
-
-      FrozenHash[new_data]
-    end
-  end
-end

data/lib/zendesk/strategy/simple.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-require 'json'
-
-require 'zendesk/frozen_hash'
-
-module Zendesk
-  module Strategy
-    module Simple
-      extend self
-
-      def load(file_paths)
-        file_paths.inject(FrozenHash.new) do |db, file_path|
-          table_name = File.basename(file_path, '.json')
-          table_data = JSON.load File.read file_path
-
-          table_data.inject(db) do |db, row|
-            db.add(table_name, row)
-          end
-        end
-      end
-
-      def exec(db, command_ast, results = FrozenHash.new)
-        results = do_exec db, command_ast, results
-      end
-
-      private
-
-      def do_exec(db, command_ast, results)
-        db.keys.each do |table_name|
-          db[table_name].each do |row|
-            command_ast.each do |type, match|
-              case type
-              when '='
-                results = results.add(table_name, row) if match.any? { |(field, value)| row[field].to_s == value.to_s }
-              else
-                raise Zendesk::Error, "unknown command #{type}"
-              end
-            end
-          end
-        end
-
-        results
-      end
-    end
-  end
-end