ultra-fast-box 0.0.1

data/shoulda-matchers-8.0.1/lib/shoulda/matchers/active_record/have_db_column_matcher.rb

@@ -0,0 +1,366 @@
+module Shoulda
+  module Matchers
+    module ActiveRecord
+      # The `have_db_column` matcher tests that the table that backs your model
+      # has a specific column.
+      #
+      #     class CreatePhones < ActiveRecord::Migration
+      #       def change
+      #         create_table :phones do |t|
+      #           t.string :supported_ios_version
+      #         end
+      #       end
+      #     end
+      #
+      #     # RSpec
+      #     RSpec.describe Phone, type: :model do
+      #       it { should have_db_column(:supported_ios_version) }
+      #     end
+      #
+      #     # Minitest (Shoulda)
+      #     class PhoneTest < ActiveSupport::TestCase
+      #       should have_db_column(:supported_ios_version)
+      #     end
+      #
+      # #### Qualifiers
+      #
+      # ##### of_type
+      #
+      # Use `of_type` to assert that a column is defined as a certain type.
+      #
+      #     class CreatePhones < ActiveRecord::Migration
+      #       def change
+      #         create_table :phones do |t|
+      #           t.decimal :camera_aperture
+      #         end
+      #       end
+      #     end
+      #
+      #     # RSpec
+      #     RSpec.describe Phone, type: :model do
+      #       it do
+      #         should have_db_column(:camera_aperture).of_type(:decimal)
+      #       end
+      #     end
+      #
+      #     # Minitest (Shoulda)
+      #     class PhoneTest < ActiveSupport::TestCase
+      #       should have_db_column(:camera_aperture).of_type(:decimal)
+      #     end
+      #
+      # ##### of_sql_type
+      #
+      # Use `of_sql_type` to assert that a column is defined as a certain sql_type.
+      #
+      #     class CreatePhones < ActiveRecord::Migration
+      #       def change
+      #         create_table :phones do |t|
+      #           t.string :camera_aperture, limit: 36
+      #         end
+      #       end
+      #     end
+      #
+      #     # RSpec
+      #     RSpec.describe Phone, type: :model do
+      #       it do
+      #         should have_db_column(:camera_aperture).of_sql_type('varchar(36)')
+      #       end
+      #     end
+      #
+      #     # Minitest (Shoulda)
+      #     class PhoneTest < ActiveSupport::TestCase
+      #       should have_db_column(:camera_aperture).of_sql_type('varchar(36)')
+      #     end
+      #
+      # ##### with_options
+      #
+      # Use `with_options` to assert that a column has been defined with
+      # certain options (`:precision`, `:limit`, `:default`, `:null`, `:scale`,
+      # `:primary` or `:array`).
+      #
+      #     class CreatePhones < ActiveRecord::Migration
+      #       def change
+      #         create_table :phones do |t|
+      #           t.decimal :camera_aperture, precision: 1, null: false
+      #         end
+      #       end
+      #     end
+      #
+      #     # RSpec
+      #     RSpec.describe Phone, type: :model do
+      #       it do
+      #         should have_db_column(:camera_aperture).
+      #           with_options(precision: 1, null: false)
+      #       end
+      #     end
+      #
+      #     # Minitest (Shoulda)
+      #     class PhoneTest < ActiveSupport::TestCase
+      #       should have_db_column(:camera_aperture).
+      #         with_options(precision: 1, null: false)
+      #     end
+      #
+      # @return [HaveDbColumnMatcher]
+      #
+      def have_db_column(column)
+        HaveDbColumnMatcher.new(column)
+      end
+
+      # @private
+      class HaveDbColumnMatcher
+        OPTIONS = %i(precision limit default null scale primary array).freeze
+
+        def initialize(column)
+          @column = column
+          @options = {}
+        end
+
+        def of_type(column_type)
+          @options[:column_type] = column_type
+          self
+        end
+
+        def of_sql_type(sql_column_type)
+          @options[:sql_column_type] = sql_column_type
+          self
+        end
+
+        def with_options(opts = {})
+          validate_options(opts)
+          OPTIONS.each do |attribute|
+            if opts.key?(attribute.to_sym)
+              @options[attribute.to_sym] = opts[attribute.to_sym]
+            end
+          end
+          self
+        end
+
+        def matches?(subject)
+          @subject = subject
+          column_exists? &&
+            correct_column_type? &&
+            correct_sql_column_type? &&
+            correct_precision? &&
+            correct_limit? &&
+            correct_default? &&
+            correct_null? &&
+            correct_scale? &&
+            correct_primary? &&
+            correct_array?
+        end
+
+        def failure_message
+          "Expected #{expectation} (#{@missing})"
+        end
+
+        def failure_message_when_negated
+          "Did not expect #{expectation}"
+        end
+
+        def description
+          desc = "have db column named #{@column}"
+          desc << " of type #{@options[:column_type]}" if @options.key?(:column_type)
+          desc << " of sql_type #{@options[:sql_column_type]}" if @options.key?(:sql_column_type)
+          desc << " of precision #{@options[:precision]}" if @options.key?(:precision)
+          desc << " of limit #{@options[:limit]}" if @options.key?(:limit)
+          desc << " of default #{@options[:default]}" if @options.key?(:default)
+          desc << " of null #{@options[:null]}" if @options.key?(:null)
+          desc << " of primary #{@options[:primary]}" if @options.key?(:primary)
+          desc << " of scale #{@options[:scale]}" if @options.key?(:scale)
+          desc
+        end
+
+        protected
+
+        def validate_options(opts)
+          invalid_options = opts.keys.map(&:to_sym) - OPTIONS
+          if invalid_options.any?
+            raise(
+              ArgumentError,
+              "Unknown option(s): #{invalid_options.map(&:inspect).join(', ')}",
+            )
+          end
+        end
+
+        def column_exists?
+          if model_class.column_names.include?(@column.to_s)
+            true
+          else
+            @missing =
+              "#{model_class} does not have a db column named #{@column}."
+            false
+          end
+        end
+
+        def correct_column_type?
+          return true unless @options.key?(:column_type)
+
+          if matched_column.type.to_s == @options[:column_type].to_s
+            true
+          else
+            @missing =
+              "#{model_class} has a db column named #{@column} " <<
+              "of type #{matched_column.type}, not #{@options[:column_type]}."
+            false
+          end
+        end
+
+        def correct_sql_column_type?
+          return true unless @options.key?(:sql_column_type)
+
+          if matched_column.sql_type.to_s == @options[:sql_column_type].to_s
+            true
+          else
+            @missing =
+              "#{model_class} has a db column named #{@column} " <<
+              "of sql type #{matched_column.sql_type}, not #{@options[:sql_column_type]}."
+            false
+          end
+        end
+
+        def correct_precision?
+          return true unless @options.key?(:precision)
+
+          if matched_column.precision.to_s == @options[:precision].to_s
+            true
+          else
+            @missing = "#{model_class} has a db column named #{@column} " <<
+                       "of precision #{matched_column.precision}, " <<
+                       "not #{@options[:precision]}."
+            false
+          end
+        end
+
+        def correct_limit?
+          return true unless @options.key?(:limit)
+
+          if matched_column.limit.to_s == @options[:limit].to_s
+            true
+          else
+            @missing = "#{model_class} has a db column named #{@column} " <<
+                       "of limit #{matched_column.limit}, " <<
+                       "not #{@options[:limit]}."
+            false
+          end
+        end
+
+        def correct_default?
+          return true unless @options.key?(:default)
+
+          if matched_column.type_cast_default.to_s == @options[:default].to_s
+            true
+          else
+            @missing = "#{model_class} has a db column named #{@column} " <<
+                       "of default #{matched_column.type_cast_default}, " <<
+                       "not #{@options[:default]}."
+            false
+          end
+        end
+
+        def correct_null?
+          return true unless @options.key?(:null)
+
+          if matched_column.null.to_s == @options[:null].to_s
+            true
+          else
+            @missing = "#{model_class} has a db column named #{@column} " <<
+                       "of null #{matched_column.null}, " <<
+                       "not #{@options[:null]}."
+            false
+          end
+        end
+
+        def correct_scale?
+          return true unless @options.key?(:scale)
+
+          if actual_scale.to_s == @options[:scale].to_s
+            true
+          else
+            @missing = "#{model_class} has a db column named #{@column} "
+            @missing << "of scale #{actual_scale}, not #{@options[:scale]}."
+            false
+          end
+        end
+
+        def correct_primary?
+          return true unless @options.key?(:primary)
+
+          if matched_column.primary? == @options[:primary]
+            true
+          else
+            @missing = "#{model_class} has a db column named #{@column} "
+            @missing <<
+              if @options[:primary]
+                'that is not primary, but should be'
+              else
+                'that is primary, but should not be'
+              end
+            false
+          end
+        end
+
+        def correct_array?
+          return true unless @options.key?(:array)
+
+          if matched_column.array? == @options[:array]
+            true
+          else
+            @missing = "#{model_class} has a db column named #{@column} "
+            @missing <<
+              if @options[:primary]
+                'that is not array, but should be'
+              else
+                'that is array, but should not be'
+              end
+            false
+          end
+        end
+
+        def matched_column
+          @_matched_column ||= begin
+            column = model_class.columns.detect do |each|
+              each.name == @column.to_s
+            end
+            DecoratedColumn.new(model_class, column)
+          end
+        end
+
+        def model_class
+          @subject.class
+        end
+
+        def actual_scale
+          matched_column.scale
+        end
+
+        def actual_primary?
+          model_class.primary_key == matched_column.name
+        end
+
+        def expectation
+          "#{model_class.name} to #{description}"
+        end
+
+        # @private
+        class DecoratedColumn < SimpleDelegator
+          def initialize(model, column)
+            @model = model
+            super(column)
+          end
+
+          def type_cast_default
+            model.column_defaults[name]
+          end
+
+          def primary?
+            model.primary_key == name
+          end
+
+          protected
+
+          attr_reader :model
+        end
+      end
+    end
+  end
+end

