ruby_dep 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4ff4303cb0495bdf891173620d7f617c38f9bb8c
-  data.tar.gz: 495b8ea913a703b6d4cf1a016e7b6cbeed4ef8dd
+  metadata.gz: 6162cd8effed647293da60172ca50c44277bc7f1
+  data.tar.gz: 1ca1c7888ea45b1531eae6608f38823bb7d26215
 SHA512:
-  metadata.gz: e14fafce98b25dd34fafb1c429c764aa96717be3975ca64b9f42c64d40f858ffd7184c16313983828cd8c80815217585b34e41b557b71202ba1ab19105a205eb
-  data.tar.gz: 8e4fec2237d44ce2a4f6a608f57dc40f061ecde2048a6062ab2482dac96ab7f5438cb6c5aafc64e96c80b6d365d5a121e05f138e999a758b7b681f1f44f8e6ba
+  metadata.gz: ef2e1a10793b65e5a6b785da3af395354f68240617d0f3e8ad739f723bf86efc0703f475991ae20f116eb4ad1c86270103a380e0d4ef3b49e99cd05ad20ed960
+  data.tar.gz: c3c487439cbb6b9dc21aad2573d850a4e2795cb1c774fdac1f0a31716ed6810fa1c2b8941c829c3d36882c6e3ee18a090fe5eb0f617b8cf21ae7d8b74aeae1c4

data/README.md

@@ -1,54 +1,82 @@
 # RubyDep
 
-Helps with various Ruby version management activities, such as:
+[![Gem Version](https://img.shields.io/gem/v/ruby_dep.svg?style=flat)](https://rubygems.org/gems/ruby_dep) [![Build Status](https://travis-ci.org/e2/ruby_dep.svg)](https://travis-ci.org/e2/ruby_dep)
 
-1. Reading supported Ruby version from a .travis.yml file
-2. More stuff planned (reading TargetRubyVersion from .rubocop.yml file?)
+## The problem
 
-Reason: tests are the best indicator of compatibility.
+Your gem doesn't support all possible Ruby versions.
 
-So, it doesn't make mention the supported Ruby version(s) in:
+And not all Ruby versions are secure to even have installed.
 
-1. your gemspec
-2. your README
-3. your .travis.yml file
+So, you need to tell users which Ruby versions you support in:
 
-(That breaks the principle of single responsibility).
+1. Your gemspec
+2. Your README
+3. Your .travis.yml file
+4. Any issues you get about which version of Ruby is supported or not
 
-Instead, it's better to:
+But maintaning that information in 4 different places breaks the principle of
+single responsibility.
 
-- point to the Travis build in your README (or your gem home page on rubygems.org)
-- extract the supported versions from your .travis.yml
-- set the versions automatically in your Gemspec
 
+## The solution
 
-## Installation
+This gems detects which versions of Ruby your project supports.
 
-Add this line to your application's Gemfile:
+It assumes you are using Travis and the versions listed in your `.travis.yml` are supported.
+
+This helps you limit the Ruby versions you support - just by adding/removing entries in your Travis configuration file.
+
+Also, you it can warn users if they are using an outdated version of Ruby.
+
+(Or one with security vulnerabilities).
+
+
+## Usage
+
+### E.g. in your gemspec file:
 
 ```ruby
-gem 'ruby_dep'
+  begin
+    require "ruby_dep/travis"
+    s.required_ruby_version = RubyDep::Travis.new.version_constraint
+  rescue LoadError
+    abort "Install 'ruby_dep' gem before building this gem"
+  end
+
+  s.add_development_dependency 'ruby_dep', '~> 1.0'
 ```
 
-And then execute:
+### In your `README.md`:
 
-    $ bundle
+Replace your mentions of "supported Ruby versions" to point to the Travis build.
 
-Or install it yourself as:
+(Or, you can point to the rubygems.org site where the required Ruby version is listed).
 
-    $ gem install ruby_dep
+If it works on Travis, it's assumed to be supported, right?
 
-## Usage
+If it fails, it isn't, right?
 
-E.g. in your gemspec file:
+### In your library:
 
 ```ruby
-require 'ruby_dep'
+require 'ruby_dep/warnings'
+RubyDep::Warning.show_warnings
+```
 
-# (...)
+## Tips
+
+To disable warnings, just set the following environment variable:
+
+`RUBY_DEP_GEM_SILENCE_WARNINGS=1`
+
+
+## Roadmap
+
+Pull Requests are welcome.
+
+Plans include: reading supported Ruby from `.rubocop.yml` (`TargetRubyVersion` field).
 
-spec.required_ruby_version = RubyDep::Travis.new.version_constraint
-```
 
 ## Development
 

data/lib/ruby_dep/version.rb

@@ -1,3 +1,3 @@
 module RubyDep
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.1.0'.freeze
 end

data/lib/ruby_dep/warning.rb

@@ -0,0 +1,50 @@
+module RubyDep
+  class Warning
+    MSG_BUGGY = 'RubyDep: WARNING: your Ruby is outdated/buggy.'\
+      ' Please upgrade.'.freeze
+
+    MSG_INSECURE = 'RubyDep: WARNING: your Ruby has security vulnerabilities!'\
+      ' Please upgrade!'.freeze
+
+    MSG_HOW_TO_DISABLE = ' (To disable warnings, set'\
+      ' RUBY_DEP_GEM_SILENCE_WARNINGS=1)'.freeze
+
+    def show_warnings
+      return if silenced?
+      case check_ruby
+      when :insecure
+        STDERR.puts MSG_INSECURE + MSG_HOW_TO_DISABLE
+      when :buggy
+        STDERR.puts MSG_BUGGY + MSG_HOW_TO_DISABLE
+      when :unknown
+      else
+        raise "Unknown problem type: #{problem.inspect}"
+      end
+    end
+
+    private
+
+    VERSION_INFO = {
+      '2.3.1' => :unknown,
+      '2.3.0' => :buggy,
+      '2.2.5' => :unknown,
+      '2.2.4' => :buggy,
+      '2.2.0' => :insecure,
+      '2.1.9' => :buggy,
+      '2.0.0' => :insecure
+    }.freeze
+
+    def check_ruby
+      version = Gem::Version.new(RUBY_VERSION)
+      VERSION_INFO.each do |ruby, status|
+        return status if version >= Gem::Version.new(ruby)
+      end
+      :insecure
+    end
+
+    def silenced?
+      value = ENV['RUBY_DEP_GEM_SILENCE_WARNINGS']
+      (value || '0') !~ /^0|false|no|n$/
+    end
+  end
+end

data/ruby_dep.gemspec

@@ -28,5 +28,5 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.12.a'
+  spec.add_development_dependency 'bundler', '~> 1.11'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_dep
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Cezary Baginski
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.12.a
+        version: '1.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.12.a
+        version: '1.11'
 description: Creates a version constraint of supported Rubies,suitable for a gemspec
   file
 email:
@@ -46,6 +46,7 @@ files:
 - lib/ruby_dep.rb
 - lib/ruby_dep/travis.rb
 - lib/ruby_dep/version.rb
+- lib/ruby_dep/warning.rb
 - ruby_dep.gemspec
 homepage: https://github.com/e2/ruby_dep
 licenses: