tricorder 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 171d739dab9839ce2f0be74b57694a1876d063d5089cdb0d90b2090984e88346
-  data.tar.gz: fe3b21010cedcb7ef2a08fa94ce002eb90bfaaf9c48c269e4e0b60e8610f2e66
+  metadata.gz: 17622b879e8001783e06b09fd71ed0c34a12eefd1d2e37e0d09db7a8c3b11892
+  data.tar.gz: 997bd53c65e73aa74c445106ecee68d2e3a55ec5af72bf836b55652909e658c7
 SHA512:
-  metadata.gz: 4f91847fe743bfb9a2153d4e1c906235abf15b3f7a174c7740bd35e548e42af685603976ca101a4d16a0508e5ac415cc0990e960776eb9337621f05e9b09a740
-  data.tar.gz: e74154e4d1a80bba53d4010bdeedcdf2dbd1117365b7bcd080dfc3842b73cc66f8ee972bb588646963ce1e964c5649c3795874466edc0de5507bb0c46a50a4ca
+  metadata.gz: d4ac54adba195400866abeb71029857e3f98153f2add719177d2a85ebda967d1bbac523b5e7bbf3e9942ad4110d1e217d7bb1f41e70753519fd9bb0bc6140ac2
+  data.tar.gz: 7321184774c0659be40b57b817df2d7713885ed8480adf7ddc121d7500101f665574e1bf0e4db33a1a3b6adc481d72fce77079e1bde429923f526de2d6476efa

data/README.md

@@ -41,6 +41,20 @@ $ tricorder search Uhura --database character --print-only-once --print-info=cha
 Human
 ```
 
+To use a plugin use the `--preprocessor`
+
+```
+$ tricorder search Uhura --disable-logging --database character --print-only-once --print-info=characterSpecies name --preprocessor name2klingon printobject scope2klingon --format raw
+0xF8DB 0xF8E8 0xF8DD 0xF8E3 0xF8D0  0xF8E5 0xF8D6 0xF8E5 0xF8E1 0xF8D0
+Human
+0xF8D6 0xF8E5 0xF8DA 0xF8D0 0xF8DB
+```
+
+To set the format output, use the `--format` command, available formats are `plain`, `raw`, `json` and `html`
+```
+tricorder search Uhura --database character --format html
+```
+
 ## Domain Specific Language
 Here's an example of using tricorder programmatically via it's own DSL syntax,
 

data/bin/tricorder

@@ -20,6 +20,8 @@ module Tricorder
     option :print_only_once, type: :boolean, desc: 'Disable printing multiple info results'
     option :print_info, type: :array, desc: 'Print info scope. i.e. --print-info=characterSpecies name'
     option :print_details, type: :boolean, desc: 'Print all the details of each queried info'
+    option :format, type: :string, desc: 'Output format as plain (default), json, html, raw'
+    option :preprocessor, type: :array, desc: 'Use a pre-processor i.e. --preprocessor name2klingon printobject scope2klingon'
 
     desc 'search <keyword>', 'Perform search in Star Trek API on all databases'
     def search(keyword)
@@ -33,6 +35,8 @@ module Tricorder
       command += ".no_logging" if options[:disable_logging]
       command += ".api_key('#{options[:api_key]}')" if options[:api_key]
       command += ".print_only_once" if options[:print_only_once]
+      command += ".set_format('#{options[:format]}')" if options[:format]
+      command += ".preprocessor(#{options[:preprocessor]})" if options[:preprocessor]
       command += ".search_locations(#{locations})"
       command += ".get_result_number(#{options[:result_number]})" if options[:result_number]
       command += ".print_all_results" unless options[:result_number] || options[:print_only_once]

data/lib/dsl/operators/base_operators.rb

@@ -1,4 +1,5 @@
 require_relative 'tricorders'
+require_relative 'plugins'
 
 module BaseOperators
   include Tricorders
@@ -44,6 +45,12 @@ module BaseOperators
       self
     end
 
+    def preprocessor(*preprocessors)
+      @preprocessors = preprocessors.flatten
+
+      self
+    end
+
     def log(message, options = {})
       return unless options[:verbose] || @verbose
 
@@ -141,6 +148,19 @@ module BaseOperators
       end
     end
 
+    def set_format(type)
+      formats = [:raw, :plain, :json, :html]
+
+      if formats.include?(type.to_sym)
+        @format = type.to_sym
+      else
+        ap "Invalid format #{@format}. Valid formats are #{formats.join(', ')}"
+        @error = true
+      end
+
+      self
+    end
+
     def search
       exit(0) if @error
 
@@ -192,10 +212,18 @@ module BaseOperators
 
       init_error_messages
 
+      @object = object
+
       if object.empty?
-        "No info found!"
+        ap "No info found!"
       else
-        object
+        if @preprocessors
+          @preprocessors.each do |preprocessor|
+            self.send(preprocessor.to_sym) unless self.instance_variable_get("@#{preprocessor}".to_sym)
+          end
+        else
+          print_object
+        end
       end
     end
 
@@ -208,7 +236,7 @@ module BaseOperators
 
         fetch_info
         begin
-          info = printer(@info[@tricorder.to_s])
+          info = @info[@tricorder.to_s]
 
           print_info = if field
             info[collection][num][field]
@@ -222,7 +250,7 @@ module BaseOperators
             @out = print_info
           end
 
-          log(@out, {pager: :puts, verbose: true}) unless @printed
+          printer(@out) unless @printed
 
           @printed = true if @print_only_once
         rescue
@@ -239,20 +267,20 @@ module BaseOperators
         set_uid(result['uid'])
 
         fetch_info
-        ap printer(@info)
+        printer(@info)
       end
 
       self
     end
 
     def print_result
-      ap printer(@result)
+      printer(@result)
 
       self
     end
 
     def print_all_results
-      ap printer(@results)
+      printer(@results)
 
       self
     end

data/lib/dsl/operators/plugins.rb

@@ -0,0 +1,7 @@
+Dir[File.join(File.dirname(__FILE__), 'plugins/**/*.rb')].sort.reverse.each { |plugin| require_relative plugin }
+
+module Tricorders
+  include Name2Klingon
+  include Scope2Klingon
+  include PrintObject
+end

data/lib/dsl/operators/plugins/name2klingon.rb

@@ -0,0 +1,20 @@
+require_relative '../../tricorder'
+require_relative '../../tricorder_dsl'
+require_relative 'pIqaD​_alphabet'
+
+module Name2Klingon
+  include PiqadAlphabet
+
+  def name2klingon
+    @name2klingon = true
+    @output = []
+
+    output = @results[0]['name'].scan(/.{1}/)
+
+    output.each_with_index do |val, idx|
+      @output[idx] = KLINGON_LETTERS[val.upcase.to_sym]
+    end
+
+    puts @output.join(' ')
+  end
+end

data/lib/dsl/operators/plugins/pIqaD_alphabet.rb

@@ -0,0 +1,49 @@
+module PiqadAlphabet
+  KLINGON_LETTERS = {
+    A: '0xF8D0',
+    B: '0xF8D1',
+    CH: '0xF8D2',
+    D: '0xF8D3',
+    E: '0xF8D4',
+    GH: '0xF8D5',
+    H: '0xF8D6',
+    I: '0xF8D7',
+    J: '0xF8D8',
+    L: '0xF8D9',
+    M: '0xF8DA',
+    N: '0xF8DB',
+    NG: '0xF8DC',
+    O: '0xF8DD',
+    P: '0xF8DE',
+    Q: '0xF8DF',
+    QH: '0xF8E0',
+    R: '0xF8E1',
+    S: '0xF8E2',
+    T: '0xF8E3',
+    TLH: '0xF8E4',
+    U: '0xF8E5',
+    V: '0xF8E6',
+    W: '0xF8E7',
+    Y: '0xF8E8',
+    GLOTTALDASH: '0xF8E9'
+  }
+
+  KLINGON_DIGITS = {
+    ZERO: '0xF8F0',
+    ONE: '0xF8F1',
+    TWO: '0xF8F2',
+    THREE: '0xF8F3',
+    FOUR: '0xF8F4',
+    FIVE: '0xF8F5',
+    SIX: '0xF8F6',
+    SEVEN: '0xF8F7',
+    EIGHT: '0xF8F8',
+    NINE: '0xF8F9'
+  }
+
+  KLINGON_SYMBOLS = {
+    COMMA: '0xF8FD',
+    FULLSTOP: '0xF8FE',
+    MUMMIFICATIONGLYPH: '0xF8FF'
+  }
+end

data/lib/dsl/operators/plugins/print_object.rb

@@ -0,0 +1,24 @@
+require_relative '../../tricorder'
+require_relative '../../tricorder_dsl'
+
+module PrintObject
+  def printobject
+    case @format
+    when :plain
+      ap @object
+    when :json
+      ap @object, indent: 2,
+                  index: false,
+                  multiline: true,
+                  plain: true,
+                  raw: true,
+                  sort_keys: true,
+                  sort_vars: true
+    when :html
+      ap @object, html: true
+    when :raw
+      puts @object
+    end
+  end
+  alias_method :print_object, :printobject
+end

data/lib/dsl/operators/plugins/scope2klingon.rb

@@ -0,0 +1,21 @@
+require_relative '../../tricorder'
+require_relative '../../tricorder_dsl'
+require_relative 'pIqaD​_alphabet'
+
+module Scope2Klingon
+  include PiqadAlphabet
+
+  def scope2klingon
+    @scope2klingon = true
+    @output = []
+    return unless @object.is_a?(String)
+
+    output = @object.scan(/.{1}/)
+
+    output.each_with_index do |val, idx|
+      @output[idx] = KLINGON_LETTERS[val.upcase.to_sym]
+    end
+
+    puts @output.join(' ')
+  end
+end

data/lib/dsl/tricorder_dsl.rb

@@ -14,6 +14,8 @@ class TricorderDSL < BaseOperators::BaseDSLOperators
     @storedir = '/tmp'
     @tricorder = nil
     @info = {}
+    @format = :plain
+    @output = []
   end
 
   def method_missing(method, *args)

data/lib/version.rb

@@ -2,7 +2,7 @@ module Tricorder #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 1
-    TINY  = 0
+    TINY  = 1
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tricorder
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Joel Bryan Juliano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-24 00:00:00.000000000 Z
+date: 2018-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +94,11 @@ files:
 - bin/tricorder
 - lib/dsl/operators/.rb
 - lib/dsl/operators/base_operators.rb
+- lib/dsl/operators/plugins.rb
+- lib/dsl/operators/plugins/name2klingon.rb
+- lib/dsl/operators/plugins/pIqaD_alphabet.rb
+- lib/dsl/operators/plugins/print_object.rb
+- lib/dsl/operators/plugins/scope2klingon.rb
 - lib/dsl/operators/string.rb
 - lib/dsl/operators/tricorders.rb
 - lib/dsl/operators/tricorders/animal.rb