data/shoulda-matchers-8.0.1/lib/shoulda/matchers/active_record/have_db_index_matcher.rb

@@ -0,0 +1,287 @@
+module Shoulda
+  module Matchers
+    module ActiveRecord
+      # The `have_db_index` matcher tests that the table that backs your model
+      # has a specific index.
+      #
+      # You can specify one column:
+      #
+      #     class CreateBlogs < ActiveRecord::Migration
+      #       def change
+      #         create_table :blogs do |t|
+      #           t.integer :user_id
+      #         end
+      #
+      #         add_index :blogs, :user_id
+      #       end
+      #     end
+      #
+      #     # RSpec
+      #     RSpec.describe Blog, type: :model do
+      #       it { should have_db_index(:user_id) }
+      #     end
+      #
+      #     # Minitest (Shoulda)
+      #     class BlogTest < ActiveSupport::TestCase
+      #       should have_db_index(:user_id)
+      #     end
+      #
+      # Or you can specify a group of columns:
+      #
+      #     class CreateBlogs < ActiveRecord::Migration
+      #       def change
+      #         create_table :blogs do |t|
+      #           t.integer :user_id
+      #           t.string :name
+      #         end
+      #
+      #         add_index :blogs, :user_id, :name
+      #       end
+      #     end
+      #
+      #     # RSpec
+      #     RSpec.describe Blog, type: :model do
+      #       it { should have_db_index([:user_id, :name]) }
+      #     end
+      #
+      #     # Minitest (Shoulda)
+      #     class BlogTest < ActiveSupport::TestCase
+      #       should have_db_index([:user_id, :name])
+      #     end
+      #
+      # Finally, if you're using Rails 5 and PostgreSQL, you can also specify an
+      # expression:
+      #
+      #     class CreateLoggedErrors < ActiveRecord::Migration
+      #       def change
+      #         create_table :logged_errors do |t|
+      #           t.string :code
+      #           t.jsonb :content
+      #         end
+      #
+      #         add_index :logged_errors, 'lower(code)::text'
+      #       end
+      #     end
+      #
+      #     # RSpec
+      #     RSpec.describe LoggedError, type: :model do
+      #       it { should have_db_index('lower(code)::text') }
+      #     end
+      #
+      #     # Minitest (Shoulda)
+      #     class LoggedErrorTest < ActiveSupport::TestCase
+      #       should have_db_index('lower(code)::text')
+      #     end
+      #
+      # #### Qualifiers
+      #
+      # ##### unique
+      #
+      # Use `unique` to assert that the index is either unique or non-unique:
+      #
+      #     class CreateBlogs < ActiveRecord::Migration
+      #       def change
+      #         create_table :blogs do |t|
+      #           t.string :domain
+      #           t.integer :user_id
+      #         end
+      #
+      #         add_index :blogs, :domain, unique: true
+      #         add_index :blogs, :user_id
+      #       end
+      #     end
+      #
+      #     # RSpec
+      #     RSpec.describe Blog, type: :model do
+      #       it { should have_db_index(:name).unique }
+      #       it { should have_db_index(:name).unique(true) }   # if you want to be explicit
+      #       it { should have_db_index(:user_id).unique(false) }
+      #     end
+      #
+      #     # Minitest (Shoulda)
+      #     class BlogTest < ActiveSupport::TestCase
+      #       should have_db_index(:name).unique
+      #       should have_db_index(:name).unique(true)   # if you want to be explicit
+      #       should have_db_index(:user_id).unique(false)
+      #     end
+      #
+      # @return [HaveDbIndexMatcher]
+      #
+      def have_db_index(columns)
+        HaveDbIndexMatcher.new(columns)
+      end
+
+      # @private
+      class HaveDbIndexMatcher
+        def initialize(columns)
+          @expected_columns = normalize_columns_to_array(columns)
+          @qualifiers = {}
+        end
+
+        def unique(unique = true)
+          @qualifiers[:unique] = unique
+          self
+        end
+
+        def matches?(subject)
+          @subject = subject
+          index_exists? && correct_unique?
+        end
+
+        def failure_message
+          message =
+            "Expected #{described_table_name} to #{positive_expectation}"
+
+          message <<
+            if index_exists?
+              ". The index does exist, but #{reason}."
+            elsif reason
+              ", but #{reason}."
+            else
+              ', but it does not.'
+            end
+
+          Shoulda::Matchers.word_wrap(message)
+        end
+
+        def failure_message_when_negated
+          Shoulda::Matchers.word_wrap(
+            "Expected #{described_table_name} not to " +
+            "#{negative_expectation}, but it does.",
+          )
+        end
+
+        def description
+          String.new('have ').tap do |description|
+            description <<
+              if qualifiers.include?(:unique)
+                "#{Shoulda::Matchers::Util.a_or_an(index_type)} "
+              else
+                'an '
+              end
+
+            description << 'index on '
+
+            description << inspected_expected_columns
+          end
+        end
+
+        private
+
+        attr_reader :expected_columns, :qualifiers, :subject, :reason
+
+        def normalize_columns_to_array(columns)
+          Array.wrap(columns).map(&:to_s)
+        end
+
+        def index_exists?
+          !matched_index.nil?
+        end
+
+        def correct_unique?
+          if qualifiers.include?(:unique)
+            if qualifiers[:unique] && !matched_index.unique
+              @reason = 'it is not unique'
+              false
+            elsif !qualifiers[:unique] && matched_index.unique
+              @reason = 'it is unique'
+              false
+            else
+              true
+            end
+          else
+            true
+          end
+        end
+
+        def matched_index
+          @_matched_index ||=
+            if expected_columns.one?
+              sorted_indexes.detect do |index|
+                Array.wrap(index.columns) == expected_columns
+              end
+            else
+              sorted_indexes.detect do |index|
+                index.columns == expected_columns
+              end
+            end
+        end
+
+        def sorted_indexes
+          if qualifiers.include?(:unique)
+            # return indexes with unique matching the qualifier first
+            unsorted_indexes.sort_by do |index|
+              index.unique == qualifiers[:unique] ? 0 : 1
+            end
+          else
+            unsorted_indexes
+          end
+        end
+
+        def unsorted_indexes
+          model.connection.indexes(table_name)
+        end
+
+        def described_table_name
+          if model
+            "the #{table_name} table"
+          else
+            'a table'
+          end
+        end
+
+        def table_name
+          model.table_name
+        end
+
+        def positive_expectation
+          if index_exists?
+            expectation = "have an index on #{inspected_expected_columns}"
+
+            if qualifiers.include?(:unique)
+              expectation << " and for it to be #{index_type}"
+            end
+
+            expectation
+          else
+            description
+          end
+        end
+
+        def negative_expectation
+          description
+        end
+
+        def inspected_expected_columns
+          if formatted_expected_columns.one?
+            formatted_expected_columns.first.inspect
+          else
+            formatted_expected_columns.inspect
+          end
+        end
+
+        def index_type
+          if qualifiers[:unique]
+            'unique'
+          else
+            'non-unique'
+          end
+        end
+
+        def formatted_expected_columns
+          expected_columns.map do |column|
+            if column.match?(/^\w+$/)
+              column.to_sym
+            else
+              column
+            end
+          end
+        end
+
+        def model
+          subject&.class
+        end
+      end
+    end
+  end
+end