gamefic-autoload 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 24affa079439426cf2ad1afbd586d34e477f92ac3024717e279cb31cb2251b12
+  data.tar.gz: 48c9c8950f62578fe13c005c076c41502dc02c048fab88a16f20da4639d03fde
+SHA512:
+  metadata.gz: 56befe92e9ef38a0c9c0b1e54b9195fcdf9990db3109d163b5634c8fd63c6367c7ee9565e9bb9ea54bbb941e1c2436aca78f5d6c86be072c0bd4d2fbc303a73a
+  data.tar.gz: 8db06531427d6f85cf5ca03d98b02dd8570ffe5814d7a5e1c3472ea31d344b4eb03deb7d9b32489bfe620ae09f8c3e344064a8f73fb81ccb42f7c343620f1806

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 1.0.0 - October 22, 2024
+- First release

data/LICENSE

@@ -0,0 +1,20 @@
+gamefic-autoload
+Copyright (c) 2024 by Fred Snyder for Castwide Technologies
+
+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,38 @@
+# Gamefic::Autoload
+
+A Zeitwerk autoloader for Gamefic projects.
+
+Using Gamefic::Autoload gives the Gamefic::SDK a way to use autoloading in web apps.
+
+## Installation
+
+The Gamefic SDK installs gamefic-autoloader by default. If you need to set it up in a bespoke project, add it to your Gemfile:
+
+    gem 'gamefic-autoloader'
+
+Then set it up in whatever directory needs autoloading (e.g., `lib/my_project.rb`):
+
+```ruby
+require 'gamefic-autoload'
+
+module MyProject
+  Gamefic::Autoload.setup(__dir__)
+end
+```
+
+## Usage
+
+Gamefic::Autoload sets up autoloading in your directory using standard Zeitwerk conventions. With the above example, you could define a class named `MyProject::MyClass` in
+`lib/my_project/my_class.rb`, and it would be automatically loaded without the need to `require` the file.
+
+For Opal-based web apps, The Gamefic SDK will create an `autoload.rb` file that preloads your files, classes, and modules in the same manner that Zeitwerk does.
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec 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/[USERNAME]/gamefic-autoload.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/gamefic-autoload.gemspec

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative 'lib/gamefic/autoload/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'gamefic-autoload'
+  spec.version = Gamefic::Autoload::VERSION
+  spec.authors = ['Fred Snyder']
+  spec.email = ['fsnyder@castwide.com']
+  spec.homepage = 'https://gamefic.com'
+  spec.license = 'MIT'
+
+  spec.summary = 'Code loading for Gamefic projects'
+  # spec.description = "TODO: Write a longer description or delete this line."
+  # spec.homepage = "TODO: Put your gem's website or public repo URL here."
+  spec.required_ruby_version = '>= 2.6.0'
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/castwide/gamefic-autoload'
+  spec.metadata['changelog_uri'] = 'https://github.com/castwide/gamefic-autoload/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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency 'gamefic', '~> 4.0'
+  spec.add_dependency 'zeitwerk', '~> 2.6'
+
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/gamefic/autoload/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Gamefic
+  module Autoload
+    VERSION = '1.0.0'
+  end
+end

data/lib/gamefic/autoload.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'gamefic'
+require 'gamefic/autoload/version'
+require 'zeitwerk' unless RUBY_ENGINE == 'opal'
+
+module Gamefic
+  # A Zeitwerk autoloader for Gamefic.
+  #
+  # Gamefic::Autoload gives the Gamefic SDK a way to use Zeitwerk's code
+  # loading conventions in Opal-based web apps.
+  #
+  module Autoload
+    def self.setup(directory, namespace: Object)
+      if RUBY_ENGINE == 'opal'
+        Gamefic.logger.info 'Opal engine detected - Gamefic::Autoload skipped'
+      else
+        register_and_setup directory, namespace
+      end
+    end
+
+    def self.registered
+      registry.keys
+    end
+
+    def self.history(directory)
+      registry[directory].eager_load
+      histories[directory]
+    end
+
+    def self.encode(directory)
+      history(directory).map do |hash|
+        if File.file?(hash[:file])
+          path = hash[:file].sub(%r{^#{directory}/?}, '').sub(/\.rb$/, '')
+          "require '#{path}'"
+        else
+          "#{hash[:const].is_a?(Class) ? 'class ' : 'module'} #{hash[:const]}; end"
+        end
+      end
+    end
+
+    def self.encode_all
+      registered.flat_map { |directory| encode(directory) }
+    end
+
+    class << self
+      def register_and_setup(directory, namespace)
+        registry[directory] = Zeitwerk::Loader.new.tap do |loader|
+          histories[directory] = []
+          loader.push_dir directory, namespace: namespace
+          loader.on_load do |name, const, file|
+            line = { name: name, const: const, file: file }
+            histories[directory].push line
+          end
+          loader.setup
+          loader.eager_load
+        end
+      end
+
+      def registry
+        @registry ||= {}
+      end
+
+      def histories
+        @histories ||= {}
+      end
+    end
+  end
+end

data/lib/gamefic-autoload.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'gamefic/autoload'

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: gamefic-autoload
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Fred Snyder
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-10-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gamefic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description:
+email:
+- fsnyder@castwide.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- LICENSE
+- README.md
+- Rakefile
+- gamefic-autoload.gemspec
+- lib/gamefic-autoload.rb
+- lib/gamefic/autoload.rb
+- lib/gamefic/autoload/version.rb
+homepage: https://gamefic.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://gamefic.com
+  source_code_uri: https://github.com/castwide/gamefic-autoload
+  changelog_uri: https://github.com/castwide/gamefic-autoload/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Code loading for Gamefic projects
+test_files: []