retrospec 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 52c998906a997c2915fdcf1f17baeb723e692af9
-  data.tar.gz: cb788ef2a91361b87f4731d3a1a842df4b540e01
+  metadata.gz: 6babe7c886b994aea6dc72564d79fef92170cc78
+  data.tar.gz: 8667464aba52550fa565d43f6f7ca5ba3974703d
 SHA512:
-  metadata.gz: 26b9a1b0e3b756f3df4151ebb96489b614c59f0f223b71490a421e4f7889752b789b32f04db7d6df4e663d50d934c0a7e85bc6959b8979fb61e5a8e1ded24ee3
-  data.tar.gz: 1235d95d10a38ddd603904b41d0858bfd5d4b737528289d624459f349d73318e16b139afceacad4da71b39a179ace855376ffe06acdcc9c2d284ed1d82025e4f
+  metadata.gz: 3c0ce0d81d0f96193a0b9ae5d1785fde481e69e0c204ca2532a265d812245499ce140d91a068e46028cd2c4d88686d9ee50a108f7b302f532051ff7fa7187643
+  data.tar.gz: cec45e06072d9a46ce300528c2b535eea917fd06f12e755fbbf7ac9c109b2b3af9ccd13d849c51621c4a3c879c37e5b6f48753c0867eedf1d8374b1a3e03a466

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.4.0

data/lib/retrospec.rb

@@ -1,4 +1,3 @@
-require_relative 'retrospec/module'
 require_relative 'version'
 # monkey patch in some color effects string methods
 class String

data/lib/retrospec/cli.rb

@@ -9,6 +9,7 @@ module Retrospec
 
     def self.run
       cli = Retrospec::Cli.new
+      # get the list of plugins and provide the plugin name as sub commands
       sub_commands = cli.plugin_map.keys
       cmd_help = sub_commands.join("\n")
 
@@ -30,11 +31,12 @@ Available subcommands:
       end
       cmd = ARGV.shift # get the subcommand
       if plugin_class = cli.plugin_map[cmd]
-        # run the subcommand options but first send the config file and global options to the subcomamnd
-        plugin_config = Retrospec::Config.plugin_context(Retrospec::Config.config_data(global_opts[:config_map]), cmd)
-        cmd_opts = cli.plugin_map[cmd].send(:cli_options, global_opts.merge(plugin_config))
-        opts = global_opts.merge(cmd_opts)
-        Retrospec::Module.new(global_opts[:module_path], plugin_class, opts)
+        # this is what generates the cli options for the subcommand
+        # this is also the main entry point that runs the plugin's cli
+        global_config = Retrospec::Config.config_data(global_opts[:config_map])
+        plugin_name   = plugin_class.send(:plugin_name)
+        plugin_config = Retrospec::Config.plugin_context(global_config, plugin_name)
+        plugin_class.send(:run_cli, global_opts, global_config, plugin_config)
       else
         if global_opts[:available_plugins]
           Retrospec::Cli.list_available_plugins

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

@@ -18,6 +18,15 @@ module Retrospec
           end
         end
 
+        def safe_move_file(src,dest)
+          if File.exists?(dest)
+            $stderr.puts "!! #{dest} already exists and differs from template".warning
+          else
+            FileUtils.mv(src,dest)
+            puts " + #{dest}".info
+          end
+        end
+
         # copy the symlink and preserve the link
         def safe_create_symlink(src,dest)
           if File.exists? dest

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

@@ -39,9 +39,8 @@ module Retrospec
 
         # 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
+        def self.run_cli(global_opts, global_config, plugin_config)
+          raise NotImplemented
         end
 
         # the name of the plugin that will be sent to the cli

data/lib/version.rb

@@ -1,4 +1,4 @@
 module Retrospec
-    VERSION = '0.3.0'
+    VERSION = '0.4.0'
 end
 

data/plugin_development.md

@@ -13,30 +13,66 @@ create a retrospec plugin. Follow the steps below to create a plugin.
 
 ## 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
+will be used throughout 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. 
 
 ### Naming the gem and repo
 Please ensure the gem name uses the following naming scheme retrospec-plugin_name and that your repo is also named retrospec-plugin_name.
-This will help everyone identify what the repo and gem do more easily. 
+This will help everyone identify what the repo and gem do. 
 
 Note: puppet-retrospec does not follow this standard due to a legacy name issue that would have caused confusion.
 
 ## What you need to override
-* run
+* self.run_cli
 
 ## 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:
+## Main method to override
+Retrospec will call your plugin by running the plugin.run_cli class method.  You can do whatever you want in this method.
 
-```
-def self.cli_options(global_opts)
-  Trollop::options do
+The global_opts are the options passed into the retrospec command which are specific to retrospec.  Additionally, the 
+global_config  (~/.retrospec/config.yaml) is a hash map of the entire config while the plugin_config is a subset that pertains
+only to your plugin.
+
+In this method you should at least call self.new() on your plugin and then plugin_instance.run.  
+
+For simplicity sake you can also just copy and paste this into your method.  This is the default layout when using 
+the retrospec plugin generator.
+
+```ruby
+def self.run_cli(global_opts, global_config, plugin_config)
+ # a list of subcommands for this plugin
+    sub_commands  = []
+    if sub_commands.count > 0
+      sub_command_help = "Subcommands:\n#{sub_commands.join("\n")}\n"
+    else
+      sub_command_help = ""
+    end
+    plugin_opts = Trollop::options do
+      version "#{Retrospec::Pluginname::VERSION} (c) Your Name"
+      banner <<-EOS
+Some description goes here.\n
+#{sub_command_help}
+
+    EOS
     opt :option1, "Some fancy option"
+    stop_on sub_commands
+  end
+  # the passed in options will always override the config file
+  plugin_data = plugin_opts.merge(global_config).merge(global_opts).merge(plugin_opts)
+  # define the default action to use the plugin here, the default is run
+  sub_command = (ARGV.shift || :run).to_sym
+  # create an instance of this plugin
+  plugin = self.new(plugin_data[:module_path],plugin_data)
+  # check if the plugin supports the sub command
+  if plugin.respond_to?(sub_command)
+    plugin.post_init   # finish initialization
+    plugin.send(sub_command)
+  else
+    puts "The subcommand #{sub_command} is not supported or valid"
+    exit 1
   end
 end
 ```

data/retrospec.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "retrospec"
-  s.version = "0.3.1"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Corey Osman"]
-  s.date = "2015-09-28"
+  s.date = "2015-10-10"
   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"]
@@ -33,7 +33,6 @@ 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",

data/spec/retrospec_spec.rb

@@ -1,6 +1,3 @@
 require 'spec_helper'
 require 'retrospec'
 
-describe "Retrospec" do
-    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.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Corey Osman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-28 00:00:00.000000000 Z
+date: 2015-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trollop
@@ -147,7 +147,6 @@ 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

data/lib/retrospec/module.rb

@@ -1,37 +0,0 @@
-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