knife-skeleton 0.0.1 → 0.0.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NTgxM2Y1NzhmZGVhZGM5ZGYzNTZhMWE2Mzc1OTRkOWExMjczYTBhYQ==
+    NzU0M2VlMTE1OGM1ZWJkZjQ1MDU5MjcyOTUxYzk1NjMxZmY4Zjc4MQ==
   data.tar.gz: !binary |-
-    ODBmYjk0OWUwYzJlZjNmNTgzZWQwYTczNjgzMDRmZThhYTZjMDg5Nw==
+    YTE2NjM3NzlmZjc3MjdjMDU1MGFjYjZmMzQzNzZiNmI1OTQwYWE0MA==
 SHA512:
   metadata.gz: !binary |-
-    OTc1ZjBiMWQ1M2FjODk5MDdlZjRiOTVmYWM4NmRkY2ZhMmFiYjU1Y2NkMjRj
-    NGMyYmMwYmNlY2UwZTIxYzJlODVjNDg1NWM4NmQyNjA5YTRmNmIyMDA0N2Zl
-    NWFhYzY2MDc2NmE1YzIyZjExNjNhNzdiY2Y3MmYzYWJlMWRiZTE=
+    MjlhYzlkZDE1OGQwZDMwMWY5ZDg5MDUxYmJiOTY4MmYzMGEyOGFiMjUyODVh
+    ODQxMDM0ODkyNjM5N2IyYmE3NGY0NGU1ZDdiNjYwMWNlM2E2ZDE2MGE5NDZl
+    YjhlOWJhNGEwZjM2MjI5ZDNjZjk3ZDJmOGI3MzYxZmIxZWMwZDg=
   data.tar.gz: !binary |-
-    M2UzOTgxZTg2MjgwZjhjNjQ0NWUzNTEwMzczYTE5MGU4ODM4Nzk4YTliNDcw
-    MDJkZjYwNDQ0MjNlMTdhNTM3YWRmYTkwMDVlNDBlMTk5Y2Q3NWM5OGI4MzZj
-    OGMyMTllMzUxMmJlNGZlN2E2NDVlMGFmOGEyOGZhYmExOTlkYjI=
+    NjY4YmFkY2I1MTZkOWM3NGFjMDMwYjlkMDU1NTJjNWI4MTU2NjRjMmYyZmY5
+    ZjM5NWU3YWQxNWI3OGJkNmRiNDRlNDlkZGRhYTk0MTU1NDQ5NzZjOWMwMTY4
+    OGI0NDViZTNiZjdkM2IzYmI3M2ZmMzA3NGYyY2E0NzY2ZDA2MzI=

data/README.md

@@ -2,6 +2,10 @@
 
 Knife plugin to create skeleton integrating chefspec, rubocop, foodcritic, knife test and kitchen.
 
+##Motivation
+
+The current "knife cookbook create" does not include tests, and many of us need to use chefspec, checkstyle and kitchen.
+
 ##Installation
 
 With rubygems:
@@ -52,9 +56,6 @@ Create your cookbook
 knife skeleton create my-cookbook -o /tmp/cookbooks
 ```
 
-##Motivation
-The current "knife cookbook create" does not include tests, and many of us need to use chefspec, checkstyle and kitchen.
-
 ## License and Authors
 
 Authors:

data/knife_skeleton.gemspec

@@ -2,8 +2,8 @@
 require File.expand_path('../lib/knife_skeleton/version', __FILE__)
 
 Gem::Specification.new do |s|
-  s.authors       = ['Pierre Rambaud']
-  s.email         = ['pierre.rambaud@numergy.com']
+  s.authors       = ['Pierre Rambaud', 'Antoine Rouyer']
+  s.email         = ['pierre.rambaud@numergy.com', 'antoine.rouyer@numergy.com']
   s.description   = <<-eos
 Knife plugin to create skeleton with rubocop, chefspec, kitchen,
 strainer, etc...
@@ -20,7 +20,7 @@ eos
   s.version       = KnifeSkeleton::VERSION
 
   s.add_dependency 'chef', '~> 0.10'
-  s.add_dependency 'erubis', '~> 0.2'
+  s.add_dependency 'erubis', '~> 2.7'
 
   s.add_development_dependency 'rake', '~> 10'
   s.add_development_dependency 'rspec', '~> 2.14'

data/lib/chef/knife/skeleton_create.rb

@@ -45,7 +45,8 @@ eos
 
     # Public: Knife skeleton create runner
     #
-    # Returns void
+    # @return [Void]
+    #
     def run
       self.config = Chef::Config.merge!(config)
       if @name_args.length < 1
@@ -94,7 +95,8 @@ eos
     #   cookbook_license_name
     #   # => 'GNU Public LIcense 3.0'
     #
-    # Returns string
+    # @return [String]
+    #
     def cookbook_license_name
       case cookbook_license
       when 'apachev2'
@@ -114,14 +116,14 @@ eos
 
     # Protected: Create cookbook directories
     #
-    # cookbook_path - Cookbook path
-    # cookbook_name - Cookbook name
-    #
     # Examples:
     #
     #   create_cookbook_directories('/tmp', 'my-cookbook')
     #
-    # Returns void
+    # @param [String] cookbook_path Cookbook path
+    # @param [String] cookbook_name Cookbook name
+    # @return [Void]
+    #
     def create_cookbook_directories(cookbook_path, cookbook_name)
       ui.msg("** Create cookbook #{cookbook_name} into #{cookbook_path}")
 
@@ -147,13 +149,13 @@ eos
 
     # Protected: Create cookbook files from templates
     #
-    # params - An Hash of parameters to use for binding template
-    #
     # Examples:
     #
     #   create_cookbook_templates({ cookbook_path: '/tmp', title: 'GoT' })
     #
-    # Returns void
+    # @params [Hash] params An Hash of parameters to use for binding template
+    # @return [Void]
+    #
     def create_cookbook_templates(params)
       params[:license_content] = File.read(
         File.join(
@@ -182,14 +184,14 @@ eos
 
     # Protected: Copy all files into the cookbook
     #
-    # cookbook_path - Cookbook path
-    # cookbook_name - Cookbook name
-    #
     # Examples:
     #
     #   create_cookbook_files('/tmp', 'my-cookbook')
     #
-    # Returns void
+    # @param [String] cookbook_path Cookbook path
+    # @param [String] cookbook_name Cookbook name
+    # @return [Void]
+    #
     def create_cookbook_files(
       cookbook_path,
       cookbook_name
@@ -208,15 +210,15 @@ eos
 
     # Protected: Copy files
     #
-    # cookbook_path - Cookbook path
-    # cookbook_name - Cookbook name
-    # file_name     - File name to used without erb extension
-    #
     # Examples:
     #
     #   copy_file('/tmp', '/cookbooks', 'my-cookbook', 'README.md')
     #
-    # Returns void
+    # @param [String] cookbook_path Cookbook path
+    # @param [String] cookbook_name Cookbook name
+    # @param [String] file_name    File name to used without erb extension
+    # @return [Void]
+    #
     def copy_file(cookbook_path, cookbook_name, file_name)
       dst = File.join(
         cookbook_path,
@@ -240,14 +242,14 @@ eos
 
     # Protected: Render template
     #
-    # file_name - File name to used without erb extension
-    # params    - Binding parameters
-    #
     # Examples:
     #
     #   render_template('/tmp', 'my-file.rb', { title: 'GoT' })
     #
-    # Returns void
+    # @param [String] file_name File name to used without erb extension
+    # @param [Hash]   params    Binding parameters
+    # @return [void]
+    #
     def render_template(file_name, params)
       dst = File.join(
         params[:cookbook_path],
@@ -280,8 +282,6 @@ eos
 
     # Protected: Test if parameter is empty
     #
-    # parameter - The tested parameter
-    #
     # Examples:
     #
     #   parameter_empty?('my string')
@@ -289,28 +289,33 @@ eos
     #   parameter_empty?('')
     #   # => true
     #
-    # Returns string
+    # @param [Mixed] parameter The tested parameter
+    # @return [String]
+    #
     def parameter_empty?(parameter)
       parameter.nil? || parameter.empty?
     end
 
     # Protected: Get cookbook copyright
     #
-    # Returns string
+    # @return [String]
+    #
     def cookbook_copyright
       config[:cookbook_copyright] || 'YOUR_COMPANY_NAME'
     end
 
     # Protected: Get maintener email
     #
-    # Returns string
+    # @return [String]
+    #
     def cookbook_email
       config[:cookbook_email] || 'YOUR_EMAIL'
     end
 
     # Protected: Get license name
     #
-    # Returns string
+    # @return [String]
+    #
     def cookbook_license
       ((config[:cookbook_license] != 'false') &&
         config[:cookbook_license]) || 'none'
@@ -318,14 +323,16 @@ eos
 
     # Protected: Get readme format
     #
-    # Returns string
+    # @return [String]
+    #
     def cookbook_readme_format
       ((config[:readme_format] != 'false') && config[:readme_format]) || 'md'
     end
 
     # Protected: Get files directory
     #
-    # Returns string
+    # @return [String]
+    #
     def files_directory
       File.expand_path(
         '../../../../files',
@@ -335,7 +342,8 @@ eos
 
     # Protected: Get templates directory
     #
-    # Returns string
+    # @return [String]
+    #
     def templates_directory
       File.expand_path(
         '../../../../templates',

data/lib/knife_skeleton/template.rb

@@ -6,15 +6,14 @@ module KnifeSkeleton
   class Template
     # Static: Render template with Erubis
     #
-    # template - Template string to used for rendering
-    # data     - Data binding
-    #
     # Examples:
     #
     #   create_cookbook_directories('Hello <%= title %>', {title: 'GoT'})
     #   # => "Hello GoT"
     #
-    # Returns string
+    # @param [String] template Template string to used for rendering
+    # @param [String] data     Data binding
+    # return [String]
     def self.render(template, data)
       eruby = Erubis::Eruby.new(template)
       output = eruby.result(data)

data/lib/knife_skeleton/version.rb

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 # Knife skeleton version
 module KnifeSkeleton
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
   MAJOR, MINOR, TINY = VERSION.split('.')
 end

metadata

@@ -1,10 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: knife-skeleton
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Pierre Rambaud
+- Antoine Rouyer
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -30,14 +31,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '2.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -115,6 +116,7 @@ description: ! 'Knife plugin to create skeleton with rubocop, chefspec, kitchen,
 '
 email:
 - pierre.rambaud@numergy.com
+- antoine.rouyer@numergy.com
 executables: []
 extensions: []
 extra_rdoc_files: []