require 'fileutils'

require 'pdk'
require 'pdk/logger'
require 'pdk/module/metadata'
require 'pdk/module/templatedir'
require 'pdk/template_file'
require 'pdk/util/filesystem'

module PDK
  module Generate
    class PuppetObject
      attr_reader :module_dir
      attr_reader :object_name
      attr_reader :options

      # Initialises the PDK::Generate::PuppetObject object.
      #
      # In general, this object should never be instantiated directly. Instead,
      # one of the subclasses should be used e.g. PDK::Generate::Klass.
      #
      # New subclasses generally only need to inherit this class, set the
      # OBJECT_TYPE constant and implement the {#template_data},
      # {#target_object_path} and {#target_spec_path} methods.
      #
      # @param module_dir [String] The path to the module directory that the
      #   will contain the object.
      # @param object_name [String] The name of the object.
      # @param options [Hash{Symbol => Object}]
      #
      # @api public
      def initialize(module_dir, object_name, options)
        @module_dir = module_dir
        @options = options
        @object_name = object_name

        if [:class, :defined_type].include?(object_type) # rubocop:disable Style/GuardClause
          object_name_parts = object_name.split('::')

          @object_name = if object_name_parts.first == module_name
                           object_name
                         else
                           [module_name, object_name].join('::')
                         end
        end
      end

      def spec_only?
        @options[:spec_only]
      end

      # @abstract Subclass and implement {#template_data} to provide data to
      #   the templates during rendering. Implementations of this method should
      #   return a Hash!{Symbol => Object}.
      def template_data
        raise NotImplementedError
      end

      # @abstract Subclass and implement {#target_object_path}. Implementations
      #   of this method should return a String containing the destination path
      #   of the object being generated.
      def target_object_path
        raise NotImplementedError
      end

      # @abstract Subclass and implement {#target_type_path}. Implementations
      #   of this method should return a String containing the destination path
      #   of the additional object file being generated.
      # @return [String] returns nil if there is no additional object file
      def target_type_path
        nil
      end

      # @abstract Subclass and implement {#target_spec_path}. Implementations
      #   of this method should return a String containing the destination path
      #   of the tests for the object being generated.
      def target_spec_path
        raise NotImplementedError
      end

      # @abstract Subclass and implement {#target_type_spec_path}. Implementations
      #   of this method should return a String containing the destination path
      #   of the tests for the object being generated.
      def target_type_spec_path
        nil
      end

      # @abstract Subclass and implement {#target_device_path}. Implementations
      #   of this method should return a String containing the destination path
      #   of the device class being generated.
      def target_device_path
        nil
      end

      # Retrieves the type of the object being generated, e.g. :class,
      # :defined_type, etc. This is specified in the subclass' OBJECT_TYPE
      # constant.
      #
      # @return [Symbol] the type of the object being generated.
      #
      # @api private
      def object_type
        self.class::OBJECT_TYPE
      end

      # Retrieves the type of the object being generated as represented in
      # the JSON output of puppet-strings.
      #
      # @return [String] the type of the object being generated or nil if
      #   there is no mapping.
      #
      # @api private
      def self.puppet_strings_type
        return nil unless const_defined?(:PUPPET_STRINGS_TYPE)

        self::PUPPET_STRINGS_TYPE
      end

      # Returns an array of possible target path strings.
      def targets
        targets = [
          target_spec_path,
          target_type_spec_path,
        ]

        unless spec_only?
          targets += [
            target_object_path,
            target_type_path,
            target_device_path,
          ]
        end

        targets.compact
      end

      # Check preconditions of this template group. By default this only makes sure that the target files do not
      # already exist. Override this (and call super) to add your own preconditions.
      #
      # @raise [PDK::CLI::ExitWithError] if the target files already exist.
      #
      # @api public
      def check_preconditions
        targets.each do |target_file|
          next unless File.exist?(target_file)

          raise PDK::CLI::ExitWithError, _("Unable to generate %{object_type}; '%{file}' already exists.") % {
            file:        target_file,
            object_type: spec_only? ? 'unit test' : object_type,
          }
        end
      end

      # Check that the templates can be rendered. Find an appropriate template
      # and create the target files from the template. This is the main entry
      # point for the class.
      #
      # @raise [PDK::CLI::ExitWithError] if the target files already exist.
      # @raise [PDK::CLI::FatalError] (see #render_file)
      #
      # @api public
      def run
        check_preconditions

        with_templates do |template_path, config_hash|
          data = template_data.merge(configs: config_hash)

          render_file(target_object_path, template_path[:object], data) unless spec_only?
          render_file(target_type_path, template_path[:type], data) if template_path[:type]
          render_file(target_device_path, template_path[:device], data) if template_path[:device]
          render_file(target_spec_path, template_path[:spec], data) if template_path[:spec]
          render_file(target_type_spec_path, template_path[:type_spec], data) if template_path[:type_spec]
        end
      end

      # Render a file using the provided template and write it to disk.
      #
      # @param dest_path [String] The path that the rendered file should be
      #   written to. Any necessary directories will be automatically created.
      # @param template_path [String] The path on disk to the file containing
      #   the template.
      # @param data [Hash{Object => Object}] The data to be provided to the
      #   template when rendering.
      #
      # @raise [PDK::CLI::FatalError] if the parent directories to `dest_path`
      #   do not exist and could not be created.
      # @raise [PDK::CLI::FatalError] if the rendered file could not be written
      #   to `dest_path`.
      #
      # @return [void]
      #
      # @api private
      def render_file(dest_path, template_path, data)
        write_file(dest_path) do
          PDK::TemplateFile.new(template_path, data).render
        end
      end

      # Write the result of the block to disk.
      #
      # @param dest_path [String] The path that the rendered file should be
      #   written to. Any necessary directories will be automatically created.
      # @param &block [String] The content to be written
      #
      # @raise [PDK::CLI::FatalError] if the parent directories to `dest_path`
      #   do not exist and could not be created.
      # @raise [PDK::CLI::FatalError] if the rendered file could not be written
      #   to `dest_path`.
      #
      # @return [void]
      #
      # @api private
      def write_file(dest_path)
        PDK.logger.info(_("Creating '%{file}' from template.") % { file: dest_path })

        file_content = yield

        begin
          FileUtils.mkdir_p(File.dirname(dest_path))
        rescue SystemCallError => e
          raise PDK::CLI::FatalError, _("Unable to create directory '%{path}': %{message}") % {
            path:    File.dirname(dest_path),
            message: e.message,
          }
        end

        PDK::Util::Filesystem.write_file(dest_path, file_content)
      rescue SystemCallError => e
        raise PDK::CLI::FatalError, _("Unable to write to file '%{path}': %{message}") % {
          path:    dest_path,
          message: e.message,
        }
      end

      # Search the possible template directories in order of preference to find
      # a template that can be used to render a new object of the specified
      # type.
      #
      # @yieldparam template_paths [Hash{Symbol => String}] :object contains
      #   the path on disk to the template file for the object, :spec contains
      #   the path on disk to the template file for the tests for the object
      #   (if it exists).
      # @yieldparam config_hash [Hash{Object => Object}] the contents of the
      #   :global key in the config_defaults.yml file.
      #
      # @raise [PDK::CLI::FatalError] if no suitable template could be found.
      #
      # @api private
      def with_templates
        templates.each do |template|
          if template[:uri].nil?
            PDK.logger.debug(_('No %{dir_type} template found; trying next template directory.') % { dir_type: template[:type] })
            next
          end

          PDK::Module::TemplateDir.new(PDK::Util::TemplateURI.new(template[:uri])) do |template_dir|
            template_paths = template_dir.object_template_for(object_type)

            if template_paths
              config_hash = template_dir.object_config
              yield template_paths, config_hash
              # TODO: refactor to a search-and-execute form instead
              return # work is done # rubocop:disable Lint/NonLocalExitFromIterator
            elsif template[:allow_fallback]
              PDK.logger.debug(_('Unable to find a %{type} template in %{url}; trying next template directory.') % { type: object_type, url: template[:uri] })
            else
              raise PDK::CLI::FatalError, _('Unable to find the %{type} template in %{url}.') % { type: object_type, url: template[:uri] }
            end
          end
        end
      rescue ArgumentError => e
        raise PDK::CLI::ExitWithError, e
      end

      # Provides the possible template directory locations in the order in
      # which they should be searched for a valid template.
      #
      # If a template-url has been specified on in the options hash (e.g. from
      # a CLI parameter), then this template directory will be checked first
      # and we do not fall back to the next possible template directory.
      #
      # If we have not been provided a specific template directory to use, we
      # try the template specified in the module metadata (as set during
      # PDK::Generate::Module) and fall back to the default template if
      # necessary.
      #
      # @return [Array<Hash{Symbol => Object}>] an array of hashes. Each hash
      #   contains 3 keys: :type contains a String that describes the template
      #   directory, :url contains a String with the URL to the template
      #   directory, and :allow_fallback contains a Boolean that specifies if
      #   the lookup process should proceed to the next template directory if
      #   the template file is not in this template directory.
      #
      # @api private
      def templates
        @templates ||= PDK::Util::TemplateURI.templates(@options)
      end

      # Retrieves the name of the module (without the forge username) from the
      # module metadata.
      #
      # @raise (see #module_metadata)
      # @return [String] The name of the module.
      #
      # @api private
      def module_name
        @module_name ||= module_metadata.data['name'].rpartition('-').last
      end

      # Parses the metadata.json file for the module.
      #
      # @raise [PDK::CLI::FatalError] if the metadata.json file does not exist,
      #   can not be read, or contains invalid metadata.
      #
      # @return [PDK::Module::Metadata] the parsed module metadata.
      #
      # @api private
      def module_metadata
        @module_metadata ||= begin
          PDK::Module::Metadata.from_file(File.join(module_dir, 'metadata.json'))
        rescue ArgumentError => e
          raise PDK::CLI::FatalError, _("'%{dir}' does not contain valid Puppet module metadata: %{msg}") % { dir: module_dir, msg: e.message }
        end
      end

      # transform a object name into a ruby class name
      def self.class_name_from_object_name(object_name)
        object_name.to_s.split('_').map(&:capitalize).join
      end
    end
  end
end