procon_bypass_man 0.1.6 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21149148015d5d8194ba9b0dc35fc1699ba1fe4eff6aaf1dd0956e0b35856e14
-  data.tar.gz: 6af893ef0a8ff0fdad56b53d9bd117f6cbd39ec7bdb5c216d44cf2d773b9974f
+  metadata.gz: 1a0674ff73c1ac25e311e304e7a3736e3feadb9f8d1221453202abbce8e00372
+  data.tar.gz: 29e63c8ee818a1ca3fe62de9152779cdbea38167db19824e0f402145dec36c04
 SHA512:
-  metadata.gz: 7185d5bf2246b3c1e2ae00eb08e170db017e78b7ed43fecde3757f2fc99bf1132f01b4e541ba669b9fc2ef39ee17e035368eabe7d4b973728c8ae49fd2873a0a
-  data.tar.gz: 6c3152904d3f4af9e3e3e4f519d4fbe3391cf7d727c3ee42966d9492672bb9ead227ce451e8b97088d8b5e27176e9427939009ff59873fac507cbdabeb7fa61a
+  metadata.gz: 2bbbce43d9ed8495f513b5cbd9688f0187f3fd64cdd932730c3938ba8d5e43d4c8e3b15118082742bb1692d95aa66537ccc501930cd778144d7639460d98c32e
+  data.tar.gz: 2a2276871754b37296e2dff2c4b0d3f1cc3822ecb4b5c55e61c2eba4996951072af69e990742463fa282cf57a5f956439a70304402cc4a208be8cd1a43309bb1

data/.circleci/config.yml

@@ -2,22 +2,47 @@ version: 2.1
 orbs:
   ruby: circleci/ruby@0.1.2 
 
-jobs:
-  build:
+executors:
+  ruby:
+    parameters:
+      tag:
+        type: string
+        default: "latest"
     docker:
-      - image: circleci/ruby:3.0.1
-    executor: ruby/default
+      - image: ruby:<< parameters.tag >>
+    environment:
+      BUNDLE_PATH: vendor/bundle
+      BUNDLE_JOBS: 4
+    working_directory: ~/app
+
+jobs:
+  rspec:
+    parameters:
+      version:
+        type: string
+    executor:
+      name: ruby
+      tag: << parameters.version >>
     steps:
       - checkout
-      - run:
-          name: install bundler
-          command: gem install bundler:2.2.20
-      - run:
-          name: bundle install
-          command: bundle install --jobs 4
-      - run:
-          name: rubocop
-          command: bundle exec rubocop
-      - run:
-          name: run test
-          command: bundle exec rspec
+      - run: ruby --version
+      - run: bundle --version
+      - run: gem --version
+      - run: gem install bundler
+      - 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.7"
+            - "3.0.1"
+            - "3.0.2"
+workflows:
+  version: 2
+  build:
+    jobs: *build_jobs

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.10] - 202
+- ボタンを無効化する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
+
 ## [0.1.6] - 2021-08-19
 - 設定ファイルを読み込むと内容のmd5を `pbm_root_dir/.setting_yaml_digest` へ出力するようにしました
 

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.6)
+    procon_bypass_man (0.1.10)
 
 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.3)
+    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)
@@ -33,33 +57,60 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
-    rubocop (1.18.4)
+    rubocop (1.20.0)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.8.0, < 2.0)
+      rubocop-ast (>= 1.9.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.8.0)
+    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
   armv7l-linux
+  x86_64-linux
 
 DEPENDENCIES
   procon_bypass_man!
   pry
   rake (~> 13.0)
+  rbs
   rspec
   rubocop
+  sinatra
+  steep
   timecop
+  webrick
 
 BUNDLED WITH
-   2.2.20
+   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スクリプトで記述します
 * 特定のタイトルに特化した振る舞いにしたい時は各プラグインを使ってください
@@ -17,11 +19,11 @@ Switch <-- (PBM): ZR連打
 * Switch本体とドック
 * Raspberry Pi4 Model B/4GB(Raspberry Pi OS (32-bit))
     * 他のシリーズは未確認です
+        * zeroは非対応
 * データ通信が可能なUSBケーブル
 
 ## 使うソフトウェア
-* 必須
-  * ruby-3.0.x
+* ruby-3.0.x
 
 ## Usage
 * USBガジェットモードで起動するRaspberry Pi4を用意する
@@ -52,25 +54,31 @@ Switch <-- (PBM): ZR連打
     * 操作するdeviceファイルの所有者がrootだから
 
 ## TODO
-* ラズパイのプロビジョニングを楽にしたい
 * レコーディング機能(プロコンの入力をマクロとして登録ができる)
 * マクロにdelayを入れれるようにする
 * 設定ファイル マクロの引数に、ボタンを取れるようにする
 
 ## 開発系
-```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/report_receive_server.rb`
+* `bin/console`
+  * `ProconBypassMan.api_server = "http://localhost:4567"`
+  * `message = ProconBypassMan::BootMessage.new; ProconBypassMan::Reporter.report(body: message.to_hash)"`
+
+### リリース手順
+* project_template/web.rb, project_template/app.rb, lib/procon_bypass_man/version.rb のバージョンをあげる
+* be rake release
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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/report_receive_server.rb

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

data/docs/setup_raspi.md

@@ -13,7 +13,7 @@
       * /etc/dphys-swapfile を CONF_SWAPSIZE=1024 にする
       * sudo /etc/init.d/dphys-swapfile restart && swapon -s
   * tailscale をインストールする(optional)
-  * sudo apt-get install vim rbenv
+  * sudo apt-get install vim rbenv git -y
   * rbenvでrubyを入れる
       * git clone https://github.com/rbenv/ruby-build.git "$(rbenv root)"/plugins/ruby-build
       * rbenv install 3.0.1
@@ -22,20 +22,25 @@
 * sshkeyを作成する
 * github に鍵を登録する
 * ~/.ssh/authorized_keys に鍵を登録する
-* sudo pip3 install fluent-logger pytz
 * ガジェットモードで起動する
   * /boot/config.txtに、dtoverlay=dwc2を追記
-　* echo "dwc2" | sudo tee -a /etc/modules
-　* echo "libcomposite" | sudo tee -a /etc/modules
-　* sudo cat /etc/modules
+  * echo "dwc2" | sudo tee -a /etc/modules
+  * echo "libcomposite" | sudo tee -a /etc/modules
+  * sudo cat /etc/modules
   * cd ~ && wget https://gist.githubusercontent.com/jiikko/3f9fb3194c0cc7685e31fbfcb5b5f9ff/raw/23ddee29d94350be80b79d290ac3c8ce8400bd88/add_procon_gadget.sh
   * chmod 755 ~/add_procon_gadget.sh
   * sudo reboot
   * sudo sh ~/add_procon_gadget.sh の実行に成功させる
   *  /etc/rc.local に sh /home/pi/add_procon_gadget.sh って書く
-* cd ~ && mkdir -p src && cd ~/src && git clone https://github.com/jiikko/procon_bypass_man_sample && cd procon_bypass_man && sudo bundle install
+* cd ~ && mkdir -p src && cd ~/src && git clone https://github.com/jiikko/procon_bypass_man_sample && cd procon_bypass_man_sample
 
-おわり. 起動する時は都度sudo ruby app.rb を実行する
+おわり. 起動する時は都度 sudo ruby app.rb を実行する
 
 ## 参考
 * https://mtosak-tech.hatenablog.jp/entry/2020/08/22/114622
+
+# TIPS
+* SDカードにイメージを焼くときは、ImagerのAdvanced Optionsを使うとセットアップが楽になる
+* raspios_liteにした方が起動が早くなりそう
+    * https://qiita.com/Liesegang/items/dcdc669f80d1bf721c21
+    * http://ftp.jaist.ac.jp/pub/raspberrypi/raspios_lite_armhf

data/docs/setup_raspi.mitamae.rb

@@ -0,0 +1,60 @@
+run_command "apt-get update"
+
+package 'ruby' do
+  action :install
+end
+
+package 'vim' do
+  action :install
+end
+
+package 'git' do
+  action :install
+end
+
+gem_package 'bundler' do
+  action :install
+end
+
+# OTG
+execute "append dtoverlay=dwc2 to /boot/config.txt" do
+  not_if "grep dtoverlay=dwc2 /boot/config.txt"
+  command "echo 'dtoverlay=dwc2' >> /boot/config.txt"
+end
+
+execute "append dwc2 to /etc/modules" do
+  not_if "grep dwc2 /etc/modules"
+  command "echo dwc2 >> /etc/modules"
+end
+
+execute "append libcomposite to /etc/modules" do
+  not_if "grep libcomposite /etc/modules"
+  command "echo libcomposite >> /etc/modules"
+end
+
+# PBM
+execute "Initialize PBM" do
+  command <<~SHELL
+    sudo mkdir -p /usr/share/pbm/shared
+    wget https://gist.githubusercontent.com/jiikko/3f9fb3194c0cc7685e31fbfcb5b5f9ff/raw/23ddee29d94350be80b79d290ac3c8ce8400bd88/add_procon_gadget.sh -O /usr/share/pbm/shared/add_procon_gadget.sh
+    chmod +x /usr/share/pbm/shared/add_procon_gadget.sh
+ SHELL
+end
+
+# 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

@@ -0,0 +1,14 @@
+# Raspberry Pi4のセットアップ手順 With mitamae
+* SDカードにRaspberry Pi OS lite (32-bit)を焼く
+    * sshをできる状態で焼いておく
+* SDカードをRaspberry Pi4本体に挿して起動する
+* sshする
+* curl -L https://github.com/itamae-kitchen/mitamae/releases/latest/download/mitamae-armhf-linux.tar.gz | tar xvz
+* wget https://raw.githubusercontent.com/splaplapla/procon_bypass_man/master/docs/setup_raspi.mitamae.rb -O setup_raspi.mitamae.rb
+* sudo ./mitamae-armhf-linux local setup_raspi.mitamae.rb -l debug
+* sudo reboot
+* 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を接続し、プロコンとして認識していることを確認する
+* sudo gem i pbmenv
+* sudo pbmenv install latest

data/lib/procon_bypass_man/analog_stick_position.rb

@@ -0,0 +1,8 @@
+class AnalogStickPosition
+  attr_accessor :x, :y
+
+  def initialize(x: , y: )
+    @x = x
+    @y = y
+  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,100 @@
+require "procon_bypass_man/configuration/validator"
+require "procon_bypass_man/configuration/loader"
+require "procon_bypass_man/configuration/layer"
+
+module ProconBypassMan
+  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: x, y: 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(x: 2124, y: 1808)
+    end
+  end
+end