moonraker-bosun 0.1.0

data/lib/moonraker/bosun/messages.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Moonraker
+  module Bosun
+    # 表示するメッセージ(日本語と英語)
+    #
+    # 言語は、CLIの実行中だけスレッドごとに設定する(テストを並列に実行するため)。
+    # 設定していないときは英語になる。
+    module Messages
+      DEFAULT_LOCALE = :en
+      # POSIXと同じく、この順に見て最初に設定されているものを使う
+      LOCALE_VARIABLES = %w[LC_ALL LC_MESSAGES LANG].freeze
+      THREAD_KEY = :moonraker_bosun_locale
+      PLACEHOLDER = /%\{(\w+)\}/
+
+      module_function
+
+      def locale_from_env(env)
+        value = LOCALE_VARIABLES.map { |name| env[name] }.find { |v| v && !v.empty? }
+        value&.start_with?("ja") ? :ja : DEFAULT_LOCALE
+      end
+
+      # Thread#[]はファイバーごとの値になるので、スレッドの中で共有するthread_variableを使う
+      def locale = Thread.current.thread_variable_get(THREAD_KEY) || DEFAULT_LOCALE
+
+      def with_locale(locale)
+        previous = Thread.current.thread_variable_get(THREAD_KEY)
+        Thread.current.thread_variable_set(THREAD_KEY, locale)
+        yield
+      ensure
+        Thread.current.thread_variable_set(THREAD_KEY, previous)
+      end
+
+      # %{name}をparamsの値で置き換える
+      def t(key, **params)
+        CATALOG.fetch(key).fetch(locale).gsub(PLACEHOLDER) { params.fetch(Regexp.last_match(1).to_sym).to_s }
+      end
+    end
+  end
+end
+
+require_relative "messages/catalog"

data/lib/moonraker/bosun/push_plan.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module Moonraker
+  module Bosun
+    # pushでホストに反映する内容と、反映できない理由を決める
+    #
+    # docs/design.md の「push」を参照。
+    class PushPlan
+      include Messages
+
+      # kindは:createか:update。pathはRoot configからのパス
+      # hostは計画を立てたときのホストのファイルの情報(作成の場合はnil)
+      Action = Data.define(:path, :kind, :blob, :host)
+      Problem = Data.define(:path, :reason, :guide)
+      # 反映しないファイル(stateはSyncStatus::STATESのキー)
+      Skipped = Data.define(:path, :state)
+
+      # ホストには通常のファイルしか作れないので、これ以外のモード(シンボリックリンク、実行可能ファイル、
+      # submoduleなど)は反映しない。host-trackingにはホストの内容を通常のファイルとして記録するため、
+      # 反映するとマージでモードが衝突する
+      REGULAR_FILE_MODE = "100644"
+
+      # 反映の対象にしないが、知らせる状態
+      NOTICE_STATES = %i[host_modified local_deleted host_modified_local_deleted
+                         host_deleted both_deleted host_read_only].freeze
+
+      attr_reader :actions, :problems, :skipped
+
+      def initialize(status)
+        @status = status
+        raise Error, unmerged_message if status.unmerged?
+
+        @actions = []
+        @problems = []
+        @skipped = []
+        status.entries.each { |entry| plan(entry) }
+      end
+
+      def ok? = @problems.empty?
+
+      private
+
+      def plan(entry)
+        tracked = @status.tracked_blob(entry.path)
+        local = @status.local_blob(entry.path)
+        # ローカルにあり、最後に取得した内容と違うファイルが対象
+        if local && local != tracked
+          mode = @status.local_mode(entry.path)
+          return problem(entry.path, :not_regular_file, mode: mode) unless mode == REGULAR_FILE_MODE
+
+          tracked ? plan_update(entry.path, local, tracked) : plan_create(entry.path, local)
+        elsif NOTICE_STATES.include?(entry.state)
+          @skipped << Skipped.new(path: entry.path, state: entry.state)
+        end
+      end
+
+      def plan_update(path, local, tracked)
+        host = @status.host_info(path)
+        if host.nil?
+          problem(path, :host_deleted)
+        elsif !host.writable?
+          problem(path, :not_writable)
+        elsif @status.host_blob(path) != tracked
+          # 最後に取得した後にホストで変更された内容を、上書きしないようにする
+          problem(path, :host_modified, :pull)
+        else
+          @actions << Action.new(path: path, kind: :update, blob: local, host: host)
+        end
+      end
+
+      def plan_create(path, local)
+        if @status.host_info(path)
+          problem(path, :exists)
+        elsif FileRules.host_backup?(path)
+          problem(path, :backup_name)
+        else
+          @actions << Action.new(path: path, kind: :create, blob: local, host: nil)
+        end
+      end
+
+      # 理由は plan.<reason>、案内は plan.<guide>_guide(省略時は理由と同じ名前)
+      def problem(path, reason, guide = reason, **params)
+        @problems << Problem.new(path: path, reason: t(:"plan.#{reason}", **params), guide: t(:"plan.#{guide}_guide"))
+      end
+
+      def unmerged_message = t(:"plan.unmerged", branch: HostTracking::BRANCH)
+    end
+  end
+end

