thinreports 0.12.1 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3abf53b7bac12b336d4ef9b4af7dd4400081eeb632f8ece362e60f6cca47c2b4
-  data.tar.gz: 4461aca74ccae200d234715a06bbc60e753a7694053116c58ef2d031b8f01047
+  metadata.gz: ec1ca9a25621cae05c4f5933c6a89f7bdf13dff54707fcc4c9c56042adfafa20
+  data.tar.gz: 447d3529dcc71e8b76864fe63dca034852d24d6464ba55709bdcd721d5360b9d
 SHA512:
-  metadata.gz: 8ebae61bcd5ce2524bc8c09eff3f2fa047de632a250dfce9390a4db78b806d945ed32ea563c1063836d938e139b433b53c595592ec741a3a0c719bb74d7ffb1b
-  data.tar.gz: ef7d77b8edaf345b546cc42bb4f2ac98d23e2e74fe62921a181976ff38f11c6f4a6ef875ede3bcb40dfd0fa02ddc42cfe532df7c7bad633efe4f8cfd056a32ca
+  metadata.gz: f6e53ec1903941f693501393e5ebc07221d9d6a50c287aee7e4219b2ff224747b021c7be671d6b39a758b0add7f9060c67b37f8fa08d4e95c0f9cb1aaa3e8774
+  data.tar.gz: 7a32cf28566ae5bdb4766f9c944c4efb2cbfdcc6eb0319f719815cc33a8c1950a43307e131d6e032dfd09cf2340669c9054d39ed632ef46290c4f385df59999b

data/.github/dependabot.yml

@@ -5,7 +5,7 @@
 
 version: 2
 updates:
-  - package-ecosystem: "bundler"
-    directory: "/"
+  - package-ecosystem: github-actions
+    directory: /
     schedule:
-      interval: "daily"
+      interval: daily

data/.github/workflows/test.yml

@@ -3,48 +3,40 @@ name: Test
 on: [push, pull_request]
 
 jobs:
-  test:
-    name: Test against ruby ${{ matrix.ruby }} and prawn ${{ matrix.prawn }}
+  setup:
+    name: Ruby ${{ matrix.ruby }}
+
     runs-on: ubuntu-latest
+
     # Run this build only on either pull request or push.
     if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository
 
     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
+          - "2.7"
+          - "3.0"
+          - "3.1"
+          - "3.2"
 
     steps:
