dpu 0.4.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 226d037ff45361a6b68bd6626166b3d70d818e89ec7f6adbd9b11b97f143948b
-  data.tar.gz: 9440a89d950b210f409b1d776d2a03c2ee203e2fa52910f59dd7cf004be1abcb
+  metadata.gz: 590a2cd53e8775d56f0b470b0407789f1d7bf7ee47c2b3c2f0f8fcb19d1805e7
+  data.tar.gz: dfa3ef6408df75dcfd83712a65c6a2020b5949c164d93c99ec85328530ffe1a7
 SHA512:
-  metadata.gz: c658a1fc92c4939456eb11f2dee2d4e350a325a4a212705bef1007f3312678f9872edddca2fa4629840548ef4490baf09ed99b6fb0182336ffadf2ef073e2582
-  data.tar.gz: 1bf97e092add6701a49ce53d7a4057d00f953ecb47f46512fcc918a8c51dff95d7cab5552e2148dd7fc3c9d89835e2e92abce9647d2073c131a12336d70ba51a
+  metadata.gz: '08e259ce385484109aa453fa7c30e61765aae3721e947c729535f8a53814c17ebcd62ca8f31809ecd6c7396594d59dbd91f98c9682e28bc3f0736d51cd61986a'
+  data.tar.gz: 56234fd78513c30ccfbe571dacafffc010a7572f40c25ff87a6656e69c1e8941ea756ab45470ad2a06196f666d4582c1cca219d0d5b217153444efc9fde0c709

data/README.md

@@ -39,35 +39,62 @@ $ dpu path_to_code start_line_number end_line_number
 
 Write following code to your `.emacs`, and evaluate it.
 
+<details>
+
+<summary>.emacs sample</summary>
+
 ```emacs-lisp
 (define-key global-map (kbd "C-x L")
   (lambda ()
     (interactive)
-    (message
-     (concat
-      "Copied: "
-      (kill-new
-       (s-chomp
-        (shell-command-to-string
-         (concat
-          "dpu "
-          buffer-file-name
-          " "
-          (number-to-string (line-number-at-pos (region-beginning)))
-          (if mark-active (concat " " (number-to-string (line-number-at-pos (region-end)))))
-          )
-         )))))))
+    (save-window-excursion
+      (let* ((start-line-number (line-number-at-pos (if (region-active-p) (region-beginning))))
+             (end-line-number
+              (if mark-active
+                  (line-number-at-pos
+                   (+ (region-end)
+                      (if (= (line-beginning-position) (region-end)) -1 0)))
+                ))
+             (proc (apply
+                    #'start-process
+                    "dpu" "*Dpu Command Result*"
+                    "dpu" buffer-file-name
+                    (number-to-string start-line-number)
+                    (if end-line-number
+                        (list (number-to-string end-line-number)))
+                    ))
+             (kill-new-with-buffer-string
+              (lambda (process signal)
+                (when (memq (process-status process) '(exit signal))
+                  (let* ((buf (process-buffer process)))
+                    (with-current-buffer buf
+                      (kill-new (s-chomp (buffer-string)))
+                      (message "Copied: %s" (current-kill 0 t))
+                      (kill-buffer buf)
+                      )))))
+             )
+        (run-with-timer 10 nil (lambda (process) (kill-buffer (process-buffer process))) proc)
+        (if (process-live-p proc)
+            (set-process-sentinel proc kill-new-with-buffer-string))
+        )
+      )))
 ```
 
+</details>
+
 Then type `C-x L` to copy permanent URI. `C-y` to paste it.
 
+---
+
+Original asynchronous execution idea is made by [@mk2](https://github.com/mk2) ([#20](https://github.com/nishidayuya/dpu/pull/20)). Thanks! :tada:
+
 ### Textbringer integration
 
 ```ruby
 define_command(:copy_permanent_uri, doc: "Copy permanent URI") do
   require "dpu"
   b = Buffer.current
-  uri = Dpu.determine_permanent_uri(Pathname(b.file_name), b.current_line)
+  uri = Dpu.determine_permanent_uri(Pathname(b.file_name), start_line_number: b.current_line)
   KILL_RING.push(uri)
   Clipboard.copy(uri) if CLIPBOARD_AVAILABLE
   message("Copied: #{uri}")
@@ -76,6 +103,10 @@ end
 GLOBAL_MAP.define_key("\C-xL", :copy_permanent_uri)
 ```
 
+### Visual Studio Code integration
+
+See [Copy permanent URL](https://marketplace.visualstudio.com/items?itemName=nishidayuya.copy-permanent-url) extension on Visual Studio Marketplace.
+
 ### Other editor integration
 
 Write pull-request or issue, please!

data/lib/dpu/cli.rb

@@ -15,7 +15,11 @@ class Dpu::Cli
       start_line_number = s_start_line_number&.to_i
       end_line_number = s_end_line_number&.to_i
 
-      uri = Dpu.determine_permanent_uri(path, start_line_number, end_line_number)
+      uri = Dpu.determine_permanent_uri(
+        path,
+        start_line_number: start_line_number,
+        end_line_number: end_line_number,
+      )
       puts(uri)
     end
   end

data/lib/dpu/scm_service/base.rb

@@ -0,0 +1,25 @@
+class Dpu::ScmService::Base
+  def determine_repository_uri(repository_http_or_ssh_url)
+    md = self.class::REMOTE_URL_PATTERN.match(repository_http_or_ssh_url)
+    return nil if !md
+
+    url = self.class::REPOSITORY_URI_TEMPLATE % {
+      account_name: md[:account_name],
+      repository_name: md[:repository_name],
+    }
+    return URI(url)
+  end
+
+  def ref_prefix
+    return self.class::REF_PREFIX
+  end
+
+  def determine_fragment(start_line_number, end_line_number)
+    return nil if !start_line_number
+    return "L#{start_line_number}" if !end_line_number || start_line_number == end_line_number
+    return self.class::START_AND_END_LINE_NUMBER_FRAGMENT_TEMPLATE % {
+      start_line_number: start_line_number,
+      end_line_number: end_line_number,
+    }
+  end
+end

data/lib/dpu/scm_service/github.rb

@@ -0,0 +1,18 @@
+class Dpu::ScmService::Github < Dpu::ScmService::Base
+  REPOSITORY_URI_TEMPLATE = "https://github.com/%{account_name}/%{repository_name}"
+
+  REMOTE_URL_PATTERN = [
+    %r{\Agit://github\.com/(?<account_name>[^/]+)/(?<repository_name>[^/]+(?=\.git)|[^/]+)},
+    %r{\Ahttps?://github\.com/(?<account_name>[^/]+)/(?<repository_name>[^/]+(?=\.git)|[^/]+)},
+    %r{\Agit@github\.com:(?<account_name>[^/]+)/(?<repository_name>[^/]+(?=\.git)|[^/]+)},
+    %r{\Assh://git@github\.com/(?<account_name>[^/]+)/(?<repository_name>[^/]+(?=\.git)|[^/]+)},
+  ].then { |patterns|
+    Regexp.union(*patterns)
+  }
+
+  REF_PREFIX = "blob"
+
+  START_AND_END_LINE_NUMBER_FRAGMENT_TEMPLATE = "L%{start_line_number}-L%{end_line_number}"
+end
+
+Dpu::SCM_SERVICES << Dpu::ScmService::Github.new

data/lib/dpu/scm_service/sourcehut.rb

@@ -0,0 +1,16 @@
+class Dpu::ScmService::Sourcehut < Dpu::ScmService::Base
+  REPOSITORY_URI_TEMPLATE = "https://git.sr.ht/~%{account_name}/%{repository_name}"
+
+  REMOTE_URL_PATTERN = [
+    %r{\Ahttps://git\.sr\.ht/\~(?<account_name>[^/]+)/(?<repository_name>.+)},
+    %r{\Agit@git\.sr\.ht:\~(?<account_name>[^/]+)/(?<repository_name>.+)},
+  ].then { |patterns|
+    Regexp.union(*patterns)
+  }
+
+  REF_PREFIX = "tree"
+
+  START_AND_END_LINE_NUMBER_FRAGMENT_TEMPLATE = "L%{start_line_number}-%{end_line_number}"
+end
+
+Dpu::SCM_SERVICES << Dpu::ScmService::Sourcehut.new

data/lib/dpu/scm_service.rb

@@ -0,0 +1,2 @@
+module Dpu::ScmService
+end

data/lib/dpu/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dpu
-  VERSION = "0.4.3"
+  VERSION = "0.6.0"
 end

data/lib/dpu.rb

@@ -8,53 +8,24 @@ module Dpu
   autoload :Cli, "dpu/cli"
   autoload :VERSION, "dpu/vesion"
 
+  SCM_SERVICES = []
+
   class << self
-    GITHUB_REPOSITORY_URI_TEMPLATE = "https://github.com/%{account_name}/%{repository_name}"
-    SOURCEHUT_REPOSITORY_URI_TEMPLATE = "https://git.sr.ht/~%{account_name}/%{repository_name}"
-    REPOSITORY_URI_TEMPLATES = {
-      github: GITHUB_REPOSITORY_URI_TEMPLATE,
-      sourcehut: SOURCEHUT_REPOSITORY_URI_TEMPLATE,
-    }
-
-    GITHUB_REMOTE_URL_PATTERN = [
-      %r{\Agit://github\.com/(?<account_name>[^/]+)/(?<repository_name>[^/]+(?=\.git)|[^/]+)},
-      %r{\Ahttps?://github\.com/(?<account_name>[^/]+)/(?<repository_name>[^/]+(?=\.git)|[^/]+)},
-      %r{\Agit@github\.com:(?<account_name>[^/]+)/(?<repository_name>[^/]+(?=\.git)|[^/]+)},
-      %r{\Assh://git@github\.com/(?<account_name>[^/]+)/(?<repository_name>[^/]+(?=\.git)|[^/]+)},
-    ].then { |patterns|
-      Regexp.union(*patterns)
-    }
-    SOURCEHUT_REMOTE_URL_PATTERN = [
-      %r{\Ahttps://git\.sr\.ht/\~(?<account_name>[^/]+)/(?<repository_name>.+)},
-      %r{\Agit@git\.sr\.ht:\~(?<account_name>[^/]+)/(?<repository_name>.+)},
-    ].then { |patterns|
-      Regexp.union(*patterns)
-    }
-    REMOTE_URL_PATTERNS = {
-      github: GITHUB_REMOTE_URL_PATTERN,
-      sourcehut: SOURCEHUT_REMOTE_URL_PATTERN,
-    }
-
-    REF_PREFIX = {
-      github: 'blob',
-      sourcehut: 'tree',
-    }
-
-    def determine_permanent_uri(path_or_link, start_line_number = nil, end_line_number = nil)
+    def determine_permanent_uri(path_or_link, start_line_number: nil, end_line_number: nil, max_find_version: 20)
       path = path_or_link.realpath
       relative_path = determine_relative_path(path)
 
       remote_url = get_remote_url(path)
-      vcs_service = determine_vcs_service(remote_url)
+      scm_service, repository_uri = determine_scm_service_and_repository_uri(remote_url)
 
       permanent_uri_parts = [
-        determine_repository_uri(vcs_service, remote_url),
-        REF_PREFIX[vcs_service],
-        find_same_content_version(path, relative_path) || determine_commit_id(path),
+        repository_uri,
+        scm_service.ref_prefix,
+        find_same_content_version(path, relative_path, max_find_version) || determine_commit_id(path),
         relative_path,
       ]
       permanent_uri = URI(permanent_uri_parts.join("/"))
-      permanent_uri.fragment = determine_fragment(vcs_service, start_line_number, end_line_number)
+      permanent_uri.fragment = scm_service.determine_fragment(start_line_number, end_line_number)
       return permanent_uri
     end
 
@@ -79,28 +50,13 @@ module Dpu
       return run_command("git remote get-url origin", chdir: path.dirname).chomp
     end
 
-    def determine_vcs_service(repository_http_or_ssh_url)
-      if GITHUB_REMOTE_URL_PATTERN.match?(repository_http_or_ssh_url)
-        return :github
-      end
-      if SOURCEHUT_REMOTE_URL_PATTERN.match?(repository_http_or_ssh_url)
-        return :sourcehut
-      end
-
-      raise "unknown VCS service: #{repository_http_or_ssh_url}"
-    end
-
-    def determine_repository_uri(vcs_service, repository_http_or_ssh_url)
-      md = REMOTE_URL_PATTERNS[vcs_service].match(repository_http_or_ssh_url)
-      if !md
-        return URI(repository_http_or_ssh_url)
+    def determine_scm_service_and_repository_uri(repository_http_or_ssh_url)
+      SCM_SERVICES.each do |scm_service|
+        repository_uri = scm_service.determine_repository_uri(repository_http_or_ssh_url)
+        return scm_service, repository_uri if repository_uri
       end
 
-      url = REPOSITORY_URI_TEMPLATES[vcs_service] % {
-        account_name: md[:account_name],
-        repository_name: md[:repository_name],
-      }
-      return URI(url)
+      raise "unknown SCM service: #{repository_http_or_ssh_url}"
     end
 
     def determine_commit_id(path)
@@ -109,12 +65,12 @@ module Dpu
       return commit_id
     end
 
-    def find_same_content_version(path, relative_path_from_repository_root)
+    def find_same_content_version(path, relative_path_from_repository_root, max_find_version)
       stdout = run_command(*%w[git tag --list [0-9]* v[0-9]*], chdir: path.dirname)
       versions = VersionSorter.sort(stdout.each_line(chomp: true).select(&:ascii_only?))
 
       content_in_head = path.read
-      same_content_version = versions.reverse_each.find { |version|
+      same_content_version = versions.reverse_each.take(max_find_version).find { |version|
         content_in_version, _stderr, _status = *Open3.capture3(
           *%W[git show #{version}:#{relative_path_from_repository_root}],
           chdir: path.dirname,
@@ -123,12 +79,10 @@ module Dpu
       }
       return same_content_version
     end
-
-    def determine_fragment(vcs_service, start_line_number, end_line_number)
-      return nil if !start_line_number
-      return "L#{start_line_number}" if !end_line_number || start_line_number == end_line_number
-      return "L#{start_line_number}-L#{end_line_number}" if vcs_service == :github
-      return "L#{start_line_number}-#{end_line_number}" if vcs_service == :sourcehut
-    end
   end
 end
+
+require "dpu/scm_service"
+require "dpu/scm_service/base"
+require "dpu/scm_service/github"
+require "dpu/scm_service/sourcehut"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dpu
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.6.0
 platform: ruby
 authors:
 - Yuya.Nishida.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-23 00:00:00.000000000 Z
+date: 2023-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: version_sorter
@@ -81,6 +81,10 @@ files:
 - exe/dpu
 - lib/dpu.rb
 - lib/dpu/cli.rb
+- lib/dpu/scm_service.rb
+- lib/dpu/scm_service/base.rb
+- lib/dpu/scm_service/github.rb
+- lib/dpu/scm_service/sourcehut.rb
 - lib/dpu/version.rb
 - sig/dpu.rbs
 homepage: https://github.com/nishidayuya/dpu