Fixing CI and tests

Author: Konstantin Gredeskoul

.rubocop.yml

@@ -6,7 +6,7 @@ AllCops:
     - "**/rubocop"
     - "examples/**/*"
     - "bazel-*/**/*"
-    - "**/external/**/*"
+    - "external/**/*"
     - "**/vendor/bundle/**/*"
 
 

examples/simple_script/.rubocop.yml

@@ -1,11 +1,36 @@
-inherit_from: .relaxed-rubocop-2.4.yml
+inherit_from: ~/.relaxed-rubocop-2.4.yml
 
 AllCops:
-  TargetRubyVersion: 2.6.5
+  TargetRubyVersion: 2.6
+  UseCache: true
+  DefaultFormatter: progress
+  DisplayStyleGuide: true
+  DisplayCopNames: true
   Exclude:
-    - rubocop
-    - bazel-*/**/*
-    - external/**/*
+    - "external*/**/*"
+    - "bazel-*/**/*"
+    - "**/examples/**/*"
+    - "**/BUILD"
+    - "**/*.bazel"
+    - "**/*.bzl"
+    - "**/rubocop"
     - "**/vendor/bundle/**/*"
+  Include:
+    - '**/*.rb'
+    - '**/*.gemfile'
+    - '**/*.gemspec'
+    - '**/*.rake'
+    - '**/*.ru'
+    - '**/Gemfile'
+    - '**/Rakefile'
 
+Layout/HashAlignment:
+  Enabled: true
+  EnforcedColonStyle: table
+  
+Style/Dir:
+  Enabled: false
 
+# In Bazel we want to use __FILE__ because __dir__points to the actual sources
+Style/ExpandPathArguments:
+  Enabled: false

examples/simple_script/BUILD

@@ -3,32 +3,59 @@ package(default_visibility = ["//:__subpackages__"])
 load(
     "@bazelruby_ruby_rules//ruby:defs.bzl",
     "ruby_binary",
+    "ruby_library",
     "ruby_test",
 )
 
+ruby_library(
+    name = "script.lib",
+    srcs = [
+        "script.rb",
+        "//lib:foo",
+    ],
+    deps = [
+        "@bundle//:awesome_print",
+        "@bundle//:colored2",
+    ],
+)
+
 ruby_binary(
-    name = "default_bin",
+    name = "bin",
     srcs = ["script.rb"],
     main = "script.rb",
     deps = [
+        ":script.lib",
         "//lib:foo",
         "@bundle//:awesome_print",
+        "@bundle//:colored2",
     ],
 )
 
 ruby_test(
-    name = "script_spec",
+    name = "rspec",
     timeout = "short",
     srcs = [
         "script.rb",
+        "spec/lib/foo_spec.rb",
         "spec/script_spec.rb",
+        "spec/spec_helper.rb",
+        "@bundle//:bin/rspec",
+    ],
+    args = [
+        "spec",
+    ],
+    includes = [
+        ".",
+        "lib",
+        "spec",
     ],
-    main = "spec/script_spec.rb",
-    rubyopt = ["-rrspec/autorun"],  # require autorun because it is needed
+    main = "spec/spec_helper.rb",
     deps = [
         "//lib:foo",
         "@bundle//:awesome_print",
+        "@bundle//:colored2",
         "@bundle//:rspec",
+        "@bundle//:rspec-its",
     ],
 )
 
@@ -39,7 +66,9 @@ ruby_binary(
         ".relaxed-rubocop-2.4.yml",
         ".rubocop.yml",
         "script.rb",
+        "spec/lib/foo_spec.rb",
         "spec/script_spec.rb",
+        "spec/spec_helper.rb",
         "@bundle//:bin/rubocop",
     ],
     args = [
@@ -50,6 +79,7 @@ ruby_binary(
     ],
     main = "@bundle//:bin/rubocop",
     deps = [
+        "//lib:foo",
         "@bundle//:rubocop",
     ],
 )

examples/simple_script/Gemfile

@@ -5,4 +5,5 @@ source 'https://rubygems.org'
 gem 'awesome_print'
 gem 'colored2'
 gem 'rspec', '~> 3.7.0'
+gem 'rspec-its'
 gem 'rubocop', '~> 0.78.0'

examples/simple_script/Gemfile.lock

