thinreports 0.9.1 → 0.11.0

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

@@ -1,226 +1,229 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 module Thinreports
-  module Core::Shape
+  module Core
+    module Shape
+      module List
+        class Manager
+          include Utils
 
-    class List::Manager
-      include Utils
+          # @return [Thinreports::Core::Shape:::List::Page]
+          attr_reader :current_page
 
-      # @return [Thinreports::Core::Shape:::List::Page]
-      attr_reader :current_page
+          # @return [Thinreports::Core::Shape::List::PageState]
+          attr_reader :current_page_state
 
-      # @return [Thinreports::Core::Shape::List::PageState]
-      attr_reader :current_page_state
+          # @return [Integer]
+          attr_accessor :page_count
 
-      # @return [Integer]
-      attr_accessor :page_count
+          # @return [Proc]
+          attr_accessor :page_finalize_handler
 
-      # @return [Proc]
-      attr_accessor :page_finalize_handler
+          # @return [Proc]
+          attr_accessor :page_footer_handler
 
-      # @return [Proc]
-      attr_accessor :page_footer_handler
+          # @return [Proc]
+          attr_accessor :footer_handler
 
-      # @return [Proc]
-      attr_accessor :footer_handler
+          # @param [Thinreports::Core::Shape::List::Page] page
+          def initialize(page)
+            switch_current!(page)
 
-      # @param [Thinreports::Core::Shape::List::Page] page
-      def initialize(page)
-        switch_current!(page)
+            @finalized = false
+            @page_count = 0
 
-        @finalized = false
-        @page_count = 0
+            @page_finalize_handler = nil
+            @page_footer_handler = nil
+            @footer_handler = nil
+          end
 
-        @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]
+          def switch_current!(page)
+            @current_page = page
+            @current_page_state = page.internal
+            self
+          end
 
-      # @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
+          def change_new_page(&block)
+            finalize_page
+            new_page = report.internal.copy_page
 
-      # @yield [new_list]
-      # @yieldparam [Thinreports::Core::Shape::List::Page] new_list
-      def change_new_page(&block)
-        finalize_page
-        new_page = report.internal.copy_page
+            block.call(new_page.list(current_page.id)) if block_given?
+          end
 
-        if block_given?
-          block.call(new_page.list(current_page.id))
-        end
-      end
+          # @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)
+            raise Thinreports::Errors::DisabledListSection, 'header' unless format.has_header?
 
-      # @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
-        current_page_state.header ||= init_section(:header)
-        build_section(header_section, values, &block)
-      end
+            current_page_state.header ||= init_section(:header)
+            build_section(header_section, values, &block)
+          end
 
-      # @return [Thinreports::Core::Shape::List::SectionInterface]
-      def header_section
-        current_page_state.header
-      end
+          # @return [Thinreports::Core::Shape::List::SectionInterface]
+          def header_section
+            current_page_state.header
+          end
 
-      # @param (see #build_section)
-      # @return [Boolean]
-      def add_detail(values = {}, &block)
-        return false if current_page_state.finalized?
+          # @param (see #build_section)
+          # @return [Boolean]
+          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_detail(values, &block)
+                end
+              else
+                finalize
+                successful = false
+              end
+            else
+              insert_detail(values, &block)
+            end
+            successful
+          end
 
-        successful = true
+          # @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
 
-        if overflow_with?(:detail)
-          if auto_page_break?
-            change_new_page do |new_list|
-              new_list.manager.insert_detail(values, &block)
-            end
-          else
-            finalize
-            successful = false
+          # @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
-        else
-          insert_detail(values, &block)
-        end
-        successful
-      end
 
-      # @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] 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]
+          def build_section(section, values = {}, &block)
+            section.values(values)
+            call_block_in(section, &block)
+          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)
+          # @param [Symbol] section_name
+          # @return [Thinreports::Core::Shape::List::SectionInterface]
+          def init_section(section_name)
+            List::SectionInterface.new(current_page,
+                                       format.sections[section_name],
+                                       section_name)
+          end
 
