Merge pull request #6 from 0rientd/development

Created test in rspec

Author: 0rientd

.rspec

@@ -0,0 +1 @@
+--require spec_helper

Gemfile

@@ -45,6 +45,8 @@ group :development, :test do
 
   # Omakase Ruby styling [https://github.com/rails/rubocop-rails-omakase/]
   gem "rubocop-rails-omakase", require: false
+
+  gem "rspec-rails", "~> 8.0"
 end
 
 group :development do

Gemfile.lock

@@ -101,6 +101,7 @@ GEM
     debug (1.11.0)
       irb (~> 1.10)
       reline (>= 0.3.8)
+    diff-lcs (1.6.2)
     drb (2.2.3)
     erb (5.0.2)
     erubi (1.13.1)
@@ -225,6 +226,27 @@ GEM
     reline (0.6.2)
       io-console (~> 0.5)
     rexml (3.4.1)
+    rspec (3.13.1)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.5)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-rails (8.0.1)
+      actionpack (>= 7.2)
+      activesupport (>= 7.2)
+      railties (>= 7.2)
+      rspec-core (~> 3.13)
+      rspec-expectations (~> 3.13)
+      rspec-mocks (~> 3.13)
+      rspec-support (~> 3.13)
+    rspec-support (3.13.4)
     rubocop (1.78.0)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
@@ -339,6 +361,8 @@ DEPENDENCIES
   pg (~> 1.5)
   puma (>= 5.0)
   rails (~> 7.2.2, >= 7.2.2.1)
+  rspec (~> 3.13)
+  rspec-rails (~> 8.0)
   rubocop-rails-omakase
   selenium-webdriver
   sprockets-rails

spec/helpers/search_queries_helper_spec.rb

@@ -0,0 +1,53 @@
+require 'rails_helper'
+
+RSpec.describe SearchQueriesHelper, type: :helper do
+  describe 'all_trending_queries' do
+    it 'return the first 3 terms in desc order' do
+      SearchQuery.create!(term: "term1", ip_address: '127.0.0.1')
+      SearchQuery.create!(term: "term1", ip_address: '127.0.0.1')
+      SearchQuery.create!(term: "term1", ip_address: '127.0.0.1')
+      SearchQuery.create!(term: "term2", ip_address: '127.0.0.1')
+      SearchQuery.create!(term: "term2", ip_address: '127.0.0.1')
+      SearchQuery.create!(term: "term3", ip_address: '127.0.0.1')
+      
+      result = helper.all_trending_queries
+
+      expect(result.keys.size).to eq(3)
+      expect(result.keys.first).to eq('term1')
+    end
+  end
+
+  describe 'format_trend_information' do
+    it 'format the info' do
+      trend = ['Fortnite', 10]
+      expect(helper.format_trend_information(trend)).to eq('Fortnite (10 hits)')
+    end
+
+    it 'return nil if empty' do
+      expect(helper.format_trend_information(nil)).to be_nil
+      expect(helper.format_trend_information([])).to be_nil
+    end
+  end
+
+  describe 'format_analytics_information' do
+    it 'format the analytic info' do
+      analytic = SearchQuery.new(term: 'Fortnite', ip_address: '192.168.0.1')
+      expect(helper.format_analytics_information(analytic)).to eq('Term: Fortnite | (From 192.168.0.1)')
+    end
+
+    it 'return nil if empty' do
+      expect(helper.format_analytics_information(nil)).to be_nil
+    end
+  end
+
+  describe 'format_top_ten_information' do
+    it 'format the top ten info' do
+      analytic = ['Minecraft', 20]
+      expect(helper.format_top_ten_information(analytic)).to eq('Term: Minecraft (20 hits)')
+    end
+
+    it 'return nil if empty' do
+      expect(helper.format_top_ten_information(nil)).to be_nil
+    end
+  end
+end

spec/rails_helper.rb

@@ -0,0 +1,72 @@
+# 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 }
+
+# Ensures that the test database schema matches the current schema file.
+# If there are pending migrations it will invoke `db:test:prepare` to
+# recreate the test database by loading the schema.
+# 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 uses metadata to mix in different behaviours to your tests,
+  # for example enabling you to call `get` and `post` in request specs. e.g.:
+  #
+  #     RSpec.describe UsersController, type: :request do
+  #       # ...
+  #     end
+  #
+  # The different available types are documented in the features, such as in
+  # https://rspec.info/features/8-0/rspec-rails
+  #
+  # You can also this infer these behaviours automatically by location, e.g.
+  # /spec/models would pull in the same behaviour as `type: :model` but this
+  # behaviour is considered legacy and will be removed in a future version.
+  #
+  # To enable this behaviour uncomment the line below.
+  # 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

spec/request/search_queries_controller_spec.rb

@@ -0,0 +1,49 @@
+require 'rails_helper'
+
+RSpec.describe SearchQueriesController, type: :request do
+  describe 'POST /search_queries' do
+    let!(:article) { Article.create!(title: "Brazil") }
+
+    context 'with turbo_stream in post request' do
+      context 'with no term in params' do
+        it "grant the response there's turbo in response" do
+          post search_queries_path, params: { search_query: { term: "" } }, as: :turbo_stream
+
+          expect(response).to have_http_status(:ok)
+          expect(response.body).to include("turbo-stream")
+        end
+      end
+
+      context 'with a term with the same name with article title' do
+        it "grant the response there's turbo in response and save the search" do
+          expect { post search_queries_path, params: { search_query: { term: "Brazil" } }, as: :turbo_stream }.to change(SearchQuery, :count).by(1)
+        
+          expect(response.body).to include("last_queries")
+          expect(response.body).to include("sub_menu")
+          expect(response.body).to include("turbo-stream")
+        end
+      end
+
+      context 'with a term different from article' do
+        it "grant the response there's turbo in response and save the search" do
+          post search_queries_path, params: { search_query: { term: "Space" } }, as: :turbo_stream
+        
+          expect(response.body).to include("last_queries")
+          expect(response.body).to include("turbo-stream")
+          expect(response.body).to include("sub_menu")
+        end
+      end
+    end
+
+    # context 'with no turbo_stream in post request' do
+    #   context 'with no term in params' do
+    #     it "grant there's no turbo in response" do
+    #       post search_queries_path, params: { search_query: { term: "" } }
+
+    #       expect(response).to_not have_http_status(:ok)
+    #       expect(response.body).to_not include("turbo-stream")
+    #     end
+    #   end
+    # end
+  end
+end

spec/spec_helper.rb

@@ -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