rspice 0.2.0 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c5e223871fe2fa4953b4780ccf5580b0c138d236d049996c703c3f5b7c17e7b
-  data.tar.gz: 7b0a7838b6c0615ef65807cb95272863456f62dc0b31c8aae23b22641ceafd29
+  metadata.gz: aa2eccc7a2ee562c1fccf79425a722e1dcbdd148c5e16e4c57cbf7d764b7b4f8
+  data.tar.gz: b0202df71dc3994f57f68898c51c99fb3c0ccd8f7a3098ece21d1014fc3b222f
 SHA512:
-  metadata.gz: 2c11c725f520566ce3ce97b117c25180bd9628d034028f1ec4be08dbef07177c5e30b3b2648625225425b8d58e25cce286ed169ece4c3903bf39dfd6fe30d474
-  data.tar.gz: 6dcaba676ce166e68112722597612aad775a6184fd76989a60ef68157894e3645a9274f5199fbdfbd99de9276e05bbe520c6e9aa0ac314c6807369b9e488236c
+  metadata.gz: 9e13f6c01268d681cdaabf6537b56924c77881521737ee3e74835f73b7f9d7462798fcfab9ba62752018b6311064bbc67ecc6d5c01a2bb7d24e677117de4727d
+  data.tar.gz: ae6894bc99e52ca53ad3f9094977b405c127c57a335d0e0d92b6c0f7e31b354e76822fddc087c551860632442a578c21473fdfded29d29a283a2ca0f24007467

data/README.md

@@ -1,5 +1,6 @@
 # Rspice
 
+[![Gem Version](https://badge.fury.io/rb/rspice.svg)](https://badge.fury.io/rb/rspice)
 [![Build Status](https://semaphoreci.com/api/v1/freshly/spicerack/branches/master/badge.svg)](https://semaphoreci.com/freshly/spicerack)
 [![Maintainability](https://api.codeclimate.com/v1/badges/7e089c2617c530a85b17/maintainability)](https://codeclimate.com/github/Freshly/spicerack/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/7e089c2617c530a85b17/test_coverage)](https://codeclimate.com/github/Freshly/spicerack/test_coverage)

data/lib/rspice.rb

@@ -1,7 +1,12 @@
 # frozen_string_literal: true
 
+require "rspec"
+require "faker"
+
 require "rspice/version"
 
-module Rspice
-  # Your code goes here...
-end
+require "rspice/custom_matchers"
+require "rspice/shared_context"
+require "rspice/shared_examples"
+
+module Rspice; end

data/lib/rspice/custom_matchers.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require "rspice/custom_matchers/alias_method"
+require "rspice/custom_matchers/extend_module"
+require "rspice/custom_matchers/include_module"
+require "rspice/custom_matchers/inherit_from"

data/lib/rspice/custom_matchers/alias_method.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# RSpec matcher to spec inheritance.
+#
+# Usage:
+#
+# RSpec.describe User, type: :model do
+#   subject { described_class.new }
+#
+#   it { is_expected.to alias_method :alias_name, :target_name }
+# end
+
+RSpec::Matchers.define :alias_method do |alias_name, target_name|
+  match do |instance|
+    instance.method(alias_name) == instance.method(target_name)
+  end
+
+  description do
+    "aliases #{target_name} as #{alias_name}"
+  end
+
+  failure_message do |instance|
+    "expected #{instance.class.name}##{alias_name} to be an alias of #{target_name}"
+  end
+
+  failure_message_when_negated do |instance|
+    "expected #{instance.class.name}##{alias_name} to not be an alias of #{target_name}"
+  end
+end

data/lib/rspice/custom_matchers/extend_module.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# RSpec matcher for extend module.
+#
+# Usage:
+#
+# RSpec.describe User, type: :model do
+#   subject { described_class }
+#
+#   it { is_expected.to extend_module Authenticatable }
+# end
+
+RSpec::Matchers.define :extend_module do |module_class|
+  match do
+    test_subject.singleton_class.included_modules.include? module_class
+  end
+
+  description do
+    "extended the module #{module_class}"
+  end
+
+  failure_message do |described_class|
+    "expected #{described_class} to extend module #{module_class}"
+  end
+
+  failure_message_when_negated do |described_class|
+    "expected #{described_class} not to extend module #{module_class}"
+  end
+
+  def test_subject
+    subject.is_a?(Class) ? subject : subject.class
+  end
+end

data/lib/rspice/custom_matchers/include_module.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# RSpec matcher for include module.
+#
+# Usage:
+#
+# RSpec.describe User, type: :model do
+#   subject { described_class }
+#
+#   it { is_expected.to include_module ApplicationRecord }
+# end
+
+RSpec::Matchers.define :include_module do |module_class|
+  match do
+    test_subject.included_modules.include? module_class
+  end
+
+  description do
+    "included the module #{module_class}"
+  end
+
+  failure_message do |described_class|
+    "expected #{described_class} to include module #{module_class}"
+  end
+
+  failure_message_when_negated do |described_class|
+    "expected #{described_class} not to include module #{module_class}"
+  end
+
+  def test_subject
+    subject.is_a?(Class) ? subject : subject.class
+  end
+end

data/lib/rspice/custom_matchers/inherit_from.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# RSpec matcher to spec inheritance.
+#
+# Usage:
+#
+# RSpec.describe User, type: :model do
+#   subject { described_class }
+#
+#   it { is_expected.to inherit_from ApplicationRecord }
+# end
+
+RSpec::Matchers.define :inherit_from do |superclass|
+  match do
+    described_class.ancestors.include? superclass
+  end
+
+  description do
+    "inherit from #{superclass}"
+  end
+
+  failure_message do
+    "expected #{described_class.name} to inherit from #{superclass}"
+  end
+
+  failure_message_when_negated do
+    "expected #{described_class.name} not to inherit from #{superclass}"
+  end
+end

data/lib/rspice/shared_context.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "rspice/shared_context/with_an_example_descendant_class"

data/lib/rspice/shared_context/with_an_example_descendant_class.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+RSpec.shared_context "with an example descendant class" do
+  let(:example_class) { Class.new(described_class) }
+  let(:example_class_name) { Faker::Internet.domain_word.capitalize }
+
+  before { stub_const(example_class_name, example_class) }
+end

data/lib/rspice/shared_examples.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "rspice/shared_examples/a_class_pass_method"

data/lib/rspice/shared_examples/a_class_pass_method.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# TODO: Jank - this should use Method#parameters, not Method#arity
+
+RSpec.shared_examples_for "a class pass method" do |method|
+  subject do
+    if takes_options?
+      test_class.public_send(method, *arguments, **options)
+    else
+      test_class.public_send(method, *arguments)
+    end
+  end
+
+  let(:test_class) { described_class }
+  let(:initialize_arity) { test_class.instance_method(:initialize).arity }
+  let(:takes_options?) { (initialize_arity < 0) }
+  let(:argument_arity) { takes_options? ? (initialize_arity.abs - 1) : initialize_arity }
+
+  let(:arguments) do
+    Array.new(argument_arity) { double }
+  end
+  let(:options) { takes_options? ? Hash[*Faker::Lorem.words(2 * rand(1..2))].symbolize_keys : nil }
+  let(:instance) { instance_double(test_class) }
+  let(:output) { double }
+
+  before do
+    allow(instance).to receive(method).and_return(output)
+    if takes_options?
+      allow(test_class).to receive(:new).with(*arguments, **options).and_return(instance)
+    else
+      allow(test_class).to receive(:new).with(*arguments).and_return(instance)
+    end
+  end
+
+  it { is_expected.to eq output }
+end

data/lib/rspice/version.rb

@@ -2,5 +2,5 @@
 
 module Rspice
   # This constant is managed by spicerack
-  VERSION = "0.2.0"
+  VERSION = "0.2.5"
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: rspice
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.5
 platform: ruby
 authors:
 - Eric Garside
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-01 00:00:00.000000000 Z
-dependencies: []
+date: 2018-10-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
 description: A dash of spice to make your RSpec tests very nice.
 email:
 - garside@gmail.com
@@ -20,6 +48,15 @@ files:
 - LICENSE.txt
 - README.md
 - lib/rspice.rb
+- lib/rspice/custom_matchers.rb
+- lib/rspice/custom_matchers/alias_method.rb
+- lib/rspice/custom_matchers/extend_module.rb
+- lib/rspice/custom_matchers/include_module.rb
+- lib/rspice/custom_matchers/inherit_from.rb
+- lib/rspice/shared_context.rb
+- lib/rspice/shared_context/with_an_example_descendant_class.rb
+- lib/rspice/shared_examples.rb
+- lib/rspice/shared_examples/a_class_pass_method.rb
 - lib/rspice/version.rb
 homepage: https://www.freshly.com
 licenses: