xremap 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2cafc501b56ad37f11da37510eb2b448e70e42ccb448241636ffb03941e3f8fa
+  data.tar.gz: ff8bce82246844c4d47cdb4299bda9900e74b9f1014913af131d524091e525ed
+SHA512:
+  metadata.gz: 4bdb21df26dfaba5aba608d0e077a2e160fe4bebfbd8502a825d06f0dd8bf64f192a763718dd33d5734ba65491d084c4f4f835eeda02ed3c4f9a3d8c2374cbf5
+  data.tar.gz: ed0499f4c0ed070bbfa186252be078eb563461c3cf992f019f7bbe26b331f0899442f236f476b8c89b72d15091a8e7c8edba61d289b6cd91dda1d46c47fb02b3

data/.github/workflows/main.yml

@@ -0,0 +1,16 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.2
+        bundler-cache: true
+    - name: Run the default task
+      run: bundle exec rake

data/.gitignore

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

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+## 0.1.0
+
+- Initial release
+  - Support `remap` and `window` like xremap 0.0.3

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in xremap.gemspec
+gemspec
+
+gem "rake", "~> 13.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Takashi Kokubun
+
+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,22 @@
+# xremap-ruby
+
+Generate an xremap config with a Ruby DSL.
+
+## Installation
+
+```bash
+$ gem install xremap
+```
+
+This will install `xremap-ruby` command.
+
+## Usage
+
+```bash
+$ xremap-ruby example/config.rb > config.yml
+$ sudo xremap config.yml
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "xremap"
+
+# 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(__FILE__)

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/example/config.rb

@@ -0,0 +1,29 @@
+# emacs-like bindings
+remap 'C-b', to: 'Left'
+remap 'C-f', to: 'Right'
+remap 'C-p', to: 'Up'
+remap 'C-n', to: 'Down'
+
+window class_not: %w[slack google-chrome gnome-terminal-server urxvt Focus-Proxy-Window] do
+  remap 'M-b', to: 'Ctrl-Left'
+  remap 'M-f', to: 'Ctrl-Right'
+
+  remap 'C-a', to: 'Alt-C-a'
+  remap 'C-e', to: 'Alt-C-e'
+
+  remap 'C-k', to: 'Alt-C-k'
+
+  remap 'C-d', to: 'Delete'
+  remap 'M-d', to: 'Ctrl-Delete'
+
+  remap 'C-w', to: ['Ctrl-Shift-Left', 'Delete']
+end
+
+window class_only: %w[google-chrome slack] do
+  remap 'M-b', to: 'Ctrl-Left'
+  remap 'M-f', to: 'Ctrl-Right'
+
+  remap 'C-a', to: 'Home'
+  remap 'C-e', to: 'End'
+  remap 'C-k', to: ['Shift-End', 'Delete']
+end

data/exe/xremap-ruby

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.expand_path('../lib', __dir__)
+require 'xremap'
+
+if ARGV.size != 1
+  abort "Usage: #{$0} config.rb"
+end
+
+source = File.read(ARGV.first)
+dsl = Xremap::DSL.new
+dsl.instance_eval(source)
+puts Xremap.generate(dsl)

data/lib/xremap/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Xremap
+  VERSION = '0.1.0'
+end

data/lib/xremap.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+require 'json'
+require 'yaml'
+require_relative 'xremap/version'
+
+module Xremap
+  def self.generate(dsl)
+    config = { keymap: [] }
+
+    # Using instance_variable_get to avoid making an attr_reader a DSL
+    dsl.instance_variable_get(:@keymap).each do |keymap|
+      unless keymap.remap.empty?
+        entry = {
+          name: 'xremap-ruby',
+          remap: keymap.remap,
+        }
+        if keymap.application
+          entry[:application] = {
+            not: keymap.application.not,
+            only: keymap.application.only,
+          }.compact
+        end
+        config.fetch(:keymap) << entry
+      end
+    end
+
+    config = JSON.parse(config.to_json) # stringify keys
+    config.to_yaml
+  end
+
+  class DSL
+    def initialize
+      @keymap = []
+      @keymap << Keymap.new(remap: {})
+    end
+
+    def remap(from, to:)
+      @keymap.last.remap[from] = to
+    end
+
+    def window(class_not: nil, class_only: nil, &block)
+      @keymap << Keymap.new(
+        remap: {},
+        application: Application.new(
+          not: class_not,
+          only: class_only,
+        ),
+      )
+      block.call
+      @keymap << Keymap.new(remap: {})
+    end
+  end
+
+  Keymap = Struct.new(:application, :remap, keyword_init: true)
+  Application = Struct.new(:not, :only, keyword_init: true)
+end

data/xremap.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative 'lib/xremap/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'xremap'
+  spec.version       = Xremap::VERSION
+  spec.authors       = ['Takashi Kokubun']
+  spec.email         = ['takashikkbn@gmail.com']
+
+  spec.summary       = 'Generate xremap config from Ruby'
+  spec.description   = 'Generate xremap config from Ruby'
+  spec.homepage      = 'https://github.com/xremap/xremap-ruby'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 2.5.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency 'example-gem', '~> 1.0'
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: xremap
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Takashi Kokubun
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-12-22 00:00:00.000000000 Z
+dependencies: []
+description: Generate xremap config from Ruby
+email:
+- takashikkbn@gmail.com
+executables:
+- xremap-ruby
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- example/config.rb
+- exe/xremap-ruby
+- lib/xremap.rb
+- lib/xremap/version.rb
+- xremap.gemspec
+homepage: https://github.com/xremap/xremap-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/xremap/xremap-ruby
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: Generate xremap config from Ruby
+test_files: []