falkorlib 0.3.8 → 0.3.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ac83da0f27d90c212ef11d4eb49797531aa5e182
-  data.tar.gz: f26283dc8a2b3d61a2d5634875d7b5c8e837d594
+  metadata.gz: 552344c4593779ef9a71c505a6cf36944076085a
+  data.tar.gz: c2b78c907bd0a3793919e86285b8fc05d3329248
 SHA512:
-  metadata.gz: c594d1cc7ae26b01db0869fe26c8f2e6a4e297192f7f2228175a795e1dbeeed5ca84b083658d1a62883b13e14f2c45225ac24ceecad7149f9fff0479366e0d12
-  data.tar.gz: 405cf89860590016e86e3529db29762d78a089a111c0ebecd100ca331cdb582d57e9b626f5b2de552b3c06f5b074a26cd17dee4fc674a41b6086dc695e21e824
+  metadata.gz: 80190e05c95c7615078dbf48e6fe15a8cefa4b3262d4031e3f9dff71031188a6f5c820d427cf13c2bf77c9ce6c286a1ec1a096d6aa27dc6bbe387c1b9cd15206
+  data.tar.gz: e954e17b3e2f48867d0bb968cdd70c9c8c005dfe1e68203d6b89fe4f94c341a92ab90fc078bb15a2b9812f2fd56f245ce7a8535bd487f7f9e1799aef3f4925b4

data/.gitignore

@@ -9,3 +9,4 @@ doc/api
 *~
 tmp/
 *.noespec
+/.falkorlib.yaml

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    falkorlib (0.3.8)
+    falkorlib (0.3.9)
       awesome_print (~> 1.2)
       configatron (~> 3.2)
       diffy (>= 3.0)

data/README.md

@@ -70,8 +70,9 @@ This library features two aspects
             	c.debug = true
         	end
   	
-    You can also place a special file `.falkorlib.yaml` to customize the
-    FalkorLib settings 
+    __IMPORTANT__: You can also place a special file `.falkorlib.yaml` to customize the
+    FalkorLib settings. Most probably, you shall ignore this file in your
+    `.gitignore` so you can place there your private settings (tokens etc.) 
    	 
   * `FalkorLib::Git`: all [git](http://git-scm.com/) operations
   * `FalkorLib::GitFlow`: all [git-flow](http://nvie.com/posts/a-successful-git-branching-model/) operations
@@ -374,11 +375,22 @@ rake version:bump:patch       # Prepare the patch release of the repository
 rake version:info             # Get versioning information
 rake version:release          # Finalize the release of a given bumped version
 ```
+If your gem is coupled with [Code Climate](https://codeclimate.com/), you might
+wish to set the code climate token to report the test coverage for you gem (see
+[these instructions](http://docs.codeclimate.com/article/104-how-do-i-set-up-test-coverage-for-one-of-my-repos)). 
+To avoid exposing this token in your (potentially public) repository, simply
+set that token in `.falkorlib.yaml` (ignored you shall ignore in your
+`.gitignore`) as follows: 
 
+```
+:tokens:
+  :code_climate: 'ACDDD1111222223333....'
+```
 
-## Implementation details
+## FalkorLib Developments / Implementation details
 
-If you want to contribute to the code, you shall be aware of the way I organize this gem and implementation details.   
+If you want to contribute to the code, you shall be aware of the way I organized
+this gem and its implementation details.    
 
 ### [RVM](https://rvm.io/) setup
 
@@ -429,7 +441,7 @@ Also, to facilitate the tracking of remote branches, you probably wants to insta
 
 Then, to make your local copy of the repository ready to use my git-flow workflow, you have to run the following commands once you cloned it for the first time:
 
-      $> rake setup # Not yet implemented!
+      $> rake setup 
 
 ### Working in a separate project
 
@@ -446,7 +458,7 @@ To illustrate the usage of the library as a regular user would do, you are advis
 
 	$> cat cat Gemfile 
 	source "https://rubygems.org"
-	gem 'falkorlib', :path => '~/git/github.com/Falkor/falkorlib'   # or whichever path that works for you
+	gem 'falkorlib'  #, :path => '~/git/github.com/Falkor/falkorlib'   # or whichever path that works for you
 
 Adapt the `Rakefile` and `tester.rb` file to reflect your tests.
 

data/lib/falkorlib/config.rb

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 ################################################################################
-# Time-stamp: <Fri 2014-08-29 14:06 svarrette>
+# Time-stamp: <Lun 2014-09-01 09:37 svarrette>
 ################################################################################
 # FalkorLib Configuration
 #
@@ -48,6 +48,9 @@ module FalkorLib #:nodoc:
 		    },
 		    :templates => {
 			    :puppet => {}
+		    },
+		    :tokens => {
+			    :code_climate => ''
 		    }
         }
 

data/lib/falkorlib/puppet/modules.rb

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 ################################################################################
-# Time-stamp: <Sun 2014-08-31 16:24 svarrette>
+# Time-stamp: <Lun 2014-09-01 21:46 svarrette>
 ################################################################################
 # Interface for the main Puppet Module operations
 #
@@ -131,7 +131,7 @@ module FalkorLib  #:nodoc:
                 # Bootstrap the directory
                 templatedir = File.join( FalkorLib.templates, 'puppet', 'modules')
                 init_from_template(templatedir, moduledir, config, {
-                                       :erb_exclude => [ 'templates\/[^\/]*\.erb$' ]
+                                       :erb_exclude => [ 'templates\/[^\/]*variables\.erb$' ]
                                    })
                 # Rename the files / element templatename
                 Dir["#{moduledir}/**/*"].each do |e|
@@ -162,7 +162,7 @@ module FalkorLib  #:nodoc:
                         info "=> preparing git-flow feature for the newly created module '#{config[:name]}'"
                         FalkorLib::GitFlow.start('feature', "bootstraping", moduledir)
                     end
-                    [ 'metadata.json', 'LICENSE', '.gitignore', 'Gemfile', 'Rakefile'].each do |f|
+                    [ 'metadata.json', 'doc/', 'LICENSE', '.gitignore', 'Gemfile', 'Rakefile'].each do |f|
                         FalkorLib::Git.add(File.join(moduledir, f))
                     end
                 end
@@ -287,12 +287,12 @@ module FalkorLib  #:nodoc:
                     resulttmp = result.dup
                     (result - result2).each do |x|
                         Dir["#{moduledir}/**/*.pp"].each do |ppfile|
-                            File.read(ppfile).scan(/^[ \t]*include.*$|^[ \t]*require.*$/).each do |line|
-                                if line.scan(">").length == 0
-                                    result << line.gsub(/^[ \t]*(include|require) ([\"']|)([0-9a-zA-Z:{$}\-]*)([\"']|)/, '\3').split("::").first
-                                end
-                            end
-                        end
+				            File.read(ppfile).scan(/^\s*(include|require|class\s*{)\s*["']?(::)?([0-9a-zA-Z:{$}\-]*)["']?/) do |m|
+					            next if $3.nil?
+					            entry = $3.split('::').first 
+					            result << entry unless entry.nil? or entry.empty?
+				            end 
+			            end 
                     end
                     result.uniq!
                     result2 = resulttmp.dup

data/lib/falkorlib/tasks/puppet_modules.rake

@@ -1,7 +1,7 @@
 # -*- encoding: utf-8 -*-
 ################################################################################
 # puppet_modules.rake - Special tasks for the management of Puppet modules
-# Time-stamp: <Sat 2014-08-30 22:27 svarrette>
+# Time-stamp: <Lun 2014-09-01 16:38 svarrette>
 #
 # Copyright (c) 2014 Sebastien Varrette <Sebastien.Varrette@uni.lu>
 #               http://varrette.gforge.uni.lu
@@ -65,24 +65,64 @@ namespace :puppet do
                 FalkorLib::Puppet::Modules.parse()
             end # task parse
 
+			###########   puppet:module:validate   ###########
+			desc "Validate manifests, templates, and ruby files"
+			task :validate do
+				Dir['manifests/**/*.pp'].each do |manifest|
+					sh "puppet parser validate --noop #{manifest}"
+				end
+				Dir['spec/**/*.rb','lib/**/*.rb'].each do |ruby_file|
+					sh "ruby -c #{ruby_file}" unless ruby_file =~ /spec\/fixtures/
+				end
+				Dir['templates/**/*.erb'].each do |template|
+					sh "erb -P -x -T '-' #{template} | ruby -c"
+				end
+			end
+			
+			###########   puppet:module:classes   ###########
+			desc "Parse the module for classes definitions"
+			task :classes do |t|
+				c = FalkorLib::Puppet::Modules.classes()
+				info "Implemented classes:"
+				puts c.empty? ? red('NONE') : c.to_yaml				
+			end # task classes 
+
+			###########   puppet:module:definitions   ###########
+			desc "Parse the module for definitions"
+			task :definitions do |t|
+				d = FalkorLib::Puppet::Modules.definitions()
+				info "Implemented definitions:"
+				puts d.empty? ? red('NONE') : d.to_yaml				
+			end # task definitions
+
+			###########   puppet:module:deps   ###########
+			desc "Parse the module for its exact dependencies"
+			task :deps do |t|
+				d = FalkorLib::Puppet::Modules.deps()
+				info "Module dependencies:"
+				puts d.empty? ? red('NONE') : d.to_yaml				
+			end # task deps
+
 
         end
     end # namespace module
 end # namespace puppet
 
 #.....................
-namespace :module do
+namespace :templates do
 	namespace :upgrade do
 		###########   module:upgrade:readme   ###########
 		task :readme do |t|
 			#info "#{t.comment}"
 			FalkorLib::Puppet::Modules.upgrade()
 		end 
-
-
 	end # namespace upgrade
 end # namespace module
 
+[ 'major', 'minor', 'patch' ].each do |level|
+	task "version:bump:#{level}" => 'puppet:module:validate'
+end 
+
 #task 'version:release' => 'puppet:module:build'
 Rake::Task["version:release"].enhance do
   Rake::Task["puppet:module:build"].invoke

data/lib/falkorlib/tasks/rspec.rake

@@ -26,49 +26,66 @@
 # http://relishapp.com/rspec
 #
 begin
-  require "rspec/core/rake_task"
-  desc "Run RSpec code examples '*_spec.rb' from the spec/ directory"
-  RSpec::Core::RakeTask.new(:rspec) do |t|
-    # Glob pattern to match files.
-		#t.pattern = "spec/**/common_*.rb"
-	#t.pattern = "spec/**/versioning_*spec.rb"
-		#t.pattern = "spec/**/*puppet*spec.rb"
+    require "rspec/core/rake_task"
+    desc "Run RSpec code examples '*_spec.rb' from the spec/ directory"
+    RSpec::Core::RakeTask.new(:rspec) do |t|
+        # Glob pattern to match files.
+        #t.pattern = "spec/**/common_*.rb"
+        #t.pattern = "spec/**/versioning_*spec.rb"
+        #t.pattern = "spec/**/*puppet*spec.rb"
 
-    # Whether or not to fail Rake when an error occurs (typically when
-    # examples fail).
-    t.fail_on_error = true
+        # Whether or not to fail Rake when an error occurs (typically when
+        # examples fail).
+        t.fail_on_error = true
 
-    # A message to print to stderr when there are failures.
-    t.failure_message = nil
+        # A message to print to stderr when there are failures.
+        t.failure_message = nil
 
-    # Use verbose output. If this is set to true, the task will print the
-    # executed spec command to stdout.
-    t.verbose = true
+        # Use verbose output. If this is set to true, the task will print the
+        # executed spec command to stdout.
+        t.verbose = true
 
-    # Use rcov for code coverage?
-    t.rcov = false
+        # Use rcov for code coverage?
+        t.rcov = false
 
-    # Path to rcov.
-    t.rcov_path = "rcov"
+        # Path to rcov.
+        t.rcov_path = "rcov"
 
-    # Command line options to pass to rcov. See 'rcov --help' about this
-    t.rcov_opts = []
+        # Command line options to pass to rcov. See 'rcov --help' about this
+        t.rcov_opts = []
 
-    # Command line options to pass to ruby. See 'ruby --help' about this
-    t.ruby_opts = []
+        # Command line options to pass to ruby. See 'ruby --help' about this
+        t.ruby_opts = []
 
-    # Path to rspec
-    t.rspec_path = "rspec"
+        # Path to rspec
+        t.rspec_path = "rspec"
 
-    # Command line options to pass to rspec. See 'rspec --help' about this
-    #t.rspec_opts = ["--color", "--backtrace"] 
-    t.rspec_opts = ["--color", "--format d", "--backtrace"] # "--format d", 
-  end
+        # Command line options to pass to rspec. See 'rspec --help' about this
+        #t.rspec_opts = ["--color", "--backtrace"]
+        t.rspec_opts = ["--color", "--format d", "--backtrace"] # "--format d",
+    end
 rescue LoadError => ex
-  task :spec_test do
-    abort 'rspec is not available. In order to run spec, you must: gem install rspec'
-  end
+    task :spec_test do
+        abort 'rspec is not available. In order to run spec, you must: gem install rspec'
+    end
 ensure
-  task :spec => [:spec_test]
-  task :test => [:spec_test]
+    task :spec => [:spec_test]
+    task :test => [:spec_test]
 end
+
+#.....................
+namespace :setenv do
+    ###########   code_climate   ###########
+    #desc "Set Code Climate token to report rspec results"
+    task :code_climate do |t|
+        unless FalkorLib.config[:tokens].nil? or
+                FalkorLib.config[:tokens][:code_climate].nil? or
+                FalkorLib.config[:tokens][:code_climate].empty?
+            ans = ask(cyan("A Code Climate token is set - Do you want to report on Code Climate the result of the process? (y|N)"), 'No')
+            ENV['CODECLIMATE_REPO_TOKEN'] = FalkorLib.config[:tokens][:code_climate] if ans =~ /y.*/i
+        end
+    end # task code_climate
+
+end # namespace set
+
+task :rspec => 'setenv:code_climate'

data/lib/falkorlib/version.rb

@@ -19,7 +19,7 @@ module FalkorLib #:nodoc:
         # MAJOR: Defines the major version
         # MINOR: Defines the minor version
         # PATCH: Defines the patch version
-	    MAJOR, MINOR, PATCH = 0, 3, 8  
+	    MAJOR, MINOR, PATCH = 0, 3, 9  
 	    
 	    module_function
 	    

data/spec/falkorlib/puppet_modules_spec.rb

@@ -2,7 +2,7 @@
 #########################################
 # puppet_modules_spec.rb
 # @author Sebastien Varrette <Sebastien.Varrette@uni.lu>
-# Time-stamp: <Dim 2014-08-31 22:45 svarrette>
+# Time-stamp: <Lun 2014-09-01 21:51 svarrette>
 #
 # @description Check the Puppet Modules operations
 #
@@ -40,18 +40,19 @@ describe FalkorLib::Puppet::Modules do
 
         it "#init -- create a puppet module" do
             # Prepare answer to the questions
-            Array.new(32).each { |e|  STDIN.should_receive(:gets).and_return('') }
+            Array.new(36).each { |e|  STDIN.should_receive(:gets).and_return('') }
             FalkorLib::Puppet::Modules.init(moduledir)
             templatedir = File.join( FalkorLib.templates, 'puppet', 'modules')
             s = true
+			puts "templatedir = #{templatedir}"
             Dir["#{templatedir}/**/*"].each  do |e|
                 next if File.directory?(e)
                 relative_dir = Pathname.new( File.realpath( File.dirname(e) )).relative_path_from Pathname.new(templatedir)
                 file = e.gsub(/templatename/, "#{name}")
                 filename = File.basename(file)
-                filename = File.basename(file, '.erb') unless file =~ /templates\/toto-variables\.erb/
+                filename = File.basename(file, '.erb') unless file =~ /templates\/toto-variables\.erb/ 
                 f = File.join(moduledir, relative_dir, filename)
-                #puts "checking #{f} - #{File.exists?( f )}"
+                puts "checking #{f} - #{File.exists?( f )}"
                 s &= File.exists?( f )
             end
             s.should be_true

data/spec/falkorlib/versioning_puppet_module_spec.rb

@@ -2,7 +2,7 @@
 #########################################
 # versioning_puppet_module_spec.rb
 # @author Sebastien Varrette <Sebastien.Varrette@uni.lu>
-# Time-stamp: <Dim 2014-08-31 22:00 svarrette>
+# Time-stamp: <Lun 2014-09-01 21:51 svarrette>
 #
 # @description Check the versioning operations on Gems
 #
@@ -53,7 +53,7 @@ describe FalkorLib::Versioning::Puppet do
 
 
             it "#get_version -- get default version #{default_version} after initialization" do
-                Array.new(32).each { |e|  STDIN.should_receive(:gets).and_return('') }
+                Array.new(36).each { |e|  STDIN.should_receive(:gets).and_return('') }
                 FalkorLib::Puppet::Modules.init(moduledir)
                 v = FalkorLib::Versioning.get_version(moduledir)
                 v.should == default_version

data/templates/puppet/modules/manifests/classes/templatename-params.pp.erb

@@ -1,5 +1,5 @@
 # File::      <tt><%= config[:name] %>-params.pp</tt>
-# Author::    <%= config[:author] %> (<%= config[:email] %>)
+# Author::    <%= config[:author] %> (<%= config[:mail] %>)
 # Copyright:: Copyright (c) <%= Time.now.year %> <%= config[:author] %>
 # License::   <%= config[:license] %>
 #

data/templates/puppet/modules/manifests/classes/templatename.pp.erb

@@ -1,5 +1,5 @@
 # File::      <tt><%= config[:name] %>.pp</tt>
-# Author::    <%= config[:author] %> (<%= config[:email] %>)
+# Author::    <%= config[:author] %> (<%= config[:mail] %>)
 # Copyright:: Copyright (c) <%= Time.now.year %> <%= config[:author] %>
 # License::   <%= config[:license] %>
 #

data/templates/puppet/modules/manifests/definitions/templatename-mydef.pp.erb

@@ -1,5 +1,5 @@
 # File::      <tt><%= config[:name] %>-mydef.pp</tt>
-# Author::    <%= config[:author] %> (<%= config[:email] %>)
+# Author::    <%= config[:author] %> (<%= config[:mail] %>)
 # Copyright:: Copyright (c) <%= Time.now.year %> <%= config[:author] %>
 # License::   <%= config[:license] %>
 #

data/templates/puppet/modules/manifests/init.pp.erb

@@ -1,5 +1,5 @@
 # File::      init.pp
-# Author::    <%= config[:author] %> (<%= config[:email] %>)
+# Author::    <%= config[:author] %> (<%= config[:mail] %>)
 # Copyright:: Copyright (c) <%= Time.now.year %> <%= config[:author] %>
 # License::   <%= config[:license] %>
 #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: falkorlib
 version: !ruby/object:Gem::Version
-  version: 0.3.8
+  version: 0.3.9
 platform: ruby
 authors:
 - Sebastien Varrette
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-31 00:00:00.000000000 Z
+date: 2014-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -324,13 +324,13 @@ files:
 - templates/puppet/modules/README.md.erb
 - templates/puppet/modules/Rakefile
 - templates/puppet/modules/doc/contributing.md.erb
-- templates/puppet/modules/files/README.md
+- templates/puppet/modules/files/README.md.erb
 - templates/puppet/modules/manifests/classes/templatename-params.pp.erb
 - templates/puppet/modules/manifests/classes/templatename.pp.erb
 - templates/puppet/modules/manifests/definitions/templatename-mydef.pp.erb
 - templates/puppet/modules/manifests/init.pp.erb
 - templates/puppet/modules/metadata.json.erb
-- templates/puppet/modules/templates/README.md
+- templates/puppet/modules/templates/README.md.erb
 - templates/puppet/modules/templates/templatename-variables.erb
 - templates/puppet/modules/tests/init.pp.erb
 homepage: https://github.com/Falkor/falkorlib