strong_versions 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e9137c23cce3c8cf3ca835657b64fbfe74761fad58f14f9572020d5360dc4bf
-  data.tar.gz: 66e4f5b06fc23363b9a83016fcf2140006d124fef6813228d4cd6c6d8d4b5a1e
+  metadata.gz: 1c22d65fb8950d91b5f8303c8f5eba7842a39d6ea9410b70071ccd7cf5944a0c
+  data.tar.gz: 840a9a7c0dd86371ca55a2b8884a7a7b86688342c1cadd038d501ffd864f6166
 SHA512:
-  metadata.gz: 1b5cfc945a0cbe534a01010b78a263c380943591889839b07a271577a7815ebe9ec03eaed6ac5247cfdbcc3e94ce8f7d9986cb85a8ba7684e45cd0edf3a59cca
-  data.tar.gz: fca7aa528b8aff694f213ec0e8aea6744185060556090a2dfe89d3fb5e2bd95639816832b91ead81203fabb01e1187eac237ea0060e38d86f693458e8d9e5475
+  metadata.gz: 460734cdc1a68bdc008f7bb496895da1f0735e9e4b29db2a1f816f41895717cae236ae27e14242ca92f25d0fe5346ff1cdb1532115a8997f63f86dfcee0e10ab
+  data.tar.gz: 634139436aec6caa3d9be60723a6fea378c702799046ffc6929d84e38a61d1927cf8c5f3820dc79c5f67c4e2628c0238da7caeb0fd71b57536b4cea897d5555a

data/README.md

@@ -8,7 +8,7 @@ Is right here inside us
 
 # Overview
 
-_StrongVersions_ is a _Bundler_ plugin that enforces a strict policy on your `Gemfile` requirements:
+_StrongVersions_ enforces a strict policy on your `Gemfile` requirements:
 
 * The pessimistic `~>` operator must be used for all gem requirement definitions.
 * If the gem version is greater than 1, the requirement format must be `major.minor`, e.g. `'~> 2.5`'
@@ -17,18 +17,18 @@ _StrongVersions_ is a _Bundler_ plugin that enforces a strict policy on your `Ge
 * All gems with a `path` or `git` source are ignored, e.g. `path: '/path/to/gem'`, `git: 'https://github.com/bobf/strong_versions'`
 * All gems specified in the [ignore list](#ignore) are ignored.
 
-Any gems that do not satisfy these rules will cause `bundle install` to fail and give output detailing which gems did not meet the standard and why.
+Any gems that do not satisfy these rules will be included in included in the _StrongVersions_ output with details on why they did not meet the standard.
 
-The benefit of applying this standard is that it [should](https://semver.org/) always be relatively safe to run `bundle update` to upgrade to the latest compatible versions of all dependencies.
+The benefit of applying this standard is that, if all gems follow [Semantic Versioning](https://semver.org/) always be relatively safe to run `bundle update` to upgrade to the latest compatible versions of all dependencies. Running `bundle update` often brings advantages both in terms of bug fixes and security updates.
 
 ![StrongVersions](doc/images/strong-versions-example.png)
 
 ## Installation
 
-Add the plugin to your `Gemfile`
+Add the gem to your `Gemfile`
 
 ```ruby
-plugin 'strong_versions', '~> 0.2.1'
+gem 'strong_versions', '~> 0.3.0'
 ```
 
 And rebuild your bundle:
@@ -37,15 +37,24 @@ And rebuild your bundle:
 $ bundle install
 ```
 
+Or install yourself:
+```bash
+$ gem install strong_versions -v '0.3.0'
+```
+
 ## Usage
 
-_StrongVersions_ will automatically hook into _Bundler_ and raise an exception every time you call `bundle install` if there are any errors.
+_StrongVersions_ is invoked with a provided executable:
 
-If you prefer to see a warning rather than raise an exception, see [raise or warn](#raise_or_warn).
+```bash
+$ bundle exec strong_versions
+```
+
+The executable will output all non-passing gems and will return an exit code of `1` on failure, `0` on success (i.e. all gems passing).
 
 ### Exclusions
 
-<a name="ignore"></a>You can exclude any gems from this list by adding them to the `ignore` section of `.strong_versions.yml` in your project root, e.g.:
+<a name="ignore"></a>You can tell _StrongVersions_ to ignore any of your gems (e.g. those that don't follow _semantic versioning_) by adding them to the `ignore` section of `.strong_versions.yml` in your project root, e.g.:
 
 ```yaml
 # .strong_versions.yml
@@ -53,19 +62,6 @@ ignore:
   - rails
 ```
 
-### Raise or Warn
-
-<a name="raise_or_warn"></a>_StrongVersions_ can be configured to raise an exception (default) or output a warning when the standard is not met.
-
-Warning instead of raising is especially useful when you want to add new dependencies to your `Gemfile` as you can initially set them with loose requirements and then update the `Gemfile` with more precise values based on your new `Gemfile.lock`.
-
-Set `on_failure` in `.strong_versions.yml` to either `raise` or `warn`:
-
-```yaml
-# .strong_versions.yml
-on_failure: warn
-```
-
 ## Contributing
 
 Fork and create a pull request.

data/bin/strong_versions

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require 'strong_versions'
+
+config_path = Bundler.root.join('.strong_versions.yml')
+config = StrongVersions::Config.new(config_path)
+dependencies = Bundler.definition.dependencies
+
+valid = StrongVersions::Dependencies.new(dependencies).validate!(
+  except: config.exceptions,
+  on_failure: 'warn'
+)
+
+exit 0 if valid
+exit 1

data/lib/strong_versions/dependencies.rb

@@ -10,7 +10,7 @@ module StrongVersions
     end
 
     def validate!(options = {})
-      return if validate(options)
+      return true if validate(options)
 
       on_failure = options.fetch(:on_failure, 'raise')
       case on_failure
@@ -19,6 +19,8 @@ module StrongVersions
       when 'warn'
         warn_failure
       end
+
+      false
     end
 
     def validate(options = {})

data/lib/strong_versions/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module StrongVersions
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

data/plugins.rb

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+# XXX: StrongVersions was intended to be a Bundler plugin but, unfortunately,
+# the plugin system is still in its infancy and has many issues which make it
+# not fit for purpose. If those issues get resolved then I will re-add
+# documentation for use as a plugin.
+
 require 'strong_versions'
 
 Bundler::Plugin.add_hook('before-install-all') do |dependencies|

data/strong_versions.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   end
 
   spec.bindir        = 'bin'
-  spec.executables   = []
+  spec.executables   = %w[strong_versions]
   spec.require_paths = ['lib']
 
   # Rails 4 is locked to I18n ~> 0.7 so, unfortunately, until we are ready to

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: strong_versions
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Bob Farrell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-07 00:00:00.000000000 Z
+date: 2018-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -111,7 +111,8 @@ dependencies:
 description: Ensure your gems are appropriately versioned
 email:
 - robertanthonyfarrell@gmail.com
-executables: []
+executables:
+- strong_versions
 extensions: []
 extra_rdoc_files: []
 files:
@@ -129,6 +130,7 @@ files:
 - bin/rspec
 - bin/rubocop
 - bin/setup
+- bin/strong_versions
 - config/locales/en.yml
 - doc/images/strong-versions-example.png
 - lib/strong_versions.rb