kokishin 0.1.0

data/kokishin.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kokishin/version'
+
+Gem::Specification.new do |spec|
+  spec.authors       = %w[ bm5k ]
+  spec.bindir        = 'exe'
+  spec.description   = 'A single home for various custom RSpec matchers.'
+  spec.email         = %w[ 226882-BM5k@users.noreply.gitlab.com ]
+  spec.homepage      = 'https://gitlab.com/devfu/kokishin'
+  spec.license       = 'MIT'
+  spec.name          = 'kokishin'
+  spec.require_paths = %w[ lib ]
+  spec.summary       = 'RSpec matchers'
+  spec.version       = Kokishin::VERSION
+
+  spec.metadata['homepage_uri']          = spec.homepage
+  spec.metadata['rubygems_mfa_required'] = 'true'
+  spec.metadata['source_code_uri']       = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+
+  spec.add_dependency 'rspec-expectations'
+end

data/lib/kokishin/extensions/hash_diff.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Kokishin
+  module HashDiff
+
+    refine Hash do
+      # Stolen from Rails 4.0.5 since this has been removed!
+      #
+      # Returns a hash that represents the difference between two hashes.
+      #
+      #   {1 => 2}.diff(1 => 2)         # => {}
+      #   {1 => 2}.diff(1 => 3)         # => {1 => 2}
+      #   {}.diff(1 => 2)               # => {1 => 2}
+      #   {1 => 2, 3 => 4}.diff(1 => 2) # => {3 => 4}
+      def diff other
+        dup.delete_if { |k, v| other[k] == v }.merge!(other.dup.delete_if { |k, _v| key?(k) })
+      end
+    end
+
+  end
+end

data/lib/kokishin/matchers/association_matcher.rb

@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+require 'kokishin/extensions/hash_diff'
+
+using Kokishin::HashDiff
+
+RSpec::Matchers.define :belong_to do |kind|
+  description do
+    "belong_to #{ kind.inspect }"
+  end
+
+  failure_message do
+    msg = "Expected #{ described_class } to belong_to #{ kind.inspect }"
+    msg << "\n column #{ key.inspect } does not exist in #{ described_class }" if associated? && !has_column?
+    msg
+  end
+
+  failure_message_when_negated do
+    "Expected #{ described_class } not to belong_to #{ kind.inspect }"
+  end
+
+  def association
+    gem_version = Gem::Version.new ActiveRecord::VERSION::STRING
+
+    key = if gem_version >= Gem::Version.new('4.2.0')
+            expected.to_s
+          else
+            expected
+          end
+
+    actual.class.reflections[key]
+  end
+
+  def associated?
+    association && association.macro == :belongs_to
+  end
+
+  def key
+    @key ||= association.foreign_key
+  end
+
+  def has_column?
+    actual.class.column_names.include? key
+  end
+
+  match do |_actual|
+    associated? && has_column?
+  end
+end
+
+RSpec::Matchers.define :have_many do |kind, expected_options|
+  description do
+    msg = "have_many #{ kind.inspect }"
+    msg << ", #{ @expected_options.map { |k, v| ":#{ k } => #{ v }" }.join ',' }" if @expected_options.present?
+
+    @expected_options = nil # for some reason this appears to be cached between runs?
+
+    msg
+  end
+
+  failure_message do
+    "Expected #{ described_class } to have_many #{ kind.inspect } #{ diff }"
+  end
+
+  failure_message_when_negated do
+    "Expected #{ described_class } not to have_many #{ kind.inspect } #{ diff }"
+  end
+
+  def expected_options
+    @expected_options || {}
+  end
+
+  def association
+    @association ||= actual.class.reflect_on_association [ *expected ].first
+  end
+
+  def association_options
+    @association_options ||= association.options.reject { |k, v| k == :extend and v == [] } rescue {}
+  end
+
+  def diff?
+    # if association_options is empty and @expected_options is not, there is a problem
+    # if @expected_options is empty and association_options is not, there is a problem
+    # if neither is empty diff them, if there's a diff, there is a problem
+
+    return true if expected_options.present? ^ association_options.present?
+    return true if association_options.diff(expected_options).present?
+
+    false
+  end
+
+  def diff
+    return '' unless diff?
+
+    <<-MSG
+      \n expected options: #{ expected_options.inspect }
+      \n actual options: #{ association_options.inspect }
+    MSG
+  end
+
+  match do |_actual|
+    @expected_options = expected_options
+    association.try(:macro) == :has_many and not diff?
+  end
+end
+
+RSpec::Matchers.define :have_one do |kind, expected_options|
+  description do
+    msg = "have_many #{ kind.inspect }"
+    msg << ", #{ @expected_options.map { |k, v| ":#{ k } => #{ v }" }.join ',' }" if @expected_options.present?
+
+    @expected_options = nil # for some reason this appears to be cached between runs?
+
+    msg
+  end
+
+  failure_message do
+    "Expected #{ described_class } to have_many #{ kind.inspect } #{ diff }"
+  end
+
+  failure_message_when_negated do
+    "Expected #{ described_class } not to have_many #{ kind.inspect } #{ diff }"
+  end
+
+  def expected_options
+    @expected_options || {}
+  end
+
+  def association
+    @association ||= actual.class.reflect_on_association [ *expected ].first
+  end
+
+  def association_options
+    @association_options ||= association.options.reject { |k, v| k == :extend and v == [] } rescue {}
+  end
+
+  def diff?
+    # if association_options is empty and @expected_options is not, there is a problem
+    # if @expected_options is empty and association_options is not, there is a problem
+    # if neither is empty diff them, if there's a diff, there is a problem
+    return true if expected_options.present? ^ association_options.present?
+    return true if association_options.diff(expected_options).present?
+
+    false
+  end
+
+  def diff
+    return '' unless diff?
+
+    <<-MSG
+      \n expected options: #{ expected_options.inspect }
+      \n actual options: #{ association_options.inspect }
+    MSG
+  end
+
+  match do |_actual|
+    @expected_options = expected_options
+    association.try(:macro) == :has_one and not diff?
+  end
+end