-        current_page_state.rows << row
-        current_page_state.height += row.height
-        row
-      end
+          # @param [Symbol] section_name
+          # @return [Boolean]
+          def overflow_with?(section_name = :detail)
+            max_height = page_max_height
 
-      # @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]
-      def build_section(section, values = {}, &block)
-        section.values(values)
-        call_block_in(section, &block)
-      end
+            max_height += format.section_height(:page_footer) if section_name == :footer && format.has_page_footer?
 
-      # @param [Symbol] section_name
-      # @return [Thinreports::Core::Shape::List::SectionInterface]
-      def init_section(section_name)
-        List::SectionInterface.new(current_page,
-                                   format.sections[section_name],
-                                   section_name)
-      end
+            height = format.section_height(section_name)
+            (current_page_state.height + height) > max_height
+          end
 
-      # @param [Symbol] section_name
-      # @return [Boolean]
-      def overflow_with?(section_name = :detail)
-        max_height = page_max_height
+          # @return [Numeric]
+          def page_max_height
+            @page_max_height ||= begin
+              h = format.height
+              h -= format.section_height(:page_footer)
+              h -= format.section_height(:footer) unless auto_page_break?
+              h
+            end
+          end
 
-        if section_name == :footer && format.has_page_footer?
-          max_height += format.section_height(:page_footer)
-        end
+          # @return [Boolean]
+          def auto_page_break?
+            format.auto_page_break?
+          end
 
-        height = format.section_height(section_name)
-        (current_page_state.height + height) > max_height
-      end
+          # @param [Hash] options
+          # @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?
 
-      # @return [Numeric]
-      def page_max_height
-        @page_max_height ||= begin
-          h  = format.height
-          h -= format.section_height(:page_footer)
-          h -= format.section_height(:footer) unless auto_page_break?
-          h
-        end
-      end
+            build_header if format.has_header?
 
-      # @return [Boolean]
-      def auto_page_break?
-        format.auto_page_break?
-      end
+            finalize_page_footer unless options[:ignore_page_footer]
 
-      # @param [Hash] options
-      # @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?
+            current_page_state.finalized!
+            @page_finalize_handler.call if @page_finalize_handler
 
-        build_header if format.has_header?
+            @page_count += 1
+            current_page_state.no = @page_count
+          end
 
-        if !options[:ignore_page_footer] && format.has_page_footer?
-          page_footer = insert_row(init_section(:page_footer))
-          @page_footer_handler.call(page_footer) if @page_footer_handler
-        end
+          def finalize_page_footer
+            return unless format.has_page_footer?
 
-        current_page_state.finalized!
-        @page_finalize_handler.call if @page_finalize_handler
+            page_footer = init_section(:page_footer)
+            insert_row(page_footer)
 
-        @page_count += 1
-        current_page_state.no = @page_count
-      end
+            @page_footer_handler.call(page_footer) if @page_footer_handler
+          end
 
-      def finalize
-        return if finalized?
-        finalize_page
+          def finalize
+            return if finalized?
+            finalize_page
 
-        if format.has_footer?
-          footer = init_section(:footer)
+            if format.has_footer?
+              footer = init_section(:footer)
 
-          @footer_handler.call(footer) if @footer_handler
+              @footer_handler.call(footer) if @footer_handler
 
-          if auto_page_break? && overflow_with?(:footer)
-            change_new_page do |new_list|
-              new_list.manager.insert_row(footer)
-              new_list.manager.finalize_page(ignore_page_footer: true)
+              if auto_page_break? && overflow_with?(:footer)
+                change_new_page do |new_list|
+                  new_list.manager.insert_row(footer)
+                  new_list.manager.finalize_page(ignore_page_footer: true)
+                end
+              else
+                insert_row(footer)
+              end
             end
-          else
-            insert_row(footer)
+            @finalized = true
           end
-        end
-        @finalized = true
-      end
 
-      # @return [Boolean]
-      def finalized?
-        @finalized
-      end
+          # @return [Boolean]
+          def finalized?
+            @finalized
+          end
 
-      # @return [Thinreports::Report::Base]
-      def report
-        current_page_state.parent.report
-      end
+          # @return [Thinreports::Report::Base]
+          def report
+            current_page_state.parent.report
+          end
 
