gem-insight

Gem::Insight

GemInsight is a Ruby gem that provides insights into the gems listed in a Rails application's Gemfile. It fetches details about each gem from the RubyGems API and displays them in an organized manner.

Installation

Add this line to your application's Gemfile::

$ gem 'gem-insight'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install gem-insight

Usage

GemInsight is designed to be used as a Rails Engine gem. After adding the gem to your Gemfile and running bundle install, you can access the GemInsight dashboard at http://localhost:3000/gem-insight (assuming your Rails server is running on the default port).

The dashboard will display a table containing details about each gem listed in your Gemfile. The details include the gem's name, current version, latest available version, recent release date, compatibility, documentation URL, GitHub repository, rubygem URL and changelog.

Once you've installed and included the GemInsight gem in your Rails application, you can directly visit the dashboard URL(/gem-insight) to view the gem details.

Features

• Fetches gem details from the RubyGems API
• Displays gem details in a user-friendly dashboard
• Organizes gem information in a tabular format
• Handles errors gracefully in case of API fetch failures
• Provides insights into the gems used in your Rails application
• Provides one-click gem management, allowing users to upgrade, downgrade, or remove gems effortlessly.

Geminsight Dashboard

Upgrade Gem

Downgrade Gem

Remove Gem

Development

• Clone the GemInsight repository to your local machine.
• Install the required gem dependencies using bundle install.
• Run tests to ensure the gem's functionality is maintained.
• Use the included dummy Rails application to test the gem in a real-world scenario.
• Create a new branch for your changes and make desired code modifications.
• Run tests again to ensure everything is functioning correctly after your changes.
• Adhere to the Ruby Style Guide for consistent code formatting.
• Report bugs and suggest new features by opening an issue on the GitHub repository.
• Follow Semantic Versioning for versioning.
• Encourage community engagement and contributions to the project.

Contributing

Contributions are welcome! If you find a bug or want to suggest an enhancement, please open an issue on GitHub. If you want to contribute code, fork the repository, create a new branch, and submit a pull reques

License

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

Code of Conduct

Everyone interacting in the Gem::Insight project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.