asi_bod 0.1.2

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/README.rdoc

@@ -0,0 +1,33 @@
+= NAME asi_bod
+
+- Manipulate and view the ASIObjectDictionary.xml and BOD.json files
+
+== SYNOPSIS
+    asi_bod [global options] command [command options] [arguments...]
+
+== Overview
+
+Tool to view, search and potentially merge the Grin Tech Phaserunner +BOD.json+
+file and the ASI +ASIObjectDictionary.xml+ file.
+
+The +BOD.json+ file is the original Grin Tech file that ships with the
++PhaseRunner v0.9.9.1+ software as of Jan 1 2018.
+
+This gem ships with +BODm.json+ which is the same as the Grin Tech +BOD.json+ except
+the Descriptions from the ASI +ASIObjectDictionary.xml+ file that shipped with the
++BacDoorSetup_1_5_4+ software.
+
+If you want to start with the original or another version of the +BOD.json+ or the
++ASIObjectDictionary.xml+ then you can override the defaults with the +-a,
+--asi_file+ or +-b, --bod_file+ flags
+
+== 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
+
+== Detailed Command Line Info
+
+:include: asi_bod.rdoc
+

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rake/clean'
+require 'rubygems'
+require 'rubygems/package_task'
+require 'rdoc/task'
+require 'cucumber'
+require 'cucumber/rake/task'
+Rake::RDocTask.new do |rd|
+  rd.main = "README.rdoc"
+  rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
+  rd.title = 'Your application title'
+end
+
+# task :rdoc_to_md
+# ruby -r rdoc -e 'puts RDoc::Markup::ToMarkdown.new.convert File.read(ARGV[0] || "README.rdoc")' | grep -v ':include:' >README.md
+# ruby -r rdoc -e 'puts RDoc::Markup::ToMarkdown.new.convert File.read(ARGV[0] || "asi_bod.rdoc")' >> README.md
+
+spec = eval(File.read('asi_bod.gemspec'))
+
+Gem::PackageTask.new(spec) do |pkg|
+end
+CUKE_RESULTS = 'results.html'
+CLEAN << CUKE_RESULTS
+desc 'Run features'
+Cucumber::Rake::Task.new(:features) do |t|
+  opts = "features --format html -o #{CUKE_RESULTS} --format progress -x"
+  opts += " --tags #{ENV['TAGS']}" if ENV['TAGS']
+  t.cucumber_opts =  opts
+  t.fork = false
+end
+
+desc 'Run features tagged as work-in-progress (@wip)'
+Cucumber::Rake::Task.new('features:wip') do |t|
+  tag_opts = ' --tags ~@pending'
+  tag_opts = ' --tags @wip'
+  t.cucumber_opts = "features --format html -o #{CUKE_RESULTS} --format pretty -x -s#{tag_opts}"
+  t.fork = false
+end
+
+task :cucumber => :features
+task 'cucumber:wip' => 'features:wip'
+task :wip => 'features:wip'
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+end
+
+task :default => [:test,:features]

data/asi_bod.gemspec

@@ -0,0 +1,46 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "asi_bod/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "asi_bod"
+  spec.version       = AsiBod::VERSION
+  spec.authors       = ["Robert J. Berger"]
+  spec.email         = ["rberger@ibd.com"]
+
+  spec.summary       = %q{Process and View Grin Phaserunner ASIObjectDictionary.xml and BOD.json files}
+  spec.description   = %q{Process and View Grin Phaserunner ASIObjectDictionary.xml and BOD.json files}
+  spec.homepage      = "https://github.com/rberger/asi_bod"
+  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.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  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.has_rdoc = true
+  spec.extra_rdoc_files = ['README.rdoc','asi_bod.rdoc']
+  spec.rdoc_options << '--title' << 'asi_bod' << '--main' << 'README.rdoc' << '-ri'
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rdoc", "~> 6.0"
+  spec.add_development_dependency "aruba", "~> 0.14"
+  spec.add_runtime_dependency "gli","~> 2.17"
+  spec.add_runtime_dependency "nori","~> 2.6"
+  spec.add_runtime_dependency "nokogiri", "~> 1.8"
+
+end

data/asi_bod.rdoc

@@ -0,0 +1,119 @@
+== asi_bod - Manipulate and view the ASIObjectDictionary.xml and BOD.json files
+
+v0.1.2
+
+=== Global Options
+=== -a|--asi_file arg
+
+Path to the ASIObjectDictionary XML file
+
+[Default Value] /Users/rberger/odrive/IBD Google Drive/Trike/bike-pi/asi_bod/ASIObjectDictionary.xml
+
+
+=== -b|--bod_file arg
+
+Path to the BOD JSON file
+
+[Default Value] /Users/rberger/odrive/IBD Google Drive/Trike/bike-pi/asi_bod/BODm.json
+
+
+=== --[no-]address_view
+View Address
+
+
+
+=== --[no-]description_view
+View Description
+
+
+
+=== --help
+Show this message
+
+
+
+=== --[no-]name_view
+View Name
+
+
+
+=== -s|--[no-]scale_view
+View Scale
+
+
+
+=== -u|--[no-]units_view
+View Units
+
+
+
+=== --version
+Display the program version
+
+
+
+=== Commands
+==== Command: <tt>find </tt>
+Find a node in one or both of the dictionaries
+
+
+===== Options
+===== -a|--[no-]asi
+Search the asi dictionary
+
+
+
+===== -b|--[no-]bod
+Search the bod dictionary
+
+
+
+===== Commands
+====== Command: <tt>by_address </tt>
+Find by register address
+
+Find by register address. Must select at least one of asi or bod and specify search_term
+====== Command: <tt>by_key_substring </tt>
+Find by the substring of a key
+
+Find by the substring of a Must select at least one of asi or bod and specify search_term
+==== Command: <tt>help  command</tt>
+Shows a list of commands or help for one command
+
+Gets help for the application or its commands. Can also list the commands in a way helpful to creating a bash-style completion function
+===== Options
+===== -c
+List commands one per line, to assist with shell completion
+
+
+
+==== Command: <tt>merge </tt>
+Merge the Description from asi to bod
+
+Merge the Description from asi to bod Do not merge if Description has "Reserved" in it Or if the Bod doesnt have the key
+===== Options
+===== -j|--[no-]json
+Output Json
+
+
+
+==== Command: <tt>view </tt>
+View the data
+
+
+===== Options
+===== -j|--[no-]json
+Output as Json instead of CSV
+
+
+
+===== Commands
+====== Command: <tt>asi </tt>
+Pretty Print output of the simplified ASI ObjectDictionary as a hash
+
+
+====== Command: <tt>bod </tt>
+Pretty Print output of the simplified BOD as a hash
+
+
+[Default Command] bod