data/lib/moonraker/bosun/sync_status.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+module Moonraker
+  module Bosun
+    # ホスト(H)、host-trackingの先頭(T)、HEAD(L)の3つを比べて、ファイルごとの状態を判定する
+    #
+    # docs/design.md の「状態の判定」を参照。
+    class SyncStatus
+      # 表示する順に並べる。見出しと案内はMessagesの state.<状態>.label と state.<状態>.guide
+      STATES = %i[host_modified local_modified both_modified host_deleted both_deleted host_read_only
+                  local_deleted host_modified_local_deleted local_added added_on_both untracked synced].freeze
+
+      def self.label(state) = Messages.t(:"state.#{state}.label")
+
+      # 解消するための手順の案内(同期済みにはない)
+      def self.guide(state)
+        return nil if state == :synced
+
+        Messages.t(:"state.#{state}.guide", branch: HostTracking::BRANCH, dir: HostTracking::CONFIG_DIR)
+      end
+
+      # pathはRoot configからのパス
+      Entry = Data.define(:path, :state)
+      # ホストで名前を変更した可能性があるファイルの組
+      Rename = Data.define(:from, :to)
+
+      attr_reader :entries, :renames
+
+      # strict: trueなら、トラッキング中のファイルをすべて取得して内容を比べる
+      def initialize(git:, client:, tracking:, strict: false)
+        @git = git
+        @client = client
+        @tracking = tracking
+        @strict = strict
+        compute
+      end
+
+      def tip = @tracking.tip
+
+      # host-trackingに、まだ現在のブランチに取り込んでいないコミットがあるか
+      def unmerged? = !tip.nil? && !@git.ancestor?(tip, "HEAD")
+
+      def by_state(state) = @entries.select { |entry| entry.state == state }
+
+      # pathはRoot configからのパス
+      def host_info(path) = @host[path]
+      def tracked_blob(path) = @tracked[path]
+      def local_blob(path) = @local[path]
+      def local_mode(path) = @local_modes[path]
+
+      # ホストの内容を取得し、blobのSHA-1を返す
+      def host_blob(path)
+        @git.hash_object(@client.download(FileRules::CONFIG_ROOT, path), write: false)
+      end
+
+      private
+
+      def compute
+        @host = @client.list_files(FileRules::CONFIG_ROOT).to_h { |info| [info.path, info] }
+        @tracked = tip ? tree(tip) : {}
+        @local = tree("HEAD")
+        @local_modes = @git.ls_tree_modes("HEAD", HostTracking::CONFIG_DIR)
+                           .transform_keys { |path| HostTracking.host_path(path) }
+        @recorded = @tracking.recorded
+
+        untracked_candidates = @host.keys.select { |path| FileRules.exclusion(FileRules::CONFIG_ROOT, @host[path]).nil? }
+        paths = (@tracked.keys | @local.keys | untracked_candidates).sort
+        @entries = paths.map { |path| Entry.new(path: path, state: state_of(path)) }
+        @renames = detect_renames
+      end
+
+      def tree(rev)
+        @git.ls_tree(rev, HostTracking::CONFIG_DIR).transform_keys { |path| HostTracking.host_path(path) }
+      end
+
+      def state_of(path)
+        host = @host[path]
+        tracked = @tracked[path]
+        local = @local[path]
+
+        if tracked
+          return local ? :host_deleted : :both_deleted unless host
+          return :host_read_only unless host.writable?
+
+          host_same = host_same?(path, host, tracked)
+          if local.nil?
+            host_same ? :local_deleted : :host_modified_local_deleted
+          elsif local == tracked
+            host_same ? :synced : :host_modified
+          else
+            host_same ? :local_modified : :both_modified
+          end
+        elsif local
+          host ? :added_on_both : :local_added
+        else
+          :untracked
+        end
+      end
+
+      # ホストの内容が、最後に取得した内容(blob)と同じか
+      def host_same?(path, host, blob)
+        unless @strict
+          recorded = @recorded[HostTracking.repo_path(path)]
+          if recorded
+            return true if recorded.modified == host.modified && recorded.size == host.size
+            # サイズが違えば内容も違う
+            return false if recorded.size != host.size
+          end
+        end
+        # 更新日時だけが違う場合などは、取得して内容を比べる
+        host_blob(path) == blob
+      end
+
+      # ホストで削除されたファイルと同じ内容のトラッキングしていないファイルを、名前の変更の候補とする
+      def detect_renames
+        deleted = (by_state(:host_deleted) + by_state(:both_deleted)).map(&:path)
+        untracked = by_state(:untracked).map(&:path)
+        return [] if deleted.empty? || untracked.empty?
+
+        deleted.flat_map do |from|
+          blob = @tracked[from]
+          size = @git.blob_size(blob)
+          untracked.filter_map do |to|
+            Rename.new(from: from, to: to) if @host[to].size == size && host_blob(to) == blob
+          end
+        end
+      end
+    end
+  end
+end

