uri-ssh_git 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9facd61c5f6b68e85e35b2dd61020b9af938a50c
-  data.tar.gz: cca70a7dd3fc346010500a4dd6c1c9750805bce6
+  metadata.gz: b1ae937932e3032acced4570e84110b5e6d91b01
+  data.tar.gz: a21a548f080ed6853cbf62b96c9235cff2a57636
 SHA512:
-  metadata.gz: 0dbf5ad7bcd4fb6873b41907b5f2ef1355351369261fa65c9b81309b783583938ffab83c0d7c62dd3c0ff72ce7b58d1c7707f1bdc73951aa921dccd9322cfc3b
-  data.tar.gz: f887deb4d55c63bb00495b712b3aa8ff8ddd628e282e63373ae5e2ddc64d4df08ffcc21b0e833c60ea46c184c89d0258e474f94713bde90487c60076c6f33cf2
+  metadata.gz: e718ee0423b176b4dd7e5a0809632857dee1cf60c523fc9c286e2b79c426a4fd4f39e68cb0ace4d523d962bd2fb708c1f106494b99d2ffeba5cb293f695ae77d
+  data.tar.gz: 2176ab180ede97531ee08ae4074b00a7a7739f8cfc62212d17721df05c10db2e667a09137475910d21fe11b1c053857b5b0c54eac934b5166febf0a7a9279c8f

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 uri-ssh_git.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,5 +2,9 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in uri-ssh_git.gemspec
 gemspec
+
 gem 'byebug' if RUBY_VERSION >= '2.0.0'
+gem 'parse_gemspec-cli'
 gem 'pry'
+gem 'rubocop'
+gem 'yard'

data/README.md

@@ -3,7 +3,14 @@
 [![Gem Version](http://img.shields.io/gem/v/uri-ssh_git.svg?style=flat)](http://badge.fury.io/rb/uri-ssh_git)
 [![Build Status](http://img.shields.io/travis/packsaddle/ruby-uri-ssh_git/master.svg?style=flat)](https://travis-ci.org/packsaddle/ruby-uri-ssh_git)
 
+> Parse and build git repository url via ssh protocol.
+
+See: [Popular use case packsaddle/ruby-git_clone_url](https://github.com/packsaddle/ruby-git_clone_url)
+
+
 ```ruby
+require 'uri/ssh_git'
+
 url = URI::SshGit.parse('git@github.com:packsaddle/ruby-uri-ssh_git.git')
 # => #<URI::SshGit::Generic git@github.com:packsaddle/ruby-uri-ssh_git.git>
 
@@ -21,7 +28,7 @@ url.opaque #=> nil
 url.query #=> nil
 url.fragment #=> nil
 
-URI::SshGit.build(
+URI::SshGit::Generic.build(
   userinfo: 'git',
   host: 'github.com',
   path: '/packsaddle/ruby-uri-ssh_git.git'
@@ -48,6 +55,7 @@ url.user #=> nil
 url.port #=> nil
 ```
 
+
 ## 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.2"></a>
+## [0.1.2](https://github.com/packsaddle/ruby-uri-ssh_git/compare/v0.1.1...v0.1.2) (2015-11-21)
+
+* Add documentation.

data/lib/uri/ssh_git.rb

@@ -4,7 +4,29 @@ require 'uri/ssh_git/generic'
 require 'uri/ssh_git/version'
 
 module URI
+  # Parse and build git repository url via ssh protocol.
   module SshGit
+    # @example
+    #   url = URI::SshGit.parse('git@github.com:packsaddle/ruby-uri-ssh_git.git')
+    #   #=> #<URI::SshGit::Generic git@github.com:packsaddle/ruby-uri-ssh_git.git>
+    #
+    #   url.scheme #=> nil
+    #   url.userinfo #=> 'git'
+    #   url.user #=> 'git'
+    #   url.password #=> nil
+    #   url.host #=> 'github.com'
+    #   url.port #=> nil
+    #   url.registry #=> nil
+    #   url.path #=> '/packsaddle/ruby-uri-ssh_git.git'
+    #   url.opaque #=> nil
+    #   url.query #=> nil
+    #   url.fragment #=> nil
+    #
+    # @see http://docs.ruby-lang.org/en/2.2.0/URI/Generic.html
+    #
+    # @param url [String] git repository url via ssh protocol
+    #
+    # @return [Generic] parsed object
     def self.parse(uri_string)
       host_part, path_part = uri_string.split(':', 2)
       userinfo, host = host_part.split('@', 2)

data/lib/uri/ssh_git/generic.rb

@@ -1,6 +1,16 @@
 module URI
   module SshGit
+    # @see http://docs.ruby-lang.org/en/2.2.0/URI/Generic.html
     class Generic < ::URI::Generic
+      # @example
+      #   Generic.build(
+      #     userinfo: 'git',
+      #     host: 'github.com',
+      #     path: '/packsaddle/ruby-uri-ssh_git.git'
+      #   ).to_s
+      #   #=> 'git@github.com:packsaddle/ruby-uri-ssh_git.git'
+      #
+      # @return [String] git repository url via ssh protocol
       def to_s
         show_path = path.slice(1..-1) if path.start_with?('/')
         "#{user}@#{host}:#{show_path}"

data/lib/uri/ssh_git/version.rb

@@ -1,5 +1,5 @@
 module URI
   module SshGit
-    VERSION = '0.1.1'
+    VERSION = '0.1.2'
   end
 end

data/package.json

@@ -0,0 +1,11 @@
+{
+  "devDependencies": {
+    "conventional-changelog": "0.4.3",
+    "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"
+  }
+}

data/uri-ssh_git.gemspec

@@ -16,20 +16,20 @@ 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_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

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: uri-ssh_git
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - sanemat
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-03-05 00:00:00.000000000 Z
+date: 2015-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   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
@@ -59,6 +59,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".conventional-changelog.context.js"
 - ".gitignore"
 - ".rubocop.yml"
 - CODE_OF_CONDUCT.md
@@ -68,10 +69,12 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- changelog.md
 - example/simple.rb
 - lib/uri/ssh_git.rb
 - lib/uri/ssh_git/generic.rb
 - lib/uri/ssh_git/version.rb
+- package.json
 - uri-ssh_git.gemspec
 homepage: https://github.com/packsaddle/ruby-uri-ssh_git
 licenses:
@@ -93,8 +96,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 and build ssh format url
 test_files: []
+has_rdoc: