thinreports 0.10.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 40890b67b0013db37dcab5672e1b3166919adc9c
-  data.tar.gz: 00d5a8a495b282c6f6c83864a2550774b09a9995
+SHA256:
+  metadata.gz: 9713f8331c7d6c97d17f0b30ba84124148f48ed40d3fde29f884503146415ed0
+  data.tar.gz: 0617cb86495f89090b6f751334aed7fd69c42b79357683992ac65d3ee0dc72e0
 SHA512:
-  metadata.gz: 7c84274da336894155c19db3ae9b6ce66f3c69bde20605c74efd841dd318c51d7317553a261cac391b8e5eb9d197d15fd05cfb18d0e87ffdafbf8b0a2ffbe315
-  data.tar.gz: f2f4b9e4aa7edeca96bb40f7ceb187fa04dd9bdfcaf6d750af6602077f0d5c25cb19466ae50780cf87d1a433f82ea11f5837263d4f16b35922b0f525b475fd91
+  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

@@ -0,0 +1,51 @@
+name: Test
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    name: Test against ruby ${{ matrix.ruby }} and prawn ${{ matrix.prawn }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby:
+          - 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
+
+    - name: Set up diff-pdf
+      run: |
+        sudo apt-get update
+        sudo apt-get install make automake g++ libpoppler-glib-dev poppler-utils libwxgtk3.0-dev
+        git clone https://github.com/vslavik/diff-pdf.git -b v0.4.1 --depth 1 /tmp/diff-pdf-src
+        cd /tmp/diff-pdf-src
+        ./bootstrap && ./configure && make && sudo make install
+
+    - name: Set up Ruby ${{ matrix.ruby }}
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+
+    - name: Install dependencies
+      run: |
+        gem install bundler
+        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/.gitignore

@@ -4,3 +4,4 @@ Gemfile.lock
 .bundle
 .yardoc
 doc
+!/test/features/*/expect.pdf

data/CHANGELOG.md

@@ -1,3 +1,52 @@
+## 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
+
+Breaking Changes:
+
+ * Dropped Ruby 2.1 support
+ * Dropped Ruby 2.2 support
+ * Dropped Ruby 2.3 support
+ * Formatter of a text-block works even with multiple-line (#95)
+
+Enhancements:
+
+ * Ruby 2.7.0 support
+ * Support Pathname layout option on `Thinreports::Report` #99 [@meganemura]
+
+Bug Fixes:
+
+ * Fixed: thousands separation is applied to decimal part #95
+
+## 0.10.3
+
+Bug Fixes:
+
+ * Fixed: corner-radius of Rect is not applied correctly #93
+
+## 0.10.2
+
+Bug Fixes:
+
+ * Fixed: Prawn::Errors::UnknownFont error occured: "is not a known font" #89
+
+## 0.10.1
+
+Bug Fixes:
+
+ * Fixed a bug that an error occurred on page break in other list when there is a list with page-break disabled #87 [@meganemura]
+
 ## 0.10.0
 
  * Thinreports requires Prawn 2.2

data/Dockerfile

@@ -0,0 +1,12 @@
+FROM ruby:3.0.0
+
+RUN apt-get update -qq && apt-get install -y build-essential xvfb
+
+# Install diff-pdf
+WORKDIR /tmp
+RUN apt-get install -y libpoppler-glib-dev poppler-utils libwxgtk3.0-dev && curl -L https://github.com/vslavik/diff-pdf/archive/master.tar.gz -o diff-pdf-master.tar.gz && tar zxf diff-pdf-master.tar.gz && cd diff-pdf-master && ./bootstrap && ./configure && make && make install
+
+RUN mkdir /thinreports
+
+WORKDIR /thinreports
+VOLUME /thinreports

data/Gemfile

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
-source 'http://rubygems.org'
+source 'https://rubygems.org'
 
 gemspec
+

data/README.md

@@ -1,9 +1,8 @@
 # Thinreports Generator
 
 [![Gem Version](https://badge.fury.io/rb/thinreports.svg)](http://badge.fury.io/rb/thinreports)
-[![](http://img.shields.io/travis/thinreports/thinreports-generator.svg?style=flat)](http://travis-ci.org/thinreports/thinreports-generator)
-[![](http://img.shields.io/codeclimate/github/thinreports/thinreports-generator.svg?style=flat)](https://codeclimate.com/github/thinreports/thinreports-generator)
-[![](http://img.shields.io/gemnasium/thinreports/thinreports-generator.svg?style=flat)](https://gemnasium.com/thinreports/thinreports-generator)
+[![Test](https://github.com/thinreports/thinreports-generator/workflows/Test/badge.svg)](https://github.com/thinreports/thinreports-generator/actions)
+[![Maintainability](https://api.codeclimate.com/v1/badges/054b400031608957ec4a/maintainability)](https://codeclimate.com/github/thinreports/thinreports-generator/maintainability)
 
 [Thinreports](http://www.thinreports.org) is an open source report generating tool for Ruby.
 
@@ -15,14 +14,15 @@
   * [Installation Guide](http://www.thinreports.org/documentation/getting-started/installation.html)
   * [Quick Start Guide](http://www.thinreports.org/documentation/getting-started/quickstart.html)
   * [Examples](https://github.com/thinreports/thinreports-examples)
-  * [Rails5 Example](https://github.com/thinreports/thinreports-rails5-example)
   * [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.1, 2.2, 2.3, 2.4
-  * JRuby 9.1.8.0
+  * Ruby 2.5, 2.6, 2.7, 3.0
+  * Prawn 2.2, 2.3, 2.4
+  * JRuby 9.2
 
 ## Quick Reference
 
@@ -153,7 +153,7 @@ report.on_page_create do |page|
 end
 ```
 
-See also [examples/report_callbacks](https://github.com/thinreports/thinreports-generator/tree/master/examples/report_callbacks).
+See also [features/report_callbacks](https://github.com/thinreports/thinreports-generator/tree/master/test/features/report_callbacks).
 
 ### List
 
@@ -202,7 +202,7 @@ report.list do |list|
 end
 ```
 
-See also  [examples/list_events](https://github.com/thinreports/thinreports-generator/tree/master/examples/list_events).
+See also  [features/list_events](https://github.com/thinreports/thinreports-generator/tree/master/test/features/list_events).
 
 ### Page Number
 
@@ -223,7 +223,7 @@ report.start_new_page do |page|
 end
 ```
 
-See also [examples/page_number](https://github.com/thinreports/thinreports-generator/blob/master/examples/page_number) and [examples/list_page_number](https://github.com/thinreports/thinreports-generator/blob/master/examples/list_page_number).
+See also [features/page_number](https://github.com/thinreports/thinreports-generator/blob/master/test/features/page_number) and [features/page_number_with_list](https://github.com/thinreports/thinreports-generator/blob/master/test/features/page_number_with_list).
 
 ### Configuring fallback fonts
 
@@ -235,7 +235,7 @@ end
 Thinreports.config.fallback_fonts = ['/path/to/font_a.ttf', '/path/to/font_b.ttf']
 ```
 
-See also [examples/eudc](https://github.com/thinreports/thinreports-generator/blob/master/examples/eudc).
+See also [features/eudc](https://github.com/thinreports/thinreports-generator/blob/master/test/features/eudc).
 
 ## Features
 
@@ -262,19 +262,44 @@ Generator can dynamically:
 
 ## Contributing
 
-### Report bug, post your suggestion
+Bug reports and pull requests are welcome on GitHub at https://github.com/thinreports/thinreports-generator.
 
-If you find bugs or improvements for the Editor, please report it [here](https://github.com/thinreports/thinreports-generator/issues/new).
+## Development
 
-### Sending a Pull Request
+### How to run feature tests
 
-  1. Fork it
-  2. Clone your forked repository
-  3. Create your feature branch: `git checkout -b my-new-feature`
-  4. Fix your feature
-  5. Commit your changes: `git commit -am 'Fixed some bugs or features'`
-  6. Push to the branch: `git push origin my-new-feature`
-  7. Create new Pull Request
+```
+$ bundle exec rake test:features
+```
+
+In order to run `test:features`, you need to install [diff-pdf](https://github.com/vslavik/diff-pdf) in your environment, or you can run test in the docker container as below.
+
+### How to develop in Docker container
+
+You can use the Docker container for development. This container contains the libraries required for testing, such as diff-pdf.
+
+```
+$ docker build -t thinreports-dev .
+$ docker run -v $PWD:/thinreports:cached -it thinreports-dev bash
+
+> /thinreports#
+```
+
+You can run test:
+
+```
+> /thinreports# bundle install
+> /thinreports# bundle exec rake test:features
+```
+
+## Releasing Generator
+
+1. Update the version number in `version.rb`
+2. Update `CHANGELOG.md` and `README.md` (if needed)
+3. Create the Release PR like #105
+4. Merge the PR
+5. Is the master CI green? If not, make it green
+6. Run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to rubygems.org
 
 ## License
 

data/Rakefile

@@ -1,38 +1,22 @@
+require 'bundler/gem_tasks'
 require 'rake/testtask'
-require 'rubocop/rake_task'
-require 'yard'
 
-task default: %i[test rubocop]
+task default: :test
 
 Rake::TestTask.new do |t|
+  t.name = 'test:units'
+  t.description = 'Run unit tests'
   t.libs << 'test'
-  t.test_files = Dir['test/unit/**/test_*.rb']
+  t.test_files = Dir['test/units/**/test_*.rb']
 end
 
-namespace :examples do
-  desc 'Run all examples'
-  task :all do
-    require_relative 'examples/helper'
-    Dir['examples/*/*.rb'].each { |f| require_relative f }
-  end
-
-  Dir['examples/*/*.rb'].each do |f|
-    casename = File.basename(File.dirname(f))
-
-    desc "Run example: #{casename}"
-    task casename.to_sym => :_init do
-      require_relative 'examples/helper'
-      require_relative "examples/#{casename}/#{casename}"
-    end
-  end
-end
-
-desc 'Run all examples'
-task examples: :'examples:all'
-
-YARD::Rake::YardocTask.new :doc do |yard|
-  yard.files = Dir['lib/**/*.rb']
-  yard.options = ['--readme', 'README.md']
+Rake::TestTask.new do |t|
+  t.name = 'test:features'
+  t.description = 'Run feature tests'
+  t.libs << 'test/features'
+  t.test_files = Dir['test/features/*/test_*.rb']
+  t.warning = false
 end
 
-RuboCop::RakeTask.new
+desc 'Run unit and feature tests'
+task test: %i( test:units test:features )

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

@@ -3,22 +3,22 @@
 module Thinreports
   module Core
     module Shape
-      def Interface(parent, format) # rubocop:disable Style/MethodName
+      def Interface(parent, format)
         find_by_type(format.type)::Interface.new(parent, format)
       end
 
-      def Format(type) # rubocop:disable Style/MethodName
+      def Format(type)
         find_by_type(type)::Format
       end
 
       module_function :Interface, :Format
 
-      # rubocop:disable Metrics/CyclomaticComplexity
       def self.find_by_type(type)
         case type
         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
@@ -38,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/base/interface.rb

@@ -30,7 +30,6 @@ module Thinreports
           # @param [Thinreports::Core::Shape::Basic::Format] format
           # @return [Thinreports::Core::Shape::Basic::Internal]
           # @abstract
-          # rubocop:disable Lint/UnusedMethodArgument
           def init_internal(parent, format)
             raise NotImplementedError
           end

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/image_block.rb

@@ -4,7 +4,7 @@ module Thinreports
   module Core
     module Shape
       module ImageBlock
-        TYPE_NAME = 'image-block'.freeze
+        TYPE_NAME = 'image-block'
       end
     end
   end

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

@@ -4,7 +4,7 @@ module Thinreports
   module Core
     module Shape
       module List
-        TYPE_NAME = 'list'.freeze
+        TYPE_NAME = 'list'
       end
     end
   end

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

@@ -4,7 +4,6 @@ module Thinreports
   module Core
     module Shape
       module List
-        # rubocop:disable Metrics/ClassLength
         class Manager
           include Utils
 
@@ -136,9 +135,7 @@ module Thinreports
           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
+            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