fusuma-plugin-keypress 0.4.0.pre → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf01d5bb0635029913f1c7fa172d65f6bd7ebaa184bf2c7bf7a374e6c58edec6
-  data.tar.gz: 6aa537cc3c9717d1ad0f913ada4487f20d44915892b1517c5f1c9aeb61571867
+  metadata.gz: 958f90d65b6a5bfe120a5462bbfc1d21e01dbdf95d97f279e824a6ad6aafa5a3
+  data.tar.gz: 6d8c96cb5be6b003f00c0d20bc6bf68af693857e82d9ceb87837a1b752678e0f
 SHA512:
-  metadata.gz: 1a2fc9a98ae8f36c88a46dd35caa917a37b6bf059faf9dae7911813dfe837ee55f9e07ffbb5b7ebb2bb656c7c16a1ff3b3cd2743a391d0385c486039508237d5
-  data.tar.gz: 3e52a0c29351c21422e499a3803b32f20416888be23811a606f115cd21e6286e5eb2f7c19bded0fae339d7335e90d72479476495888677430e211485c60ee465
+  metadata.gz: 7be790c59d66696f078c89121f32f9dd61630a0debfe3584899cac8b0ed73d335b2858aca88e7d84b511dcb1cbaf9a0e36ac487300c519f2c5480ac7f16a4040
+  data.tar.gz: 858e05f1aca03e80be587ed315e79717a5c6815336c5b1ef8e1c112603df698be6d3b720853c18f2b200137b8c9eb866907e325032c8727ee6d1ffba368bc07e

data/README.md

@@ -45,6 +45,7 @@ Keys following are available for `keypress`.
 * `RIGHTALT`
 * `RIGHTCTRL`
 * `RIGHTSHIFT`
+* `RIGHTMETA`
 
 ## Example
 

data/fusuma-plugin-keypress.gemspec

@@ -16,14 +16,13 @@ Gem::Specification.new do |spec|
   spec.license       = 'MIT'
 
   # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
+  spec.files          = Dir['{bin,lib,exe}/**/*', 'LICENSE*', 'README*', '*.gemspec']
+  spec.test_files     = Dir['{test,spec,features}/**/*']
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.4' # https://packages.ubuntu.com/search?keywords=ruby&searchon=names&exact=1&suite=all&section=main
-  spec.add_dependency 'fusuma', '~> 2.0.0.pre'
+  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'
 end

data/lib/fusuma/plugin/detectors/keypress_detector.rb

@@ -5,8 +5,14 @@ module Fusuma
     module Detectors
       # Detect KeypressEvent from KeypressBuffer
       class KeypressDetector < Detector
+        SOURCES = ['keypress'].freeze
         BUFFER_TYPE = 'keypress'
 
+        # Always watch buffers and detect them.
+        def watch?
+          true
+        end
+
         # @param buffers [Array<Event>]
         # @return [Event] if event is detected
         # @return [NilClass] if event is NOT detected
@@ -15,9 +21,7 @@ module Fusuma
 
           return if buffer.empty?
 
