thinreports 0.7.7 → 0.8.0

data/lib/thinreports/core/shape/list/manager.rb

@@ -1,122 +1,154 @@
 # coding: utf-8
 
-module ThinReports
+module Thinreports
   module Core::Shape
-    
-    # @private
+
     class List::Manager
-      # @return [ThinReports::Core::Shape::List::Configuration]
+      include Utils
+
+      # @return [Thinreports::Core::Shape::List::Configuration]
       attr_reader :config
-      
-      # @return [ThinReports::Core::Shape:::List::Page]
+
+      # @return [Thinreports::Core::Shape:::List::Page]
       attr_reader :current_page
-      
-      # @return [ThinReports::Core::Shape::List::PageState]
+
+      # @return [Thinreports::Core::Shape::List::PageState]
       attr_reader :current_page_state
 
       # @return [Integer]
       attr_accessor :page_count
-      
-      # @param [ThinReports::Core::Shape::List::Page] page
+
+      # @return [Proc]
+      attr_accessor :page_finalize_handler
+
+      # @return [Proc]
+      attr_accessor :page_footer_handler
+
+      # @return [Proc]
+      attr_accessor :footer_handler
+
+      # @param [Thinreports::Core::Shape::List::Page] page
       def initialize(page)
         switch_current!(page)
 
-        @config     = init_config
-        @finalized  = false
+        @config = init_config
+        @finalized = false
         @page_count = 0
+
+        @page_finalize_handler = nil
+        @page_footer_handler = nil
+        @footer_handler = nil
       end
-      
-      # @param [ThinReports::Core::Shape::List::Page] page
-      # @return [ThinReports::Core::Shape::List::Manager]
+
+      # @param [Thinreports::Core::Shape::List::Page] page
+      # @return [Thinreports::Core::Shape::List::Manager]
       def switch_current!(page)
         @current_page       = page
         @current_page_state = page.internal
         self
       end
-      
+
       # @yield [new_list]
-      # @yieldparam [ThinReports::Core::Shape::List::Page] new_list
+      # @yieldparam [Thinreports::Core::Shape::List::Page] new_list
       def change_new_page(&block)
         finalize_page
         new_page = report.internal.copy_page
-        
+
         if block_given?
           block.call(new_page.list(current_page.id))
         end
       end
-      
-      # @see List::Page#header
-      def header(values = {}, &block)
+
+      # @param [Hash] values ({})
+      # @yield [header]
+      # @yieldparam [Thinreports::Core::Shape::List::SectionInterface] header
+      # @return [Thinreports::Core::Shape::List::SectionInterface]
+      # @raise [Thinreports::Errors::DisabledListSection]
+      def build_header(values = {}, &block)
         unless format.has_header?
-          raise ThinReports::Errors::DisabledListSection.new('header')
-        end        
+          raise Thinreports::Errors::DisabledListSection.new('header')
+        end
         current_page_state.header ||= init_section(:header)
-        build_section(current_page_state.header, values, &block)
+        build_section(header_section, values, &block)
+      end
+
+      # @return [Thinreports::Core::Shape::List::SectionInterface]
+      def header_section
+        current_page_state.header
       end
-      
+
       # @param (see #build_section)
       # @return [Boolean]
-      def insert_new_detail(values = {}, &block)
+      def add_detail(values = {}, &block)
         return false if current_page_state.finalized?
-        
+
         successful = true
-        
+
         if overflow_with?(:detail)
           if auto_page_break?
             change_new_page do |new_list|
-              new_list.manager.insert_new_row(:detail, values, &block)
+              new_list.manager.insert_detail(values, &block)
             end
           else
             finalize
             successful = false
           end
         else
-          insert_new_row(:detail, values, &block)
+          insert_detail(values, &block)
         end
         successful
       end
-      
-      # @see #build_section
-      def insert_new_row(section_name, values = {}, &block)
-        row = build_section(init_section(section_name), values, &block)
+
+      # @param values (see Thinreports::Core::Shape::Manager::Target#values)
+      # @yield [section,]
+      # @yieldparam [Thinreports::Core::Shape::List::SectionInterface] section
+      # @return [Thinreports::Core::Shape::List::SectionInterface]
+      def insert_detail(values = {}, &block)
+        detail = build_section(init_section(:detail), values, &block)
+        insert_row(detail)
+      end
+
+      # @param [Thinreports::Core::Shape::List::SectionInterface] row
+      # @return [Thinreports::Core::Shape::List::SectionInterface]
+      def insert_row(row)
         row.internal.move_top_to(current_page_state.height)
-        
+
         current_page_state.rows << row
         current_page_state.height += row.height
         row
       end
-      
-      # @param [ThinReports::Core::Shape::List::SectionInterface] section
-      # @param values (see ThinReports::Core::Shape::Manager::Target#values)
+
+      # @param [Thinreports::Core::Shape::List::SectionInterface] section
+      # @param values (see Thinreports::Core::Shape::Manager::Target#values)
       # @yield [section,]
-      # @yieldparam [ThinReports::Core::Shape::List::SectionInterface] section
-      # @return [ThinReports::Core::Shape::List::SectionInterface]
+      # @yieldparam [Thinreports::Core::Shape::List::SectionInterface] section
+      # @return [Thinreports::Core::Shape::List::SectionInterface]
       def build_section(section, values = {}, &block)
         section.values(values)
-        block_exec_on(section, &block)
+        call_block_in(section, &block)
       end
-      
+
       # @param [Symbol] section_name
-      # @return [ThinReports::Core::Shape::List::SectionInterface]
+      # @return [Thinreports::Core::Shape::List::SectionInterface]
       def init_section(section_name)
         List::SectionInterface.new(current_page,
                                    format.sections[section_name],
                                    section_name)
-      end      
-      
+      end
+
       # @param [Symbol] section_name
       # @return [Boolean]
       def overflow_with?(section_name = :detail)
         max_height = page_max_height
-        
+
         if section_name == :footer && format.has_page_footer?
           max_height += format.section_height(:page_footer)
         end
-        
+
         height = format.section_height(section_name)
         (current_page_state.height + height) > max_height
       end
-      
+
       # @return [Numeric]
       def page_max_height
         unless @page_max_height
@@ -127,103 +159,104 @@ module ThinReports
         end
         @page_max_height
       end
-      
-      # @return [ThinReports::Core::Shape::List::Store]
+
+      # @return [Thinreports::Core::Shape::List::Store]
       def store
         config.store
       end
-      
-      # @return [ThinReports::Core::Shape::List::Events]
+
+      # @return [Thinreports::Core::Shape::List::Events]
       def events
-        config.events
+        config.internal_events
       end
-      
+
       # @return [Boolean]
       def auto_page_break?
         format.auto_page_break?
       end
 
       # @param [Hash] options
-      # @option [Boolean] :ignore_page_footer (false)
-      #   When the switch of the page is generated by #finalize, it is used. 
-      # @private
+      # @option options [Boolean] :ignore_page_footer (false)
+      #   When the switch of the page is generated by #finalize, it is used.
       def finalize_page(options = {})
         return if current_page_state.finalized?
-        
-        if format.has_header?
-          current_page_state.header ||= init_section(:header)
-        end
-        
+
+        build_header if format.has_header?
+
         if !options[:ignore_page_footer] && format.has_page_footer?
-          footer = insert_new_row(:page_footer)
-          # Dispatch page-footer insert event.
+          page_footer = insert_row(init_section(:page_footer))
+
+          # [DEPRECATION] Use List::Interface#on_page_footer_insert instead.
           events.
             dispatch(List::Events::SectionEvent.new(:page_footer_insert,
-                                                    footer, store))
+                                                    page_footer, store))
+          # In 0.8 or later
+          @page_footer_handler.call(page_footer) if @page_footer_handler
         end
         current_page_state.finalized!
