ducalis 0.5.5 → 0.5.6

data/lib/ducalis/cops/useless_only.rb

@@ -4,24 +4,24 @@ require 'rubocop'
 
 module Ducalis
   class UselessOnly < RuboCop::Cop::Cop
-    include RuboCop::Cop::DefNode
+    OFFENSE = <<-MESSAGE.gsub(/^ +\|/, '').strip
+      | Seems like there is no any reason to keep before filter only for one
+      | action. Maybe it will be better to inline it?
+      |
+      | ```ruby
+      | before_filter :do_something, only: %i[index]
+      | def index; end
+      |
+      | # to
+      |
+      | def index
+      |   do_something
+      | end
+      | ```
+    MESSAGE
+
     FILTERS = %i(before_filter after_filter around_filter
                  before_action after_action around_action).freeze
-    OFFENSE = %(
-Seems like there is no any reason to keep before filter only for one action. \
-Maybe it will be better to inline it?
-
-```ruby
-before_filter :do_something, only: %i[index]
-def index; end
-
-# to
-
-def index
-  do_something
-end
-```
-    ).strip
 
     def on_class(node)
       _classdef_node, superclass, _body = *node

data/lib/ducalis/documentation.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
 require 'parser/current'
-require 'rubocop'
 
+# This class could be used to dynamically generate documentation from cops spec.
+# It recognizes bad and good examples by signal words like `raises`. Additional
+# information for documentation could be passed by setting `DETAILS` constant.
 class SpecsProcessor < Parser::AST::Processor
   attr_reader :cases
 
@@ -55,6 +57,10 @@ class SpecsProcessor < Parser::AST::Processor
 end
 
 class Documentation
+  RED_SQUARE = '![](https://placehold.it/10/f03c15/000000?text=+)'
+  GREEN_SQUARE = '![](https://placehold.it/10/2cbe4e/000000?text=+)'
+  SIGNAL_WORD = 'raises'
+
   def call
     Dir['./lib/ducalis/cops/*.rb'].map do |f|
       present_cop(klass_const_for(f), spec_cases_for(f))
@@ -66,7 +72,7 @@ class Documentation
   def present_cop(klass, specs)
     [
       "## #{klass}\n",                                  # header
-      klass.const_get(:OFFENSE)                         # description
+      message(klass)                                    # description
     ] +
       specs.map do |(it, code)|
         [
@@ -77,11 +83,14 @@ class Documentation
   end
 
   def color(it)
-    if it.include?('raises')
-      '![](https://placehold.it/15/f03c15/000000?text=+)'
-    else
-      '![](https://placehold.it/15/2cbe4e/000000?text=+)'
-    end
+    it.include?(SIGNAL_WORD) ? RED_SQUARE : GREEN_SQUARE
+  end
+
+  def message(klass)
+    [
+      klass.const_get(:OFFENSE),
+      *(klass.const_get(:DETAILS) if klass.const_defined?(:DETAILS))
+    ].join("\n")
   end
 
   def spec_cases_for(f)

data/lib/ducalis/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ducalis
-  VERSION = '0.5.5'
+  VERSION = '0.5.6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ducalis
 version: !ruby/object:Gem::Version
-  version: 0.5.5
+  version: 0.5.6
 platform: ruby
 authors:
 - Ignat Zakrevsky
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-03 00:00:00.000000000 Z
+date: 2017-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git