fusuma-plugin-wmctrl 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 206927fb10327c6ab0d7f07eeb06f01a29d7e41606a1531d6502cf84442a3d38
-  data.tar.gz: be3df8f773fb4967ef9cc7a89adb36a2b1da12605ec76c9c25c3b36f39daa96b
+  metadata.gz: db960729f5b2efaf7a2836fbd09ca5ec52669cdf2e864c528cc97cac5f3d5992
+  data.tar.gz: ac6168d7203212c274fb646af071d3fc50ec7dcc9cf4f87b7431f4cd95a62ab5
 SHA512:
-  metadata.gz: d295420ce0a75f51d1ced4057a067773f99b1a7c2fbb94f1fe222f2f315c13a00e41103ce50c0f17ce5ef1a0092672837ad762e7306c0e22c9bf8ee461c2c8f4
-  data.tar.gz: d89d25b3270a470bff127e435d8e95caa3f1a4da462db098ef3b1634ba2ed9ac2faf3c722c0dec6190c556cb7c492110a9306a3b9807e0532a8ae7c756f87031
+  metadata.gz: 987c7d1241da28ce082ab83e3af20856ba2fa135f280a6780a17c195fb486dc60b2fe97839d033c618e54bb851f69e3fd35377e6af95812f779c3cb136102c6e
+  data.tar.gz: 1fa805963357ef94051a4264449cf6e294e4b080a0449cc465b289438e2cc67ec57a0a4ca788bfa1953a931672d7d2c41029796a9a9e46751e3fc395207ce4c9

data/README.md

