class_spec_helper 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b8638213951339c30d2d985e7cda10f3857c41575c2ba9409c0d3ef166468b92
+  data.tar.gz: 64299b1761a7d59974b3582266f7304b968408d204c18406c7c01b550045d244
+SHA512:
+  metadata.gz: 6defe9ad81d470ad0a6e0e0d20cbb6cc016b0155a9389ebf386b97b3dd82526d52a37be92431b78a335b14ef1d89adf44a4fda14f98d2b00aaa4aa7c0526c8e0
+  data.tar.gz: 96db5f7019a128090a84505e0e3a7a8562a02f7cb3f38ba24e1dcd556db01f1546a6c8a94db368c667c2d32be0040a45d0cf7738ade6c73c98f3a89358804b3b

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+## 1.0.0 (2023-07-13)
+
+
+### Features
+
+* dynamically create named classes from within your test suite and have them destroyed automatically between each test ([8918b35](https://github.com/craigulliott/class_spec_helper/commit/8918b35e8a57527c9b95a3ca02d9c3d8526253f7))

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at craigulliott@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Craig Ulliott
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,120 @@
+# ClassSpecHelper
+
+
+[![Gem Version](https://badge.fury.io/rb/class_spec_helper.svg)](https://badge.fury.io/rb/class_spec_helper)
+[![Specs](https://github.com/craigulliott/class_spec_helper/actions/workflows/specs.yml/badge.svg)](https://github.com/craigulliott/class_spec_helper/actions/workflows/specs.yml)
+[![Types](https://github.com/craigulliott/class_spec_helper/actions/workflows/types.yml/badge.svg)](https://github.com/craigulliott/class_spec_helper/actions/workflows/types.yml)
+[![Coding Style](https://github.com/craigulliott/class_spec_helper/actions/workflows/linter.yml/badge.svg)](https://github.com/craigulliott/class_spec_helper/actions/workflows/linter.yml)
+
+
+### What this gem is
+
+A helper class for creating up and easily deleting (cleaning up) classes within a testing environment.
+
+If you are building something which uses metaprogramming to dynamically create classes, then this gem will be a useful tool within your test suite.
+
+## Key Features
+
+* Easily create named classes within your test suite
+* Optionally provide base a base class for your new class to extend from
+* Optionally provide a block which will be called within your new class via class_eval
+* Handles class namespacing automatically
+* Have those classes destroyed automatically between tests
+
+## Installation
+
+Add the gem to your Gemfile:
+
+```ruby
+gem "class_spec_helper"
+```
+
+Or to your `*.gemspec`
+
+```ruby
+spec.add_development_dependency "class_spec_helper"
+```
+
+And run bundle install
+
+    $ bundle install
+
+
+## Getting Started
+
+#### Setting up rspec
+
+Install ClassSpecHelper into your `spec/spec_helper.rb`
+
+```ruby
+require "class_spec_helper"
+
+RSpec.configure do |config|
+
+  # make class_spec_helper conveniently accessable within your test suite
+  config.add_setting :class_spec_helper
+  config.class_spec_helper = ClassSpecHelper.new
+
+  # destroy these dyanmically created classes after each test
+  config.after(:each) do
+    config.class_spec_helper.remove_all_dynamically_created_classes
+  end
+end
+
+```
+
+
+#### An example test which creates classes dynamically
+
+Note, that these dynamically created classes will be destroyed automatically after each test has been run
+
+```ruby
+RSpec.describe ClassSpecHelper do
+  let(:class_spec_helper) { RSpec.configuration.class_spec_helper }
+
+  describe "for a class and a child class" do
+    before(:each) do
+      # create the class named MyClass
+      class_spec_helper.create_class :MyClass
+      # note than MyClass will be available here
+      class_spec_helper.create_class :MyChildClass, MyClass
+    end
+
+    it "created a class which correctly extends the base class" do
+      expect(MyClass < MyChildClass).to be true
+    end
+
+  end
+end
+```
+
+
+## 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.
+
+We use [Conventional Commit Messages](https://gist.github.com/qoomon/5dfcdf8eec66a051ecd85625518cfd13).
+
+Code should be linted and formatted according to [Ruby Standard](https://github.com/standardrb/standard).
+
+Publishing is automated via github actions and Googles [Release Please](https://github.com/google-github-actions/release-please-action) github action
+
+We prefer using squash-merges when merging pull requests because it helps keep a linear git history and allows more fine grained control of commit messages which get sent to release-please and ultimately show up in the changelog.
+
+Type checking is enabled for this project. You can find the corresponding `rbs` files in the sig folder.
+
+Install types for the packages used in development (such as `rspec`) by running
+
+    $ rbs collection install
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/craigulliott/class_spec_helper. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/craigulliott/class_spec_helper/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+This software is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ClassSpecHelper project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/craigulliott/class_spec_helper/blob/master/CODE_OF_CONDUCT.md).

data/lib/class_spec_helper/create_classes.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+class ClassSpecHelper
+  module CreateClasses
+    # create a new class with the provided name, if the provided name is
+    # namespaced, then assume each part of the namespace is a module and
+    # create create modules as needed to satistfy the fully qualified name
+    #
+    # if base_class is provided, then the newly created class will extend it
+    #
+    # if block is provided, then the newly created class will execute
+    # it via class_eval
+    def create_class fully_qualified_class_name, base_class = nil, &block
+      # because we're using eval, we validate the class name to ensure it is not mallicious
+      unless /\A[A-Z][a-zA-Z0-9_]*(::[A-Z][a-zA-Z0-9_]*)*\z/.match?(fully_qualified_class_name)
+        raise ClassNameError, "`#{fully_qualified_class_name}` is not a valid class name"
+      end
+
+      # ensure it was not already created here
+      if Object.const_defined? fully_qualified_class_name
+        raise ClassAlreadyExistsError, "Class `#{fully_qualified_class_name}` already exists within this application"
+      end
+
+      # ensure it does not already exist
+      if @classes.key? fully_qualified_class_name.to_sym
+        raise ClassAlreadyDynamicallyCreatedError, "Class `#{fully_qualified_class_name}` was already dynamically created with this helper"
+      end
+
+      # We prepend "::" to the class name to ensure the class is created at the top most scope
+      class_name_parts = fully_qualified_class_name.to_s.split("::")
+      class_name = class_name_parts.pop
+      module_names = class_name_parts
+
+      eval_code_lines = []
+
+      # is this class nested within a namespace?
+      is_namespaced = module_names.any?
+      if is_namespaced
+        # first module is always prepended by a "::" to ensure it is at the top most level
+        eval_code_lines << "module ::#{module_names.shift}"
+        # each remaining module name is just nested within this top most module
+        module_names.each do |module_name|
+          eval_code_lines << "module #{module_name}"
+        end
+      end
+      # the class definition
+      eval_code_lines << "class #{is_namespaced ? nil : "::"}#{class_name} #{base_class && "< #{base_class.name}"}"
+      # add the expected number of "ends" to close the class and any nested modules
+      end_count = eval_code_lines.count
+      end_count.times do
+        eval_code_lines << "end"
+      end
+
+      eval_code = eval_code_lines.join("\n")
+
+      # we use `eval` because we want to create a class which immediately has
+      # the expected name, unlike an anonymous class which is initially created
+      # without the expected name and only receives the expected name once assigned
+      # to a constant.
+      eval eval_code # standard:disable Security/Eval
+
+      # get the new class from the constant
+      klass = Object.const_get fully_qualified_class_name
+
+      # remember the full class name with namespace, so we can remove it again later
+      @classes[fully_qualified_class_name.to_sym] = klass
+
+      # finish building the class
+      klass.class_eval(&block) if block
+    end
+  end
+end

data/lib/class_spec_helper/destroy_classes.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+class ClassSpecHelper
+  module DestroyClasses
+    # remove any classes (constants) which were
+    # created by the class helper
+    def remove_all_dynamically_created_classes
+      @classes.each do |fully_qualified_class_name, klass|
+        # destroy the class by removing the constant
+        destroy_class klass
+        # remove the class from the list of classes
+        @classes.delete fully_qualified_class_name.to_sym
+      end
+    end
+
+    # destroy the class by removing the constant
+    def destroy_class klass
+      fully_qualified_class_name = klass.name
+      # get the namespace and class name from the fully qualified class name
+      namespace = namespace_from_name fully_qualified_class_name
+      class_name = class_name_from_name fully_qualified_class_name
+      # remove the constant from the namespace
+      namespace.send :remove_const, class_name
+    end
+  end
+end

data/lib/class_spec_helper/naming.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+class ClassSpecHelper
+  module Naming
+    # provided with a fully qualified class name, return the namespace
+    #
+    # For example:
+    #   namespace_from_name "Foo::Bar::Baz" will return the constant Foo
+    #   namespace_from_name "Foo" will return the constant Object
+    def namespace_from_name fully_qualified_class_name
+      namespace_parts = fully_qualified_class_name.split("::")[0..-2]
+      namespace_name = namespace_parts.join("::")
+
+      # if the model was namespaced, then return the coresponding constant
+      # if there is no namespace, then use `Object` which is the top most
+      # namespace in ruby
+      if namespace_name == ""
+        Object
+      else
+        Object.const_get namespace_name
+      end
+    end
+
+    # provided with a fully qualified class name, return the class name
+    #
+    # For example:
+    #   namespace_from_name "Foo::Bar::Baz" will return the string "Baz"
+    #   namespace_from_name "Foo" will return the string "Foo"
+    def class_name_from_name name
+      name.split("::").last
+    end
+  end
+end

data/lib/class_spec_helper/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class ClassSpecHelper
+  VERSION = "1.0.0"
+end

data/lib/class_spec_helper.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "class_spec_helper/version"
+
+require "class_spec_helper/create_classes"
+require "class_spec_helper/destroy_classes"
+require "class_spec_helper/naming"
+
+class ClassSpecHelper
+  class ClassAlreadyDynamicallyCreatedError < StandardError
+  end
+
+  class ClassAlreadyExistsError < StandardError
+  end
+
+  class ClassNameError < StandardError
+  end
+
+  def initialize
+    @classes = {}
+  end
+
+  include CreateClasses
+  include DestroyClasses
+  include Naming
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: class_spec_helper
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Craig Ulliott
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-07-13 00:00:00.000000000 Z
+dependencies: []
+description: Ruby gem to create named classes for use within your specs, and then
+  clear them out automatically between specs.
+email:
+- craigulliott@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- lib/class_spec_helper.rb
+- lib/class_spec_helper/create_classes.rb
+- lib/class_spec_helper/destroy_classes.rb
+- lib/class_spec_helper/naming.rb
+- lib/class_spec_helper/version.rb
+homepage: 
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/craigulliott/class_spec_helper/
+  changelog_uri: https://github.com/craigulliott/class_spec_helper/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key: 
+specification_version: 4
+summary: Easily create and destroy named classes for use within your specs.
+test_files: []