banalize 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8a4e26483ea5692063efa9d08adb90fcbc552243
-  data.tar.gz: 1225cf15d13b89501f0d6bf2cdff359f2927bcf6
+  metadata.gz: 87630dc6d2b7488f3fb027555a11fa8a55e51e69
+  data.tar.gz: 7125e23ea24ff1e1d76755431cc89e20a639c1b8
 SHA512:
-  metadata.gz: 0ac7bff7e15664f2beb9aa862c539451f8dab4531346abfca0d1f4fff5f13c7769666440c24e50c792f10aedaeb7bedf7d8b1c41d92cb53a917c812a65abef95
-  data.tar.gz: 940407208055587056763facf1b72c5720a5933f35cc01284e0d54e6d84bf54259b279ae2fea15202ee44e8c9a3bc5c3f7c0947bb697a8288cbb68f62fc7b146
+  metadata.gz: 8e3f424b7c271325b8824af7be082dcadc94960045389d0d668277afd5e9d36ed61e41a6a1ff2780d234755dd55918c7d2463b3a184a2a953dca208df56db20c
+  data.tar.gz: e6c02e8669009ae01a06b6e6b42622909227ae576496c5e2826189ea70802dbe12d852bf39292bdead538c9de93ca661458c1b514e9e8acc74ff6d3399b2a604

data/History.md

@@ -0,0 +1,25 @@
+
+## v.0.0.2
+
+* Wed Mar 27 2013 -- Dmytro Kovalov
+    Multiple changes:
+  - Allow search policies by regexp from CLI
+  - search method changes in Policy
+      - add search by Regexp
+      - YARD formatting
+  - Changes to describe command
+      - Better screen output with color support
+      - Drop policy name argument from desc command, use global policies search
+  - Fix NaN - divizion by 0n comment coverage
+  - Use of active = false
+      By using false on active default allow disabling policies.
+  - Policy to check percetantage coverage of the comments over code
+  - POD comments module
+      POD comments included into standard parser as module.  It recognizes comments in POD here-doc style and moves them from code part to comments.
+  - For Numbered class:
+      - method slice
+      - method sort
+  - Move @lines parsing to Parser class
+  - Add GLI_DEBUG for exit_now!
+  - Documnetation for Numbered class
+  - Fix no method error when $styles section for policy don't exist

data/bin/banalize

@@ -20,7 +20,7 @@ EOF
 
 flag   [:group,    :g],    :desc => 'Use only policies included in specified group'
 flag   [:severity, :s],    :desc => 'Use only policies of specified severity and above'
-flag   [:policy,   :p],    :desc => 'Apply single policy only (by name)'
+flag   [:policy,   :p],    :desc => 'Select policies by name (single) or regexp, include in slashes: /indent/'
 flag   [:style,    :S],    :desc => 'Use custom style file instead of default one.',
                            :default_value => Banalize::USER[:styles]
 
@@ -52,6 +52,8 @@ pre do |global,command,options,args|
     search.merge!({ :severity => global[:severity].to_i }) if global[:severity]
   end
 
+
+  search = Regexp.new(search[1..-2]) if search =~ /^\/.*\/$/
   $search   = search
   $policies = Banalize::Policy.search search 
 
@@ -112,7 +114,9 @@ post do |global,command,options,args|
 end
 
 on_error do |exception|
-  exit_now! exception.message unless exception.is_a? GLI::BadCommandLine
+  unless ENV['GLI_DEBUG'] == 'true'
+    exit_now! exception.message unless exception.is_a? GLI::BadCommandLine
+  end
   true
 end
 

data/lib/banalize/parser.rb

@@ -1,28 +1,52 @@
 module Banalize
+  
+  require_relative 'parser/pod_comments'
 
+  # Instance attributes
+  # -----------
+  # Class sets following attribute accessor methods:
+  #
+  # - {#lines}
+  # - {#path} 
+  # - {#shebang}
+  # - {#comments}
+  # - {#code}
+  
   class Parser
-
+    
+    include Banalize::Parser::PodStyleComments
+    
     def initialize path
-      @shebang = Numbered.new
+      @lines    = IO.read(path).force_encoding("utf-8").split($/)
+      @shebang  = Numbered.new
       @comments = Numbered.new 
-      @code = Numbered.new
+      @code     = Numbered.new
 
-      @shebang.add lines.shift if lines.first =~ /^#!/
+      @shebang.add @lines.shift if @lines.first =~ /^#!/
 
-      lines.each_index do |idx|
+      @lines.each_index do |idx|
 
-        next if lines[idx] =~ /^\s*$/
+        next if @lines[idx] =~ /^\s*$/
 
         lineno = idx + 1 + (@shebang ? 1 : 0) # Compensate for base-0 and shebang line
 
-        if lines[idx] =~ /^\s*\#/
-          @comments.add lines[idx], lineno
+        if @lines[idx] =~ /^\s*\#/
+          @comments.add @lines[idx], lineno
         else
-          @code.add lines[idx], lineno
+          @code.add @lines[idx], lineno
         end
       end
+      pod_comments
+
     end
 
+    # Lines of the tested bash file, split by \n's
+    attr_accessor :lines
+
+    # UNIX path to the tested file
+    attr_accessor :path
+
+
     ##
     # Shebang contains first line of the script if it's in `#!`
     # format. Otherwise it is nil.

data/lib/banalize/parser/numbered.rb

@@ -4,8 +4,23 @@ module Banalize
   # Class numbered implements simple model of numbered lines data
   # structure. It's Mash (think Hash). 
   #
-  # Each pair is line_number => row. Line numbers are *not*
-  # necessarily sequential.
+  # Each pair is { line_number => row }. Line numbers are *not*
+  # necessarily sequential, i.e. line numbers in {Numbered} instance
+  # corresponds to those of actuall analyzed script. 
+  #
+  # Base of numbers is 1. Examples:
+  #
+  # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ruby
+  # p @shebang # { 1 => "#!/bin/bash" }
+  #
+  # p @code
+  # # { 
+  # #   2 => 'set -e',
+  # #   3 => 'set -u'
+  # # }
+  #
+  # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+  #
   class Numbered < ::Mash
 
     def initialize *p
@@ -48,6 +63,8 @@ module Banalize
                       )
       end
     end
+    
+    alias :numbers :lines
 
     ##
     # Search attribute always contains last result of search (grep)
@@ -67,7 +84,38 @@ module Banalize
     end
     
     alias :inspect :to_s
-    
+
+
+    ##
+    # Return all lines with numbers between from and to
+    #
+    # @param [Finxum] from Starting line
+    # @param [Finxum] to   Ending line
+    #
+    # @return [Numbered] Instance of Numbered with all lines beween
+    #     specified numbers. Numbers can be not sequntial.
+    #
+    def slice from, to
+      from, to = from.to_i, to.to_i
+      ret = self.class.new self.select { |k,v|  k.to_i.between?(from,to) }
+    end
+
+    ##
+    # Sort by the order of lines numbers
+    #
+    # @return [Array] Sorted array of 2-elements arrays:
+    #
+    # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ruby
+    # >> a.comments.sort {  |a,b| a.first.to_i <=> b.first.to_i }
+    # => [["2", " Use perldoc functions to see documentation for this file."], 
+    #    ["4", ":<<\"=cut\ 
+    # ...
+    # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+    #
+    def sort
+      self.sort { |a,b| a.first.to_i <=> b.first.to_i }
+    end
+
     ##
     # Grep lines of the Numbered object (i.e. values of the hash) and
     # return all lines together with numbers that match
@@ -89,13 +137,50 @@ module Banalize
     # *Attention*: since {Numbered} is a hash, adding line with the
     # number that already exists will overwrite existing one.
     #
+    # @param [String,Numbered] line Line or Numbered object to add
+    #
+    # @param [Finxum] number Line number in the analized script. If
+    #     First param is {Numbered} instance, then this argument is
+    #     not used.
+    #
     # ## Example
     #
-    # ```
-    #       @shebang.add lines.shift if lines.first =~ /^#!/
-    # ```
+    # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ruby
+    #     @shebang.add lines.shift if lines.first =~ /^#!/
+    # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+    #
     def add line, number=0
-      self[number] = line.chomp
+      case line
+      when String
+        self[number.to_i] = line.chomp
+      when Numbered
+        self.merge! line
+      end
+    end
+
+    ##
+    # Delete numbered line by its number
+    #
+    # Delete line from {Numbered} and return it as
+    #     single element {Numbered} object with line number.
+    #
+    # @param [Fixnum,Array[Fixnum],Numbered] lines Lines to delete from Numbered instance. 
+    #
+    # @return [Hash] Deleted lines as instance of {Numbered}
+    #
+    def delete lines
+      ret = self.class.new
+
+      case lines
+      when Fixnum
+        ret.add super(lines), lines
+      when Array
+        lines.each { |line| ret.add super(line), line }
+      when Numbered
+        ret.add self.delete lines.keys
+      end
+
+      ret
     end
 
   end

data/lib/banalize/parser/pod_comments.rb

@@ -0,0 +1,49 @@
+module Banalize
+  class Parser
+
+    ##
+    # Munin project uses documentation in the style of Perl's
+    # POD. These comments are not detected by standard Bash
+    # parser. This mixin takes POD style comments from {#code} and put
+    # them in {#comments}
+    #
+    # POD style comments are in the form:
+    #
+    # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~bash
+    # :<<"=cut"
+    # 
+    # =head1 NAME
+    #  ....
+    #  ...
+    #
+    # =cut
+    # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+    module PodStyleComments
+      
+      ##
+      # Parse bash here-doc comments in the POD style and move them to
+      # {#comments}
+      #
+      #
+      def pod_comments
+        start = code.grep(/^:<<"?=cut"?\s*$/)
+        cut   = code.grep(/^=cut\s*$/)
+        
+        raise "Started not the same number of POD blocks as ended: #{start.size} vs #{cut.size}" if
+          start.size != cut.size
+        
+        start.each do |start_pod|
+
+          start_pod = start_pod.first.to_i
+          cut_pod   = cut.shift.first.to_i
+
+          raise "Starting line of POD comment after ending line: #{start_pod} > #{cut_pod}" if 
+            start_pod > cut_pod
+          
+          comments.add code.delete(code.slice(start_pod,cut_pod))
+        end
+      end
+
+    end # PodStyleComments
+  end # Parser
+end # Banalize

data/lib/banalize/policy.rb

@@ -26,19 +26,18 @@ module Banalize
 
     # Find policy or list of policies by search criteria.
     #
-    # Search can be policy name (Symbol or String), Hash with
-    # :policy and/or :severity keys or nil.
+    # Can perform policy search by:
     #
-    # - `nil` -  no filtering. Simply list of all policies returned.
+    # - policy name (Symbol, String or Regegp)
+    # - or Hash with :policy and/or :severity keys or nil.
+    #   - `nil` -  no filtering. Simply list of all policies returned.
+    #   - `:severity` searched for policies with severity value same as
+    #       search or higher.
+    #   - `:style` - can be Symbol or Array of symbols. If it's :core
+    #       or includes :core, all policies returned.
     #
-    # - `:severity` searched for policies with severity value same as
-    #   search or higher.
     #
-    # - `:style` - can be Symbol or Array of symbols. If it's :core
-    #   or includes :core, all policies returned.
-    #
-    #
-    # @param [String, Symbol, Hash] search Name of a policy to check
+    # @param [String, Symbol, Hash, Regexp, nil] search Name of a policy to check
     #     against or hash having :severity and/or :policy keys.
     #
     # @return [Hash]
@@ -52,6 +51,9 @@ module Banalize
       when Symbol, String
         [Files.policies.find { |x| x[:policy] == search.to_sym }]
 
+      when Regexp
+        Files.policies.find_all { |x| x[:policy] =~ search }
+
       when Hash
         res = Files.policies
         #

data/lib/banalize/registry.rb

@@ -9,11 +9,8 @@ module Banalize
   #
   # Instance attributes
   # -----------
-  # Class sets following attribute accessor methods:
-  #
-  # - {#lines}
-  # - {#path} 
   # - {#errors}
+  # - {#default}
   #
   # Other attributes are inherited from parent Parser class.
   #
@@ -71,7 +68,7 @@ module Banalize
       c = Object.const_set klass, Class.new(self , &block)
 
       c.synopsis myname
-      c.default({})
+      c.default({})             # make sure defaults are initialized
       c.severity Policy::DEFAULT[:severity] unless c.severity # Set default severity if it's not defined in block
 
       # Override these with Styles file
@@ -94,22 +91,28 @@ module Banalize
     ##
     # Creates new instance of policy check.
     #
-    # @param [String] path UNIX PATH to Bash script
+    # @param [String] bash UNIX PATH to Bash script
     #
-    def initialize path
-      raise RuntimeError, "File does not exist: #{path}" unless File.exists? path
-      @lines = IO.read(path).force_encoding("utf-8").split($/)
-      @path = path
+    def initialize bash
+      raise RuntimeError, "File does not exist: #{bash}" unless File.exists? bash
+
+      @path = bash
       @errors = Errors.new self
 
       # Make class level default variable accessible as instance level
       # variable and accessor
 
-      @default = self.class.default.merge($styles[self.class.config[:policy]] || {})
+      super @path
+      @default = self.class.default.merge( $styles[self.class.config[:policy]] || {} )
 
-      super path
     end
 
+    ##
+    # Instance level accessor for the defaults 
+    #
+    # Instance defaults hold same data as in class level default
+    # method. Instance level data are merged on initializing with
+    # personal styles data.
     attr_accessor :default
 
     # Instance of Errors class to hold all error messages from tests
@@ -121,11 +124,6 @@ module Banalize
       raise ArgumentError, "You must override #run method in class ''#{self.class.policy_name}'"
     end
 
-    # Lines of the tested bash file, split by \n's
-    attr_accessor :lines
-
-    # UNIX path to the tested file
-    attr_accessor :path
 
     ##
     # Name of this policy.

data/lib/banalize/runner.rb

@@ -70,7 +70,10 @@ module Banalize
     #
     def ruby
       object = policy[:klass].constantize.new(bash)
-      res = object.run
+
+      # Policy executed by default unless it explicitly deactivated
+      res = object.default[:active] == false ? true : object.run 
+
       @result = {
         :status => res ? true : false,
         :messages => Errors.to_s(object.errors.messages)

data/lib/commands/describe.rb

@@ -5,14 +5,21 @@ command [:describe,:desc] do |c|
 
   c.desc 'Print help for the specified policy'
   c.command [:policy, :pol, :p] do |p|
-    p.desc 'Policy name'
-    p.arg_name 'policy_name'
+
+    def yellow
+      printf "%s\n", ('~' * 80).color(:yellow)
+    end
 
     p.action do |global_options, options, args|
-      raise "Need a policy name to see description" if args.empty?
-      p = args.first.to_sym
-      print "\n#{p}: #{Banalize::Policy.synopsis(p)}\n\n"
-      print Banalize::Policy.description(p) + "\n\n"
+      $policies.each do |pol|
+
+        yellow
+        printf "%s :  %s\n", pol[:policy].to_s.color(:bold), pol[:synopsis].color(:green)
+        yellow
+
+        puts pol[:description]
+        puts
+      end
     end
 
   end

data/lib/policies/comment_coverage.rb

@@ -0,0 +1,24 @@
+banalizer File.basename(__FILE__, '.rb').to_sym do
+
+  synopsis 'Script file should be commented. Check percentage of code vs commetns' 
+  severity :brutal
+  style    :cosmetic
+
+  # What the minumum percentage of comments, by number of lines should
+  # be in your code
+  default percent: 30
+
+  def run
+
+    if code.size == 0
+      errors.add "Code size is 0"
+
+    else
+      pct = ((comments.size.to_f / code.size) * 100).to_i
+      errors.add "Code commented on #{pct}%" if pct < default[:percent]
+    end
+
+    errors.empty?
+  end
+
+end

data/lib/policies/trailing_spaces.rb

@@ -1,7 +1,7 @@
 banalizer File.basename(__FILE__, '.rb').to_sym do
 
   synopsis 'Code lines should not have spaces or tabs at the end' 
-  severity :harsh
+  severity :brutal
   style    :cosmetic
 
   def run

data/version.txt

@@ -1 +1 @@
-0.0.1
+0.0.2

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: banalize
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Dmytro Kovalov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-26 00:00:00.000000000 Z
+date: 2013-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -76,12 +76,14 @@ extra_rdoc_files: []
 files:
 - bin/banalize
 - version.txt
+- History.md
 - PARSER.md
 - README.md
 - ./lib/banalize/errors.rb
 - ./lib/banalize/exception.rb
 - ./lib/banalize/files.rb
 - ./lib/banalize/parser/numbered.rb
+- ./lib/banalize/parser/pod_comments.rb
 - ./lib/banalize/parser.rb
 - ./lib/banalize/policy/severity.rb
 - ./lib/banalize/policy.rb
@@ -94,6 +96,7 @@ files:
 - ./lib/commands/list.rb
 - ./lib/core_extensions/string.rb
 - ./lib/helpers/beautify.rb
+- ./lib/policies/comment_coverage.rb
 - ./lib/policies/consistent_indents.rb
 - ./lib/policies/define_path.rb
 - ./lib/policies/exit_on_error.rb