usps-imis-api 0.13.9 → 0.14.1

data/lib/usps/imis/models.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module Usps
+  module Imis
+    # Namespace and routing registry for ActiveModel-backed iMIS wrappers.
+    # Subclass +Models::Base+ and declare +business_object+ to opt a Business
+    # Object into Model wrapping; +BusinessObject+ and +Query+ consult this
+    # registry to decide whether to wrap parsed responses.
+    #
+    module Models
+      @registry = {}
+
+      class << self
+        # Process-wide default +Api+ used when callers omit +api:+ on
+        # +find+ / +find_by+. Memoized lazily; assignment overrides.
+        #
+        attr_writer :default_api
+
+        def default_api = @default_api ||= Imis::Api.new
+
+        # Look up the registered Model class for an iMIS Business Object name.
+        # Returns +nil+ if none is registered.
+        #
+        def for_entity(name)
+          load!
+          @registry[name.to_s]
+        end
+
+        # All registered Business Object names, sorted.
+        #
+        def entity_names
+          load!
+          @registry.keys.sort
+        end
+
+        # Register a Model subclass under its +business_object_name+. Called
+        # from +Base.business_object+; tests can call +deregister+ for cleanup.
+        #
+        def register(klass) = @registry[klass.business_object_name] = klass
+
+        # Remove a Model subclass from the routing registry.
+        #
+        def deregister(name) = @registry.delete(name.to_s)
+
+        # Require all model files. Hand-written files at the top level go first
+        # (some — e.g. party.rb — require their own subdirectory). Auto-generated
+        # wrappers under generated/ are loaded next. Finally, files in associations/
+        # reopen previously-loaded classes to declare cross-model relationships;
+        # they're separated from generated/ so the generator doesn't clobber them.
+        #
+        # Deferred until first registry lookup so CLI startup (--help, --version)
+        # doesn't pay the cost of requiring several hundred model files.
+        #
+        # Trigger lazy load when callers reference a model constant directly
+        # (e.g. +Usps::Imis::Models::Party+) before any registry lookup has
+        # forced loading.
+        #
+        def const_missing(name)
+          return super if loaded? || skipped? || name == :Base
+
+          load!
+          const_get(name)
+        end
+
+        def load!
+          return if loaded? || skipped?
+
+          dir = File.expand_path('models', __dir__)
+          paths =
+            Dir[File.join(dir, '*.rb')] +
+            Dir[File.join(dir, 'generated', '*.rb')] +
+            Dir[File.join(dir, 'associations', '*.rb')]
+          paths
+            .reject { it.end_with?('models/base.rb') }
+            .map { it.sub(/\.rb$/, '') }
+            .each { require it }
+
+          @loaded = true
+        end
+
+        def skip!
+          @skipped = true
+        end
+
+        def loaded? = @loaded
+        def skipped? = @skipped
+      end
+    end
+  end
+end
+
+require_relative 'models/base'

data/lib/usps/imis/party_data.rb

@@ -1,10 +1,5 @@
 # frozen_string_literal: true
 
-require 'pp'
-require 'stringio'
-
-require_relative 'base_data'
-
 module Usps
   module Imis
     # Convenience wrapper for accessing specific properties within an API data response for the
@@ -79,7 +74,7 @@ module Usps
           when String, Integer, true, false then next
           end
 
-          if %w[Addresses AlternateIds CommunicationPreferences Emails Salutations].include?(key)
+          if %w[Addresses AlternateIds CommunicationPreferences Emails Phones Salutations].include?(key)
             hash[key] = value.map { format_extracted(it.to_h) }
           elsif value.all?(String)
             # Do nothing

data/lib/usps/imis/query.rb

@@ -153,7 +153,11 @@ module Usps
         end
       end
 
-      def wrap(data) = query_name == 'Party' ? Imis::PartyData[data] : Imis::Data[data]
+      def wrap(data)
+        wrapped = query_name == 'Party' ? Imis::PartyData[data] : Imis::Data[data]
+        model_klass = Imis::Models.for_entity(query_name)
+        model_klass ? model_klass.from_data(wrapped, api:) : wrapped
+      end
     end
   end
 end

data/lib/usps/imis/version.rb

@@ -2,6 +2,6 @@
 
 module Usps
   module Imis
-    VERSION = '0.13.9'
+    VERSION = '0.14.1'
   end
 end

data/lib/usps/imis.rb

@@ -1,31 +1,22 @@
 # frozen_string_literal: true
 
-# Core dependencies
-require 'net/https'
-require 'json'
-require 'yaml'
-require 'time'
-require 'cgi'
+require_relative 'imis/dependencies'
 
-require 'active_support/core_ext/string/inflections'
-require 'active_support/core_ext/object/to_query'
-require 'active_support/core_ext/enumerable'
-require 'active_support/core_ext/module/delegation'
-require 'active_support/string_inquirer'
-require 'active_support/duration'
-require 'logger'
-require 'active_support/isolated_execution_state' # Fix constant loading issue with TaggedLogging
-require 'active_support/tagged_logging'
-
-require 'dotenv/load'
-
-# Internal requires
+# Shared infrastructure (used by multiple files below)
 require_relative 'imis/helpers'
+require_relative 'imis/requests'
+require_relative 'imis/logger_formatter'
+require_relative 'imis/logger_helpers'
+require_relative 'imis/base_data'
+require_relative 'imis/data'
+require_relative 'imis/party_data'
+
 require_relative 'imis/config'
 require_relative 'imis/error'
 require_relative 'imis/api'
 require_relative 'imis/properties'
 require_relative 'imis/blank_object'
+require_relative 'imis/models'
 require_relative 'imis/panels'
 require_relative 'imis/mocks'
 require_relative 'imis/version'

data/spec/support/usps/simple_cov_uncovered_lines_formatter.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+# Simple coverage formatter to display paths of any uncovered lines
+#
+# Intended to make it quicker to know what was uncovered, especially when
+# running in GitHub Actions
+#
+# Extracted from gem `usps-support`
+#
+# rubocop:disable RSpec/Output
+module Usps
+  class SimpleCovUncoveredLinesFormatter
+    attr_reader :uncovered_files
+
+    def format(result)
+      @uncovered_files = result.files.reject { it.missed_lines.empty? }
+      return unless uncovered_files.any?
+
+      puts 'Uncovered lines:'
+      uncovered_files.each { report(it) }
+    end
+
+  private
+
+    def report(file)
+      missed = pad(file.missed_lines.size)
+      total = pad(file.lines_of_code)
+      percent = file.covered_percent.round(2).to_s.rjust(5, ' ')
+
+      puts "  [#{missed} / #{total} : #{percent}%] #{file.filename}"
+      puts "    Lines: #{line_number_ranges(file).join(', ')}"
+    end
+
+    def pad(number) = number.to_s.rjust(max_line_count_length, ' ')
+
+    def max_line_count_length
+      @max_line_count_length ||= uncovered_files.map(&:lines_of_code).max.to_s.length
+    end
+
+    def line_number_ranges(file)
+      file
+        .missed_lines
+        .map(&:line_number)
+        .chunk
+        .with_index { |number, index| number - index }
+        .map do |_diff, group|
+          first, *, last = group
+          last.nil? ? first : "#{first}-#{last}"
+        end
+    end
+  end
+end
+# rubocop:enable RSpec/Output