banalize 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2b0087481450fe823d7653961d51e65a77d1c204
-  data.tar.gz: d0c17b02bfb921f7b9c66f30891b24cd48cc1606
+  metadata.gz: bf6d4ff389346ec3266feaf32efab5ba91c17400
+  data.tar.gz: bc52e8fe7b830cdbc4a70b07edd71b6189ac0696
 SHA512:
-  metadata.gz: 11e7fe1cc961b17e79fab3d8d3c3db3fb9fa36912d7664330c013b12cdb0b7f1d797c7b6a66dfc9df74cd390c2194c414b31a05db8ae4158f2a83204a7edd0c7
-  data.tar.gz: 4c417850b591635872e6b272b781dda161e4a06cdb8ff9a369f070e8cd161e01f621c169c002fa5fff2ff845e9aa91986036ce40692ecaca7b67d2cf5efaac45
+  metadata.gz: 10160e842179287216bb7dcddf90206120d1d0d3acc0938131cbcf635cb38f4b600cc6beeec742fd748e55d5330d22cacf3c7a1279b4aa053bfb48d1d4e6bbf0
+  data.tar.gz: c196f2e6d6bcf7394ae2b4a2c0fdcbfedff7d47919a5192184f1903b7a8631ea4dc5f768faf26722a7c7a3598f21a3397f2dca439e7e399a896524d7c5f5fd8a

data/History.md

@@ -1,10 +1,16 @@
+## v.0.0.4
+
+* Fri Mar 29 2013 -- Dmytro Kovalov
+
+  - Generate Markdown documentation from policy descriptions
+
 ## 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
+  - 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

data/lib/commands/describe.rb

@@ -6,20 +6,15 @@ command [:describe,:desc] do |c|
   c.desc 'Print help for the specified policy'
   c.command [:policy, :pol, :p] do |p|
 
-    def yellow
-      printf "%s\n", ('~' * 80).color(:yellow)
-    end
-
-    p.action do |global_options, options, args|
-      $policies.each do |pol|
 
-        yellow
-        printf "%s :  %s\n", pol[:policy].to_s.color(:bold), pol[:synopsis].color(:green)
-        yellow
+    p.switch [:markdown, :m], desc: "Print description in markdown format"
 
-        puts pol[:description]
-        puts
-      end
+    
+    p.action do |global_options, options, args|
+      Banalize::Describe.send( 
+                              options[:markdown] ? :markdown : :screen, 
+                              $policies
+                              )
     end
 
   end

data/lib/helpers/description.rb

@@ -0,0 +1,79 @@
+module Banalize
+  ##
+  # Helper methods for printing out policies descriptions.
+  #
+  class Describe
+
+    ##
+    # Format for markdown documentation for policies
+    #
+    FORMAT =<<-FORM
+
+## %s
+
+*%s*
+
+* Policy name: %s
+* Severity:    %s
+* Style:       %s
+* Defaults:    %s
+
+**Description**
+
+````
+%s
+
+````
+
+------------------------------------------------------------------
+
+FORM
+
+    def self.yellow
+      printf "%s\n", ('~' * 80).color(:yellow)
+    end
+
+    def self.markdown policies
+
+      puts <<-PUT
+# @title List of available policies
+
+# Banalizer
+
+![banalize](images/banalize_small.png)
+
+PUT
+
+      policies.each do |pol|
+
+        defl = ""
+
+        if pol[:default]
+          pol[:default].each { |k,v| defl << "\n  * #{k}: #{v}\n" }
+        end
+
+        defl = "N/A" if defl.empty?
+
+        printf FORMAT,
+        pol[:policy].to_s.titleize,
+        pol[:synopsis],
+        pol[:policy],
+        pol[:severity],
+        pol[:style],
+        defl,
+        pol[:description]
+      end
+    end
+
+    def self.screen policies
+      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
+end

data/version.txt

@@ -1 +1 @@
-0.0.3
+0.0.4

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: banalize
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Dmytro Kovalov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-28 00:00:00.000000000 Z
+date: 2013-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -97,6 +97,7 @@ files:
 - ./lib/commands/list.rb
 - ./lib/core_extensions/string.rb
 - ./lib/helpers/beautify.rb
+- ./lib/helpers/description.rb
 - ./lib/policies/braces_for_variables.rb
 - ./lib/policies/comment_coverage.rb
 - ./lib/policies/consistent_indents.rb