-        
-        # Dispatch page finalize event.
+
+        # [DEPRECATION] Use List::Interface#on_page_finalize instead.
         events.
           dispatch(List::Events::PageEvent.new(:page_finalize,
-                                               current_page, 
+                                               current_page,
                                                current_page_state.parent))
+        # In 0.8 or later
+        @page_finalize_handler.call if @page_finalize_handler
+
         @page_count += 1
         current_page_state.no = @page_count
       end
-      
-      # @private
+
       def finalize
         return if finalized?
-        
         finalize_page
-        
+
         if format.has_footer?
-          footer = nil
-          
+          footer = init_section(:footer)
+
+          # [DEPRECATION] Use List::Interface#on_footer_insert instead.
+          events.dispatch(List::Events::SectionEvent.new(:footer_insert, footer, store))
+
+          # In 0.8 or later
+          @footer_handler.call(footer) if @footer_handler
+
           if auto_page_break? && overflow_with?(:footer)
             change_new_page do |new_list|
-              footer = new_list.manager.insert_new_row(:footer)
-              new_list.manager.finalize_page(:ignore_page_footer => true)
+              new_list.manager.insert_row(footer)
+              new_list.manager.finalize_page(ignore_page_footer: true)
             end
           else
-            footer = insert_new_row(:footer)
+            insert_row(footer)
           end
-          # Dispatch footer insert event.
-          events.dispatch(List::Events::SectionEvent.new(:footer_insert,
-                                                         footer, store))
         end
         @finalized = true
       end
-      
+
       # @return [Boolean]
-      # @private
       def finalized?
         @finalized
-      end      
-      
-    private
-      
-      # @return [ThinReports::Report::Base]
+      end
+
+      # @return [Thinreports::Report::Base]
       def report
         current_page_state.parent.report
       end
-      
-      # @return [ThinReports::Layout::Base]
+
+      # @return [Thinreports::Layout::Base]
       def layout
         current_page_state.parent.layout
       end
-      
-      # @return [ThinReports::Core::Shape::List::Format]
+
+      # @return [Thinreports::Core::Shape::List::Format]
       def format
         current_page_state.format
       end
-      
-      # @return [ThinReports::Core::Shape::List::Configuration]
+
+      # @return [Thinreports::Core::Shape::List::Configuration]
       def init_config
         layout.config.activate(current_page.id) || List::Configuration.new
       end
     end
-    
+
   end
-end
+end

data/lib/thinreports/core/shape/list/page.rb

@@ -1,16 +1,18 @@
 # coding: utf-8
 
-module ThinReports
+module Thinreports
   module Core::Shape
-    
+
     class List::Page < Basic::Interface
-      # @param [ThinReports::Core::Page] parent
-      # @param [ThinReports::Core::Shape::Basic::Format] format
-      # @param [ThinReports::Core::Shape::List::PageState] internal (nil)
-      # @param [ThinReports::Core::Shape::List::Manager] manager (nil)
+      extend Forwardable
+
+      # @param [Thinreports::Report::Page] parent
+      # @param [Thinreports::Core::Shape::Basic::Format] format
+      # @param [Thinreports::Core::Shape::List::PageState] internal (nil)
+      # @param [Thinreports::Core::Shape::List::Manager] manager (nil)
       def initialize(parent, format, internal = nil, manager = nil)
         super(parent, format, internal)
-        
+
         @manager = if manager
           manager.switch_current!(self)
         else
@@ -20,24 +22,35 @@ module ThinReports
         # Set a reference to List::PageState List::Manager
         self.internal.manager = self.manager
       end