-          records = buffer.events.select do |e|
-            e.record.status == 'pressed'
-          end.map(&:record)
+          records = buffer.events.select { |e| e.record.status == 'pressed' }.map(&:record)
 
           index_record = Events::Records::IndexRecord.new(
             index: create_index(records: records),

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

@@ -3,7 +3,7 @@
 module Fusuma
   module Plugin
     module Keypress
-      VERSION = '0.4.0.pre'
+      VERSION = '0.4.2'
     end
   end
 end

data/lib/fusuma/plugin/keypress.rb

@@ -3,8 +3,8 @@
 # fusuma will `require fusuma-plugin-xxxx/plugin/xxxx.rb`
 
 require_relative './keypress/version'
-require_relative './events/records/keypress_record.rb'
-require_relative './filters/keypress_filter.rb'
-require_relative './parsers/keypress_parser.rb'
-require_relative './buffers/keypress_buffer.rb'
-require_relative './detectors/keypress_detector.rb'
+require_relative './events/records/keypress_record'
+require_relative './filters/keypress_filter'
+require_relative './parsers/keypress_parser'
+require_relative './buffers/keypress_buffer'
+require_relative './detectors/keypress_detector'

data/lib/fusuma/plugin/parsers/keypress_parser.rb

@@ -7,6 +7,18 @@ module Fusuma
       class KeypressParser < Parser
         DEFAULT_SOURCE = 'libinput_command_input'
 
+        AVAILABLE_KEYS = %w[
+          CAPSLOCK
+          LEFTALT
+          LEFTCTRL
+          LEFTMETA
+          LEFTSHIFT
+          RIGHTALT
+          RIGHTCTRL
+          RIGHTSHIFT
+          RIGHTMETA
+        ].freeze
+
         # @param record [String]
         # @return [Records::Gesture, nil]
         def parse_record(record)
@@ -27,6 +39,8 @@ module Fusuma
             code = matched[2]   # LEFTSHIFT
             status = matched[3] # pressed
 
+            return unless AVAILABLE_KEYS.include?(code)
+
             Events::Records::KeypressRecord.new(status: status, code: code)
           end
         end

data/spec/fusuma/plugin/detectors/keypress_detector_spec.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+require 'fusuma/plugin/detectors/detector'
+require 'fusuma/plugin/buffers/buffer'
+
+require './lib/fusuma/plugin/buffers/keypress_buffer'
+require './lib/fusuma/plugin/detectors/keypress_detector'
+
+module Fusuma
+  module Plugin
+    module Detectors
+      RSpec.describe KeypressDetector do
+        before do
+          @detector = KeypressDetector.new
+          @buffer = Buffers::KeypressBuffer.new
+        end
+
+        describe '#detector' do
+          context 'with no keypress event in buffer' do
+            before do
+              @buffer.clear
+            end
+
+            it { expect(@detector.detect([@buffer])).to eq nil }
+          end
+        end
+
+        context 'with keypress events in buffer' do
+          before do
+            record = Events::Records::KeypressRecord.new(status: 'pressed', code: 'LEFTSHIFT')
+            event = Events::Event.new(tag: 'keypress_parser', record: record)
+
+            @buffer.buffer(event)
+          end
+          it { expect(@detector.detect([@buffer])).to be_a Events::Event }
+          it { expect(@detector.detect([@buffer]).record).to be_a Events::Records::IndexRecord }
+          it { expect(@detector.detect([@buffer]).record.index).to be_a Config::Index }
+
+          it 'should detect LEFTSHIFT' do
+            expect(@detector.detect([@buffer]).record.index.keys.map(&:symbol))
+              .to eq(%i[keypress LEFTSHIFT])
+          end
+        end
+
+        context 'with two different keypress events in buffer' do
+          before do
+            record1 = Events::Records::KeypressRecord.new(status: 'pressed', code: 'LEFTSHIFT')
+            record2 = Events::Records::KeypressRecord.new(status: 'pressed', code: 'LEFTCTRL')
+            event1 = Events::Event.new(tag: 'keypress_parser', record: record1)
+            event2 = Events::Event.new(tag: 'keypress_parser', record: record2)
+
+            @buffer.buffer(event1)
+            @buffer.buffer(event2)
+          end
+
+          it 'should detect LEFTSHIFT+LEFTCTRL' do
+            expect(@detector.detect([@buffer]).record.index.keys.map(&:symbol))
+              .to eq(%i[keypress LEFTSHIFT+LEFTCTRL])
+          end
+        end
+      end
+    end
+  end
+end

data/spec/fusuma/plugin/keypress_spec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Fusuma::Plugin::Keypress do
+  it 'has a version number' do
+    expect(Fusuma::Plugin::Keypress::VERSION).not_to be nil
+  end
+end

data/spec/helpers/config_helper.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'tempfile'
+require 'fusuma/config'
+
+module Fusuma
+  module ConfigHelper
+    module_function
+
+    def load_config_yml=(string)
+      Config.custom_path = Tempfile.open do |temp_file|
+        temp_file.tap { |f| f.write(string) }
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'helpers/config_helper'
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = '.rspec_status'
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  config.include(Fusuma::ConfigHelper)
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fusuma-plugin-keypress
 version: !ruby/object:Gem::Version
-  version: 0.4.0.pre
+  version: 0.4.2
 platform: ruby
 authors:
 - iberianpig
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-09 00:00:00.000000000 Z
+date: 2021-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fusuma
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0.pre
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0.pre
+        version: '2.0'
 description: fusuma-plugin-keypress is Fusuma plugin for keypress combination.
 email:
 - yhkyky@gmail.com
@@ -31,19 +31,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rubocop.yml"
-- ".travis.yml"
-- CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
 - bin/console
 - bin/setup
 - fusuma-plugin-keypress.gemspec
-- lefthook.yml
 - lib/fusuma/plugin/buffers/keypress_buffer.rb
 - lib/fusuma/plugin/detectors/keypress_detector.rb
 - lib/fusuma/plugin/events/records/keypress_record.rb
@@ -51,11 +43,15 @@ files:
 - lib/fusuma/plugin/keypress.rb
 - lib/fusuma/plugin/keypress/version.rb
 - lib/fusuma/plugin/parsers/keypress_parser.rb
+- spec/fusuma/plugin/detectors/keypress_detector_spec.rb
+- spec/fusuma/plugin/keypress_spec.rb
+- spec/helpers/config_helper.rb
+- spec/spec_helper.rb
 homepage: https://github.com/iberianpig/fusuma-plugin-keypress
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -63,15 +59,19 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: 2.5.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.4
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Keypress plugin for Fusuma
-test_files: []
+test_files:
+- spec/fusuma/plugin/detectors/keypress_detector_spec.rb
+- spec/fusuma/plugin/keypress_spec.rb
+- spec/helpers/config_helper.rb
+- spec/spec_helper.rb

data/.gitignore

@@ -1,13 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status
-.ruby-version

data/.rubocop.yml

@@ -1,17 +0,0 @@
-AllCops:
-  TargetRubyVersion: 2.4
-  NewCops: enable
-
-Metrics/ModuleLength:
-  Exclude:
-    - "**/*_spec.rb"
-
-Metrics/BlockLength:
-  Exclude:
-    - "**/*_spec.rb"
-    - "fusuma-plugin-*.gemspec"
-
-Metrics/LineLength:
-  Max: 100
-  Exclude:
-    - "fusuma-plugin-*.gemspec"

data/.travis.yml

@@ -1,10 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.3.1
-  - 2.4
-  - 2.5
-  - 2.6
-before_install: gem install bundler --no-document -v 2.0.1

data/CHANGELOG.md

@@ -1,9 +0,0 @@
-# Change Log
-
-## [v0.1.1](https://github.com/iberianpig/fusuma-plugin-keypress/tree/v0.1.1) (2020-02-18)
-[Full Changelog](https://github.com/iberianpig/fusuma-plugin-keypress/compare/v0.1.0...v0.1.1)
-
-## [v0.1.0](https://github.com/iberianpig/fusuma-plugin-keypress/tree/v0.1.0) (2019-11-12)
-
-
-\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# 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

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in fusuma-plugin-keypress.gemspec
-gemspec
-
-gem 'bundler'
-gem 'github_changelog_generator'
-gem 'lefthook'
-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/Rakefile

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: :spec
-
-require 'github_changelog_generator/task'
-
-GitHubChangelogGenerator::RakeTask.new :changelog do |config|
-  config.user = 'iberianpig'
-  config.project = 'fusuma-plugin-keypress'
-end

data/lefthook.yml

@@ -1,29 +0,0 @@
-# EXAMPLE USAGE
-# Refer for explanation to following link:
-# https://github.com/Arkweid/lefthook/blob/master/docs/full_guide.md
-
-# pre-push:
-#   commands:
-#     packages-audit:
-#       tags: frontend security
-#       run: yarn audit
-#     gems-audit:
-#       tags: backend security
-#       run: bundle audit
-
-pre-commit:
-  parallel: true
-  commands:
-    # eslint:
-    #   glob: "*.{js,ts}"
-    #   run: yarn eslint {staged_files}
-    rubocop:
-      tags: backend style
-      glob: "*.rb"
-      # exclude: "application.rb|routes.rb"
-      run: bundle exec rubocop --force-exclusion {staged_files}
-  # scripts:
-  #   "hello.js":
-  #     runner: node
-  #   "any.go":
-  #     runner: go run