next_rails 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 822e7ed8bda705fc5a9ff1a0f8ccbba91901e01dd279760e7787a7ef1df3f38f
-  data.tar.gz: fd6e3bb66afd86c54fba7e5352245ada2f3ec0520cd88063d11a938d908a4d90
+  metadata.gz: ceb25dba1847fdd6aa7b71ea2dacac03a90e16cf855e59d6a92cb6855c9124f6
+  data.tar.gz: 48c1a8bc8a02a2d717bb0da75c5145881ec96c0da6953309867238299d8f76b6
 SHA512:
-  metadata.gz: 2da9a58d3922e7d266bc9769a5cfdfee57e1e5d21c2d31be9ff5f3b6b8c109e08b94dfb34eb894d516906921edcddafb5a26b42aab82f3c2f16344820877d133
-  data.tar.gz: e8886320ac2047e9d83d4c6fd67aaccf14b9aa735102dc4eb2755e78cb2dbe359f221ae768ab5c9e2eba44731ba91222e370ff4bea4bee5cbad966e0b5ac2678
+  metadata.gz: afe58b7bc957ceed1c2c1ead4fe64059e4657dcbab249ecd35138f90d3e335987ea6759590679009dee64b9eb8178a28ee030ad13a744ae082348e19f82cc0ff
+  data.tar.gz: 00c6a32d28b7cb6836ee99246d6a92829d6a450753ad379ecf493015d809888790204e85ba55ac9c0c22c6ce30531422bbf646f7b5bea695c4193e47544c9c07

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -6,46 +6,32 @@ labels: bug
 assignees: ""
 ---
 
-**IMPORTANT: please make sure you ask yourself all intro questions and fill all sections of the template.**
+<!--- Before creating a bug report, please, answer the following questions -->
+<!--- Did you check the documentation for answers? -->
+<!--- Did you make sure that this bug has not already been reported? -->
 
-**Before we start...:**
+## Expected Behavior
+<!--- Tell us what should happen -->
+<!--- For example: When I [do X], it should [produce Y] -->
 
-- [ ] I checked the documentation and found no answer
-- [ ] I checked to make sure that this issue has not already been filed
-- [ ] I'm reporting the issue to the correct repository (for multi-repository projects)
+## Actual Behavior
+<!--- Tell us what happens instead -->
+<!--- For example: When I [did X], it [produced Y] -->
 
-**Version, Branch, or Commit:**
+## Possible Fix
+<!--- Optionally suggest a fix or work around -->
 
-What branch/commit/version of "next_rails" you are using?
+## To Reproduce
+<!--- Optionally provide a link to a live example -->
 
-**Expected behavior:**
+<!--- Otherwise, please provide a set of reproduction steps -->
+1.
+2.
+3.
+4.
 
-Please include a detailed description of the behavior you were expecting when you encountered this issue.
-
-**Actual behavior:**
-
-Please include a detailed description of the actual behavior of the application.
-
-**Steps to reproduce:**
-
-How do I achieve this behavior? Use the following format to provide a step-by-step guide:
-
-1. Step 1: ...
-2. Step 2: ...
-
-**Context and environment:**
-
-Provide any relevant information about your setup (Customize the list accordingly based on what info is relevant to this project)
-
-1. Version of the software the issue is being opened for.
-2. Operating System
-3. Operating System version
-4. Ruby version
-
-_Delete any information that is not relevant._
-
-**Logs**
-
-Include relevant log snippets or files here.
+## Additional Information
+<!--- Include any relevant details about your environment (branch, browser, OS) -->
+<!--- and the bug (screenshots, logs, etc) -->
 
 **I will abide by the [code of conduct](https://github.com/fastruby/next_rails/blob/main/CODE_OF_CONDUCT.md)**

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -6,35 +6,18 @@ labels: enhancement
 assignees: ""
 ---
 
-**IMPORTANT: please make sure you ask yourself all intro questions and fill all sections of the template.**
+<!--- Before creating a feature request, please, answer the following questions -->
+<!--- Did you check the documentation for this feature? -->
+<!--- Did you make sure that this feature has not already been requested? -->
 
-**Before we start...:**
+## Description
+<!--- Provide a description of the change or addition you are proposing -->
 
-- [ ] I checked the documentation and didn't find this feature
-- [ ] I checked to make sure that this feature has not already been requested
+## Possible Implementation
+<!--- Optionally suggest an idea to implement or a workaround to fix the issue -->
 
-**Branch/Commit:**
-
-Inform what branch/commit/version of "next_rails" you are using.
-
-**Describe the feature:**
-
-Please include a detailed description of the feature you are requesting and any detail on it’s expected behavior.
-
-> **As a \<role name\>** > **I do \<something\>** > **And then I do \<another action\>** > **And I see \<some result\>**
-
-**Problem:**
-
-Please include a detailed description of the problem this feature would solve.
-
-> **As a \<role name\>** > **I want to \<do something\>** > **So that I can achieve a \<goal\>**
-
-**Mockups:**
-
-Include any mockup idea related to the requested feature if it applies.
-
-**Resources:**
-
-If you have resources related to the implementation or research for this feature, add them here.
+## Resources:
+<!--- If you have resources related to the implementation or research for this feature, add them here. -->
+<!--- If possible, include any mockup ideas related to the requested feature. -->
 
 **I will abide by the [code of conduct](https://github.com/fastruby/next_rails/blob/main/CODE_OF_CONDUCT.md)**

data/CHANGELOG.md

@@ -1,4 +1,9 @@
-# main [(unreleased)](https://github.com/fastruby/next_rails/compare/v1.2.1...main)
+# main [(unreleased)](https://github.com/fastruby/next_rails/compare/v1.2.2...main)
+* Your changes/patches go here.
+# v1.2.2 / 2023-03-03 [(commits)](https://github.com/fastruby/next_rails/compare/v1.2.1...v1.2.2)
+* [BUGFIX: Fixed `KernelWarnTracker#warn signature to match `Kernel#warn` for ruby 2.5+](https://github.com/fastruby/next_rails/pull/82)
+* [CHORE: Added updated templates for bug fixes, feature requests and pull requests](https://github.com/fastruby/next_rails/pull/64) as per [this RFC](https://github.com/fastruby/RFCs/blob/main/2021-10-13-github-templates.md)
+* [FEATURE: Turn BundleReport into a module](https://github.com/fastruby/next_rails/pull/63)
 
 # v1.2.1 / 2022-09-26 [(commits)](https://github.com/fastruby/next_rails/compare/v1.2.0...v1.2.1)
 
@@ -8,6 +13,8 @@
 
 - [BUGFIX: bundle_report outdated was giving an exception due to missing method latest_version](https://github.com/fastruby/next_rails/pull/62)
 
+- [FEATURE: `bundle_report outdated` outputs in JSON format when passed optional argument](https://github.com/fastruby/next_rails/pull/61)
+
 # v1.2.0 / 2022-08-12 [(commits)](https://github.com/fastruby/next_rails/compare/v1.1.0...v1.2.0)
 
 - [FEATURE: Support Ruby versions as old as Ruby 2.0](https://github.com/fastruby/next_rails/pull/54)

data/README.md

@@ -29,10 +29,17 @@ Learn about your Gemfile and see what needs updating.
 ```bash
 # Show all out-of-date gems
 bundle_report outdated
+
 # Show five oldest, out-of-date gems
 bundle_report outdated | head -n 5
+
+# Show all out-of-date gems in machine readable JSON format
+bundle_report outdated --json
+
 # Show gems that don't work with Rails 5.2.0
 bundle_report compatibility --rails-version=5.2.0
+
+# Show the usual help message
 bundle_report --help
 # Find minimum compatible ruby version with Rails 7.0.0
 bundle_report ruby_check --rails-version=7.0.0
@@ -91,7 +98,7 @@ deprecations run
 deprecations --help # For more options and examples
 ```
 
-Right now, the path to the shitlist is hardcoded so make sure you store yours at `spec/support/deprecations.shitlist.json`.
+Right now, the path to the shitlist is hardcoded so make sure you store yours at `spec/support/deprecation_warning.shitlist.json`.
 
 #### `next_rails` command
 
@@ -115,7 +122,9 @@ next rails s        # Start server using Gemfile.next
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your application's Gemfile
+
+> NOTE: If you add this gem to a group, make sure it is the test env group
 
 ```ruby
 gem 'next_rails'

data/exe/bundle_report

@@ -17,6 +17,7 @@ at_exit do
       Examples:
         #{$0} compatibility --rails-version 5.0
         #{$0} outdated
+        #{$0} outdated --json
 
       ruby_check To find a compatible ruby version for the target rails version
 
@@ -36,6 +37,10 @@ at_exit do
       options[:include_rails_gems] = true
     end
 
+    opts.on("--json", "Output JSON in outdated report (defaults to false)") do
+      options[:format] = 'json'
+    end
+
     opts.on_tail("-h", "--help", "Show this message") do
       puts opts
       exit
@@ -54,7 +59,7 @@ at_exit do
 
   case report_type
   when "ruby_check" then NextRails::BundleReport.compatible_ruby_version(rails_version: options.fetch(:rails_version))
-  when "outdated" then NextRails::BundleReport.outdated
+  when "outdated" then NextRails::BundleReport.outdated(options.fetch(:format, nil))
   else
     NextRails::BundleReport.compatibility(rails_version: options.fetch(:rails_version, "5.0"), include_rails_gems: options.fetch(:include_rails_gems, false))
   end

data/lib/deprecation_tracker.rb

@@ -18,12 +18,16 @@ class DeprecationTracker
       @callbacks ||= []
     end
 
-    def warn(*messages)
+    def warn(*messages, uplevel: nil)
       KernelWarnTracker.callbacks.each do |callback|
         messages.each { |message| callback.(message) }
       end
 
-      super
+      if Gem::Version.new(RUBY_VERSION) < Gem::Version.new("2.5.0")
+        super *messages
+      else
+        super
+      end
     end
   end
 

data/lib/next_rails/bundle_report.rb

@@ -5,8 +5,10 @@ require "json"
 require "net/http"
 
 module NextRails
-  class BundleReport
-    def self.compatibility(rails_version: nil, include_rails_gems: nil)
+  module BundleReport
+    extend self
+
+    def compatibility(rails_version: nil, include_rails_gems: nil)
       incompatible_gems = NextRails::GemInfo.all.reject do |gem|
         gem.compatible_with_rails?(rails_version: rails_version) || (!include_rails_gems && gem.from_rails?)
       end.sort_by { |gem| gem.name }
@@ -50,13 +52,13 @@ module NextRails
       puts ERB.new(template, nil, "-").result(binding)
     end
 
-    def self.gem_header(_gem)
+    def gem_header(_gem)
       header = "#{_gem.name} #{_gem.version}".bold
       header << " (loaded from git)".magenta if _gem.sourced_from_git?
       header
     end
 
-    def self.compatible_ruby_version(rails_version)
+    def compatible_ruby_version(rails_version)
       # find all the versions of rails gem
       uri = URI('https://rubygems.org/api/v1/versions/rails.json')
       res = Net::HTTP.get_response(uri)
@@ -95,25 +97,62 @@ module NextRails
       end
     end
 
-    def self.outdated
+    def outdated(format = nil)
       gems = NextRails::GemInfo.all
       out_of_date_gems = gems.reject(&:up_to_date?).sort_by(&:created_at)
-      percentage_out_of_date = ((out_of_date_gems.count / gems.count.to_f) * 100).round
       sourced_from_git = gems.select(&:sourced_from_git?)
 
-      out_of_date_gems.each do |_gem|
-        header = "#{_gem.name} #{_gem.version}"
+      if format == 'json'
+        output_to_json(out_of_date_gems, gems.count, sourced_from_git.count)
+      else
+        output_to_stdout(out_of_date_gems, gems.count, sourced_from_git.count)
+      end
+    end
+
+    def output_to_json(out_of_date_gems, total_gem_count, sourced_from_git_count)
+      obj = build_json(out_of_date_gems, total_gem_count, sourced_from_git_count)
+      puts JSON.pretty_generate(obj)
+    end
+
+    def build_json(out_of_date_gems, total_gem_count, sourced_from_git_count)
+      output = Hash.new { [] }
+      out_of_date_gems.each do |gem|
+        output[:outdated_gems] += [
+          {
+            name: gem.name,
+            installed_version: gem.version,
+            installed_age: gem.age,
+            latest_version: gem.latest_version.version,
+            latest_age: gem.latest_version.age
+          }
+        ]
+      end
+
+      output.merge(
+        {
+          sourced_from_git_count: sourced_from_git_count,
+          total_gem_count: total_gem_count
+        }
+      )
+    end
+
+    def output_to_stdout(out_of_date_gems, total_gem_count, sourced_from_git_count)
+      out_of_date_gems.each do |gem|
+        header = "#{gem.name} #{gem.version}"
 
         puts <<-MESSAGE
-#{header.bold.white}: released #{_gem.age} (latest version, #{_gem.latest_version.version}, released #{_gem.latest_version.age})
+          #{header.bold.white}: released #{gem.age} (latest version, #{gem.latest_version.version}, released #{gem.latest_version.age})
         MESSAGE
       end
 
-      puts ""
-      puts <<-MESSAGE
-#{"#{sourced_from_git.count}".yellow} gems are sourced from git
-#{"#{out_of_date_gems.length}".red} of the #{gems.count} gems are out-of-date (#{percentage_out_of_date}%)
+      percentage_out_of_date = ((out_of_date_gems.count / total_gem_count.to_f) * 100).round
+      footer = <<-MESSAGE
+        #{sourced_from_git_count.to_s.yellow} gems are sourced from git
+        #{out_of_date_gems.count.to_s.red} of the #{total_gem_count} gems are out-of-date (#{percentage_out_of_date}%)
       MESSAGE
+
+      puts ''
+      puts footer
     end
   end
-end
+end

data/lib/next_rails/gem_info.rb

@@ -79,7 +79,7 @@ module NextRails
     def state(rails_version)
       if compatible_with_rails?(rails_version: rails_version)
         :compatible
-      elsif latest_compatible_version.version == "NOT FOUND"
+      elsif latest_compatible_version && latest_compatible_version.version == "NOT FOUND"
         :no_new_version
       elsif latest_compatible_version
         :found_compatible

data/lib/next_rails/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module NextRails
-  VERSION = "1.2.1"
+  VERSION = "1.2.2"
 end

data/pull_request_template.md

@@ -1,9 +1,15 @@
-**IMPORTANT**: Please read the README before submitting pull requests for this project. Additionally, if your PR closes any open GitHub issues, make sure you include Closes #XXXX in your comment or use the option on the PR's sidebar to add related issues to auto-close the issue that your PR fixes.
+## Description
+<!--- Describe your changes in detail -->
 
-- [ ] Add an entry to `CHANGELOG.md` that links to this PR under the "main (unreleased)" heading.
+## Motivation and Context
+<!--- Why is this change required? What problem does it solve? -->
+<!--- If it fixes an open issue, please link to the issue here. -->
 
-Description:
+## How Has This Been Tested?
+<!--- Include any relevant details about your testing environment and the steps you followed -->
+<!--- For example: I am using [Safari|Firefox|Chrome] then I visit [the users path] -->
 
-Please include a summary of the change and which issue is fixed or which feature is introduced. If changes to the behavior are made, clearly describe what changes.
+## Screenshots:
+<!-- Add screenshots (applicable to any UI changes) -->
 
-I will abide by the [code of conduct](https://github.com/fastruby/next_rails/blob/main/CODE_OF_CONDUCT.md).
+**I will abide by the [code of conduct](https://github.com/fastruby/next_rails/blob/main/CODE_OF_CONDUCT.md)**

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: next_rails
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Ernesto Tagwerker
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-26 00:00:00.000000000 Z
+date: 2023-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -194,7 +194,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.0.9
 signing_key: 
 specification_version: 4
 summary: A toolkit to upgrade your next Rails application