data/exe/asi_bod

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'asi_bod'
+
+cli = AsiBod::Cli.new
+cli.main

data/lib/asi_bod.rb

@@ -0,0 +1,6 @@
+require 'asi_bod/gli_patch.rb'
+require 'asi_bod/version.rb'
+require 'asi_bod/cli.rb'
+require 'asi_bod/asi.rb'
+require 'asi_bod/bod.rb'
+require 'asi_bod/dict.rb'

data/lib/asi_bod/asi.rb

@@ -0,0 +1,33 @@
+
+require 'nori'
+
+module AsiBod
+  class Asi
+    attr_reader :nori
+    attr_reader :raw_data
+    attr_reader :array_data
+    attr_reader :hash_data
+
+    def initialize(global_options, options, args)
+      @nori = Nori.new
+      @raw_data = @nori.parse(File.read(global_options[: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)
+      end
+    end
+
+    def clean_node(node)
+      node.each_with_object({}) do |(k,v), memo|
+        next if k == "@FaultIndicator" || k == "BitField" # Skip these pairs
+        key = k.sub(k[0], k[0].downcase) # Make it uncapitalized
+        memo[key.to_sym] = v
+      end
+    end
+  end
+end

data/lib/asi_bod/bod.rb

@@ -0,0 +1,24 @@
+require 'json'
+
+module AsiBod
+  class Bod
+    attr_reader :hash_data
+
+    def initialize(global,options,args)
+      @json_data = JSON.parse(File.read(global[:bod_file]))
+      @hash_data = json_data_to_hash(@json_data)
+    end
+
+    def json_data_to_hash(json_data)
+      json_data.each_with_object({}) do |(k, v), memo|
+        memo[k.to_i] = clean_node(v)
+      end
+    end
+
+    def clean_node(node)
+      node.each_with_object({}) do |(k, v), memo|
+        memo[k.to_sym] = v
+      end
+    end
+  end
+end

data/lib/asi_bod/cli.rb

@@ -0,0 +1,191 @@
+require 'gli'
+require 'json'
+require 'pp'
+
+module AsiBod
+
+  class Cli
+    attr_reader :asi
+    attr_reader :bod
+
+    include GLI::App
+
+    GPARENT = GLI::Command::PARENT
+
+    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")
+          # 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
+          # Store them in KEY_ORDER
+          memo[KEY_ORDER[key]] = key
+        end
+      end.compact
+    end
+
+    def main
+      program_desc 'Manipulate and view the ASIObjectDictionary.xml and BOD.json files'
+
+      version AsiBod::VERSION
+
+      subcommand_option_handling :normal
+      arguments :strict
+
+      desc 'Path to the ASIObjectDictionary XML file'
+      default_value File.expand_path('../../../ASIObjectDictionary.xml', __FILE__)
+      flag [:a,:asi_file]
+
+      desc 'Path to the BOD JSON file'
+      default_value File.expand_path('../../../BODm.json', __FILE__)
+      flag [:b,:bod_file]
+
+      desc 'View Address'
+      switch :address_view, default_value: true
+
+      desc 'View Name'
+      switch :name_view, default_value: true
+
+      desc 'View Description'
+      switch :description_view, default_value: true
+
+      desc 'View Scale'
+      switch [:s, :scale_view]
+
+      desc 'View Units'
+      switch [:u, :units_view]
+
+      desc 'View the data'
+      command :view do |view|
+        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.switch [:j, :json]
+
+          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))
+            end
+          end
+        end
+
+        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))
+            end
+          end
+        end
+        view.default_command :bod
+      end
+
+      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 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.arg 'address'
+        find.command :by_address do |find_by_address| 
+          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: => " +
+                 "#{Dict.node_line(asi.hash_data[address.to_i],
+                    which_keys(global_options))}" if options[GPARENT][:asi]
+            puts "bod: => " +
+                 "#{Dict.node_line(bod.hash_data[address.to_i],
+                    which_keys(global_options))}" if options[GPARENT][:bod]
+          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.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|
+            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))
+            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))
+            end
+          end
+        end
+      end
+
+      desc 'Merge the Description from asi to bod'
+      long_desc 'Merge the Description from asi to bod ' +
+                'Do not merge if Description has "Reserved" in it ' +
+                'Or if the Bod doesnt have the key'
+      command :merge do |merge|
+        merge.desc 'Output Json'
+        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
+          puts result
+        end
+      end
+
+      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)
+      end
+
+      post do |global_options,command,options,args|
+        # Post logic here
+        # Use skips_post before a command to skip this
+        # block on that command only
+      end
+
+      on_error do |exception|
+        # Error logic here
+        # return false to skip default error handling
+        true
+      end
+
+      exit run(ARGV)
+    end
+  end
+end