Git Product home page Git Product logo

gem_dependencies_visualizer's Introduction

GemDependenciesVisualizer

Installation

Add this line to your application's Gemfile:

gem 'gem_dependencies_visualizer'

And then execute:

$ bundle

Or install it yourself as:

$ gem install gem_dependencies_visualizer

Usage

To produce a graph of your gem dependencies, pass the content of a Gemfile.lock and, if available, the content of the Gemfile as is as an input to the visualizer. For gems, you can also use a different method to pass the gemspec and your Gemfile.lock content. You can (optionaly) pass a graph name you might want to give to the .png file to be produced.

To use it just run the following in your code:

GemDependenciesVisualizer.produce_gems_graph(gemfile_content, gemfile_lock_content, graph_name, options = {})
GemDependenciesVisualizer.produce_gems_graph_from_gemspec(gemspec_file_content, gemfile_lock_content, graph_name, options = {})

Available options you could use are:

  • :graph_direction, which will set how your graph will be produced with options ** top-bottom, for the graph to start on the top towards the bottom ** bottom-top, for the graph to start on the bottom towards the top ** right-left, for the graph to start on the left towards the right ** anything else is set to default, which is left to right.
  • :keep_gem_version, which will keep the versions set in the Gemfile.lock
  • :specific_directory, which will mark the folder in which the graphs should be rendered. All graphs are always created inside gem_dependencies_graphs folder. Default namespace used is app/assets/images.

For example by using the produced Gemfile.lock in this gem, we can get the following:

Sample produced graph

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. 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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/arcanoid/gem_dependencies_visualizer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

gem_dependencies_visualizer's People

Contributors

arcanoid avatar

Stargazers

L. Papa avatar Lazarus Lazaridis avatar

Watchers

James Cloos avatar  avatar

gem_dependencies_visualizer's Issues

Read through multiple remotes in Gemfile.lock

If the file has more than one remotes it doesn't take them into account. Make sure that the following is properly parsed:

GIT
remote: xxxxxx
revision: xxxxxxx
specs:
gem-1 (x.x.x)

GIT
remote: xxxxxx
revision: xxxxxx
branch: xxxxxx
specs:
gem_2 (x.x.x)

GEM
remote: xxxxxx
remote: xxxxxxx
specs:
xxxxxx (x.x.x)
gem-3 (x.x.x)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.