fusuma-plugin-keypress 0.2.1 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e119f537a5a9039591ab5434fbef52509f91af1531308d1ec6e35663fa42593e
-  data.tar.gz: a65839a395f388f0c3f0772046838f3897efac6f43467f9808e6ee79db543383
+  metadata.gz: 0701111fbc7fb83f15edc252e1cfa67ec636520dcd6a90fa68ec8163a48ad6d5
+  data.tar.gz: aaac5cd36824ecf8f7012406e7bcfeca569f412b299367f0f602ec48d4885a42
 SHA512:
-  metadata.gz: b273ceac36e18505e04acb3c439f8f114b2886a6eba939f2876d5ca5949599347a4b087ff3f72c05f93eb1621a64d8a4902b493993cf848205fdeaffb1b4dbff
-  data.tar.gz: 730630bd6f215507ad26d4c4ee8b6dd10e40dc5ba133a400da35eebf92414751fd398b2a874f9a63ab9df8a0daaa12a45fa7b28eaa341efc3d62ca9f3b93fe12
+  metadata.gz: 6bd4c472b48cfa0bd2b09581a4cf348292b088f9ed66c852ad0d9c6fc4d59f5019bd76be84affd122afda04415b9eaf0800f926e11cf7c3a2e99e113e873edba
+  data.tar.gz: 7bd7157b88e160b5dd6ffb4ec73ade7d40894d20a13e65efda0b11940d3e3366f8847fdf549532d41bcdb829d1db07fde23b0eb1f20b55ff9622fec0a3bb9a19

data/README.md

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

data/fusuma-plugin-keypress.gemspec

@@ -16,25 +16,12 @@ 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.3' # https://packages.ubuntu.com/search?keywords=ruby&searchon=names&exact=1&suite=all&section=main
-  spec.add_dependency 'fusuma', '~> 1.5'
-
-  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.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'
 end

data/lib/fusuma/plugin/buffers/keypress_buffer.rb

@@ -17,7 +17,10 @@ module Fusuma
         def clear_expired(*)
           return if @events.empty?
 
-          @events.clear if released?
+          return unless released?
+
+          released_code = @events.last.record.code
+          @events.delete_if { |e| e.record.code == released_code }
         end
 
         def empty?

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.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/keypress/version.rb

@@ -3,7 +3,7 @@
 module Fusuma
   module Plugin
     module Keypress
-      VERSION = '0.2.1'
+      VERSION = '0.4.1'
     end
   end
 end

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.2.1
+  version: 0.4.1
 platform: ruby
 authors:
 - iberianpig
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-15 00:00:00.000000000 Z
+date: 2021-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fusuma
@@ -16,154 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
-- !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-keypress is Fusuma plugin for keypress combination.
 email:
 - yhkyky@gmail.com
@@ -171,15 +31,8 @@ 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
@@ -190,6 +43,10 @@ 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
@@ -202,15 +59,19 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 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,13 +0,0 @@
-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,6 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in fusuma-plugin-keypress.gemspec
-gemspec

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