https://github.com/travelist/dependency_inspector

The inspector for the project dependency
https://github.com/travelist/dependency_inspector

Last synced: 14 days ago
JSON representation

The inspector for the project dependency

• Host: GitHub
• URL: https://github.com/travelist/dependency_inspector
• Owner: travelist
• License: mit
• Created: 2015-10-05T11:11:30.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2015-10-16T13:39:14.000Z (over 9 years ago)
• Last Synced: 2024-04-26T15:20:45.054Z (9 months ago)
• Language: Ruby
• Size: 206 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Dependency Inspector [![Circle CI](https://circleci.com/gh/travelist/dependency_inspector.svg?style=svg)](https://circleci.com/gh/travelist/dependency_inspector) [![Gem Version](https://badge.fury.io/rb/dependency_inspector.svg)](https://badge.fury.io/rb/dependency_inspector) [![License](http://img.shields.io/:license-mit-blue.svg)](http://doge.mit-license.org) 

This gem is for analysing dependencies files such as `Gemfile` and list libraries with their information.

*Currently only `Gemfile` is supported. Others will come to be supported*

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'dependency_inspector'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install dependency_inspector

## Usage

*NOTE: Since this is primitive project, the following usages is not ensured to be consistent for the future versions*

```ruby

# include this gem

require 'dependency_inspector'

```

```ruby

gemfile_filepath = "#{Dir.pwd}/Gemfile"

di = DependencyInspector::RubyGemfile::Dsl.evaluate(gemfile_filepath)

```

> It can handle the text as well

```ruby

gemfile_txt = < "rails"

  p i["downloads"]         # => 54525871

  p i["version"]           # => "4.2.4"

  p i["version_downloads"] # => 359907

  p i["platform"]          # => "ruby"

  p i["authors"]           # => "Dav..."

  p i["info"]              # => "Ruby"

  p i["licenses"]          # => ["MIT"]

  p i["metadata"]          # => {}

  p i["sha"]               # => "1c33de75..."

  p i["project_uri"]       # => "https://rubygems.org/gems/rails"

  p i["gem_uri"]           # => "https://rubygems.org/gems/rails-4.2.4.gem"

  p i["homepage_uri"]      # => "http://www.rubyonrails.org"

  p i["wiki_uri"]          # => "http://wiki.rubyonrails.org"

  p i["documentation_uri"] # => "http://api.rubyonrails.org"

  p i["mailing_list_uri"]  # => "http://groups.google.com/group/rubyonrails-talk"

  p i["source_code_uri"]   # => "http://github.com/rails/rails"

  p i["bug_tracker_uri"]   # => "http://github.com/rails/rails/issues"

  p i["dependencies"]      # => {"development"=>[], "runtime"=>[{"name"=>"actionmailer", "requirements"=>"= 4.2.4"}

end

```

## TODO

* Write test code

* support for other languages and dependency managers

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine

```

bundle exec rake install

```

Do not forget to execute `rubocop` before pushing the changes.

```shell

rubocop

```

## Contributing

1 Fork it ( https://github.com/travelist/dependency-inspector/fork )

2 Create your feature branch 

```shell

git checkout -b my-new-feature

```

3 Commit your changes 

```shell

git commit -am 'Add some feature'

```

4 Push to the branch

```shell

git push origin my-new-feature

```

5 Create a new Pull Request