git_clone_url 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 44e25b0c0510721a7ef50c79d8161138156edce1
-  data.tar.gz: 711729247df08a80167a0672460ae33cd1e9506e
+  metadata.gz: 7a065062d97efddcc19e9eebf13762f6ee904329
+  data.tar.gz: be75bc3c88635cc581ab860cded7de8de076456e
 SHA512:
-  metadata.gz: a480c6ecb0feff3bd5b31e063fdf7e2e411fbc2bbf823b81da4f94a015ce3363da1b0159b35a181052e2289b6d39ac0b5f4562b83b9cd234003f99ae9ce51b9d
-  data.tar.gz: 619c21ff2fe40fa0b7bfe1c4a4bc1543a12a6232efb7a434bf502132894cabd6ae8f0d94fe80ca54726b1bcea2c4be422dc631b2fdc05b4e158d4cf70f79f4a0
+  metadata.gz: 91cddbb4761db1d19834af49f0a0a1abc9606e19da8ba15361c2745e712863fde138a216ce7ff70758a96728be817a9d1e726aae72e8193207a7da52e843ed18
+  data.tar.gz: 65fd8ccf9d57536e8e41148bea21085d055ecc93618a22f9a5b25f1301fe607bd598607c0b13e8d247fa5e809b402cc763feb2183430ebbc056fa6df6a6b7df9

data/.conventional-changelog.context.js

@@ -0,0 +1,17 @@
+'use strict';
+var execSync = require('child_process').execSync;
+var URI = require('urijs');
+
+var gemspec = JSON.parse(execSync('bundle exec parse-gemspec-cli git_clone_url.gemspec'));
+var homepageUrl = gemspec.homepage;
+var url = new URI(homepageUrl);
+var host = url.protocol() + '://' + url.authority();
+var owner = url.pathname().split('/')[1];
+var repository = url.pathname().split('/')[2];
+
+module.exports = {
+  version: gemspec.version,
+  host: host,
+  owner: owner,
+  repository: repository
+};

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+/node_modules

data/.rubocop.yml

@@ -12,6 +12,3 @@ Metrics/LineLength:
 Style/FileName:
   Exclude:
     - exe/*
-
-Style/RegexpLiteral:
-  MaxSlashes: 0

data/Gemfile

@@ -2,3 +2,7 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in git_clone_url.gemspec
 gemspec
+
+gem 'parse_gemspec-cli'
+gem 'rubocop'
+gem 'yard'

data/README.md

@@ -3,6 +3,15 @@
 [![Gem Version](http://img.shields.io/gem/v/git_clone_url.svg?style=flat)](http://badge.fury.io/rb/git_clone_url)
 [![Build Status](http://img.shields.io/travis/packsaddle/ruby-git_clone_url/master.svg?style=flat)](https://travis-ci.org/packsaddle/ruby-git_clone_url)
 
+> Easy to parse git repository-ish url.
+
+* Parse by [URI.parse](http://ruby-doc.org/stdlib-2.2.3/libdoc/uri/rdoc/URI.html#method-c-parse)
+    * `git://github.com/schacon/ticgit.git`
+    * `https://github.com/schacon/ticgit.git`
+* Parse by [URI::SshGit](https://rubygems.org/gems/uri-ssh_git)
+    * `git@github.com:schacon/ticgit.git`
+
+
 ```ruby
 require 'git_clone_url'
 
@@ -26,6 +35,47 @@ GitCloneUrl.parse(https_url_with_userinfo)
 # host: 'github.com', path: '/schacon/ticgit.git'}
 ```
 
+## Motivation
+
+`URI.parse` and `Addressable::URI.parse`
+can parse https protocol, git protocol and ssh protocol(`ssh://git@github.com...`),
+but they can not parse `git@github.com:foo/bar.git` pattern of ssh protocol.
+
+```ruby
+# URI
+url = URI.parse('git@github.com:schacon/ticgit.git')
+URI::InvalidURIError: bad URI(is not URI?): git@github.com:schacon/ticgit.git
+
+# Addressable
+url = Addressable::URI.parse('git@github.com:schacon/ticgit.git')
+#=> #<Addressable::URI:0x3fedf48fb430 URI:git@github.com:schacon/ticgit.git>
+url.path #=> "schacon/ticgit.git"
+url.scheme #=> "git@github.com"
+
+url.host #=> nil
+url.userinfo #=> nil
+url.user #=> nil
+url.port #=> nil
+```
+
+
+## API
+
+### GitCloneUrl.parse(git_url) -> URI::*
+
+Return `URI` namespaced object.
+E.g. `URI::Generic`, `URI::HTTPS` and `URI::SshGit::Generic`.
+See: [class URI::Generic](http://docs.ruby-lang.org/en/2.2.0/URI/Generic.html), [class URI::HTTPS](http://docs.ruby-lang.org/en/2.2.0/URI/HTTPS.html) and [URI::SshGit](https://github.com/packsaddle/ruby-uri-ssh_git).
+
+
+#### git_url
+
+*Required*
+Type: `string`
+
+Git repository-ish url.
+
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/Rakefile

@@ -8,3 +8,12 @@ Rake::TestTask.new(:test) do |t|
 end
 
 task default: :test
+
+require 'yard'
+require 'yard/rake/yardoc_task'
+DOC_FILES = ['lib/**/*.rb']
+DOC_OPTIONS = ['--debug', '--verbose']
+YARD::Rake::YardocTask.new(:doc) do |t|
+  t.files = DOC_FILES
+  t.options = DOC_OPTIONS if Rake.application.options.trace
+end