-    - uses: actions/checkout@v2
-
-    - uses: hidakatsuya/setup-diff-pdf@v1
-      with:
-        diff-pdf-version: 0.5
-
-    - 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
+      - uses: actions/checkout@v4
+
+      - uses: hidakatsuya/action-setup-diff-pdf@v1
+        with:
+          diff-pdf-version: "0.5"
+
+      - name: Set up Ruby ${{ matrix.ruby }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Run tests for main
+        run: bundle exec rake test:main
+
+      - name: Run tests for basic report
+        run: xvfb-run -a bundle exec rake test:basic_report
+
+      - name: Run tests for section report
+        run: xvfb-run -a bundle exec rake test:section_report

data/.gitignore

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

data/CHANGELOG.md

@@ -1,4 +1,22 @@
-## master (Unreleased)
+## main (Unreleased)
+
+## 0.13.0
+
+Breaking Changes:
+
+ * Drop Ruby 2.5,2.6,JRuby support
+ * Drop Prawn 2.2, 2.3 support
+ * Moved Basic Format implementation to `Thinreports::BasicReport` namespace
+   * `Thinreports::Report` and `Thinreports::Layout` are defined as aliases for `Thinreports::BasicReport::Report` and `Thinreports::BasicReport::Layout` respectively, but other than those can be a destructive change if you rely on internal implementations
+
+Enhancements:
+
+ * Allow any string to be set to the title attribute of the PDF document metadata #125
+ * Add Ruby 3.1, 3.2 support
+
+Notes:
+
+ * thinreports gem has opted in to the ["MFA required to publish" setting](https://guides.rubygems.org/mfa-requirement-opt-in/) on Rubygems.org
 
 ## 0.12.1
 

data/Gemfile

@@ -1,6 +1,17 @@
 # frozen_string_literal: true
 
 source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
 gemspec
 
+gem 'rake'
+gem 'minitest'
+gem 'mocha'
+gem 'pdf-inspector'
+gem 'matrix'
+gem 'pdf_matcher-testing'
+
+# suppress warning: assigned but unused variable - y1
+# https://github.com/yob/pdf-reader/pull/502
+gem 'pdf-reader', github: 'yob/pdf-reader', ref: 'dc7e6e46e1d842486bd34288df087b590e8a7b38'

data/README.md

@@ -9,9 +9,8 @@ A Ruby library for [Thinreports](https://github.com/thinreports/thinreports).
 
 ### Supported Versions
 
-- Ruby 2.5, 2.6, 2.7, 3.0
-- JRuby 9.2
-- Prawn 2.2, 2.3, 2.4
+- Ruby 2.7, 3.0, 3.1, 3.2
+- Prawn 2.4+
 
 ## Installation
 
@@ -40,7 +39,7 @@ See [the README](https://github.com/thinreports/thinreports) for usage of the Se
 
 ### Basic Format
 
-The template file (`.tlf`) must be created in [the Basic Editor of the Thinreports Editor](https://github.com/thinreports/thinreports-editor/tree/master/basic-editor).
+The template file (`.tlf`) must be created in the [Thinreports Basic Editor](https://github.com/thinreports/thinreports-basic-editor/).
 
 ```ruby
 require 'thinreports'
@@ -165,7 +164,7 @@ report.on_page_create do |page|
 end
 ```
 
-See also [features/report_callbacks](https://github.com/thinreports/thinreports-generator/tree/master/test/features/report_callbacks).
+See also [basic_report/features/report_callbacks](https://github.com/thinreports/thinreports-generator/tree/main/test/basic_report/features/report_callbacks).
 
 #### List
 
@@ -214,7 +213,7 @@ report.list do |list|
 end
 ```
 
-See also  [features/list_events](https://github.com/thinreports/thinreports-generator/tree/master/test/features/list_events).
+See also  [basic_report/features/list_events](https://github.com/thinreports/thinreports-generator/tree/main/test/basic_report/features/list_events).
 
 #### Page Number
 
@@ -235,7 +234,7 @@ report.start_new_page do |page|
 end
 ```
 
-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).
+See also [basic_report/features/page_number](https://github.com/thinreports/thinreports-generator/blob/main/test/basic_report/features/page_number) and [basic_report/features/page_number_with_list](https://github.com/thinreports/thinreports-generator/blob/main/test/basic_report/features/page_number_with_list).
 
 #### Configuring fallback fonts
 
@@ -247,21 +246,17 @@ end
 Thinreports.config.fallback_fonts = ['/path/to/font_a.ttf', '/path/to/font_b.ttf']
 ```
 
-See also [features/eudc](https://github.com/thinreports/thinreports-generator/blob/master/test/features/eudc).
+See also [basic_report/features/eudc](https://github.com/thinreports/thinreports-generator/blob/main/test/basic_report/features/eudc).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/thinreports/thinreports-generator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/thinreports/thinreports/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/thinreports/thinreports-generator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/thinreports/thinreports/blob/main/CODE_OF_CONDUCT.md).
 
 ## Development
 
-### How to run feature tests
+### Feature test requires diff-pdf command
 
-```
-$ 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.
+In order to run feature test, 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
 
@@ -278,7 +273,7 @@ You can run test:
 
 ```
 > /src# bundle install
-> /src# bundle exec rake test:features
+> /src# bundle exec rake test
 ```
 
 ## Releasing Generator
@@ -287,7 +282,7 @@ You can run test:
 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
+5. Is the main 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

@@ -4,19 +4,25 @@ require 'rake/testtask'
 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/units/**/test_*.rb']
+  t.name = 'test:main'
+  t.description = 'Run tests for main'
+  t.libs << 'test/main'
+  t.test_files = Dir['test/main/**/test_*.rb']
 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
+  t.name = 'test:basic_report'
+  t.description = 'Run tests for basic report'
+  t.libs << 'test' << 'test/basic_report'
+  t.test_files = Dir['test/basic_report/**/test_*.rb']
 end
 
-desc 'Run unit and feature tests'
-task test: %i( test:units test:features )
+Rake::TestTask.new do |t|
+  t.name = 'test:section_report'
+  t.description = 'Run tests for section report'
+  t.libs << 'test' << 'test/section_report'
+  t.test_files = Dir['test/section_report/**/test_*.rb']
+end
+
+desc 'Run all tests'
+task test: %i(test:main test:basic_report test:section_report)

data/lib/thinreports/basic_report/core/errors.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Thinreports
+  module BasicReport
+    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(', ')}.")
+        end
+      end
+
+      class UnknownShapeType < Basic
+      end
+
+      class UnknownFormatterType < Basic
+      end
+
+      class LayoutFileNotFound < Basic
+      end
+
+      class FontFileNotFound < Basic
+      end
+
+      class NoRegisteredLayoutFound < Basic
+      end
+
+      class UnknownItemId < Basic
+        def initialize(id, item_type = 'Basic')
+          super("The layout does not have a #{item_type} Item with id '#{id}'.")
+        end
+      end
+
+      class DisabledListSection < Basic
+        def initialize(section)
+          super("The #{section} section is disabled.")
+        end
+      end
+
+      class UnknownLayoutId < Basic
+      end
+
+      class UnsupportedColorName < Basic
+      end
+
+      class InvalidLayoutFormat < Basic
+      end
+
+      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}', " \
+                "but Generator requires version #{required_rules}.")
+        end
+      end
+    end
+  end
+end

data/lib/thinreports/basic_report/core/format/base.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Thinreports
+  module BasicReport
+    module Core
+      module Format
+        # @abstract
+        class Base
+          class << self
+            def config_reader(*configs, &block)
+              each_configs(*configs) do |m, location|
+                define_read_method(m, location, &block)
+              end
+            end
+
+            def config_checker(check, *configs)
+              checker = ->(val) { val == check }
+              each_configs(*configs) do |m, location|
+                define_read_method(:"#{m}?", location, &checker)
+              end
+            end
+
+            def config_writer(*configs)
+              each_configs(*configs) do |m, location|
+                define_write_method(m, location)
+              end
+            end
+
+            def config_accessor(*configs, &block)
+              config_reader(*configs, &block)
+              config_writer(*configs)
+            end
+
+            private
+
+            def define_read_method(m, location = nil, &block)
+              define_method(m) do
+                read(*location, &block)
+              end
+            end
+
+            def define_write_method(m, location = nil)
+              define_method(:"#{m}=") do |value|
+                write(value, *location)
+              end
+            end
+
+            def each_configs(*configs, &block)
+              c = configs.first.is_a?(::Hash) ? configs.first : (configs || [])
+              c.each do |m, location|
+                block.call(m, location || [m.to_s])
+              end
+            end
+          end
+
+          def initialize(config, &block)
+            @config = config
+            block.call(self) if ::Kernel.block_given?
+          end
+
+          def attributes
+            @config
+          end
+
+          private
+
+          def find(*keys)
+            if keys.empty?
+              @config
+            else
+              keys.inject(@config) do |c, k|
+                c.is_a?(::Hash) ? c[k] : (break c)
+              end
+            end
+          end
+
+          def write(value, *keys)
+            key = keys.pop
+            owner = find(*keys)
+            owner[key] = value
+          end
+
+          def read(*keys, &block)
+            value = find(*keys)
+            ::Kernel.block_given? ? block.call(value) : value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/thinreports/basic_report/core/shape/base/interface.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Thinreports
+  module BasicReport
+    module Core
+      module Shape
+        module Base
+          # @abstract
+          class Interface
+            include Utils
+            extend  Forwardable
+
+            def self.internal_delegators(*args)
+              def_delegators :internal, *args
+            end
+            private_class_method :internal_delegators
+
+            attr_reader :internal
+
+            def initialize(parent, format, internal = nil)
+              @internal = internal || init_internal(parent, format)
+            end
+
+            def copy(parent)
+              self.class.new(parent, internal.format, internal.copy(parent))
+            end
+
+            private
+
+            # @param [Thinreports::BasicReport::Report::Page, Thinreports::BasicReport::Core::Shape::List::SectionInterface] parent
+            # @param [Thinreports::BasicReport::Core::Shape::Basic::Format] format
+            # @return [Thinreports::BasicReport::Core::Shape::Basic::Internal]
+            # @abstract
+            def init_internal(parent, format)
+              raise NotImplementedError
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/thinreports/basic_report/core/shape/base/internal.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Thinreports
+  module BasicReport
+    module Core
+      module Shape
+        module Base
+          # @abstract
+          class Internal
+            include Utils
+            extend  Forwardable
+
+            def self.format_delegators(*args)
+              def_delegators :format, *args
+            end
+            private_class_method :format_delegators
+
+            attr_reader :parent
+            attr_reader :format
+            attr_writer :style
+            attr_accessor :states
+
+            def initialize(parent, format)
+              @parent = parent
+              @format = format
+              @states = {}
+              @style = nil
+
+              @finalized_attributes = nil
+            end
+
+            def style
+              raise NotImplementedError
+            end
+
+            def copy(new_parent, &block)
+              new_internal = self.class.new(new_parent, format)
+              new_internal.style = style.copy
+              new_internal.states = deep_copy(states)
+
+              block.call(new_internal) if block_given?
+              new_internal
+            end
+
+            def type_of?
+              raise NotImplementedError
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/thinreports/basic_report/core/shape/basic/block_format.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Thinreports
+  module BasicReport
+    module Core
+      module Shape
+        module Basic
+          class BlockFormat < Basic::Format
+            config_reader :value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/thinreports/basic_report/core/shape/basic/block_interface.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Thinreports
+  module BasicReport
+    module Core
+      module Shape
+        module Basic
+          class BlockInterface < Basic::Interface
+            # @overload value(val)
+            #   Set a val
+            #   @param [Object] val
+            #   @return [self]
+            # @overload value
+            #   Return the value
+            #   @return [Object]
+            def value(*args)
+              if args.empty?
+                internal.read_value
+              else
+                internal.write_value(args.first)
+                self
+              end
+            end
+
+            # @param [Object] val
+            def value=(val)
+              value(val)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/thinreports/basic_report/core/shape/basic/block_internal.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Thinreports
+  module BasicReport
+    module Core
+      module Shape
+        module Basic
+          class BlockInternal < Basic::Internal
+            format_delegators :box
+
+            def style
+              @style ||= Style::Basic.new(format)
+            end
+
+            def read_value
+              states.key?(:value) ? states[:value] : format.value.dup
+            end
+            alias value read_value
+
+            def write_value(val)
+              states[:value] = val
+            end
+
+            def real_value
+              read_value
+            end
+
+            def type_of?(type_name)
+              type_name == :block
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Thinreports
+  module BasicReport
+    module Core
+      module Shape
+        module Basic
+          class Format < Core::Format::Base
+            include Utils
+
+            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
+    end
+  end
+end