rails_omnibar 1.0.0

data/spec/support/factories.rb

@@ -0,0 +1,8 @@
+require 'factory_bot_rails'
+
+FactoryBot.define do
+  factory :user do
+    first_name { 'John' }
+    last_name { 'Doe' }
+  end
+end

data/spec/system/rails_omnibar_spec.rb

@@ -0,0 +1,87 @@
+require 'rails_helper'
+
+describe RailsOmnibar do
+  it 'works' do
+    FactoryBot.create(:user, id: 1, first_name: 'John', last_name: 'Doe')
+    FactoryBot.create(:user, id: 2, first_name: 'Jane', last_name: 'Doe', admin: true)
+    expect(User.pluck(:id).sort).to eq [1, 2] # sanity check
+
+    visit main_app.root_path
+    expect(page).to have_selector '#mount-rails-omnibar' # sanity check
+
+    # test visibility toggling with hotkey
+    expect(page).not_to have_selector 'input'
+
+    send_keys([:control, 'm']) # custom hotkey, c.f. app_template.rb
+    expect(page).to have_selector 'input'
+
+    send_keys([:control, 'm'])
+    expect(page).not_to have_selector 'input'
+
+    send_keys([:meta, 'm']) # meta modifier (⌘) should also be supported
+    expect(page).to have_selector 'input'
+
+    # test fuzzy search for static items
+    type('ou')
+    expect(page).to have_content 'boring URL'
+    expect(page).to have_content 'important URL'
+
+    type('ori')
+    expect(page).to have_content 'boring URL'
+    expect(page).not_to have_content 'important URL'
+
+    # test help modal
+    expect(page).not_to have_content 'Available actions'
+    submit('Help')
+    expect(page).to have_content 'Available actions'
+    send_keys :escape
+    expect(page).not_to have_content 'Available actions'
+
+    # test record search by id
+    type('u1')
+    expect(page).to have_content 'User#1'
+    expect(page).not_to have_content 'User#2'
+
+    type('u2')
+    expect(page).to have_content 'User#2'
+    expect(page).not_to have_content 'User#1'
+
+    # test record search by custom column
+    type('u J') # both usernames start with J
+    expect(page).to have_content 'User#1'
+    expect(page).to have_content 'User#2'
+
+    type('u Jo')
+    expect(page).to have_content 'User#1'
+    expect(page).not_to have_content 'User#2'
+
+    type('u Ja')
+    expect(page).to have_content 'User#2'
+    expect(page).not_to have_content 'User#1'
+
+    # test navigation for item with #url
+    submit
+    expect(page.current_url).to end_with '/users/2'
+    send_keys([:control, 'm']) # make omnibar visible again
+
+    # test generic search
+    type('g foobar')
+    expect(page).to have_content 'fake_result_1'
+    expect(page).to have_content 'fake_result_2'
+    expect(page).to have_content 'fake_result_3'
+
+    # test custom command
+    type('count users')
+    expect(page).to have_content '2'
+  end
+
+  def type(str)
+    find('input').set(str)
+  end
+
+  def submit(str = nil)
+    str.present? && type(str)
+    sleep(0.1) # wait a tiny bit for the omnibar results to appear
+    send_keys(:return)
+  end
+end

data/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "compilerOptions": {
+    "allowSyntheticDefaultImports": true,
+    "downlevelIteration": true,
+    "outDir": "./javascript/",
+    "noImplicitAny": true,
+    "module": "es6",
+    "target": "es5",
+    "jsx": "react-jsx",
+    "jsxImportSource": "preact",
+    "allowJs": true,
+    "moduleResolution": "node",
+    "paths": {
+      "react": ["./node_modules/preact/compat/"],
+      "react-dom": ["./node_modules/preact/compat/"]
+    }
+  },
+}

data/webpack.config.js

@@ -0,0 +1,32 @@
+const path = require('path')
+
+module.exports = {
+  entry: './javascript/src/index.ts',
+  mode: 'production',
+  module: {
+    rules: [
+      {
+        rules: [
+          {
+            test: /\.tsx?$/,
+            use: 'ts-loader',
+            exclude: /node_modules/,
+          },
+        ],
+      }
+    ]
+  },
+  resolve: {
+    extensions: ['.tsx', '.ts', '.js'],
+    alias: {
+      "react": "preact/compat",
+      "react-dom/test-utils": "preact/test-utils",
+      "react-dom": "preact/compat",     // Must be below test-utils
+      "react/jsx-runtime": "preact/jsx-runtime"
+    },
+  },
+  output: {
+    filename: 'compiled.js',
+    path: path.resolve(__dirname, 'javascript'),
+  },
+}

metadata

@@ -0,0 +1,226 @@
+--- !ruby/object:Gem::Specification
+name: rails_omnibar
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Janosch Müller
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: js_regex
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  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: factory_bot_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.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: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+- !ruby/object:Gem::Dependency
+  name: webdrivers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Omnibar for Rails
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/tests.yml"
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/controllers/rails_omnibar/base_controller.rb
+- app/controllers/rails_omnibar/js_controller.rb
+- app/controllers/rails_omnibar/queries_controller.rb
+- bin/console
+- bin/setup
+- config/routes.rb
+- javascript/compiled.js
+- javascript/src/app.tsx
+- javascript/src/hooks/index.ts
+- javascript/src/hooks/use_hotkey.ts
+- javascript/src/hooks/use_item_action.tsx
+- javascript/src/hooks/use_modal.tsx
+- javascript/src/hooks/use_omnibar_extensions.ts
+- javascript/src/hooks/use_toggle_focus.ts
+- javascript/src/index.ts
+- javascript/src/types.ts
+- lib/rails_omnibar.rb
+- lib/rails_omnibar/command/base.rb
+- lib/rails_omnibar/command/search.rb
+- lib/rails_omnibar/commands.rb
+- lib/rails_omnibar/config.rb
+- lib/rails_omnibar/engine.rb
+- lib/rails_omnibar/item/base.rb
+- lib/rails_omnibar/item/help.rb
+- lib/rails_omnibar/items.rb
+- lib/rails_omnibar/rendering.rb
+- lib/rails_omnibar/version.rb
+- package.json
+- rails_omnibar.gemspec
+- spec/app_template.rb
+- spec/lib/rails_omnibar/config_spec.rb
+- spec/lib/rails_omnibar/version_spec.rb
+- spec/my_omnibar_template.rb
+- spec/rails_helper.rb
+- spec/support/factories.rb
+- spec/system/rails_omnibar_spec.rb
+- tsconfig.json
+- webpack.config.js
+homepage: https://github.com/jaynetics/rails_omnibar
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key:
+specification_version: 4
+summary: Omnibar for Rails
+test_files:
+- spec/app_template.rb
+- spec/lib/rails_omnibar/config_spec.rb
+- spec/lib/rails_omnibar/version_spec.rb
+- spec/my_omnibar_template.rb
+- spec/rails_helper.rb
+- spec/support/factories.rb
+- spec/system/rails_omnibar_spec.rb