thinreports 0.10.0 → 0.12.0

data/lib/thinreports/generator/pdf/document/graphics/attributes.rb

@@ -23,7 +23,6 @@ module Thinreports
         # @yield [attrs]
         # @yieldparam [Hash] attrs
         # @return [Hash]
-        # rubocop:disable Metrics/AbcSize
         def build_text_attributes(style, &block)
           text_attributes = {
             font: font_family(style['font-family']),

data/lib/thinreports/generator/pdf/document/graphics/basic.rb

@@ -65,7 +65,6 @@ module Thinreports
         end
 
         # @param [Hash] attrs
-        # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
         def with_graphic_styles(attrs, &block)
           stroke = build_stroke_styles(attrs)
           fill = build_fill_styles(attrs)

data/lib/thinreports/generator/pdf/document/graphics/image.rb

@@ -39,9 +39,16 @@ module Thinreports
         # @param [Hash] options
         # @option options [:left, :center, :right] :position_x (:left)
         # @option options [:top, :center, :bottom] :position_y (:top)
+        # @option options [Numeric] :offset_x
+        # @option options [Numeric] :offset_y
         def image_box(filename_or_io, x, y, w, h, options = {})
           w, h = s2f(w, h)
-          pdf.bounding_box(pos(x, y), width: w, height: h) do
+
+          computed_position = pos(
+            x + (options[:offset_x] || 0),
+            y + (options[:offset_y] || 0)
+          )
+          pdf.bounding_box(computed_position, width: w, height: h) do
             pdf.image(
               filename_or_io,
               position: options[:position_x] || :left,
@@ -51,6 +58,17 @@ module Thinreports
           end
         end
 
+        def image_dimensions(filename_or_io, x, y, w, h, options = {})
+          w, h = s2f(w, h)
+          # XXX: Calling @private method
+          _pdf_obj, info = pdf.build_image_object(filename_or_io)
+          info.calc_image_dimensions(
+            position: options[:position_x] || :left,
+            vposition: options[:position_y] || :top,
+            auto_fit: [w, h]
+          )
+        end
+
         def clean_temp_images
           temp_image_registry.each_value do |image_path|
             File.delete(image_path) if File.exist?(image_path)

data/lib/thinreports/generator/pdf/document/graphics/text.rb

@@ -22,7 +22,7 @@ module Thinreports
         # @option attrs [Boolean] :single (false)
         # @option attrs [:trancate, :shrink_to_fit, :expand] :overflow (:trancate)
         # @option attrs [:none, :break_word] :word_wrap (:none)
-        def text_box(content, x, y, w, h, attrs = {})
+        def text_box(content, x, y, w, h, attrs = {}, &block)
           w, h = s2f(w, h)
 
           box_attrs = text_box_attrs(
@@ -35,12 +35,16 @@ module Thinreports
           content = text_without_line_wrap(content) if attrs[:word_wrap] == :none
 
           with_text_styles(attrs) do |built_attrs, font_styles|
-            pdf.formatted_text_box(
-              [{ text: content, styles: font_styles }],
-              built_attrs.merge(box_attrs)
-            )
+            if block
+              block.call [{ text: content, styles: font_styles }],
+                built_attrs.merge(box_attrs)
+            else
+              pdf.formatted_text_box(
+                [{ text: content, styles: font_styles }],
+                built_attrs.merge(box_attrs)
+              )
+            end
           end
-        # rubocop:disable Lint/HandleExceptions
         rescue Prawn::Errors::CannotFit
           # Nothing to do.
           #
@@ -81,7 +85,6 @@ module Thinreports
         # @yield [built_attrs, font_styles]
         # @yieldparam [Hash] built_attrs The finalized attributes.
         # @yieldparam [Array] font_styles The finalized styles.
-        # rubocop:disable Metrics/AbcSize
         def with_text_styles(attrs, &block)
           # When no color is given, do not draw.
           return unless attrs.key?(:color) && attrs[:color] != 'none'
@@ -139,7 +142,6 @@ module Thinreports
         # @yield [attributes, styles]
         # @yieldparam [Hash] modified_attrs
         # @yieldparam [Array] styles
-        # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
         def with_font_styles(attrs, font, &block)
           # Building font styles.
           styles = attrs.delete(:styles)

data/lib/thinreports/generator/pdf/document/page.rb

@@ -10,16 +10,13 @@ module Thinreports
         }.freeze
 
         # @param [Thinreports::Layout::Format] format
-        # rubocop:disable Metrics/AbcSize
         def start_new_page(format)
           format_id =
             if change_page_format?(format)
               pdf.start_new_page(new_basic_page_options(format))
               @current_page_format = format
 
-              unless format_stamp_registry.include?(format.identifier)
-                create_format_stamp(format)
-              end
+              create_format_stamp(format) unless format_stamp_registry.include?(format.identifier)
               format.identifier
             else
               pdf.start_new_page(new_basic_page_options(current_page_format))
@@ -29,6 +26,18 @@ module Thinreports
           stamp(format_id.to_s)
         end
 
+        def start_new_page_for_section_report(format)
+          @current_page_format = format
+          pdf.start_new_page(new_basic_page_options(current_page_format).merge(
+            top_margin: current_page_format.page_margin[0],
+            bottom_margin: current_page_format.page_margin[2]
+          ))
+        end
+
+        def max_content_height
+          pdf.margin_box.height
+        end
+
         def add_blank_page
           pdf.start_new_page(pdf.page_count.zero? ? { size: 'A4' } : {})
         end

data/lib/thinreports/generator/pdf/drawer/list.rb

@@ -12,7 +12,6 @@ module Thinreports
           end
 
           # @param [Thinreports::Core::Shape::List::PageState] list_page
-          # rubocop:disable Metrics/AbcSize
           def draw(list_page)
             draw_section(list_page.header) if list_page.header
             list_page.rows.each do |row|

data/lib/thinreports/generator/pdf/prawn_ext/calc_image_dimensions.rb

@@ -20,9 +20,7 @@ module Thinreports
 
             box_width, box_height = options.delete(:auto_fit)
 
-            if image_width > box_width || image_height > box_height
-              options[:fit] = [box_width, box_height]
-            end
+            options[:fit] = [box_width, box_height] if image_width > box_width || image_height > box_height
           end
           super(options)
         end

data/lib/thinreports/generator/pdf/prawn_ext/width_of.rb

@@ -4,16 +4,13 @@ module Thinreports
   module Generator
     module PrawnExt
       module WidthOf
-        # Subtract the width of one character space from the string width calculation result.
+        # This patch fixes the character_spacing effect on text width calculation.
         #
-        # The original Prawn::Document#width_of returns the following result:
-        #
-        #  Width of Character is 1
-        #  Width of Character Space is 1
+        # The original #width_of:
         #
         #   width_of('abcd') #=> 4 + 4 = 8
         #
-        # In this width_of, returns the following result:
+        # The #width_of in this patch:
         #
         #   width_of('abcd') #=> 4 + 3 = 7
         #
@@ -26,4 +23,7 @@ module Thinreports
   end
 end
 
-Prawn::Document.prepend Thinreports::Generator::PrawnExt::WidthOf
+# Prawn v2.3 and later includes this patch by https://github.com/prawnpdf/prawn/pull/1117.
+if Prawn::VERSION < '2.3.0'
+  Prawn::Document.prepend Thinreports::Generator::PrawnExt::WidthOf
+end

data/lib/thinreports/layout/base.rb

@@ -3,7 +3,7 @@
 module Thinreports
   module Layout
     class Base
-      EXT_NAME = 'tlf'.freeze
+      EXT_NAME = 'tlf'
       include Utils
 
       class << self
@@ -14,9 +14,7 @@ module Thinreports
         def load_format(filename)
           filename += ".#{EXT_NAME}" unless filename =~ /\.#{EXT_NAME}$/
 
-          unless File.exist?(filename)
-            raise Thinreports::Errors::LayoutFileNotFound
-          end
+          raise Thinreports::Errors::LayoutFileNotFound unless File.exist?(filename)
           # Build format.
           Thinreports::Layout::Format.build(filename)
         end

data/lib/thinreports/layout/format.rb

@@ -13,7 +13,6 @@ module Thinreports
                     page_orientation: %w[report orientation]
 
       class << self
-        # rubocop:disable Metrics/AbcSize
         def build(filename)
           schema = JSON.parse(read_file(filename))
           schema_version = Layout::Version.new(schema['version'])

data/lib/thinreports/layout/legacy_schema.rb

@@ -5,7 +5,6 @@ require 'rexml/document'
 
 module Thinreports
   module Layout
-    # rubocop:disable Metrics/ClassLength
     class LegacySchema
       include Utils
 
@@ -17,7 +16,6 @@ module Thinreports
         @legacy_svg = cleanup_svg(@legacy_svg)
       end
 
-      # rubocop:disable Metrics/AbcSize
       def upgrade
         config = legacy_schema['config']
         page_config = config['page']
@@ -48,7 +46,6 @@ module Thinreports
         build_item_schemas_from_svg(svg.elements['/svg/g'])
       end
 
-      # rubocop:disable Metrics/CyclomaticComplexity
       def build_item_schemas_from_svg(svg_elements)
         return [] unless svg_elements
 
@@ -107,6 +104,7 @@ module Thinreports
           'width' => attributes['width'].to_f,
           'height' => attributes['height'].to_f,
           'display' => display(attributes['x-display']),
+          'border-radius' => attributes['rx'].to_i,
           'style' => {
             'border-width' => attributes['stroke-width'].to_f,
             'border-color' => attributes['stroke'],
@@ -277,9 +275,7 @@ module Thinreports
           'footer' => footer
         }
 
-        if page_footer['enabled']
-          page_footer['translate']['y'] += detail['height']
-        end
+        page_footer['translate']['y'] += detail['height'] if page_footer['enabled']
 
         if footer['enabled']
           footer['translate']['y'] += detail['height']

data/lib/thinreports/layout/version.rb

@@ -4,7 +4,7 @@ module Thinreports
   module Layout
     class Version
       COMPATIBLE_RULES = ['>= 0.8.0', '< 1.0.0'].freeze
-      NEW_SCHEMA_FROM = '0.9.0'.freeze
+      NEW_SCHEMA_FROM = '0.9.0'
 
       class << self
         def compatible_rules

data/lib/thinreports/report/internal.rb

@@ -33,9 +33,7 @@ module Thinreports
         else
           id = options[:id].to_sym
 
-          if layout_registry.key?(id)
-            raise ArgumentError, "Id :#{id} is already in use."
-          end
+          raise ArgumentError, "Id :#{id} is already in use." if layout_registry.key?(id)
           layout_registry[id] = init_layout(layout, id)
         end
       end
@@ -74,7 +72,7 @@ module Thinreports
             raise ArgumentError, 'Invalid argument for layout.'
           end
 
-        @default_layout = layout unless @default_layout
+        @default_layout ||= layout
         layout
       end
 
@@ -98,6 +96,8 @@ module Thinreports
       end
 
       def init_layout(filename, id = nil)
+        filename = filename.to_path if filename.is_a?(Pathname)
+
         Thinreports::Layout.new(filename, id: id)
       end
     end

data/lib/thinreports/report/page.rb

@@ -64,7 +64,6 @@ module Thinreports
         false
       end
 
-      # rubocop:disable Metrics/AbcSize
       def copy
         new_page = self.class.new(report, layout, count: count?)
 
@@ -72,9 +71,7 @@ module Thinreports
           new_shape = shape.copy(new_page)
           new_page.manager.shapes[id] = new_shape
 
-          if new_shape.internal.type_of?(Core::Shape::List::TYPE_NAME)
-            new_page.manager.lists[id] = new_shape
-          end
+          new_page.manager.lists[id] = new_shape if new_shape.internal.type_of?(Core::Shape::List::TYPE_NAME)
         end
         new_page
       end
@@ -85,9 +82,7 @@ module Thinreports
         at = options[:at] || :create
 
         # For list shapes.
-        if at == :create
-          manager.lists.values.each { |list| list.manager.finalize }
-        end
+        manager.lists.each_value { |list| list.manager.finalize } if at == :create
 
         @finalized = true
       end

data/lib/thinreports/section_report/build.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative 'schema/loader'
+require_relative 'builder/report_builder'
+
+module Thinreports
+  module SectionReport
+    class Build
+      def call(report_params)
+        schema = load_schema(report_params)
+        params = report_params[:params] || {}
+
+        Builder::ReportBuilder.new(schema).build(params)
+      end
+
+      private
+
+      def load_schema(report_params)
+        loader = Schema::Loader.new
+
+        case
+        when report_params[:layout_file]
+          loader.load_from_file(report_params[:layout_file])
+        when report_params[:layout_data]
+          loader.load_from_data(report_params[:layout_data])
+        else
+          raise Errors::LayoutFileNotFound
+        end
+      end
+    end
+  end
+end

data/lib/thinreports/section_report/builder/item_builder.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require_relative 'stack_view_builder'
+
+module Thinreports
+  module SectionReport
+    module Builder
+      class ItemBuilder
+        Context = Struct.new(:parent_schema)
+
+        def initialize(item_schema, parent_schema)
+          @item = Core::Shape::Interface(nil, item_schema)
+          @parent_schema = parent_schema
+        end
+
+        def build(item_params)
+          params = build_params(item_params)
+
+          item.visible(params[:display]) if params.key?(:display)
+          item.value(params[:value]) if params.key?(:value)
+          item.styles(params[:styles]) if params.key?(:styles)
+
+          if item.internal.format.attributes['type'] == Core::Shape::StackView::TYPE_NAME
+            StackViewBuilder.new(item).update(params)
+          end
+
+          item
+        end
+
+        private
+
+        attr_reader :item, :parent_schema
+
+        def build_params(params)
+          return {} unless params
+
+          case params
+          when Hash
+            params
+          when Proc
+            params.call(Context.new(parent_schema))
+          else
+            { value: params }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/thinreports/section_report/builder/report_builder.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require_relative 'report_data'
+require_relative 'item_builder'
+
+module Thinreports
+  module SectionReport
+    module Builder
+      class ReportBuilder
+        def initialize(schema)
+          @schema = schema
+        end
+
+        def build(params)
+          ReportData::Main.new(
+            schema,
+            build_groups(params[:groups])
+          )
+        end
+
+        private
+
+        attr_reader :schema
+
+        def build_groups(groups_params)
+          return [] unless groups_params
+
+          groups_params.map do |group_params|
+            ReportData::Group.new(
+              build_sections(:header, group_params[:headers] || {}),
+              build_detail_sections(group_params[:details] || []),
+              build_sections(:footer, group_params[:footers] || {})
+            )
+          end
+        end
+
+        def build_sections(section_type, sections_params)
+          sections_schemas =
+            case section_type
+            when :header then schema.headers
+            when :footer then schema.footers
+            end
+
+          sections_schemas.each_with_object([]) do |(section_id, section_schema), sections|
+            section_params = sections_params[section_id.to_sym] || {}
+            next unless section_enabled?(section_schema, section_params)
+
+            items = build_items(section_schema, section_params[:items] || {})
+            sections << ReportData::Section.new(section_schema, items, section_params[:min_height])
+          end
+        end
+
+        def build_detail_sections(details_params)
+          details_params.each_with_object([]) do |detail_params, details|
+            detail_id = detail_params[:id].to_sym
+            detail_schema = schema.details[detail_id]
+
+            next unless detail_schema
+
+            items = build_items(detail_schema, detail_params[:items] || {})
+            details << ReportData::Section.new(detail_schema, items, detail_params[:min_height])
+          end
+        end
+
+        def build_items(section_schema, items_params)
+          section_schema.items.each_with_object([]) do |item_schema, items|
+            item = ItemBuilder.new(item_schema, section_schema).build(items_params[item_schema.id&.to_sym])
+            items << item if item.visible?
+          end
+        end
+
+        def section_enabled?(section_schema, section_params)
+          if section_params.key?(:display)
+            section_params[:display]
+          else
+            section_schema.display?
+          end
+        end
+      end
+    end
+  end
+end