gem-clone 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88c04c0a3f92b224d8cf69412f3a93c6daeb829bc89749dd712874e88bd86531
-  data.tar.gz: f50157ba3e8559bfe70903f08c5804451eea29b015dc1b9aa9c4e895bc50aef3
+  metadata.gz: f10b5ead51ab522bd8575ce4d75a262dbfc1c92e190207d1101631bb76a24366
+  data.tar.gz: db822b7b07fbcb6ec522c667cc90829d70c6fcd93b18bedd8591971d7cadc2b1
 SHA512:
-  metadata.gz: c025fe44200548cc80821344aa8e930a71ef8b4bdea7001f2fb1ef7b5833e3694774803524f71b29a13b9c66e0d84f6b1e738463cf05c872d6fb179378e8f404
-  data.tar.gz: 513e70c10abe50e0655dbf065672bb36564648567dc1086e6d72abc0203b91d37ee731e0ba896077762366cf137e84ad51123c7e4828da40fb24f9a99a27fc4f
+  metadata.gz: 1c897ef52329cfbbaae20e125d630a142d849cade5d2cfcf52c901aa91a118f63bd27fa9661f8fc8a849978281cab629fefdc7a6b436f18500030a93dc8818fe
+  data.tar.gz: 864e09fd30b7a65ae23b4162bc226c9806d69e3820562600e900a0f1627be5573a9c7f6c8a1903641941e0b3521b3be97cf55e55cbaff730b5a3d9142ece4a70

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,185 @@ $ 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
+
+The plugin automatically normalizes repository URLs by removing common Git hosting service paths:
+
+- `/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)
+
+**Example:**
+- `https://github.com/rails/rails/tree/v8.0.2` → `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

@@ -6,7 +6,7 @@ require 'open3'
 
 class Gem::Commands::CloneCommand < Gem::Command
   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 +24,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
@@ -108,12 +108,14 @@ Examples:
   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,8 +132,23 @@ Examples:
     end
   end
 
+  def clone_with_git_goget(url)
+    command = "git goget #{url}"
+    say "Executing: #{command}" if options[:verbose]
+
+    system(command)
+
+    if $?.success?
+      say "Successfully cloned repository: #{url}"
+    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 "git goget not found, falling back to ghq" if options[:verbose]
     say "Executing: #{command}" if options[:verbose]
 
     system(command)

metadata

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