retrospec 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 08b7e319301663802a82b062d861645c924ee032
-  data.tar.gz: bb0d02ff8279e82049534b87f33612fb4b0d8b81
+  metadata.gz: a2cd45726cebda553995e231943a0471f733edf4
+  data.tar.gz: c5e151d70b8045fc843b30eeb995344b93a91e37
 SHA512:
-  metadata.gz: 48db65f55ba4eee36885cade5bfda62b0e41b65be3a2caacd8104f41b54b57b15e05e474bc24c94b24901e51b4277d141cf15452361d344ab30dffb43a0a69b1
-  data.tar.gz: 5f94d2b8aaf93a880ebc028c09609a241d0af629530874c573e99ac458d2d0e6268e79b13c048c2ffee53f13444441220786d3139acc30e8a46d81b08017ff70
+  metadata.gz: e32c52220839c540b7a7a6f3461a8b85cfd091a44c49c040c6d1af5e9029ba35b2c3d5c24ff96c4e7fd768c2e4eca7551a34d1372d2f20344f4ec50570b03ae3
+  data.tar.gz: 51ed46bc2d938f5738f67294b60db40ad2562ce6d3982a87a46dce1c4f04fa8e97d2e4545d22bb49d6260ea7ea99df00fa66b84b9d82d06b60cf4d9d75b37544

data/Gemfile

@@ -1,10 +1,6 @@
 source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
 gem 'trollop'
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
+
 group :development do
   gem "rspec", "~> 3.2"
   gem "rdoc", "~> 3.12"
@@ -13,4 +9,4 @@ group :development do
   gem "simplecov", ">= 0"
   gem 'pry'
   gem "fakefs", :require => "fakefs/safe"
-end
+end

data/Gemfile.lock

@@ -46,7 +46,7 @@ GEM
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
       rack (~> 1.2)
-    pry (0.10.1)
+    pry (0.10.2)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)

data/README.md

@@ -0,0 +1,119 @@
+# Retrospec
+
+Retrospec is a framework that allows the automation of repetitive project file creation with just about any kind of programming
+project through the use of a pluggable architecture.
+
+The idea originally came from another project that performed the same function but was scoped to puppet module creation
+called [puppet-retrospec](https://github.com/nwops/puppet-retrospec.git).  The goal of puppet-retrospec was to document
+the workflow and its best practices inside templates. This idea has now been generalized to cover any kind of project,
+therefore making it dead simple for anybody to get their project started with a simple command.
+
+There are two scenarios that this gem can be used for.
+1. Initial project creation
+2. Project augmentation
+
+The first scenario is to aid the creation of the project as many times information is spread across people, teams, blogs,
+forums and is often out of date.  By keeping this information in templates we have removed the burden of finding this
+information from the user.  However, there are many tools in existence today that already help in this area, but they
+are often not customizable.
+
+The second scenario it to augment an existing project that a user may have already started.  When this is the case
+retrospec can "retrofit" an existing project with the latest workflow and best practices based on the templates inside
+a plugin gem.  An existing project also contains information that can be used to automatically generate lots of files beyond just
+initial module creation.  A great example of this is with [puppet-retrospec](https://github.com/nwops/puppet-retrospec.git),
+where the goal is to automaticly generate valid unit tests based on the code the author wrote. So as the user writes more
+code, they can easily create unit test files by just running retrospec.
+
+Furthermore, retrospec is meant to be run multiple times during a project lifecycle in order to augment it with new files.
+Because of the safe file creation, no file can be overwritten so the only way to overcome this is to manually delete the
+file and let retrospec recreate it automatically.
+
+This idea is inspried by a few projects:
+
+- maven archetypes
+- jeweler ruby gem
+- puppet-lint
+
+## Install
+
+`gem install retrospec`
+
+## Known issues
+If you have previously installed the puppet-retrospec gem, there is a conflict with the executable file `retrospec` because
+this gem also uses an executable file with the same name.  As a result I will be moving the legacy puppet-retrospec gem
+to a retrospec plugin that performs the same functionality.  But first I have to release this gem and the plugingem in order
+to move the puppet-retrospec to a plugin.
+
+## Usage
+
+### List Available Plugins
+By default the retrospec gem does not do anything but provide a framework for plugins.  In order to do anything you will
+need to install a retrospec plugin.  To see a list of plugins use: `retrospec -a` which will query the following [url](https://raw.githubusercontent.com/nwops/retrospec/master/available_plugins.yaml).
+
+
+### Setting the module path
+Setting the module path is the only option that can change the outcome of the plugin.  By default it will use the current
+directory, but this can be overridden by using the `retrospec -m` option.
+
+### Subcommands
+Subcommands are added dynamically to the help screen when installing new retrospec plugins. 
+So just use `retrospec -h` to see the list.  The name of the plugin is usually the name of subcommand. 
+
+```
+retrospec -h
+A framework to automate your development workflow by generating common files and test patterns.
+
+Usage: retrospec [global options] subcommand [subcommand options]
+Available subcommands:
+plugingen
+  -m, --module-path=<s>      The path (relative or absolute) to the module directory (default: /Users/cosman/github/retrospec)
+  -a, --available-plugins    Show an online list of available plugins
+  -v, --version              Print version and exit
+  -h, --help                 Show this message
+```
+
+Note: If you are really good at Trollop and can suggest a better way to display subcommands please let me know.  I was going
+for a git like interface but came up short. 
+
+### Using subcommands
+Once you find the subcommand you want just run the subcommand like: `retrospec -m tmp/test4 plugingen`. If you
+have already created your project you don't need to pass the `-m` option if your current working directory 
+is the root of your project.  So you may find yourself running `retrospec plugin_name` often inside your project.
+
+Getting help with a subcommand is easy as using `retrospec -m tmp/test4 plugin_name -h`
+
+```
+% retrospec -m /tmp/new_retrospec_plugin plugingen -h
+Options:
+  -n, --name=<s>    The name of the new plugin (default: new_retrospec_plugin)
+  -h, --help        Show this message
+```  
+
+
+### Retrspec config file
+Retrospec will read the config file at ~/.retrospec/config.yaml for configs related to retrospec itself or any plugins
+you install.  Since you may be running retrospec over and over it will be annoying to always have to specify this info
+so please refer to the plugin documentation for which options you can save to the config file.  At this time there are 
+no retrospec config options being read form the config file.  By default retrospec will add a simple config to ~/.retrospec
+
+## Plugins
+Please see the following [list](https://raw.githubusercontent.com/nwops/retrospec/master/available_plugins.yaml) for available plugins.
+
+
+## Plugin development
+Please see the [plugin document](plugin_development.md) for creating new retrospec plugins.
+
+== Contributing to retrospec
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2015 Corey Osman. See LICENSE.txt for
+further details.

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/available_plugins.yaml

@@ -1,5 +1,5 @@
 ---
-retrospec-puppet:
-  project_url: https://github.com/nwops/retrospec-puppet
-  gem: retrospec-puppet
-  description: Provides puppet module development automation
+retrospec-plugingen:
+  project_url: https://github.com/nwops/retrospec-plugingen
+  gem: retrospec-plugingen
+  description: Provides instant retrospec plugin creation

data/bin/retrospec

@@ -1,25 +1,5 @@
 #!/usr/bin/env ruby
 require_relative '../lib/retrospec/cli'
-require 'trollop'
 
-opts = Trollop::options do
-  version "0.1.0 (c) Corey Osman"
-  banner <<-EOS
-A framework to automate your development workflow by generating common files and test patterns.
-
-
-  EOS
-  opt :module_path, "The path (relative or absolute) to the module directory (Defaults to current directory) " ,
-      :type => :string, :required => false, :default => nil
-  opt :installed_plugins, "List the installed plugins", :type => :boolean, :require => false
-  opt :available_plugins, "Show an online list of available plugins", :type => :boolean, :require => false
-
-end
-if opts[:installed_plugins]
-   Retrospec::Cli.list_installed_plugins
-end
-
-if opts[:available_plugins]
-   Retrospec::Cli.list_available_plugins
-end
 
+Retrospec::Cli.run

data/lib/retrospec.rb

@@ -1,43 +1,6 @@
-require 'retrospec/plugins'
-require 'retrospec/exceptions'
-require 'retrospec/config'
-
-module Retrospec
-  class Module
-    include Retrospec::Plugins
-    # module path is the relative or absolute path to the module that we should retrofit
-    # opts hash contains additional flags and options that can be user to control the creation of the tests
-    # opts[:config_map]
-    def initialize(supplied_module_path, opts={})
-      # locates the plugin class that can be used with this module directory
-      begin
-        opts[:name] ||= File.basename(supplied_module_path) # use the name or derive it from the dir name
-        plugin_class = find_plugin_type(supplied_module_path, opts[:name])
-        # load any save data in the config file
-        config_data  = Retrospec::Config.config_data(opts[:config_map])
-        plugin_data = Retrospec::Config.plugin_context(config_data, plugin_class.send(:plugin_name))
-        # merge the passed in options
-        plugin_data.merge!(opts)
-        # create the instance of the plugin
-        plugin = plugin_class.send(:new, supplied_module_path, plugin_data)
-        plugin.run
-      rescue NoSuitablePluginFoundException
-        puts "No gem was found to support this code type, please install a gem that supports this module.".fatal
-      end
-    end
-
-    # finds a suitable plugin given the name of the plugin or via a supported discovery method
-    def find_plugin_type(module_path, name=nil)
-      if name
-        # when the user wants to create a module give the module type
-        discover_plugin_by_name(name)
-      else
-        discover_plugin(module_path)
-      end
-    end
-  end
-end
+require_relative 'retrospec/module'
 
+# monkey patch in some color effects string methods
 class String
   def red;            "\033[31m#{self}\033[0m" end
   def green;          "\033[32m#{self}\033[0m" end
@@ -46,5 +9,4 @@ class String
   def warning;        yellow                   end
   def fatal;          red                      end
   def info;           green                    end
-end
-
+end

data/lib/retrospec/cli.rb

@@ -1,9 +1,49 @@
 require_relative 'plugins'
+require 'trollop'
+require_relative '../retrospec'
 
 module Retrospec
   class Cli
     include Retrospec::Plugins
 
+    def self.run
+      cli = Retrospec::Cli.new
+      sub_commands = cli.plugin_map.keys
+      cmd_help = sub_commands.join("\n")
+
+      global_opts = Trollop::options do
+        version "0.1.0 (c) Corey Osman"
+        banner <<-EOS
+A framework to automate your development workflow by generating common files and test patterns.
+
+Usage: retrospec [global options] subcommand [subcommand options]
+Available subcommands:
+#{cmd_help}
+
+        EOS
+        opt :module_path, "The path (relative or absolute) to the module directory" ,
+            :type => :string, :required => false, :default => File.expand_path('.')
+        opt :available_plugins, "Show an online list of available plugins", :type => :boolean, :require => false, :short => '-a'
+        stop_on sub_commands
+      end
+      cmd = ARGV.shift # get the subcommand
+      if plugin_class = cli.plugin_map[cmd]
+        # run the subcommand options
+        cmd_opts = cli.plugin_map[cmd].send(:cli_options, global_opts)
+        opts = global_opts.merge(cmd_opts)
+        Retrospec::Module.new(global_opts[:module_path], plugin_class, opts)
+      else
+        if global_opts[:available_plugins]
+          Retrospec::Cli.list_available_plugins
+        else
+          # this is the default action when no command is entered
+          # at a later time we will try and use some magic to guess
+          # what the user wants
+          Trollop.educate
+        end
+      end
+    end
+
     def self.list_available_plugins
         Retrospec::Cli.new.available_plugins.each do |name, plugin_data|
         puts "#{name}: #{plugin_data['project_url']}"

data/lib/retrospec/module.rb

@@ -0,0 +1,37 @@
+require_relative 'plugins'
+require_relative 'exceptions'
+require_relative 'config'
+
+module Retrospec
+  class Module
+    include Retrospec::Plugins
+    # module path is the relative or absolute path to the module that we should retrofit
+    # opts hash contains additional flags and options that can be user to control the creation of the tests
+    # opts[:config_map]
+    def initialize(supplied_module_path, plugin_class, opts={})
+      # locates the plugin class that can be used with this module directory
+      begin
+        # load any save data in the config file
+        config_data  = Retrospec::Config.config_data(opts[:config_map])
+        plugin_data = Retrospec::Config.plugin_context(config_data, plugin_class.send(:plugin_name))
+        # merge the passed in options
+        plugin_data.merge!(opts)
+        # create the instance of the plugin
+        plugin = plugin_class.send(:new, supplied_module_path, plugin_data)
+        plugin.run
+      rescue NoSuitablePluginFoundException
+        puts "No gem was found to support this code type, please install a gem that supports this module.".fatal
+      end
+    end
+
+    # finds a suitable plugin given the name of the plugin or via a supported discovery method
+    def find_plugin_type(module_path, name=nil)
+      if name
+        # when the user wants to create a module give the module type
+        discover_plugin_by_name(name)
+      else
+        discover_plugin(module_path)
+      end
+    end
+  end
+end

data/lib/retrospec/plugin_loader.rb

@@ -27,6 +27,7 @@ module Retrospec
       end
     end
 
+
     # returns a list of retrospec gem plugin specs
     def self.retrospec_gem_list
       gemspecs.reject { |spec| spec.name == 'retrospec' or ! File.directory?(File.join(spec.full_gem_path,'lib','retrospec','plugins')) }

data/lib/retrospec/plugins.rb

@@ -15,8 +15,14 @@ module Retrospec
      def plugin_classes
        unless @plugin_classes
          load_plugins
-         @plugin_classes = ObjectSpace.each_object(Class).find_all {|c| c.name =~ /Retrospec::Plugins/}
+         @plugin_classes = ObjectSpace.each_object(Class).find_all {|c| c.name =~ /Retrospec::Plugins/} - [Retrospec::Plugins::V1::Plugin]|| []
+
        end
+       @plugin_classes
+     end
+
+     def plugin_map
+       @plugin_map ||= Hash[plugin_classes.map { |gem| [gem.send(:plugin_name) , gem] }]
      end
 
      def installed_plugins
@@ -38,8 +44,17 @@ module Retrospec
        plugin
      end
 
+     def gem_dir
+       File.expand_path("../../../", __FILE__)
+     end
+
      def available_plugins
-        get_remote_data('https://raw.githubusercontent.com/nwops/retrospec/master/available_plugins.yaml')
+        begin
+          get_remote_data('https://raw.githubusercontent.com/nwops/retrospec/master/available_plugins.yaml')
+        rescue SocketError
+          puts "Using cached list of available plugins, use internet to get latest list."
+          YAML.load_file(File.join(gem_dir, 'available_plugins.yaml'))
+        end
      end
 
      def get_remote_data(url)

data/lib/retrospec/plugins/v1.rb

@@ -1 +1 @@
-require_relative 'v1/instance'
+require_relative 'v1/plugin'

data/lib/retrospec/plugins/v1/context_object.rb

@@ -0,0 +1,11 @@
+module Retrospec
+  module Plugins
+    module V1
+      class ContextObject
+        def get_binding
+          binding
+        end
+      end
+    end
+  end
+end

data/lib/retrospec/plugins/v1/plugin.rb

@@ -0,0 +1,70 @@
+require 'trollop'
+require_relative 'module_helpers'
+
+module Retrospec
+  module Plugins
+    module V1
+      class Plugin
+        attr_accessor :module_path, :config_data
+        attr_reader   :plugin_name
+
+        # by including this module we are getting helper code that will assist
+        # with creating files and rendering template.
+        # for a list of available functions please see the following lik
+        # https://github.com/nwops/retrospec/blob/master/lib/retrospec/plugins/v1/module_helpers.rb
+        include Retrospec::Plugins::V1::ModuleHelpers
+
+        def initialize(supplied_module_path='.',config={})
+          @config_data = config
+          @module_path = File.expand_path(supplied_module_path)
+        end
+
+        # validates that the module meets the plugins criteria
+        # returns boolean true if module files are valid, false otherwise
+        # validates module directory fits the description of this plugin
+        # this is used in the discover method
+        def self.valid_module_dir?(dir)
+          if ! File.exist?(dir)
+            false
+          else
+            module_files ||= Dir.glob("#{dir}/**/*#{file_type}")
+            if module_files.length < 1
+              false
+            else
+              true
+            end
+          end
+        end
+
+        # used to display subcommand options to the cli
+        # the global options are passed in for your usage
+        def self.cli_options(global_opts)
+          Trollop::options do
+          end
+        end
+
+        # the name of the plugin that will be sent to the cli
+        # the cli turns this into a subcommand where the user interacts with your plugin
+        def self.plugin_name
+          self.name.split('::').last.downcase
+        end
+
+        # sets the config which should be a hash
+        def config=(config_map)
+          @config = config_map
+        end
+
+        # the main file type that is used to help discover what the module is
+        def self.file_type
+          raise NotImplementedError
+        end
+
+        # the main entry point that is called when retrospec is run
+        # using this as the starting point after initialization
+        def run
+          raise NotImplementedError
+        end
+      end
+    end
+  end
+end

data/plugin_development.md

@@ -0,0 +1,45 @@
+# Retrospec plugin development
+
+If you wish to automate the creation of a project or other project plugins you should
+create a retrospec plugin. Follow the steps below to create a plugin.
+
+## Creating a plugin using the plugin generator
+1. Install the retrospec plugin that creates retrospec plugins!  `gem install retrospec-plugingen`
+2. Come up with a name for you plugin.
+3. Use the retrospec plugin help `retrospec -m /path_to_project/plugin_name plugingen -h`
+4. Create the plugin `retrospec -m /path_to_project/plugin_name plugingen`
+5. Open the /path_to_project/plugin_name in your favorite editor
+6. Hack --> Test --> Publish
+
+## Choosing a plugin name
+By default the plugin generator will use the name of the directory or the name specified via the -n option.  This name
+will used through the generator templates so its important to pick a sensible name.  The generator also uses the plugin_name
+as a class name although you are free to change it after creation. 
+
+## What you need to override
+* run
+
+## Create a context object
+By default the plugin generator will create a context object that can be used inside templates.  The default context object
+does not contain anything useful so you will want to customize this object only if your templates require variable interpolation.
+
+## Add custom options to the cli
+You can get input from the user in the form of cli options.  These options are passed in directly to your init method.
+To customize these options please override the the following class method:
+
+```
+def self.cli_options(global_opts)
+  Trollop::options do
+    opt :option1, "Some fancy option"
+  end
+end
+```
+
+See the [trollop documentation](http://trollop.rubyforge.org) for more info.
+
+## Module helpers
+The module helpers module is included by default and contains useful methods to safely create files. When creating files
+use the safe create methods in order to protect the users content from being overwritten.  
+For a list of methods please see the [source code](https://github.com/nwops/retrospec/blob/master/lib/retrospec/plugins/v1/module_helpers.rb)
+
+

data/retrospec.gemspec

@@ -5,17 +5,17 @@
 
 Gem::Specification.new do |s|
   s.name = "retrospec"
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Corey Osman"]
-  s.date = "2015-09-25"
+  s.date = "2015-09-26"
   s.description = "Retrospec is a framework that allows the automation of repetitive file creation with just about any kind of language through the use of a pluggable architecture."
   s.email = "corey@logicminds.biz"
   s.executables = ["retrospec"]
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.rdoc"
+    "README.md"
   ]
   s.files = [
     ".document",
@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
-    "README.rdoc",
+    "README.md",
     "Rakefile",
     "VERSION",
     "available_plugins.yaml",
@@ -33,11 +33,14 @@ Gem::Specification.new do |s|
     "lib/retrospec/cli.rb",
     "lib/retrospec/config.rb",
     "lib/retrospec/exceptions.rb",
+    "lib/retrospec/module.rb",
     "lib/retrospec/plugin_loader.rb",
     "lib/retrospec/plugins.rb",
     "lib/retrospec/plugins/v1.rb",
-    "lib/retrospec/plugins/v1/instance.rb",
+    "lib/retrospec/plugins/v1/context_object.rb",
     "lib/retrospec/plugins/v1/module_helpers.rb",
+    "lib/retrospec/plugins/v1/plugin.rb",
+    "plugin_development.md",
     "retrospec.gemspec",
     "spec/cli_spec.rb",
     "spec/config_spec.rb",

data/spec/cli_spec.rb

@@ -1,5 +1,4 @@
 require 'spec_helper'
 
 describe 'cli' do
-
 end

data/spec/retrospec_spec.rb

@@ -2,5 +2,5 @@ require 'spec_helper'
 require 'retrospec'
 
 describe "Retrospec" do
-    it {expect(Retrospec::Module.new('/Users/cosman/github/puppetlabs-apache')).to be_a Retrospec::Module }
+    it {expect{Retrospec::Module.new('/Users/cosman/github/puppetlabs-apache', Retrospec::Plugins::V1::Plugin)}.to raise_error NotImplementedError }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: retrospec
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Corey Osman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-25 00:00:00.000000000 Z
+date: 2015-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trollop
@@ -130,14 +130,14 @@ executables:
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- README.rdoc
+- README.md
 files:
 - .document
 - .rspec
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - available_plugins.yaml
@@ -147,11 +147,14 @@ files:
 - lib/retrospec/cli.rb
 - lib/retrospec/config.rb
 - lib/retrospec/exceptions.rb
+- lib/retrospec/module.rb
 - lib/retrospec/plugin_loader.rb
 - lib/retrospec/plugins.rb
 - lib/retrospec/plugins/v1.rb
-- lib/retrospec/plugins/v1/instance.rb
+- lib/retrospec/plugins/v1/context_object.rb
 - lib/retrospec/plugins/v1/module_helpers.rb
+- lib/retrospec/plugins/v1/plugin.rb
+- plugin_development.md
 - retrospec.gemspec
 - spec/cli_spec.rb
 - spec/config_spec.rb

data/README.rdoc

@@ -1,19 +0,0 @@
-= retrospec
-
-Description goes here.
-
-== Contributing to retrospec
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
-* Fork the project.
-* Start a feature/bugfix branch.
-* Commit and push until you are happy with your contribution.
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== Copyright
-
-Copyright (c) 2015 Corey Osman. See LICENSE.txt for
-further details.
-

data/lib/retrospec/plugins/v1/instance.rb

@@ -1,44 +0,0 @@
-module Retrospec
-  module Plugin
-    module V1
-      attr_accessor :module_path, :module_name, :module_dir_name, :config
-      attr_reader   :files, :plugin_name
-
-      # validates that the module meets the plugins criteria
-      # returns boolean true if module files are valid, false otherwise
-      # validates module directory fits the description of this plugin
-      def self.valid_module_dir?(dir)
-        if ! File.exist?(dir)
-          false
-        else
-          module_files ||= Dir.glob("#{dir}/**/*#{file_type}")
-          if module_files.length < 1
-            false
-          else
-            true
-          end
-        end
-      end
-
-      # sets the config which should be a hash
-      def config=(config_map)
-        @config = config_map
-      end
-
-      # the name of the plugin, defaults to the name of the class
-      def self.plugin_name
-        self.class.downcase
-      end
-
-      # the main file type that is used to help discover what the module is
-      def self.file_type
-        raise NotImplementedError
-      end
-
-      def run
-        raise NotImplementedError
-      end
-
-    end
-  end
-end