thinreports 0.9.1 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c93b3357d3d5cf6c1b61a01e9426482712d918da
-  data.tar.gz: d6947e5e59242e15735d7bb3022dda152ed03d5d
+SHA256:
+  metadata.gz: b53f36fac9af329499239b3db9313911fba89c82dd28cf81ac2e9942bcdce13a
+  data.tar.gz: 38ce4e9d25a709240a1242948a33d96372e3cb6981b07e3121c88967279a3eed
 SHA512:
-  metadata.gz: c05756da8074b034b0747ee7d469086c11348ec9366e2311874230961aa36d82c105453ad0d9079eb6ca0c63b3a05ded8135d8bfb3b17fa41aff330f7c2e2804
-  data.tar.gz: 10805e8930c437ecc4c2c48fb370c93a450d155af49d783405e0ec2289e1f263b3bd8a29111e6675eac8bf67d426df237ecc5f4831e02dbe477e1696bafac73e
+  metadata.gz: 5db1f93781fd6be18f53424eb2853b6701449938f2dc2875f287be74720611361f5dc7b6f657ea9fd96ed83de8056efa92cd4ae7b5b8c0df3d11bb318a81f7d6
+  data.tar.gz: 25d1cc37589223ea85f574f7c6cf007a9e5682dff6f59051286c3fe691b5ab9704d9c5e40e8b3b9b49134406af538aa4e688a74d5416aa1082f6bc1330de173a

data/.github/workflows/test.yml

@@ -0,0 +1,39 @@
+name: Test
+
+on: push
+
+jobs:
+  test:
+    name: Test against ${{ matrix.ruby }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby:
+          - 2.4
+          - 2.5
+          - 2.6
+          - 2.7
+          - jruby
+
+    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: Build and test with Rake
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        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,59 @@
+## master
+
+## 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
+ * Dropped Ruby 1.9.3 and 2.0.0 support
+ * Fixed a bug line-height of a text line-wrapped is broken #36 [@tkobayashi0330]
+ * Remove deprecated top-module `ThinReports`
+ * Remove `config.convert_palleted_transparency_png` option
+ * Remove `config.generator.default` option
+ * Deprecate `:report` and `:generator` argument of `Thinreports::Report.generate`
+
+### Remove config.convert_palleted_transparency_png option
+
+PNG image with indexed transparency has been supported since Prawn version 2.0. And now, thinreports requires Prawn 2.2+, so the unique support in thinreports is no longer needed.
+
+### Remove deprecated top-module ThinReports
+
+Please use `Thinreports` instead.
+
 ## 0.9.1
 
  * Fixed bug that line-height of text-block is always set to 0 #68
@@ -46,8 +102,9 @@ png_image = StringIO.new(png_data)
 page.item(:image_block).src(png_image)
 
 require 'open-uri'
-png_data = open('http://example.com/image.png')
-page.item(:image_block).src(image_data)
+open('http://example.com/image.png') do |image_data|
+  page.item(:image_block).src(image_data)
+end
 ```
 
 ### Remove old way to define callback of list

data/Dockerfile

@@ -0,0 +1,12 @@
+FROM ruby:2.7.1
+
+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,7 +1,10 @@
-source 'http://rubygems.org'
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 gemspec
 
-group :example do
-  gem 'pdf-inspector'
-end
+gem 'minitest', '>= 5.14.1'
+gem 'mocha', '>= 1.11.2'
+gem 'pdf-inspector', '>= 1.3.0'
+gem 'rake', '>= 13.0.1'

data/README.md

@@ -1,9 +1,8 @@
-# Thinreports Generator [![Join the chat at https://gitter.im/thinreports/thinreports-generator](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/thinreports/thinreports-generator?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+# 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,15 +14,13 @@
   * [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)
-  * [Rails4 Example](https://github.com/thinreports/thinreports-rails4-example)
   * [Changelog](https://github.com/thinreports/thinreports-generator/blob/master/CHANGELOG.md)
   * [Discussion Group](https://groups.google.com/forum/#!forum/thinreports)
-  * [![Join the chat at https://gitter.im/thinreports/thinreports-generator](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/thinreports/thinreports-generator?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 ## Supported versions
 
-  * Ruby 1.9.3, 2.0, 2.1, 2.2, 2.3
-  * JRuby 1.7.0+ (1.9 mode)
+  * Ruby 2.4, 2.5, 2.6, 2.7
+  * JRuby 9.2
 
 ## Quick Reference
 
@@ -154,7 +151,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
 
@@ -203,7 +200,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
 
@@ -224,7 +221,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
 
@@ -236,7 +233,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
 
@@ -263,19 +260,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,39 +1,22 @@
-# coding: utf-8
-
+require 'bundler/gem_tasks'
 require 'rake/testtask'
-require 'yard'
+
+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: :_init 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
-
-  task :_init do
-    $:.push File.expand_path('../lib', __FILE__)
-  end
+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
 
-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']
-end
+desc 'Run unit and feature tests'
+task test: %i( test:units test:features )

data/lib/thinreports.rb

@@ -1,19 +1,20 @@
-# coding: utf-8
+# frozen_string_literal: true
+
+require 'pathname'
 
 module Thinreports
-  ROOT = File.expand_path File.join(File.dirname(__FILE__), '..')
+  def self.root
+    @root ||= Pathname.new(__FILE__).join('..', '..')
+  end
 end
 
-require 'thinreports/version'
-require 'thinreports/config'
-require 'thinreports/core/utils'
-require 'thinreports/core/errors'
-require 'thinreports/core/format/base'
-require 'thinreports/core/shape'
-require 'thinreports/core/utils'
-require 'thinreports/report'
-require 'thinreports/layout'
-require 'thinreports/generator'
-
-# Alias for Thinreports
-ThinReports = Thinreports
+require_relative 'thinreports/version'
+require_relative 'thinreports/config'
+require_relative 'thinreports/core/utils'
+require_relative 'thinreports/core/errors'
+require_relative 'thinreports/core/format/base'
+require_relative 'thinreports/core/shape'
+require_relative 'thinreports/core/utils'
+require_relative 'thinreports/report'
+require_relative 'thinreports/layout'
+require_relative 'thinreports/generator/pdf'

data/lib/thinreports/config.rb

@@ -1,10 +1,10 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 module Thinreports
   # @yield [config]
   # @yieldparam [Thinreports::Configuration] config
   def self.configure(&block)
-    Thinreports.call_block_in(self.config, &block)
+    Thinreports.call_block_in(config, &block)
   end
 
   # @return [Thinreports::Configuration]
@@ -15,7 +15,6 @@ module Thinreports
   class Configuration
     def initialize
       @fallback_fonts = []
-      @convert_palleted_transparency_png = false
     end
 
     # @return [Array<String>]
@@ -33,26 +32,5 @@ module Thinreports
     def fallback_fonts=(font_names)
       @fallback_fonts = font_names.is_a?(Array) ? font_names : [font_names]
     end
-
-    # @return [Boolean]
-    # @see https://github.com/thinreports/thinreports-generator/pull/32
-    attr_reader :convert_palleted_transparency_png
-
-    # @param [Boolean]
-    # @example
-    #   config.convert_palleted_transparency_png = true
-    #   config.convert_palleted_transparency_png = false # default
-    # @see https://github.com/thinreports/thinreports-generator/pull/32
-    # @deprecated convert_palleted_transparency_png is deprecated and will be removed in thinreports-generator 1.0 with no replacement
-    def convert_palleted_transparency_png=(enable)
-      warn '[DEPRECATION] convert_palleted_transparency_png is deprecated' \
-           ' and will be removed in thinreports-generator 1.0 with no replacement.' if enable
-      @convert_palleted_transparency_png = enable
-    end
-
-    # @return [Thinreports::Generator::Configuration]
-    def generator
-      @generator ||= Thinreports::Generator::Configuration.new
-    end
   end
 end

data/lib/thinreports/core/errors.rb

@@ -1,15 +1,14 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 module Thinreports
-
   module Errors
     class Basic < ::StandardError
     end
 
     class UnknownShapeStyleName < Basic
       def initialize(style, availables)
-        super("The specified style name, '#{style}', cannot be used. " +
-              "The available styles are #{availables.map{|s| ":#{s}"}.join(', ')}.")
+        super("The specified style name, '#{style}', cannot be used. " \
+              "The available styles are #{availables.map { |s| ":#{s}" }.join(', ')}.")
       end
     end
 
@@ -40,18 +39,9 @@ module Thinreports
       end
     end
 
-    class UnknownEventType < Basic
-    end
-
     class UnknownLayoutId < Basic
     end
 
-    class UnknownGeneratorType < Basic
-      def initialize(type)
-        super("The specified generator type, '#{type}', was not found.")
-      end
-    end
-
     class UnsupportedColorName < Basic
     end
 
@@ -60,12 +50,11 @@ module Thinreports
 
     class IncompatibleLayoutFormat < Basic
       def initialize(filename, fileversion, required_rules)
-        super("Generator #{Thinreports::VERSION} can not be built this file, " +
-              "'#{File.basename(filename)}'. " +
-              "This file is updated in the Editor of version '#{fileversion}', " +
+        super("Generator #{Thinreports::VERSION} can not be built this file, " \
+              "'#{File.basename(filename)}'. " \
+              "This file is updated in the Editor of version '#{fileversion}', " \
               "but Generator requires version #{required_rules}.")
       end
     end
   end
-
 end