thinreports 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b53f36fac9af329499239b3db9313911fba89c82dd28cf81ac2e9942bcdce13a
-  data.tar.gz: 38ce4e9d25a709240a1242948a33d96372e3cb6981b07e3121c88967279a3eed
+  metadata.gz: 9713f8331c7d6c97d17f0b30ba84124148f48ed40d3fde29f884503146415ed0
+  data.tar.gz: 0617cb86495f89090b6f751334aed7fd69c42b79357683992ac65d3ee0dc72e0
 SHA512:
-  metadata.gz: 5db1f93781fd6be18f53424eb2853b6701449938f2dc2875f287be74720611361f5dc7b6f657ea9fd96ed83de8056efa92cd4ae7b5b8c0df3d11bb318a81f7d6
-  data.tar.gz: 25d1cc37589223ea85f574f7c6cf007a9e5682dff6f59051286c3fe691b5ab9704d9c5e40e8b3b9b49134406af538aa4e688a74d5416aa1082f6bc1330de173a
+  metadata.gz: 37bd09438b27f1147c9803b0236bac461c0d5c08844bff920e7a183bd3f09912f157bf66c6ad246ece7a8c8041fd559a18495c56a22550459e15e357b60355c9
+  data.tar.gz: 43fd24534374c1c63162cece99c12622c5bdab0fce12c9f8c7b9e82d985ec50fc0b1fa388f1b67658ae3892e6b9d97350fada88ef6c48021c4dedecff128e910

data/.github/CONTRIBUTING.md