@@ -1,4 +1,4 @@
-# Fusuma::Plugin::Wmctrl [![Gem Version](https://badge.fury.io/rb/fusuma-plugin-wmctrl.svg)](https://badge.fury.io/rb/fusuma-plugin-wmctrl) [![Build Status](https://travis-ci.com/iberianpig/fusuma-plugin-wmctrl.svg?branch=master)](https://travis-ci.com/iberianpig/fusuma-plugin-wmctrl)
+# Fusuma::Plugin::Remap [![Gem Version](https://badge.fury.io/rb/fusuma-plugin-wmctrl.svg)](https://badge.fury.io/rb/fusuma-plugin-wmctrl) [![Build Status](https://github.com/iberianpig/fusuma-plugin-wmctrl/actions/workflows/main.yml/badge.svg)](https://github.com/iberianpig/fusuma-plugin-wmctrl/actions/workflows/main.yml)
 
 
 Window Manager plugin for [Fusuma](https://github.com/iberianpig/fusuma)

data/exe/fusuma-wmctrl

@@ -0,0 +1,93 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'optparse'
+require_relative '../lib/fusuma/plugin/wmctrl/window.rb'
+require_relative '../lib/fusuma/plugin/wmctrl/workspace.rb'
+require_relative '../lib/fusuma/plugin/wmctrl/version.rb'
+
+option = {}
+opt = OptionParser.new
+
+opt.on('--wrap-navigation',
+       'circular navigation between workspaces') do |v|
+  option[:wrap_navigation] = v
+end
+
+opt.on('--matrix-col-size=3',
+       'For grid-style workspace, move up, down, left or right.'
+      ) do |v|
+  option[:matrix_col_size] = v.to_i
+end
+
+opt.on('--workspace=prev|next|up|down|left|right',
+       'move workspace') do |v|
+  option[:workspace] = v
+end
+
+opt.on('--window=prev|next|up|down|left|right',
+       'move window') do |v|
+  option[:window] = v
+end
+
+opt.on('--version', 'Show version') do |v|
+  option[:version] = v
+end
+
+opt.parse!(ARGV)
+
+if option[:workspace]
+  workspace = Fusuma::Plugin::Wmctrl::Workspace.new(
+    wrap_navigation: option[:wrap_navigation], matrix_col_size: option[:matrix_col_size]
+  )
+
+  command = case property = option[:workspace]
+  when 'prev', 'next'
+    workspace.move_command(direction: property)
+  when 'left', 'right', 'up', 'down'
+    workspace.move_command_for_matrix(direction: property)
+  else
+    raise "#{property} is invalid key"
+  end
+  `#{command}`
+
+  return
+end
+
+if option[:window]
+  workspace = Fusuma::Plugin::Wmctrl::Workspace.new(
+    wrap_navigation: option[:wrap_navigation], matrix_col_size: option[:matrix_col_size]
+  )
+  window = Fusuma::Plugin::Wmctrl::Window.new
+
+  command = case property = option[:window]
+            when 'prev', 'next'
+              workspace.move_window_command(direction: property)
+            when 'left', 'right', 'up', 'down'
+              workspace.move_window_command_for_matrix(direction: property)
+            when 'maximized'
+              window.maximized(method: 'toggle')
+            when 'close'
+              window.close
+            when 'fullscreen'
+              window.fullscreen(method: 'toggle')
+            else
+              raise "#{property} is invalid key"
+            end
+
+  `#{command}`
+
+  return
+end
+
+if option[:version]
+  puts Fusuma::Plugin::Wmctrl::VERSION
+  return
+end
+
+param = ARGV.first
+
+if param.nil?
+  warn 'fusuma-wmctrl require aruguments'
+  exit 1
+end

data/fusuma-plugin-wmctrl.gemspec

@@ -24,5 +24,5 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.5.1' # https://packages.ubuntu.com/search?keywords=ruby&searchon=names&exact=1&suite=all&section=main
   # support bionic (18.04LTS) 2.5.1
-  spec.add_dependency 'fusuma', '~> 2.0'
+  spec.add_dependency 'fusuma', '>= 2.0'
 end

data/lib/fusuma/plugin/executors/wmctrl_executor.rb

@@ -23,11 +23,11 @@ module Fusuma
 
         def initialize
           super()
-          @workspace = Workspace.new(
+          @workspace = Wmctrl::Workspace.new(
             wrap_navigation: config_params(:'wrap-navigation'),
             matrix_col_size: config_params(:'matrix-col-size')
           )
-          @window = Window.new
+          @window = Wmctrl::Window.new
         end
 
         # execute wmctrl command

data/lib/fusuma/plugin/wmctrl/version.rb

@@ -3,7 +3,7 @@
 module Fusuma
   module Plugin
     module Wmctrl
-      VERSION = '1.0.1'
+      VERSION = '1.2.0'
     end
   end
 end

data/lib/fusuma/plugin/wmctrl/window.rb

@@ -1,18 +1,24 @@
 # frozen_string_literal: true
 
-# Manage Window
-class Window
-  # @param method [String] "toggle" or "add" or "remove"
-  def maximized(method:)
-    "wmctrl -r :ACTIVE: -b #{method},maximized_vert,maximized_horz"
-  end
+module Fusuma
+  module Plugin
+    module Wmctrl
+      # Manage Window
+      class Window
+        # @param method [String] "toggle" or "add" or "remove"
+        def maximized(method:)
+          "wmctrl -r :ACTIVE: -b #{method},maximized_vert,maximized_horz"
+        end
 
-  def close
-    'wmctrl -c :ACTIVE:'
-  end
+        def close
+          'wmctrl -c :ACTIVE:'
+        end
 
-  # @param method [String] "toggle" or "add" or "remove"
-  def fullscreen(method:)
-    "wmctrl -r :ACTIVE: -b #{method},fullscreen"
+        # @param method [String] "toggle" or "add" or "remove"
+        def fullscreen(method:)
+          "wmctrl -r :ACTIVE: -b #{method},fullscreen"
+        end
+      end
+    end
   end
 end

data/lib/fusuma/plugin/wmctrl/workspace.rb

@@ -1,153 +1,160 @@
 # frozen_string_literal: true
 
-# Manage workspace
-class Workspace
-  class InvalidOption < StandardError; end
-
-  def initialize(wrap_navigation: nil, matrix_col_size: nil)
-    @wrap_navigation = wrap_navigation
-    @matrix_col_size = matrix_col_size
-  end
-
-  # get next workspace number
-  # @return [Integer]
-  def next_workspace_num(step:)
-    current_workspace_num, total_workspace_num = workspace_values
-
-    next_workspace_num = current_workspace_num + step
-
-    return next_workspace_num unless @wrap_navigation
-
-    if next_workspace_num.negative?
-      next_workspace_num = total_workspace_num - 1
-    elsif next_workspace_num >= total_workspace_num
-      next_workspace_num = 0
-    else
-      next_workspace_num
-    end
-    next_workspace_num
-  end
-
-  # @return [Array<Integer>]
-  def matrix_size(total_workspace_num)
-    must_have_matrix_option!
-    col_size = @matrix_col_size
-    row_size = (total_workspace_num / col_size)
-    [row_size.to_i, col_size.to_i]
-  end
-
-  def must_have_matrix_option!
-    return if @matrix_col_size
-
-    warn(<<~ERRRORMESSAGE)
-      Please set matrix-col-size to config.yml
-
-      ```config.yaml
-      plugin:
-        executors:
-          wmctrl_executor:
-            matrix-col-size: 2
-      ```
-    ERRRORMESSAGE
-    raise InvalidOption, 'You need to set matrix option to config.yml'
-  end
-
-  # @return [Integer]
-  # @raise RuntimeError
-  def next_workspace_num_for_matrix(direction:)
-    must_have_matrix_option!
-    current_workspace_num, total_workspace_num = workspace_values
-    row_size, col_size = matrix_size(total_workspace_num)
-    x = current_workspace_num % col_size
-    y = current_workspace_num / col_size
-    case direction
-    when 'right'
-      if x < col_size - 1
-        current_workspace_num + 1
-      elsif @wrap_navigation
-        current_workspace_num - (col_size - 1)
-      else
-        current_workspace_num
-      end
-    when 'left'
-      if x.positive?
-        current_workspace_num - 1
-      elsif @wrap_navigation
-        current_workspace_num + (col_size - 1)
-      else
-        current_workspace_num
+module Fusuma
+  module Plugin
+    module Wmctrl
+      # Manage workspace
+      class Workspace
+        class MissingMatrixOption < StandardError; end
+
+        def initialize(wrap_navigation: nil, matrix_col_size: nil)
+          @wrap_navigation = wrap_navigation
+          @matrix_col_size = matrix_col_size
+        end
+
+        # get next workspace number
+        # @return [Integer]
+        def next_workspace_num(step:)
+          current_workspace_num, total_workspace_num = workspace_values
+
+          next_workspace_num = current_workspace_num + step
+
+          return next_workspace_num unless @wrap_navigation
+
+          if next_workspace_num.negative?
+            next_workspace_num = total_workspace_num - 1
+          elsif next_workspace_num >= total_workspace_num
+            next_workspace_num = 0
+          else
+            next_workspace_num
+          end
+          next_workspace_num
+        end
+
+        # @return [Array<Integer>]
+        def matrix_size(total_workspace_num)
+          must_have_matrix_option!
+          col_size = @matrix_col_size
+          row_size = (total_workspace_num / col_size)
+          [row_size.to_i, col_size.to_i]
+        end
+
+        def must_have_matrix_option!
+          return if @matrix_col_size
+
+          # FIXME: move to executor
+          warn(<<~ERRRORMESSAGE)
+            Please set matrix-col-size to config.yml
+
+            ```config.yaml
+            plugin:
+              executors:
+                wmctrl_executor:
+                  matrix-col-size: 2
+            ```
+          ERRRORMESSAGE
+          raise MissingMatrixOption, 'You need to set matrix option to config.yml'
+        end
+
+        # @return [Integer]
+        # @raise RuntimeError
+        def next_workspace_num_for_matrix(direction:)
+          must_have_matrix_option!
+          current_workspace_num, total_workspace_num = workspace_values
+          row_size, col_size = matrix_size(total_workspace_num)
+          x = current_workspace_num % col_size
+          y = current_workspace_num / col_size
+          case direction
+          when 'right'
+            if x < col_size - 1
+              current_workspace_num + 1
+            elsif @wrap_navigation
+              current_workspace_num - (col_size - 1)
+            else
+              current_workspace_num
+            end
+          when 'left'
+            if x.positive?
+              current_workspace_num - 1
+            elsif @wrap_navigation
+              current_workspace_num + (col_size - 1)
+            else
+              current_workspace_num
+            end
+          when 'down'
+            if y < row_size - 1
+              current_workspace_num + col_size
+            elsif @wrap_navigation
+              (current_workspace_num + col_size) - total_workspace_num
+            else
+              current_workspace_num
+            end
+          when 'up'
+            if y.positive?
+              current_workspace_num - col_size
+            elsif @wrap_navigation
+              total_workspace_num + (current_workspace_num - col_size)
+            else
+              current_workspace_num
+            end
+          else
+            raise "#{direction} is invalid key"
+          end
+        end
+
+        def move_command(direction:)
+          workspace_num = case direction
+                          when 'next'
+                            next_workspace_num(step: 1)
+                          when 'prev'
+                            next_workspace_num(step: -1)
+                          else
+                            raise "#{direction} is invalid key"
+                          end
+          "wmctrl -s #{workspace_num}"
+        end
+
+        def move_command_for_matrix(direction:)
+          workspace_num = next_workspace_num_for_matrix(direction: direction)
+          "wmctrl -s #{workspace_num}"
+        end
+
+        def move_window_command(direction:)
+          workspace_num = case direction
+                          when 'next'
+                            next_workspace_num(step: 1)
+                          when 'prev'
+                            next_workspace_num(step: -1)
+                          else
+                            raise "#{direction} is invalid key"
+                          end
+          "wmctrl -r :ACTIVE: -t #{workspace_num} ; wmctrl -s #{workspace_num}"
+        end
+
+        def move_window_command_for_matrix(direction:)
+          workspace_num = next_workspace_num_for_matrix(direction: direction)
+          "wmctrl -r :ACTIVE: -t #{workspace_num} ; wmctrl -s #{workspace_num}"
+        end
+
+        private
+
+        # get current workspace and total workspace numbers
+        # @return [Integer, Integer]
+        def workspace_values
+          wmctrl_output = `wmctrl -d`.split("\n")
+
+          current_line = wmctrl_output.grep(/\*/).first
+          # NOTE: stderror when failed to get desktop
+          # `Cannot get current desktop properties. \
+          # (_NET_CURRENT_DESKTOP or _WIN_WORKSPACE property)`
+          return [0, 1] if current_line.nil?
+
+          current_workspace_num = current_line.chars.first.to_i
+          total_workspace_num = wmctrl_output.length
+
+          [current_workspace_num, total_workspace_num]
+        end
       end
-    when 'down'
-      if y < row_size - 1
-        current_workspace_num + col_size
-      elsif @wrap_navigation
-        (current_workspace_num + col_size) - total_workspace_num
-      else
-        current_workspace_num
-      end
-    when 'up'
-      if y.positive?
-        current_workspace_num - col_size
-      elsif @wrap_navigation
-        total_workspace_num + (current_workspace_num - col_size)
-      else
-        current_workspace_num
-      end
-    else
-      raise "#{direction} is invalid key"
     end
   end
-
-  def move_command(direction:)
-    workspace_num = case direction
-                    when 'next'
-                      next_workspace_num(step: 1)
-                    when 'prev'
-                      next_workspace_num(step: -1)
-                    else
-                      raise "#{direction} is invalid key"
-                    end
-    "wmctrl -s #{workspace_num}"
-  end
-
-  def move_command_for_matrix(direction:)
-    workspace_num = next_workspace_num_for_matrix(direction: direction)
-    "wmctrl -s #{workspace_num}"
-  end
-
-  def move_window_command(direction:)
-    workspace_num = case direction
-                    when 'next'
-                      next_workspace_num(step: 1)
-                    when 'prev'
-                      next_workspace_num(step: -1)
-                    else
-                      raise "#{direction} is invalid key"
-                    end
-    "wmctrl -r :ACTIVE: -t #{workspace_num} ; wmctrl -s #{workspace_num}"
-  end
-
-  def move_window_command_for_matrix(direction:)
-    workspace_num = next_workspace_num_for_matrix(direction: direction)
-    "wmctrl -r :ACTIVE: -t #{workspace_num} ; wmctrl -s #{workspace_num}"
-  end
-
-  private
-
-  # get current workspace and total workspace numbers
-  # @return [Integer, Integer]
-  def workspace_values
-    wmctrl_output = `wmctrl -d`.split("\n")
-
-    current_line = wmctrl_output.grep(/\*/).first
-    # NOTE: stderror when failed to get desktop
-    # `Cannot get current desktop properties. \
-    # (_NET_CURRENT_DESKTOP or _WIN_WORKSPACE property)`
-    return [0, 1] if current_line.nil?
-
-    current_workspace_num = current_line.chars.first.to_i
-    total_workspace_num = wmctrl_output.length
-
-    [current_workspace_num, total_workspace_num]
-  end
 end

data/spec/fusuma/plugin/plugin/executors/wmctrl_executor_spec.rb

@@ -13,8 +13,8 @@ module Fusuma
     module Executors
       RSpec.describe WmctrlExecutor do
         before do
-          @workspace = double(Workspace)
-          allow(Workspace)
+          @workspace = double(Wmctrl::Workspace)
+          allow(Wmctrl::Workspace)
             .to receive(:new)
             .and_return(@workspace)
 
@@ -317,7 +317,7 @@ module Fusuma
             end
 
             it 'should wrap-navigation mode' do
-              expect(Workspace).to receive(:new).with(
+              expect(Wmctrl::Workspace).to receive(:new).with(
                 wrap_navigation: true,
                 matrix_col_size: nil
               )

data/spec/fusuma/plugin/plugin/wmctrl/workspace_spec.rb

@@ -135,7 +135,7 @@ module Fusuma
             it 'raises InvalidOption' do
               expect do
                 @workspace.next_workspace_num_for_matrix(direction: 'prev')
-              end.to raise_error(Workspace::InvalidOption)
+              end.to raise_error(Wmctrl::Workspace::MissingMatrixOption)
             end
           end
 
@@ -227,7 +227,7 @@ module Fusuma
               @workspace = Workspace.new(matrix_col_size: nil)
               stub_workspace_values(current: 1, total: 3)
             end
-            it { expect { @workspace.matrix_size(3) }.to raise_error Workspace::InvalidOption }
+            it { expect { @workspace.matrix_size(3) }.to raise_error Workspace::MissingMatrixOption }
           end
         end
       end

metadata

@@ -1,33 +1,34 @@
 --- !ruby/object:Gem::Specification
 name: fusuma-plugin-wmctrl
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - iberianpig
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-03 00:00:00.000000000 Z
+date: 2023-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fusuma
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
 description: fusuma-plugin-wmctrl is Fusuma plugin for window manager.
 email:
 - yhkyky@gmail.com
-executables: []
+executables:
+- fusuma-wmctrl
 extensions: []
 extra_rdoc_files: []
 files:
@@ -35,6 +36,7 @@ files:
 - README.md
 - bin/console
 - bin/setup
+- exe/fusuma-wmctrl
 - fusuma-plugin-wmctrl.gemspec
 - lib/fusuma/plugin/executors/wmctrl_executor.rb
 - lib/fusuma/plugin/wmctrl.rb
@@ -65,13 +67,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: Wmctrl plugin for Fusuma
 test_files:
-- spec/fusuma/plugin/plugin/wmctrl/workspace_spec.rb
 - spec/fusuma/plugin/plugin/executors/wmctrl_executor_spec.rb
+- spec/fusuma/plugin/plugin/wmctrl/workspace_spec.rb
 - spec/fusuma/plugin/wmctrl_spec.rb
 - spec/helpers/config_helper.rb
 - spec/spec_helper.rb