@@ -19,6 +19,9 @@ GEM
     rspec-expectations (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
+    rspec-its (1.3.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
     rspec-mocks (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
@@ -40,7 +43,8 @@ DEPENDENCIES
   awesome_print
   colored2
   rspec (~> 3.7.0)
+  rspec-its
   rubocop (~> 0.78.0)
 
 BUNDLED WITH
-   2.1.0
+   2.1.2

examples/simple_script/lib/foo.rb

@@ -1,7 +1,30 @@
 # frozen_string_literal: true
 
-module Foo
-  def self.aha
-    "aha"
+class Foo
+  class << self
+    def yell_aha
+      puts aha
+    end
+
+    def aha
+      'You said, aha?'
+    end
+
+    def rot13(value)
+      return nil unless value.is_a?(String)
+
+      value.tr('abcdefghijklmnopqrstuvwxyz', 'nopqrstuvwxyzabcdefghijklm')
+    end
+  end
+
+  attr_reader :goo, :foo
+
+  def initialize(goo)
+    @goo = goo
+    @foo = transform(goo)
+  end
+
+  def transform(incoming = goo)
+    Foo.rot13(incoming)
   end
 end

examples/simple_script/script.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
+require 'colored2'
 require 'openssl'
-require 'lib/foo'
 require 'awesome_print'
 
+require_relative 'lib/foo'
+
 def oss_rand
   OpenSSL::BN.rand(512).to_s
 end
 
 puts Foo.aha + ' ' + oss_rand
 
-puts $LOAD_PATH
-
-ap Class
+ap Class.to_s

examples/simple_script/spec/lib/foo_spec.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative '../spec_helper'
+require_relative '../../lib/foo'
+
+RSpec.describe Foo do
+  let(:goo) { 'Green slime was dripping down his throat into his lapdomen...' }
+  subject(:foo) { Foo.new(goo) }
+
+  context 'without the aha' do
+    before { allow(Foo).to receive(:yell_aha).and_return('tiny dongle') }
+
+    its(:goo) { should eq goo }
+    its(:transform) { should_not eq goo }
+
+    # Some rot13 old school encryption :)
+    its(:transform) { should eq 'Gerra fyvzr jnf qevccvat qbja uvf guebng vagb uvf yncqbzra...' }
+  end
+
+  context 'aha' do
+    it 'should print aha' do
+      expect(Foo).to receive(:puts).with('You said, aha?').and_return(nil)
+      Foo.yell_aha
+    end
+  end
+end

examples/simple_script/spec/script_spec.rb

@@ -1,35 +1,6 @@
 # frozen_string_literal: true
 
-RSpec.configure do |config|
-  config.expect_with :rspec do |expectations|
-    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
-  end
-
-  config.mock_with :rspec do |mocks|
-    mocks.verify_partial_doubles = true
-  end
-
-  config.shared_context_metadata_behavior = :apply_to_host_groups
-
-  config.warnings = true
-  config.filter_run_when_matching :focus
-  # config.disable_monkey_patching!
-  config.order = :random
-  Kernel.srand config.seed
-end
-
-# Sets HOME here because:
-# If otherwise, it causes a runtime failure with the following steps.
-# 1. RSpec::Core::ConfigurationOptions.global_options_file raises an exception
-#    because $HOME is not set in the sandbox environment of Bazel
-# 2. the rescue clause calls RSpec::Support.#warning
-# 3. #warning calls #warn_with
-# 4. #warn_with tries to lookup the first caller which is not a part of RSpec.
-#    But all the call stack entires are about RSpec at this time because
-#    it is invoked by rpsec/autorun. So #warn_with raises an exception
-# 5. The process fails with an unhandled exception.
-ENV['HOME'] ||= '/'
-
+require 'spec_helper'
 require_relative '../script'
 
 describe 'oss_rand' do

examples/simple_script/spec/spec_helper.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'rspec'
+require 'rspec/its'
+require 'awesome_print'
+require 'colored2'
+
+# frozen_string_literal: true
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  config.warnings = true
+  config.filter_run_when_matching :focus
+  # config.disable_monkey_patching!
+  config.order = :random
+  Kernel.srand config.seed
+end
+
+if $0 == 'rspec'
+  require_relative '../script'
+  require_relative '../lib/foo'
+  require_relative './script_spec'
+  require_relative './lib/foo_spec'
+end
+
+# Sets HOME here because:
+# If otherwise, it causes a runtime failure with the following steps.
+# 1. RSpec::Core::ConfigurationOptions.global_options_file raises an exception
+#    because $HOME is not set in the sandbox environment of Bazel
+# 2. the rescue clause calls RSpec::Support.#warning
+# 3. #warning calls #warn_with
+# 4. #warn_with tries to lookup the first caller which is not a part of RSpec.
+#    But all the call stack entires are about RSpec at this time because
+#    it is invoked by rpsec/autorun. So #warn_with raises an exception
+# 5. The process fails with an unhandled exception.
+# ENV['HOME'] ||= '/'