fusuma 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 210ffddb66e6e96beba56784fdcba46872b84bd7
+  data.tar.gz: 99a6e185643a0616816176ce49076fcf1afa57db
+SHA512:
+  metadata.gz: 3f799865b93d7b33a7721a63b18103f006f51760cd71aa7a1e3d404bd74d3f764954b3e8bbaa9b39c460280d6c0616f601ad0823bc8bfbeafc619c2e66fd54c2
+  data.tar.gz: 40afda3397ac78ac92914cadf7163356d9828c49d93563209008a2a1afdc2100c9f3da631a51a4bc3698686f4e8680f1b2fffc86315143948f1a04a1270888bb

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at yhkyky@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fusuma.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 iberianpig
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 iberianpig
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,84 @@
+# Fusuma
+
+Fusuma is multitouch gesture recognizer.
+This gem makes your linux PC able to recognize swipes or pinchs and assign shortcuts to them.
+
+[![https://gyazo.com/757fef526310b9d68f68e80eb1e4540f](https://i.gyazo.com/757fef526310b9d68f68e80eb1e4540f.png)](https://gyazo.com/757fef526310b9d68f68e80eb1e4540f)
+
+襖(Fusuma) means sliding door used to partition off rooms in a Japanese house.
+
+## Installation
+
+IMPORTANT: You must be a member of the _input_ group to have permission
+to read the touchpad device:
+
+    $ sudo gpasswd -a $USER input  # Log out and back in to assign this group
+
+You need libinput release 1.0 or later. Install prerequisites:
+
+If you are using pacman (for archlinux).
+
+    $ sudo pacman -S xdotool
+
+If you are using apt (for ubuntu/debian based distributions).
+
+    $ sudo apt-get install xdotool
+
+
+Install Fusuma
+
+    $ gem install fusuma
+
+## Usage
+
+    $ fusuma
+
+## Customize
+
+
+You can customize the settings for gestues to put and edit `~/.config/fusuma/config.yml`.
+
+### Sample (default keymap for Elementary OS)
+
+```yaml
+swipe:
+  3: 
+    left: 
+      shortcut: 'alt+Right'
+    right: 
+      shortcut: 'alt+Left'
+    up: 
+      shortcut: 'ctrl+t'
+    down: 
+      shortcut: 'ctrl+w'
+  4:
+    left: 
+      shortcut: 'super+Right'
+    right: 
+      shortcut: 'super+Left'
+    up: 
+      shortcut: 'super+a'
+    down: 
+      shortcut: 'super+s'
+pinch:
+  in:
+    shortcut: 'ctrl+plus'
+  out:
+     shortcut: 'ctrl+minus'
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/iberianpig/fusuma. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fusuma"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config.yml

@@ -0,0 +1,24 @@
+swipe:
+  3: 
+    left: 
+      shortcut: 'alt+Right'
+    right: 
+      shortcut: 'alt+Left'
+    up: 
+      shortcut: 'ctrl+t'
+    down: 
+      shortcut: 'ctrl+w'
+  4:
+    left: 
+      shortcut: 'super+Right'
+    right: 
+      shortcut: 'super+Left'
+    up: 
+      shortcut: 'super+a'
+    down: 
+      shortcut: 'super+s'
+pinch:
+  in:
+    shortcut: 'ctrl+plus'
+  out:
+     shortcut: 'ctrl+minus'

data/exe/fusuma

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/fusuma'
+
+Fusuma.run

data/fusuma.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fusuma/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fusuma"
+  spec.version       = Fusuma::VERSION
+  spec.authors       = ["iberianpig"]
+  spec.email         = ["yhkyky@gmail.com"]
+
+  spec.summary       = %q{ Multitouch gestures with libinput dirver on X11, Linux }
+  spec.homepage      = "https://github.com/iberianpig/fusuma"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry-byebug"
+end

data/lib/fusuma.rb

@@ -0,0 +1,87 @@
+require_relative 'fusuma/version'
+require_relative 'fusuma/action_stack'
+require_relative 'fusuma/gesture_action'
+require 'logger'
+require 'open3'
+require 'yaml'
+
+# this is top level module
+module Fusuma
+  class << self
+    def run
+      read_libinput
+    end
+
+    private
+
+    def read_libinput
+      Open3.popen3(libinput_command) do |_i, o, _e, _w|
+        o.each do |line|
+          gesture_action = GestureAction.initialize_by_libinput(line, device_name)
+          next if gesture_action.nil?
+          @action_stack ||= ActionStack.new
+          @action_stack.push gesture_action
+          gesture_info = @action_stack.gesture_info
+          trigger_keyevent(gesture_info) unless gesture_info.nil?
+        end
+      end
+    end
+
+    def libinput_command
+      @libinput_command ||= "stdbuf -oL -- libinput-debug-events --device \
+    /dev/input/#{device_name}"
+    end
+
+    def device_name
+      return @device_name unless @device_name.nil?
+      Open3.popen3('libinput-list-devices') do |_i, o, _e, _w|
+        o.each do |line|
+          extracted_input_device_from(line)
+          next unless touch_is_available?(line)
+          return @device_name
+        end
+      end
+    end
+
+    def extracted_input_device_from(line)
+      return unless line =~ /^Kernel: /
+      @device_name = line.match(/event[0-9]/).to_s
+    end
+
+    def touch_is_available?(line)
+      return false unless line =~ /^Tap-to-click: /
+      return false if line =~ %r{n/a}
+      true
+    end
+
+    def trigger_keyevent(gesture_info)
+      case gesture_info.action
+      when 'swipe'
+        swipe(gesture_info.finger, gesture_info.direction.move)
+      when 'pinch'
+        pinch(gesture_info.direction.pinch)
+      end
+    end
+
+    def swipe(finger, direction)
+      shortcut = event_map['swipe'][finger.to_i][direction]['shortcut']
+      `xdotool key #{shortcut}`
+    end
+
+    def pinch(zoom)
+      shortcut = event_map['pinch'][zoom]['shortcut']
+      `xdotool key #{shortcut}`
+    end
+
+    def event_map
+      @event_map ||= YAML.load_file(config_file)
+    end
+
+    def config_file
+      filename = 'fusuma/config.yml'
+      original_path = File.expand_path "~/.config/#{filename}"
+      default_path = File.expand_path "../#{filename}"
+      File.exist?(original_path) ? original_path : default_path
+    end
+  end
+end

data/lib/fusuma/action_stack.rb

@@ -0,0 +1,90 @@
+module Fusuma
+  # manage actions
+  class ActionStack < Array
+    def initialize(*args)
+      super(*args)
+    end
+
+    # return { finger:, direction:, action: } or nil
+    def gesture_info
+      return unless enough_actions?
+      direction = detect_direction
+      finger    = detect_finger
+      action    = detect_action
+      clear
+      GestureInfo.new(finger, direction, action)
+    end
+
+    def push(gesture_action)
+      super(gesture_action)
+      clear if action_end?
+    end
+    alias << push
+
+    private
+
+    GestureInfo = Struct.new(:finger, :direction, :action)
+    Direction = Struct.new(:move, :pinch)
+
+    def detect_direction
+      direction_hash = sum_direction
+      move = detect_move(direction_hash)
+      pinch = detect_pinch(direction_hash)
+      Direction.new(move, pinch)
+    end
+
+    def detect_move(direction_hash)
+      if direction_hash[:move][:x].abs > direction_hash[:move][:y].abs
+        return direction_hash[:move][:x] > 0 ? 'right' : 'left'
+      end
+      direction_hash[:move][:y] > 0 ? 'down' : 'up'
+    end
+
+    def detect_pinch(direction_hash)
+      direction_hash[:pinch] > 1 ? 'in' : 'out'
+    end
+
+    def detect_finger
+      last.finger
+    end
+
+    def sum_direction
+      move_x = sum_attrs(:move_x)
+      move_y = sum_attrs(:move_y)
+      pinch  = mul_attrs(:pinch)
+      { move: { x: move_x, y: move_y }, pinch: pinch }
+    end
+
+    def sum_attrs(attr)
+      send('map') do |gesture_action|
+        gesture_action.send(attr.to_sym.to_s)
+      end.compact.inject(:+)
+    end
+
+    def mul_attrs(attr)
+      send('map') do |gesture_action|
+        num = gesture_action.send(attr.to_sym.to_s)
+        # NOTE: ignore 0.0, treat as 1(immutable)
+        num.zero? ? 1 : num
+      end.compact.inject(:*)
+    end
+
+    def action_end?
+      last_action_name =~ /_END$/
+    end
+
+    def last_action_name
+      return false if last.class != GestureAction
+      last.action
+    end
+
+    def enough_actions?
+      length > 7 # TODO: should be detected by move per time
+    end
+
+    def detect_action
+      first.action =~ /GESTURE_(.*?)_/
+      Regexp.last_match(1).downcase
+    end
+  end
+end

data/lib/fusuma/config.yml

@@ -0,0 +1,24 @@
+swipe:
+  3: 
+    left: 
+      shortcut: 'alt+Right'
+    right: 
+      shortcut: 'alt+Left'
+    up: 
+      shortcut: 'ctrl+t'
+    down: 
+      shortcut: 'ctrl+w'
+  4:
+    left: 
+      shortcut: 'super+Right'
+    right: 
+      shortcut: 'super+Left'
+    up: 
+      shortcut: 'super+a'
+    down: 
+      shortcut: 'super+s'
+pinch:
+  in:
+    shortcut: 'ctrl+plus'
+  out:
+     shortcut: 'ctrl+minus'

data/lib/fusuma/gesture_action.rb

@@ -0,0 +1,56 @@
+module Fusuma
+  # pinch or swipe action
+  class GestureAction
+    def initialize(time, action, finger, directions)
+      @time   = time
+      @action = action
+      @finger = finger
+      @move_x = directions[:move][:x].to_f
+      @move_y = directions[:move][:y].to_f
+      @pinch  = directions[:pinch].to_f
+    end
+    attr_reader :time, :action, :finger,
+                :move_x, :move_y, :pinch
+
+    class << self
+      def initialize_by_libinput(line, device_name)
+        return unless line.to_s =~ /^#{device_name}/
+        return if line.to_s =~ /_BEGIN/
+        return unless line.to_s =~ /GESTURE_SWIPE|GESTURE_PINCH/
+        time, action, finger, directions = gesture_action_arguments(line)
+        logger.debug(line)
+        logger.debug(directions)
+        GestureAction.new(time, action, finger, directions)
+      end
+
+      private
+
+      def gesture_action_arguments(libinput_line)
+        action, time, finger_directions = parse_libinput(libinput_line)
+        finger, move_x, move_y, pinch = parse_finger_directions(finger_directions)
+        directions = { move: { x: move_x, y: move_y }, pinch: pinch }
+        [time, action, finger, directions]
+      end
+
+      def parse_libinput(line)
+        _device, action_time, finger_directions = line.split("\t").map(&:strip)
+        action, time = action_time.split
+        [action, time, finger_directions]
+      end
+
+      def parse_finger_directions(finger_directions_line)
+        finger_num, move_x, move_y, _, _, _, pinch =
+          finger_directions_line.tr('/', ' ').split
+        [finger_num, move_x, move_y, pinch]
+      end
+
+      def logger
+        @logger ||= begin
+                      log = Logger.new(STDOUT)
+                      log.level = Logger::WARN
+                      log
+                    end
+      end
+    end
+  end
+end

data/lib/fusuma/version.rb

@@ -0,0 +1,3 @@
+module Fusuma
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: fusuma
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- iberianpig
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: pry-byebug
+  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'
+description: 
+email:
+- yhkyky@gmail.com
+executables:
+- fusuma
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config.yml
+- exe/fusuma
+- fusuma.gemspec
+- lib/fusuma.rb
+- lib/fusuma/action_stack.rb
+- lib/fusuma/config.yml
+- lib/fusuma/gesture_action.rb
+- lib/fusuma/version.rb
+homepage: https://github.com/iberianpig/fusuma
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Multitouch gestures with libinput dirver on X11, Linux
+test_files: []