Fix code style with help of Rubocop

alsemyonov · Jul 5, 2016 · a2d97d6 · a2d97d6
1 parent 17923f6
commit a2d97d6
Show file tree

Hide file tree

Showing 79 changed files with 475 additions and 264 deletions.
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -0,0 +1,2 @@
+require: rubocop-rspec
+inherit_from: .rubocop_todo.yml
diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml
@@ -0,0 +1,91 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-07-05 04:35:13 +0300 using RuboCop version 0.41.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+Lint/ShadowingOuterLocalVariable:
+  Exclude:
+    - 'examples/atom.rb'
+
+# Offense count: 9
+Metrics/AbcSize:
+  Max: 70
+
+# Offense count: 2
+Metrics/CyclomaticComplexity:
+  Max: 14
+
+# Offense count: 125
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 265
+
+# Offense count: 10
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 46
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ModuleLength:
+  Max: 203
+
+# Offense count: 3
+Metrics/PerceivedComplexity:
+  Max: 15
+
+# Offense count: 61
+Style/AsciiComments:
+  Enabled: false
+
+# Offense count: 2
+Style/CaseEquality:
+  Exclude:
+    - 'lib/xommelier/xml/element/serialization.rb'
+
+# Offense count: 1
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: nested, compact
+Style/ClassAndModuleChildren:
+  Exclude:
+    - 'lib/xommelier/core_ext/uri.rb'
+
+# Offense count: 110
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 1
+Style/DoubleNegation:
+  Exclude:
+    - 'lib/xommelier/xml/element.rb'
+
+# Offense count: 1
+Style/EachWithObject:
+  Exclude:
+    - 'lib/xommelier/xml/element/serialization.rb'
+
+# Offense count: 1
+# Configuration parameters: MinBodyLength.
+Style/GuardClause:
+  Exclude:
+    - 'lib/xommelier/xml/element/namespace.rb'
+
+# Offense count: 1
+Style/IfInsideElse:
+  Exclude:
+    - 'lib/xommelier/xml/element/serialization.rb'
+
+# Offense count: 1
+# Configuration parameters: NamePrefix, NamePrefixBlacklist, NameWhitelist.
+# NamePrefix: is_, has_, have_
+# NamePrefixBlacklist: is_, has_, have_
+# NameWhitelist: is_a?
+Style/PredicateName:
+  Exclude:
+    - 'spec/**/*'
+    - 'lib/xommelier/ds.rb'
diff --git a/Gemfile b/Gemfile
@@ -1,7 +1,7 @@
+# frozen_string_literal: true
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in xommelier.gemspec
 gemspec
 
-
 gem 'simplecov', require: false, group: :test
diff --git a/Rakefile b/Rakefile
@@ -6,9 +6,7 @@ RSpec::Core::RakeTask.new(:spec)
 task default: :spec
 
 require 'rubocop/rake_task'
-RuboCop::RakeTask.new do |task|
-  task.requires << 'rubocop-rspec'
-end
+RuboCop::RakeTask.new
 task default: :rubocop
 
 require 'yard'

diff --git a/bin/console b/bin/console
@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 require 'bundler/setup'
 require 'xommelier'
 require 'pry'

diff --git a/bin/rake b/bin/rake
@@ -7,11 +7,11 @@
 # this file is here to facilitate running it.
 #
 
-require "pathname"
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
 
-require "rubygems"
-require "bundler/setup"
+require 'rubygems'
+require 'bundler/setup'
 
-load Gem.bin_path("rake", "rake")
+load Gem.bin_path('rake', 'rake')
diff --git a/bin/rubocop b/bin/rubocop
@@ -7,11 +7,11 @@
 # this file is here to facilitate running it.
 #
 
-require "pathname"
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
 
-require "rubygems"
-require "bundler/setup"
+require 'rubygems'
+require 'bundler/setup'
 
-load Gem.bin_path("rubocop", "rubocop")
+load Gem.bin_path('rubocop', 'rubocop')
diff --git a/examples/atom.rb b/examples/atom.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'xommelier/atom'
 require 'xommelier/atom/threading'
 require 'active_support/core_ext'

diff --git a/examples/xml.rb b/examples/xml.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'xommelier'
 
 class Author < Xommelier::Xml::Element

diff --git a/lib/xommelier.rb b/lib/xommelier.rb
@@ -1,4 +1,5 @@
 # coding: utf-8
+# frozen_string_literal: true
 
 ################################################
 # © Alexander Semyonov, 2011—2013, MIT License #

diff --git a/lib/xommelier/atom.rb b/lib/xommelier/atom.rb
@@ -1,4 +1,5 @@
 # coding: utf-8
+# frozen_string_literal: true
 
 ################################################
 # © Alexander Semyonov, 2011—2013, MIT License #

diff --git a/lib/xommelier/atom/category.rb b/lib/xommelier/atom/category.rb
@@ -1,4 +1,5 @@
 # coding: utf-8
+# frozen_string_literal: true
 
 ################################################
 # © Alexander Semyonov, 2011—2013, MIT License #

diff --git a/lib/xommelier/atom/content.rb b/lib/xommelier/atom/content.rb
@@ -1,4 +1,5 @@
 # coding: utf-8
+# frozen_string_literal: true
 
 ################################################
 # © Alexander Semyonov, 2011—2013, MIT License #

diff --git a/lib/xommelier/atom/entry.rb b/lib/xommelier/atom/entry.rb
@@ -1,4 +1,5 @@
 # coding: utf-8
+# frozen_string_literal: true
 
 ################################################
 # © Alexander Semyonov, 2011—2013, MIT License #

diff --git a/lib/xommelier/atom/feed.rb b/lib/xommelier/atom/feed.rb
@@ -1,4 +1,5 @@
 # coding: utf-8
+# frozen_string_literal: true
 
 ################################################
 # © Alexander Semyonov, 2011—2013, MIT License #

diff --git a/lib/xommelier/atom/full.rb b/lib/xommelier/atom/full.rb
@@ -1,4 +1,5 @@
 # coding: utf-8
+# frozen_string_literal: true
 
 ################################################
 # © Alexander Semyonov, 2011—2013, MIT License #

diff --git a/lib/xommelier/atom/generator.rb b/lib/xommelier/atom/generator.rb
@@ -1,4 +1,5 @@
 # coding: utf-8
+# frozen_string_literal: true
 
 ################################################
 # © Alexander Semyonov, 2011—2013, MIT License #

diff --git a/lib/xommelier/atom/history.rb b/lib/xommelier/atom/history.rb
@@ -1,4 +1,5 @@
 # coding: utf-8
+# frozen_string_literal: true
 
 ################################################
 # © Alexander Semyonov, 2011—2013, MIT License #

diff --git a/lib/xommelier/atom/link.rb b/lib/xommelier/atom/link.rb
@@ -1,4 +1,5 @@
 # coding: utf-8
+# frozen_string_literal: true
 
 ################################################
 # © Alexander Semyonov, 2011—2013, MIT License #
@@ -13,7 +14,7 @@ class Link < Xml::Element
       attribute :href, type: Uri
 
       may do
-        attribute :rel#, type: Enum(:alternate, :related, :self, :enclosure, :via)
+        attribute :rel # , type: Enum(:alternate, :related, :self, :enclosure, :via)
         attribute :type
         attribute :hreflang
         attribute :title

diff --git a/lib/xommelier/atom/links_extension.rb b/lib/xommelier/atom/links_extension.rb
@@ -1,4 +1,5 @@
 # coding: utf-8
+# frozen_string_literal: true
 
 ################################################
 # © Alexander Semyonov, 2011—2013, MIT License #

diff --git a/lib/xommelier/atom/person.rb b/lib/xommelier/atom/person.rb
@@ -1,4 +1,5 @@
 # coding: utf-8
+# frozen_string_literal: true
 
 ################################################
 # © Alexander Semyonov, 2011—2013, MIT License #

diff --git a/lib/xommelier/atom/source.rb b/lib/xommelier/atom/source.rb
@@ -1,4 +1,5 @@
 # coding: utf-8
+# frozen_string_literal: true
 
 ################################################
 # © Alexander Semyonov, 2011—2013, MIT License #

diff --git a/lib/xommelier/atom/threading.rb b/lib/xommelier/atom/threading.rb
@@ -1,4 +1,5 @@
 # coding: utf-8
+# frozen_string_literal: true
 
 ################################################
 # © Alexander Semyonov, 2011—2013, MIT License #

diff --git a/lib/xommelier/common.rb b/lib/xommelier/common.rb
@@ -1,4 +1,5 @@
 # coding: utf-8
+# frozen_string_literal: true
 
 ################################################
 # © Alexander Semyonov, 2011—2013, MIT License #
@@ -15,7 +16,11 @@ def self.from_xommelier(value)
         return unless value
         case value
         when String
-          value = rfc2822(value) rescue parse(value)
+          value = begin
+                    rfc2822(value)
+                  rescue
+                    parse(value)
+                  end
           at(value)
         when Time, Date, DateTime
           at(value.to_time)

diff --git a/lib/xommelier/core_ext.rb b/lib/xommelier/core_ext.rb
@@ -1,4 +1,5 @@
 # coding: utf-8
+# frozen_string_literal: true
 
 ################################################
 # © Alexander Semyonov, 2011—2013, MIT License #

diff --git a/lib/xommelier/core_ext/boolean.rb b/lib/xommelier/core_ext/boolean.rb
@@ -1,4 +1,5 @@
 # coding: utf-8
+# frozen_string_literal: true
 
 ################################################
 # © Alexander Semyonov, 2011—2013, MIT License #
@@ -9,11 +10,11 @@
 require 'xommelier'
 
 class Boolean
-  #noinspection RubyStringKeysInHashInspection,RubyDuplicatedKeysInHashInspection
+  # noinspection RubyStringKeysInHashInspection,RubyDuplicatedKeysInHashInspection
   BOOLEAN_MAP = {
     true => true, 'true' => true, 'TRUE' => true, '1' => true, '1.0' => true, 1 => true, 1.0 => true,
     false => false, 'false' => false, 'FALSE' => false, '0' => false, '0.0' => false, 0 => false, 0.0 => false, nil => false, '' => false
-  }
+  }.freeze
 
   def self.from_xommelier(value)
     BOOLEAN_MAP[value]

diff --git a/lib/xommelier/core_ext/date.rb b/lib/xommelier/core_ext/date.rb
@@ -1,4 +1,5 @@
 # coding: utf-8
+# frozen_string_literal: true
 
 ################################################
 # © Alexander Semyonov, 2011—2013, MIT License #

diff --git a/lib/xommelier/core_ext/float.rb b/lib/xommelier/core_ext/float.rb
@@ -1,4 +1,5 @@
 # coding: utf-8
+# frozen_string_literal: true
 
 ################################################
 # © Alexander Semyonov, 2011—2013, MIT License #

diff --git a/lib/xommelier/core_ext/numeric.rb b/lib/xommelier/core_ext/numeric.rb
@@ -1,4 +1,5 @@
 # coding: utf-8
+# frozen_string_literal: true
 
 ################################################
 # © Alexander Semyonov, 2011—2013, MIT License #

diff --git a/lib/xommelier/core_ext/string.rb b/lib/xommelier/core_ext/string.rb
@@ -1,4 +1,5 @@
 # coding: utf-8
+# frozen_string_literal: true
 
 ################################################
 # © Alexander Semyonov, 2011—2013, MIT License #

diff --git a/lib/xommelier/core_ext/symbol.rb b/lib/xommelier/core_ext/symbol.rb
@@ -1,4 +1,5 @@
 # coding: utf-8
+# frozen_string_literal: true
 
 ################################################
 # © Alexander Semyonov, 2011—2013, MIT License #

diff --git a/lib/xommelier/core_ext/time.rb b/lib/xommelier/core_ext/time.rb
@@ -1,4 +1,5 @@
 # coding: utf-8
+# frozen_string_literal: true
 
 ################################################
 # © Alexander Semyonov, 2011—2013, MIT License #
@@ -9,7 +10,7 @@
 
 class Time
   def self.from_xommelier(value)
-    return if value == nil
+    return if value.nil?
     case value
     when String
       Time.xmlschema(value)

diff --git a/lib/xommelier/core_ext/uri.rb b/lib/xommelier/core_ext/uri.rb
@@ -1,4 +1,5 @@
 # coding: utf-8
+# frozen_string_literal: true
 
 ################################################
 # © Alexander Semyonov, 2011—2013, MIT License #
@@ -17,7 +18,7 @@ def to_xommelier
 
 class Uri < String
   def self.from_xommelier(value)
-    return if value == nil
+    return if value.nil?
     case value
     when URI::Generic
       value
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		require: rubocop-rspec
		inherit_from: .rubocop_todo.yml