-      # @return [Thinreports::Layout::Base]
-      def layout
-        current_page_state.parent.layout
-      end
+          # @return [Thinreports::Layout::Base]
+          def layout
+            current_page_state.parent.layout
+          end
 
-      # @return [Thinreports::Core::Shape::List::Format]
-      def format
-        current_page_state.format
+          # @return [Thinreports::Core::Shape::List::Format]
+          def format
+            current_page_state.format
+          end
+        end
       end
     end
-
   end
 end

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

@@ -1,112 +1,110 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 module Thinreports
-  module Core::Shape
-
-    class List::Page < Basic::Interface
-      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
-            List::Manager.new(self)
+  module Core
+    module Shape
+      module List
+        class Page < Basic::Interface
+          extend Forwardable
+
+          attr_reader :manager
+
+          # @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
+                List::Manager.new(self)
+              end
+
+            # Set a reference to List::PageState List::Manager
+            self.internal.manager = self.manager
           end
 
-        # Set a reference to List::PageState List::Manager
-        self.internal.manager = self.manager
-      end
-
-      # @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
+          # @see Thinreports::Core::Shape::List::Manager#build_header
+          def_delegator :manager, :build_header, :header
 
-      # @yield [page_footer]
-      # @yieldparam [Thinreports::Core::Shape::List::SectionInterface] page_footer
-      def on_page_footer_insert(&block)
-        manager.page_footer_handler = block
-      end
+          def on_page_finalize(&block)
+            manager.page_finalize_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
+          # @yield [page_footer]
+          # @yieldparam [Thinreports::Core::Shape::List::SectionInterface] page_footer
+          def on_page_footer_insert(&block)
+            manager.page_footer_handler = block
+          end
 
-      # @param [Hash] values ({})
-      # @yield [row,]
-      # @yieldparam [Thinreports::Core::Shape::List::SectionInterface] row
-      # @return [Boolean]
-      def add_row(values = {}, &block)
-        manager.add_detail(values, &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
 
-      # 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
-        if manager.auto_page_break?
-          manager.change_new_page
-        else
-          manager.finalize_page
-        end
-      end
-      alias_method :finalize, :page_break
+          # @param [Hash] values ({})
+          # @yield [row,]
+          # @yieldparam [Thinreports::Core::Shape::List::SectionInterface] row
+          # @return [Boolean]
+          def add_row(values = {}, &block)
+            manager.add_detail(values, &block)
+          end
 
-      # @return [Boolean] Returns true if list has overflowed
-      #   when `list#add_row` is called at the next time.
-      def overflow?
-        manager.overflow_with?(:detail)
-      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
+            if manager.auto_page_break?
+              manager.change_new_page
+            else
+              manager.finalize_page
+            end
+          end
+          alias finalize page_break
 
-      # @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|
-            new_list.internal.rows << row.copy(new_list)
+          # @return [Boolean] Returns true if list has overflowed
+          #   when `list#add_row` is called at the next time.
+          def overflow?
+            manager.overflow_with?(:detail)
           end
-          new_list.finalized!
-        end
 
-        if internal.format.has_header?
-          new_list.internal.header = internal.header.copy(new_list)
-        end
-        new_list
-      end
+          # @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|
+                new_list.internal.rows << row.copy(new_list)
+              end
+              new_list.internal.finalized!
+            end
+
+            new_list.internal.header = internal.header.copy(new_list) if internal.format.has_header?
+            new_list
+          end
 
-      def manager
-        @manager
-      end
+          private
 
-    private
+          # @see Thinreports::Core::Shape::Base::Interface#init_internal
+          def init_internal(parent, format)
+            List::PageState.new(parent, format)
+          end
+        end
 
-      # @see Thinreports::Core::Shape::Base::Interface#init_internal
-      def init_internal(parent, format)
-        List::PageState.new(parent, format)
+        # Alias to List::Page.
+        # @see Thinreports::Core::Shape::List::Page
+        List::Interface = List::Page
       end
     end
-
-    # Alias to List::Page.
-    # @see Thinreports::Core::Shape::List::Page
-    List::Interface = List::Page
-
   end
 end