-      
-      # @param [Hash] values ({})
-      # @yield [header,]
-      # @yieldparam [ThinReports::Core::Shape::List::SectionInterface] header
-      # @return [ThinReports::Core::Shape::List::SectionInterface]
-      # @raise [ThinReports::Errors::DisabledListSection]
-      def header(values = {}, &block)
-        manager.header(values, &block)
+
+      # @see Thinreports::Core::Shape::List::Manager#build_header
+      def_delegator :manager, :build_header, :header
+
+      def on_page_finalize(&block)
+        manager.page_finalize_handler = block
       end
-      
+
+      # @yield [page_footer]
+      # @yieldparam [Thinreports::Core::Shape::List::SectionInterface] page_footer
+      def on_page_footer_insert(&block)
+        manager.page_footer_handler = block
+      end
+
+      # @yield [footer]
+      # @yieldparam [Thinreports::Core::Shape::List::SectionInterface] footer
+      # @return [Thinreports::Core::Shape::List::SectionInterface]
+      def on_footer_insert(&block)
+        manager.footer_handler = block
+      end
+
       # @param [Hash] values ({})
       # @yield [row,]
-      # @yieldparam [ThinReports::Core::Shape::List::SectionInterface] row
+      # @yieldparam [Thinreports::Core::Shape::List::SectionInterface] row
       # @return [Boolean]
       def add_row(values = {}, &block)
-        manager.insert_new_detail(values, &block)
+        manager.add_detail(values, &block)
       end
-      
+
       # If enabled, the auto-page-break of the list will force a page break
       # at the time this method is called. Otherwise, this list will be finalized.
       def page_break
@@ -48,44 +61,37 @@ module ThinReports
         end
       end
       alias_method :finalize, :page_break
-      
-      # @return [Boolean] If overfilling the list to insert a detail row
-      #   or already finalized, return the true. Otherwise false.
+
+      # @return [Boolean] Returns true if list has overflowed
+      #   when `list#add_row` is called at the next time.
       def overflow?
-        finalized? || manager.overflow_with?(:detail)
+        manager.overflow_with?(:detail)
       end
-      
-      # @return [Boolean] Return the true,
-      #   if the current page of list is already finalized.
-      def finalized?
-        internal.finalized?
-      end
-      
-      # @return [ThinReports::Core::Shape::List::Configuration]
+
+      # @return [Thinreports::Core::Shape::List::Configuration]
       def config
         manager.config
       end
-            
-      # @return [ThinReports::Core::Shape::List::Store]
+
+      # @return [Thinreports::Core::Shape::List::Store]
       def store
         config.store
       end
-      
-      # @return [ThinReports::Core::Shape::List::Events]
+
+      # @return [Thinreports::Core::Shape::List::Events]
       def events
         config.events
       end
-      
-      # @param [ThinReports::Core::Page] new_parent
-      # @return [ThinReports::Core::Shape::List::Page]
-      # @private
+
+      # @param [Thinreports::Report::Page] new_parent
+      # @return [Thinreports::Core::Shape::List::Page]
       def copy(new_parent)
         if manager.auto_page_break?
           new_list = self.class.new(new_parent, internal.format,
                                     nil, manager)
         else
           manager.finalize
-          
+
           new_list = self.class.new(new_parent, internal.format,
                                     internal.copy(new_parent), manager)
           internal.rows.each do |row|
@@ -93,30 +99,28 @@ module ThinReports
           end
           new_list.finalized!
         end
-        
+
         if internal.format.has_header?
           new_list.internal.header = internal.header.copy(new_list)
         end
         new_list
       end
-      
-      # @private
+
       def manager
         @manager
       end
-      
+
     private
-      
-      # @see ThinReports::Core::Shape::Base::Interface#init_internal
+
+      # @see Thinreports::Core::Shape::Base::Interface#init_internal
       def init_internal(parent, format)
         List::PageState.new(parent, format)
       end
     end
-    
+
     # Alias to List::Page.
-    # @see ThinReports::Core::Shape::List::Page
-    # @private
+    # @see Thinreports::Core::Shape::List::Page
     List::Interface = List::Page
-    
+
   end
 end