feature_envy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ebacd4b2d2a8d5292de874248a212a72b02a7bc13b5279b08f020a88c8973e71
+  data.tar.gz: bca18e8eab4ef3d67efa38b65a09f4ede7291873a95a266748bbfd79e2b9ab45
+SHA512:
+  metadata.gz: 534c102e65795b30fd4cdd42ef10b34b062776642f145ebddffd3865fc39e81657c870e645e782362f39c45b1d6afb2e565caefb2932da69fcd84d71121a5548
+  data.tar.gz: 0be465e644e71f4b51f14acb6e6e496c43618e5fbe8e13cc2a288291789074bcbc5d297589b4cb4b3d36eff742eb5a5351b3db81298a7637e22f348e78afb53b

data/README.md

@@ -0,0 +1,27 @@
+# Feature Envy
+
+Feature Envy enhances Ruby with features found in other programming languages.
+
+**WARNING**: This gem is still in development and a stable release hasn't been
+made yet. Bug reports and contributions are welcome!
+
+## Installation
+
+You can install the gem by running `gem install feature_envy` or adding it to
+`Gemfile`:
+
+```ruby
+gem "feature_envy"
+```
+
+Don't forget to run `bundle install` afterwards.
+
+## Usage
+
+Features are independent from each other and can be enabled one-by-one when
+needed. Please refer to individual feature documentation to understand how to
+enabled them.
+
+## Author
+
+This gem is developed and maintained by [Greg Navis](http://www.gregnavis.com).

data/lib/feature_envy/final_class.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module FeatureEnvy
+  # Final classes.
+  #
+  # A final class is a class that cannot be inherited from. In other words, a
+  # final class enforces the invariant that it has no subclasses. Existence of
+  # subclasses if checked **at the moment a class is defined final** (to catch
+  # cases where a class is reopened and made final after subclasses were
+  # defined) and when.
+  #
+  # The module can be used in two ways:
+  #
+  # 1. Using it as a refinement and calling +.final!+ in bodies of classes that
+  #    should be marked final.
+  # 2. Extending the class with {FeatureEnvy::FinalClass}.
+  #
+  # See the example below for details.
+  #
+  # @example Final classes with refinements
+  #   module Models
+  #     # Use the refinement within the module, so that all classes defined
+  #     # within support the final! method.
+  #     using FeatureEnvy::FinalClass
+  #
+  #     class User < Base
+  #       # Mark the User class final.
+  #       final!
+  #     end
+  #   end
+  #
+  # @example Final classes without refinements
+  #   module Models
+  #     class User < Base
+  #       # Mark the User class final.
+  #       extend FeatureEnvy::FinalClass
+  #     end
+  #   end
+  module FinalClass
+    # An error representing a final class invariant violation.
+    class Error < FeatureEnvy::Error
+      def initialize final_class:, subclasses:
+        super(<<~ERROR)
+          Class #{FeatureEnvy::Internal.class_name final_class} is final but the following subclasses were defined:
+
+          #{subclasses.map { "- #{FeatureEnvy::Internal.class_name _1}" }.join("\n")}
+        ERROR
+      end
+    end
+
+    refine Class do
+      def final!
+        extend FinalClass
+      end
+
+      def final?
+        FinalClass.final? self
+      end
+    end
+
+    # The array of classes that were marked as final.
+    @classes = []
+
+    class << self
+      def extended final_class
+        # The class must be marked final first, before we check whether there
+        # are already existing subclasses. If the error were raised first then
+        # .final? would return +false+ causing confusion: if the class isn't
+        # final then why was the error raised?
+        @classes << final_class
+
+        subclasses = Internal.subclasses final_class
+        return if subclasses.empty?
+
+        raise Error.new(final_class: final_class, subclasses: subclasses)
+      end
+
+      # Determines whether a given class is marked final.
+      #
+      # @param klass [Class] The class whose finality should be checked.
+      # @return [Boolean] +true+ if +klass+ is final, +false+ otherwise.
+      def final? klass
+        @classes.include? klass
+      end
+    end
+
+    # @private
+    def inherited klass # rubocop:disable Lint/MissingSuper
+      raise Error.new(final_class: self, subclasses: [klass])
+    end
+  end
+end

data/lib/feature_envy/internal.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module FeatureEnvy
+  # @private
+  module Internal
+    # Returns all subclasses of the given class.
+    def self.subclasses parent_class
+      subclasses = []
+      ObjectSpace.each_object(Class) do |klass|
+        subclasses << klass if klass.superclass.equal? parent_class
+      end
+      subclasses
+    end
+
+    # Returns a user-friendly class name.
+    def self.class_name klass
+      klass.name || ANONYMOUS_CLASS_NAME
+    end
+
+    ANONYMOUS_CLASS_NAME = "anonymous class"
+    private_constant :ANONYMOUS_CLASS_NAME
+  end
+end

data/lib/feature_envy/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module FeatureEnvy
+  # The current version number.
+  VERSION = "0.1.0"
+end

data/lib/feature_envy.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative "feature_envy/version"
+
+# Features inspired by other programming languages.
+#
+# Features are independent from each other and are implemented in separate
+# submodules. Refer to module documentation for details on how each feature can
+# be enabled and used.
+module FeatureEnvy
+  # A base class for all errors raised by Feature Envy.
+  class Error < StandardError; end
+
+  autoload :Internal,   "feature_envy/internal"
+  autoload :FinalClass, "feature_envy/final_class"
+end

data/test/final_class_test.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class FinalClassTest < Minitest::Test
+  using FeatureEnvy::FinalClass
+
+  def test_non_refinement_final_class_cannot_be_inherited
+    user = Class.new do
+      extend FeatureEnvy::FinalClass
+    end
+
+    assert_raises FeatureEnvy::FinalClass::Error,
+                  "Subclassing a final class should have raised an exception" do
+      Class.new user
+    end
+    assert user.final?,
+           "A final class should have been reported as final but was not"
+  end
+
+  def test_refinement_final_class_cannot_be_inherited
+    user = Class.new do
+      final!
+    end
+
+    assert_raises FeatureEnvy::FinalClass::Error,
+                  "Subclassing a final class should have raised an exception" do
+      Class.new user
+    end
+    assert user.final?,
+           "A final class should have been reported as final but was not"
+  end
+
+  def test_error_when_superclass_made_final
+    model = Class.new
+    user = Class.new model # rubocop:disable Lint/UselessAssignment
+
+    assert_raises FeatureEnvy::FinalClass::Error,
+                  "Making a superclass final should have raised an exception" do
+      model.extend FeatureEnvy::FinalClass
+    end
+  end
+end

data/test/internal_test.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class InternalTest < Minitest::Test
+  class Model; end
+  class User < Model; end
+  class Project < Model; end
+  class AdminUser < User; end
+
+  def test_subclasses
+    assert_equal [User, Project].sort_by(&:name),
+                 FeatureEnvy::Internal.subclasses(Model).sort_by(&:name),
+                 "All subclasses and no other descendants should have been returned"
+  end
+
+  def test_class_name
+    assert_equal "InternalTest::Model",
+                 FeatureEnvy::Internal.class_name(Model)
+    assert_equal "InternalTest::User",
+                 FeatureEnvy::Internal.class_name(User)
+    assert_equal "anonymous class",
+                 FeatureEnvy::Internal.class_name(Class.new)
+  end
+end

data/test/support/assertions.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Assertions
+  def assert_mapping callable, mapping
+    Hash(mapping).each do |input, output|
+      arguments = input.is_a?(Array) ? input : [input]
+
+      assert_equal output, callable.call(*arguments)
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+require "feature_envy"
+
+require "minitest/autorun"
+
+require_relative "support/assertions"
+
+class Minitest::Test
+  include Assertions
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: feature_envy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Greg Navis
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.18.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.18.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.26.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.26.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.28
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.28
+description:
+email: contact@gregnavis.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/feature_envy.rb
+- lib/feature_envy/final_class.rb
+- lib/feature_envy/internal.rb
+- lib/feature_envy/version.rb
+- test/final_class_test.rb
+- test/internal_test.rb
+- test/support/assertions.rb
+- test/test_helper.rb
+homepage: https://github.com/gregnavis/feature_envy
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/gregnavis/feature_envy
+  source_code_uri: https://github.com/gregnavis/feature_envy
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.6
+signing_key:
+specification_version: 4
+summary: Feature Envy enhances Ruby with features inspired by other programming languages
+test_files:
+- test/final_class_test.rb
+- test/internal_test.rb
+- test/support/assertions.rb
+- test/test_helper.rb