ducalis 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1cebb8b9bfce243520e492e14428a31520166d57
-  data.tar.gz: 71377e24c677052deba2729e4d6edad9d5661408
+SHA256:
+  metadata.gz: 9b9c876d0a00b147a1b951611b7ad2f0e7c1acfaecdb03f00a76a206e582678b
+  data.tar.gz: 447e6dbfb3ae6d84b6f63234ae66aa7db0741ef463daaca07ed3715bcccdf160
 SHA512:
-  metadata.gz: a80ee7b95acfc74476566eb5c5cf4b02dd94889a27f1832772e30d6e85cc923443dcf3e659847e455c3884dde71b1fcb75e09a85bb2e1ebd3cc4cbe81af3ebd8
-  data.tar.gz: 113862c9e97fd9c418f31ccd172153660daf9406307fa5e8fbb5756658b173ebda5ce8e7dde7f5dfe00cfcf1d0e157fad33d3daca70d84fd5c514702e5709a81
+  metadata.gz: cc5cfd83af5d1754ece8f915ffcf04850f39f167fa79c89845b610c9e1b53835a536479598241d1e81e7559f4265ee04d665073f7190e734acea05c270667d74
+  data.tar.gz: 36ee864dfdd14acc6f941ca5ade14876cff2cfd2a49020d146326010340e9ee7f519c5e36c740f6e46b5323c04a64ab3aeea4fe20277594fa6b5c72c236fff1b

data/.ruby-version

@@ -1 +1 @@
-2.3.4
+2.5.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ducalis (0.7.0)
+    ducalis (0.8.0)
       git (~> 1.3, >= 1.3.0)
       policial (= 0.0.4)
       regexp-examples (~> 1.3, >= 1.3.2)

data/README.md

@@ -5,26 +5,21 @@
 [![Maintainability](https://api.codeclimate.com/v1/badges/d03d4e567e8728d2c58b/maintainability)](https://codeclimate.com/github/ignat-z/ducalis/maintainability)
 
 __Ducalis__ is RuboCop-based static code analyzer for enterprise Rails applications.
-As __Ducalis__ isn't style checker and could sometimes be false-positive it's not
+
+Documentation available at https://ducalis-rb.github.io/.
+
+__Ducalis__ isn't style checker and could sometimes be false-positive it's not
 necessary to follow all it rules, the main purpose of __Ducalis__ is help to find
 possible weak code parts.
 
-[Documentation](<https://ducalis-rb.github.io/>)
+## Installation and Usage
 
-## Installation
-
-Add this line to your application's Gemfile:
+Add this line to your application's `Gemfile`:
 
 ```ruby
 gem 'ducalis'
 ```
 
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Usage
-
 There are a lot of variants how you can use __Ducalis__:
 
 1. As CLI application. In this mode __Ducalis__ will notify you about any
@@ -72,9 +67,19 @@ def remove_audits
 end
 ```
 
+The main behavior of Ducalis can be controlled via the
+[.ducalis.yml](<https://github.com/ignat-z/ducalis/blob/master/config/.ducalis.yml>).
+It makes it possible to enable/disable certain cops (checks) and to alter their
+behavior if they accept any parameters. List of all available cops could be
+found in the [documentation](<https://ducalis-rb.github.io/>).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
 ## Contribution
 
-To pass your code through the all checks you simply need to run:
+Contributions are welcome! To pass your code through the all checks you simply need to run:
 
 ```
 bundle exec rake

data/config/.ducalis.yml

@@ -120,3 +120,11 @@ Ducalis/ModuleLikeClass:
     - Sidekiq::Worker
     - Singleton
     - ActiveModel::Model
+    - Virtus.model
+
+Ducalis/DescriptiveBlockNames:
+  Enabled: true
+  MinimalLenght: 3
+  WhiteList:
+    - to
+    - id

data/lib/ducalis.rb

@@ -37,6 +37,7 @@ require 'ducalis/cops/callbacks_activerecord'
 require 'ducalis/cops/case_mapping'
 require 'ducalis/cops/controllers_except'
 require 'ducalis/cops/data_access_objects'
+require 'ducalis/cops/descriptive_block_names'
 require 'ducalis/cops/fetch_expression'
 require 'ducalis/cops/only_defs'
 require 'ducalis/cops/keyword_defaults'

data/lib/ducalis/cops/descriptive_block_names.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+module Ducalis
+  class DescriptiveBlockNames < RuboCop::Cop::Cop
+    OFFENSE = <<-MESSAGE.gsub(/^ +\|\s/, '').strip
+      | Please, use descriptive names as block arguments. There is no any sanse to save on letters.
+    MESSAGE
+
+    def on_block(node)
+      _send, args, _inner = *node
+      block_arguments(args).each do |violation_node|
+        add_offense(violation_node, :expression, OFFENSE)
+      end
+    end
+
+    private
+
+    def violate?(node)
+      node.to_s.length < minimal_length &&
+        !node.to_s.start_with?('_') &&
+        !white_list.include?(node.to_s)
+    end
+
+    def white_list
+      cop_config.fetch('WhiteList')
+    end
+
+    def minimal_length
+      cop_config.fetch('MinimalLenght').to_i
+    end
+
+    def_node_search :block_arguments, '(arg #violate?)'
+  end
+end

data/lib/ducalis/cops/fetch_expression.rb

@@ -13,6 +13,8 @@ module Ducalis
       | %<source>s
       | ```
 
+      | If your hash contains `nil` or `false` values and you want to treat them not like an actual values you should preliminarily remove this values from hash.
+      | You can use `compact` (in case if you do not want to ignore `false` values) or `keep_if { |key, value| value }` (if you want to ignore all `false` and `nil` values).
     MESSAGE
 
     def investigate(processed_source)

data/lib/ducalis/documentation.rb

@@ -66,16 +66,30 @@ end
 
 class Documentation
   SIGNAL_WORD = 'raises'.freeze
+  PREFER_WORD = 'better'.freeze
   RULE_WORD = '[rule]'.freeze
 
+  def cop_rules
+    cops.map do |file|
+      rules = spec_cases_for(file).select do |desc, _code|
+        desc.include?(RULE_WORD)
+      end
+      [file, rules]
+    end
+  end
+
   def call
-    Dir[File.join(File.dirname(__FILE__), 'cops', '*.rb')].sort.map do |f|
+    cops.map do |f|
       present_cop(klass_const_for(f), spec_cases_for(f))
     end.flatten.join("\n")
   end
 
   private
 
+  def cops
+    Dir[File.join(File.dirname(__FILE__), 'cops', '*.rb')].sort
+  end
+
   def present_cop(klass, specs)
     [
       "## #{klass}\n",                                  # header

data/lib/ducalis/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ducalis
-  VERSION = '0.7.0'.freeze
+  VERSION = '0.8.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ducalis
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Ignat Zakrevsky
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-19 00:00:00.000000000 Z
+date: 2018-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -116,6 +116,7 @@ files:
 - lib/ducalis/cops/case_mapping.rb
 - lib/ducalis/cops/controllers_except.rb
 - lib/ducalis/cops/data_access_objects.rb
+- lib/ducalis/cops/descriptive_block_names.rb
 - lib/ducalis/cops/enforce_namespace.rb
 - lib/ducalis/cops/evlis_overusing.rb
 - lib/ducalis/cops/extensions/rubocop_cast.rb
@@ -174,7 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: RuboCop based static code analyzer