require 'tap/support/batchable'
require 'tap/support/executable'
require 'tap/support/framework_class'

module Tap
  module Support
    
    # Framework encapsulates the basic framework functionality (batching,
    # configuration, documentation, etc) used by Task and Workflow. Note 
    # that Framework does NOT encapsulate the functionality needed to
    # make a class useful in workflows, such as enq and on_complete.
    module Framework
      include Batchable
      include Configurable
    
      def self.included(mod)
        mod.extend Support::BatchableClass
        mod.extend Support::ConfigurableClass
        mod.extend Support::FrameworkClass
      end
    
      # The application used to load config_file templates 
      # (and hence, to initialize batched objects).
      attr_reader :app
      
      # The name of self.
      attr_accessor :name
      
      # Initializes a new instance and associated batch objects.  Batch
      # objects will be initialized for each configuration template 
      # specified by app.each_config_template(config_file) where 
      # config_file = app.config_filepath(name).  
      def initialize(config={}, name=nil, app=App.instance)
        super()
        @app = app
        @name = name || self.class.default_name
        initialize_config(config)
      end
      
      # Creates a new batched object and adds the object to batch. The batched object 
      # will be a duplicate of the current object but with a new name and/or 
      # configurations.
      def initialize_batch_obj(overrides={}, name=nil)
        obj = super().reconfigure(overrides)
        obj.name = name if name
        obj 
      end
      
      # Logs the inputs to the application logger (via app.log)
      def log(action, msg="", level=Logger::INFO)
        # TODO - add a task identifier?
        app.log(action, msg, level)
      end

      # Raises a TerminateError if app.state == State::TERMINATE.
      # check_terminate may be called at any time to provide a 
      # breakpoint in long-running processes.
      def check_terminate
        if app.state == App::State::TERMINATE
          raise App::TerminateError.new
        end
      end
      
      # Returns self.name
      def to_s
        name
      end
      
    end
  end
end