polariscope 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '012182ad9b21b397a1b59d91c199bef8a751baa727c0a3d95703dd0df13ee3d2'
-  data.tar.gz: fa12186f4461ba71e1a9d252c4115fd009f006e3abca2b0ab957bf9862140e89
+  metadata.gz: bbffdce0784ea9e04a8a70ce76826f2a4585509bdf458a993c7f8d433ef4c8cd
+  data.tar.gz: 5a8fd12fb706744204fd96052716df30b595bf636c2a33d795c48fbd76554286
 SHA512:
-  metadata.gz: 8a25dd7a42b93ff2081b7042fbae6c3f65c769933ad1792f345913c84b9c7daafc735f2a92e0a8e1d5c6d79fe46f481b8e227dac3afcfc54034778ab04a7ac1f
-  data.tar.gz: 4d9acf916ef3a6ffdc51dd234e3f5dded843d726103320eeddea02a8da7b828803bae605f1fc3cd8aa6331daf58aa8faf6a2e62bfc36185b0487b39d88d01352
+  metadata.gz: 6ac88021029fbe6c211fd361b4c08ba1bd7c15c8f3d18d6626d33db6f340c3f227a4420dd65a8eb88e0aae492e9b225065d77304b6ebf311d8e1f4fda2bea8eb
+  data.tar.gz: 3003407cde63e74bead70bb722482ee06da18f539e38cea0e900d2bde6e1f7d1aaf14166d7acaf3921b20248f79144e81afc1da94abfeaf71aeb0bf5a9a0e14c

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [0.1.1] - 2024-08-08
+
+- Make **spec_type** optional in `.gem_versions`
+- Add readme
+
 ## [0.1.0] - 2024-08-07
 
 - Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    polariscope (0.1.0)
+    polariscope (0.1.1)
       bundler
       bundler-audit
 

data/README.md

@@ -1,24 +1,81 @@
 # Polariscope
 
-TODO: Delete this and the text below, and describe your gem
+Polariscope is a Ruby gem designed to evaluate the overall health of your Ruby application by analyzing its dependencies. It calculates a health score based on how many dependencies are outdated, meaning there are newer versions available. Keeping dependencies up-to-date is crucial for maintaining application security, performance, and compatibility. This gem provides a quick and easy way to gauge the state of your project's dependencies and take proactive measures to improve its health.
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/polariscope`. To experiment with that code, run `bin/console` for an interactive prompt.
+### Health Score Algorithm
 
-## Installation
+The health score calculation is based on the following mathematical formula:
+
+![Health Score Algorithm](docs/algorithm.png)
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+## Installation
 
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+    $ bundle add polariscope
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+    $ gem install polariscope
+
+### Known issue
+
+If your default Ruby version is 3.1.2, you might get this error when installing polariscope:
+
+```bash
+.rbenv/versions/3.1.2/lib/ruby/gems/3.1.0/gems/rdoc-6.7.0/lib/rdoc/version.rb:8: warning: already initialized constant RDoc::VERSION
+ERROR:  While executing gem ... (NameError)
+    uninitialized constant RDoc::Markdown
+
+    'markdown' => RDoc::Markdown,
+                      ^^^^^^^^^^
+```
+
+You can ignore this error. It doesn't occur in other Ruby versions and it doesn't prevent you from using polariscope.
 
 ## Usage
 
-TODO: Write usage instructions here
+Polariscope can be used in 2 ways.
+
+### CLI
+
+Position yourself in a Ruby application and run:
+
+```bash
+polariscope scan
+```
+
+### IRB / Rails
+
+```ruby
+Polariscope.scan
+```
+
+The return value will indicate how healthy your project is on a scale from 0 to 100.
+
+#### Additional features
+
+##### Score color
+
+Get the score color for a score:
+
+```ruby
+Polariscope.score_color(60.75)
+```
+
+##### Gem versions
+
+Get the released or latest version of gems with:
+
+```ruby
+# released versions
+gem_specs = Polariscope.gem_versions(['gem_name_1', 'gem_name_2'])
+gem_specs.versions_for('gem_name_1') # => returns potentially many versions
+
+# latest version
+gem_specs = Polariscope.gem_versions(['gem_name_1', 'gem_name_2'], spec_type: :latest)
+gem_specs.versions_for('gem_name_1') # => returns latest version
+```
 
 ## Development
 
@@ -28,7 +85,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/polariscope.
+Bug reports and pull requests are welcome on GitHub at https://github.com/infinum/polariscope.
 
 ## License
 

data/lib/polariscope/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Polariscope
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/lib/polariscope.rb

@@ -22,7 +22,7 @@ module Polariscope
       Color::Hsl.for(score)
     end
 
-    def gem_versions(dependency_names, spec_type:)
+    def gem_versions(dependency_names, spec_type: :released)
       Scanner::GemVersions.new(dependency_names, spec_type: spec_type)
     end
   end

data/polariscope.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.authors = ['Rails team']
   spec.email = ['team.rails@infinum.com']
 
-  spec.summary = 'Tool for determining the health of a project based on the state of dependencies'
+  spec.summary = 'Calculate the health score of a Ruby application based on the state of its dependencies'
   spec.homepage = 'https://github.com/infinum/polariscope'
   spec.license = 'MIT'
   spec.required_ruby_version = '>= 3.0.0'
@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(__dir__) do
     `git ls-files -z`.split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features|sig)/|\.(?:git|circleci)|appveyor)})
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features|sig|docs)/|\.(?:git|circleci)|appveyor)})
     end + Dir['exe/polariscope'] + Dir['lib/**/*']
   end
   spec.bindir = 'exe'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: polariscope
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Rails team
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-07 00:00:00.000000000 Z
+date: 2024-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -92,5 +92,6 @@ requirements: []
 rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
-summary: Tool for determining the health of a project based on the state of dependencies
+summary: Calculate the health score of a Ruby application based on the state of its
+  dependencies
 test_files: []