mdv 0.3.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d8ae58018911dd37af67935880a3a18abbb7ffc4
-  data.tar.gz: ddfab34f27ce6af584c4990a06f51e0888906317
+SHA256:
+  metadata.gz: cb3eb712bbc1f685d269a4e97421efb66ff9416700159a90ec4cf5d1f24c2d72
+  data.tar.gz: 666ab4a8cc091d8bbe702385e43c6d96017a718a35efe19a131372abf1515b70
 SHA512:
-  metadata.gz: 07b27b674063ce928eceedac586b67c278f4d1ae2f1a937a79490a3e6322fc89f44626c589afb36d76f2212ff98430ff0905608f08c8eaf5c080b58db3fa7a65
-  data.tar.gz: 8e0ca22c3025613ec2e9baf39ef503a0c02cda169541e095a94c544bb7166e1694ec23304dfd21bdabeda1dcfb590b07650a77e1bba1b2160c3c1e79b0bd3756
+  metadata.gz: 6c6cd510080c885c528a62684a1b5571e3798da209bde4bedac13ea780aa0af2c2b37c5bd87a8e38b3770fbcefae7ba79f3731139973a837684e3bcbe85789aa
+  data.tar.gz: c584ebcbd56777548042385e80949bfc4dcd25062ceb8ac57feac63c05d23ba69b9ea8bceae71df47b12857f2356ed7f4c402a2eefd2dd5435ee1a8d60ee9eaf

data/Changelog.md

@@ -1,8 +1,35 @@
 # Change log
 
+## 0.6.0 / 2021-01-17
+
+* Drop support for Ruby 2.4
+* Support Ruby 2.7 and 3.0
+* Implement as a Gtk::Application
+
+## 0.5.1 / 2019-11-03
+
+* Fix navigation signal handler that would cause program to abort just after
+  loading
+
+## 0.5.0 / 2019-10-20
+
+* Drop support for Ruby 2.3 and lower
+* Port to GirFFI-Gtk
+
+## 0.4.1 / 2018-12-09
+
+* Update dependencies
+
+## 0.4.0 / 2018-09-12
+
+* Drop support for Ruby 2.2 and lower
+* Update dependencies
+* Hide context menus to prevent unwanted actions
+* Open links in default browser instead of in mdv itself
+
 ## 0.3.1 / 2017-11-11
 
-* Port to Ruby-GNOME2
+* Update dependencies
 
 ## 0.3.0 / 2017-04-25
 
@@ -24,7 +51,7 @@
 
 * Update dependency on GirFFI
 * Update code to use GirFFI's new bitmasks
-* Use updated atspi_app_driver to fix tests
+* Use updated `atspi_app_driver` to fix tests
 
 ## 0.1.6 / 2015-10-17
 
@@ -35,7 +62,7 @@
 
 * Ensure all relevant files are released in the gem
 * Code restructuring
-* Tested end-to-end using atspi_app_driver
+* Tested end-to-end using `atspi_app_driver`
 * Updated dependencies
 
 ## 0.1.4 / 2014-05-27

data/README.md

@@ -6,7 +6,8 @@ Simple Markdown Viewer for GNOME 3.
 
     mdv README.md
 
-Press Ctrl-R to reload, Ctrl-Q to quit.
+Press Ctrl-R to reload, Ctrl-Q to quit, Ctrl-C to copy selected text. Clicked
+links open in default browser.
 
 ## Install
 
@@ -14,30 +15,22 @@ Press Ctrl-R to reload, Ctrl-Q to quit.
 
 ## Dependencies
 
-MDV needs some additional software installed in order to work.
+MDV depends on the `gir_ffi-gtk` gem. Additionally, you need to install the
+Webkit2Gtk library and its gobject-introspection information. On Debian and
+Ubuntu, the following should work:
 
-### Debian
+    sudo apt-get install gir1.2-webkit2-4.0
 
-The following should work:
+On Ubuntu, you may also have to install two additional packages:
 
-    sudo apt-get install libgirepository1.0-dev gobject-introspection
-    sudo apt-get install libwebkit2gtk-4.0-dev
-
-### Other OS
-
-To be determined. Please contribute back your experience in getting MDV running
-on your favorite operation system.
+    sudo apt-get install libwebkit2gtk-4.0-dev libjavascriptcoregtk-4.0-dev
 
 ## Contributing
 
 Contributions are welcome! Please feel free to create issues or pull requests
 on GitHub.
 
-If you want to run the tests, you may need to install additional packages:
-
-    sudo apt-get install gir1.2-atspi-2.0 libatk-adaptor
-
 ## License
 
