everyday-plugins 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aef7ff8b3547cb61a4fe29ba134fc62a33899dea
+  data.tar.gz: 5ac025923337b937c39c2ae97aa76c725549619b
+SHA512:
+  metadata.gz: 1c51fe1fc1b868bf1300d7955b073fe5e73da16845b20fe038fe9d5a8fb4dcec4ec1c27a77fa458d5455a701e0447d42702e45f4a41f456829e8aaa67087e51b
+  data.tar.gz: cba503a3718084028bc52d40eb44892bd490cd2809b79889209e35cbf7c30c3026ef57a74025e3ef64625c1ade6339bb8666f6c1d1373559605cd862b723da39

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+/.idea/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in everyday-plugins.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Eric Henderson
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,107 @@
+# EverydayPlugins
+
+A simple gem plugin system.  Extracted from `mvn2`.  Plugins have to be defined in gems for them to be able to be picked up on automatically.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'everyday-plugins'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install everyday-plugins
+
+## Usage
+
+###For supporting plugins:
+See below for info on defining and using plugin types.  As for including plugins, use
+
+```ruby
+EverydayPlugins::Plugins.load_plugins '{folder}'
+```
+
+where `{folder}` is the folder name you specify for your plugins to be put in.  For example, my `mvn2` gem uses
+
+```ruby
+EverydayPlugins::Plugins.load_plugins 'mvn2'
+```
+
+###For creating plugins:
+
+The files have to match the pattern `{folder}/plugin/*.plugin.rb` in your gem's `lib/` folder, where `{folder}` is whatever folder path the gem you are adding a plugin to requires.  If you do that, when the gem is installed, the gem accepting plugins will automatically pick up on it and load it.
+
+Two examples of this are my gems `colorconfig` and `mvn2-say`.
+
+The `EverydayPlugins::Plugin` module is used for registering a plugin of a defined type.  It defines the `register` method.  You should use `extend` so that you can define things statically.  There is no need for a `build` method because it automatically adds the plugins at the time you call the method.
+
+Here is an example:
+
+```ruby
+register :option, sym: :timer, names: %w(-t --timer), desc: 'display a timer while the build is in progress'
+```
+
+And another:
+
+```ruby
+register(:before_run, order: 2) { |options|
+  EverydayPlugins::Plugins.set_var :time1, Time.now
+  EverydayPlugins::Plugins.set_var :thread, options[:timer] ? Thread.new {
+    start_time = EverydayPlugins::Plugins.get_var :time1
+    while true
+      print "\r#{get_timer_message(start_time, Time.now)}"
+      sleep(0.05)
+    end
+  } : nil
+}
+```
+
+The `register` method takes a first parameter of the plugin type identifier, followed by an optional (but probably necessary) hash of options, and an optional block (usable with most built-in plugin types, required by some).
+
+-----
+
+If you want to define a new plugin type, you can extend the `EverydayPlugins::PluginType`.  This defines the `register_type` and `register_variable` methods.  Technically, you don't really need to register a variable, but if you want to give it a certain starting value, you will need to register it and pass over the value.  `register_type` takes a first parameter of the plugin type identifier, followed by a block.  The block will always take a first parameter of the list of instances, followed by any additional parameters passed to the plugin when it is called.  The block has the task of taking the list of plugin instances and turning it into whatever result the plugin is supposed to have.
+
+Here is an example:
+
+```ruby
+register_type(:command_flag) { |list|
+  options = EverydayPlugins::Plugins.get_var :options
+  flags   = []
+  list.each { |flag|
+    if flag[:block].nil?
+      flags << " #{flag[:options][:flag]}" if flag[:options].has_key?(:option) && options[flag[:options][:option]] == (flag[:options].has_key?(:value) ? flag[:options][:value] : true)
+    else
+      flag[:block].call(options, flags)
+    end
+  }
+  flags.join
+}
+```
+
+-----
+
+You might notice in the second plugin example, as well as the plugin type example, methods are called on `EverydayPlugins::Plugins`.  This is the class that stores all of the plugins and types.  It has various methods, but the ones involved in making a plugin are:
+
+* `EverydayPlugins::Plugins.get(type, *args)`
+    * Gets the result of a plugin type.  The first parameter is the plugin type identifier, followed by any additional arguments the plugin type takes.
+* `EverydayPlugins::Plugins.get_var(name)`
+    * Gets a single variable by name
+* `EverydayPlugins::Plugins.get_vars(*names)`
+    * Gets a list of variables by name.  Useful for getting a lot of variables in one line.
+* `EverydayPlugins::Plugins.set_var(name, value)`
+    * Sets a single variable of the given name to the given value.
+* `EverydayPlugins::Plugins.set_vars(vars = {})`
+    * Sets a list of variables to the values specified.  It use a hash format, so you can do something like `EverydayPlugins::Plugins.set_vars found: true, info_line_last: false`
+
+## Contributing
+
+1. Fork it ( http://github.com/henderea/everyday-plugins/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/everyday-plugins.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+#noinspection RubyResolve
+require 'everyday-plugins/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'everyday-plugins'
+  spec.version       = EverydayPlugins::VERSION
+  spec.authors       = ['Eric Henderson']
+  spec.email         = ['henderea@gmail.com']
+  spec.summary       = %q{A simple gem plugin system}
+  spec.description   = %q{A simple gem plugin system.  Extracted from the mvn2 gem.}
+  spec.homepage      = 'https://github.com/henderea/everyday-plugins'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/lib/everyday-plugins.rb

@@ -0,0 +1,2 @@
+require 'everyday-plugins/version'
+require 'everyday-plugins/plugin'

data/lib/everyday-plugins/plugin.rb

@@ -0,0 +1,103 @@
+module EverydayPlugins
+  class Plugins
+    def self.instance
+      @instance ||= Plugins.new
+    end
+
+    def self.load_plugins(path, error_fatal = false)
+      begin
+        Gem.find_latest_files("/#{path}/plugin/*.plugin.rb").each { |plugin|
+          #noinspection RubyResolve
+          begin
+            require plugin
+          rescue LoadError => e
+            puts "Error in loading plugin '#{plugin}'"
+            puts e.inspect
+            exit 1 if error_fatal
+          end
+        }
+      rescue Exception => e
+        puts 'Error in loading plugins'
+        puts e.inspect
+        exit 1 if error_fatal
+      end
+    end
+
+    def initialize
+      @ext   = {}
+      @types = {}
+      @vars  = {}
+    end
+
+    def register(type, options = {}, &block)
+      @ext[type] ||= []
+      @ext[type] << { options: options, block: block }
+    end
+
+    def register_type(type, &block)
+      @types[type] = block
+    end
+
+    def register_variable(name, value = nil)
+      @vars[name] = value
+    end
+
+    def [](type)
+      @ext[type] || []
+    end
+
+    def get(type, *args)
+      @types[type].call(self[type], *args)
+    end
+
+    def self.get(type, *args)
+      instance.get(type, *args)
+    end
+
+    def get_var(name)
+      @vars[name] || nil
+    end
+
+    def get_vars(*names)
+      names.map { |name| get_var(name) }
+    end
+
+    def set_var(name, value)
+      @vars[name] = value
+    end
+
+    def set_vars(vars = {})
+      vars.each { |v| set_var(*v) }
+    end
+
+    def self.get_var(name)
+      instance.get_var(name)
+    end
+
+    def self.get_vars(*names)
+      instance.get_vars(*names)
+    end
+
+    def self.set_var(name, value)
+      instance.set_var(name, value)
+    end
+
+    def self.set_vars(vars = {})
+      instance.set_vars(vars)
+    end
+  end
+  module Plugin
+    def register(type, options = {}, &block)
+      EverydayPlugins::Plugins.instance.register(type, options, &block)
+    end
+  end
+  module PluginType
+    def register_type(type, &block)
+      EverydayPlugins::Plugins.instance.register_type(type, &block)
+    end
+
+    def register_variable(name, value = nil)
+      EverydayPlugins::Plugins.instance.register_variable(name, value)
+    end
+  end
+end

data/lib/everyday-plugins/version.rb

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

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: everyday-plugins
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Eric Henderson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: A simple gem plugin system.  Extracted from the mvn2 gem.
+email:
+- henderea@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- everyday-plugins.gemspec
+- lib/everyday-plugins.rb
+- lib/everyday-plugins/plugin.rb
+- lib/everyday-plugins/version.rb
+homepage: https://github.com/henderea/everyday-plugins
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: A simple gem plugin system
+test_files: []
+has_rdoc: