get_root 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a35e413a287125eaa15eaf2bd9f4e3e815b5c77335d8367c2980426e9021c4e1
+  data.tar.gz: 5070fd9c13fda1a5c7e785b82a361c888d167a4bcf9ea00fbd2496d2cb2101d9
+SHA512:
+  metadata.gz: 4f113f67cbd872cdc7ff7b5e337f47e58ea2021e33db30b0c5e2728eb560af0aedfbb0f671c4ce9e5adc0e179dbd1f6149faf0a8b448e65da7ef365cdcb6ea32
+  data.tar.gz: 1413b4db180e95bfe8ea0fac419b770ef34be71e243a4ce34f25df70bc71f06e19f2939a9625357c554d178207ae58048728928ee8d67dbe7856df04498ef83b

data/LICENSE

@@ -0,0 +1,25 @@
+MIT License
+===========
+
+Copyright (©) 2020 Utkarsh Gupta <utkarsh@debian.org>
+
+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/README.md

@@ -0,0 +1,65 @@
+# GetRoot
+
+This is essentially written for [RuboCop::Packaging](https://github.com/utkarsh2102/rubocop-packaging)
+to get the root directory of your git repository at runtime.
+
+This **only** works on a git repository. Otherwise this won't work, because it
+essentially looks for the presence of a `.git` directory.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'get_root'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install get_root
+```
+
+## Usage
+
+You can use `get_root` for your project in the following way:
+```ruby
+require 'get_root'
+
+root_path = GetRoot.path  # or GetRoot::path
+```
+
+
+Here's a snippet to see how it runs/behaves:
+```ruby
+irb(main):001:0> require 'get_root'
+=> true
+
+irb(main):002:0> Dir.pwd  # to show the current directory.
+=> "/home/utkarsh/github/rubocop-packaging/spec/rubocop/cop/packaging"
+
+irb(main):003:0> GetRoot.path  # to get the root direcotry of this project
+=> "/home/utkarsh/github/rubocop-packaging"
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then,
+run `rake spec` to run the tests. You can also run `bin/console` for an
+interactive prompt that will allow you to experiment.  
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+As always, bug reports and pull requests are heartily welcomed! 💖  
+This project is intended to be a safe and welcoming space for collaboration.
+
+## License
+`get_root` is available as open-source under the
+[MIT License](https://github.com/utkarsh2102/get_root/blob/master/LICENSE).

data/lib/get_root.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "get_root/version"
+
+module GetRoot # :nodoc:
+  class << self
+    # This method shows the path of the root directory
+    # of a git project.
+    # There, strictly, needs to be a git repository,
+    # otherwise this won't work, because it essentially
+    # looks for the presence of a `.git` directory.
+    def path(count = 0, relative_path = +".", root = nil)
+      if count > 15
+        root = File.expand_path(relative_path)
+        # puts "Assuming root directory to be #{root}. " \
+        #      "Please run the same command from the root directory of the project."
+        return root
+      else
+        if Dir.entries(relative_path).include?(".git")
+          root = File.expand_path(relative_path)
+          return root
+        else
+          relative_path.prepend("../")
+          count += 1
+          path(count, relative_path)
+        end
+      end
+    end
+  end
+end

data/lib/get_root/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module GetRoot
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: get_root
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Utkarsh Gupta
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-packaging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+description: 
+email:
+- utkarsh@debian.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/get_root.rb
+- lib/get_root/version.rb
+homepage: https://github.com/utkarsh2102/get_root
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/utkarsh2102/get_root
+  source_code_uri: https://github.com/utkarsh2102/get_root
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Get the root directory of your git repository.
+test_files: []