data/lib/kokishin/matchers/method_matcher.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'rspec/expectations'
+
+RSpec::Matchers.define :have_method do |method_name, include_all = false|
+  match do |actual|
+    @actual      = actual
+    @include_all = include_all
+    @method_name = method_name
+
+    if @alias_name
+      responds_to_method? && responds_to_alias? && source_locations_match?
+    else
+      responds_to_method?
+    end
+  end
+
+  chain :with_alias do |alias_name|
+    @alias_name = alias_name
+  end
+
+  description do
+    if @alias_name
+      "have method ##{ @method_name } with alias ##{ @alias_name }"
+    else
+      "have method ##{ @method_name }"
+    end
+  end
+
+  failure_message do
+    "should have method ##{ @method_name }, but does not."
+  end
+
+  failure_message_when_negated do
+    "should not have method ##{ @method_name }, but does."
+  end
+
+  def responds_to_alias?
+    subject.respond_to? @alias_name, @include_all
+  end
+
+  def responds_to_method?
+    subject.respond_to? @method_name, @include_all
+  end
+
+  def source_locations_match?
+    location_of(@method_name) == location_of(@alias_name)
+  end
+
+  def location_of name
+    @actual.method(name).source_location
+  end
+end

data/lib/kokishin/matchers/validate_matcher.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require 'rspec/expectations'
+
+RSpec::Matchers.define :validate do |_expected|
+  chain(:of) { |attr| @attribute = attr }
+
+  chain(:with) do |*opts|
+    @options = opts.extract_options!
+    @options = opts if @options.empty?
+  end
+
+  match do |_actual|
+    if @attribute
+      validator.present? && (@options ? validator.options.should =~ @options : true)
+    else
+      callback.present? && (@options ? check_callback_options : true)
+    end
+  end
+
+  match_when_negated do |_actual|
+    if @attribute
+      raise "Negating a matcher with options doesn't really make sense!" if @options
+
+      validator.should be_nil
+    else
+      callback.should be_nil
+    end
+  end
+
+  def callback
+    actual.class._validate_callbacks.detect { |c| c.filter == expected }
+  end
+
+  def check_callback_options
+    opts = parse_callback_options
+
+    if @options.is_a? Hash
+      raise 'Cannot expect custom procs' if @options.values.any? { |v| v.is_a? Proc }
+
+      @options.each { |k, _| opts[k].should =~ Array(@options[k]) }
+    else
+      opts.keys.should =~ @options
+    end
+  end
+
+  def parse_callback_options
+    gem_version = Gem::Version.new ActiveModel::VERSION::STRING
+
+    options = if (Gem::Version.new('4.0.0')...Gem::Version.new('4.1.0')).cover?(gem_version)
+                parse_callback_options4
+              else
+                parse_callback_options_default
+              end
+
+    options.reject { |_, v| v.empty? }
+  end
+
+  def parse_callback_options_default
+    ifs      = callback.instance_variable_get '@if'
+    unlesses = callback.instance_variable_get '@unless'
+
+    if ifs.first.is_a?(Proc)
+      proc_binding = ifs.first.binding
+      if proc_binding.local_variables.include? :context # rails 7.1.0+
+        ons = proc_binding.local_variable_get :context
+        ifs = ifs[1..-1]
+      elsif proc_binding.local_variables.include? :options
+        ons = proc_binding.local_variable_get(:options)[:on]
+        ifs = ifs[1..-1]
+      end
+    end
+
+    { if: ifs, on: Array(ons), unless: Array(unlesses) }
+  end
+
+  def parse_callback_options4
+    ifs      = [ *callback.options[:if] ]
+    ons      = [ *callback.options[:on] ]
+    unlesses = [ *callback.options[:unless] ]
+
+    ifs = ifs[1..-1] if ons.any?
+
+    { if: ifs, on: ons, unless: unlesses }
+  end
+
+  def validator
+    actual.class.validators_on(@attribute).detect { |v| v.kind == expected }
+  end
+end

