retrospec-plugingen 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3a34a844acae924220ed1d90abb3f30cabc16c70
-  data.tar.gz: d76a5211682359461f87936840688c800064edd6
+  metadata.gz: e361d21d5e66451543bf1ba5634623193b997f36
+  data.tar.gz: 33fd32aa5f0d8c6f20f37ce0d730fbe90c4a5c2f
 SHA512:
-  metadata.gz: 40e3dd7d590071c610c0f921bf54cad8aba14f1f441e80a77094067445539c46a60020bdf4abf1b2aeb2ab3bdf727d8b485c15f5faf3c0989d184e24b51e19a8
-  data.tar.gz: 5a4c4c4620c3ebf0854ad16be4580a2ef6417c06bcb94c6ba572e86fbd648ce4a709dfdbc211b19b308d4aada46d4818632b9cb10c66b08568efc6d7a691444c
+  metadata.gz: aff877210061dad170936b8481132ce42247ff4486b9786f03fe2ff026408c564ee368af54fcf84a308419ba68f66897991acccb98246190fc835589a42c781d
+  data.tar.gz: aab6305d9147efc76df7c94c30be98214caf94fed1d50d515818a008511b7e7371853d1b9b8aa27f117608bab58123e0155b87c648bedc6154b0e8d63eb68203

data/Gemfile

@@ -9,4 +9,4 @@ group :development do
   gem "pry"
 end
 gem 'facets'  # used for snakecase
-gem 'retrospec',  "~> 0.3"
+gem 'retrospec',  "~> 0.4"

data/Gemfile.lock

@@ -54,7 +54,7 @@ GEM
     rake (10.4.2)
     rdoc (3.12.2)
       json (~> 1.4)
-    retrospec (0.3.1)
+    retrospec (0.4.0)
       trollop
     rspec (3.3.0)
       rspec-core (~> 3.3.0)
@@ -87,6 +87,6 @@ DEPENDENCIES
   jeweler (~> 2.0.1)
   pry
   rdoc (~> 3.12)
-  retrospec (~> 0.3)
+  retrospec (~> 0.4)
   rspec (~> 3.2)
   simplecov

data/VERSION

@@ -1 +1 @@
-0.2.2
+0.3.0

data/lib/retrospec-plugingen.rb

@@ -1 +1 @@
-require 'retrospec/plugins/v1/plugin/plugin_gen'
+require 'retrospec/plugins/v1/plugin/plugin_gen'

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

@@ -1,6 +1,6 @@
 require 'retrospec/plugins/v1'
 require_relative 'spec_object'
-
+require_relative 'version'
 # this plugin will generate the necessary scaffolding in order to build your own
 # retrospec plugin.
 module Retrospec
@@ -20,9 +20,36 @@ module Retrospec
           create_plugin_file
         end
 
-        def self.cli_options(global_opts)
-          Trollop::options do
+        def self.run_cli(global_opts, global_config, plugin_config, args=ARGV)
+          # 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::PluginGen::VERSION} (c) Corey Osman"
+            banner <<-EOS
+A generator to create plugins for retrospec\n
+#{sub_command_help}
+
+            EOS
             opt :name, "The name of the new plugin", :require => false, :short => '-n', :type => :string, :default => File.basename(File.expand_path(global_opts[:module_path]))
+            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_config).merge(plugin_opts)
+          # define the default action to use the plugin here, the default is run
+          sub_command = (args.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.send(sub_command)
+          else
+            puts "The subcommand #{sub_command} is not supported or valid"
+            exit 1
           end
         end
 

data/lib/retrospec/plugins/v1/plugin/templates/module_files/Gemfile

@@ -8,4 +8,4 @@ group :development do
   gem "simplecov", ">= 0"
   gem "pry"
 end
-gem 'retrospec', :git => 'https://github.com/nwops/retrospec.git'
+gem 'retrospec',  "~> 0.4"

data/lib/retrospec/plugins/v1/plugin/templates/module_files/lib/retrospec/plugins/v1/plugin/templates/module_files/.gitkeep

@@ -0,0 +1,2 @@
+This file only exists because git repos cannot contain empty directories by without a file.
+You can remove this file once you create another file in this directory for your plugin usage.

data/lib/retrospec/plugins/v1/plugin/templates/module_files/lib/retrospec/plugins/v1/plugin/version.rb.retrospec.erb

@@ -0,0 +1,5 @@
+module Retrospec
+  module <%= capitalized_plugin_name %>
+    VERSION = '0.0.1'
+  end
+end

data/lib/retrospec/plugins/v1/plugin/templates/module_files/spec/unit/plugin_spec.rb.retrospec.erb

@@ -2,10 +2,16 @@ require 'spec_helper'
 require 'retrospec'
 
 describe "<%= plugin_name %>" do
+
+  let(:global_opts) do
+    {:module_path => '/tmp/testplugin_dir'}
+  end
+
   let(:plugin) do
     Retrospec::Plugins::V1::<%= capitalized_plugin_name %>.new('/tmp/testplugin_dir', {:name => 'testplugin', :config1 => 'test'})
   end
 
+
   it "can create plugin instance" do
     expect(plugin).to be_a Retrospec::Plugins::V1::<%= capitalized_plugin_name %>
   end
@@ -14,7 +20,7 @@ describe "<%= plugin_name %>" do
     expect(plugin.config_data[:config1]).to eq('test')
   end
 
-  it 'can module_path from context' do
+  it 'can get module_path from context' do
     expect(plugin.context.module_path).to eq('/tmp/testplugin_dir')
   end
 
@@ -25,4 +31,18 @@ describe "<%= plugin_name %>" do
   it 'can run without error' do
     expect{plugin.run}.to_not raise_error
   end
+
+  it 'can run cli' do
+    expect(Retrospec::Plugins::V1::<%= capitalized_plugin_name %>.run_cli(global_opts, {},{}, []).count).to eq(2)
+  end
+
+  describe 'subcommands' do
+     # if your plugin has subcommands you can test them here by putting the subcommands in the array below
+    subcommands = []
+    subcommands.each do |cmd|
+      it "can run cli with subcommand #{cmd}" do
+        expect(Retrospec::Plugins::V1::Newplugin3.run_cli(global_opts, {},{}, [cmd]).count).to eq(2)
+      end
+    end
+  end
 end

data/lib/retrospec/plugins/v1/plugin/templates/plugin-name.rb.retrospec.erb

@@ -1,5 +1,6 @@
 require 'retrospec/plugins/v1'
 require_relative 'spec_object'
+require_relative 'version'
 
 module Retrospec
   module Plugins
@@ -22,29 +23,58 @@ module Retrospec
         # 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
+      def self.run_cli(global_opts, global_config, plugin_config, args=ARGV)
+        # a list of subcommands for this plugin, if any
+        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::<%= capitalized_plugin_name %>::VERSION} (c) Your Name"
+          banner <<-EOS
+  A short description of your plugin goes here\n
+  #{sub_command_help}
 
-        # this is the main entry point that retrospec will use to make magic happen
-        # this is called after everything has been initialized
-        def run
+          EOS
+          opt :option1, "Some Fancy option", :require => false, :short => '-n', :type => :string,
+              :default => File.basename(File.expand_path(global_opts[:module_path]))
+          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_config).merge(plugin_opts)
+        # define the default action to use the plugin here, the default is run
+        sub_command = (args.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.send(sub_command)
+        else
+          puts "The subcommand #{sub_command} is not supported or valid"
+          exit 1
+        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 that ends with .retrospec.erb
           # 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 it using: safe_create_template_file(file_path, template, context)
-        end
+      end
 
-        # the template directory located inside the your retrospec plugin gem
-        # you should not have to modify this unless you move the templates directory
-        # if this directory does not exist please create a directory templates/module_files
-        def template_dir
-          @template_dir ||= File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
-        end
+      # the template directory located inside the your retrospec plugin gem
+      # you should not have to modify this unless you move the templates directory
+      # if this directory does not exist please create a directory templates/module_files
+      def template_dir
+        @template_dir ||= File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+      end
       end
     end
   end

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

@@ -0,0 +1,5 @@
+module Retrospec
+  module PluginGen
+    VERSION = '0.3.0'
+  end
+end

data/retrospec-plugingen.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "retrospec-plugingen"
-  s.version = "0.2.2"
+  s.version = "0.3.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-11"
   s.description = ""
   s.email = "corey@logicminds.biz"
   s.extra_rdoc_files = [
@@ -22,6 +22,7 @@ Gem::Specification.new do |s|
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
+    "New_plugin.md",
     "README.md",
     "Rakefile",
     "VERSION",
@@ -35,10 +36,13 @@ Gem::Specification.new do |s|
     "lib/retrospec/plugins/v1/plugin/templates/module_files/README.md.retrospec.erb",
     "lib/retrospec/plugins/v1/plugin/templates/module_files/Rakefile.retrospec.erb",
     "lib/retrospec/plugins/v1/plugin/templates/module_files/lib/retrospec/plugins/v1/plugin/spec_object.rb.retrospec.erb",
+    "lib/retrospec/plugins/v1/plugin/templates/module_files/lib/retrospec/plugins/v1/plugin/templates/module_files/.gitkeep",
+    "lib/retrospec/plugins/v1/plugin/templates/module_files/lib/retrospec/plugins/v1/plugin/version.rb.retrospec.erb",
     "lib/retrospec/plugins/v1/plugin/templates/module_files/spec/spec_helper.rb.retrospec.erb",
     "lib/retrospec/plugins/v1/plugin/templates/module_files/spec/unit/plugin_spec.rb.retrospec.erb",
     "lib/retrospec/plugins/v1/plugin/templates/plugin-name.rb.retrospec.erb",
     "lib/retrospec/plugins/v1/plugin/templates/retrospec-main-plugin-file.rb.retrospec.erb",
+    "lib/retrospec/plugins/v1/plugin/version.rb",
     "retrospec-plugingen.gemspec",
     "spec/plugin_gen_spec.rb",
     "spec/retrospec-plugin_spec.rb",
@@ -55,7 +59,7 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<facets>, [">= 0"])
-      s.add_runtime_dependency(%q<retrospec>, ["~> 0.3"])
+      s.add_runtime_dependency(%q<retrospec>, ["~> 0.4"])
       s.add_development_dependency(%q<rspec>, ["~> 3.2"])
       s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0"])
@@ -64,7 +68,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<pry>, [">= 0"])
     else
       s.add_dependency(%q<facets>, [">= 0"])
-      s.add_dependency(%q<retrospec>, ["~> 0.3"])
+      s.add_dependency(%q<retrospec>, ["~> 0.4"])
       s.add_dependency(%q<rspec>, ["~> 3.2"])
       s.add_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_dependency(%q<bundler>, ["~> 1.0"])
@@ -74,7 +78,7 @@ Gem::Specification.new do |s|
     end
   else
     s.add_dependency(%q<facets>, [">= 0"])
-    s.add_dependency(%q<retrospec>, ["~> 0.3"])
+    s.add_dependency(%q<retrospec>, ["~> 0.4"])
     s.add_dependency(%q<rspec>, ["~> 3.2"])
     s.add_dependency(%q<rdoc>, ["~> 3.12"])
     s.add_dependency(%q<bundler>, ["~> 1.0"])

data/spec/plugin_gen_spec.rb

@@ -2,6 +2,14 @@ require 'spec_helper'
 require 'retrospec'
 
 describe "RetrospecPlugin" do
+  let(:global_opts) do
+    {:module_path => '/tmp/testplugin_dir'}
+  end
+
+  before :each do
+    FileUtils.rm_rf('/tmp/testplugin_dir')
+  end
+
   let(:gen) do
     Retrospec::Plugins::V1::PluginGen.new('/tmp/testplugin_dir', {:name => 'testplugin', :config1 => 'test'})
   end
@@ -29,4 +37,8 @@ describe "RetrospecPlugin" do
   it 'can run without error' do
     expect{gen.run}.to_not raise_error
   end
+
+  it 'can run cli' do
+    expect(Retrospec::Plugins::V1::PluginGen.run_cli(global_opts, {},{}, [])).to eq(nil)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: retrospec-plugingen
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Corey Osman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-28 00:00:00.000000000 Z
+date: 2015-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: facets
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -135,6 +135,7 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
+- New_plugin.md
 - README.md
 - Rakefile
 - VERSION
@@ -148,10 +149,13 @@ files:
 - lib/retrospec/plugins/v1/plugin/templates/module_files/README.md.retrospec.erb
 - lib/retrospec/plugins/v1/plugin/templates/module_files/Rakefile.retrospec.erb
 - lib/retrospec/plugins/v1/plugin/templates/module_files/lib/retrospec/plugins/v1/plugin/spec_object.rb.retrospec.erb
+- lib/retrospec/plugins/v1/plugin/templates/module_files/lib/retrospec/plugins/v1/plugin/templates/module_files/.gitkeep
+- lib/retrospec/plugins/v1/plugin/templates/module_files/lib/retrospec/plugins/v1/plugin/version.rb.retrospec.erb
 - lib/retrospec/plugins/v1/plugin/templates/module_files/spec/spec_helper.rb.retrospec.erb
 - lib/retrospec/plugins/v1/plugin/templates/module_files/spec/unit/plugin_spec.rb.retrospec.erb
 - lib/retrospec/plugins/v1/plugin/templates/plugin-name.rb.retrospec.erb
 - lib/retrospec/plugins/v1/plugin/templates/retrospec-main-plugin-file.rb.retrospec.erb
+- lib/retrospec/plugins/v1/plugin/version.rb
 - retrospec-plugingen.gemspec
 - spec/plugin_gen_spec.rb
 - spec/retrospec-plugin_spec.rb