rails_omnibar 1.3.2 → 1.5.0

data/lib/rails_omnibar/config.rb

@@ -1,4 +1,23 @@
 class RailsOmnibar
+  def configure(&block)
+    check_const_and_clear_cache
+    tap(&block)
+  end
+
+  attr_reader :auth
+  def auth=(arg)
+    @auth = arg.try(:arity) == 0 ? arg : RailsOmnibar.cast_to_proc(arg)
+  end
+  def authorize(controller)
+    if auth.nil?
+      true
+    elsif auth.arity == 0
+      controller.instance_exec(&auth)
+    else
+      auth.call(controller, controller: controller, omnibar: self)
+    end
+  end
+
   def max_results=(arg)
     arg.is_a?(Integer) && arg > 0 || raise(ArgumentError, 'max_results must be > 0')
     @max_results = arg
@@ -32,4 +51,16 @@ class RailsOmnibar
     help_item = items.find { |i| i.type == :help }
     help_item && "Hint: Type `#{help_item.title}` for help"
   end
+
+  private
+
+  def omnibar_class
+    self.class.name || raise(<<~EOS)
+      RailsOmnibar subclasses must be assigned to constants
+      before configuring or rendering them. E.g.:
+
+      Foo = Class.new(RailsOmnibar)
+      Foo.configure { ... }
+    EOS
+  end
 end

data/lib/rails_omnibar/item/help.rb

@@ -1,7 +1,6 @@
 class RailsOmnibar
   def add_help(**kwargs)
     add_item Item::Help.new(for_commands: commands, **kwargs)
-    self.class
   end
 
   module Item

data/lib/rails_omnibar/item/webadmin.rb

@@ -0,0 +1,45 @@
+class RailsOmnibar
+  # adds fuzzy-searchable links to each defined resource index of ActiveAdmin etc.
+  def add_webadmin_items(icon: default_admin_item_icon, prefix: nil, suffix: nil, suggested: false)
+    if defined?(ActiveAdmin)
+      add_active_admin_items(icon: icon, prefix: prefix, suffix: suffix, suggested: suggested)
+    elsif defined?(RailsAdmin)
+      add_rails_admin_items(icon: icon, prefix: prefix, suffix: suffix, suggested: suggested)
+    else
+      raise "#{__method__} currently only works with ActiveAdmin or RailsAdmin"
+    end
+  end
+
+  def add_active_admin_items(icon: default_admin_item_icon, prefix: nil, suffix: nil, suggested: false)
+    ActiveAdmin.load!
+
+    ActiveAdmin.application.namespaces.each do |namespace|
+      namespace.fetch_menu(ActiveAdmin::DEFAULT_MENU) # ensure menu is loaded
+
+      namespace.resources.each do |res|
+        next unless (res.controller.action_methods & ['index', :index]).any?
+        next unless index = res.route_collection_path rescue next
+        next unless label = res.menu_item&.label.presence
+
+        title = [prefix, label, suffix].compact.join(' ')
+        add_item(title: title, url: index, icon: icon, suggested: suggested)
+      end
+    end
+  end
+
+  def add_rails_admin_items(icon: default_admin_item_icon, prefix: nil, suffix: nil, suggested: false)
+    admin_urls = RailsAdmin::Engine.routes.url_helpers
+
+    RailsAdmin::Config.models.select(&:visible?).each do |model|
+      next unless index = admin_urls.index_path(model.abstract_model.to_param)
+      next unless label = model.label_plural # as used by rails_admin in sidebar
+
+      title = [prefix, label, suffix].compact.join(' ')
+      add_item(title: title, url: index, icon: icon, suggested: suggested)
+    end
+  end
+
+  def default_admin_item_icon
+    :document
+  end
+end

data/lib/rails_omnibar/items.rb

@@ -1,13 +1,13 @@
 class RailsOmnibar
   def add_item(item)
+    check_const_and_clear_cache
     items << RailsOmnibar.cast_to_item(item)
-    clear_cache
-    self.class
+    self
   end
 
   def add_items(*args)
     args.each { |arg| add_item(arg) }
-    self.class
+    self
   end
 
   def self.cast_to_item(arg)

data/lib/rails_omnibar/rendering.rb

@@ -8,6 +8,10 @@ class RailsOmnibar
     HTML
   end
 
+  def html_url
+    urls.html_path(omnibar_class: omnibar_class)
+  end
+
   require 'js_regex'
 
   def as_json(*)
@@ -19,7 +23,7 @@ class RailsOmnibar
       maxResults:     max_results,
       modal:          modal?,
       placeholder:    placeholder,
-      queryPath:      urls.query_path(omnibar_class: self.class),
+      queryPath:      urls.query_path(omnibar_class: omnibar_class),
     }
   end
 
@@ -29,7 +33,8 @@ class RailsOmnibar
 
   private
 
-  def clear_cache
+  def check_const_and_clear_cache
+    omnibar_class # trigger constant assignment check
     @cached_html = nil
   end
 end

data/lib/rails_omnibar/version.rb

@@ -1,3 +1,3 @@
 class RailsOmnibar
-  VERSION = '1.3.2'
+  VERSION = '1.5.0'
 end

data/lib/rails_omnibar.rb

@@ -3,15 +3,11 @@ require 'rails'
 Dir[File.join(__dir__, 'rails_omnibar', '**', '*.rb')].sort.each { |f| require(f) }
 
 class RailsOmnibar
-  def self.configure(&block)
-    @singleton = block_given? ? new.tap(&block) : new
-  end
-  private_class_method :new
-
   singleton_class.delegate(*public_instance_methods(false), to: :singleton)
 
-  private_class_method\
   def self.singleton
-    @singleton || raise("Please `.configure' your omnibar first")
+    @singleton ||= new
   end
+  private_class_method :singleton
+  private_class_method :new
 end

data/rails_omnibar.gemspec

@@ -20,12 +20,4 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'js_regex'
   spec.add_dependency 'rails', ['>= 6.0', '< 8.0']
-
-  spec.add_development_dependency 'capybara', '~> 3.0'
-  spec.add_development_dependency 'factory_bot_rails', '~> 6.0'
-  spec.add_development_dependency 'puma', '~> 5.0'
-  spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rspec-rails', '~> 5.0'
-  spec.add_development_dependency 'sqlite3', '>= 1.3.6'
-  spec.add_development_dependency 'webdrivers', '~> 5.0'
 end

data/spec/lib/rails_omnibar/config_spec.rb

@@ -1,7 +1,9 @@
 require 'rails_helper'
 
+TestBar = Class.new(RailsOmnibar)
+
 describe RailsOmnibar do
-  subject { Class.new(RailsOmnibar).configure }
+  subject { TestBar }
 
   it 'has a configurable max_results' do
     expect(subject.max_results).to eq 10
@@ -50,4 +52,11 @@ describe RailsOmnibar do
     subject.placeholder = false
     expect(subject.placeholder).to eq nil
   end
+
+  it 'raises when trying to configure or render from an anonymous class' do
+    klass = Class.new(RailsOmnibar)
+    expect { klass.configure {} }.to raise_error(/constant/)
+    expect { klass.add_item(title: 'a', url: 'b') }.to raise_error(/constant/)
+    expect { klass.render }.to raise_error(/constant/)
+  end
 end

data/spec/rails_helper.rb

@@ -15,8 +15,4 @@ RSpec.configure do |config|
   config.before(:each, type: :system) do
     driven_by :selenium_chrome_headless
   end
-  config.after(:each, type: :system) do
-    logs = page.driver.browser.logs.get(:browser)
-    logs.empty? || raise("JS errors: #{logs.map(&:message)}")
-  end
 end

data/spec/support/factories.rb

@@ -4,5 +4,7 @@ FactoryBot.define do
   factory :user do
     first_name { 'John' }
     last_name { 'Doe' }
+    sequence(:email) { |n| "person#{n}@example.com" }
+    password { '12345678' }
   end
 end

data/spec/system/rails_omnibar_spec.rb

@@ -12,12 +12,14 @@ describe RailsOmnibar do
     # test visibility toggling with hotkey
     expect(page).not_to have_selector 'input'
 
-    send_keys([:control, 'm']) # custom hotkey, c.f. app_template.rb
+    send_keys([:control, 'm']) # custom hotkey, c.f. my_omnibar_template.rb
     expect(page).to have_selector 'input'
 
+    sleep 0.1
     send_keys([:control, 'm'])
     expect(page).not_to have_selector 'input'
 
+    sleep 0.1
     send_keys([:meta, 'm']) # meta modifier (⌘) should also be supported
     expect(page).to have_selector 'input'
 
@@ -65,7 +67,7 @@ describe RailsOmnibar do
 
     # test navigation for item with #url
     submit
-    expect(page.current_url).to end_with '/users/2'
+    expect(page).to have_current_path '/users/2'
     send_keys([:control, 'm']) # make omnibar visible again
 
     # test generic search and multi-itemization
@@ -78,6 +80,43 @@ describe RailsOmnibar do
     # test custom command
     type('count users')
     expect(page).to have_content '2'
+
+    # test auth with devise
+    auth = ->(controller) { controller.user_signed_in? || true }
+    MyOmnibar.auth = auth
+    expect(auth).to receive(:call).at_least(:once).and_call_original
+    sleep 0.1 # not sure why this is needed ...
+    type('count users')
+    expect(page).to have_content '2'
+
+    # test activeadmin integration
+    # stub sprockets so we don't need sassc etc.
+    allow_any_instance_of(Sprockets::Rails::Helper)
+      .to receive(:compute_asset_path)
+      .and_return('')
+
+    submit('Admin: Useroos')
+    expect(page).to have_current_path('/admin/users')
+  end
+
+  it 'can have more than one omnibar' do
+    visit main_app.root_path
+    expect(page).to have_selector '#mount-rails-omnibar' # sanity check
+
+    expect(page).not_to have_selector 'input'
+    send_keys([:meta, 'a']) # custom hotkey, c.f. other_omnibar_template.rb
+    expect(page).to have_selector 'input'
+
+    # test suggested content from other omnibar is not there
+    expect(page).not_to have_content 'important URL'
+
+    # test fuzzy search for this bars' static items
+    type('dis')
+    expect(page).to have_content 'disney'
+
+    # test command from other omnibar does not run
+    type('g foobar')
+    expect(page).not_to have_content 'fake_result_1'
   end
 
   def type(str)

data/spec/templates/app_template.rb

@@ -0,0 +1,40 @@
+# template for dummy rails app used in specs
+
+gem 'rails_omnibar', path: __dir__ + '/../../'
+gem 'csv'
+gem 'devise'
+gem 'activeadmin'
+
+insert_into_file 'config/application.rb', <<~RUBY, after: /action_mailer.*\n/
+  require 'action_mailer/railtie' # needed to make devise work
+  require 'devise'
+  require 'sprockets/railtie' # needed to make activeadmin work
+RUBY
+
+# https://github.com/activeadmin/activeadmin/pull/7235#issuecomment-1000823435
+insert_into_file 'config/environments/test.rb', 'false # ', after: /config.eager_load *=/
+
+generate 'model', 'User first_name:string last_name:string admin:boolean --no-test-framework'
+generate 'devise:install'
+generate 'devise User'
+generate 'active_admin:install --skip-users'
+
+insert_into_file 'config/initializers/active_admin.rb', <<-RUBY, after: "|config|\n"
+  config.load_paths = [File.join(Rails.root, 'app/lib/aa')]
+RUBY
+
+file 'app/lib/my_omnibar.rb',    File.read(__dir__ + '/my_omnibar_template.rb')
+file 'app/lib/other_omnibar.rb', File.read(__dir__ + '/other_omnibar_template.rb')
+file 'app/lib/aa/users.rb',      File.read(__dir__ + '/user_resource_template.rb')
+
+inject_into_class 'app/controllers/application_controller.rb', 'ApplicationController', <<-RUBY
+  def index
+    render html: (MyOmnibar.render + OtherOmnibar.render)
+  end
+RUBY
+
+route 'mount RailsOmnibar::Engine => "/rails_omnibar"'
+route 'root "application#index"'
+route 'get "users/(*path)" => "application#index"'
+
+rake 'db:migrate db:test:prepare'

