inclusive 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3e972fc6385483574fb08cfcc3a4cf320b162b8e7bd726a1074e917a308114bc
+  data.tar.gz: 6d1fed490b2da13b72acaaa16ebacaea3623fdd4d98904523ee8e6d6f7428ef7
+SHA512:
+  metadata.gz: 22c5f46c10692394cff02977e1017b84009ff19f268357703b84c3ce1c2d06ca4c5f8a839dcedf98cb9dfeedb7a0f070bd27ef923df0bebcb57977cabc5bd4cc
+  data.tar.gz: 9e22d54b55eb4c10ecac7b1c5962dca0772ec66a06d3728e22a06a1c663afbf971524095b1516fb7ec80cc9bb3429cb9c5346f7711af3aaf2c1f57c25e8404f7

data/.rubocop.yml

@@ -0,0 +1,30 @@
+require:
+ - rubocop-minitest
+ - rubocop-rake
+
+AllCops:
+  TargetRubyVersion: 3.1
+  NewCops: enable
+
+Naming/VariableNumber:
+  Enabled: false
+
+Style/EndlessMethod:
+  Enabled: false
+
+Style/CommentedKeyword:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 20

data/.ruby-version

@@ -0,0 +1 @@
+3.1.4

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [1.0.0] - 2024-06-30
+
+- Initial release

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 jared@jaredwhite.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) 2024 Jared White & Bridgetown maintainers
+
+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,136 @@
+# Inclusive
+
+Compose globally-scoped Ruby modules into local packages. This makes it easy to access utility methods (aka functions) without having to type lengthy namespaces or remember which modules provide with functions at each call site (or alternatively include modules in your classes which pollute the method space).
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add inclusive
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install inclusive
+
+## Usage
+
+To start with, you can write your "package" (aka a standard Ruby module) containing a set of discrete functions. It's recommended you namespace your packages within higher-level modules.
+
+```ruby
+module MyOrg
+  module MyPackages
+    module WorkHardAtIt
+      def just_do_it = puts "Don't let your dreams be dreams"
+    end
+  end
+end
+```
+
+Then in any standard Ruby class, you can include the `Inclusive` module and use the `packages` class helper to "import" the package:
+
+```ruby
+require "inclusive"
+# require the file(s) containing your package(s)
+
+class GetToThePoint
+  include Inclusive
+
+  packages def work_hard = [MyOrg::MyPackages::WorkHardAtIt]
+
+  def nothing_is_impossible
+    work_hard.just_do_it # this will print out the motivational speech
+  end
+end
+```
+
+The import syntax is an array because you can import multiple packages. The imported packages will "compose" together, meaning the methods from the various package modules will all be available simultaneously.
+
+In addition to creating instance methods using the `packages` class helper, you can use the `packages` method inline:
+
+```ruby
+def some_method
+  my_math = packages[MyOrg::Math]
+
+  my_math.multiply_by_100(5)
+end
+```
+
+This approach isn't recommended unless you're in a context where using the class helper is impossible, such as a template (ERB, etc.) or a block which is executed by a framework. You can also call the `packages` method directly on the `Inclusive` module:
+
+```ruby
+my_math = Inclusive.packages(MyOrg::Math)
+```
+
+If you want to be able to call a package method directly on its own module, you can extend your module and use the `public_function` helper:
+
+```ruby
+module Packages
+  module MyPackage
+    extend Inclusive::Public
+
+    def some_method
+      # code
+    end
+
+    public_function :some_method
+  end
+end
+```
+
+Now in addition to using package imports via Inclusive, you can call the module method directly:
+
+```ruby
+Packages::MyPackage.some_method
+```
+
+This is only recommended if you need to mantain an existing module's legacy behavior in a codebase while incrementally adopting Inclusive.
+
+### Packages Are Duplicated
+
+One of the aspects of Inclusive which make it more useful than merely using standard Ruby modules is each imported package is actually a cloned module. This means a module can actually contain internal state, much like an object:
+
+```ruby
+module Packages
+  module Ownership
+    attr_accessor :owner
+
+    def owner_classname
+      owner.class.name
+    end
+  end
+end
+
+class SomeObject
+  def try_out_ownership
+    ownership = packages[Package::Ownership].tap { _1.owner = self }
+
+    puts ownership.owner_classname # this will be `SomeObject`
+  end
+end
+
+class SomeOtherObject
+  def try_out_ownership
+    ownership = packages[Package::Ownership].tap { _1.owner = self }
+
+    puts ownership.owner_classname # this will be `SomeOtherObject`
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bin/rake install`. To release a new version, update the version number in `version.rb`, and then run `bin/rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bridgetownrb/inclusive. 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/bridgetownrb/inclusive/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Inclusive project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/bridgetownrb/inclusive/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/inclusive/version.rb

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

data/lib/inclusive.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+require "set"
+
+require_relative "inclusive/version"
+
+# Include this in any class so you have access to the `packages` method (both class and instance).
+module Inclusive
+  # You can extend a module with this in order to use `public_function`, which is the same as
+  # Ruby's native `module_function` except the instance method retains public visibility—a necessity
+  # for packaging via Inclusive.
+  module Public
+    def public_function(method_name)
+      module_function method_name
+      public method_name # reset back to public visibility
+    end
+  end
+
+  extend Inclusive::Public
+
+  # This is the base module which will be cloned for each individual import scenario. You should
+  # never need to reference this module directly.
+  module ModuleWithPackages
+    # Use this for the inline packages syntax.
+    #
+    # @example importing packages
+    #   utils = packages[UtilitiesPackage, Another::Package]
+    #   utils.make_it(:so)
+    def self.[](*packages)
+      packages.each { |package| extend_with_package(package) }
+      self
+    end
+
+    def self.extend_with_package(package)
+      @package_names ||= Set.new
+      @package_methods ||= Set.new
+
+      warn_on_overwritten_methods(package)
+      package.instance_methods.each { @package_methods << _1 }
+      @package_names << package.name
+
+      extend package
+    end
+
+    def self.warn_on_overwritten_methods(package)
+      overwriting_methods = @package_methods.select { package.instance_methods.include? _1 }
+      return unless overwriting_methods.length.positive?
+
+      warn "Inclusive <#{@package_names.join(", ")}> - The following methods will be overridden by " \
+           "'#{package.name}':\n  #{overwriting_methods.join(", ")}"
+    end
+
+    def self.to_s = "#{name}<#{@package_names.join(", ")}>"
+
+    def self.inspect = to_s
+
+    def self.loaded_packages
+      singleton_class.included_modules.reverse.select { @package_names.include? _1.name }
+    end
+
+    def self.package_methods
+      loaded_packages.flat_map(&:instance_methods)
+    end
+  end
+
+  # This will extend your class by default if you `include Inclusive`, but if for some reason you
+  # don't want the `packages` instance method in your class, you can simply
+  # `extend Inclusive::Class`
+  module Class
+    # Use this as a decorator for an instance method which you will use to access your package
+    # imports.
+    #
+    # @example method definition
+    #   packages def utilities = [Package1, Package2]
+    #
+    #   def some_logic_here
+    #     utilities.do_stuff # from Package1
+    #     utilities.convert(x) # from Package2
+    #   end
+    #
+    # This new method will be set to private, unless you use `public_packages` instead of `packages`.
+    #
+    # @return [void]
+    def packages(method_name)
+      old_method_name = :"__old_#{method_name}__"
+      ivar_name = :"@_#{method_name}"
+
+      alias_method old_method_name, method_name
+
+      define_method method_name do
+        return instance_variable_get(ivar_name) if instance_variable_defined?(ivar_name)
+
+        packages_to_extend = send(old_method_name)
+        ModuleWithPackages.dup.tap do |mod|
+          mod.module_eval do
+            def self.name = "ModuleWithPackages" # preserve module name
+          end
+          packages_to_extend.each { |package| mod.extend_with_package(package) }
+          instance_variable_set(ivar_name, mod)
+        end
+      end
+
+      private method_name unless __callee__ == :public_packages
+    end
+
+    alias public_packages packages
+  end
+
+  def self.included(klass)
+    klass.extend self::Class
+  end
+
+  # Returns a blank module ready for package imports, useful for inline package access when an
+  # instance method is not suitable (perhaps you're in a template or block context).
+  #
+  # @return [ModuleWithPackages]
+  def packages = ModuleWithPackages.dup.tap do |mod|
+    mod.module_eval do
+      def self.name = "ModuleWithPackages" # preserve module name
+    end
+  end
+
+  public_function :packages
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: inclusive
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Bridgetown Team
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-06-30 00:00:00.000000000 Z
+dependencies: []
+description:
+email: maintainers@bridgetownrb.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/inclusive.rb
+- lib/inclusive/version.rb
+homepage: https://github.com/bridgetownrb/inclusive
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/bridgetownrb/inclusive
+  source_code_uri: https://github.com/bridgetownrb/inclusive
+  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: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: Compose globally-scoped Ruby modules into local packages
+test_files: []