diff --git a/.gitignore b/.gitignore index 26c17459..9efbf585 100644 --- a/.gitignore +++ b/.gitignore @@ -4,6 +4,7 @@ log/*.log tmp/**/* .env .env.* +/spec/examples.txt /app/assets/builds/* !/app/assets/builds/.keep diff --git a/.rspec b/.rspec new file mode 100644 index 00000000..c99d2e73 --- /dev/null +++ b/.rspec @@ -0,0 +1 @@ +--require spec_helper diff --git a/Gemfile b/Gemfile index 9121a4af..a0a40047 100644 --- a/Gemfile +++ b/Gemfile @@ -19,7 +19,7 @@ gem 'haml', '~> 6.1', '>= 6.1.1' gem 'sass-rails', '~> 6.0' gem 'terser', '~> 1.1', '>= 1.1.17' gem 'react-rails', '~> 2.7', '>= 2.7.1' -gem 'jsbundling-rails', '~> 1.1' +gem 'jsbundling-rails', '~> 1.3' gem 'turbo-rails', '~> 2.0' # For authentication. @@ -86,3 +86,8 @@ gem "shell", "~> 0.8.1" # For workspace autocomplete. gem "solargraph", "~> 0.50.0", group: :development gem "solargraph-rails", "~> 1.1", group: :development + +# For automated tests. +group :development, :test do + gem "rspec-rails", "~> 7.0" +end diff --git a/Gemfile.lock b/Gemfile.lock index 607a00f0..c80f2416 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -376,6 +376,23 @@ GEM reverse_markdown (2.1.1) nokogiri rexml (3.3.7) + rspec-core (3.13.2) + rspec-support (~> 3.13.0) + rspec-expectations (3.13.3) + diff-lcs (>= 1.2.0, < 2.0) + rspec-support (~> 3.13.0) + rspec-mocks (3.13.2) + diff-lcs (>= 1.2.0, < 2.0) + rspec-support (~> 3.13.0) + rspec-rails (7.0.1) + actionpack (>= 7.0) + activesupport (>= 7.0) + railties (>= 7.0) + rspec-core (~> 3.13) + rspec-expectations (~> 3.13) + rspec-mocks (~> 3.13) + rspec-support (~> 3.13) + rspec-support (3.13.1) rubocop (1.66.1) json (~> 2.3) language_server-protocol (>= 3.17.0) @@ -503,7 +520,7 @@ DEPENDENCIES haml (~> 6.1, >= 6.1.1) http_accept_language (~> 2.1, >= 2.1.1) httparty (~> 0.22.0) - jsbundling-rails (~> 1.1) + jsbundling-rails (~> 1.3) letter_opener (~> 1.8, >= 1.8.1) memory_profiler (~> 1.0) mysql2 (~> 0.5.5) @@ -518,6 +535,7 @@ DEPENDENCIES rails-i18n (~> 7.0, >= 7.0.7) rdiscount (~> 2.2, >= 2.2.7.1) react-rails (~> 2.7, >= 2.7.1) + rspec-rails (~> 7.0) sanitize (~> 6.0, >= 6.0.2) sass-rails (~> 6.0) sentry-rails (~> 5.12) diff --git a/spec/mocks/custom_pets.rb b/spec/mocks/custom_pets.rb new file mode 100644 index 00000000..228d78f6 --- /dev/null +++ b/spec/mocks/custom_pets.rb @@ -0,0 +1,16 @@ +# We replace Neopets::CustomPets methods with a mocked implementation. +module Neopets::CustomPets + def self.fetch_viewer_data(pet_name, ...) + File.open(Rails.root / "spec/mocks/custom_pets/#{pet_name}.json") do |file| + HashWithIndifferentAccess.new JSON.load(file) + end + end + + def self.fetch_metadata(...) + raise NotImplementedError + end + + def self.fetch_image_hash(pet_name, ...) + "mock-image-hash:#{pet_name}" + end +end diff --git a/test/mocks/custom_pets/thyassa.json b/spec/mocks/custom_pets/thyassa.json similarity index 100% rename from test/mocks/custom_pets/thyassa.json rename to spec/mocks/custom_pets/thyassa.json diff --git a/spec/models/pet_spec.rb b/spec/models/pet_spec.rb new file mode 100644 index 00000000..4414a290 --- /dev/null +++ b/spec/models/pet_spec.rb @@ -0,0 +1,29 @@ +require 'rails_helper' +require_relative '../mocks/custom_pets' + +RSpec.describe Pet, type: :model do + context "#load" do + context "for thyassa, the Purple Chia" do + subject { Pet.load "thyassa" } + + it "is named thyassa" do + expect(subject.name).to eq("thyassa") + end + + it "has a new Purple Chia pet type" do + expect(subject.pet_type.new_record?).to be true + expect(subject.pet_type.color).to eq Color.find_by_name!("purple") + expect(subject.pet_type.species).to eq Species.find_by_name!("chia") + expect(subject.pet_type.body_id).to eq 212 + expect(subject.pet_type.image_hash).to eq "mock-image-hash:thyassa" + end + + it "has a new unlabeled Purple Chia pet state" do + expect(subject.pet_state.new_record?).to be true + expect(subject.pet_state.color).to eq Color.find_by_name!("purple") + expect(subject.pet_state.species).to eq Species.find_by_name!("chia") + expect(subject.pet_state.pose).to eq "UNKNOWN" + end + end + end +end diff --git a/spec/rails_helper.rb b/spec/rails_helper.rb new file mode 100644 index 00000000..0cd9a904 --- /dev/null +++ b/spec/rails_helper.rb @@ -0,0 +1,68 @@ +# 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? +# Uncomment the line below in case you have `--require rails_helper` in the `.rspec` file +# that will avoid rails generators crashing because migrations haven't been run yet +# return unless Rails.env.test? +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_by(&:to_s).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/7-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 diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb new file mode 100644 index 00000000..3fe5ca2a --- /dev/null +++ b/spec/spec_helper.rb @@ -0,0 +1,78 @@ +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. + + # 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 diff --git a/test/modeling.rb b/test/modeling.rb deleted file mode 100644 index eee540dc..00000000 --- a/test/modeling.rb +++ /dev/null @@ -1,16 +0,0 @@ -require 'test_helper' - -class ModelingTest < ActiveSupport::TestCase - test "Modeling thyassa gives us Purple Chia data" do - thyassa = Pet.load("thyassa") - - # The Purple Chia starts as a new record, hooked up to the existing - # Purple color and Chia species. - purple_chia = thyassa.pet_type - assert purple_chia.new_record? - assert_equal Color.find_by_name("purple"), purple_chia.color - assert_equal Species.find_by_name("chia"), purple_chia.species - assert_equal 212, purple_chia.body_id - assert_equal "mock-image-hash:thyassa", purple_chia.image_hash - end -end diff --git a/test/test_helper.rb b/test/test_helper.rb index 354abff3..8bf1192f 100644 --- a/test/test_helper.rb +++ b/test/test_helper.rb @@ -11,20 +11,3 @@ class ActiveSupport::TestCase # Add more helper methods to be used by all tests here... end - -# We replace Neopets::CustomPets methods with a mocked implementation. -module Neopets::CustomPets - def self.fetch_viewer_data(pet_name, ...) - File.open(Rails.root / "test/mocks/custom_pets/#{pet_name}.json") do |file| - HashWithIndifferentAccess.new JSON.load(file) - end - end - - def self.fetch_metadata(...) - raise NotImplementedError - end - - def self.fetch_image_hash(pet_name, ...) - "mock-image-hash:#{pet_name}" - end -end diff --git a/vendor/cache/rspec-core-3.13.2.gem b/vendor/cache/rspec-core-3.13.2.gem new file mode 100644 index 00000000..96e771a6 Binary files /dev/null and b/vendor/cache/rspec-core-3.13.2.gem differ diff --git a/vendor/cache/rspec-expectations-3.13.3.gem b/vendor/cache/rspec-expectations-3.13.3.gem new file mode 100644 index 00000000..d7847b72 Binary files /dev/null and b/vendor/cache/rspec-expectations-3.13.3.gem differ diff --git a/vendor/cache/rspec-mocks-3.13.2.gem b/vendor/cache/rspec-mocks-3.13.2.gem new file mode 100644 index 00000000..b7bc174c Binary files /dev/null and b/vendor/cache/rspec-mocks-3.13.2.gem differ diff --git a/vendor/cache/rspec-rails-7.0.1.gem b/vendor/cache/rspec-rails-7.0.1.gem new file mode 100644 index 00000000..f833fa43 Binary files /dev/null and b/vendor/cache/rspec-rails-7.0.1.gem differ diff --git a/vendor/cache/rspec-support-3.13.1.gem b/vendor/cache/rspec-support-3.13.1.gem new file mode 100644 index 00000000..bb660f28 Binary files /dev/null and b/vendor/cache/rspec-support-3.13.1.gem differ