thinreports 0.12.0 → 0.13.0

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

@@ -1,229 +0,0 @@
-# frozen_string_literal: true
-
-module Thinreports
-  module Core
-    module Shape
-      module List
-        class Manager
-          include Utils
-
-          # @return [Thinreports::Core::Shape:::List::Page]
-          attr_reader :current_page
-
-          # @return [Thinreports::Core::Shape::List::PageState]
-          attr_reader :current_page_state
-
-          # @return [Integer]
-          attr_accessor :page_count
-
-          # @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)
-
-            @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]
-          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
-
-            block.call(new_page.list(current_page.id)) if block_given?
-          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?
-
-            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
-
-          # @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
-
-          # @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)
-          # @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 [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
-
-          # @param [Symbol] section_name
-          # @return [Boolean]
-          def overflow_with?(section_name = :detail)
-            max_height = page_max_height
-
-            max_height += format.section_height(:page_footer) if section_name == :footer && format.has_page_footer?
-
-            height = format.section_height(section_name)
-            (current_page_state.height + height) > max_height
-          end
-
-          # @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
-
-          # @return [Boolean]
-          def auto_page_break?
-            format.auto_page_break?
-          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?
-
-            build_header if format.has_header?
-
-            finalize_page_footer unless options[:ignore_page_footer]
-
-            current_page_state.finalized!
-            @page_finalize_handler.call if @page_finalize_handler
-
-            @page_count += 1
-            current_page_state.no = @page_count
-          end
-
-          def finalize_page_footer
-            return unless format.has_page_footer?
-
-            page_footer = init_section(:page_footer)
-            insert_row(page_footer)
-
-            @page_footer_handler.call(page_footer) if @page_footer_handler
-          end
-
-          def finalize
-            return if finalized?
-            finalize_page
-
-            if format.has_footer?
-              footer = init_section(:footer)
-
-              @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)
-                end
-              else
-                insert_row(footer)
-              end
-            end
-            @finalized = true
-          end
-
-          # @return [Boolean]
-          def finalized?
-            @finalized
-          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::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,110 +0,0 @@
-# frozen_string_literal: true
-
-module Thinreports
-  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
-
-          # @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
-          # @return [Boolean]
-          def add_row(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
-            if manager.auto_page_break?
-              manager.change_new_page
-            else
-              manager.finalize_page
-            end
-          end
-          alias finalize page_break
-
-          # @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
-
-          # @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
-
-          private
-
-          # @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
-        List::Interface = List::Page
-      end
-    end
-  end
-end

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

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-module Thinreports
-  module Core
-    module Shape
-      module List
-        class PageState < Basic::Internal
-          attr_reader :rows
-
-          attr_accessor :height
-          attr_accessor :header
-          attr_accessor :no
-          attr_accessor :manager
-
-          def initialize(*args)
-            super(*args)
-
-            @rows = []
-            @height = 0
-            @finalized = false
-
-            @header = nil
-          end
-
-          def style
-            @style ||= Style::Basic.new(format)
-          end
-
-          def finalized?
-            @finalized
-          end
-
-          def finalized!
-            @finalized = true
-          end
-
-          def type_of?(type_name)
-            type_name == List::TYPE_NAME
-          end
-        end
-
-        # Alias to List::PageState.
-        # @see Thinreports::Core::Shape::List::PageState
-        List::Internal = List::PageState
-      end
-    end
-  end
-end

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

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-module Thinreports
-  module Core
-    module Shape
-      module List
-        class SectionFormat < Shape::Manager::Format
-          config_reader :height
-          config_reader relative_left: %w[translate x],
-                        relative_top: %w[translate y]
-          config_reader :style
-
-          # For compatible 0.8.x format API
-          config_checker true, display: %w[enabled]
-
-          def initialize(*)
-            super
-            initialize_items(attributes['items'])
-          end
-
-          private
-
-          def initialize_items(item_schemas)
-            item_schemas.each do |item_schema|
-              id, type = item_schema.values_at 'id', 'type'
-              next if id.empty?
-
-              shapes[id.to_sym] = Core::Shape::Format(type).new(item_schema)
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-module Thinreports
-  module Core
-    module Shape
-      module List
-        class SectionInterface < Base::Interface
-          include Core::Shape::Manager::Target
-
-          undef_method :list
-          internal_delegators :height
-
-          # @param [Thinreports::Core::Shape::List::Page] parent
-          # @param [Thinreports::Core::Shape::List::SectionFormat] format
-          # @param [Symbol] section_name
-          def initialize(parent, format, section_name)
-            super(parent, format)
-            internal.section_name = section_name
-
-            initialize_manager(format) do |f|
-              Core::Shape::Interface(self, f)
-            end
-          end
-
-          # @param [Thinreports::Core::Shape::List::Page] parent
-          # @return [Thinreports::Core::Shape::List::SectionInterface]
-          def copy(parent)
-            new_sec = super
-            new_sec.internal.section_name = internal.section_name
-
-            manager.shapes.each do |id, shape|
-              new_sec.manager.shapes[id] = shape.copy(new_sec)
-            end
-            new_sec
-          end
-
-          private
-
-          # @param parent (see #initialize)
-          # @param format (see #initialize)
-          # @return [Thinreports::Core::Shape::List::SectionInternal]
-          def init_internal(parent, format)
-            List::SectionInternal.new(parent, format)
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module Thinreports
-  module Core
-    module Shape
-      module List
-        class SectionInternal < Base::Internal
-          format_delegators :height,
-                            :relative_left
-
-          # @return [Symbol]
-          attr_accessor :section_name
-
-          def style
-            @style ||= Style::Base.new(format)
-          end
-
-          # @param [Numeric] ry
-          def move_top_to(ry)
-            states[:relative_top] = ry
-          end
-
-          # @return [Float]
-          def relative_top
-            states[:relative_top] || 0
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module Thinreports
-  module Core
-    module Shape
-      module Manager
-        class Format < Core::Format::Base
-          # @return [Symbol, Integer]
-          attr_reader :identifier
-
-          def initialize(config, id = nil, &block)
-            super(config, &block)
-            @identifier = id || object_id
-          end
-
-          def find_shape(id)
-            shapes[id]
-          end
-
-          def has_shape?(id)
-            shapes.key?(id)
-          end
-
-          def shapes
-            @shapes ||= {}
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,107 +0,0 @@
-# frozen_string_literal: true
-
-module Thinreports
-  module Core
-    module Shape
-      module Manager
-        class Internal
-          include Utils
-
-          attr_reader :format
-          attr_reader :shapes
-          attr_reader :lists
-
-          # @param [Thinreports::Core::Manager::Format] format
-          # @param [Proc] init_item_handler
-          def initialize(format, init_item_handler)
-            @format = format
-            @shapes = {}
-            @lists = {}
-            @init_item_handler = init_item_handler
-          end
-
-          # @param [String, Symbol] id
-          # @return [Thinreports::Core::Shape::Basic::Format]
-          def find_format(id)
-            format.find_shape(id.to_sym)
-          end
-
-          # @param [String, Symbol] id
-          # @param limit (see #valid_type?)
-          def find_item(id, limit = {})
-            id = id.to_sym
-
-            if shapes.key?(id)
-              shape = shapes[id]
-              valid_type?(shape.type, limit) ? shape : nil
-            elsif find_format(id)
-              shape_format = find_format(id)
-              return nil unless valid_type?(shape_format.type, limit)
-
-              shape = init_item(shape_format)
-              shapes[id] = shape
-
-              shape
-            end
-          end
-
-          # @param [String, Symbol] id
-          # @return [Thinreports::Core::Shape::Base::Interface, nil]
-          def final_shape(id)
-            shape = shapes[id]
-
-            # When shape was found in registry.
-            if shape
-              return nil unless shape.visible?
-
-              # In the case of TextBlock or ImageBlock.
-              if shape.internal.type_of?(:block)
-                blank_value?(shape.internal.real_value) ? nil : shape
-              else
-                shape
-              end
-            # When shape was not found in registry.
-            elsif format.has_shape?(id)
-              shape_format = find_format(id)
-              return nil unless shape_format.display?
-
-              case shape_format.type
-              # In the case of TextBlock.
-              when TextBlock::TYPE_NAME
-                return nil if !shape_format.has_reference? && blank_value?(shape_format.value)
-                init_item(shape_format)
-              # In the case of ImageBlock, Return the nil constantly.
-              when ImageBlock::TYPE_NAME
-                nil
-              else
-                init_item(shape_format)
-              end
-            end
-          end
-
-          # @param [Thinreports::Core::Shape::Basic::Format] format
-          def init_item(format)
-            @init_item_handler.call(format)
-          end
-
-          # @param [String] type
-          # @param [Hash] limit
-          # @option limit [String] :only
-          # @option limit [String] :except
-          # @return [Booldan]
-          def valid_type?(type, limit = {})
-            return true if limit.empty?
-
-            if limit[:only]
-              type == limit[:only]
-            elsif limit[:except]
-              type != limit[:except]
-            else
-              raise ArgumentError
-            end
-          end
-        end
-      end
-    end
-  end
-end