dpu 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a136a963872583eb77ab03abe04b4f06a281e33f6bf3e74703eb1920545c2839
+  data.tar.gz: 112faf5ef0d4ab660844a3c81eacf5cda68072ad00015fe0862ed7d242b26371
+SHA512:
+  metadata.gz: 95b54d43d7a9352b305047415af4f0eb9c379162ab52acbf89007b72e48df6253e21faf622e454584944b0fd8d4e4674b57af013f568389c92dcadefe9303259
+  data.tar.gz: 58c2fe2c850536c1c3dcafbcac54e7a56c40a9b268570937ae25b4360e6ef172bac9d24e6e524a1d4b799fcb3e0b8c05073136df8f19e76c130b30b571bdc4eb

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2023 Yuya.Nishida.
+
+X11 License
+
+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,36 @@
+# dpu: determine permanent URI
+
+`dpu` command shows us permanent source-code URI.
+
+```console
+$ dpu array.c 4133 4136
+https://github.com/ruby/ruby/blob/v3_2_2/array.c#L4133-L4136
+```
+
+## Requirements
+
+- Ruby
+
+## Installation
+
+```console
+$ gem install dpu
+```
+
+## Usage
+
+Get permanent source code URI:
+
+```console
+$ dpu path_to_code
+```
+
+Get permanent source code URI with line range:
+
+```console
+$ dpu path_to_code start_line_number end_line_number
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nishidayuya/dpu .

data/Rakefile

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

data/exe/dpu

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "dpu"
+
+Dpu::Cli.run(ARGV)

data/lib/dpu/cli.rb

@@ -0,0 +1,22 @@
+class Dpu::Cli
+  USAGE = <<~EOS
+    #{File.basename(Process.argv0)} path start_line_number end_line_number
+  EOS
+
+  class << self
+    def run(argv)
+      s_path, s_start_line_number, s_end_line_number = *argv
+      if !s_path
+        $stderr.puts(USAGE)
+        exit(1)
+      end
+
+      path = Pathname(s_path).expand_path
+      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)
+      puts(uri)
+    end
+  end
+end

data/lib/dpu/version.rb

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

data/lib/dpu.rb

@@ -0,0 +1,86 @@
+require "open3"
+require "pathname"
+require "uri"
+
+module Dpu
+  autoload :Cli, "dpu/cli"
+  autoload :VERSION, "dpu/vesion"
+
+  class << self
+    GITHUB_REPOSITORY_URI_TEMPLATE = "https://github.com/%{account_name}/%{repository_name}"
+
+    def determine_permanent_uri(path, start_line_number, end_line_number)
+      relative_path = determine_relative_path(path)
+
+      permanent_uri_parts = [
+        determine_repository_uri(path),
+        "blob",
+        find_same_content_version(path, relative_path) || determine_commit_id(path),
+        relative_path,
+      ]
+      permanent_uri = URI(permanent_uri_parts.join("/"))
+      permanent_uri.fragment = determine_fragment(start_line_number, end_line_number)
+      return permanent_uri
+    end
+
+    private
+
+    def run_command(*args, **kwargs)
+      stdout, status = *Open3.capture2(*args, **kwargs)
+      if !status.success?
+        raise "failure to run command: args=#{args.inspect} kwargs=#{kwargs.inspect}"
+      end
+      return stdout
+    end
+
+    def determine_relative_path(path)
+      stdout = run_command("git rev-parse --show-toplevel", chdir: path.dirname)
+      repository_top_path = Pathname(stdout.chomp)
+      relative_path = path.relative_path_from(repository_top_path)
+      return relative_path
+    end
+
+    def determine_repository_uri(path)
+      stdout = run_command("git remote get-url origin", chdir: path.dirname)
+      repository_http_or_ssh_url = stdout.chomp
+
+      md = %r{\Agit@github\.com:(?<account_name>[^/]+)/(?<repository_name>.+)(?=\.git)}.match(repository_http_or_ssh_url)
+      if !md
+        return URI(repository_http_or_ssh_url)
+      end
+
+      md => {account_name:, repository_name:}
+      url = GITHUB_REPOSITORY_URI_TEMPLATE % {account_name:, repository_name:}
+      URI(url)
+    end
+
+    def determine_commit_id(path)
+      stdout = run_command("git rev-parse HEAD", chdir: path.dirname)
+      commit_id = stdout.chomp
+      return commit_id
+    end
+
+    def find_same_content_version(path, relative_path_from_repository_root)
+      stdout = run_command(*%w[git tag --list [0-9]* v[0-9]*], chdir: path.dirname)
+      versions = stdout.each_line(chomp: true).sort_by { |v|
+        comparable_version =
+          v.sub(/\Av/, "").
+            gsub(/[_@]+/, ".") # https://github.com/ruby/ruby/tree/v1_8_5_55%4013008
+        Gem::Version.new(comparable_version)
+      }
+
+      content_in_head = path.read
+      same_content_version = versions.reverse_each.find { |version|
+        content_in_version, _status = *Open3.capture2(*%W[git show #{version}:#{relative_path_from_repository_root}], chdir: path.dirname, err: "/dev/null")
+        content_in_head == content_in_version
+      }
+      return same_content_version
+    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 "L#{start_line_number}-L#{end_line_number}"
+    end
+  end
+end

data/sig/dpu.rbs

@@ -0,0 +1,4 @@
+module Dpu
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: dpu
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yuya.Nishida.
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-05-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- yuya@j96.org
+executables:
+- dpu
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/dpu
+- lib/dpu.rb
+- lib/dpu/cli.rb
+- lib/dpu/version.rb
+- sig/dpu.rbs
+homepage: https://github.com/nishidayuya/dpu
+licenses: []
+metadata:
+  homepage_uri: https://github.com/nishidayuya/dpu
+  source_code_uri: https://github.com/nishidayuya/dpu
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key: 
+specification_version: 4
+summary: determine permanent URI
+test_files: []