data/lib/moonraker/bosun/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Moonraker
+  module Bosun
+    VERSION = "0.1.0"
+  end
+end

data/lib/moonraker/bosun.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative "bosun/version"
+require_relative "bosun/error"
+require_relative "bosun/messages"
+require_relative "bosun/config"
+require_relative "bosun/client"
+require_relative "bosun/file_rules"
+require_relative "bosun/git"
+require_relative "bosun/host_tracking"
+require_relative "bosun/sync_status"
+require_relative "bosun/push_plan"
+require_relative "bosun/context"
+require_relative "bosun/commands/base"
+require_relative "bosun/commands/roots"
+require_relative "bosun/commands/ls"
+require_relative "bosun/commands/get"
+require_relative "bosun/commands/fetching"
+require_relative "bosun/commands/add"
+require_relative "bosun/commands/pull"
+require_relative "bosun/commands/status_report"
+require_relative "bosun/commands/status"
+require_relative "bosun/commands/audit"
+require_relative "bosun/commands/diff"
+require_relative "bosun/commands/push"
+require_relative "bosun/commands/removing"
+require_relative "bosun/commands/forget"
+require_relative "bosun/commands/rm"
+require_relative "bosun/commands/backup"
+require_relative "bosun/commands/export"
+require_relative "bosun/cli"

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: moonraker-bosun
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- akira yamada
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: bosun fetches configuration files and Moonraker database contents from
+  a Klipper host through the Moonraker API, records them in a dedicated git branch,
+  and pushes local changes back to the host after checking that nothing has changed
+  there.
+email:
+- akira@arika.org
+executables:
+- bosun
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.ja.md
+- README.md
+- docs/design.md
+- docs/moonraker-api.md
+- exe/bosun
+- lib/moonraker/bosun.rb
+- lib/moonraker/bosun/cli.rb
+- lib/moonraker/bosun/client.rb
+- lib/moonraker/bosun/commands/add.rb
+- lib/moonraker/bosun/commands/audit.rb
+- lib/moonraker/bosun/commands/backup.rb
+- lib/moonraker/bosun/commands/base.rb
+- lib/moonraker/bosun/commands/diff.rb
+- lib/moonraker/bosun/commands/export.rb
+- lib/moonraker/bosun/commands/fetching.rb
+- lib/moonraker/bosun/commands/forget.rb
+- lib/moonraker/bosun/commands/get.rb
+- lib/moonraker/bosun/commands/ls.rb
+- lib/moonraker/bosun/commands/pull.rb
+- lib/moonraker/bosun/commands/push.rb
+- lib/moonraker/bosun/commands/removing.rb
+- lib/moonraker/bosun/commands/rm.rb
+- lib/moonraker/bosun/commands/roots.rb
+- lib/moonraker/bosun/commands/status.rb
+- lib/moonraker/bosun/commands/status_report.rb
+- lib/moonraker/bosun/config.rb
+- lib/moonraker/bosun/context.rb
+- lib/moonraker/bosun/error.rb
+- lib/moonraker/bosun/file_rules.rb
+- lib/moonraker/bosun/git.rb
+- lib/moonraker/bosun/host_tracking.rb
+- lib/moonraker/bosun/messages.rb
+- lib/moonraker/bosun/messages/catalog.rb
+- lib/moonraker/bosun/push_plan.rb
+- lib/moonraker/bosun/sync_status.rb
+- lib/moonraker/bosun/version.rb
+homepage: https://github.com/arika/moonraker-bosun
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  source_code_uri: https://github.com/arika/moonraker-bosun
+  changelog_uri: https://github.com/arika/moonraker-bosun/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.20
+specification_version: 4
+summary: Track Klipper configuration files on a Moonraker host with git
+test_files: []