@@ -1,2 +1,2 @@
-**We only accept bug reports and pull requests in GitHub**.
-If you have a support question about how to use thinreports, please [ask on Google Group](https://groups.google.com/forum/?hl=ja#!forum/thinreports).
+We only accept bug reports and pull requests in GitHub.
+If you have a support question about how to use thinreports, please [ask on GitHub Discussions](https://github.com/thinreports/thinreports/discussions).

data/.github/workflows/test.yml

@@ -1,19 +1,28 @@
 name: Test
 
-on: push
+on: [push, pull_request]
 
 jobs:
   test:
-    name: Test against ${{ matrix.ruby }}
+    name: Test against ruby ${{ matrix.ruby }} and prawn ${{ matrix.prawn }}
     runs-on: ubuntu-latest
     strategy:
       matrix:
         ruby:
-          - 2.4
           - 2.5
           - 2.6
           - 2.7
+          - 3.0
           - jruby
+        prawn:
+          - 2.2
+          - 2.3
+          - 2.4
+        exclude:
+          - ruby: 3.0
+            prawn: 2.2
+          - ruby: 3.0
+            prawn: 2.3
 
     steps:
     - uses: actions/checkout@v1
@@ -31,9 +40,12 @@ jobs:
       with:
         ruby-version: ${{ matrix.ruby }}
 
-    - name: Build and test with Rake
+    - name: Install dependencies
       run: |
         gem install bundler
-        bundle install --jobs 4 --retry 3
+        bundle install --gemfile gemfiles/prawn-${{ matrix.prawn }}.gemfile --jobs 4 --retry 3
+
+    - name: Run tests
+      run: |
         bundle exec rake test:units
         bundle exec rake test:features

data/CHANGELOG.md

@@ -1,4 +1,15 @@
-## master
+## master (Unreleased)
+
+## 0.12.0
+
+Breaking Changes:
+
+ * Drop Ruby 2.4 support #108, #109
+
+Enhancements:
+
+ * Ruby 3.0 support #108, #109
+ * Prawn 2.4 support #108, #109
 
 ## 0.11.0
 

data/Dockerfile

@@ -1,4 +1,4 @@
-FROM ruby:2.7.1
+FROM ruby:3.0.0
 
 RUN apt-get update -qq && apt-get install -y build-essential xvfb
 

data/Gemfile

@@ -4,7 +4,3 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem 'minitest', '>= 5.14.1'
-gem 'mocha', '>= 1.11.2'
-gem 'pdf-inspector', '>= 1.3.0'
-gem 'rake', '>= 13.0.1'

data/README.md

@@ -15,11 +15,13 @@
   * [Quick Start Guide](http://www.thinreports.org/documentation/getting-started/quickstart.html)
   * [Examples](https://github.com/thinreports/thinreports-examples)
   * [Changelog](https://github.com/thinreports/thinreports-generator/blob/master/CHANGELOG.md)
-  * [Discussion Group](https://groups.google.com/forum/#!forum/thinreports)
+  * [Discussion Group (GitHub Discussions)](https://github.com/thinreports/thinreports/discussions)
+  * [Discussion Group (Google Groups)](https://groups.google.com/forum/#!forum/thinreports)
 
 ## Supported versions
 
-  * Ruby 2.4, 2.5, 2.6, 2.7
+  * Ruby 2.5, 2.6, 2.7, 3.0
+  * Prawn 2.2, 2.3, 2.4
   * JRuby 9.2
 
 ## Quick Reference

data/gemfiles/prawn-2.2.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'prawn', '~> 2.2.0'
+
+gemspec path: '../'

data/gemfiles/prawn-2.3.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'prawn', '~> 2.3.0'
+
+gemspec path: '../'

data/gemfiles/prawn-2.4.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'prawn', '~> 2.4.0'
+
+gemspec path: '../'

data/lib/thinreports.rb

@@ -6,6 +6,10 @@ module Thinreports
   def self.root
     @root ||= Pathname.new(__FILE__).join('..', '..')
   end
+
+  def self.generate(report_params, filename: nil)
+    Generate.new.call(report_params, filename: filename)
+  end
 end
 
 require_relative 'thinreports/version'
@@ -18,3 +22,4 @@ require_relative 'thinreports/core/utils'
 require_relative 'thinreports/report'
 require_relative 'thinreports/layout'
 require_relative 'thinreports/generator/pdf'
+require_relative 'thinreports/generate'

data/lib/thinreports/core/shape.rb

@@ -18,6 +18,7 @@ module Thinreports
         when TextBlock::TYPE_NAME  then TextBlock
         when ImageBlock::TYPE_NAME then ImageBlock
         when List::TYPE_NAME       then List
+        when StackView::TYPE_NAME  then StackView
         when Text::TYPE_NAME       then Text
         when PageNumber::TYPE_NAME then PageNumber
         when *Basic::TYPE_NAMES    then Basic
@@ -37,4 +38,5 @@ require_relative 'shape/text'
 require_relative 'shape/text_block'
 require_relative 'shape/image_block'
 require_relative 'shape/list'
+require_relative 'shape/stack_view'
 require_relative 'shape/page_number'

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

@@ -10,6 +10,11 @@ module Thinreports
           config_reader :type, :id
           config_reader :style
           config_checker true, :display
+          config_reader follow_stretch: %w[follow-stretch]
+
+          def affect_bottom_margin?
+            attributes.fetch('affect-bottom-margin', true)
+          end
         end
       end
     end

data/lib/thinreports/core/shape/stack_view.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Thinreports
+  module Core
+    module Shape
+      module StackView
+        TYPE_NAME = 'stack-view'.freeze
+      end
+    end
+  end
+end
+
+require_relative 'stack_view/format'
+require_relative 'stack_view/interface'
+require_relative 'stack_view/internal'
+
+require_relative 'stack_view/row_format'

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Thinreports
+  module Core
+    module Shape
+      module StackView
+        class Format < Basic::Format
+          attr_reader :rows
+
+          def initialize(*)
+            super
+            initialize_rows
+          end
+
+          private
+
+          def initialize_rows
+            @rows = []
+            attributes['rows'].each do |row|
+              @rows << StackView::RowFormat.new(row)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/thinreports/core/shape/stack_view/interface.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Thinreports
+  module Core
+    module Shape
+      module StackView
+        class Interface < Basic::Interface
+          private
+
+          def init_internal(parent, format)
+            StackView::Internal.new(parent, format)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Thinreports
+  module Core
+    module Shape
+      module StackView
+        class Internal < Basic::Internal
+          def initialize(parent, format)
+            super
+            @rows = []
+          end
+
+          attr_accessor :rows
+
+          def type_of?(type_name)
+            type_name == StackView::TYPE_NAME
+          end
+        end
+      end
+    end
+  end
+end

data/lib/thinreports/core/shape/stack_view/row_format.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Thinreports
+  module Core
+    module Shape
+      module StackView
+        class RowFormat < Core::Format::Base
+          config_reader :id
+          config_reader :height
+          config_checker true, :display
+          config_checker true, auto_stretch: 'auto-stretch'
+
+          attr_reader :items
+
+          def initialize(*)
+            super
+            @items = []
+            @item_with_ids = {}
+            initialize_items(attributes['items'])
+          end
+
+          def find_item(id)
+            @item_with_ids[id.to_sym]
+          end
+
+          private
+
+          def initialize_items(item_schemas)
+            item_schemas.each do |item_schema|
+              item = Core::Shape::Format(item_schema['type']).new(item_schema)
+              @items << item
+              @item_with_ids[item.id.to_sym] = item unless item.id.empty?
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/thinreports/core/shape/style/basic.rb

@@ -5,9 +5,12 @@ module Thinreports
     module Shape
       module Style
         class Basic < Style::Base
-          style_accessible :visible
+          style_accessible :visible, :offset_x, :offset_y
           attr_accessor :visible
 
+          style_accessor :offset_x, 'offset-x'
+          style_accessor :offset_y, 'offset-y'
+
           def initialize(*args)
             super
             @visible = @format.display?

data/lib/thinreports/generate.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative 'section_report/generate'
+
+module Thinreports
+  class Generate
+    def call(report_params, filename: nil)
+      SectionReport::Generate.new.call(report_params, filename: filename)
+    end
+  end
+end

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

@@ -5,20 +5,26 @@ module Thinreports
     class PDF
       module DrawShape
         # @param [Thinreports::Core::Shape::TextBlock::Internal] shape
-        def draw_shape_tblock(shape)
-          x, y, w, h = shape.format.attributes.values_at('x', 'y', 'width', 'height')
+        # @param [Numeric] height (nil) It will be used as rendering height if present.
+        #   Otherwise, the rendering height is the height of schema.
+        # @param [:truncate, :shrink_to_fit, :expand] overflow (nil) It will be set the overflow attribute if present.
+        def draw_shape_tblock(shape, height: nil, overflow: nil, &block)
+          x, y, w = shape.format.attributes.values_at('x', 'y', 'width')
+
+          h = height || shape.format.attributes['height']
 
           content = shape.real_value.to_s
           return if content.empty?
 
           attrs = build_text_attributes(shape.style.finalized_styles)
+          attrs[:overflow] = overflow if overflow
 
           unless shape.multiple?
             content = content.tr("\n", ' ')
             attrs[:single] = true
           end
 
-          text_box(content, x, y, w, h, attrs)
+          text_box(content, x, y, w, h, attrs, &block)
         end
 
         def draw_shape_pageno(shape, page_no, page_count)
@@ -44,6 +50,21 @@ module Thinreports
           style = shape.style.finalized_styles
 
           image_box(
+            shape.src, x, y, w, h,
+            position_x: image_position_x(style['position-x']),
+            position_y: image_position_y(style['position-y']),
+            offset_x: style['offset-x'],
+            offset_y: style['offset-y']
+          )
+        end
+
+        def shape_iblock_dimenions(shape)
+          return nil if blank_value?(shape.src)
+
+          x, y, w, h = shape.format.attributes.values_at('x', 'y', 'width', 'height')
+          style = shape.style.finalized_styles
+
+          image_dimensions(
             shape.src, x, y, w, h,
             position_x: image_position_x(style['position-x']),
             position_y: image_position_y(style['position-y'])
@@ -51,10 +72,10 @@ module Thinreports
         end
 
         # @param [Thinreports::Core::Shape::Text::Internal] shape
-        def draw_shape_text(shape)
+        def draw_shape_text(shape, dheight = 0)
           x, y, w, h = shape.format.attributes.values_at('x', 'y', 'width', 'height')
           text(
-            shape.texts.join("\n"), x, y, w, h,
+            shape.texts.join("\n"), x, y, w, h + dheight,
             build_text_attributes(shape.style.finalized_styles)
           )
         end
@@ -66,18 +87,18 @@ module Thinreports
         end
 
         # @param [Thinreports::Core::Shape::Basic::Internal] shape
-        def draw_shape_line(shape)
+        def draw_shape_line(shape, dy1 = 0, dy2 = 0)
           x1, y1, x2, y2 = shape.format.attributes.values_at('x1', 'y1', 'x2', 'y2')
-          line(x1, y1, x2, y2, build_graphic_attributes(shape.style.finalized_styles))
+          line(x1, y1 + dy1, x2, y2 + dy2, build_graphic_attributes(shape.style.finalized_styles))
         end
 
         # @param [Thinreports::Core::Shape::Basic::Internal] shape
-        def draw_shape_rect(shape)
+        def draw_shape_rect(shape, dheight = 0)
           x, y, w, h = shape.format.attributes.values_at('x', 'y', 'width', 'height')
           rect_attributes = build_graphic_attributes(shape.style.finalized_styles) do |attrs|
             attrs[:radius] = shape.format.attributes['border-radius']
           end
-          rect(x, y, w, h, rect_attributes)
+          rect(x, y, w, h + dheight, rect_attributes)
         end
       end
     end

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)