stitches 4.1.0RC2 → 4.2.0.RC1

data/spec/api_version_constraint_middleware_spec.rb

@@ -0,0 +1,58 @@
+require 'rails_helper'
+require 'securerandom'
+
+RSpec.describe "/api/hellos", type: :request do
+  let(:version) { 8  }
+  let(:accept_header) { "application/json; version=#{version}" }
+  let(:headers) {
+    h = {}
+    h["Accept"] = accept_header if accept_header
+    h
+  }
+
+  before do
+    Stitches.configuration.reset_to_defaults!
+    Stitches.configuration.allowlist_regexp = /.*hello.*/
+    Stitches::ApiClientAccessWrapper.clear_api_cache
+  end
+
+  context "when correctly configured for version 1" do
+    let(:version) { 1 }
+
+    it "executes the correct controller" do
+      get "/api/hellos", headers: headers
+
+      expect(response.body).to include "Hello"
+    end
+  end
+
+  context "when correctly configured for version 2" do
+    let(:version) { 2 }
+
+    it "executes the correct controller" do
+      get "/api/hellos", headers: headers
+
+      expect(response.body).to include "Greetings"
+    end
+  end
+
+  context "when correctly configured for a version that does not exist" do
+    let(:version) { 6 }
+
+    it "fails to map to a controller" do
+      expect {
+        get "/api/hellos", headers: headers
+      }.to raise_error(ActionController::RoutingError)
+    end
+  end
+
+  context "when accept header is missing version" do
+    let(:accept_header) { "application/json" }
+
+    it "fails to map to a controller" do
+      expect {
+        get "/api/hellos", headers: headers
+      }.to raise_error(ActionController::RoutingError)
+    end
+  end
+end

data/spec/configuration_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper.rb'
+require 'rails_helper'
 
 describe Stitches::Configuration do
   before do

data/spec/deprecation_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper.rb'
+require 'rails_helper'
 
 describe Stitches::Deprecation do
   let(:response) {

data/spec/error_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require 'rails_helper'
 
 module Stitches
   describe Error do

data/spec/errors_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper.rb'
+require 'rails_helper'
 
 class MyFakeError < StandardError
 end
@@ -10,9 +10,9 @@ class FakePersonHolder
   validates_presence_of :name
 
   def valid?
-    # doing this because we can't use validates_associated on a non-AR object, and 
+    # doing this because we can't use validates_associated on a non-AR object, and
     # our logic doesn't depend on validates_associated, per se
-    super.tap { 
+    super.tap {
       unless person.valid?
         errors.add(:person,"is not valid")
       end

data/spec/fake_app/.rspec

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

data/spec/fake_app/.ruby-version

@@ -0,0 +1 @@
+ruby-2.7.3

data/spec/fake_app/Gemfile

@@ -0,0 +1,53 @@
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+ruby '2.7.3'
+
+# Bundle edge Rails instead: gem 'rails', github: 'rails/rails', branch: 'main'
+gem 'rails', '~> 6.1.4'
+# Use sqlite3 as the database for Active Record
+gem 'sqlite3', '~> 1.4'
+# Use Puma as the app server
+gem 'puma', '~> 5.0'
+# Use SCSS for stylesheets
+gem 'sass-rails', '>= 6'
+# Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
+gem 'jbuilder', '~> 2.7'
+# Use Active Model has_secure_password
+# gem 'bcrypt', '~> 3.1.7'
+
+# Use Active Storage variant
+# gem 'image_processing', '~> 1.2'
+
+gem 'stitches'
+
+group :development, :test do
+  # Call 'byebug' anywhere in the code to stop execution and get a debugger console
+  # gem 'byebug', platforms: [:mri, :mingw, :x64_mingw]
+end
+
+group :development do
+  # Access an interactive console on exception pages or by calling 'console' anywhere in the code.
+  gem 'web-console', '>= 4.1.0'
+  # Display performance information such as SQL time and flame graphs for each request in your browser.
+  # Can be configured to work on production as well see: https://github.com/MiniProfiler/rack-mini-profiler/blob/master/README.md
+  gem 'rack-mini-profiler', '~> 2.0'
+end
+
+group :test do
+  # Adds support for Capybara system testing and selenium driver
+  gem 'capybara', '>= 3.26'
+  gem 'selenium-webdriver'
+  # Easy installation and use of web drivers to run system tests with browsers
+  gem 'webdrivers'
+end
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]
+gem 'apitome'
+
+group :development, :test do
+  gem 'rspec'
+  gem 'rspec-rails'
+  gem 'rspec_api_documentation'
+end

data/spec/fake_app/README.md

@@ -0,0 +1,24 @@
+# README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...

data/spec/fake_app/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative "config/application"
+
+Rails.application.load_tasks

data/spec/fake_app/app/assets/config/manifest.js

@@ -0,0 +1,2 @@
+//= link_tree ../images
+//= link_directory ../stylesheets .css

data/spec/fake_app/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, or any plugin's
+ * vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/fake_app/app/controllers/api.rb

@@ -0,0 +1,2 @@
+module Api
+end

data/spec/fake_app/app/controllers/api/api_controller.rb

@@ -0,0 +1,31 @@
+class Api::ApiController < ActionController::API
+  include Stitches::Deprecation
+  #
+  # The order of the rescue_from blocks is important - ActiveRecord::RecordNotFound must come after StandardError,
+  # otherwise ActiveRecord::RecordNotFound exceptions will get rescued in the StandardError block.
+  # See the documentation for rescue_from for further explanation:
+  # https://apidock.com/rails/ActiveSupport/Rescuable/ClassMethods/rescue_from
+  # Specifically, this part: "Handlers are inherited. They are searched from right to left, from bottom to top, and up
+  # the hierarchy."
+  #
+  rescue_from StandardError do |exception|
+    render json: { errors: Stitches::Errors.from_exception(exception) }, status: :internal_server_error
+  end
+
+  rescue_from ActiveRecord::RecordNotFound do |exception|
+    render json: { errors: Stitches::Errors.from_exception(exception) }, status: :not_found
+  end
+
+  def current_user
+    api_client
+  end
+
+protected
+
+  def api_client
+    @api_client ||= request.env[Stitches.configuration.env_var_to_hold_api_client]
+    # Use this if you want to look up the ApiClient instead of using the one placed into the env
+    # @api_client ||= ApiClient.find(request.env[Stitches.configuration.env_var_to_hold_api_client_primary_key])
+  end
+
+end

data/spec/fake_app/app/controllers/api/v1.rb

@@ -0,0 +1,2 @@
+module Api::V1
+end

data/spec/fake_app/app/controllers/api/v1/hellos_controller.rb

@@ -0,0 +1,7 @@
+class Api::V1::HellosController < Api::ApiController
+  def show
+    name = request.env[Stitches.configuration.env_var_to_hold_api_client]&.name || "NameNotFound"
+    id =  request.env[Stitches.configuration.env_var_to_hold_api_client_primary_key] || "IdNotFound"
+    render json: { hello: "Hello #{name}, your id is #{id}" }
+  end
+end

data/spec/fake_app/app/controllers/api/v1/pings_controller.rb

@@ -0,0 +1,16 @@
+class Api::V1::PingsController < Api::ApiController
+
+  def create
+    if ping_params[:error]
+      render json: { errors: Stitches::Errors.new([ Stitches::Error.new(code: "test", message: ping_params[:error]) ])} , status: 422
+    else
+      render json: { ping: { status: "ok" } }, status: (ping_params[:status] || "201").to_i
+    end
+  end
+
+private
+
+  def ping_params
+    params.permit(:error, :status)
+  end
+end

data/spec/fake_app/app/controllers/api/v2.rb

@@ -0,0 +1,2 @@
+module Api::V2
+end

data/spec/fake_app/app/controllers/api/v2/hellos_controller.rb

@@ -0,0 +1,7 @@
+class Api::V2::HellosController < Api::ApiController
+  def show
+    name = request.env[Stitches.configuration.env_var_to_hold_api_client]&.name || "NameNotFound"
+    id =  request.env[Stitches.configuration.env_var_to_hold_api_client_primary_key] || "IdNotFound"
+    render json: { hello: "Greetings #{name}, your id is #{id}" }
+  end
+end

data/spec/fake_app/app/controllers/api/v2/pings_controller.rb

@@ -0,0 +1,16 @@
+class Api::V2::PingsController < Api::ApiController
+
+  def create
+    if ping_params[:error]
+      render json: { errors: Stitches::Errors.new([ Stitches::Error.new(code: "test", message: ping_params[:error]) ])} , status: 422
+    else
+      render json: { ping: { status_v2: "ok" } }, status: (ping_params[:status] || "201").to_i
+    end
+  end
+
+private
+
+  def ping_params
+    params.permit(:error, :status)
+  end
+end

data/spec/fake_app/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

data/spec/fake_app/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/fake_app/app/models/api_client.rb

@@ -0,0 +1,2 @@
+class ApiClient < ActiveRecord::Base
+end

data/spec/fake_app/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/spec/fake_app/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../config/application', __dir__)
+require_relative "../config/boot"
+require "rails/commands"

data/spec/fake_app/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative "../config/boot"
+require "rake"
+Rake.application.run

data/spec/fake_app/bin/setup

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+require "fileutils"
+
+# path to your application root.
+APP_ROOT = File.expand_path('..', __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+FileUtils.chdir APP_ROOT do
+  # This script is a way to set up or update your development environment automatically.
+  # This script is idempotent, so that you can run it at any time and get an expectable outcome.
+  # Add necessary setup steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?('config/database.yml')
+  #   FileUtils.cp 'config/database.yml.sample', 'config/database.yml'
+  # end
+
+  puts "\n== Preparing database =="
+  system! 'bin/rails db:prepare'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/spec/fake_app/config.ru

@@ -0,0 +1,6 @@
+# This file is used by Rack-based servers to start the application.
+
+require_relative "config/environment"
+
+run Rails.application
+Rails.application.load_server

data/spec/fake_app/config/application.rb

@@ -0,0 +1,35 @@
+require_relative "boot"
+
+require "rails"
+# Pick the frameworks you want:
+require "active_model/railtie"
+require "active_job/railtie"
+require "active_record/railtie"
+require "active_storage/engine"
+require "action_controller/railtie"
+# require "action_mailer/railtie"
+require "action_mailbox/engine"
+require "action_text/engine"
+require "action_view/railtie"
+# require "action_cable/engine"
+require "sprockets/railtie"
+require "rails/test_unit/railtie"
+
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(*Rails.groups)
+
+module FakeApp
+  class Application < Rails::Application
+    # Initialize configuration defaults for originally generated Rails version.
+    config.load_defaults 6.0
+
+    # Configuration for the application, engines, and railties goes here.
+    #
+    # These settings can be overridden in specific environments using the files
+    # in config/environments, which are processed later.
+    #
+    # config.time_zone = "Central Time (US & Canada)"
+    # config.eager_load_paths << Rails.root.join("extras")
+  end
+end

data/spec/fake_app/config/boot.rb

@@ -0,0 +1,3 @@
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+
+require "bundler/setup" # Set up gems listed in the Gemfile.

data/spec/fake_app/config/credentials.yml.enc

@@ -0,0 +1 @@
+1V1LD3DAIWjwHRquoRQBqr5cV/J7VMKuSfze36/aKJmPKzv5G6vQnrSpybKvTMY1Q29EEL/T3uGjj1wNuCAjh6eGWXXDDLVH85GlXw9qpHulWv36Dnr9xL9OQNvMRCKOrUuR3CJm4A4Fw9qC7zPTSHN2WhcxXNr1wVW1shJEWLW1eUzwRS3c3njC8KK3BCqktQK0MZhM0CryIxbZsi57VY8gZp0FegdOJGw2mASdYj2jGzEdNuyRMvgCOT8sXwgmMC3QV0v95w/M1AS2OqHsO7ndHfymBh8+qmEbHo74+w3aEkZ0Ct+mp49ROH2ZrZFRw9BWZ2T8gamLad3whIOzVGA4XI15hlcJGV9GWdbnHkLCHv9Rj+0Av09asKfJMnWW32yPpO79w88BAEd8I2ZhZNGcFLpYisQljXQA--HOld8JMRchEcQETs--oo5IsQMkFW/wZJKDvyInew==

data/spec/fake_app/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite. Versions 3.8.0 and up are supported.
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3