everyday-plugins 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aef7ff8b3547cb61a4fe29ba134fc62a33899dea
-  data.tar.gz: 5ac025923337b937c39c2ae97aa76c725549619b
+  metadata.gz: f5261638c746e3841cd0eb250b76fc6d00102ebd
+  data.tar.gz: 88f21dd9ddc7be4345739315ecfe0037763a126e
 SHA512:
-  metadata.gz: 1c51fe1fc1b868bf1300d7955b073fe5e73da16845b20fe038fe9d5a8fb4dcec4ec1c27a77fa458d5455a701e0447d42702e45f4a41f456829e8aaa67087e51b
-  data.tar.gz: cba503a3718084028bc52d40eb44892bd490cd2809b79889209e35cbf7c30c3026ef57a74025e3ef64625c1ade6339bb8666f6c1d1373559605cd862b723da39
+  metadata.gz: c2c1926e386e1f9a6cc586ee145fa9ac6f2ce8c87182275d807a6004020dc9309b45ae79b4d54fba1da2185830c0b0ab43b4d66a839307e728be3d635560a999
+  data.tar.gz: 50a30e9063b3b723128f3651b298e2206290509cf0f45ad6a96692a06c8d6fb1fd1175109fa66639b4986ca2ca14a48de56570440d03fcd20a0163a4f55add5e

data/README.md

@@ -18,6 +18,29 @@ Or install it yourself as:
 
 ## Usage
 
+###For conditionally running plugin setup code (or other code) based on installed gems
+As of version 1.1.0, there is support for running a block of code based on whether or not certain gems are installed.  This is via the `EverydayPlugins::Loader` module.  You can either `extend` it and use the `depend` method like any other plugin setup method, or you can use the static `EverydayPlugins::Loader.depend` method.  The method takes each dependency as a separate argument.  If you want to specify more than just the name of the gem (for example, if you want to require a minimum version), you need to put the parameters for that argument into an array.
+
+Here is an example:
+
+```ruby
+EverydayPlugins::Loader.depend(['bundler', '~> 1.5'], 'rake') {
+  #do stuff here
+}
+```
+
+And here is an example using `extend`:
+
+```ruby
+class MyLoader
+  extend EverydayPlugins::Loader
+  
+  depend(['bundler', '~> 1.5'], 'rake') {
+    #do stuff here
+  }
+end
+```
+
 ###For supporting plugins:
 See below for info on defining and using plugin types.  As for including plugins, use
 

data/Rakefile

@@ -1 +1,8 @@
-require "bundler/gem_tasks"
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec

data/everyday-plugins.gemspec

@@ -21,4 +21,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.5'
   spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
 end

data/lib/everyday-plugins/plugin.rb

@@ -86,6 +86,19 @@ module EverydayPlugins
       instance.set_vars(vars)
     end
   end
+  module Loader
+    def depend(*deps, &block)
+      EverydayPlugins::Loader.depend(*deps, &block)
+    end
+
+    def self.depend(*deps, &block)
+      met = deps.all? { |dep|
+        matches = Gem::Specification.find_all_by_name(*dep)
+        !(matches.nil? || matches.empty?)
+      }
+      block.call if met
+    end
+  end
   module Plugin
     def register(type, options = {}, &block)
       EverydayPlugins::Plugins.instance.register(type, options, &block)

data/lib/everyday-plugins/version.rb

@@ -1,3 +1,3 @@
 module EverydayPlugins
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/spec/loader_spec.rb

@@ -0,0 +1,30 @@
+require_relative '../lib/everyday-plugins/plugin'
+class Loader1
+  extend EverydayPlugins::Loader
+end
+
+describe EverydayPlugins::Loader do
+  it 'runs the block when the dependencies are met' do
+    rval = false
+    Loader1.depend(['bundler', '~> 1.5'], 'rake') { rval = true }
+    rval.should be_true
+  end
+
+  it 'does not run the block when the dependencies are not met' do
+    rval = false
+    Loader1.depend(['bundler', '>= 10.5'], 'rake') { rval = true }
+    rval.should be_false
+  end
+
+  it 'runs the block when the dependencies are met using a static method' do
+    rval = false
+    EverydayPlugins::Loader.depend(['bundler', '~> 1.5'], 'rake') { rval = true }
+    rval.should be_true
+  end
+
+  it 'does not run the block when the dependencies are not met using a static method' do
+    rval = false
+    EverydayPlugins::Loader.depend(['bundler', '>= 10.5'], 'rake') { rval = true }
+    rval.should be_false
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: everyday-plugins
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Eric Henderson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-04 00:00:00.000000000 Z
+date: 2014-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A simple gem plugin system.  Extracted from the mvn2 gem.
 email:
 - henderea@gmail.com
@@ -54,6 +68,7 @@ files:
 - lib/everyday-plugins.rb
 - lib/everyday-plugins/plugin.rb
 - lib/everyday-plugins/version.rb
+- spec/loader_spec.rb
 homepage: https://github.com/henderea/everyday-plugins
 licenses:
 - MIT
@@ -78,5 +93,6 @@ rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: A simple gem plugin system
-test_files: []
+test_files:
+- spec/loader_spec.rb
 has_rdoc: