asi_bod 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae26c57d2a4a79a4b382d879ce67dc88f5beeeea
-  data.tar.gz: 896df20de06baddfdb046a32716d83b09fa099f0
+  metadata.gz: 0fffe6a70e746724e33292bea03778ae3c4ae4e7
+  data.tar.gz: 343e48434eb1a69e0e532891fc4fcc39649fd15a
 SHA512:
-  metadata.gz: d42a641277355dec13da962cba023b1be5b35373c498a2c3520bf7c3303dbf2063e0b0b6345eac975e5bab01e879eb5cc87de7f8e1a961a462849c136505e87f
-  data.tar.gz: 422547b0c18113035709a26c750dc633d491527af8c67a0793d0c91ffb05d971c5bf8ed7a54b95344039ef371c4e57677e55b3329e44d74d1f1a5e4c8ac54136
+  metadata.gz: ed713a4e7cca0ceacd3cebb2eca07d40cc28347fc015b2bd7ff21f576a9bae87429e71862905f0d97285e94c458171ad582f2dcadc4518d017da2ee53f8eea5a
+  data.tar.gz: 29f643a1f59f09624aa728da6d8f8d38105c736913a13c750adf7bb9e9734484ff72cc7ae897b1809c9a0fbdf75414e8cc7fecbaf3c2adeccddb8c6cb7e9a56c

data/README.rdoc

@@ -5,6 +5,8 @@
 == SYNOPSIS
     asi_bod [global options] command [command options] [arguments...]
 
+{<img src="https://badge.fury.io/rb/asi_bod.svg" alt="Gem Version" />}[https://badge.fury.io/rb/asi_bod]
+
 == Overview
 
 Tool to view, search and potentially merge the Grin Tech Phaserunner +BOD.json+
@@ -21,11 +23,24 @@ If you want to start with the original or another version of the +BOD.json+ or t
 +ASIObjectDictionary.xml+ then you can override the defaults with the +-a,
 --asi_file+ or +-b, --bod_file+ flags
 
+== GLOBAL OPTIONS
+    -a, --asi_file=arg      - Path to the ASIObjectDictionary XML file (default: /Users/rberger/odrive/IBD Google
+                              Drive/Trike/bike-pi/asi_bod/ASIObjectDictionary.xml)
+    -b, --bod_file=arg      - Path to the BOD JSON file (default: /Users/rberger/odrive/IBD Google
+                              Drive/Trike/bike-pi/asi_bod/BODm.json)
+    --version               - Display the program version
+    --[no-]address_view     - View Address (default: enabled)
+    --[no-]name_view        - View Name (default: enabled)
+    --[no-]description_view - View Description (default: enabled)
+    -s, --[no-]scale_view   - View Scale
+    -u, --[no-]units_view   - View Units
+    --help                  - Show this message
+
 == COMMANDS
-    find  - Find a node in one or both of the dictionaries
     help  - Shows a list of commands or help for one command
-    merge - Merge the Description from asi to bod
     view  - View the data
+    find  - Find a node in one or both of the dictionaries
+    merge - Merge the Description from asi to bod
 
 == Detailed Command Line Info
 

data/asi_bod.rdoc

@@ -1,6 +1,6 @@
 == asi_bod - Manipulate and view the ASIObjectDictionary.xml and BOD.json files
 
-v0.1.2
+v0.1.3
 
 === Global Options
 === -a|--asi_file arg

data/lib/asi_bod/asi.rb

@@ -2,23 +2,33 @@
 require 'nori'
 
 module AsiBod
+
+  # Handle reading in ASI ObjectDictionary and doing operations on it
   class Asi
     attr_reader :nori
     attr_reader :raw_data
     attr_reader :array_data
     attr_reader :hash_data
 
-    def initialize(global_options, options, args)
+    # Returns the path to the default ASIObjectDictionary.xml file
+    def self.default_file_path
+      File.expand_path('../../../ASIObjectDictionary.xml', __FILE__)
+    end
+
+    # Asi.new reads in the source file for the ASIObjectDictionary and creates
+    # an internal Hash
+    # @param params [Hash]
+    def initialize(params = { asi_file: default_file_path })
       @nori = Nori.new
-      @raw_data = @nori.parse(File.read(global_options[:asi_file]))
-      @array_data = @raw_data["InternalAppEntity"]["Parameters"].first[1]
+      @raw_data = @nori.parse(File.read(params[:asi_file]))
+      @array_data = @raw_data['InternalAppEntity']['Parameters'].first[1]
       @hash_data = array_data_to_hash(@array_data)
     end
 
     # Convert the array of hashes to a hash with the address as primary key
     def array_data_to_hash(array_data)
       array_data.each_with_object({}) do |node, memo|
-        memo[node["Address"].to_i] = clean_node(node)
+        memo[node['Address'].to_i] = clean_node(node)
       end
     end
 

data/lib/asi_bod/bod.rb

@@ -1,11 +1,18 @@
 require 'json'
 
 module AsiBod
+
+  # Handle reading in Grin Tech BOD Json file and doing operations on it
   class Bod
     attr_reader :hash_data
 
-    def initialize(global,options,args)
-      @json_data = JSON.parse(File.read(global[:bod_file]))
+    # Returns the path to the default BODm.json file
+    def self.default_file_path
+      File.expand_path('../../../BODm.json', __FILE__)
+    end
+
+    def initialize(params = { bod_file: default_file_path })
+      @json_data = JSON.parse(File.read(params[:bod_file]))
       @hash_data = json_data_to_hash(@json_data)
     end
 

data/lib/asi_bod/cli.rb

@@ -12,27 +12,28 @@ module AsiBod
 
     GPARENT = GLI::Command::PARENT
 
-    KEY_ORDER = {address: 0,
-                 name: 1,
-                 description: 2,
-                 scale: 3,
-                 units: 4,
-                 read: 5,
-                 write: 6}
+    KEY_ORDER = { address: 0,
+                  name: 1,
+                  description: 2,
+                  scale: 3,
+                  units: 4,
+                  read: 5,
+                  write: 6 }
 
     def which_keys(options)
       options.each_with_object([]) do |(k,v), memo|
-        if k.is_a?(String) && k.include?("_view")
+        if k.is_a?(String) && k.include?('_view')
           # Its a view key
           next unless options[k]
           # Strip off the '_view' and convert to a symbol
-          key = k[0..(k.index("_view") - 1)].to_sym
+          key = k[0..(k.index('_view') - 1)].to_sym
           # Store them in KEY_ORDER
           memo[KEY_ORDER[key]] = key
         end
       end.compact
     end
 
+    # Main body. Does all the CLI processing and dispatching
     def main
       program_desc 'Manipulate and view the ASIObjectDictionary.xml and BOD.json files'
 
@@ -40,14 +41,15 @@ module AsiBod
 
       subcommand_option_handling :normal
       arguments :strict
+      sort_help :manually
 
       desc 'Path to the ASIObjectDictionary XML file'
-      default_value File.expand_path('../../../ASIObjectDictionary.xml', __FILE__)
-      flag [:a,:asi_file]
+      default_value Asi.default_file_path
+      flag [:a, :asi_file]
 
       desc 'Path to the BOD JSON file'
-      default_value File.expand_path('../../../BODm.json', __FILE__)
-      flag [:b,:bod_file]
+      default_value Bod.default_file_path
+      flag [:b, :bod_file]
 
       desc 'View Address'
       switch :address_view, default_value: true
@@ -66,27 +68,35 @@ module AsiBod
 
       desc 'View the data'
       command :view do |view|
-        view.desc "Pretty Print output of the simplified ASI ObjectDictionary as a hash"
+        view.desc 'Pretty Print output of the simplified ASI ObjectDictionary as a hash'
         view.command :asi do |view_asi| 
-          view.desc "Output as Json instead of CSV"
+          view.desc 'Output as Json instead of CSV'
           view.switch [:j, :json]
 
-          view_asi.action do |global_options,options,args|
+          view_asi.action do |global_options, options, args|
             if options[GPARENT][:json]
               puts JSON.pretty_generate asi.hash_data
             else
-              Dict.put_results(asi.hash_data, which_keys(global_options))
+              Dict.specific_keys_per_node(
+                asi.hash_data,
+                which_keys(global_options)) do |address, node|
+                puts node
+              end
             end
           end
         end
 
-        view.desc "Pretty Print output of the simplified BOD as a hash"
+        view.desc 'Pretty Print output of the simplified BOD as a hash'
         view.command :bod do |view_bod|
           view_bod.action do |global_options,options,args|
             if options[GPARENT][:json]
               puts JSON.pretty_generate bod.hash_data
             else
-              Dict.put_results(bod.hash_data, which_keys(global_options))
+              Dict.specific_keys_per_node(
+                bod.hash_data,
+                which_keys(global_options)).each_pair do |address, node|
+                puts node
+              end
             end
           end
         end
@@ -95,19 +105,19 @@ module AsiBod
 
       desc 'Find a node in one or both of the dictionaries'
       command :find do |find|
-        find.desc "Search the asi dictionary"
-        find.switch [:a, :asi] 
+        find.desc 'Search the asi dictionary'
+        find.switch [:a, :asi]
 
-        find.desc "Search the bod dictionary"
+        find.desc 'Search the bod dictionary'
         find.switch [:b, :bod]
 
-        find.desc "Find by register address"
-        find.long_desc %{Find by register address. } +
-                       %{Must select at least one of } +
-                       %{asi or bod and specify search_term}
+        find.desc 'Find by register address'
+        find.long_desc 'Find by register address. ' +
+                       'Must select at least one of ' +
+                       'asi or bod and specify search_term'
         find.arg 'address'
         find.command :by_address do |find_by_address| 
-          find_by_address.action do |global_options,options,args|
+          find_by_address.action do |global_options, options, args|
             address = args.first
             # puts "find_by_address global_options #{global_options.inspect} options: #{options.inspect} args: #{args.inspect}"
             puts "asi: => " +
@@ -119,27 +129,29 @@ module AsiBod
           end
         end
 
-        find.desc "Find by the substring of a key"
-        find.long_desc %{Find by the substring of } +
-                       %{a Must select at least one of } +
-                       %{asi or bod and specify search_term}
+        find.desc 'Find by the substring of a key'
+        find.long_desc 'Find by the substring of ' +
+                       'a Must select at least one of ' +
+                       'asi or bod and specify search_term'
         find.arg 'node_key'
         find.arg 'substring'
         find.command :by_key_substring do |find_by_key_substring| 
-          find_by_key_substring.action do |global_options,options,args|
+          find_by_key_substring.action do |global_options, options, args|
             key = args[0].to_sym
             substring = args[1]
             if options[GPARENT][:asi]
               puts "asi: key: #{key} substring: #{substring} => "
               Dict.put_results(
                 Dict.find_by_key_substring(asi.hash_data, key, substring),
-                which_keys(global_options))
+                which_keys(global_options)
+              )
             end
             if options[GPARENT][:bod]
               puts "bod: key: #{key} substring: #{substring} => "
               Dict.put_results(
                 Dict.find_by_key_substring(bod.hash_data, key, substring),
-                which_keys(global_options))
+                which_keys(global_options)
+              )
             end
           end
         end
@@ -154,26 +166,26 @@ module AsiBod
         merge.switch [:j, :json]
         merge.action do |global_options,options,args|
           raw_result = Dict.merge(asi.hash_data, bod.hash_data)
-          if options[:json]
-            result = JSON.pretty_generate raw_result
-          else
-            result = raw_result.pretty_inspect
-          end
+          result = if options[:json]
+                     JSON.pretty_generate raw_result
+                   else
+                     raw_result.pretty_inspect
+                   end
           puts result
         end
       end
 
-      pre do |global_options,command,options,args|
+      pre do |global_options, command, options, args|
         # Pre logic here
         # Return true to proceed; false to abort and not call the
         # chosen command
         # Use skips_pre before a command to skip this block
         # on that command only
-        @asi = AsiBod::Asi.new(global_options,options,args)
-        @bod = AsiBod::Bod.new(global_options,options,args)
+        @asi = AsiBod::Asi.new(global_options)
+        @bod = AsiBod::Bod.new(global_options)
       end
 
-      post do |global_options,command,options,args|
+      post do |global_options, command, options, args|
         # Post logic here
         # Use skips_post before a command to skip this
         # block on that command only

data/lib/asi_bod/dict.rb

@@ -2,11 +2,19 @@ require 'pp'
 
 module AsiBod
 
+  # Manipulate the unified Hash that can contain the data from
+  # ASIObjectDictionary or BOD
   class Dict
-    def self.find_by_key_substring(dict, key, search_string)
+    # Find a node in the dict by the value of the specified key
+    # @params dict [Hash] The unified Hash of Hashes that represents the ASIObjectDictionary or BOD data
+    # @params key [Symbol] The Key that will be search against
+    # @params search_value [String, Symbol] The value to search for
+    # @params output_keys [Array] What keys of the node to return
+    # @return [Array<Hash>] Array of Dict nodes scoped by output_keys
+    def self.find_by_key_substring(dict, key, search_value, output_keys)
       dict.each_with_object({}) do |(k, v), memo|
         next if v[key].nil?
-        memo[k] = v if v[key].to_s.include? search_string
+        memo[k] = node_line(v, output_keys) if v[key].to_s.include? search_value
       end
     end
 
@@ -21,17 +29,23 @@ module AsiBod
     # with only the keys specified
     # @param results [Hash] The subset of a full asi or bod Hash
     # @param keys [Array] Optional array of keys to display
-    def self.put_results(results, keys)
-      results.each_pair do |address, node|
-        puts Dict.node_line(node, keys)
+    # @return [Hash<Symbol>,<Hash>] Hash of Hashes with each hash having specified keys
+    def self.specific_keys_per_node(dict, keys)
+      dict.each_with_object({}) do |(key, node), memo|
+        memo[key] = Dict.node_line(node, keys)
       end
     end
 
+    # Merge the descriptions from ASIObjectDictionary Hash of Hashes into BOD
+    # Hash of Hashes This is not used often. Allowed the creation of the
+    # BODm.json file which has the ASIObjectDictionary Descriptions merged in
+    # @param asi [Hash] The Hash of Hashes of the ASIObjectDictionary
+    # @param bod [Hash] The Hash of Hashes of the BOD
     def self.merge(asi, bod)
       bod.each_with_object({}) do |(address, node), memo|
         memo[address] = node
         if (asi[address][:description].nil? ||
-            asi[address][:description].include?("Reserved") rescue true)
+            asi[address][:description].include?('Reserved') rescue true)
           memo[address][:description] = nil
         end
         memo[address][:description] = asi[address][:description]

data/lib/asi_bod/version.rb

@@ -1,3 +1,3 @@
 module AsiBod
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asi_bod
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Robert J. Berger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-08 00:00:00.000000000 Z
+date: 2018-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler