Skip to content

Commit

Permalink
Add cleanup job and tests and stuff
Browse files Browse the repository at this point in the history
  • Loading branch information
hschne committed Dec 20, 2023
1 parent b028f1d commit 9485ba5
Show file tree
Hide file tree
Showing 11 changed files with 295 additions and 5 deletions.
7 changes: 7 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -42,3 +42,10 @@

# Ignore for Build
/vendor/bundle

# Test stuff
*.rbc
.rspec
/public/system
/coverage/
/spec/tmp
33 changes: 33 additions & 0 deletions .rubocop.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
require:
- rubocop-factory_bot
- rubocop-rails
- rubocop-rspec

AllCops:
NewCops: enable

Layout/LineLength:
Max: 120

Layout/MultilineMethodCallIndentation:
EnforcedStyle: indented_relative_to_receiver

Metrics/BlockLength:
AllowedMethods: ["describe", "context"]

RSpec/ExampleLength:
Exclude:
- spec/**/*

RSpec/NestedGroups:
Max: 5

RSpec/MultipleExpectations:
Max: 2

Style/BlockDelimiters:
Exclude:
- spec/**/*

Style/Documentation:
Enabled: false
16 changes: 14 additions & 2 deletions Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -50,11 +50,18 @@ gem 'kamal', '~> 1.3'

gem 'litestack', '~> 0.4.2'

# Files
gem 'active_storage_validations', '~> 1.1'
gem 'aws-sdk-s3', '~> 1.141'
gem 'inline_svg', '~> 1.9'

# Scheduler
gem 'rufus-scheduler', '~> 3.9'

# Utilities
gem 'inline_svg', '~> 1.9'
gem 'lograge', '~> 0.14.0'

# Errors
gem 'sentry-rails', '~> 5.14'
gem 'sentry-ruby', '~> 5.14'

Expand All @@ -64,16 +71,21 @@ gem 'sentry-ruby', '~> 5.14'
group :development, :test do
# See https://guides.rubyonrails.org/debugging_rails_applications.html#debugging-with-the-debug-gem
gem 'debug', platforms: %i[mri windows]
gem 'factory_bot_rails', '~> 6.4'
gem 'rspec-rails', '~> 6.1'
end

group :development do
# Use console on exceptions pages [https://github.com/rails/web-console]
gem 'annotate', '~> 3.2'

gem 'erb-formatter', '~> 0.6.0'
gem 'rubocop', '~> 1.59'
gem 'rubocop-factory_bot', '~> 2.24'
gem 'rubocop-rails', '~> 2.23'
gem 'web-console'
gem 'rubocop-rspec', '~> 2.25'

gem 'web-console'
# Add speed badges [https://github.com/MiniProfiler/rack-mini-profiler]
# gem "rack-mini-profiler"

Expand Down
43 changes: 43 additions & 0 deletions Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,7 @@ GEM
debug (1.9.0)
irb (~> 1.10)
reline (>= 0.3.8)
diff-lcs (1.5.0)
dotenv (2.8.1)
drb (2.2.0)
ruby2_keywords
Expand All @@ -123,6 +124,11 @@ GEM
erubi (1.12.0)
et-orbi (1.2.7)
tzinfo
factory_bot (6.4.2)
activesupport (>= 5.0.0)
factory_bot_rails (6.4.2)
factory_bot (~> 6.4)
railties (>= 5.0.0)
fugit (1.9.0)
et-orbi (~> 1, >= 1.2.7)
raabro (~> 1.4)
Expand Down Expand Up @@ -171,6 +177,11 @@ GEM
rack
sqlite3
tilt
lograge (0.14.0)
actionpack (>= 4)
activesupport (>= 4)
railties (>= 4)
request_store (~> 1.0)
loofah (2.22.0)
crass (~> 1.0.2)
nokogiri (>= 1.12.0)
Expand Down Expand Up @@ -258,7 +269,26 @@ GEM
regexp_parser (2.8.3)
reline (0.4.1)
io-console (~> 0.5)
request_store (1.5.1)
rack (>= 1.4)
rexml (3.2.6)
rspec-core (3.12.2)
rspec-support (~> 3.12.0)
rspec-expectations (3.12.3)
diff-lcs (>= 1.2.0, < 2.0)
rspec-support (~> 3.12.0)
rspec-mocks (3.12.6)
diff-lcs (>= 1.2.0, < 2.0)
rspec-support (~> 3.12.0)
rspec-rails (6.1.0)
actionpack (>= 6.1)
activesupport (>= 6.1)
railties (>= 6.1)
rspec-core (~> 3.12)
rspec-expectations (~> 3.12)
rspec-mocks (~> 3.12)
rspec-support (~> 3.12)
rspec-support (3.12.1)
rubocop (1.59.0)
json (~> 2.3)
language_server-protocol (>= 3.17.0)
Expand All @@ -272,11 +302,19 @@ GEM
unicode-display_width (>= 2.4.0, < 3.0)
rubocop-ast (1.30.0)
parser (>= 3.2.1.0)
rubocop-capybara (2.19.0)
rubocop (~> 1.41)
rubocop-factory_bot (2.24.0)
rubocop (~> 1.33)
rubocop-rails (2.23.0)
activesupport (>= 4.2.0)
rack (>= 1.1)
rubocop (>= 1.33.0, < 2.0)
rubocop-ast (>= 1.30.0, < 2.0)
rubocop-rspec (2.25.0)
rubocop (~> 1.40)
rubocop-capybara (~> 2.17)
rubocop-factory_bot (~> 2.22)
ruby-progressbar (1.13.0)
ruby2_keywords (0.0.5)
rufus-scheduler (3.9.1)
Expand Down Expand Up @@ -341,15 +379,20 @@ DEPENDENCIES
bootsnap
debug
erb-formatter (~> 0.6.0)
factory_bot_rails (~> 6.4)
importmap-rails
inline_svg (~> 1.9)
jbuilder
kamal (~> 1.3)
litestack (~> 0.4.2)
lograge (~> 0.14.0)
puma (>= 5.0)
rails (~> 7.1.2)
rspec-rails (~> 6.1)
rubocop (~> 1.59)
rubocop-factory_bot (~> 2.24)
rubocop-rails (~> 2.23)
rubocop-rspec (~> 2.25)
rufus-scheduler (~> 3.9)
sentry-rails (~> 5.14)
sentry-ruby (~> 5.14)
Expand Down
6 changes: 3 additions & 3 deletions app/jobs/cleanup_job.rb
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ class CleanupJob < ApplicationJob
queue_as :default

def perform
Upload.where(expiry: (Time.now..))
.or(Upload.where('remaining_uses < ?', 1))
.destroy_all
Upload.where(expiry: (..Time.now))
.or(Upload.where('remaining_uses < ?', 1))
.destroy_all
end
end
8 changes: 8 additions & 0 deletions spec/factories/uploads.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
FactoryBot.define do
factory :upload do
sequence(:key) { |i| "random-key-#{i}" }
expiry { 10.minutes.from_now }
remaining_uses { 1 }
data { Rack::Test::UploadedFile.new('spec/fixtures/files/sample.txt', 'image/png') }
end
end
Empty file added spec/fixtures/files/sample.txt
Empty file.
27 changes: 27 additions & 0 deletions spec/jobs/cleanup_job_spec.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
require 'rails_helper'

RSpec.describe CleanupJob do
it 'does not delete uploads with remaining uses and expiry' do
upload = create(:upload)

described_class.perform_now

expect(Upload.exists?(upload.id)).to be(true)
end

it 'deletes uploads with no remaining uses' do
upload = create(:upload, remaining_uses: 0)

described_class.perform_now

expect(Upload.exists?(upload.id)).to be(false)
end

it 'deletes expired uploads' do
upload = create(:upload, expiry: 1.minute.ago)

described_class.perform_now

expect(Upload.exists?(upload.id)).to be(false)
end
end
63 changes: 63 additions & 0 deletions spec/rails_helper.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# This file is copied to spec/ when you run 'rails generate rspec:install'
require 'spec_helper'
ENV['RAILS_ENV'] ||= 'test'
require_relative '../config/environment'
# Prevent database truncation if the environment is production
abort('The Rails environment is running in production mode!') if Rails.env.production?
require 'rspec/rails'
# Add additional requires below this line. Rails is not loaded until this point!

# Requires supporting ruby files with custom matchers and macros, etc, in
# spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
# run as spec files by default. This means that files in spec/support that end
# in _spec.rb will both be required and run as specs, causing the specs to be
# run twice. It is recommended that you do not name files matching this glob to
# end with _spec.rb. You can configure this pattern with the --pattern
# option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
#
# The following line is provided for convenience purposes. It has the downside
# of increasing the boot-up time by auto-requiring all files in the support
# directory. Alternatively, in the individual `*_spec.rb` files, manually
# require only the support files necessary.
#
Rails.root.glob('spec/support/**/*.rb').sort.each { |f| require f }

# Checks for pending migrations and applies them before tests are run.
# If you are not using ActiveRecord, you can remove these lines.
begin
ActiveRecord::Migration.maintain_test_schema!
rescue ActiveRecord::PendingMigrationError => e
abort e.to_s.strip
end
RSpec.configure do |config|
# Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
config.fixture_paths = [Rails.root.join('spec/fixtures')]

# If you're not using ActiveRecord, or you'd prefer not to run each of your
# examples within a transaction, remove the following line or assign false
# instead of true.
config.use_transactional_fixtures = true

# You can uncomment this line to turn off ActiveRecord support entirely.
# config.use_active_record = false

# RSpec Rails can automatically mix in different behaviours to your tests
# based on their file location, for example enabling you to call `get` and
# `post` in specs under `spec/controllers`.
#
# You can disable this behaviour by removing the line below, and instead
# explicitly tag your specs with their type, e.g.:
#
# RSpec.describe UsersController, type: :controller do
# # ...
# end
#
# The different available types are documented in the features, such as in
# https://rspec.info/features/6-0/rspec-rails
config.infer_spec_type_from_file_location!

# Filter lines from Rails gems in backtraces.
config.filter_rails_from_backtrace!
# arbitrary gems may also be filtered via:
# config.filter_gems_from_backtrace("gem name")
end
94 changes: 94 additions & 0 deletions spec/spec_helper.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
# This file was generated by the `rails generate rspec:install` command. Conventionally, all
# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
# The generated `.rspec` file contains `--require spec_helper` which will cause
# this file to always be loaded, without a need to explicitly require it in any
# files.
#
# Given that it is always loaded, you are encouraged to keep this file as
# light-weight as possible. Requiring heavyweight dependencies from this file
# will add to the boot time of your test suite on EVERY test run, even for an
# individual file that may not need all of that loaded. Instead, consider making
# a separate helper file that requires the additional dependencies and performs
# the additional setup, and require it from the spec files that actually need
# it.
#
# See https://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
RSpec.configure do |config|
# rspec-expectations config goes here. You can use an alternate
# assertion/expectation library such as wrong or the stdlib/minitest
# assertions if you prefer.
config.expect_with :rspec do |expectations|
# This option will default to `true` in RSpec 4. It makes the `description`
# and `failure_message` of custom matchers include text for helper methods
# defined using `chain`, e.g.:
# be_bigger_than(2).and_smaller_than(4).description
# # => "be bigger than 2 and smaller than 4"
# ...rather than:
# # => "be bigger than 2"
expectations.include_chain_clauses_in_custom_matcher_descriptions = true
end

# rspec-mocks config goes here. You can use an alternate test double
# library (such as bogus or mocha) by changing the `mock_with` option here.
config.mock_with :rspec do |mocks|
# Prevents you from mocking or stubbing a method that does not exist on
# a real object. This is generally recommended, and will default to
# `true` in RSpec 4.
mocks.verify_partial_doubles = true
end

# This option will default to `:apply_to_host_groups` in RSpec 4 (and will
# have no way to turn it off -- the option exists only for backwards
# compatibility in RSpec 3). It causes shared context metadata to be
# inherited by the metadata hash of host groups and examples, rather than
# triggering implicit auto-inclusion in groups with matching metadata.
config.shared_context_metadata_behavior = :apply_to_host_groups

# The settings below are suggested to provide a good initial experience
# with RSpec, but feel free to customize to your heart's content.
=begin
# This allows you to limit a spec run to individual examples or groups
# you care about by tagging them with `:focus` metadata. When nothing
# is tagged with `:focus`, all examples get run. RSpec also provides
# aliases for `it`, `describe`, and `context` that include `:focus`
# metadata: `fit`, `fdescribe` and `fcontext`, respectively.
config.filter_run_when_matching :focus
# Allows RSpec to persist some state between runs in order to support
# the `--only-failures` and `--next-failure` CLI options. We recommend
# you configure your source control system to ignore this file.
config.example_status_persistence_file_path = "spec/examples.txt"
# Limits the available syntax to the non-monkey patched syntax that is
# recommended. For more details, see:
# https://rspec.info/features/3-12/rspec-core/configuration/zero-monkey-patching-mode/
config.disable_monkey_patching!
# Many RSpec users commonly either run the entire suite or an individual
# file, and it's useful to allow more verbose output when running an
# individual spec file.
if config.files_to_run.one?
# Use the documentation formatter for detailed output,
# unless a formatter has already been configured
# (e.g. via a command-line flag).
config.default_formatter = "doc"
end
# Print the 10 slowest examples and example groups at the
# end of the spec run, to help surface which specs are running
# particularly slow.
config.profile_examples = 10
# Run specs in random order to surface order dependencies. If you find an
# order dependency and want to debug it, you can fix the order by providing
# the seed, which is printed after each run.
# --seed 1234
config.order = :random
# Seed global randomization in this process using the `--seed` CLI option.
# Setting this allows you to use `--seed` to deterministically reproduce
# test failures related to randomization by passing the same `--seed` value
# as the one that triggered the failure.
Kernel.srand config.seed
=end
end
3 changes: 3 additions & 0 deletions spec/support/factory_bot.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
RSpec.configure do |config|
config.include FactoryBot::Syntax::Methods
end

0 comments on commit 9485ba5

Please sign in to comment.