core-loader 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 97c1b629b63e1e8c1afaf7517d94ebd10e07fc6c8d90242710f19badef3159a2
+  data.tar.gz: 0e1bc36bcf61e9453540f0c205f75ec39a9fd9fc9de2e5a18d8fb29f8e9c2bb3
+SHA512:
+  metadata.gz: 936b3d2fb25f3c8bf5aa1c672d6d932c56645c6d780271df0ecbea7171d1b1adfcdc7d2e4a03b121ff5fba02e9b0c65b1ce3950f91e4d64fc870b1ffc1c32478
+  data.tar.gz: c3d65ce565fa6fc21f1f5c06497065db77facacd0de7834382b1bf185e7d682e1db0733ec7d2f26645db853f0f3cb0b160a008d753a58bd53b3e7d7b8c0592de

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## [v0.0.0](https://github.com/metabahn/corerb/releases/tag/2021-11-02)
+
+*released on 2021-11-02*
+
+  * `add` [#94](https://github.com/metabahn/corerb/pull/94) Initial implementation of the core-loader gem ([bryanp](https://github.com/bryanp))
+
+

data/LICENSE

@@ -0,0 +1,353 @@
+Mozilla Public License, version 2.0
+
+1. Definitions
+
+1.1. “Contributor”
+
+     means each individual or legal entity that creates, contributes to the
+     creation of, or owns Covered Software.
+
+1.2. “Contributor Version”
+
+     means the combination of the Contributions of others (if any) used by a
+     Contributor and that particular Contributor’s Contribution.
+
+1.3. “Contribution”
+
+     means Covered Software of a particular Contributor.
+
+1.4. “Covered Software”
+
+     means Source Code Form to which the initial Contributor has attached the
+     notice in Exhibit A, the Executable Form of such Source Code Form, and
+     Modifications of such Source Code Form, in each case including portions
+     thereof.
+
+1.5. “Incompatible With Secondary Licenses”
+     means
+
+     a. that the initial Contributor has attached the notice described in
+        Exhibit B to the Covered Software; or
+
+     b. that the Covered Software was made available under the terms of version
+        1.1 or earlier of the License, but not also under the terms of a
+        Secondary License.
+
+1.6. “Executable Form”
+
+     means any form of the work other than Source Code Form.
+
+1.7. “Larger Work”
+
+     means a work that combines Covered Software with other material, in a separate
+     file or files, that is not Covered Software.
+
+1.8. “License”
+
+     means this document.
+
+1.9. “Licensable”
+
+     means having the right to grant, to the maximum extent possible, whether at the
+     time of the initial grant or subsequently, any and all of the rights conveyed by
+     this License.
+
+1.10. “Modifications”
+
+     means any of the following:
+
+     a. any file in Source Code Form that results from an addition to, deletion
+        from, or modification of the contents of Covered Software; or
+
+     b. any new file in Source Code Form that contains any Covered Software.
+
+1.11. “Patent Claims” of a Contributor
+
+      means any patent claim(s), including without limitation, method, process,
+      and apparatus claims, in any patent Licensable by such Contributor that
+      would be infringed, but for the grant of the License, by the making,
+      using, selling, offering for sale, having made, import, or transfer of
+      either its Contributions or its Contributor Version.
+
+1.12. “Secondary License”
+
+      means either the GNU General Public License, Version 2.0, the GNU Lesser
+      General Public License, Version 2.1, the GNU Affero General Public
+      License, Version 3.0, or any later versions of those licenses.
+
+1.13. “Source Code Form”
+
+      means the form of the work preferred for making modifications.
+
+1.14. “You” (or “Your”)
+
+      means an individual or a legal entity exercising rights under this
+      License. For legal entities, “You” includes any entity that controls, is
+      controlled by, or is under common control with You. For purposes of this
+      definition, “control” means (a) the power, direct or indirect, to cause
+      the direction or management of such entity, whether by contract or
+      otherwise, or (b) ownership of more than fifty percent (50%) of the
+      outstanding shares or beneficial ownership of such entity.
+
+
+2. License Grants and Conditions
+
+2.1. Grants
+
+     Each Contributor hereby grants You a world-wide, royalty-free,
+     non-exclusive license:
+
+     a. under intellectual property rights (other than patent or trademark)
+        Licensable by such Contributor to use, reproduce, make available,
+        modify, display, perform, distribute, and otherwise exploit its
+        Contributions, either on an unmodified basis, with Modifications, or as
+        part of a Larger Work; and
+
+     b. under Patent Claims of such Contributor to make, use, sell, offer for
+        sale, have made, import, and otherwise transfer either its Contributions
+        or its Contributor Version.
+
+2.2. Effective Date
+
+     The licenses granted in Section 2.1 with respect to any Contribution become
+     effective for each Contribution on the date the Contributor first distributes
+     such Contribution.
+
+2.3. Limitations on Grant Scope
+
+     The licenses granted in this Section 2 are the only rights granted under this
+     License. No additional rights or licenses will be implied from the distribution
+     or licensing of Covered Software under this License. Notwithstanding Section
+     2.1(b) above, no patent license is granted by a Contributor:
+
+     a. for any code that a Contributor has removed from Covered Software; or
+
+     b. for infringements caused by: (i) Your and any other third party’s
+        modifications of Covered Software, or (ii) the combination of its
+        Contributions with other software (except as part of its Contributor
+        Version); or
+
+     c. under Patent Claims infringed by Covered Software in the absence of its
+        Contributions.
+
+     This License does not grant any rights in the trademarks, service marks, or
+     logos of any Contributor (except as may be necessary to comply with the
+     notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+     No Contributor makes additional grants as a result of Your choice to
+     distribute the Covered Software under a subsequent version of this License
+     (see Section 10.2) or under the terms of a Secondary License (if permitted
+     under the terms of Section 3.3).
+
+2.5. Representation
+
+     Each Contributor represents that the Contributor believes its Contributions
+     are its original creation(s) or it has sufficient rights to grant the
+     rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+     This License is not intended to limit any rights You have under applicable
+     copyright doctrines of fair use, fair dealing, or other equivalents.
+
+2.7. Conditions
+
+     Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted in
+     Section 2.1.
+
+
+3. Responsibilities
+
+3.1. Distribution of Source Form
+
+     All distribution of Covered Software in Source Code Form, including any
+     Modifications that You create or to which You contribute, must be under the
+     terms of this License. You must inform recipients that the Source Code Form
+     of the Covered Software is governed by the terms of this License, and how
+     they can obtain a copy of this License. You may not attempt to alter or
+     restrict the recipients’ rights in the Source Code Form.
+
+3.2. Distribution of Executable Form
+
+     If You distribute Covered Software in Executable Form then:
+
+     a. such Covered Software must also be made available in Source Code Form,
+        as described in Section 3.1, and You must inform recipients of the
+        Executable Form how they can obtain a copy of such Source Code Form by
+        reasonable means in a timely manner, at a charge no more than the cost
+        of distribution to the recipient; and
+
+     b. You may distribute such Executable Form under the terms of this License,
+        or sublicense it under different terms, provided that the license for
+        the Executable Form does not attempt to limit or alter the recipients’
+        rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+     You may create and distribute a Larger Work under terms of Your choice,
+     provided that You also comply with the requirements of this License for the
+     Covered Software. If the Larger Work is a combination of Covered Software
+     with a work governed by one or more Secondary Licenses, and the Covered
+     Software is not Incompatible With Secondary Licenses, this License permits
+     You to additionally distribute such Covered Software under the terms of
+     such Secondary License(s), so that the recipient of the Larger Work may, at
+     their option, further distribute the Covered Software under the terms of
+     either this License or such Secondary License(s).
+
+3.4. Notices
+
+     You may not remove or alter the substance of any license notices (including
+     copyright notices, patent notices, disclaimers of warranty, or limitations
+     of liability) contained within the Source Code Form of the Covered
+     Software, except that You may alter any license notices to the extent
+     required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+     You may choose to offer, and to charge a fee for, warranty, support,
+     indemnity or liability obligations to one or more recipients of Covered
+     Software. However, You may do so only on Your own behalf, and not on behalf
+     of any Contributor. You must make it absolutely clear that any such
+     warranty, support, indemnity, or liability obligation is offered by You
+     alone, and You hereby agree to indemnify every Contributor for any
+     liability incurred by such Contributor as a result of warranty, support,
+     indemnity or liability terms You offer. You may include additional
+     disclaimers of warranty and limitations of liability specific to any
+     jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+
+   If it is impossible for You to comply with any of the terms of this License
+   with respect to some or all of the Covered Software due to statute, judicial
+   order, or regulation then You must: (a) comply with the terms of this License
+   to the maximum extent possible; and (b) describe the limitations and the code
+   they affect. Such description must be placed in a text file included with all
+   distributions of the Covered Software under this License. Except to the
+   extent prohibited by statute or regulation, such description must be
+   sufficiently detailed for a recipient of ordinary skill to be able to
+   understand it.
+
+5. Termination
+
+5.1. The rights granted under this License will terminate automatically if You
+     fail to comply with any of its terms. However, if You become compliant,
+     then the rights granted under this License from a particular Contributor
+     are reinstated (a) provisionally, unless and until such Contributor
+     explicitly and finally terminates Your grants, and (b) on an ongoing basis,
+     if such Contributor fails to notify You of the non-compliance by some
+     reasonable means prior to 60 days after You have come back into compliance.
+     Moreover, Your grants from a particular Contributor are reinstated on an
+     ongoing basis if such Contributor notifies You of the non-compliance by
+     some reasonable means, this is the first time You have received notice of
+     non-compliance with this License from such Contributor, and You become
+     compliant prior to 30 days after Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+     infringement claim (excluding declaratory judgment actions, counter-claims,
+     and cross-claims) alleging that a Contributor Version directly or
+     indirectly infringes any patent, then the rights granted to You by any and
+     all Contributors for the Covered Software under Section 2.1 of this License
+     shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all end user
+     license agreements (excluding distributors and resellers) which have been
+     validly granted by You or Your distributors under this License prior to
+     termination shall survive termination.
+
+6. Disclaimer of Warranty
+
+   Covered Software is provided under this License on an “as is” basis, without
+   warranty of any kind, either expressed, implied, or statutory, including,
+   without limitation, warranties that the Covered Software is free of defects,
+   merchantable, fit for a particular purpose or non-infringing. The entire
+   risk as to the quality and performance of the Covered Software is with You.
+   Should any Covered Software prove defective in any respect, You (not any
+   Contributor) assume the cost of any necessary servicing, repair, or
+   correction. This disclaimer of warranty constitutes an essential part of this
+   License. No use of  any Covered Software is authorized under this License
+   except under this disclaimer.
+
+7. Limitation of Liability
+
+   Under no circumstances and under no legal theory, whether tort (including
+   negligence), contract, or otherwise, shall any Contributor, or anyone who
+   distributes Covered Software as permitted above, be liable to You for any
+   direct, indirect, special, incidental, or consequential damages of any
+   character including, without limitation, damages for lost profits, loss of
+   goodwill, work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses, even if such party shall have been
+   informed of the possibility of such damages. This limitation of liability
+   shall not apply to liability for death or personal injury resulting from such
+   party’s negligence to the extent applicable law prohibits such limitation.
+   Some jurisdictions do not allow the exclusion or limitation of incidental or
+   consequential damages, so this exclusion and limitation may not apply to You.
+
+8. Litigation
+
+   Any litigation relating to this License may be brought only in the courts of
+   a jurisdiction where the defendant maintains its principal place of business
+   and such litigation shall be governed by laws of that jurisdiction, without
+   reference to its conflict-of-law provisions. Nothing in this Section shall
+   prevent a party’s ability to bring cross-claims or counter-claims.
+
+9. Miscellaneous
+
+   This License represents the complete agreement concerning the subject matter
+   hereof. If any provision of this License is held to be unenforceable, such
+   provision shall be reformed only to the extent necessary to make it
+   enforceable. Any law or regulation which provides that the language of a
+   contract shall be construed against the drafter shall not be used to construe
+   this License against a Contributor.
+
+
+10. Versions of the License
+
+10.1. New Versions
+
+      Mozilla Foundation is the license steward. Except as provided in Section
+      10.3, no one other than the license steward has the right to modify or
+      publish new versions of this License. Each version will be given a
+      distinguishing version number.
+
+10.2. Effect of New Versions
+
+      You may distribute the Covered Software under the terms of the version of
+      the License under which You originally received the Covered Software, or
+      under the terms of any subsequent version published by the license
+      steward.
+
+10.3. Modified Versions
+
+      If you create software not governed by this License, and you want to
+      create a new license for such software, you may create and use a modified
+      version of this License if you rename the license and remove any
+      references to the name of the license steward (except to note that such
+      modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary Licenses
+      If You choose to distribute Source Code Form that is Incompatible With
+      Secondary Licenses under the terms of this version of the License, the
+      notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+
+      This Source Code Form is subject to the
+      terms of the Mozilla Public License, v.
+      2.0. If a copy of the MPL was not
+      distributed with this file, You can
+      obtain one at
+      http://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular file, then
+You may include the notice in a location (such as a LICENSE file in a relevant
+directory) where a recipient would be likely to look for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - “Incompatible With Secondary Licenses” Notice
+
+      This Source Code Form is “Incompatible
+      With Secondary Licenses”, as defined by
+      the Mozilla Public License, v. 2.0.

data/lib/core/loader/context.rb

@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+
+require "pathname"
+
+require "core/define/location"
+
+module Core
+  module Loader
+    # [public]
+    #
+    class Context < BasicObject
+      def initialize(path:, root:, type:, target:)
+        @path = ::Kernel.Pathname(path)
+        @root = ::Kernel.Pathname(root)
+        @type = type.to_sym
+        @target = target
+      end
+
+      # [public]
+      #
+      def load
+        ::Kernel.eval(@path.read, ::Kernel.binding, @path.to_s)
+      end
+
+      def self.const_missing(name)
+        ::Object.const_get(name)
+      end
+
+      def method_missing(definable, *name, **kwargs, &block)
+        if @target.makes?(definable)
+          unless definable == @type
+            ::Kernel.raise "expected to define an object of type `#{@type}` but was `#{definable}` (#{@path})"
+          end
+
+          definable_path = ::Kernel.Pathname(@path.to_s.gsub(@root.to_s, ""))
+          expected_name = definable_path.dirname.join(
+            definable_path.basename(definable_path.extname)
+          ).to_s.split("/").reject(&:empty?).compact.map(&:to_sym)
+
+          if name.empty?
+            name = expected_name
+          elsif name != expected_name
+            ::Kernel.raise "expected to define an object named `#{expected_name.join(", ")}` but was `#{name.join(", ")}` (#{@path})"
+          end
+
+          path, line = ::Kernel.caller(1..1).first.split(":", 3)
+          location = ::Core::Define::Location.new(path: path, line: line)
+          defined = @target.make(definable, *name, __location__: location, **kwargs)
+
+          # TODO: Validate that definition name matches the expectation, and that it's the expected type.
+
+          if block
+            header = @path.read.each_line.take(block.source_location[1] - 1).join
+            source = extract_block_inner_source(block, @path)
+
+            type = case defined
+            when ::Class
+              "class"
+            when ::Module
+              "module"
+            end
+
+            eval_source = <<~SOURCE
+              #{header}#{type} #{defined}#{source}
+              end
+            SOURCE
+
+            ::Kernel.eval(eval_source, ::Kernel.const_get("TOPLEVEL_BINDING"), @path.to_s)
+          end
+
+          defined
+        else
+          ::Kernel.public_send(definable, *name, **kwargs, &block)
+        end
+      end
+
+      def respond_to_missing?(definable, include_private = false)
+        @target.makes?(definable) || ::Kernel.respond_to?(definable, include_private)
+      end
+
+      private def extract_block_inner_source(block, path)
+        source = extract_block_source(block, path).strip
+
+        if source.end_with?("end")
+          scan_to_complete_expression(source, "do", -4, path)
+        elsif source.end_with?("}")
+          scan_to_complete_expression(source, "{", -2, path)
+        else
+          # We should never get here, but raise an error just to be clear.
+          #
+          ::Kernel.raise "could not parse inner source of `#{path}`"
+        end
+      end
+
+      private def extract_block_source(block, path)
+        lineno = block.source_location[1]
+        lines = path.each_line.to_a[(lineno - 1)..]
+
+        lines.count.times do |index|
+          possible_source = lines.take(index + 1).join
+
+          if complete_expression?(possible_source)
+            return possible_source
+          end
+        end
+
+        # We should never get here, but raise an error just to be clear.
+        #
+        ::Kernel.raise "could not find a complete expression in `#{path}`"
+      end
+
+      private def scan_to_complete_expression(source, matcher, ending_offset, path)
+        source.scan(matcher) do
+          offset = $~.offset(0)[0] + 2
+
+          possible_inner_source = source[offset..ending_offset]
+
+          if complete_expression?(possible_inner_source)
+            return possible_inner_source
+          end
+        end
+
+        # We should never get here, but raise an error just to be clear.
+        #
+        ::Kernel.raise "could not find a complete expression for `#{matcher}` in `#{path}`"
+      end
+
+      # Based on https://github.com/banister/method_source.
+      #
+      private def complete_expression?(string)
+        original_verbose = $VERBOSE
+        $VERBOSE = nil
+
+        ::Kernel.catch :valid do
+          ::Kernel.eval "BEGIN{throw :valid}\n#{string}" # standard:disable Style/EvalWithLocation
+        end
+
+        true
+      rescue ::SyntaxError
+        false
+      ensure
+        $VERBOSE = original_verbose
+      end
+    end
+  end
+end

data/lib/core/loader/version.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Core
+  module Loader
+    VERSION = "0.0.0"
+
+    # [public]
+    #
+    def self.version
+      VERSION
+    end
+  end
+end

data/lib/core/loader.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Core
+  module Loader
+    require_relative "loader/version"
+  end
+end

data/lib/is/loadable.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require "is/extension"
+require "is/stateful"
+
+require_relative "../core/loader/context"
+
+module Is
+  # [public]
+  #
+  module Loadable
+    extend Is::Extension
+
+    extends dependencies: [Is::Stateful]
+
+    extends :definition do
+      # [public]
+      #
+      def loads(definable, path, pattern: "*.rb")
+        unless ancestors.include?(Is::Factory) && makes?(definable)
+          raise "cannot load unknown object `#{definable}`"
+        end
+
+        __loads__[definable.to_sym] = {
+          type: definable,
+          path: Pathname(path),
+          pattern: pattern
+        }
+      end
+
+      # [public]
+      #
+      def load(reload: false)
+        loadable = []
+
+        __loads__.each_pair do |definable, options|
+          find_loadable_paths(options[:path], options, loadable)
+        end
+
+        while (loadable_path, loadable_options = loadable.shift)
+          if reload || !loaded?(loadable_path)
+            Core::Loader::Context.new(
+              path: loadable_path,
+              root: loadable_options[:path],
+              type: loadable_options[:type],
+              target: self
+            ).load
+
+            __loaded_paths__ << loadable_path
+          end
+        end
+      end
+
+      # [public]
+      #
+      def reload
+        load(reload: true)
+      end
+
+      # [public]
+      #
+      def reset
+        __loaded_paths__.clear
+      end
+
+      private def loaded?(path)
+        __loaded_paths__.include?(Pathname(path))
+      end
+
+      private def find_loadable_paths(path, options, loadable)
+        path.glob(options[:pattern]).sort.each do |each_path|
+          loadable << [each_path, options]
+        end
+
+        path.glob("*").select(&:directory?).sort.each do |each_path|
+          find_loadable_paths(each_path, options, loadable)
+        end
+      end
+    end
+
+    applies do
+      state :__loads__, :class, default: {}
+      state :__loaded_paths__, :class, default: []
+    end
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: core-loader
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Bryan Powell
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-11-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: core-extension
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: core-factory
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: core-state
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: Load Ruby objects from the filesystem.
+email: bryan@metabahn.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- lib/core/loader.rb
+- lib/core/loader/context.rb
+- lib/core/loader/version.rb
+- lib/is/loadable.rb
+homepage: https://github.com/metabahn/corerb/
+licenses:
+- MPL-2.0
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: Load Ruby objects from the filesystem.
+test_files: []