-Copyright © 2012–2016 [Matijs van Zuijlen](http://www.matijs.net).
+Copyright © 2012–2019 [Matijs van Zuijlen](http://www.matijs.net).
 See LICENSE for details.

data/bin/mdv

@@ -1,14 +1,59 @@
 #!/usr/bin/env ruby
-require 'github/markup'
-require 'mdv'
+# frozen_string_literal: true
 
-Gtk.init
+require "mdv"
 
-WebKit2Gtk::WebContext.default.set_cache_model :document_viewer
+myapp = Gtk::Application.new("net.matijs.mdv",
+                             { handles_open: true })
 
-file = ARGV[0]
-raise 'Need file' unless file
+def make_window(app)
+  win = Gtk::ApplicationWindow.new app
+  close_action = Gio::SimpleAction.new("close", nil)
+  close_action.signal_connect("activate") { win.destroy }
+  win.add_action close_action
+  win
+end
 
-MDV::MarkdownViewer.new file
+myapp.signal_connect "startup" do |app|
+  WebKit2::WebContext.get_default.set_cache_model :document_viewer
 
-Gtk.main
+  action = Gio::SimpleAction.new("quit", nil)
+  action.signal_connect("activate") { app.quit }
+  myapp.add_action action
+
+  myapp.set_accels_for_action "app.quit", ["<Ctrl>Q"]
+  myapp.set_accels_for_action "win.close", ["<Ctrl>W"]
+  myapp.set_accels_for_action "win.reload", ["<Ctrl>R"]
+
+  # Add menu so Atspi has a way to access the actions
+  menu = Gio::Menu.new
+  file_menu = Gio::Menu.new
+  file_menu.append "Close Window", "win.close"
+  file_menu.append "Quit", "app.quit"
+  menu.append_submenu "File", file_menu
+  view_menu = Gio::Menu.new
+  view_menu.append "Reload", "win.reload"
+  menu.append_submenu "View", view_menu
+
+  myapp.menubar = menu
+end
+
+myapp.signal_connect "activate" do |app, _user_data|
+  win = make_window(app)
+  win.show_all
+  win.children.first.visible = false
+end
+
+myapp.signal_connect "open" do |app, files, _hint, _user_data|
+  files.each do |file|
+    filename = file.path
+    win = make_window(app)
+    MDV::MarkdownViewer.new win, filename
+    win.show_all
+
+    # This hides the menubar but keeps it available for Atspi
+    win.children.first.visible = false
+  end
+end
+
+exit(myapp.run([$PROGRAM_NAME] + ARGV))

data/lib/mdv.rb

@@ -1 +1,3 @@
-require_relative 'mdv/markdown_viewer'
+# frozen_string_literal: true
+
+require_relative "mdv/markdown_viewer"

data/lib/mdv/document.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "github/markup"
+
+module MDV
+  # Markdown document class
+  class Document
+    def initialize(file)
+      @file = file
+    end
+
+    def base_uri
+      @base_uri ||= "file://#{fullpath}"
+    end
+
+    def html
+      GitHub::Markup.render(fullpath, File.read(fullpath))
+    end
+
+    private
+
+    def fullpath
+      @fullpath ||= File.expand_path(@file, Dir.pwd)
+    end
+  end
+end

data/lib/mdv/markdown_viewer.rb

@@ -1,76 +1,71 @@
-require 'webkit2-gtk'
+# frozen_string_literal: true
+
+require "gir_ffi-gtk3"
+require "mdv/document"
+
+GirFFI.setup :WebKit2, "4.0"
 
 module MDV
   # Markdown viewer window class
   class MarkdownViewer
-    attr_reader :file
-
-    def initialize(file)
-      @file = file
+    def initialize(win, file)
+      @win = win
+      @document = Document.new(file)
       setup_gui
+      connect_actions
       reload
       connect_signals
-      @win.show_all
     end
 
     private
 
     def connect_signals
-      connect_key_press_event_signal
-      connect_destroy_signal
+      connect_web_view_signals
     end
 
-    def connect_destroy_signal
-      @win.signal_connect('destroy') { Gtk.main_quit }
-    end
-
-    def connect_key_press_event_signal
-      @win.signal_connect 'key-press-event' do |_wdg, evt, _ud|
-        handle_key(evt) if evt.state.control_mask?
-        false
+    def connect_web_view_signals
+      web_view.signal_connect("context-menu") { true }
+      web_view.signal_connect("decide-policy") do |_wv, decision, decision_type|
+        handle_decide_policy(decision, decision_type)
       end
     end
 
-    def handle_key(evt)
-      case evt.keyval
-      when 'q'.ord
-        @win.destroy
-      when 'r'.ord
-        reload
+    def handle_decide_policy(decision, decision_type)
+      case decision_type
+      when :navigation_action
+        action = decision.navigation_action
+        if action.is_user_gesture
+          Gtk.show_uri_on_window(@win, action.request.uri, 0)
+          true
+        end
+      when :new_window_action
+        true
       end
     end
 
     def setup_gui
-      @win = Gtk::Window.new :toplevel
-      @win.set_default_geometry 700, 500
-
       @win.add scrolled_window
+      @win.set_default_size 700, 500
+    end
+
+    def connect_actions
+      reload_action = Gio::SimpleAction.new("reload", nil)
+      reload_action.signal_connect("activate") { reload }
+      @win.add_action reload_action
     end
 
     def scrolled_window
-      @scr ||= Gtk::ScrolledWindow.new(nil, nil).tap do |it|
+      @scrolled_window ||= Gtk::ScrolledWindow.new(nil, nil).tap do |it|
         it.add web_view
       end
     end
 
     def web_view
-      @wv ||= WebKit2Gtk::WebView.new
-    end
-
-    def fullpath
-      @fullpath ||= File.expand_path(file, Dir.pwd)
-    end
-
-    def base_uri
-      @base_uri ||= "file://#{fullpath}"
-    end
-
-    def html
-      GitHub::Markup.render(fullpath)
+      @web_view ||= WebKit2::WebView.new
     end
 
     def reload
-      web_view.load_html html, base_uri
+      web_view.load_html @document.html, @document.base_uri
     end
   end
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: mdv
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Matijs van Zuijlen
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-11-11 00:00:00.000000000 Z
+date: 2021-01-17 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: gir_ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.7
+- !ruby/object:Gem::Dependency
+  name: gir_ffi-gtk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.0
 - !ruby/object:Gem::Dependency
   name: github-markdown
   requirement: !ruby/object:Gem::Requirement
@@ -30,112 +58,199 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: webkit2-gtk
+  name: atspi_app_driver
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.0
-  type: :runtime
+        version: 0.7.0
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
-  name: gnome_app_driver
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: '5.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: '5.12'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.5'
+        version: 0.13.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.5'
+        version: 0.13.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        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: rake-manifest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
-description: Quickly view markdown files on GNOME
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-packaging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+description: 'Quickly view markdown files on GNOME
+
+  '
 email:
 - matijs@matijs.net
 executables:
 - mdv
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- Changelog.md
+- README.md
 files:
 - Changelog.md
-- Gemfile
 - LICENSE
 - README.md
-- Rakefile
 - bin/mdv
 - lib/mdv.rb
+- lib/mdv/document.rb
 - lib/mdv/markdown_viewer.rb
-- test/end_to_end/basic_run_test.rb
-- test/test_helper.rb
 homepage: http://www.github.com/mvz/mdv
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
-rdoc_options: []
+metadata:
+  homepage_uri: http://www.github.com/mvz/mdv
+  source_code_uri: https://github.com/mvz/mdv
+  changelog_uri: https://github.com/mvz/mdv/blob/master/Changelog.md
+post_install_message:
+rdoc_options:
+- "--main"
+- README.md
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Simple Markdown Viewer
-test_files:
-- test/test_helper.rb
-- test/end_to_end/basic_run_test.rb
+test_files: []

data/Gemfile

@@ -1,3 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec

data/Rakefile

@@ -1,17 +0,0 @@
-require 'rake/clean'
-require 'bundler/gem_tasks'
-require 'rake/testtask'
-
-namespace :test do
-  Rake::TestTask.new(:end_to_end) do |t|
-    t.libs = ['lib']
-    t.test_files = FileList['test/end_to_end/*_test.rb']
-    t.warning = true
-  end
-
-  task all: [:end_to_end]
-end
-
-task test: 'test:all'
-
-task default: 'test'

data/test/end_to_end/basic_run_test.rb

@@ -1,31 +0,0 @@
-require_relative '../test_helper'
-require 'gnome_app_driver'
-
-# Test driver for the MDV application.
-class MDVDriver < GnomeAppDriver
-  def initialize
-    super 'mdv'
-  end
-
-  def boot(filename)
-    super arguments: [filename]
-  end
-end
-
-describe 'The MDV application' do
-  before do
-    @driver = MDVDriver.new
-    @driver.boot('README.md')
-  end
-
-  it 'starts and can be quit with Ctrl-q' do
-    @driver.press_ctrl_q
-
-    status = @driver.cleanup
-    status.exitstatus.must_equal 0
-  end
-
-  after do
-    @driver.cleanup
-  end
-end

data/test/test_helper.rb

@@ -1 +0,0 @@
-require 'minitest/autorun'