data/changelog.md

@@ -0,0 +1,4 @@
+<a name="0.1.1"></a>
+## [0.1.1](https://github.com/packsaddle/ruby-git_clone_url/compare/v0.1.0...v0.1.1) (2015-11-21)
+
+* Add changelog file

data/git_clone_url.gemspec

@@ -16,22 +16,22 @@ Gem::Specification.new do |spec|
 
   spec.files         = \
     `git ls-files -z`
-      .split("\x0")
-      .reject { |f| f.match(%r{^(test|spec|features)/}) }
-      .reject do |f|
-        [
-          '.travis.yml',
-          'circle.yml',
-          '.tachikoma.yml'
-        ].include?(f)
-      end
+    .split("\x0")
+    .reject { |f| f.match(%r{^(test|spec|features)/}) }
+    .reject do |f|
+      [
+        '.travis.yml',
+        'circle.yml',
+        '.tachikoma.yml'
+      ].include?(f)
+    end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'uri-ssh_git'
 
-  spec.add_development_dependency 'bundler', '~> 1.8'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
   spec.add_development_dependency 'test-unit'
 end

data/lib/git_clone_url/version.rb

@@ -1,3 +1,3 @@
 module GitCloneUrl
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/lib/git_clone_url.rb

@@ -4,15 +4,27 @@ require 'uri/ssh_git'
 require 'git_clone_url/version'
 
 module GitCloneUrl
+  # Git clone url
   class << self
+    # @param url [String] git repository-ish url
+    #
+    # @return [URI::Generic] if url starts ssh
+    # @return [URI::HTTPS] if url starts https
+    # @return [URI::SshGit] if url is ssh+git e.g git@example.com:schacon/ticgit.git
     def parse(url)
       ssh_git_url?(url) ? URI::SshGit.parse(url) : URI.parse(url)
     end
 
+    # @param url [String] git repository-ish url
+    #
+    # @return [Boolean] true if url is git via ssh protocol
     def ssh_git_url?(url)
       !generic_url?(url)
     end
 
+    # @param url [String] git repository-ish url
+    #
+    # @return [Boolean] true if url is https, ssh protocol
     def generic_url?(url)
       match = %r{\A(\w*)://}.match(url)
       !match.nil?

data/package.json

@@ -0,0 +1,11 @@
+{
+  "devDependencies": {
+    "conventional-changelog": "0.5.1",
+    "npm-check-updates": "^2.2.3",
+    "urijs": "^1.16.1"
+  },
+  "scripts": {
+    "changelog": "conventional-changelog -i CHANGELOG.md --overwrite --preset angular --context .conventional-changelog.context.js",
+    "ncu": "ncu -u"
+  }
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git_clone_url
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - sanemat
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-03-06 00:00:00.000000000 Z
+date: 2015-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uri-ssh_git
@@ -28,30 +28,30 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
@@ -73,6 +73,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".conventional-changelog.context.js"
 - ".gitignore"
 - ".rubocop.yml"
 - CODE_OF_CONDUCT.md
@@ -82,10 +83,12 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- changelog.md
 - example/simple.rb
 - git_clone_url.gemspec
 - lib/git_clone_url.rb
 - lib/git_clone_url/version.rb
+- package.json
 homepage: https://github.com/packsaddle/ruby-git_clone_url
 licenses:
 - MIT
@@ -106,8 +109,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Parse git clone url
 test_files: []
+has_rdoc: