gem-clone 0.4.1 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88c04c0a3f92b224d8cf69412f3a93c6daeb829bc89749dd712874e88bd86531
-  data.tar.gz: f50157ba3e8559bfe70903f08c5804451eea29b015dc1b9aa9c4e895bc50aef3
+  metadata.gz: 836f42b5a4924b0e9d94246ff6d12bb2f39faa30c51647d8443f75a4f1b98656
+  data.tar.gz: 22c882c0be0897264b54cbf865e9ba234cd7ec05d778ece19431c1158c6e8577
 SHA512:
-  metadata.gz: c025fe44200548cc80821344aa8e930a71ef8b4bdea7001f2fb1ef7b5833e3694774803524f71b29a13b9c66e0d84f6b1e738463cf05c872d6fb179378e8f404
-  data.tar.gz: 513e70c10abe50e0655dbf065672bb36564648567dc1086e6d72abc0203b91d37ee731e0ba896077762366cf137e84ad51123c7e4828da40fb24f9a99a27fc4f
+  metadata.gz: e911bd7cf6c713b46e3e9ca34da2edd34c2af8e6988e308ace4b403d7526a7722abc009f1b8c655f06f0da76fa5522cafffa82bceeaa8a2995dc2e80f1b60500
+  data.tar.gz: fb3c3a11745f66da76dc3db82173d3b01c611e5905578a6f3feeddac926bf8faa4208ca0c39ab95e6f5d2e8a1846ddf8dfdc9b16c3f477e6cd260b8c17a1819b

data/README.md

@@ -1,40 +1,11 @@
-# RubyGems Clone Plugin
+# gem-clone
 
-A RubyGems plugin that allows you to clone gem repositories using `ghq` based on gem metadata.
-
-## Installation
-
-```bash
-gem install gem-clone
-```
-
-Or build and install locally:
-
-```bash
-gem build gem-clone.gemspec
-gem install gem-clone-0.1.0.gem
-```
-
-## Prerequisites
-
-This plugin works best with `ghq` but will automatically fall back to `git clone` if `ghq` is not available.
-
-### Recommended: Install ghq
-
-```bash
-# Install ghq (example for macOS)
-brew install ghq
-
-# Or install via Go
-go install github.com/x-motemen/ghq@latest
-```
-
-### Fallback: Git only
-
-If `ghq` is not installed, the plugin will automatically use `git clone` instead. Make sure `git` is available in your PATH.
+A RubyGems plugin that allows you to clone gem repositories by fetching source code URLs from gem metadata and using `git goget`, `ghq`, or `git clone`.
 
 ## Usage
 
+### Basic Usage
+
 ```bash
 # Clone a gem repository
 gem clone sinatra
@@ -46,38 +17,28 @@ gem clone rails --verbose
 gem clone rails --show-url
 ```
 
-The command will:
-
-1. Fetch gem metadata from RubyGems.org API
-2. Extract repository URL from:
-   - `source_code_uri` metadata
-   - `homepage_uri` (if it looks like a repository URL)
-3. Clone the repository using:
-   - `ghq get` (preferred method if available)
-   - `git clone` (fallback if ghq is not available)
-   - Skip cloning if `--show-url` is specified
-
-## Options
+### Options
 
 - `-v, --verbose`: Show verbose output during execution
 - `-u, --show-url`: Display the repository URL without executing the clone operation
 
-## Examples
+### Examples
 
 ```bash
-# With ghq available
+# With git goget available (preferred)
 $ gem clone sinatra
-Executing: ghq get https://github.com/sinatra/sinatra
+Executing: git goget https://github.com/sinatra/sinatra
 Successfully cloned repository: https://github.com/sinatra/sinatra
 
-# With verbose output
+# Fallback to ghq when git goget is not available
 $ gem clone rails --verbose
 Fetching gem metadata for 'rails'...
 Found repository URL: https://github.com/rails/rails
+git goget not found, falling back to ghq
 Executing: ghq get https://github.com/rails/rails
 Successfully cloned repository: https://github.com/rails/rails
 
-# Fallback to git clone when ghq is not available
+# Fallback to git clone when neither git goget nor ghq is available
 $ gem clone rails --verbose
 Fetching gem metadata for 'rails'...
 Found repository URL: https://github.com/rails/rails
@@ -90,15 +51,193 @@ $ gem clone rails --show-url
 https://github.com/rails/rails
 ```
 
+## Installation
+
+### From RubyGems
+
+```bash
+gem install gem-clone
+```
+
+### From Source
+
+```bash
+git clone https://github.com/hsbt/gem-clone.git
+cd gem-clone
+gem build gem-clone.gemspec
+gem install gem-clone-*.gem
+```
+
+### Prerequisites
+
+This plugin works best with `git goget` but will automatically fall back to `ghq` or `git clone` if `git goget` is not available.
+
+#### Recommended: Install git goget
+
+[git goget](https://github.com/hsbt/git-goget) is a bash script for cloning Git repositories with additional features.
+
+```bash
+# Install git goget from GitHub
+git clone https://github.com/hsbt/git-goget.git
+cd git-goget
+chmod +x git-goget
+# Copy to a directory in your PATH
+cp git-goget /usr/local/bin/
+
+# Or download directly
+curl -o git-goget https://raw.githubusercontent.com/hsbt/git-goget/main/git-goget
+chmod +x git-goget
+cp git-goget /usr/local/bin/
+```
+
+#### Alternative: Install ghq
+
+```bash
+# Install ghq (example for macOS)
+brew install ghq
+
+# Or install via Go
+go install github.com/x-motemen/ghq@latest
+
+# Or download binary from GitHub releases
+# https://github.com/x-motemen/ghq/releases
+```
+
+#### Fallback: Git only
+
+If neither `git goget` nor `ghq` is installed, the plugin will automatically use `git clone` instead. Make sure `git` is available in your PATH.
+
+## Technical Details
+
+### How it works
+
+The plugin performs the following steps:
+
+1. **Fetch gem metadata** from RubyGems.org API (`/api/v1/gems/{gem_name}.json`)
+2. **Extract repository URL** from gem metadata in this priority order:
+   - `source_code_uri` metadata field
+   - `homepage_uri` (if it looks like a repository URL)
+3. **Normalize URL** by removing version-specific paths (e.g., `/tree/v1.0.0`, `/blob/main/README.md`)
+4. **Clone repository** using:
+   - `git goget <url>` (preferred method if available)
+   - `ghq get <url>` (fallback if git goget is not available)
+   - `git clone <url>` (fallback if neither git goget nor ghq is available)
+   - Display URL only if `--show-url` option is specified
+
+### URL Normalization
+
+Gem metadata names the same repository in many shapes, so the plugin folds them to one before cloning. Common Git hosting service paths are removed:
+
+- `/tree/*` → removed (GitHub, GitLab branches/tags)
+- `/blob/*` → removed (GitHub, GitLab file views)
+- `/commits/*` → removed (commit history pages)
+- `/releases/*` → removed (release pages)
+- `/issues/*` → removed (issue pages)
+- `/pull/*` → removed (pull request pages)
+- `/tags/*` → removed (tag pages)
+- `/branches/*` → removed (branch pages)
+
+So is anything else that does not name the repository itself:
+
+- `#fragment` and `?query` → removed
+- `http://` → `https://`
+- `https://www.` → `https://`
+- trailing `/` and `.git` → removed
+
+**Examples:**
+- `https://github.com/rails/rails/tree/v8.0.2` → `https://github.com/rails/rails`
+- `http://www.github.com/rails/rails.git` → `https://github.com/rails/rails`
+
+### Cross-platform Support
+
+The plugin includes cross-platform command detection:
+
+- **Unix/Linux/macOS**: Uses `which` command
+- **Windows**: Uses `where` command
+- **Error handling**: Gracefully handles missing commands
+
+### Supported Repository Hosts
+
+The plugin recognizes repository URLs from:
+
+- GitHub (github.com)
+- GitLab (gitlab.com)
+- Bitbucket (bitbucket.org)
+- Codeberg (codeberg.org)
+- SourceHut (sourcehut.org)
+
+### Requirements
+
+- Ruby >= 2.7.0
+- RubyGems
+- `git goget` (recommended), `ghq` (alternative), or `git` (fallback)
+
 ## Development
 
-After checking out the repo, run tests and build the gem:
+### Setting up the development environment
 
 ```bash
+# Clone the repository
+git clone https://github.com/hsbt/gem-clone.git
+cd gem-clone
+
+# Install dependencies
+bundle install
+
+# Run tests
+bundle exec rake test
+
+# Build the gem
 gem build gem-clone.gemspec
-gem install gem-clone-0.1.0.gem
 ```
 
+### Running Tests
+
+```bash
+# Run all tests
+bundle exec rake test
+
+# Run specific test file
+ruby -Ilib:test test/clone_command_test.rb
+
+# Run with verbose output
+ruby -Ilib:test test/clone_command_test.rb --verbose
+```
+
+### Contributing
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feature/amazing-feature`)
+3. Make your changes and add tests
+4. Run the test suite (`bundle exec rake test`)
+5. Commit your changes (`git commit -am 'Add amazing feature'`)
+6. Push to the branch (`git push origin feature/amazing-feature`)
+7. Open a Pull Request
+
 ## License
 
-The gem is available as open source under the terms of the MIT License.
+This gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+```
+MIT License
+
+Copyright (c) 2024 Hiroshi SHIBATA
+
+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/lib/rubygems/commands/clone_command.rb

@@ -5,8 +5,11 @@ require 'uri'
 require 'open3'
 
 class Gem::Commands::CloneCommand < Gem::Command
+  # git goget answers with this when the repository cannot be reached at all.
+  GOGET_SKIPPED = 3
+
   def initialize
-    super 'clone', 'Clone a gem repository using ghq'
+    super 'clone', 'Clone a gem repository using git goget, ghq, or git'
 
     add_option('-v', '--verbose', 'Show verbose output') do |value, options|
       options[:verbose] = true
@@ -24,8 +27,8 @@ class Gem::Commands::CloneCommand < Gem::Command
   def description # :nodoc:
     <<-EOF
 The clone command fetches gem metadata from RubyGems.org and clones
-the gem's source repository using ghq based on the homepage or
-source_code_uri from the gem's metadata.
+the gem's source repository using git goget (preferred), ghq, or git
+based on the homepage or source_code_uri from the gem's metadata.
 
 Examples:
   gem clone sinatra
@@ -102,18 +105,22 @@ Examples:
   def normalize_repository_url(url)
     return url if url.nil? || url.empty?
 
-    normalized_url = url.gsub(%r{/(tree|blob|commits|releases|issues|pull|tags|branches)/.*$}, '')
+    normalized_url = url.sub(/[#?].*/m, '')
+    normalized_url = normalized_url.sub(%r{\Ahttp://}, 'https://').sub(%r{\Ahttps://www\.}, 'https://')
+    normalized_url = normalized_url.gsub(%r{/(tree|blob|commits|releases|issues|pull|tags|branches)/.*$}, '')
 
-    normalized_url.chomp('/')
+    normalized_url.chomp('/').sub(/\.git\z/, '')
   end
 
   def clone_repository(url)
-    if command_available?('ghq')
+    if command_available?('git-goget')
+      clone_with_git_goget(url)
+    elsif command_available?('ghq')
       clone_with_ghq(url)
     elsif command_available?('git')
       clone_with_git(url)
     else
-      alert_error "Neither 'ghq' nor 'git' is available in your PATH. Please install one of them."
+      alert_error "None of 'git goget', 'ghq', or 'git' is available in your PATH. Please install one of them."
       terminate_interaction 1
     end
   end
@@ -130,11 +137,28 @@ Examples:
     end
   end
 
+  def clone_with_git_goget(url)
+    say "Executing: git goget #{url}" if options[:verbose]
+
+    system("git", "goget", url)
+
+    case $?.exitstatus
+    when 0
+      say "Successfully cloned repository: #{url}"
+    when GOGET_SKIPPED
+      alert_error "Repository is unreachable: #{url}"
+      terminate_interaction 1
+    else
+      alert_error "Failed to clone repository with git goget."
+      terminate_interaction 1
+    end
+  end
+
   def clone_with_ghq(url)
-    command = "ghq get #{url}"
-    say "Executing: #{command}" if options[:verbose]
+    say "git goget not found, falling back to ghq" if options[:verbose]
+    say "Executing: ghq get #{url}" if options[:verbose]
 
-    system(command)
+    system("ghq", "get", url)
 
     if $?.success?
       say "Successfully cloned repository: #{url}"
@@ -145,11 +169,10 @@ Examples:
   end
 
   def clone_with_git(url)
-    command = "git clone #{url}"
     say "ghq not found, falling back to git clone" if options[:verbose]
-    say "Executing: #{command}" if options[:verbose]
+    say "Executing: git clone #{url}" if options[:verbose]
 
-    system(command)
+    system("git", "clone", url)
 
     if $?.success?
       say "Successfully cloned repository: #{url}"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gem-clone
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.3
 platform: ruby
 authors:
 - Hiroshi SHIBATA