puppet-retrospec 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 022b797256a583f5e85ef8b751871581c90014e1
-  data.tar.gz: 40dec9863afc4e2abbae8e4a3def3634e7a57927
+  metadata.gz: 002916714e063012f04646ccf19f1b8a1187fcf0
+  data.tar.gz: 0face14d5260e31e4b6f5ff5ec1e9d67f1847b7e
 SHA512:
-  metadata.gz: 0fe4e049e0a434964cf2ab9ded54a3a57dcf071ef41b5451e238b3ffa5200489112e82afa004e602325c675d02c43308d12e3b1ef2860f0da01046e8d4123da2
-  data.tar.gz: 80e3c5c885a461a1ed6b158eadc7fc4948716c2c8c7b349d6f3e9b85c13237011dd5c6f43ac4b308b755f2ad3ccc2a1e189f08342f7a6daef8bd696a4c054e69
+  metadata.gz: 356c8bec48b1bee94dfbefba8b7da3eaaab8758c420c391dacec95022bd8511db15c95c4ebd114b0a7e8a4d29b671d9ddde959501767d5679ae1b3fa989e3467
+  data.tar.gz: 9cf6823f600855200d52f3ea47f637256cf68b30ad5e01ac5f095224d046eb67f984be2bcbc7d5a2e2f6d01d26e4211e5830189e367d42c347453cb14313b47c

data/.gitlab-ci.yml

@@ -5,6 +5,8 @@ before_script:
   - bundle install --without development build
   - bundle exec ruby lib/retrospec/plugins/v1/plugin/templates/clone-hook
 
+image: ruby:2.1
+
 ruby193:
   stage: test
   script:
@@ -38,10 +40,34 @@ ruby2.3:
 
 stages:
   - test
+  - release
   - deploy
 
+rubocop_ruby:
+  stage: validate
+  allow_failure: true
+  only:
+    - branches
+  tags:
+    - ruby2.2
+  script:
+    - bundle install
+    - bundle exec rubocop -D
+
+bump_and_tag:
+  type: release
+  when: manual
+  tags:
+    - ruby2.2
+  only:
+    - master@puppet-debugger/puppet-debugger
+  script:
+    - gem install release_me
+    - bump_and_tag
+
 production:
-  image: ruby:2.1
+  tags:
+    - ruby2.2
   before_script:
     - gem install dpl
   type: deploy

data/.release_me.yaml

@@ -0,0 +1,11 @@
+vcs:
+  author_email: autobot@nwops.io
+  author_name: Autobot
+  provider: gitlab
+  branch_name: master
+
+adapter:
+  version_file_relative_path: 'lib/retrospec/v1/plugin/version.rb'
+  version_field: 'VERSION'
+  version_type: 'semver'
+  adapter_name: 'custom'

data/.rubocop.yml

@@ -22,6 +22,8 @@ Metrics/LineLength:
   Max: 128
   Enabled: false
 
+Metrics/BlockLength:
+  Enabled: false
 # dealbreaker:
 #Style/TrailingComma:
 #  Enabled: false

data/.rubocop_todo.yml

@@ -6,9 +6,9 @@
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-Style/WordArray:
+Style/MultilineIfModifier:
   Exclude:
-    - lib/retrospec/plugins/v1/plugin/generators/type_generator.rb
+    - 'lib/retrospec/plugins/v1/plugin/generators/serializers/rspec_dumper_full.rb'
 
 Lint/ShadowedException:
   Exclude:
@@ -52,7 +52,7 @@ Lint/EndAlignment:
     - 'lib/retrospec/plugins/v1/plugin/generators/parsers/facter.rb'
 
 # Offense count: 5
-Lint/Eval:
+Security/Eval:
   Exclude:
     - 'lib/retrospec/plugins/v1/plugin/generators/parsers/facter.rb'
     - 'lib/retrospec/plugins/v1/plugin/generators/parsers/function.rb'
@@ -349,6 +349,7 @@ Style/GuardClause:
     - 'lib/retrospec/plugins/v1/plugin/generators/resource_base_generator.rb'
     - 'lib/retrospec/plugins/v1/plugin/puppet.rb'
     - 'lib/retrospec/plugins/v1/plugin/templates/clone-hook'
+    - 'lib/retrospec/plugins/v1/plugin/generators/module_generator.rb'
 
 # Offense count: 2
 Style/IfInsideElse:
@@ -414,7 +415,7 @@ Style/LeadingCommentSpace:
 
 # Offense count: 3
 # Cop supports --auto-correct.
-Style/MethodCallParentheses:
+Style/MethodCallWithoutArgsParentheses:
   Exclude:
     - 'lib/retrospec/plugins/v1/plugin/generators/parsers/facter.rb'
     - 'lib/retrospec/plugins/v1/plugin/generators/serializers/rspec_dumper_full.rb'

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 1.3.0
+ * fixes gh-68 - add ability to overwrite generated files
+ * updates README
+ * removes old rakefile code
+ * bumps retrospec gem to 0.5
 ## 1.2.1
  * fix conditional logic preventing hooks from running
 ## 1.2.0

data/Gemfile

@@ -1,22 +1,22 @@
 source 'http://rubygems.org'
 
-gem 'trollop'
-gem 'retrospec', '~> 0.4'
 gem 'awesome_print'
 gem 'facets'
+gem 'retrospec', '~> 0.5'
+gem 'trollop'
 
 group :development do
-  gem 'rdoc', '~> 3.12'
   gem 'pry'
+  gem 'rdoc', '~> 3.12'
 end
 
 group :test do
-  gem 'rubocop', platforms: :ruby_20
-  gem 'rspec', '~> 3.2'
-  gem 'puppet', '4.5.2', :path => 'vendor/gems/puppet-4.5.2'
+  gem 'bundler', '~> 1.0'
+  gem 'fakefs', :require => 'fakefs/safe'
   gem 'json_pure', '= 2.0.1' # force this gem as 2.0.2 requires ruby > 2.0.0
+  gem 'puppet', '4.5.2', :path => 'vendor/gems/puppet-4.5.2'
   gem 'rake'
-  gem 'bundler', '~> 1.0'
+  gem 'rspec', '~> 3.2'
+  gem 'rubocop', platforms: :ruby_20
   gem 'yard', '~> 0.7'
-  gem 'fakefs', :require => 'fakefs/safe'
 end

data/Gemfile.lock

@@ -33,7 +33,7 @@ GEM
     rake (11.3.0)
     rdoc (3.12.2)
       json (~> 1.4)
-    retrospec (0.4.0)
+    retrospec (0.5.0)
       trollop
     rspec (3.5.0)
       rspec-core (~> 3.5.0)
@@ -73,11 +73,11 @@ DEPENDENCIES
   puppet (= 4.5.2)!
   rake
   rdoc (~> 3.12)
-  retrospec (~> 0.4)
+  retrospec (~> 0.5)
   rspec (~> 3.2)
   rubocop
   trollop
   yard (~> 0.7)
 
 BUNDLED WITH
-   1.13.1
+   1.13.7

data/README.md

@@ -51,20 +51,9 @@ TOC Created by [gh-md-toc](https://github.com/ekalinin/github-markdown-toc)
 [![Gem Version](https://badge.fury.io/rb/puppet-retrospec.svg)](http://badge.fury.io/rb/puppet-retrospec)
 
 ## News
-### 6-28-16
-Version 1.0.0 is released with full support for puppet 4.x code.  
-### 1-18-16
-A slew of new features has been added with the 0.12 update. If you already use retrospec to retrofit your modules, now you can use retrospec to generate some of the more advanced puppet module customizations such as:
-
-- custom facts
-- providers
-- custom types
-- functions (v3,v4, and native)
-- parameter schemas  
-
-This has been a feature in the making since Puppetconf 2015.  I would have finished this sooner but was sucked in
-binge watching a bunch of Netflix shows.   Check out `retrospec puppet -h` for a list of all new subcommands.
-
+### 2/1/17
+You can now choose to overwrite files!  This is very useful when updating old module code with newer content.
+See Usage below for how to enable.
 
 ## Install
 `gem install puppet-retrospec`  
@@ -78,6 +67,31 @@ are specified.  Expect to run `retrospec puppet` multiple times throughout the d
 Retrospec will never overwrite a file, so if something already exists retrospec will
 skip the file. Many times you will find yourself deleting existing files and allowing retrospec to recreate them based on updated templates.
 
+### Overwriting files
+As stated above retrospec will not overwrite your files.  However, sometimes recreating files is desired as you change
+your code.  Before '1.3' it was not possible to overwrite files, but now we can safely specify which files should be
+overwritten.  This feature is off by default so you will need to enable it.
+
+To enable please use the global options `--enable-overwrite` or if you want everything `--enable-overwrite-all`
+
+Note: Enabling this feature will prompt you before running destructive operations like:  `y/n/a` where `a` means all.
+
+```
+retrospec -h
+A framework to automate your development workflow by generating common files and test patterns.
+
+Usage: retrospec [global options] plugin [plugin options]
+Available subcommands:
+puppet
+  -e, --enable-overwrite        Enable overwriting of files, will prompt for each file
+  -n, --enable-overwrite-all    Always overwrites files without prompting
+  -m, --module-path=<s>         The path (relative or absolute) to the module directory (default: /Users/cosman/github/puppet-retrospec)
+  -c, --config-map=<s>          The global retrospec config file (default: /Users/cosman/.retrospec/config.yaml)
+  -a, --available-plugins       Show an online list of available plugins
+  -v, --version                 Print version and exit
+  -h, --help                    Show this message
+  
+```
 ### Module Path
 By default the module path is dynamically set based on the current directory.
 If you need to point to a directory outside the current directory you can use the `--module_path` option.  This option is built into the retrospec framework
@@ -214,11 +228,6 @@ retrospec puppet
 ## Dependency
 Retrospec relies heavily on the puppet 3.7.x codebase.  Because of this hard dependency the puppet gem is vendored into the library so there should not be conflicts with your existing puppet gem.  
 
-## Enabling the future parser
-
-`retrospec -m ~/projects/puppet_modules/apache puppet --enable-future-parser`
-
-Please see #future-parser-support for why this might be required.
 
 ## Configuration
  Below is a list of options that you can set in the config file.  Setting these options will help cut down on passing parameters. (/Users/username/.retrospec/config.yaml)  `retrospec -h`
@@ -473,7 +482,7 @@ For now you will probably want to read up on the following documentation:
 
 
 ## How Does it do this
-Basically Retrospec uses the puppet lexer and parser to scan your code in order to fill out some basic templates that will retrofit your puppet module with unit tests.  Currently I rely on the old AST parser to generate all this.  This is why puppet 3.7 is vendored into the gem.
+Basically Retrospec uses the puppet lexer and parser to scan your code in order to fill out some basic templates that will retrofit your puppet module with unit tests.
 
 ## Overriding the Templates
 There may be a time when you want to override the default templates used to generate the rspec related files. By default retrospec will clone these [templates](https://github.com/nwops/retrospec-templates) and place inside the default or specified template directory.  
@@ -555,17 +564,17 @@ Because the code does not rely on catalog compilation we have to build our own s
 2. Find all vardef objects, resolve them if possible and store the values
 3. Anything contained in a block of code is currently ignored, until later refinement.
 
-##Future Parser Support
+## Puppet 4.x Support
 As of 1.0.0 Retrospec Puppet provides full support for code written against the 4.x/future parser.
 If you have 3.x code the 4.x parser may throw errors instead of deprecation warnings.
 If you do not wish to convert your 3.x to 4.x code yet, you will need to use the puppet-retrospec
 version < 1.0.0
 
 
-##Ruby Support
+## Ruby Support
 Currently this library only supports ruby >= 1.9.3.  Since we vendor Puppet 4.5.x you need to have
 a supported ruby version that puppet 4.5 supports which.  
 
-##Paid Support
-Want to see new features developed much faster?  Contact me about a support contract so I can develop this tool during
+## Paid Support
+Want to see new features developed faster?  Contact me about a support contract so I can develop this tool during
 the day instead of after work.  contact: corey@nwops.io

data/Rakefile

@@ -1,9 +1,7 @@
 # encoding: utf-8
 
-require 'rubygems'
-require 'bundler'
-require "bundler/gem_tasks"
-require "rake/testtask"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 begin
   Bundler.setup(:default, :development, :test)
 rescue Bundler::BundlerError => e
@@ -11,11 +9,8 @@ rescue Bundler::BundlerError => e
   $stderr.puts 'Run `bundle install` to install missing gems'
   exit e.status_code
 end
-require 'rake'
-require 'rspec/core'
-require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb'].exclude('spec/fixtures/**/*_spec.rb')
+  spec.pattern = FileList['spec/**/*_spec.rb'].exclude('spec/fixtures/**/*')
 end
 
 task :default => :spec

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

@@ -44,7 +44,7 @@ module Retrospec
         # all options here are available in the config passed into config object
         # returns the parameters
         def self.run_cli(global_opts, args=ARGV)
-          func_types = ['v3', 'v4', 'native']
+          func_types = %w(v3 v4 native)
           func_type  = global_opts['plugins::puppet::default_function_version'] || 'v4'
           test_type  = global_opts['plugins::puppet::default_function_test_type'] || 'rspec'
           sub_command_opts = Trollop.options(args) do

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

@@ -30,7 +30,6 @@ module Retrospec
           sub_command_opts = Trollop.options(args) do
             banner <<-EOS
 Generates a new module with the given name and namespace
-
             EOS
             opt :name, 'The name of the module you wish to create', :type => :string, :required => true, :short => '-n',
                                                                     :default => File.basename(global_opts[:module_path])

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

@@ -7,17 +7,17 @@ module Retrospec
         attr_reader :template_dir, :context
 
         # this is the list of core puppet types that cannot be recreated
-        CORE_TYPES = ["augeas", "computer", "cron", "exec", "file", "filebucket",
-           "group", "host", "interface", "k5login", "macauthorization", "mailalias",
-           "maillist", "mcx", "mount", "nagios_command", "nagios_contact",
-           "nagios_contactgroup", "nagios_host", "nagios_hostdependency",
-           "nagios_hostescalation", "nagios_hostextinfo", "nagios_hostgroup",
-           "nagios_service", "nagios_servicedependency",
-           "nagios_serviceescalation", "nagios_serviceextinfo",
-           "nagios_servicegroup", "nagios_timeperiod", "notify", "package",
-           "resources", "router", "schedule", "scheduled_task", "selboolean",
-           "selmodule", "service", "ssh_authorized_key", "sshkey", "stage",
-           "tidy", "user", "vlan", "yumrepo", "zfs", "zone", "zpool"]
+        CORE_TYPES = %w(augeas computer cron exec file filebucket
+           group host interface k5login macauthorization mailalias
+           maillist mcx mount nagios_command nagios_contact
+           nagios_contactgroup nagios_host nagios_hostdependency
+           nagios_hostescalation nagios_hostextinfo nagios_hostgroup
+           nagios_service nagios_servicedependency
+           nagios_serviceescalation nagios_serviceextinfo
+           nagios_servicegroup nagios_timeperiod notify package
+           resources router schedule scheduled_task selboolean
+           selmodule service ssh_authorized_key sshkey stage
+           tidy user vlan yumrepo zfs zone zpool)
 
         # retrospec will initilalize this class so its up to you
         # to set any additional variables you need to get the job done.

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

@@ -94,17 +94,19 @@ module Retrospec
           # a list of subcommands for this plugin
           sub_commands  = %w(new_module new_fact new_type new_provider new_function new_report)
           if sub_commands.count > 0
-            sub_command_help = "Subcommands:\n#{sub_commands.join("\n")}\n"
+            sub_command_help = "Subcommands:\n  #{sub_commands.join("\n  ")}\n"
           else
             sub_command_help = ''
           end
           plugin_opts = Trollop.options(args) do
             version "Retrospec puppet plugin: #{Retrospec::Puppet::VERSION} (c) Corey Osman"
             banner <<-EOS
-            Generates puppet rspec test code based on the classes and defines inside the manifests directory.\n
-            #{sub_command_help}
+Generates puppet rspec test code and puppet module components.
+
+#{sub_command_help}
 
             EOS
+
             opt :template_dir, 'Path to templates directory (only for overriding Retrospec templates)', :type => :string,
             :required => false, :default => template_dir
             opt :scm_url, 'SCM url for retrospec templates', :type => :string, :required => false,

data/lib/retrospec/plugins/v1/plugin/templates/clone-hook

@@ -29,6 +29,7 @@ end
 
 def update_templates(git_url, dest, branch = 'master')
   create_repo(dest, git_url, branch)
+  puts "Attempting to connect to #{@template_repo}"
   puts `git --git-dir #{dest}/.git --work-tree #{dest} pull`
   dest
 end
@@ -38,7 +39,7 @@ def connected?(url)
     # if the user wants internet but doesn't want cloning, allow them to set this variable
     return false
   end
-  open('http://www.google.com/') rescue false
+  true
 end
 
 # sometimes I work on an airplane and don't care to clone everything all the time

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

@@ -1,5 +1,5 @@
 module Retrospec
   module Puppet
-    VERSION = '1.2.1'
+    VERSION = '1.3.0'
   end
 end

data/puppet-retrospec.gemspec

@@ -23,31 +23,10 @@ Gem::Specification.new do |s|
   s.licenses = ["MIT"]
   s.rubygems_version = "2.4.5.1"
   s.summary = "Generates puppet rspec test code based on the classes and defines inside the manifests directory. Aims to reduce some of the boilerplate coding with default test patterns."
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 4
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<trollop>, [">= 0"])
-      s.add_runtime_dependency(%q<retrospec>, ["~> 0.4"])
-      s.add_runtime_dependency(%q<awesome_print>, [">= 0"])
-      s.add_runtime_dependency(%q<facets>, [">= 0"])
-      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_development_dependency(%q<pry>, [">= 0"])
-    else
-      s.add_dependency(%q<trollop>, [">= 0"])
-      s.add_dependency(%q<retrospec>, ["~> 0.4"])
-      s.add_dependency(%q<awesome_print>, [">= 0"])
-      s.add_dependency(%q<facets>, [">= 0"])
-      s.add_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_dependency(%q<pry>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<trollop>, [">= 0"])
-    s.add_dependency(%q<retrospec>, ["~> 0.4"])
-    s.add_dependency(%q<awesome_print>, [">= 0"])
-    s.add_dependency(%q<facets>, [">= 0"])
-    s.add_dependency(%q<rdoc>, ["~> 3.12"])
-    s.add_dependency(%q<pry>, [">= 0"])
-  end
+  s.add_runtime_dependency(%q<trollop>, [">= 0"])
+  s.add_runtime_dependency(%q<retrospec>, ["~> 0.5"])
+  s.add_runtime_dependency(%q<awesome_print>, [">= 0"])
+  s.add_runtime_dependency(%q<facets>, [">= 0"])
+  s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+  s.add_development_dependency(%q<pry>, [">= 0"])
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puppet-retrospec
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Corey Osman
@@ -14,84 +14,84 @@ dependencies:
   name: trollop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: retrospec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: facets
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.12'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Retrofits and generates valid puppet rspec test code to existing modules
@@ -103,14 +103,15 @@ extra_rdoc_files:
 - LICENSE
 - README.md
 files:
-- ".dockerignore"
-- ".document"
-- ".gitignore"
-- ".gitlab-ci.yml"
-- ".overcommit.yml"
-- ".rspec"
-- ".rubocop.yml"
-- ".rubocop_todo.yml"
+- .dockerignore
+- .document
+- .gitignore
+- .gitlab-ci.yml
+- .overcommit.yml
+- .release_me.yaml
+- .rspec
+- .rubocop.yml
+- .rubocop_todo.yml
 - CHANGELOG.md
 - DEVELOPMENT.md
 - Dockerfile
@@ -1755,17 +1756,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.0.14.1
 signing_key: 
 specification_version: 4
 summary: Generates puppet rspec test code based on the classes and defines inside