windoo 1.0.1

data/lib/windoo/zeitwerk_config.rb

@@ -0,0 +1,158 @@
+# Copyright 2025 Pixar
+#
+#    Licensed under the terms set forth in the LICENSE.txt file available at
+#    at the root of this project.
+
+# frozen_string_literal: true
+
+# Gems
+######
+require 'pathname'
+require 'zeitwerk'
+
+# Windoo's Zeitwerk Config and processes
+module WindooZeitwerkConfig
+
+  # touch this file to make zeitwerk and mixins send text to stderr as things load
+  # or get mixed in
+  VERBOSE_LOADING_FILE = Pathname.new('/tmp/windoo-verbose-loading')
+
+  # Or, set this ENV var to also make zeitverk and mixins send text to stderr
+  VERBOSE_LOADING_ENV = 'WINDOO_VERBOSE_LOADING'
+
+  # touch this file to make zeitwek  eager-load everything when the gem is required.
+  EAGER_LOAD_FILE = Pathname.new('/tmp/windoo-zeitwerk-eager-load')
+
+  # Only look at the filesystem once.
+  def self.verbose_loading?
+    return @verbose_loading unless @verbose_loading.nil?
+
+    @verbose_loading = VERBOSE_LOADING_FILE.file?
+    @verbose_loading ||= ENV.include? VERBOSE_LOADING_ENV
+    @verbose_loading
+  end
+
+  # rubocop: disable Style/StderrPuts
+  def self.load_msg(msg)
+    $stderr.puts msg if verbose_loading?
+  end
+  # rubocop: enable Style/StderrPuts
+
+  # The loader object for Windoo
+  def self.loader
+    @loader
+  end
+
+  # Configure the Zeitwerk loader, See https://github.com/fxn/zeitwerk
+  # This all has to happen before the first 'module Windoo' declaration
+  def self.setup_zeitwerk_loader(zloader)
+    @loader = zloader
+
+    ##### Ingored Paths
+    ################################
+    #
+    # These should be ignored, some will be required directly
+    ###############################################
+
+    # Ignore this file
+    ####
+    loader.ignore __FILE__
+
+    # ignore files at the top level
+    ####
+    Pathname.new(__dir__).parent
+    # loader.ignore "#{top}/some_top_level_file.rb"
+
+    # ignore things that are manually loaded by our code
+    ####
+    loader.ignore "#{__dir__}/exceptions.rb"
+
+    ##### Collaped Paths
+    ################################
+    #
+    # these paths all define classes & modules directly below 'Jamf'
+    # If we didn't collapse them, then e.g.
+    #   /jamf/api/base_classes/classic/group.rb
+    # would be expected to define
+    #   Jamf::Api::BaseClasses::Classic::Group
+    # rather than what we want:
+    #  Jamf::Group
+    ###################################################
+
+    loader.collapse("#{__dir__}/objects")
+
+    ##### Inflected Paths
+    ################################
+    #
+    # filenames => Constants, which don't adhere to zeitwerk's parsing standards.
+    #
+    # Mostly because the a filename like 'oapi_object' would be
+    # loaded by zeitwerk expecting it to define 'OapiObject', but it really
+    # defines 'OAPIObject'
+    ###############################################
+
+    loader.inflector.inflect 'json_object' => 'JSONObject'
+    loader.inflector.inflect 'api_collection' => 'APICollection'
+
+    ##### Callbacks
+    ################################
+
+    # callback for when a specific file/constant loads
+    # duplicate and uncomment this if desired to react to
+    # specific things loading
+    #####################################
+    # loader.on_load('Windoo::SomeClass') do |klass, abspath|
+    #   load_msg "I just loaded #{klass} from #{abspath}"
+    # end
+
+    # callback for when anything loads
+    #  - const_path is like "Windoo::SomeClass" or "Windoo::SomeClass::SOME_CONST_ARRY"
+    #  - value is the value that constant contains after loading,
+    #    e.g. the class Windoo::SomeClass for 'Windoo::SomeClass' or
+    #    an Array for the constant  "Windoo::SomeClass::SOME_CONST_ARRY"
+    #  - abspath is the full path to the file where the constant was loaded from.
+    #####################################
+    loader.on_load do |const_path, value, abspath|
+      load_msg "Zeitwerk just loaded #{value.class} '#{const_path}' from:\n  #{abspath}"
+
+      # Parse JSON_ATTRIBUTES into getters and setters for subclasses of
+      # JSONObject
+      #
+      # The class we just loaded must have this method and constant
+      # and the method must not have run already for the class or any superclass.
+      # This prevents running parse_oapi_properties again in subclasses that
+      # don't need to do that
+      if defined?(value::JSON_ATTRIBUTES)
+        parsed = value.parse_json_attributes
+        load_msg "Parsed JSON_ATTRIBUTES for #{value}" if parsed
+      end
+
+      # Generate the identifier list methods (.all_*) for subclasses of APIObject
+      # in the Classic API
+      # if value.is_a?(Class) && value.superclass == Jamf::APIObject
+
+      #   done = value.define_identifier_list_methods
+      #   load_msg "Defined identifier list methods for #{value}" if done
+      # end
+    end
+
+    # actually do the setup that was defined above
+    loader.setup
+  end # setup_zeitwerk_loader
+
+  # For testing the Zeitwrk Loader.
+  # Normally we want autoloading on demand,
+  # eager loading loads everything so we can see it
+  #
+  # To make this happen touch the file defined in ZEITWERK_EAGER_LOAD_FILE
+  # in jamf.rb
+  def self.eager_load_for_testing
+    return unless EAGER_LOAD_FILE.file?
+
+    loader.eager_load(force: true)
+    warn :loaded
+    # rescue Zeitwerk::NameError => e
+    #   warn e.message
+  end
+
+end # module ZeitwerkConfig

data/lib/windoo.rb

@@ -0,0 +1,56 @@
+# Copyright 2025 Pixar
+#
+#    Licensed under the terms set forth in the LICENSE.txt file available at
+#    at the root of this project.
+#
+
+# frozen_string_literal: true
+
+# Core Standard Libraries
+######
+require 'English'
+require 'time'
+
+# Other gems
+######
+require 'pixar-ruby-extensions'
+require 'faraday' # >= 0.17.0
+
+# Zeitwerk
+######
+
+# Configure the Zeitwerk loader, See https://github.com/fxn/zeitwerk
+# This also defines other methods related to loading
+require 'windoo/zeitwerk_config'
+
+# the `Zeitwerk::Loader.for_gem` creates the loader object, and must
+# happen in this file, so we pass it into a method defined in
+# zeitwerk_config
+#
+# BE CAREFUL - Do not load anything above here that
+# defines the Windoo:: module namespace!
+WindooZeitwerkConfig.setup_zeitwerk_loader Zeitwerk::Loader.for_gem
+
+# Zeitwerk
+######
+
+# Load windoo stuff here that we don't autoload with zeitwerk
+require 'windoo/exceptions'
+
+# The main module
+module Windoo
+
+  extend Windoo::Mixins::Loading
+  include Windoo::Mixins::Constants
+  extend Windoo::Mixins::Utility
+  extend Windoo::Mixins::DefaultConnection
+
+  # the single instance of our configuration object
+  def self.config
+    Windoo::Configuration.instance
+  end
+
+end # module Windoo
+
+# testing zeitwerk loading, if the correct file is present
+WindooZeitwerkConfig.eager_load_for_testing

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: windoo
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Chris Lasell
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-09-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pixar-ruby-extensions
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+description: 'Windoo provides a Ruby interface to the REST API of the [Jamf Title
+  Editor](https://docs.jamf.com/title-editor/documentation/About_Title_Editor.html),
+  formerly known as ''Kinobi''. The Title Editor is a ''patch source'' provided to
+  users of Jamf Pro that provides a way to manage macOS software titles and their
+  versions. Windoo allows ruby developers to interact with the Title Editor''s API
+  to automate tasks such as creating, updating, and managing patches and related resources.
+
+  '
+email: windoo@pixar.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE.txt
+- CHANGES.md
+files:
+- CHANGES.md
+- LICENSE.txt
+- README.md
+- lib/windoo.rb
+- lib/windoo/base_classes/array_manager.rb
+- lib/windoo/base_classes/criteria_manager.rb
+- lib/windoo/base_classes/criterion.rb
+- lib/windoo/base_classes/json_object.rb
+- lib/windoo/configuration.rb
+- lib/windoo/connection.rb
+- lib/windoo/connection/actions.rb
+- lib/windoo/connection/attributes.rb
+- lib/windoo/connection/connect.rb
+- lib/windoo/connection/constants.rb
+- lib/windoo/connection/token.rb
+- lib/windoo/converters.rb
+- lib/windoo/exceptions.rb
+- lib/windoo/mixins/api_collection.rb
+- lib/windoo/mixins/constants.rb
+- lib/windoo/mixins/default_connection.rb
+- lib/windoo/mixins/immutable.rb
+- lib/windoo/mixins/loading.rb
+- lib/windoo/mixins/patch/component.rb
+- lib/windoo/mixins/software_title/extension_attribute.rb
+- lib/windoo/mixins/utility.rb
+- lib/windoo/objects/capability.rb
+- lib/windoo/objects/capability_manager.rb
+- lib/windoo/objects/component.rb
+- lib/windoo/objects/component_criteria_manager.rb
+- lib/windoo/objects/component_criterion.rb
+- lib/windoo/objects/extension_attribute.rb
+- lib/windoo/objects/kill_app.rb
+- lib/windoo/objects/kill_app_manager.rb
+- lib/windoo/objects/patch.rb
+- lib/windoo/objects/patch_manager.rb
+- lib/windoo/objects/requirement.rb
+- lib/windoo/objects/requirement_manager.rb
+- lib/windoo/objects/software_title.rb
+- lib/windoo/validate.rb
+- lib/windoo/version.rb
+- lib/windoo/zeitwerk_config.rb
+homepage: https://github.com/PixarAnimationStudios/windoo
+licenses:
+- LicenseRef-LICENSE.txt
+metadata: {}
+post_install_message:
+rdoc_options:
+- "--title"
+- Windoo
+- "--line-numbers"
+- "--main"
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.11
+signing_key:
+specification_version: 4
+summary: Ruby interface to the REST API of the Jamf Title Editor, formerly known as
+  Kinobi.
+test_files: []