data/spec/{my_omnibar_template.rb → templates/my_omnibar_template.rb}

@@ -4,6 +4,8 @@ MyOmnibar = RailsOmnibar.configure do |c|
   c.add_item(title: 'important URL', url: 'https://www.disney.com', suggested: true)
   c.add_item(title: 'boring URL', url: 'https://www.github.com')
 
+  c.add_webadmin_items(prefix: 'Admin:')
+
   c.add_record_search(pattern: /^u(\d+)/, model: User, example: 'u123')
 
   c.add_record_search(pattern: /^u (.+)/, model: User, columns: %i[first_name last_name],
@@ -34,7 +36,7 @@ MyOmnibar = RailsOmnibar.configure do |c|
     description: 'Get count of a DB table',
     pattern:     /COUNT (.+)/i,
     example:     'COUNT users',
-    resolver:    ->(value, _omnibar) do
+    resolver:    ->(value) do
       { title: value.classify.constantize.count.to_s }
     rescue => e
       { title: e.message }

data/spec/templates/other_omnibar_template.rb

@@ -0,0 +1,11 @@
+OtherOmnibar = Class.new(RailsOmnibar)
+OtherOmnibar.configure do |c|
+  c.modal = true
+
+  c.add_item(title: 'disney', url: 'https://www.disney.com', suggested: true)
+
+  # Use a hotkey that is the same in most keyboard layouts to work around
+  # https://bugs.chromium.org/p/chromedriver/issues/detail?id=553
+  # (This is only relevant for testing with chromedriver.)
+  c.hotkey = 'a'
+end

data/spec/templates/user_resource_template.rb

@@ -0,0 +1,5 @@
+ActiveAdmin.register User do
+  menu label: 'Useroos', parent: 'Stuff'
+  actions :all
+  config.filters = false
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_omnibar
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.5.0
 platform: ruby
 authors:
 - Janosch Müller
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-27 00:00:00.000000000 Z
+date: 2024-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: js_regex
@@ -44,104 +44,6 @@ dependencies:
     - - "<"
       - !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: []
@@ -156,6 +58,7 @@ files:
 - README.md
 - Rakefile
 - app/controllers/rails_omnibar/base_controller.rb
+- app/controllers/rails_omnibar/html_controller.rb
 - app/controllers/rails_omnibar/js_controller.rb
 - app/controllers/rails_omnibar/queries_controller.rb
 - bin/console
@@ -180,19 +83,22 @@ files:
 - lib/rails_omnibar/engine.rb
 - lib/rails_omnibar/item/base.rb
 - lib/rails_omnibar/item/help.rb
+- lib/rails_omnibar/item/webadmin.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/item/base_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
+- spec/templates/app_template.rb
+- spec/templates/my_omnibar_template.rb
+- spec/templates/other_omnibar_template.rb
+- spec/templates/user_resource_template.rb
 - tsconfig.json
 - webpack.config.js
 homepage: https://github.com/jaynetics/rails_omnibar
@@ -214,16 +120,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.5.0.dev
 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/item/base_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
+- spec/templates/app_template.rb
+- spec/templates/my_omnibar_template.rb
+- spec/templates/other_omnibar_template.rb
+- spec/templates/user_resource_template.rb

data/spec/app_template.rb

@@ -1,17 +0,0 @@
-gem 'rails_omnibar', path: __dir__ + '/../'
-
-generate 'model', 'User first_name:string last_name:string admin:boolean --no-test-framework'
-
-file 'app/lib/my_omnibar.rb', File.read(__dir__ + '/my_omnibar_template.rb')
-
-inject_into_class 'app/controllers/application_controller.rb', 'ApplicationController', <<-RUBY
-  def index
-    render html: MyOmnibar.render
-  end
-RUBY
-
-route 'mount RailsOmnibar::Engine => "/rails_omnibar"'
-route 'root "application#index"'
-route 'get "users/(*path)" => "application#index"'
-
-rake 'db:migrate db:test:prepare'