retrospec-plugingen 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3639afab2202a3e92b0e28e1c18441a5981a6a0f
-  data.tar.gz: 33a2a797c72907da27150f65f55818e718d2d810
+  metadata.gz: a7459885713f1b9030a1a04b8803c5076f7eb258
+  data.tar.gz: f7048d9e02f55dcb648f7c9920e83e05f57636e0
 SHA512:
-  metadata.gz: bf036166da33a0b89345329cfd41a2ec54cd81ec6b65e0a66080fc3913a8d3d36d09aec60ae1e4daf5458d2edc2d73a518c389b4c1b5b55971eac7cdb9c95a33
-  data.tar.gz: 443359d19ae6dc2d141d23b8fca572d8b4e0db8cc4463a3cb35489c9393c0fc5a0a719fa6c4c46f49271ffca73cf31cc8020b5763bf7aa886c53e5edc17e74d5
+  metadata.gz: 216191c3a11f81b71ef5656b0861dabc5bfd8c0afd1becde08d27368b0f1f142c274675a3c176bead6cddc5bab07badb0698c454654857108fb7f381d192404b
+  data.tar.gz: 818ad60d696ef7a4919634f0bf40d42652794011245796d4a705c1d39c3f920c777a4a34565496d0618209eac276bb558c3e6a70f834949f6889a87271503e46

data/Gemfile

@@ -1,10 +1,5 @@
 source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
 
-# 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,6 +8,5 @@ group :development do
   gem "simplecov", ">= 0"
   gem "pry"
 end
-#gem 'retrospec', :git => 'https://github.com/nwops/retrospec.git'
-gem 'retrospec', :path => '/Users/cosman/github/retrospec'
-gem 'facets'
+gem 'facets'  # used for snakecase
+gem 'retrospec',  "~> 0.2"

data/Gemfile.lock

@@ -1,9 +1,3 @@
-PATH
-  remote: /Users/cosman/github/retrospec
-  specs:
-    retrospec (0.1.0)
-      trollop
-
 GEM
   remote: http://rubygems.org/
   specs:
@@ -60,6 +54,8 @@ GEM
     rake (10.4.2)
     rdoc (3.12.2)
       json (~> 1.4)
+    retrospec (0.2.0)
+      trollop
     rspec (3.3.0)
       rspec-core (~> 3.3.0)
       rspec-expectations (~> 3.3.0)
@@ -91,6 +87,6 @@ DEPENDENCIES
   jeweler (~> 2.0.1)
   pry
   rdoc (~> 3.12)
-  retrospec!
+  retrospec (~> 0.2)
   rspec (~> 3.2)
   simplecov

data/README.md

@@ -4,11 +4,66 @@
 This plugin is the starting point to create plugins for retrospec.  Its a widget for creating widgets!
 Use the plugin to generate the retrospec plugin layout, along with basic tests and documentation.
 
+## Install
+`gem install retrospec-plugingen`
 
+## Usage
 
+To create a new plugin for retrospec use the following command `retrospec -m /tmp/test4 plugingen`.
+By default plugingen will use the current directory as the name of the plugin.  
+If you wish to override this name please pass the `-n` option. `retrospec -m /tmp/test4 plugingen -n test_plugin`
+
+```shell
+% retrospec -m /tmp/test4 plugingen -h
+% 
+Options:
+  -n, --name=<s>    The name of the new plugin (default: test4)
+  -h, --help        Show this message
+MacBook-Pro~ % retrospec -m /tmp/test4 plugingen   
+!! /Users/cosman/.retrospec/config.yaml.sample already exists
+ + /tmp/test4/
+ + /tmp/test4/.gitignore
+ + /tmp/test4/.rspec
+ + /tmp/test4/Gemfile
+ + /tmp/test4/LICENSE.txt
+ + /tmp/test4/README.md
+ + /tmp/test4/Rakefile
+ + /tmp/test4/lib/
+ + /tmp/test4/lib/retrospec/
+ + /tmp/test4/lib/retrospec/plugins/
+ + /tmp/test4/lib/retrospec/plugins/v1/
+ + /tmp/test4/lib/retrospec/plugins/v1/plugin/
+ + /tmp/test4/lib/retrospec/plugins/v1/plugin/spec_object.rb
+ + /tmp/test4/spec/
+ + /tmp/test4/spec/plugin_spec.rb
+ + /tmp/test4/spec/spec_helper.rb
+ + /tmp/test4/lib/retrospec-test4.rb
+ + /tmp/test4/lib/retrospec/plugins/v1/plugin/test4.rb
+```
+
+Once the plugin directory has been created you are ready to start development on your plugin.  This plugin
+produces a working retrospec plugin with unit tests.  So just add your code and go.  The templates are based off the jeweler gem
+so if you currently use [jeweler](https://github.com/technicalpickles/jeweler) you should feel right at home.  
+
+At a minimum run:
+
+```
+bundle install
+bundle exec rake -T
+bundle exec rake version:write
+# edit the Rakefile and fill with our gem information
+bundle exec rake spec
+bundle exec rake gemspec (recreate the gemspec)
+bundle exec rake version:bump:minor (when releasing)
+bundle exec git:release 
+bundle exec release (send to rubygems.org)
+# submit a PR to retrospec and tell me about your new plugin
+https://github.com/nwops/retrospec/blob/master/available_plugins.yaml
+
+
+## Contributing to retrospec-plugingen
+Got a change you want to see in this plugin?  Submit a PR.
 
-## Contributing to retrospec-plugin
- 
 * 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.

data/VERSION

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

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

@@ -1,4 +1,3 @@
-require 'retrospec/plugins/v1/module_helpers'
 require 'retrospec/plugins/v1'
 require_relative 'spec_object'
 
@@ -7,14 +6,11 @@ require_relative 'spec_object'
 module Retrospec
   module Plugins
     module V1
-      class PluginGen
-        attr_reader :template_dir, :module_path, :config_data, :context
+      class PluginGen < Retrospec::Plugins::V1::Plugin
+        attr_reader :template_dir, :context
 
-        include Retrospec::Plugins::V1::ModuleHelpers
-
-        def initialize(supplied_module_path=nil,config={})
-          @config_data = config
-          @module_path = File.expand_path(supplied_module_path)
+        def initialize(supplied_module_path='.',config={})
+          super
           @context = ::PluginGen::SpecObject.new(module_path, config)
         end
 
@@ -24,20 +20,27 @@ module Retrospec
           create_plugin_file
         end
 
+        def self.cli_options(global_opts)
+          Trollop::options do
+            opt :name, "The name of the new plugin", :require => false, :short => '-n', :type => :string, :default => File.basename(File.expand_path(global_opts[:module_path]))
+          end
+        end
+
         private
 
-        def plugin_name
+        # this is the name of the plugin the user wants to create
+        def external_plugin_name
           context.plugin_name
         end
 
         def create_main_file
-          file_path = File.join(module_path, 'lib', "retrospec-#{plugin_name}.rb" )
+          file_path = File.join(module_path, 'lib', "retrospec-#{external_plugin_name}.rb" )
           template  = File.join(template_dir, 'retrospec-main-plugin-file.rb.erb' )
           safe_create_template_file(file_path, template, context)
         end
 
         def create_plugin_file
-          file_path = File.join(module_path, 'lib', 'retrospec', 'plugins', 'v1', 'plugin', "#{plugin_name}.rb" )
+          file_path = File.join(module_path, 'lib', 'retrospec', 'plugins', 'v1', 'plugin', "#{external_plugin_name}.rb" )
           template  = File.join(template_dir, 'plugin-name.rb.erb' )
           safe_create_template_file(file_path, template, context)
         end

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

@@ -1,8 +1,8 @@
 require 'facets'
-
+require 'retrospec/plugins/v1/context_object'
 module PluginGen
 
-  class SpecObject
+  class SpecObject < Retrospec::Plugins::V1::ContextObject
     attr_reader :instance, :module_path, :capitalized_plugin_name, :plugin_name, :snakecase_plugin_name
 
     def initialize(mod_path, data)
@@ -18,12 +18,9 @@ module PluginGen
       @capitalized_plugin_name ||= plugin_name.capitalize
     end
 
+    # the name of the plugin you wish to create, automatically is inherited from the basename of the module_path
     def plugin_name
       @plugin_name ||= instance[:name]
     end
-
-    def get_binding
-      binding
-    end
   end
 end

data/lib/retrospec/plugins/v1/plugin/templates/module_files/README.md

@@ -9,6 +9,14 @@ bundle install
 bundle exec rake spec
 ```
 
+## Install
+
+`gem install retrospec-<%= plugin_name %>`
+
+## Usage
+
+`retrospec -m /tmp/test4 <%= plugin_name %> -h`
+
 ## Contributing to retrospec-<%= plugin_name %>
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.

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

@@ -1,6 +1,10 @@
+require 'retrospec/plugins/v1/context_object'
+
 module <%= capitalized_plugin_name %>
+  # this object is passed to the templates for erb template rendering
+  # you can use data contained in this object in your templates
+  class SpecObject < Retrospec::Plugins::V1::ContextObject
 
-  class SpecObject
     attr_reader :instance, :module_path, :module_name
 
     def initialize(mod_path, data)
@@ -15,9 +19,5 @@ module <%= capitalized_plugin_name %>
     def module_name
       instance[:name]
     end
-
-    def get_binding
-      binding
-    end
   end
 end

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

@@ -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

data/retrospec-plugingen.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "retrospec-plugingen"
-  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 = ""
   s.email = "corey@logicminds.biz"
   s.extra_rdoc_files = [
@@ -54,8 +54,8 @@ Gem::Specification.new do |s|
     s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<retrospec>, [">= 0"])
       s.add_runtime_dependency(%q<facets>, [">= 0"])
+      s.add_runtime_dependency(%q<retrospec>, ["~> 0.2"])
       s.add_development_dependency(%q<rspec>, ["~> 3.2"])
       s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0"])
@@ -63,8 +63,8 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<simplecov>, [">= 0"])
       s.add_development_dependency(%q<pry>, [">= 0"])
     else
-      s.add_dependency(%q<retrospec>, [">= 0"])
       s.add_dependency(%q<facets>, [">= 0"])
+      s.add_dependency(%q<retrospec>, ["~> 0.2"])
       s.add_dependency(%q<rspec>, ["~> 3.2"])
       s.add_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_dependency(%q<bundler>, ["~> 1.0"])
@@ -73,8 +73,8 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<pry>, [">= 0"])
     end
   else
-    s.add_dependency(%q<retrospec>, [">= 0"])
     s.add_dependency(%q<facets>, [">= 0"])
+    s.add_dependency(%q<retrospec>, ["~> 0.2"])
     s.add_dependency(%q<rspec>, ["~> 3.2"])
     s.add_dependency(%q<rdoc>, ["~> 3.12"])
     s.add_dependency(%q<bundler>, ["~> 1.0"])

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: retrospec-plugingen
 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: retrospec
+  name: facets
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -25,19 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: facets
+  name: retrospec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement