rubocop-temporal 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4febd507038f166b850ed9f780ec490d20eb090fd40284f5aa17d37bb429988e
+  data.tar.gz: 51328f405b3d2c39258d9470919c64f77b0dc3e7c9314f02c4bcdf95e7bd7e17
+SHA512:
+  metadata.gz: 998e8a5869f3d034bdc26f5dbb9dc7a0e218bbf630e4a1f7943df5fca4ed61cbc539136fdde24f328d9133dca25e3c136d8e8cd1403cae2c927cc05bd07d300b
+  data.tar.gz: 6deb7be8332b81765508d3938450e3fa3e515d1accda100ce9101253855ad9cb6985a6515ffa1aa02b8a56c56687493574445a47278a13e4640835aac0f4bc63

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.vscode/

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,12 @@
+Naming/FileName:
+ Exclude:
+   - lib/rubocop-temporal.rb
+
+AllCops:
+  TargetRubyVersion: 2.5.0
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.4
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rubocop-temporal.gemspec
+gemspec
+
+gem "minitest", "~> 5.0"
+gem "rake", "~> 12.0"
+gem "rspec"

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    rubocop-temporal (0.1.0)
+      rubocop (~> 1.8)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.4.4)
+    minitest (5.14.4)
+    parallel (1.21.0)
+    parser (3.0.3.1)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.23.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.12.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.13.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  x86_64-darwin-19
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  rake (~> 12.0)
+  rspec
+  rubocop-temporal!
+
+BUNDLED WITH
+   2.2.31

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Achilleas Buisman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,114 @@
+# Rubocop::Temporal
+
+Is your test suite suddenly failing randomly? Do you use `travel_to` without blocks? The Department of Temporal Investigations is here to ~~stop~~ help you.
+
+TLDR: This cop checks for calls to `travel_to` without a block. This is dangerous because a test where this happen might break other tests subtely because now the code runs either in the future or in the past. Using a block will protect you, because after running the block, you will be returned to real time.
+
+## The problem
+
+So what is the problem? Let's explore this a bit.
+
+Imagine you have the following spec:
+
+```ruby
+describe 'Enable discounts on New Years Eve' do
+    context 'when it is new years' do
+        it 'shows fireworks' do
+            travel_to '2021-12-31'
+
+            expect(product.price).to eq 100 * 0.5
+        end
+    end
+end
+```
+
+Looks good, ship it!
+
+Oh no, random failures:
+
+```ruby
+
+# Mail is not enqueued suddenly, but only sometimes. When you run this spec individually, it is always sent
+describe 'Special member invite' do
+    it 'invites people who spent at least €1000 to become special members' do
+        10.times { user.purchase(create(:product, price: 100)) }
+
+        expect(ActionMailer::MailDeliveryJob).to have_been_enqueued.with('UserMailer', 'special_member_invite', 'deliver_now', user)
+    end
+end
+
+# This also passes individually, but sometimes we see:
+# Luke: Noooooooooooooo
+# Darth: No. I am your father
+describe 'Message view' do
+    it 'displays messages from old to new' do
+        travel_to 2.days.ago
+        darth_message = send_message(to: 'Luke', 'No. I am your father')
+
+        travel_back
+        luke_message = send_message(to: 'Darth', 'Noooooooooooooo')
+
+        expect(page).to have_content(<~~MESSAGE)
+            Darth: No. I am your father
+            Luke: Noooooooooooooo
+        MESSAGE
+    end
+end
+
+```
+
+Why?
+
+Many 🕐🕑🕒🕓 hours, later 🧽.
+
+It turns out, whenever the `Enable discounts on New Years Eve` spec runs, it sets the date to the end of this year, but we never return to the current date. The random fails then only happen when the NYE spec runs before them, hence 'random'.
+
+The spec `Special member invite` fails because on New Years Eve all prices are cut in half, so the user never reaches the treshold of €1000.
+
+The spec `Message view` fails because when we did `travel_to 2.days.ago` we went to the 29th of December, not `2.days.ago` from the current date. Then when we do `travel_back` we go back to the current date, lets say the 15th of May and send the second message, or so we think. In reality it is now the first message.
+
+Side note: this does not randomly fail after the 31st of December 2021.
+
+The solution? Passing a block to `travel_to`. After the block runs, you will be returned to real time.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rubocop-temporal', require: false
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rubocop-temporal
+
+## Usage
+
+Add the following to your `.rubocop.yml` config:
+
+```
+require:
+  - rubocop-temporal
+```
+
+If `require:` was already there, just add `  - rubocop-temporal` nested underneath it.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/abuisman/rubocop-temporal.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+desc 'Generate a new cop with a template'
+task :new_cop, [:cop] do |_task, args|
+  require 'rubocop'
+
+  cop_name = args.fetch(:cop) do
+    warn 'usage: bundle exec rake new_cop[Department/Name]'
+    exit!
+  end
+
+  github_user = `git config github.user`.chop
+  github_user = 'your_id' if github_user.empty?
+
+  generator = RuboCop::Cop::Generator.new(cop_name, github_user)
+
+  generator.write_source
+  generator.write_spec
+  generator.inject_require(root_file_path: 'lib/rubocop/cop/temporal_cops.rb')
+  generator.inject_config(config_file_path: 'config/default.yml')
+
+  puts generator.todo
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "rubocop/temporal"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/default.yml

@@ -0,0 +1,2 @@
+Temporal/TravelToWithBlock:
+  Description: "Always use a block when calling travel_to"

data/lib/rubocop/cop/temporal_cops.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Temporal
+  class TravelToWithBlock < RuboCop::Cop::Cop
+    def_node_matcher(
+      :travel_to,
+      <<~PATTERN
+        (send nil? :travel_to ...)
+      PATTERN
+    )
+
+    MSG = "Always use travel_to with a block"
+
+    def on_send(node)
+      travel_to(node) do
+        next if node.block_node
+
+        add_offense(node)
+      end
+    end
+  end
+end

data/lib/rubocop/temporal/inject.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# The original code is from https://github.com/rubocop-hq/rubocop-rspec/blob/master/lib/rubocop/rspec/inject.rb
+# See https://github.com/rubocop-hq/rubocop-rspec/blob/master/MIT-LICENSE.md
+module RuboCop
+  module Temporal
+    # Because RuboCop doesn't yet support plugins, we have to monkey patch in a
+    # bit of our configuration.
+    module Inject
+      def self.defaults!
+        path = CONFIG_DEFAULT.to_s
+        hash = ConfigLoader.send(:load_yaml_configuration, path)
+        config = Config.new(hash, path).tap(&:make_excludes_absolute)
+        puts "configuration from #{path}" if ConfigLoader.debug?
+        config = ConfigLoader.merge_with_default(config, path)
+        ConfigLoader.instance_variable_set(:@default_configuration, config)
+      end
+    end
+  end
+end

data/lib/rubocop/temporal/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Temporal
+    VERSION = "0.1.0"
+  end
+end

data/lib/rubocop/temporal.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "rubocop/temporal/version"
+
+module RuboCop
+  module Temporal
+    class Error < StandardError; end
+    # Your code goes here...
+    PROJECT_ROOT   = Pathname.new(__dir__).parent.parent.expand_path.freeze
+    CONFIG_DEFAULT = PROJECT_ROOT.join('config', 'default.yml').freeze
+    CONFIG         = YAML.safe_load(CONFIG_DEFAULT.read).freeze
+
+    private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)
+  end
+end

data/lib/rubocop-temporal.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+require_relative 'rubocop/temporal'
+require_relative 'rubocop/temporal/version'
+require_relative 'rubocop/temporal/inject'
+
+RuboCop::Temporal::Inject.defaults!
+
+require_relative 'rubocop/cop/temporal_cops'

data/rubocop-temporal.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative "lib/rubocop/temporal/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "rubocop-temporal"
+  spec.version = RuboCop::Temporal::VERSION
+  spec.authors = ["Achilleas Buisman"]
+  spec.email = ["temporal@abuisman.nl"]
+
+  spec.summary = "Rubocop cop that makes sure travel_to is called with a block"
+  spec.description = "A rubocop cop that check that `travel_to` is only called with a block."
+  spec.homepage = "https://github.com/abuisman/rubocop-temporal"
+  spec.license = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/abuisman/rubocop-temporal"
+  spec.metadata["changelog_uri"] = "https://github.com/abuisman/rubocop-temporal"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "rubocop", "~> 1.8"
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-temporal
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Achilleas Buisman
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-12-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: A rubocop cop that check that `travel_to` is only called with a block.
+email:
+- temporal@abuisman.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/default.yml
+- lib/rubocop-temporal.rb
+- lib/rubocop/cop/temporal_cops.rb
+- lib/rubocop/temporal.rb
+- lib/rubocop/temporal/inject.rb
+- lib/rubocop/temporal/version.rb
+- rubocop-temporal.gemspec
+homepage: https://github.com/abuisman/rubocop-temporal
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/abuisman/rubocop-temporal
+  source_code_uri: https://github.com/abuisman/rubocop-temporal
+  changelog_uri: https://github.com/abuisman/rubocop-temporal
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Rubocop cop that makes sure travel_to is called with a block
+test_files: []