binp 4.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 737c05ad3f05c0d57238526b2456d36e3a0fb1de14909d64fffa15942bfc76eb
-  data.tar.gz: 30c2ad4ec1b7a6cf12b772a85a4a811a5c22da0db93544346761584028fd3ff8
+  metadata.gz: 5c53f3f9d6f7dfaf4ef40754a51b901510e27c13a28ca4bebf51138d7af7eeef
+  data.tar.gz: 84343e0458654820acf6f33d053506786b72c226aa1c7db2ba493b2e67b2227a
 SHA512:
-  metadata.gz: 19085d777a54bd338c9e12868ad3041a57540e568ba7cd36c9c1dae393235187fa5f9240708f5a517ff42e4f9a063ba5121d8a0dd49af4c56404dd6cd4b7a6ce
-  data.tar.gz: 6967cd575f2897023570563fc6985981b02b75dc7c62da6b807bafad938166875891f6f333c8270263273ba0a35681887a204b390b6f0c96bfe782dba5631564
+  metadata.gz: 3315c9cbdb10d04fb4d47afbd13b0056054bfd43d05358dae11967062d1c9ba3c4494565546deb783deec692870bbe4a6284ed9e00ab3338abc71a3a22d2fca0
+  data.tar.gz: 69f95fcd377c8c153a6c583b1094f31032e347f6baa2bc15ed31938ba93ebcebfea263f5b11eb5c88a8840e6f80cd447e0d90cee70249ecdc0cdb99cd3a18b98

data/Gemfile.lock

@@ -1,21 +1,31 @@
 PATH
   remote: .
   specs:
-    binp (4.0.0)
+    binp (4.1.0)
       formatador
+      listen
 
 GEM
   remote: https://rubygems.org/
   specs:
-    docile (1.3.2)
-    formatador (0.2.5)
-    power_assert (1.2.0)
+    docile (1.4.0)
+    ffi (1.15.5)
+    formatador (1.1.0)
+    listen (3.8.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    power_assert (2.0.3)
     rake (12.3.3)
-    simplecov (0.18.5)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
-    simplecov-html (0.12.2)
-    test-unit (3.3.6)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    test-unit (3.6.1)
       power_assert
 
 PLATFORMS
@@ -28,4 +38,4 @@ DEPENDENCIES
   test-unit
 
 BUNDLED WITH
-   2.1.4
+   2.4.19

data/README.md

@@ -7,6 +7,14 @@
 
 # 使い方
 
+```sh
+Usage: binp [options] FILE
+    -c, --config VALUE               設定ファイルパス
+    -a, --all                        name, value 以外のすべての項目(endianness, offset, size, type)を表示する
+    -p, --polling VALUE              指定したポーリング間隔(ミリ秒)で再表示します
+    -w, --watch                      ファイル更新時に再表示します
+```
+
 以下内容のバイナリファイルをパースする場合について説明する。
 
 ■ `example.bin`

data/binp.gemspec

@@ -26,6 +26,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency 'formatador'
+  spec.add_dependency 'listen'
 
   spec.add_development_dependency 'test-unit'
   spec.add_development_dependency 'simplecov'

data/lib/binp/cli/main.rb

@@ -1,51 +1,52 @@
 # encoding: UTF-8
 require 'formatador'
 require 'json'
+require 'listen'
 require 'optparse'
+require 'pathname'
 require 'yaml'
 
 require_relative '../../binp.rb'
 
 class Main
   def self.run(argv)
-    # 引数パース
-    opts, argv = parse_option(argv)
-
-    # ファイル読み込み
-    config = read_config_file(opts[:config])
-    uint8_array = read_binary_file(argv[0])
-
-    # バイナリパース
-    raw_result = BinParser.parse(uint8_array, config)
-
-    # 出力用に加工して出力
-    result = raw_result.map { |e|
-      e['type'] = e['type'][:name]
-
-      # FLAGS では endianness が無い場合があるのでチェックしてから設定
-      if e['endianness']
-        e['endianness'] = e['endianness'][:name]
+    begin
+      # 引数パース
+      opts, argv = parse_option(argv)
+
+      # コンフィグファイル読み込み
+      config = read_config_file(opts[:config])
+
+      # watch オプションを確認し、フラグがたっていれば watch モードで実行
+      if opts[:watch]
+        watch(config, opts[:all], argv[0])
+      elsif opts[:polling] != 0
+        interval = opts[:polling].to_f / 1000.0
+        loop do
+          display(config, opts[:all], argv[0], true)
+          sleep interval
+        end
+      else
+        display(config, opts[:all], argv[0], false)
       end
-
-      # layout は出力量が多すぎるので削除
-      e.delete('layout')
-      e
-    }
-    if  !opts[:all]
-        result.map! { |e| { 'name' => e['name'], 'value' => e['value']} }
+    rescue Interrupt
+      # do nothing
     end
-    Formatador.display_compact_table(result)
   end
 
   def self.parse_option(argv)
     options = {
-        all: false
+        all: false,
+        polling: 0,
+        watch: false
     }
     op = OptionParser.new
     op.banner = 'Usage: binp [options] FILE'
 
     op.on('-c VALUE', '--config VALUE', '設定ファイルパス') { |v| options[:config] = v }
     op.on('-a', '--all', 'name, value 以外のすべての項目(endianness, offset, size, type)を表示する') { |v| options[:all] = true }
+    op.on('-p VALUE', '--polling VALUE', '指定したポーリング間隔(ミリ秒)で再表示します') { |v| options[:polling] = v }
+    op.on('-w', '--watch', 'ファイル更新時に再表示します') { |v| options[:watch] = true }
     begin
       op.parse!(argv)
     rescue OptionParser::InvalidOption => e
@@ -111,5 +112,68 @@ class Main
       f.each_byte.to_a
     }
   end
+
+  # watch モード(指定されたファイルが更新されるたびに結果を出力する)
+  def self.watch(config, is_all, file)
+    # 初回の出力
+    display(config, is_all, file, true)
+    
+    # ファイルの変更を監視し、変更があればターミナルに出力
+    directory = Pathname.new(file).dirname.to_s
+    listener = Listen.to(directory) do |modified, _added, _removed|
+      modified_file = Pathname.new(modified.first).expand_path
+
+      # 変更されたファイルが監視対象でなければ何もしない
+      next unless modified_file == Pathname.new(file).expand_path
+
+      # 出力
+      display(config, is_all, modified_file, true)
+    end
+
+    listener.start
+    begin
+      sleep
+    rescue Interrupt
+      # do nothing
+    end
+  end
+
+  # バイナリファイルをパースして、出力用にフォーマットする
+  def self.parse_and_format(config, is_all, file)
+    uint8_array = read_binary_file(file);
+
+    # バイナリパース
+    raw_result = BinParser.parse(uint8_array, config)
+
+    # パース結果を出力用に加工
+    result = raw_result.map { |e|
+      e['type'] = e['type'][:name]
+
+      # FLAGS では endianness が無い場合があるのでチェックしてから設定
+      if e['endianness']
+        e['endianness'] = e['endianness'][:name]
+      end
+
+      # layout は出力量が多すぎるので削除
+      e.delete('layout')
+      e
+    }
+
+    # all フラグが立っていない場合、 name と value のみ抽出
+    if !is_all
+        result.map! { |e| { 'name' => e['name'], 'value' => e['value']} }
+    end
+
+    result
+  end
+
+  def self.display(config, is_all, file, is_reset)
+    # 表示用文字列を取得
+    result = parse_and_format(config, is_all, file)
+
+    # 一度ターミナルをリセットして表示し直す
+    printf "\033c" if is_reset
+    Formatador.display_compact_table(result)
+  end
 end
 

data/lib/binp/version.rb

@@ -1,3 +1,3 @@
 module Binp
-  VERSION = "4.0.0"
+  VERSION = "4.1.0"
 end

data/lib/binp.rb

@@ -3,16 +3,17 @@ require "binp/version"
 
 class BinParser
   def self.parse(uint8_array, config)
-    config.flat_map { |e|
+    flatten_config = config.flat_map { |e|
+      new_e = e.clone
       # ビットフラグかどうかを確認
       if e['type'] == BinParserElement::Type::FLAGS
-        e = BinParserElement.get_flags(uint8_array, e)
+        new_e = BinParserElement.get_flags(uint8_array, e)
       else
-        e['value'] = BinParserElement.get_value(uint8_array, e['offset'], e['size'], e['type'], e['endianness'], e['value_label'])
+        new_e['value'] = BinParserElement.get_value(uint8_array, e['offset'], e['size'], e['type'], e['endianness'], e['value_label'])
       end
-      e
+      new_e
     }
-  end
+    end
 end
 
 class BinParserElement

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: binp
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - mikoto2000
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-21 00:00:00.000000000 Z
+date: 2023-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: formatador
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
@@ -100,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: binary file parser.