plugin-name.rb.erb in retrospec-plugingen-0.2.0

- old
+ new
@@ -1,30 +1,50 @@
-require 'retrospec/plugins/v1/module_helpers'
 require 'retrospec/plugins/v1'
 require_relative 'spec_object'
 
 module Retrospec
   module Plugins
     module V1
-      class <%= capitalized_plugin_name %>
-        attr_reader :template_dir, :module_path, :config_data, :context
+      class <%= capitalized_plugin_name %> < Retrospec::Plugins::V1::Plugin
 
-        include Retrospec::Plugins::V1::ModuleHelpers
+        attr_reader :template_dir, :context
 
+        # retrospec will initilalize this class so its up to you
+        # to set any additional variables you need to get the job done.
         def initialize(supplied_module_path=nil,config={})
-          @config_data = config
-          @module_path = File.expand_path(supplied_module_path)
+          super
+          # below is the Spec Object which serves as a context for template rendering
+          # you will need to initialize this object, so the erb templates can get the binding
+          # the SpecObject can be customized to your liking as its different for every plugin gem.
           @context = ::<%= capitalized_plugin_name %>::SpecObject.new(module_path, config)
         end
 
+        # used to display subcommand options to the cli
+        # the global options are passed in for your usage
+        # http://trollop.rubyforge.org
+        # all options here are available in the config passed into config object
+        def self.cli_options(global_opts)
+          Trollop::options do
+            opt :option1, "Some fancy option"
+          end
+        end
+
+        # this is the main entry point that retrospec will use to make magic happen
+        # this is called after everything has been initialized
         def run
+          # the safe_create_module_files will render every file under the templates/module_files
+          # folder in your gem and copy them to the destination.
           safe_create_module_files(template_dir, module_path, context)
+          # Should you need to change the file name of the copied file you will have to move
+          # the file outside of the module_files directory and
+          # render if using: safe_create_template_file(file_path, template, context)
         end
 
-        # the template directory located inside the retrospec gem
+        # the template directory located inside the your retrospec plugin gem
+        # you should not have to modify this unless you move the templates directory
         def template_dir
           @template_dir ||= File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
         end
       end
     end
   end
-end
+end
\ No newline at end of file