ruby_checker 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e79f1172a7f16cc5fd768291aeaaa80b9cfee2928703dfd167239d05c3733c78
-  data.tar.gz: ec39b7b666d51613774dc7572f98f569c5a625351f5209827ca191154bcdf213
+  metadata.gz: 7d7e15ff3c8888029960319b1444e64379e0699f7b974e8122100ff53a44e1a9
+  data.tar.gz: 23452924cc0d17b7d3a4e13f5404fc6d724e12909c9215edcbc71c52124281b2
 SHA512:
-  metadata.gz: 460ecd9775931511690147038ad1460a6c471acff771869c9f8763925c03d53877d1cb8de42564b0cbc1c179f8fa2e393f88772faf79abcbb270e6a34f4bb684
-  data.tar.gz: 8dd18f8fe5c019dbdf42ec586ece3fe631fe0313ae49e3cbf78e9e6fca2b355f6da9b3c2fdbef6716e7fb0fc3b812e4f4b05e2a2cc880d2e9698468c5b36ec11
+  metadata.gz: 77d53b1378b651ee38a7a8ff6fefd18955e85cdbf431264ada0c738be56e2d77f6a2574f83806ec3c4b0aa2e356ac8acfcc9d18185c6aad11d5c650b9b8cde43
+  data.tar.gz: d9ba900883bb1d1e2f08a2727a45fe344b291ded54cd7f2af652c9e4d213b4118f4cc427473573e845b3d1c2a932715993a763d5b45820cf438c542a14cf773c

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.1.0
+
+- [8a8c3621fb12](https://github.com/mssola/ruby_checker/commits/8a8c3621fb12) Implemented a railtie with an initializer.
+
 ## 1.0.0
 
 - Implemented the basic functionality of `ruby_checker`:

data/README.md

@@ -36,6 +36,17 @@ If you are using this gem from within a Ruby on Rails project, you will notice t
   since it will be guessed from the `.ruby-version` file from the root of your
   project.
 
+Moreover, this gem also implements a railtie with an initializer. This means
+that if you require this gem on your Gemfile, you won't have to write any code
+in order to get this gem up and running. That is if you are on this situation:
+you have a `.ruby-version` file and you are using
+[MRI](https://en.wikipedia.org/wiki/Ruby_MRI). If you are using another
+interpreter you can write in your `config/application.rb` the following:
+
+```ruby
+config.ruby_checker.interpreter = ::RubyChecker::JRUBY  # or any other interpreter, even ANY.
+```
+
 ## Contributing
 
 Read the [CONTRIBUTING.md](./CONTRIBUTING.md) file.

data/Rakefile

@@ -33,6 +33,7 @@ end
 
 GitValidation::Task.new(:"git-validation") do |t|
   t.from = "74a6c20fc4d3"
+  t.quiet = ENV["CI"] != "true"
 end
 
 task default: :all

data/lib/ruby_checker.rb

@@ -22,3 +22,4 @@ module RubyChecker
 end
 
 require "ruby_checker/ruby_checker"
+require "ruby_checker/railtie" if defined?(Rails)

data/lib/ruby_checker/logger.rb

@@ -31,5 +31,14 @@ module RubyChecker
         puts "[ruby_checker] Warning: #{msg}"
       end
     end
+
+    # debug logs the given message as a debug message.
+    def debug(msg)
+      if defined?(Rails)
+        Rails.logger.tagged("ruby_checker") { Rails.logger.debug(msg) }
+      else
+        puts "[ruby_checker] Debug: #{msg}"
+      end
+    end
   end
 end

data/lib/ruby_checker/railtie.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# copyright (c) 2020 miquel sabaté solà <mikisabate@gmail.com>
+#
+# this file is part of ruby_checker.
+#
+# ruby_checker is free software: you can redistribute it and/or modify
+# it under the terms of the gnu lesser general public license as published by
+# the free software foundation, either version 3 of the license, or
+# (at your option) any later version.
+#
+# ruby_checker is distributed in the hope that it will be useful,
+# but without any warranty; without even the implied warranty of
+# merchantability or fitness for a particular purpose.  see the
+# gnu general public license for more details.
+#
+# you should have received a copy of the gnu lesser general public license
+# along with ruby_checker.  if not, see <http://www.gnu.org/licenses/>.
+
+require "rails"
+
+module RubyChecker
+  # Railtie implements a Ruby on Rails initializer so most Rails apps don't have
+  # to do anything in order to setup this gem.
+  class Railtie < Rails::Railtie
+    railtie_name :ruby_checker
+
+    initializer "ruby_checker" do |app|
+      ::RubyChecker::RubyChecker.new(interpreter: app.config.ruby_checker.interpreter).check!
+    end
+
+    config.ruby_checker = ActiveSupport::OrderedOptions.new
+    config.ruby_checker.interpreter = ::RubyChecker::MRI
+  end
+end

data/lib/ruby_checker/ruby_checker.rb

@@ -19,6 +19,7 @@
 
 require "ruby_checker/errors"
 require "ruby_checker/interpreter"
+require "ruby_checker/logger"
 require "ruby_checker/versions"
 
 require "rubygems/version"
@@ -37,7 +38,9 @@ module RubyChecker
       @supported = parsed_supported_version
       raise MissingSupportedVersionError if @supported.nil?
 
-      perform_checks!
+      res = perform_checks!
+      Logger.new.debug "OK!" if res
+      res
     end
 
     protected

data/lib/ruby_checker/version.rb

@@ -19,5 +19,5 @@
 
 module RubyChecker
   # The current version of RubyChecker.
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/ruby_checker.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 2.3"
 
   spec.add_development_dependency "bundler", "~> 2.1.4"
-  spec.add_development_dependency "git_validation_task", "~> 1.0.0"
+  spec.add_development_dependency "git_validation_task", "~> 1.1.0"
   spec.add_development_dependency "minitest", "~> 5.14.0"
   spec.add_development_dependency "rake", "~> 13.0.1"
   spec.add_development_dependency "rubocop", "~> 0.80.1"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_checker
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Miquel Sabaté Solà
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-28 00:00:00.000000000 Z
+date: 2020-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -112,6 +112,7 @@ files:
 - lib/ruby_checker/errors.rb
 - lib/ruby_checker/interpreter.rb
 - lib/ruby_checker/logger.rb
+- lib/ruby_checker/railtie.rb
 - lib/ruby_checker/ruby_checker.rb
 - lib/ruby_checker/version.rb
 - lib/ruby_checker/versions.rb