github_url 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 00dbc7f5bcc97f99d25e08bf39365959e500c7a9
4
+ data.tar.gz: 8bf8551e9eb8f1706ac51a9634331ed99a87924c
5
+ SHA512:
6
+ metadata.gz: 0aaab09f30f4dd78a45aef1b9818e78ae232fd632b358087b910f77e373d6bf8114cef5eba97777f2a3f1b2b90fe3f6b0e76948bfa4bd3918990c31e31d8bb45
7
+ data.tar.gz: 7ae6af3605abc174d113b3c026ceaf33b73c7e0974718d3cb9dee9320ec5ece25b149f6bbc0aa167b333ed3106660006a31524dc9ae8bc7ec024e8724db941f4
data/.gitignore ADDED
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
data/.rubocop.yml ADDED
@@ -0,0 +1,126 @@
1
+ Style/Semicolon:
2
+ Enabled: true
3
+
4
+ Lint/AmbiguousBlockAssociation:
5
+ Enabled: false
6
+
7
+ Lint/AssignmentInCondition:
8
+ Enabled: true
9
+
10
+ Lint/EndAlignment:
11
+ Enabled: true
12
+
13
+ Lint/HandleExceptions:
14
+ Enabled: true
15
+
16
+ Lint/IneffectiveAccessModifier:
17
+ Enabled: true
18
+
19
+ Lint/UselessAccessModifier:
20
+ Enabled: true
21
+
22
+ Lint/RescueException:
23
+ Enabled: true
24
+
25
+ Metrics/AbcSize:
26
+ Enabled: true
27
+ Max: 100
28
+
29
+ Metrics/BlockLength:
30
+ Enabled: true
31
+ Max: 1200
32
+
33
+ Metrics/BlockNesting:
34
+ Enabled: true
35
+ Max: 6
36
+
37
+ Metrics/ClassLength:
38
+ Enabled: true
39
+ Max: 500
40
+
41
+ Metrics/CyclomaticComplexity:
42
+ Enabled: true
43
+ Max: 25
44
+
45
+ Metrics/LineLength:
46
+ Enabled: true
47
+ Max: 70000
48
+
49
+ Metrics/MethodLength:
50
+ Enabled: true
51
+ Max: 100
52
+
53
+ Metrics/ModuleLength:
54
+ Enabled: true
55
+ Max: 500
56
+
57
+ Metrics/ParameterLists:
58
+ Enabled: true
59
+ Max: 6
60
+
61
+ Metrics/PerceivedComplexity:
62
+ Enabled: true
63
+ Max: 26
64
+
65
+ Style/DotPosition:
66
+ EnforcedStyle: trailing
67
+
68
+ Style/MultilineMethodCallIndentation:
69
+ EnforcedStyle: indented_relative_to_receiver
70
+
71
+ Style/SpecialGlobalVars:
72
+ EnforcedStyle: use_perl_names
73
+
74
+ Style/StringLiterals:
75
+ EnforcedStyle: double_quotes
76
+
77
+ Performance/StartWith:
78
+ Enabled: false
79
+
80
+ Performance/TimesMap:
81
+ Enabled: false
82
+
83
+ Security/YAMLLoad:
84
+ Enabled: false
85
+
86
+ Style/AndOr:
87
+ Enabled: false
88
+
89
+ Style/CaseIndentation:
90
+ Enabled: false
91
+
92
+ Style/Documentation:
93
+ Enabled: false
94
+
95
+ Style/EmptyMethod:
96
+ Enabled: false
97
+
98
+ Style/FrozenStringLiteralComment:
99
+ Enabled: false
100
+
101
+ Style/MutableConstant:
102
+ Enabled: false
103
+
104
+ Style/NumericLiteralPrefix:
105
+ Enabled: false
106
+
107
+ Style/NumericLiterals:
108
+ Enabled: false
109
+
110
+ Style/NumericPredicate:
111
+ Enabled: false
112
+
113
+ Style/RedundantParentheses:
114
+ Enabled: false
115
+
116
+ Style/RegexpLiteral:
117
+ Enabled: false
118
+
119
+ Style/UnneededPercentQ:
120
+ Enabled: false
121
+
122
+ Style/VariableName:
123
+ Enabled: true
124
+
125
+ Style/WordArray:
126
+ Enabled: false
data/.travis.yml ADDED
@@ -0,0 +1,5 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.3.0
5
+ before_install: gem install bundler -v 1.15.0
@@ -0,0 +1,74 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at dh1272@nyu.edu. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [http://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: http://contributor-covenant.org
74
+ [version]: http://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source "https://rubygems.org"
2
+
3
+ # Specify your gem's dependencies in github_url.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2017 dizehacioglu
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,84 @@
1
+ # GithubUrl
2
+
3
+ A small ruby gem for parsing Github URLs
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ ```ruby
10
+ gem 'github_url'
11
+ ```
12
+
13
+ And then execute:
14
+
15
+ $ bundle
16
+
17
+ Or install it yourself as:
18
+
19
+ $ gem install github_url
20
+
21
+ ## Usage
22
+
23
+ Initializing a GithubUrl
24
+
25
+ ```ruby
26
+ url = GithubUrl.new('https://github.com/GalvanizeOpenSource/github_url/blob/master/lib/github_url.rb')
27
+ ```
28
+
29
+ Initializing a GithubUrl using a specific branch
30
+
31
+ ```ruby
32
+ url_with_branch = GithubUrl.new('https://github.com/GalvanizeOpenSource/github_url/blob/master/lib/github_url.rb', 'branch-besides-master')
33
+ ```
34
+
35
+ Getting the organization
36
+
37
+ ```ruby
38
+ url.organization
39
+ # GalvanizeOpenSource
40
+ ```
41
+
42
+ Getting the repository
43
+
44
+ ```ruby
45
+ url.repository
46
+ # github_url
47
+ ```
48
+
49
+ Getting the branch (will default to master when initialized)
50
+
51
+ ```ruby
52
+ url.branch
53
+ # master
54
+ ```
55
+
56
+ ```ruby
57
+ url_with_branch.branch
58
+ # branch-besides-master
59
+ ```
60
+
61
+ Getting the path
62
+
63
+ ```ruby
64
+ url.path
65
+ # lib/github_url.rb
66
+ ```
67
+
68
+ ## Development
69
+
70
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
71
+
72
+ To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
73
+
74
+ ## Contributing
75
+
76
+ Bug reports and pull requests are welcome on GitHub at https://github.com/GalvanizeOpenSource/github_url. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
77
+
78
+ ## License
79
+
80
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
81
+
82
+ ## Code of Conduct
83
+
84
+ Everyone interacting in the GithubUrl project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/GalvanizeOpenSource/github_url/blob/master/CODE_OF_CONDUCT.md).
data/Rakefile ADDED
@@ -0,0 +1,10 @@
1
+ require "bundler/gem_tasks"
2
+ require "rake/testtask"
3
+
4
+ Rake::TestTask.new(:test) do |t|
5
+ t.libs << "test"
6
+ t.libs << "lib"
7
+ t.test_files = FileList["test/**/*_test.rb"]
8
+ end
9
+
10
+ task :default => :test
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "github_url"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start(__FILE__)
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,35 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path("../lib", __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require "github_url/version"
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "github_url"
8
+ spec.version = GithubUrl::VERSION
9
+ spec.authors = ["dizehacioglu"]
10
+ spec.email = ["dh1272@nyu.edu"]
11
+
12
+ spec.summary = %q{A small ruby gem for parsing Github URLs}
13
+ spec.homepage = "https://github.com/GalvanizeOpenSource/github_url"
14
+ spec.license = "MIT"
15
+
16
+ # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
17
+ # to allow pushing to a single host or delete this section to allow pushing to any host.
18
+ # if spec.respond_to?(:metadata)
19
+ # spec.metadata["allowed_push_host"] = "https://rubygems.org"
20
+ # else
21
+ # raise "RubyGems 2.0 or newer is required to protect against " \
22
+ # "public gem pushes."
23
+ # end
24
+
25
+ spec.files = `git ls-files -z`.split("\x0").reject do |f|
26
+ f.match(%r{^(test|spec|features)/})
27
+ end
28
+ spec.bindir = "exe"
29
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
30
+ spec.require_paths = ["lib"]
31
+
32
+ spec.add_development_dependency "bundler", "~> 1.15"
33
+ spec.add_development_dependency "rspec", "~> 3.0"
34
+ spec.add_development_dependency "rubocop"
35
+ end
@@ -0,0 +1,3 @@
1
+ class GithubUrl
2
+ VERSION = "0.1.0"
3
+ end
data/lib/github_url.rb ADDED
@@ -0,0 +1,50 @@
1
+ class GithubUrl
2
+ attr_accessor :url, :default_branch
3
+
4
+ GITHUB_HOST = "github.com"
5
+
6
+ class Invalid < StandardError
7
+ end
8
+
9
+ def initialize(url, default_branch = "master")
10
+ @default_branch = default_branch
11
+ @url = url
12
+
13
+ validate_url
14
+ end
15
+
16
+ def organization
17
+ url_path[0]
18
+ end
19
+
20
+ def repository
21
+ url_path[1]
22
+ end
23
+
24
+ def branch
25
+ default_branch? ? @default_branch : url_path[3]
26
+ end
27
+
28
+ def path
29
+ default_branch? ? File.join(url_path[2..-1]) : File.join(url_path[4..-1].to_a)
30
+ end
31
+
32
+ private
33
+
34
+ def default_branch?
35
+ (["blob", "tree", "raw"] & url_path).empty?
36
+ end
37
+
38
+ def validate_url
39
+ raise(Invalid, "Must contain #{GITHUB_HOST}") unless url.split("/").any? { |e| e.include?(GITHUB_HOST) }
40
+ raise(Invalid, "Missing organization") if organization.nil?
41
+ raise(Invalid, "Missing repository") if repository.nil?
42
+ raise(Invalid, "Missing branch") if !default_branch? && url_path[3].nil?
43
+ end
44
+
45
+ def url_path
46
+ url_arr = url.split("/")
47
+ github_index = url_arr.index { |e| e.include?(GITHUB_HOST) }
48
+ url_arr[github_index + 1..-1]
49
+ end
50
+ end
metadata ADDED
@@ -0,0 +1,99 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: github_url
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - dizehacioglu
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2017-06-21 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.15'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.15'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rspec
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '3.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '3.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rubocop
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - ">="
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - ">="
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ description:
56
+ email:
57
+ - dh1272@nyu.edu
58
+ executables: []
59
+ extensions: []
60
+ extra_rdoc_files: []
61
+ files:
62
+ - ".gitignore"
63
+ - ".rubocop.yml"
64
+ - ".travis.yml"
65
+ - CODE_OF_CONDUCT.md
66
+ - Gemfile
67
+ - LICENSE.txt
68
+ - README.md
69
+ - Rakefile
70
+ - bin/console
71
+ - bin/setup
72
+ - github_url.gemspec
73
+ - lib/github_url.rb
74
+ - lib/github_url/version.rb
75
+ homepage: https://github.com/GalvanizeOpenSource/github_url
76
+ licenses:
77
+ - MIT
78
+ metadata: {}
79
+ post_install_message:
80
+ rdoc_options: []
81
+ require_paths:
82
+ - lib
83
+ required_ruby_version: !ruby/object:Gem::Requirement
84
+ requirements:
85
+ - - ">="
86
+ - !ruby/object:Gem::Version
87
+ version: '0'
88
+ required_rubygems_version: !ruby/object:Gem::Requirement
89
+ requirements:
90
+ - - ">="
91
+ - !ruby/object:Gem::Version
92
+ version: '0'
93
+ requirements: []
94
+ rubyforge_project:
95
+ rubygems_version: 2.6.12
96
+ signing_key:
97
+ specification_version: 4
98
+ summary: A small ruby gem for parsing Github URLs
99
+ test_files: []