banalize 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 87630dc6d2b7488f3fb027555a11fa8a55e51e69
-  data.tar.gz: 7125e23ea24ff1e1d76755431cc89e20a639c1b8
+  metadata.gz: 2b0087481450fe823d7653961d51e65a77d1c204
+  data.tar.gz: d0c17b02bfb921f7b9c66f30891b24cd48cc1606
 SHA512:
-  metadata.gz: 8e3f424b7c271325b8824af7be082dcadc94960045389d0d668277afd5e9d36ed61e41a6a1ff2780d234755dd55918c7d2463b3a184a2a953dca208df56db20c
-  data.tar.gz: e6c02e8669009ae01a06b6e6b42622909227ae576496c5e2826189ea70802dbe12d852bf39292bdead538c9de93ca661458c1b514e9e8acc74ff6d3399b2a604
+  metadata.gz: 11e7fe1cc961b17e79fab3d8d3c3db3fb9fa36912d7664330c013b12cdb0b7f1d797c7b6a66dfc9df74cd390c2194c414b31a05db8ae4158f2a83204a7edd0c7
+  data.tar.gz: 4c417850b591635872e6b272b781dda161e4a06cdb8ff9a369f070e8cd161e01f621c169c002fa5fff2ff845e9aa91986036ce40692ecaca7b67d2cf5efaac45

data/History.md

@@ -1,3 +1,16 @@
+## v.0.0.3
+
+* Thu Mar 28 2013 -- Dmytro Kovalov
+
+  - Filtering files by extension list: comma separated
+  - Add default sorting to policy search
+  - Policy to check braces ${a} around variables
+    with test  for it
+  - Add template for ruby policy in the docs directory
+  - Policy to check uninitialized variables
+  - Currently processed bash: Add error reporting on exit of currently processed bash file.
+  - ShellVariables module for parser
+    Find all shell variables in script into array and accessor `variables`
 
 ## v.0.0.2
 

data/bin/banalize

@@ -60,7 +60,8 @@ pre do |global,command,options,args|
   # - results of checks
   # - count of failed checks
   # - total count of checks
-  $res, $status, $total = { }, 0, 0
+  # - current - name of the currently processed bash file
+  $res, $status, $total, $current = { }, 0, 0, ''
   true
 end
 
@@ -115,6 +116,7 @@ end
 
 on_error do |exception|
   unless ENV['GLI_DEBUG'] == 'true'
+    puts "Current bash file #{$current}"
     exit_now! exception.message unless exception.is_a? GLI::BadCommandLine
   end
   true

data/lib/banalize/parser.rb

@@ -1,6 +1,7 @@
 module Banalize
   
   require_relative 'parser/pod_comments'
+  require_relative 'parser/variables'
 
   # Instance attributes
   # -----------
@@ -14,14 +15,16 @@ module Banalize
   
   class Parser
     
-    include Banalize::Parser::PodStyleComments
+    include PodStyleComments
+    include ShellVariables
     
     def initialize path
-      @lines    = IO.read(path).force_encoding("utf-8").split($/)
-      @shebang  = Numbered.new
-      @comments = Numbered.new 
-      @code     = Numbered.new
-
+      @lines     = IO.read(path).force_encoding("utf-8").split($/)
+      @shebang   = Numbered.new
+      @comments  = Numbered.new 
+      @code      = Numbered.new
+      @variables = []
+      
       @shebang.add @lines.shift if @lines.first =~ /^#!/
 
       @lines.each_index do |idx|
@@ -37,7 +40,7 @@ module Banalize
         end
       end
       pod_comments
-
+      shell_variables
     end
 
     # Lines of the tested bash file, split by \n's

data/lib/banalize/parser/variables.rb

@@ -0,0 +1,30 @@
+module Banalize
+  class Parser
+
+    ##
+    # Parse and detect all shell variables used in script. Set
+    # instance level accessor `variables`.
+    #
+    module ShellVariables
+      
+      ##
+      # Parse and detect all shell variables  used in script.
+      #
+      # @return [Array] 
+      def shell_variables
+        ln = code.grep(/\$\{?\w+\}?/).map(&:last).join " "
+
+        vars = ln.scan(/\$\{?\w+\}?/)
+        vars.map! { |x| x.gsub(/[${}]/,'') }
+        vars.reject! { |x| x =~ /^\d$/}
+
+        @variables = vars || []
+        @variables.uniq!
+      end
+
+      # All variables used in shell script
+      attr_accessor :variables
+
+    end # ShellVariables
+  end # Parser
+end # Banalize

data/lib/banalize/policy.rb

@@ -78,7 +78,7 @@ module Banalize
       else
         raise ArgumentError, "Unknown search criteria: #{search.inspect}"
 
-      end.compact
+      end.compact.sort { |a,b| a[:policy] <=> b[:policy] } # By default sort by  policy name
     end
 
     ##

data/lib/banalize/runner.rb

@@ -14,6 +14,8 @@ module Banalize
   #
   def self.run bash, search
 
+    $current = bash
+
     run_list = Policy.search search
 
     if run_list.empty?

data/lib/commands/dir.rb

@@ -3,20 +3,14 @@ desc 'Banalize file(s) from single or multiple directories. Can use wildcards an
 arg_name 'dir', :multiple
 command [:directory, :dir] do |c|
 
-  c.desc "Show all results, by default only failures shown (only for long format)"
-  c.switch [:a,:all]
 
-  c.desc "Short dotted output format"
-  c.switch [:s, :short, :dots]
+  c.switch [:a,:all],                desc: "Show all results, not only failures (for long format)"
+  c.switch [:dots, :d],              desc: "Short dotted output format"
+  c.switch [:recursive, :recur, :r], desc: "Recursive scan directories for files"
+  c.switch [:allow_files, :f],       desc: "Allow use of file paths together with directory paths"
 
-  c.desc "Recursive scan directories for files"
-  c.switch [:recursive, :recur, :r]
-
-  c.switch [:allow_files, :f], :desc => "Allow use of file paths together with directory paths"
-
-  c.desc "Wildcard for file lists"
-  c.default_value "*"
-  c.flag [:wildcard, :w]
+  c.flag   [:wildcard, :w],          desc: "Wildcard for file lists", default_value: "*"
+  c.flag   [:except,  :ex],          desc: "Skip files with listed extensions (comma-separated)"
 
   c.desc "With 'no-' do not show errors, only name of failed check"
   c.default_value true
@@ -32,8 +26,23 @@ command [:directory, :dir] do |c|
         files += Dir.glob("#{dir}/#{ options[:r] ? '**/' : ''}#{options[:wildcard]}").select { |x| File.file? x}
       end
     }
+    ##
+    # Filter out files by extentions
+    #
+    if options[:except]
+
+      extensions = options[:except]
+
+      extensions = extensions.split(/\s*,\s*/) if
+        extensions.is_a? String
+
+      extensions.each do |ext|
+        files.reject! {  |file| file =~ /.*\.#{ext}/ }
+      end
+    end
+
     files.each { |file| $res[file] = Banalize.run(file, $search) }
+
   end
 end
 
-

data/lib/commands/file.rb

@@ -2,12 +2,10 @@ desc 'Run banalize on a single file or multiple files'
 
 arg_name 'filename', :multiple
 command [:file, :fl] do |c|
-  
-  c.desc "Show all results, by default only failures shown (only for long format)"
-  c.switch [:a,:all]
 
-  c.desc "Short dotted output format"
-  c.switch [:s, :short, :dots]
+
+  c.switch [:a,:all],   desc: "Show all results, not only failures (for long format)"
+  c.switch [:dots, :d], desc: "Short dotted output format"
 
   c.desc "With 'no-' do not show errors, only name of failed check"
   c.default_value true

data/lib/policies/braces_for_variables.rb

@@ -0,0 +1,37 @@
+banalizer File.basename(__FILE__, '.rb').to_sym do
+
+  synopsis 'Always use braces to isolate variables ${a}' 
+  severity :stern
+  style    :bugs
+
+  description <<-DESC
+
+Use braces around variables
+---------------------------
+
+To prevent wrong expansion of variables always use braces around
+variables. I.e.
+
+Good: ${VARIABLE}
+Bad:  $VARIABLE
+
+foo=sun
+echo $fooshine     # $fooshine is undefined
+echo ${foo}shine   # displays the word "sunshine"
+
+DESC
+  
+  def run
+
+    variables.each do |var|
+
+      if code.has?(/\$#{var}/)
+        errors.add "Variable $#{var} used without braces" 
+        errors.add "    Lines: #{code.lines}"
+      end
+    end
+
+    errors.empty?
+  end
+
+end

data/lib/policies/comment_coverage.rb

@@ -15,7 +15,7 @@ banalizer File.basename(__FILE__, '.rb').to_sym do
 
     else
       pct = ((comments.size.to_f / code.size) * 100).to_i
-      errors.add "Code commented on #{pct}%" if pct < default[:percent]
+      errors.add "Code comment coverage #{pct}%" if pct < default[:percent]
     end
 
     errors.empty?

data/lib/policies/define_path.rb

@@ -5,13 +5,14 @@ banalizer :explicitly_define_path_variable do
 
   description <<-EOF
 
-PATH varaible should be defined explicitly in the script. It should *only* list absolute path names and does not have $PATH variable. 
+PATH varaible  should be defined  explicitly in the script.  It should
+*only* list absolute path names and does not have $PATH variable.
 
-Quote from http://hub.opensolaris.org/bin/view/Community+Group+on/shellstyle#HPathnames
+Ref.: http://hub.opensolaris.org/bin/view/Community+Group+on/shellstyle#HPathnames
 
-It is always a good idea to be careful about $PATH settings and
-pathnames when writing shell scripts. This allows them to function
-correctly even when the user invoking your script has some strange
+It  is always  a good  idea  to be  careful about  $PATH settings  and
+pathnames  when writing shell  scripts. This  allows them  to function
+correctly even  when the  user invoking your  script has  some strange
 $PATH set in their environment.
 
  There are two acceptable ways to do this:
@@ -27,13 +28,11 @@ PATH=/usr/bin; export PATH
 chown root bar
 chgrp sys bar
 
-DO NOT use a mixture of (1) and (2) in the same script. Pick one method and use it consistently.
-
+DO NOT  use a  mixture of  (1) and (2)  in the  same script.  Pick one
+method and use it consistently.
 
 EOF
 
-  
-
   parser :bash
 
   def run

data/lib/policies/uninitialized_variables.rb

@@ -0,0 +1,45 @@
+banalizer File.basename(__FILE__, '.rb').to_sym do
+
+  synopsis 'Variables should be explicitly initialized'
+  severity :gentle
+  style    :security
+
+  description <<-DESC
+
+Variable initialization
+------------------------
+
+As in C, it's always a good idea to initialize your variables, though,
+the  shell  will  initialize  fresh variables  itself  (better:  Unset
+variables   will  generally   behave  like   variables   containing  a
+nullstring).
+
+It's  no problem  to pass  a variable  you use  as environment  to the
+script. If you blindly assume that all variables you use are empty for
+the first time, somebody can inject a variable content by just passing
+it in the environment.
+
+The solution is simple and effective: Initialize them
+
+my_input=""
+my_array=()
+my_number=0
+
+If you do that  for every variable you use, then you  also have a kind
+of documentation for them.
+
+Ref: http://wiki.bash-hackers.org/scripting/style#variable_initialization
+
+DESC
+
+  def run
+
+    variables.each do |var|
+      errors.add "Variable ${#{var}} used without initializing" if 
+        code.dont_have? /#{var}=/
+    end
+
+    errors.empty?
+  end
+
+end

data/version.txt

@@ -1 +1 @@
-0.0.2
+0.0.3

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: banalize
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Dmytro Kovalov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-27 00:00:00.000000000 Z
+date: 2013-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -84,6 +84,7 @@ files:
 - ./lib/banalize/files.rb
 - ./lib/banalize/parser/numbered.rb
 - ./lib/banalize/parser/pod_comments.rb
+- ./lib/banalize/parser/variables.rb
 - ./lib/banalize/parser.rb
 - ./lib/banalize/policy/severity.rb
 - ./lib/banalize/policy.rb
@@ -96,6 +97,7 @@ files:
 - ./lib/commands/list.rb
 - ./lib/core_extensions/string.rb
 - ./lib/helpers/beautify.rb
+- ./lib/policies/braces_for_variables.rb
 - ./lib/policies/comment_coverage.rb
 - ./lib/policies/consistent_indents.rb
 - ./lib/policies/define_path.rb
@@ -105,6 +107,7 @@ files:
 - ./lib/policies/max_line_length.rb
 - ./lib/policies/shebang_format.rb
 - ./lib/policies/trailing_spaces.rb
+- ./lib/policies/uninitialized_variables.rb
 - ./lib/policies/minus_n_syntax_check
 homepage: http://wizcorp.jp
 licenses: []