data/lib/kokishin/should.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# Should syntax is the best syntax.
+require 'rspec/matchers'
+
+module RSpec
+
+  configure do |config|
+    config.expect_with(:rspec) { |spec| spec.syntax = :should }
+    config.mock_with(:rspec)   { |spec| spec.syntax = :should }
+  end
+
+  module Matchers
+
+    # Force generated description to use should syntax
+    def self.generated_description
+      return nil if last_expectation_handler.nil?
+
+      "should #{ last_description }"
+    end
+
+  end
+
+end

data/lib/kokishin/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Kokishin
+
+  VERSION = '0.1.0'
+
+end

data/lib/kokishin.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require_relative 'kokishin/version'
+
+module Kokishin
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: kokishin
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- bm5k
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-10-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A single home for various custom RSpec matchers.
+email:
+- 226882-BM5k@users.noreply.gitlab.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".ci/Gemfile.rails_4.0.0"
+- ".ci/Gemfile.rails_4.0.0.lock"
+- ".ci/Gemfile.rails_4.1.0"
+- ".ci/Gemfile.rails_4.1.0.lock"
+- ".ci/Gemfile.rails_4.2.0"
+- ".ci/Gemfile.rails_4.2.0.lock"
+- ".ci/Gemfile.rails_5.0.0"
+- ".ci/Gemfile.rails_5.0.0.lock"
+- ".ci/Gemfile.rails_5.1.0"
+- ".ci/Gemfile.rails_5.1.0.lock"
+- ".ci/Gemfile.rails_5.2.0"
+- ".ci/Gemfile.rails_5.2.0.lock"
+- ".ci/Gemfile.rails_6.0.0"
+- ".ci/Gemfile.rails_6.0.0.lock"
+- ".ci/Gemfile.rails_6.1.0"
+- ".ci/Gemfile.rails_6.1.0.lock"
+- ".ci/Gemfile.rails_7.0.0"
+- ".ci/Gemfile.rails_7.0.0.lock"
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- kokishin.gemspec
+- lib/kokishin.rb
+- lib/kokishin/extensions/hash_diff.rb
+- lib/kokishin/matchers/association_matcher.rb
+- lib/kokishin/matchers/method_matcher.rb
+- lib/kokishin/matchers/validate_matcher.rb
+- lib/kokishin/should.rb
+- lib/kokishin/version.rb
+homepage: https://gitlab.com/devfu/kokishin
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://gitlab.com/devfu/kokishin
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://gitlab.com/devfu/kokishin
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: RSpec matchers
+test_files: []