banalize 0.0.1

data/lib/policies/exit_on_unset_variable.rb

@@ -0,0 +1,58 @@
+banalizer :should_use_set_nounset do
+
+  
+  synopsis "Always use 'set -u' or 'set -o nounset' in scripts"
+  severity  :gentle
+  style     :bug
+  
+  description <<EOF
+
+Quote from: http://www.davidpashley.com/articles/writing-robust-shell-scripts.html
+
+Use set -u
+===========
+
+    How often have you written a script that broke because a variable
+    wasn't set? I know I have, many times.
+
+chroot=$1
+...
+rm -rf $chroot/usr/share/doc 
+
+    If you ran the script above and accidentally forgot to give a
+    parameter, you would have just deleted all of your system
+    documentation rather than making a smaller chroot. So what can you
+    do about it? Fortunately bash provides you with set -u, which will
+    exit your script if you try to use an uninitialised variable. You
+    can also use the slightly more readable set -o nounset.
+
+% bash /tmp/shrink-chroot.sh
+$chroot=
+david% bash -u /tmp/shrink-chroot.sh
+/tmp/shrink-chroot.sh: line 3: $1: unbound variable
+david% 
+
+EOF
+
+  def run
+    ret = true
+    #
+    # Prohibit using set +e option
+    #
+    errors.add "Setting +u option in shebang: #{shebang}" if (shebang.has? /\+u/)
+
+    if code.has? /set\s+\+u/
+      errors.add "Use of +u to unset -u option. Lines: #{code.lines}"
+      errors.add "    #{code.search.inspect}"
+    end
+
+    
+    if ( code.dont_have?(/set\s+-u/) || 
+         code.dont_have?(/set\s+-o\s+nounset/)) &&
+        shebang.dont_have?(/\s-u/)
+      errors.add "Can not find option -u or -o nounset anywhere in the script"
+    end
+    return errors.empty?
+  end
+
+end

data/lib/policies/indentation_style.rb

@@ -0,0 +1,40 @@
+banalizer File.basename(__FILE__, '.rb').to_sym do
+
+  synopsis 'All lines must be indented accordingly to defined style' 
+  severity :harsh
+  style    :cosmetic
+
+  # Can be either :tabs or :spaces. Can overwrite in custom style file.
+  default :style => :spaces
+
+  description <<EOF
+
+When indenting the code, all  leading line indents should use the same
+character: either all SPACES or all TABS, specified by the indentation
+style.
+
+Indenation style can be set in personal style file. Set it to :tabs or
+:spaces. See CONFIGURATION.md for details.
+
+EOF
+
+
+  def run
+
+    rex = case default[:style]
+          when :tabs
+            %r{^\s* }
+          when :spaces
+            %r{^\s*\t}
+          end
+    
+    if code.has? rex
+      errors.add "Impoperly indented code. Current style is #{default[:style].to_s.upcase}"
+      errors.add "    Badly indented lines: #{code.lines}"
+    end
+            
+    
+    return errors.empty?
+  end
+
+end

data/lib/policies/max_line_length.rb

@@ -0,0 +1,43 @@
+banalizer :max_line_length do
+
+  synopsis 'The line length must not exceed max number of characters' 
+  severity :brutal
+  style    :cosmetic
+
+  default  :max => 88 # Default can be overwritten by personal styles
+                      # file
+ 
+  description <<EOF
+
+Bash Style Guide and Coding Standard
+====================================
+
+1 Length of line
+
+The total length of a line (including comment) must not exceed more
+than 88 characters. Thus searching in cross direction can be avoided
+and the file can be printed with the usual width of paper without
+lines being cut or line breaks. Instructions have to be split up, as
+applicable, texts can be made up as well.  
+
+Ref.: http://lug.fh-swf.de/vim/vim-bash/StyleGuideShell.en.pdf
+
+EOF
+
+
+  def run
+    ret = true
+
+    offset = shebang ? 2 : 1 # Offset for line numbers, 
+
+    lines.each_index do |idx|
+      len = lines[idx].length
+      errors.add(
+                 "Line # #{idx + offset} is #{len} characters long, expected to be #{default[:max]} char. max."
+                 ) if len > default[:max]
+    end
+    
+    return errors.empty?
+  end
+
+end

data/lib/policies/minus_n_syntax_check

@@ -0,0 +1,26 @@
+#!/bin/bash 
+set -e 
+set -u
+
+ARG=${1:-unset}
+
+case $ARG in 
+    config)
+        cat <<EOF
+---
+severity: 5
+synopsis: Bash syntax check 
+description: |
+  This policy runs syntax check using 'bash -n' option.
+
+EOF
+        exit 0;;
+esac
+
+
+[ -z "$ARG" ] && { echo "File name must be provided"; exit 64; }
+[ -f "$ARG" ] || { echo "File must exist"; exit 64; }
+
+
+\bash -n $ARG 2>&1
+exit $?

data/lib/policies/shebang_format.rb

@@ -0,0 +1,15 @@
+banalizer :shebang_format do
+  
+  description 'Format of shebang should be #!/usr/bin/env bash'
+
+  parser :bash
+
+  def run
+    unless shebang.has?(%r{\#!/usr/bin/env\s+bash})
+      errors.add "Expected first line to be '#!/usr/bin/env bash'"
+      errors.add "    Shebang line is '#{shebang.to_s}'"
+    end
+    return errors.empty?
+  end
+  
+end

data/lib/policies/trailing_spaces.rb

@@ -0,0 +1,16 @@
+banalizer File.basename(__FILE__, '.rb').to_sym do
+
+  synopsis 'Code lines should not have spaces or tabs at the end' 
+  severity :harsh
+  style    :cosmetic
+
+  def run
+
+    if code.has?(/\s$/)
+      errors.add "Trailing spaces at the end of lines: #{code.lines}"
+    end
+    
+    return errors.empty?
+  end
+
+end

data/version.txt

@@ -0,0 +1 @@
+0.0.1

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: banalize
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dmytro Kovalov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  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'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  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'
+- !ruby/object:Gem::Dependency
+  name: gli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.5.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.5.4
+description: Run policies tests on bash scripts and libraries with specified policies
+  and severity
+email: dmytro.kovalov@gmail.com
+executables:
+- banalize
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/banalize
+- version.txt
+- PARSER.md
+- README.md
+- ./lib/banalize/errors.rb
+- ./lib/banalize/exception.rb
+- ./lib/banalize/files.rb
+- ./lib/banalize/parser/numbered.rb
+- ./lib/banalize/parser.rb
+- ./lib/banalize/policy/severity.rb
+- ./lib/banalize/policy.rb
+- ./lib/banalize/registry.rb
+- ./lib/banalize/runner.rb
+- ./lib/banalize.rb
+- ./lib/commands/describe.rb
+- ./lib/commands/dir.rb
+- ./lib/commands/file.rb
+- ./lib/commands/list.rb
+- ./lib/core_extensions/string.rb
+- ./lib/helpers/beautify.rb
+- ./lib/policies/consistent_indents.rb
+- ./lib/policies/define_path.rb
+- ./lib/policies/exit_on_error.rb
+- ./lib/policies/exit_on_unset_variable.rb
+- ./lib/policies/indentation_style.rb
+- ./lib/policies/max_line_length.rb
+- ./lib/policies/shebang_format.rb
+- ./lib/policies/trailing_spaces.rb
+- ./lib/policies/minus_n_syntax_check
+homepage: http://wizcorp.jp
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options:
+- --title
+- Banalize
+- --main
+- README.md
+- -ri
+require_paths:
+- lib
+- 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.0.3
+signing_key: 
+specification_version: 4
+summary: Static syntax analyzer for Bash
+test_files: []
+has_rdoc: true