middlegem 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8e1dd451fcba2d15305534945c4d6fe88c7f6c9fb29c8e8059241503291432b
-  data.tar.gz: 61fcd25df93bb9902e6a85815ab6b63696c6c2f6d753cceeac4afa521143ca12
+  metadata.gz: 33925e2b8f3d95cb564a53b44788717d3068603dbc2a5107f0937819d6967e87
+  data.tar.gz: f3597bc2dfce25d28280dbeed6c61625af875879852b1a67301d2e18e2dd5603
 SHA512:
-  metadata.gz: 95319c1cc7be36e04290c0a30e3494834dea8b9aef142ca1c44582a80ba9037a9325efb7a764dff32c1483e591c62ca14794d07c4c810d29dcf171c6e40eb171
-  data.tar.gz: 5790037f20f4c2a7b88f894c74377bd1ca75031ebc87c4c3fc601e3d4b9de21436f11a5aeb7f28b908da0462ef8962d9cfadbfbfdf491781faee122141a74ec8
+  metadata.gz: d8107aa2092092b484c3e46a79bb870559e5519a9b2eeaccf34ff6403c3899133926942683dba7564f7e18b6310469fdef2e26ebad46f73a5d81a626359044c6
+  data.tar.gz: 68ed4faa9ee68d24080941b6302816100df2130482ec5d166dcd83f299c75f49bdbee52fcfda5451aac37f8d50b85c8fadc83beab09f83e9bbe5511d8dc112e9

data/.gitignore

@@ -19,3 +19,7 @@ Gemfile.lock
 # Ignore byebug history
 
 .byebug_history
+
+# Ignore built .gem s
+
+*.gem

data/CHANGELOG.md

@@ -6,9 +6,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.2.0] - 2021-07-18
+### Added
+- The ability to change how `ArrayDefinition` matches middleware classes.
+
 ## [0.1.0] - 2021-07-08
 ### Added
 - The initial `middlegem` gem.
 
-[Unreleased]: https://github.com/jacoblockard99/middlegem/compare/v0.1.0...HEAD
+[Unreleased]: https://github.com/jacoblockard99/middlegem/compare/v0.2.0...HEAD
 [0.1.0]: https://github.com/jacoblockard99/middlegem/releases/tag/v0.1.0
+[0.2.0]: https://github.com/jacoblockard99/middlegem/releases/tag/v0.2.0

data/README.md

@@ -1,5 +1,6 @@
 # Middlegem
 
+[![Gem Version](https://badge.fury.io/rb/middlegem.svg)](https://badge.fury.io/rb/middlegem)
 [![Build Status](https://travis-ci.com/jacoblockard99/middlegem.svg?branch=master)](https://travis-ci.com/jacoblockard99/middlegem)
 [![Inline docs](http://inch-ci.org/github/jacoblockard99/middlegem.svg?branch=master)](http://inch-ci.org/github/jacoblockard99/middlegem)
 [![Maintainability](https://api.codeclimate.com/v1/badges/b43ed85211cb562678bb/maintainability)](https://codeclimate.com/github/jacoblockard99/middlegem/maintainability)
@@ -184,6 +185,22 @@ While this works, the limitations quickly become obvious. Mainly, it requires a
 
 For more complicated scenarios, it is instead recommended that you create your own implementation of `Middlegem::Definition` that allows ordering the middlewares in some other way. Perhaps you could set "priorities" on the middlewares, or organize them into "groups"—the possibilities with this method are limitless!
 
+### Class Evaluation
+
+There may be times when you wish to have more control over how exactly `ArrayDefinition` determines the class of a middleware. The default implementation uses `instance_of?`. Perhaps you want to use `is_a?`, or maybe you have an entirely different method for getting the "class" of the middleware. In any case, this can be easily done by overriding `ArrayDefinition#matches_class?`. For example:
+
+```ruby
+class CustomArrayDefinition < Middlegem::ArrayDefinition do
+  protected
+
+  def matches_class?(middleware, klass)
+    middleware.is_a? klass
+  end
+end
+```
+
+This would cause all subclasses of a base class to be defined when the base class is.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/middlegem/array_definition.rb

@@ -108,17 +108,33 @@ module Middlegem
     # @param middleware [Object] the middleware to check.
     # @return [bool] whether the middleware is defined.
     def defined?(middleware)
-      defined_classes.include?(middleware.class)
+      defined_classes.any? { |c| matches_class?(middleware, c) }
     end
 
     # Sorts the given array of middlewares according to this {ArrayDefinition}. Middlewares are
     # sorted according to the order in which their classes are specified in {#defined_classes}.
     # If multiple middlewares of the same type are encountered, they will be resolved with the
     # {#resolver}.
+    # @param middlewares [Array<Object>] the middlewares to sort.
+    # @return [Array<Object>] the sorted middlewares.
     def sort(middlewares)
       defined_classes.map { |c| resolver.call(matches(middlewares, c)) }.flatten
     end
 
+    protected
+
+    # Should determine whether the given middleware's evaluated class is equal to the given one.
+    # The default implementation naturally just uses +instance_of?+, but you are free to
+    # override this method for other situations. You may want is use +is_a?+ instead, for
+    # example, or perhaps a middleware's "class" is based on some other criterion.
+    # @param middleware [Object] the middleware to check.
+    # @param klass [Class] the class against which to check the middleware.
+    # @return [Boolean] whether the given middleware has the given class.
+    # @since 0.2.0
+    def matches_class?(middleware, klass)
+      middleware.instance_of? klass
+    end
+
     private
 
     # Gets all the middlewares in the given array whose class is the given class.
@@ -126,7 +142,7 @@ module Middlegem
     # @param klass [Class] the class to search for.
     # @return [Array<Object>] the matched middlewares.
     def matches(middlewares, klass)
-      middlewares.select { |m| m.instance_of?(klass) }
+      middlewares.select { |m| matches_class?(m, klass) }
     end
   end
 end

data/lib/middlegem/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Middlegem
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/middlegem.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/jacoblockard99/middlegem'
-  spec.metadata['changelog_uri'] = 'https://github.com/jacoblockard99/middlegem/CHANGELOG.md'
+  spec.metadata['changelog_uri'] = 'https://github.com/jacoblockard99/middlegem/blob/master/CHANGELOG.md'
   # 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: middlegem
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jacob
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-07-09 00:00:00.000000000 Z
+date: 2021-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -104,7 +104,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/jacoblockard99/middlegem
   source_code_uri: https://github.com/jacoblockard99/middlegem
-  changelog_uri: https://github.com/jacoblockard99/middlegem/CHANGELOG.md
+  changelog_uri: https://github.com/jacoblockard99/middlegem/blob/master/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths: