procon_bypass_man 0.1.7 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59fe04b1f616674f3f4a500fbc0abf1dce166482b2e7c880e94d0247a7162877
-  data.tar.gz: 55217706d204a06777fb9c9bfe87a64113dc2bdcfd0efa1079e79afc266690ce
+  metadata.gz: ead44cd36352dba5f4bd97af9c99936657a1a896fb9793a6735ce730a045b6f1
+  data.tar.gz: b8d115ef493d0b58a064fc7a0a7348a66e9e331e8173edd7543d96e9e213daba
 SHA512:
-  metadata.gz: 1c57e7ca180ec142258a4725197e928cf073358743c8e98a78cbd87c4419b05f47859d97428f86dabcaee68f7856596a697a9f211b1f928efd3bb88b9a840c2a
-  data.tar.gz: fa60bd01934dc80f811bd8871ba256c2cc70fb6cc6cbaa33fd180922fdde5bc70476234d00ce28303acb37229cace8137de540e29483af9d7dce926cd7e75fc6
+  metadata.gz: 3229e5e9f0fef53072b4869af2c6469b55703804d12bd8a9d077fe7c413d2198f747d482b30134daa4da55a0c5309eeda45d9928e46cd7778391ed865720ca00
+  data.tar.gz: 2de07a44334162b54ca8ba2464286c12a7a21d6ef74cb36b39a97bd5e22a833a5a6a5af2dac5ba6382da99a8635cdd9bd196a98d7f63dac311a4e61c2387ecad

data/.circleci/config.yml

@@ -32,15 +32,16 @@ jobs:
       - run: bundle install --jobs 4
       - run: bundle exec rubocop
       - run: bundle exec rspec
+      - run: bundle exec steep check
 
 build_jobs: &build_jobs
   - rspec:
       matrix:
         parameters:
           version:
-            - "2.5"
             - "2.7"
-            - "3.0"
+            - "3.0.1"
+            - "3.0.2"
 workflows:
   version: 2
   build:

data/.github/workflows/ruby.yml

@@ -0,0 +1,34 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  [push]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.7', '3.0.1']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: |-
+        bundle exec rake
+        bundle exec steep check

data/.gitignore

@@ -8,3 +8,7 @@
 /tmp/
 vendor
 todo.local.md
+*.log
+.setting_yaml_digest
+pbm_pid
+setting.yml

data/.rubocop.yml

@@ -22,3 +22,5 @@ Lint/UselessAssignment:
     Enabled: false
 Lint/EmptyBlock:
     Enabled: false
+Lint/ReturnInVoidContext:
+    Enabled: false

data/.ruby-version

@@ -1 +1 @@
-3.0.1
+3.0.2

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+## [0.1.11] - 2021-11-05
+- PBM-WEB(>= 0.1.3)でボタンの入力を見るためのスレッドが動くようになりました
+
+## [0.1.10] - 2021-10-28
+- ボタンを無効化するdisableを設定できるようになりました
+- pvmenvで生成する初期ファイルにprocon_bypass_man-webを同梱しました
+- PBM自体の設定の構文を変更しました
+
+## [0.1.9] - 2021-10-20
+- 左スティックを傾けた時に設定した最大値内に丸めることができるようになりました
+    - 関連メソッド: set_neutral_position, left_analog_stick_cap
+- 数時間に一度起きる、数秒間入力が通らなくなる問題の改善
+
+## [0.1.8] - 2021-09-19
+- 使える場合、GC.auto_compactを有効にしました
+- 起動ログにuptimeからの経過時間を表示しました
+
 ## [0.1.7] - 2021-09-11
 - Support pbmenv
 

data/Gemfile

@@ -10,3 +10,7 @@ gem "rspec"
 gem "pry"
 gem "timecop"
 gem "rubocop", require: false
+gem "steep", require: false
+gem 'rbs', require: false
+gem "sinatra", require: false
+gem "webrick", require: false

data/Gemfile.lock

@@ -1,23 +1,47 @@
 PATH
   remote: .
   specs:
-    procon_bypass_man (0.1.7)
+    procon_bypass_man (0.1.11)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (6.1.4.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     ast (2.4.2)
     coderay (1.1.3)
+    concurrent-ruby (1.1.9)
     diff-lcs (1.4.4)
+    ffi (1.15.4)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    language_server-protocol (3.16.0.3)
+    listen (3.7.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
     method_source (1.0.0)
+    minitest (5.14.4)
+    mustermann (1.1.1)
+      ruby2_keywords (~> 0.0.1)
     parallel (1.20.1)
     parser (3.0.2.0)
       ast (~> 2.4.1)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
+    rack (2.2.3)
+    rack-protection (2.1.0)
+      rack
     rainbow (3.0.0)
     rake (13.0.6)
+    rb-fsevent (0.11.0)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rbs (1.6.2)
     regexp_parser (2.1.1)
     rexml (3.2.5)
     rspec (3.10.0)
@@ -45,21 +69,49 @@ GEM
     rubocop-ast (1.11.0)
       parser (>= 3.0.1.1)
     ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    sinatra (2.1.0)
+      mustermann (~> 1.0)
+      rack (~> 2.2)
+      rack-protection (= 2.1.0)
+      tilt (~> 2.0)
+    steep (0.46.0)
+      activesupport (>= 5.1)
+      language_server-protocol (>= 3.15, < 4.0)
+      listen (~> 3.0)
+      parallel (>= 1.0.0)
+      parser (>= 3.0)
+      rainbow (>= 2.2.2, < 4.0)
+      rbs (>= 1.2.0)
+      terminal-table (>= 2, < 4)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    tilt (2.0.10)
     timecop (0.9.4)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (2.0.0)
+    webrick (1.7.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   arm-linux
   arm64-darwin-20
+  arm64-darwin-21
   armv7l-linux
+  x86_64-linux
 
 DEPENDENCIES
   procon_bypass_man!
   pry
   rake (~> 13.0)
+  rbs
   rspec
   rubocop
+  sinatra
+  steep
   timecop
+  webrick
 
 BUNDLED WITH
-   2.2.15
+   2.2.22

data/README.md

@@ -1,4 +1,6 @@
 # ProconBypassMan
+[![Ruby](https://github.com/splaplapla/procon_bypass_man/actions/workflows/ruby.yml/badge.svg?branch=master)](https://github.com/splaplapla/procon_bypass_man/actions/workflows/ruby.yml)
+
 * Switchに繋いだプロコンを連射機にしたり、キーのリマップをしたり、マクロを実行できるツールです
     * 設定ファイルはrubyスクリプトで記述します
 * 特定のタイトルに特化した振る舞いにしたい時は各プラグインを使ってください
@@ -57,21 +59,24 @@ Switch <-- (PBM): ZR連打
 * 設定ファイル マクロの引数に、ボタンを取れるようにする
 
 ## 開発系
-```ruby
-ProconBypassMan.tap do |pbm|
-  pbm.root = File.expand_path(__dir__)
-  pbm.logger = Logger.new("#{ProconBypassMan.root}/app.log", 5, 1024 * 1024 * 10)
-  pbm.logger.level = :debug
-end
-```
+* pbmenvで生成するapp.rbに開発用ブランチを参照してください
 
 ### プロコンとの接続を維持したまま、現在の設定ファイルをPBMに反映する
 ```shell
 sudo kill -USR2 `cat ./pbm_pid`
 ```
 
+### 起動ログをサーバに送信する
+* `ProconBypassMan.api_server = "http://.."` を設定すると、 `POST /api/reports` に対して起動ログを送信するようになります
+
+### 開発環境でログの送信を確認する方法
+* `bundle exec bin/dev_api_server.rb`
+* `INTERNAL_API_SERVER=http://localhost:4567 bin/console`
+  * `message = ProconBypassMan::BootMessage.new; ProconBypassMan::Reporter.report(body: message.to_hash)"`
+
 ### リリース手順
-* project_template/app.rb, lib/procon_bypass_man/version.rb のバージョンをあげる
+* project_template/web.rb, project_template/app.rb, lib/procon_bypass_man/version.rb のバージョンをあげる
+* CHANGELOG.md に日付を書く
 * be rake release
 
 ## License

data/Rakefile

@@ -1,4 +1,13 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
-task default: %i[]
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/Steepfile

@@ -0,0 +1,39 @@
+# D = Steep::Diagnostic
+#
+# target :lib do
+#   signature "sig"
+#
+#   check "lib"                       # Directory name
+#   check "Gemfile"                   # File name
+#   check "app/models/**/*.rb"        # Glob
+#   # ignore "lib/templates/*.rb"
+#
+#   # library "pathname", "set"       # Standard libraries
+#   # library "strong_json"           # Gems
+#
+#   # configure_code_diagnostics(D::Ruby.strict)       # `strict` diagnostics setting
+#   # configure_code_diagnostics(D::Ruby.lenient)      # `lenient` diagnostics setting
+#   # configure_code_diagnostics do |hash|             # You can setup everything yourself
+#   #   hash[D::Ruby::NoMethod] = :information
+#   # end
+# end
+
+# target :test do
+#   signature "sig", "sig-private"
+#
+#   check "test"
+#
+#   # library "pathname", "set"       # Standard libraries
+# end
+
+target :lib do
+  check "lib/procon_bypass_man/timer.rb"
+  check "lib/procon_bypass_man/uptime.rb"
+  check "lib/procon_bypass_man/configuration.rb"
+
+  signature "sig"
+
+  library "time"
+  library "logger"
+  library "monitor"
+end

data/bin/console

@@ -3,6 +3,7 @@
 
 require "bundler/setup"
 require "procon_bypass_man"
+require "pry"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -12,4 +13,7 @@ require "procon_bypass_man"
 # Pry.start
 
 require "irb"
+
+ProconBypassMan.config.logger = Logger.new($stdout)
+
 IRB.start(__FILE__)

data/bin/dev_api_server.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+require "sinatra"
+require "webrick"
+require "pry"
+
+post '/api/reports' do
+  puts JSON.parse(request.body.read)
+  status 200
+  body ''
+end
+
+post '/api/pressed_buttons' do
+  r = JSON.parse(request.body.read)
+  puts r
+  status 200
+  body ''
+end

data/docs/setup_raspi.mitamae.rb

@@ -41,5 +41,20 @@ execute "Initialize PBM" do
  SHELL
 end
 
-run_command 'systemctl disable triggerhappy'
-run_command 'systemctl disable bluetooth'
+# rbenv
+execute "Install rbenv" do
+  not_if "which rbenv"
+  command "git clone https://github.com/rbenv/ruby-build.git "$(rbenv root)"/plugins/ruby-build"
+end
+
+# ruby
+execute "Install ruby" do
+  not_if "rbenv versions | grep 3.0.1"
+  command "rbenv install 3.0.1"
+end
+
+run_command 'sudo systemctl disable triggerhappy.socket'
+run_command 'sudo systemctl disable triggerhappy.service'
+run_command 'sudo systemctl disable bluetooth'
+run_command 'sudo systemctl disable apt-daily-upgrade.timer'
+run_command 'sudo systemctl disable apt-daily.timer'

data/docs/setup_raspi_by_mitamae.md

@@ -10,4 +10,5 @@
 * sudo sh /usr/share/pbm/shared/add_procon_gadget.sh の実行に成功させる
 * /etc/rc.local に sh /usr/share/pbm/shared/add_procon_gadget.sh って書く
 * PCとRaspberry Pi4を接続し、プロコンとして認識していることを確認する
-* TOOD install pbmenv
+* sudo gem i pbmenv
+* sudo pbmenv install latest

data/lib/procon_bypass_man/background/report_thread.rb

@@ -0,0 +1,42 @@
+module ProconBypassMan
+  module Background
+    class Reporter
+      MAX_QUEUE_SIZE = 100
+
+      def self.start!
+        new.start!
+      end
+
+      def start!
+        return if defined?(@@thread)
+        @@latest_request_result = { stats: true, timestamp: Time.now }
+        @@queue = Queue.new
+        @@thread = Thread.new do
+          while(item = @@queue.pop)
+            begin
+              result = item[:reporter_class].report(body: item[:data])
+              @@latest_request_result = { stats: result.stats, timestamp: Time.now }
+              sleep(1)
+            rescue => e
+              ProconBypassMan.logger.error(e)
+            end
+          end
+        end
+      end
+
+      def self.queue
+        raise "Do not start this thread yet" unless defined?(@@queue)
+        @@queue
+      end
+
+      def self.push(hash)
+        if queue.size > MAX_QUEUE_SIZE
+          ProconBypassMan.logger.error('Over queue size cap!!')
+          return
+        end
+
+        queue.push(hash)
+      end
+    end
+  end
+end

data/lib/procon_bypass_man/boot_message.rb

@@ -0,0 +1,40 @@
+class ProconBypassMan::BootMessage
+  def initialize
+    @table = {}
+    @table[:ruby_version] = RUBY_VERSION
+    @table[:pbm_version] = ProconBypassMan::VERSION
+    @table[:pid] = $$
+    @table[:root_path] = ProconBypassMan.root
+    @table[:pid_path] = ProconBypassMan.pid_path
+    @table[:setting_path] = ProconBypassMan::ButtonsSettingConfiguration.instance.setting_path
+    @table[:uptime_from_boot] = ProconBypassMan::Uptime.from_boot
+
+    build_version = `git rev-parse --short HEAD`.chomp
+    if build_version.empty?
+      @table[:build_version] = 'release version'
+    else
+      @table[:build_version] = build_version
+    end
+  end
+
+  # @return [String]
+  def to_s
+    booted_message = <<~EOF
+      ----
+      RUBY_VERSION: #{@table[:ruby_version]}
+      ProconBypassMan: #{@table[:pbm_version]}
+      pid: #{@table[:pid]}
+      root: #{@table[:root_path]}
+      pid_path: #{@table[:pid_path]}
+      setting_path: #{@table[:setting_path]}
+      uptime from boot: #{@table[:uptime_from_boot]} sec
+      build version: #{@table[:build_version]}
+      ----
+    EOF
+  end
+
+  # @return [Hash]
+  def to_hash
+    @table
+  end
+end

data/lib/procon_bypass_man/buttons_setting_configuration.rb

@@ -0,0 +1,102 @@
+require "procon_bypass_man/configuration/validator"
+require "procon_bypass_man/configuration/loader"
+require "procon_bypass_man/configuration/layer"
+
+module ProconBypassMan
+  class AnalogStickPosition < Struct.new(:x, :y); end
+
+  class ButtonsSettingConfiguration
+    attr_accessor :layers,
+      :setting_path,
+      :mode_plugins,
+      :macro_plugins,
+      :context,
+      :current_context_key,
+      :neutral_position
+
+    def self.instance
+      @@current_context_key ||= :main
+      @@context ||= {}
+      @@context[@@current_context_key] ||= new
+    end
+
+    def self.switch_new_context(key)
+      @@context[key] = new
+      previous_key = @@current_context_key
+      if block_given?
+        @@current_context_key = key
+        value = yield(@@context[key])
+        @@current_context_key = previous_key
+        return value
+      else
+        @@current_context_key = key
+      end
+    end
+
+    def initialize
+      reset!
+    end
+
+    module ManualMode
+      def self.name
+        'manual'
+      end
+    end
+    MODES = [:manual]
+    def layer(direction, mode: ManualMode, &block)
+      mode_name = case mode
+                  when String
+                    mode.to_sym
+                  when Symbol
+                    mode
+                  else
+                    mode.name.to_sym
+                  end
+      unless (MODES + ProconBypassMan::Procon::ModeRegistry.plugins.keys).include?(mode_name)
+        raise("#{mode_name} mode is unknown")
+      end
+
+      layer = Layer.new(mode: mode_name)
+      layer.instance_eval(&block) if block_given?
+      self.layers[direction] = layer
+      self
+    end
+
+    def install_mode_plugin(klass)
+      ProconBypassMan::Procon::ModeRegistry.install_plugin(klass)
+      self
+    end
+
+    def install_macro_plugin(klass)
+      ProconBypassMan::Procon::MacroRegistry.install_plugin(klass)
+      self
+    end
+
+    def prefix_keys_for_changing_layer(buttons)
+      @prefix_keys_for_changing_layer = buttons
+      self
+    end
+
+    def set_neutral_position(x, y)
+      self.neutral_position = AnalogStickPosition.new(x, y)
+      self
+    end
+
+    def prefix_keys
+      @prefix_keys_for_changing_layer
+    end
+
+    def reset!
+      @prefix_keys_for_changing_layer = []
+      self.mode_plugins = {}
+      self.macro_plugins = {}
+      self.layers = {
+        up: Layer.new,
+        down: Layer.new,
+        left: Layer.new,
+        right: Layer.new,
+      }
+      @neutral_position = AnalogStickPosition.new(2124, 1808)
+    end
+  end
+end

data/lib/procon_bypass_man/bypass/usb_hid_logger.rb

@@ -0,0 +1,27 @@
+class ProconBypassMan::Bypass
+  module UsbHidLogger
+    extend ProconBypassMan::Callbacks::ClassMethods
+    include ProconBypassMan::Callbacks
+
+    define_callbacks :send_gadget_to_procon
+    define_callbacks :send_procon_to_gadget
+
+    set_callback :send_gadget_to_procon, :after, :log_send_gadget_to_procon
+    set_callback :send_procon_to_gadget, :after, :log_procon_to_gadget
+
+    def log_send_gadget_to_procon
+      ProconBypassMan.logger.debug { ">>> #{bypass_status.to_text}" }
+    end
+
+    def log_procon_to_gadget
+      ProconBypassMan.logger.debug { "<<< #{bypass_status.to_text}" }
+
+      ProconBypassMan.cache.fetch key: 'reporter', expires_in: 5 do
+        ProconBypassMan::Background::Reporter.push({
+          data: ProconBypassMan::ReadonlyProcon.new(binary: bypass_status.binary).to_hash,
+          reporter_class: ProconBypassMan::PressedButtonsReporter
+        })
+      end
+    end
+  end
+end