fusuma-plugin-wmctrl 0.1.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 316ce994f0890c7b67dbb07ca8305fcc47c3fa715adc693991d3fe809aa8b808
-  data.tar.gz: 3f77d3c20e4e832adf3f40782cd1cbd9005064159575805d97e5e02193fafb63
+  metadata.gz: f9070f0ff5c01bf9dd2109c2e8c5a7413791fac4048937b3e4dc401c40dbd589
+  data.tar.gz: e232215a854eeb26c815478d8b68b58b89dd45983e534584fc377b2dd2e6fdd5
 SHA512:
-  metadata.gz: '0888f8dfab2a61cd9dcd71b231da45804f6ea93fc8bc2ae03dd4cbd56eac13f7f46f3df0ac1bf311ede6e531f677ca439364175744bb3338478137a99b423811'
-  data.tar.gz: 616aa9662f061ceb728007daccbee5520839d043af29715a635420738d3f5b8a3b39ad68a557ba23966db39c07595059ed2bf09ebc15c0e828426fb9837e7b7b
+  metadata.gz: 3d94aa6dc1afddd886a1e0aa60cb6978a96b1bba6ea34a1a204ecf34f56c26a6ec43cc31fcdec4bc503b31513311c8d208cc898fa8bc7e4b8f727db45c7c1e50
+  data.tar.gz: df7ccf6df129eb2a38e39451270ee3f200532c8cacf1cd3f044ffb2af49878042a8e849ff750c01c2f5b38f5b085cc01726f5cd187a7532507a4e97a8fb494ab

data/.rubocop_todo.yml

@@ -0,0 +1,20 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2020-01-02 00:51:24 +0900 using RuboCop version 0.75.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+Metrics/AbcSize:
+  Max: 17
+
+# Offense count: 1
+Metrics/CyclomaticComplexity:
+  Max: 8
+
+# Offense count: 1
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/MethodLength:
+  Max: 17

data/.travis.yml

@@ -3,5 +3,8 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.4.1
-before_install: gem install bundler -v 2.0.1
+  - 2.3.1
+  - 2.4
+  - 2.5
+  - 2.6
+before_install: gem install bundler --no-document -v 2.0.1

data/CHANGELOG.md

@@ -1,5 +1,33 @@
-# Change Log
+# Changelog
 
+## [v0.4.0.pre](https://github.com/iberianpig/fusuma-plugin-wmctrl/tree/v0.4.0.pre) (2020-11-09)
 
+[Full Changelog](https://github.com/iberianpig/fusuma-plugin-wmctrl/compare/v0.3.0...v0.4.0.pre)
 
-\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
+**Merged pull requests:**
+
+- sudo for gem install? [\#3](https://github.com/iberianpig/fusuma-plugin-wmctrl/pull/3) ([oli-ver](https://github.com/oli-ver))
+
+## [v0.3.0](https://github.com/iberianpig/fusuma-plugin-wmctrl/tree/v0.3.0) (2020-01-03)
+
+[Full Changelog](https://github.com/iberianpig/fusuma-plugin-wmctrl/compare/v0.2.0...v0.3.0)
+
+**Implemented enhancements:**
+
+- Control active window \(Close / Minimize / Maximize\) [\#2](https://github.com/iberianpig/fusuma-plugin-wmctrl/issues/2)
+
+## [v0.2.0](https://github.com/iberianpig/fusuma-plugin-wmctrl/tree/v0.2.0) (2019-11-07)
+
+[Full Changelog](https://github.com/iberianpig/fusuma-plugin-wmctrl/compare/v0.1.0...v0.2.0)
+
+**Implemented enhancements:**
+
+- Move active window to next/prev workspace [\#1](https://github.com/iberianpig/fusuma-plugin-wmctrl/issues/1)
+
+## [v0.1.0](https://github.com/iberianpig/fusuma-plugin-wmctrl/tree/v0.1.0) (2019-10-12)
+
+[Full Changelog](https://github.com/iberianpig/fusuma-plugin-wmctrl/compare/7e20b0138aaa335e4b9008ee9af680e8dad188aa...v0.1.0)
+
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

data/Gemfile

@@ -4,3 +4,14 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in fusuma-plugin-wmctrl.gemspec
 gemspec
+
+gem 'bundler'
+gem 'github_changelog_generator', '~> 1.14'
+gem 'pry-byebug', '~> 3.4'
+gem 'pry-doc'
+gem 'pry-inline'
+gem 'rake', '~> 13.0'
+gem 'reek'
+gem 'rspec', '~> 3.0'
+gem 'rubocop'
+gem 'yard'

data/README.md

@@ -1,31 +1,99 @@
-# Fusuma::Plugin::Wmctrl
+# 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)
+
 
 Window Manager plugin for [Fusuma](https://github.com/iberianpig/fusuma)
 
+* Move window or workspace instead of xdotool
+* Works on Wayland(Not depends on xdotool)
+
 ## Installation
 
 Run the following code in your terminal.
 
-### Install wmctrl
+### 1.Install wmctrl
+
+#### For Debian Based Distros (Ubuntu, Debian, Mint, Pop!_OS)
+
+```
+$ sudo apt install wmctrl -y
+```
+
+#### For Arch Based Distros (Manjaro, Arch)
 
 ```
-$ sudo apt install wmctrl
+sudo pacman -S wmctrl
 ```
-### Install fusuma-plugin-wmctrl
+
+### 2. Install fusuma-plugin-wmctrl
 
 This plugin requires [Fusuma](https://github.com/iberianpig/fusuma#update) version 1.0 or later.
 
+
+**Note For Arch Based Distros:** By default in Arch Linux, when running ```gem```, gems are installed per-user (into ```~/.gem/ruby/```), instead of system-wide (into ```/usr/lib/ruby/gems/```). This is considered the best way to manage gems on Arch, because otherwise they might interfere with gems installed by Pacman. (From Arch Wiki)
+
+To install gems system-wide, see any of the methods listed on [Arch Wiki](https://wiki.archlinux.org/index.php/ruby#Installing_gems_system-wide)
+
 ```sh
-$ gem install fusuma-plugin-wmctrl
+$ sudo gem install fusuma-plugin-wmctrl
 ```
 
 ## Properties
 
+### `workspace:` property
 Add `workspace:` property in `~/.config/fusuma/config.yml`.
 
-Currently, values following are available for `workspace`.
-  * `prev`
-  * `next`
+Values following are available for `workspace`.
+
+  * `prev` is value to switch current workspace to previous workspace.
+  * `next` is value to switch current workspace to next workspace.
+
+### `window:` property
+Add `window:` property in `~/.config/fusuma/config.yml`.
+
+Values following are available for `window`.
+
+  * `prev` is value to move active window to previous workspace.
+  * `next` is value to move active window to next workspace.
+  * `fullscreen` is value to toggle fullscreen
+    * `fullscreen: toggle` toggles the active window to fullscreen.
+      ```yml
+        window: fullscreen
+        # ↑ same ↓
+        window: 
+          fullscreen: toggle
+      ```
+
+    * `fullscreen: add` changes the active window to a fullscreen.
+      ```yml
+        window: 
+          fullscreen: add
+      ``` 
+
+    * `fullscreen: remove` restores the active window from fullscreen.
+      ```yml
+        window: 
+          fullscreen: remove
+      ```
+  * `maximized` is value to toggle maximized
+    * `maximized: toggle` toggles the active window to maximized.
+      ```yml
+        window: maximized
+        # ↑ same ↓
+        window: 
+          maximized: toggle
+      ```
+
+    * `maximized: add` changes the active window to a maximized.
+      ```yml
+        window: 
+          maximized: add
+      ``` 
+
+    * `maximized: remove` restores the active window from maximized.
+      ```yml
+        window: 
+          maximized: remove
+      ```
 
 
 ## Example
@@ -41,6 +109,17 @@ swipe:
       workspace: 'prev'
 ```
 
+## Configuration
+
+The plugin allows to enable (disabled by default) circular navigation between workspaces. To enable it set the following in your config file `~/.config/fusuma/config.yml`.
+
+```yaml
+plugin: 
+  executors:
+    wmctrl_executor:
+      wrap-navigation: true
+```
+
 
 ## Contributing
 

data/fusuma-plugin-wmctrl.gemspec

@@ -25,16 +25,5 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.required_ruby_version = '>= 2.3' # https://packages.ubuntu.com/search?keywords=ruby&searchon=names&exact=1&suite=all&section=main
-  spec.add_dependency 'fusuma', '~> 1.0'
-
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'github_changelog_generator', '~> 1.14'
-  spec.add_development_dependency 'pry-byebug', '~> 3.4'
-  spec.add_development_dependency 'pry-doc'
-  spec.add_development_dependency 'pry-inline'
-  spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'reek'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'yard'
+  spec.add_dependency 'fusuma', '~> 2.0.0'
 end

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

@@ -1,21 +1,38 @@
 # frozen_string_literal: true
 
+require 'posix/spawn'
+require 'singleton'
+
 module Fusuma
   module Plugin
     module Executors
       # Control Window or Workspaces by executing wctrl
       class WmctrlExecutor < Executor
+        # executor properties on config.yml
+        # @return [Array<Symbol>]
+        def execute_keys
+          %i[wmctrl workspace]
+        end
+
+        def config_param_types
+          {
+            'wrap-navigation': [TrueClass, FalseClass]
+          }
+        end
+
+        def initialize
+          super()
+          Workspace.configure(wrap_navigation: config_params(:'wrap-navigation'))
+        end
+
         # execute wmctrl command
         # @param event [Event]
         # @return [nil]
         def execute(event)
           return if search_command(event).nil?
 
-          pid = fork do
-            Process.daemon(true)
-            exec(search_command(event))
-          end
-
+          MultiLogger.info(wmctrl: search_command(event))
+          pid = POSIX::Spawn.spawn(search_command(event))
           Process.detach(pid)
         end
 
@@ -32,34 +49,137 @@ module Fusuma
         # @return [String]
         # @return [NilClass]
         def search_command(event)
+          search_workspace_command(event) || search_window_command(event)
+        end
+
+        private
+
+        # @param event [Event]
+        # @return [String]
+        # @return [NilClass]
+        def search_workspace_command(event)
           index = Config::Index.new([*event.record.index.keys, :workspace])
+
           direction = Config.search(index)
-          return if direction.nil?
+          return unless direction.is_a?(String)
+
+          Workspace.move_command(direction: direction)
+        end
 
-          Workspace.move_workspace_command(direction: direction)
+        # @param event [Event]
+        # @return [String]
+        # @return [NilClass]
+        def search_window_command(event)
+          index = Config::Index.new([*event.record.index.keys, :window])
+
+          case property = Config.search(index)
+          when 'prev', 'next'
+            Window.move_command(direction: property)
+          when 'fullscreen'
+            Window.fullscreen(method: 'toggle')
+          when 'maximized'
+            Window.maximized(method: 'toggle')
+          when 'close'
+            Window.close
+          when Hash
+            if property[:fullscreen]
+              Window.fullscreen(method: property[:fullscreen])
+            elsif property[:maximized]
+              Window.maximized(method: property[:maximized])
+            end
+          end
         end
 
         # Manage workspace
         class Workspace
+          include Singleton
+
+          attr_accessor :wrap_navigation
+
           class << self
-            # get workspace number
+            # configure properties of the workspace switcher
+            # @return [NilClass]
+            def configure(wrap_navigation:)
+              instance.wrap_navigation = wrap_navigation
+            end
+
+            # get next workspace number
             # @return [Integer]
-            def current_workspace_num
-              text = `wmctrl -d`.split("\n").grep(/\*/).first
-              text.chars.first.to_i
+            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 instance.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
+            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
+
+            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
+        end
+
+        # Manage Window
+        class Window
+          class << self
+            # @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
+
+            # @param method [String] "toggle" or "add" or "remove"
+            def fullscreen(method:)
+              "wmctrl -r :ACTIVE: -b #{method},fullscreen"
             end
 
-            def move_workspace_command(direction:)
-              new_workspace_num = case direction
-                                  when 'next'
-                                    current_workspace_num + 1
-                                  when 'prev'
-                                    current_workspace_num - 1
-                                  else
-                                    warn "#{direction} is invalid key"
-                                    exit 1
-                                  end
-              "wmctrl -s #{new_workspace_num}"
+            def move_command(direction:)
+              workspace_num = case direction
+                              when 'next'
+                                Workspace.next_workspace_num(step: 1)
+                              when 'prev'
+                                Workspace.next_workspace_num(step: -1)
+                              else
+                                raise "#{direction} is invalid key"
+                              end
+              "wmctrl -r :ACTIVE: -t #{workspace_num} ; wmctrl -s #{workspace_num}"
             end
           end
         end

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

@@ -3,7 +3,7 @@
 module Fusuma
   module Plugin
     module Wmctrl
-      VERSION = '0.1.0'
+      VERSION = '0.4.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fusuma-plugin-wmctrl
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.0
 platform: ruby
 authors:
 - iberianpig
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-12 00:00:00.000000000 Z
+date: 2021-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fusuma
@@ -16,154 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: github_changelog_generator
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.14'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.14'
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.4'
-- !ruby/object:Gem::Dependency
-  name: pry-doc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry-inline
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: reek
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.0
 description: fusuma-plugin-wmctrl is Fusuma plugin for window manager.
 email:
 - yhkyky@gmail.com
@@ -207,7 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Wmctrl plugin for Fusuma