Fix style violations and update RuboCop config

Author: remi Taylor

.rubocop.yml

@@ -12,10 +12,61 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# RubyCop configuration file
+#
+# RuboCop
+# http://batsov.com/rubocop/
+#
+# Style cops
+# http://www.rubydoc.info/gems/rubocop/RuboCop/Cop/Style
+#
+# Lint cops
+# http://www.rubydoc.info/gems/rubocop/RuboCop/Cop/Lint
+
+# Prefer double quotes for consistency (regardless of interpolation)
 Style/StringLiterals:
   EnforcedStyle: double_quotes
+
+# Prefer no parentheses for method definitions and invocations
 Style/MethodDefParentheses:
   EnforcedStyle: require_no_parentheses
+
+# Use %[ ] for string arrays
+# Use %{ } for other delimiters, eg. %{ } sometimes used for multiline strings
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+# Always use 2 spaces for indentation
+# Sometimes method invokations might be additionally indented for clarity
+Style/MultilineMethodCallIndentation:
+  Enabled: false
+
+# Unused block arguments are OK
+# They can add clarity to code to demonstrate available arguments
+Lint/UnusedBlockArgument:
+  Enabled: false
+
+# Usage of // or %r{ } is acceptable for regular expressions
+# Please use // unless %r{ } adds clarity, eg. slashes used in expression
+Style/RegexpLiteral:
+  Enabled: false
+
+# Use of parenthesis is optional in nested method calls
+# This cop is optional mostly to support RSpec expectations
+# If the code sample is: service.add "variable"
+# Then the spec can use: expect { service.add "variable" }
+Style/NestedParenthesizedCalls:
+  Enabled: false
+
+# In production code, yield is prefered over block.call
+# For code samples, explicitly calling a block by name can add clarity
+Performance/RedundantBlockCall:
+  Enabled: false
+
+# Empty line at top of block is sometimes OK, eg. for RSpec describe blocks
+Style/EmptyLinesAroundBlockBody:
+  Enabled: false
+
 Style/NumericLiterals:
   Enabled: false
 Style/SpaceAroundOperators:

logging/Gemfile.lock

@@ -8,7 +8,7 @@ GEM
       thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
     addressable (2.4.0)
-    ast (2.2.0)
+    ast (2.3.0)
     autoparse (0.3.3)
       addressable (>= 2.3.1)
       extlib (>= 0.9.15)
@@ -63,7 +63,7 @@ GEM
     multi_json (1.12.1)
     multipart-post (2.0.0)
     os (0.9.6)
-    parser (2.3.1.1)
+    parser (2.3.1.2)
       ast (~> 2.2)
     powerpack (0.1.1)
     rack (1.6.4)
@@ -85,8 +85,8 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.4.0)
     rspec-support (3.4.1)
-    rubocop (0.40.0)
-      parser (>= 2.3.1.0, < 3.0)
+    rubocop (0.42.0)
+      parser (>= 2.3.1.1, < 3.0)
       powerpack (~> 0.1)
       rainbow (>= 1.99.1, < 3.0)
       ruby-progressbar (~> 1.7)
@@ -100,7 +100,7 @@ GEM
     thread_safe (0.3.5)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
-    unicode-display_width (1.0.5)
+    unicode-display_width (1.1.0)
     zonefile (1.04)
 
 PLATFORMS

logging/sample.rb

@@ -113,14 +113,14 @@ def write_log_entry
 end
 
 def delete_log
-# [START delete_log]
+  # [START delete_log]
   require "gcloud"
 
   gcloud  = Gcloud.new "my-gcp-project-id"
   logging = gcloud.logging
 
   logging.delete_log "my_application_log"
-# [END delete_log]
+  # [END delete_log]
 end
 
 def write_log_entry_using_ruby_logger
@@ -129,8 +129,10 @@ def write_log_entry_using_ruby_logger
 
   gcloud   = Gcloud.new "my-gcp-project-id"
   logging  = gcloud.logging
-  resource = logging.resource "gae_app", module_id: "default", version_id: "20160101t163030"
-  logger   = logging.logger "my_application_log", resource
+  resource = logging.resource "gae_app", module_id: "default",
+                                         version_id: "20160101t163030"
+
+  logger = logging.logger "my_application_log", resource
 
   logger.info "Log message"
   # [END write_log_entry_using_ruby_logger]

logging/spec/sample_spec.rb

@@ -27,10 +27,15 @@ def wait_until times: 5, delay: 1, &condition
     raise "Condition not met.  Waited #{times} times with #{delay} sec delay"
   end
 
+  # Frequently used full path to "my_application_log" for test project
+  def my_application_log_name
+    "projects/#{@project_id}/logs/my_application_log"
+  end
+
   # Returns entries logged to "my_application_log" in the test project
   def my_application_log_entries
     @logging.entries(
-      filter: %{logName = "projects/#{@project_id}/logs/my_application_log"},
+      filter: %{logName = "#{my_application_log_name}"},
       order: "timestamp desc"
     )
   end
@@ -73,7 +78,8 @@ def my_application_log_entries
 
   # Delete log sink used by code samples if the test created one
   def cleanup!
-    @logging.sink("my-sink")&.delete
+    test_sink = @logging.sink "my-sink"
+    test_sink.delete if test_sink
   end
 
   it "can create logging client" do
@@ -91,14 +97,14 @@ def cleanup!
 
   it "can create log sink" do
     expect(@logging.sink "my-sink").to be nil
-    
+
     create_log_sink
 
     expect(@logging.sink "my-sink").not_to be nil
   end
 
   it "can update log sink" do
-    original_destination = "storage.googleapis.com/#{@bucket.id}" 
+    original_destination = "storage.googleapis.com/#{@bucket.id}"
     updated_destination  = "storage.googleapis.com/#{@alt_bucket.id}"
 
     create_log_sink
@@ -130,17 +136,15 @@ def cleanup!
       with(filter: %{resource.type = "gae_app"}).
       and_wrap_original do |m, *args|
         m.call(
-          filter: %{logName = "projects/#{@project_id}/logs/my_application_log"},
+          filter: %{logName = "#{my_application_log_name}"},
           order: "timestamp desc"
         )
-    end
+      end
 
     timestamp = "\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2} [^\\\\]+"
-    log_name  = "projects/#{@project_id}/logs/my_application_log"
-    payload   = '"Log message"'
 
     expect { list_log_entries }.to output(
-      %r{\[#{timestamp}\] #{log_name} #{payload}}
+      %r{\[#{timestamp}\] #{my_application_log_name} "Log message"}
     ).to_stdout
   end
 
@@ -167,7 +171,7 @@ def cleanup!
     end
 
     entries = my_application_log_entries
-    entry = entries.detect {|e| e.payload.include? "time #{current_time}" }
+    entry = entries.detect { |e| e.payload.include? "time #{current_time}" }
     expect(entry).to be nil
 
     write_log_entry
@@ -180,7 +184,7 @@ def cleanup!
     end
 
     entries = my_application_log_entries
-    entry = entries.detect {|e| e.payload.include? "time #{current_time}" }
+    entry = entries.detect { |e| e.payload.include? "time #{current_time}" }
     expect(entry).not_to be nil
     expect(entry.payload).to eq "Log message - current time #{current_time}"
     expect(entry.severity).to eq :NOTICE
@@ -200,7 +204,7 @@ def cleanup!
       filter: %{logName = "projects/#{@project_id}/logs/my_application_log"},
       order: "timestamp desc"
     )
-    entry = entries.detect {|e| e.payload.include? "time #{current_time}" }
+    entry = entries.detect { |e| e.payload.include? "time #{current_time}" }
     expect(entry).to be nil
 
     # Hooked up to real test project
@@ -227,7 +231,7 @@ def cleanup!
       m.call message
     end
 
-    write_log_entry_using_ruby_logger  
+    write_log_entry_using_ruby_logger
 
     # Wait for entry to be queryable
     wait_until do
@@ -237,7 +241,7 @@ def cleanup!
     end
 
     entries = my_application_log_entries
-    entry = entries.detect {|e| e.payload.include? "time #{current_time}" }
+    entry = entries.detect { |e| e.payload.include? "time #{current_time}" }
     expect(entry).not_to be nil
     expect(entry.payload).to eq "Log message - current time #{current_time}"
     expect(entry.severity).to eq :INFO