thinreports 0.9.1 → 0.11.0

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

@@ -1,120 +1,125 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 module Thinreports
-  module Generator::PDF::Drawer
-
-    class Page < Base
-      # @param (see PDF::Drawer::Base#initialize)
-      def initialize(pdf, format)
-        super
-        @lists = {}
-      end
+  module Generator
+    class PDF
+      module Drawer
+        class Page < Base
+          # @param (see PDF::Drawer::Base#initialize)
+          def initialize(pdf, format)
+            super
+            @lists = {}
+          end
 
-      # @param [Thinreports::Report::Page] page
-      def draw(page)
-        manager = page.manager
+          # @param [Thinreports::Report::Page] page
+          def draw(page)
+            manager = page.manager
 
-        manager.format.shapes.each_key do |id|
-          shape = manager.final_shape(id)
-          next unless shape
+            manager.format.shapes.each_key do |id|
+              shape = manager.final_shape(id)
+              next unless shape
 
-          shape = shape.internal
+              shape = shape.internal
 
-          if shape.type_of?(Core::Shape::PageNumber::TYPE_NAME)
-            # Do not draw pageno if is not for Report
-            draw_pageno_shape(shape, page) if page.count? && shape.for_report?
-          else
-            draw_shape(shape)
+              if shape.type_of?(Core::Shape::PageNumber::TYPE_NAME)
+                # Do not draw pageno if is not for Report
+                draw_pageno_shape(shape, page) if page.count? && shape.for_report?
+              else
+                draw_shape(shape)
+              end
+            end
           end
-        end
-      end
 
-    private
-
-      def draw_shape(shape)
-        case
-        when shape.type_of?(Core::Shape::TextBlock::TYPE_NAME)
-          draw_tblock_shape(shape)
-        when shape.type_of?(Core::Shape::List::TYPE_NAME)
-          draw_list_shape(shape)
-        when shape.type_of?(Core::Shape::ImageBlock::TYPE_NAME)
-          draw_iblock_shape(shape)
-        else
-          id = shape.identifier
-          unless @stamps.include?(id)
-            create_basic_shape_stamp(shape)
-            @stamps << id
+          private
+
+          def draw_shape(shape)
+            if shape.type_of?(Core::Shape::TextBlock::TYPE_NAME)
+              draw_tblock_shape(shape)
+            elsif shape.type_of?(Core::Shape::List::TYPE_NAME)
+              draw_list_shape(shape)
+            elsif shape.type_of?(Core::Shape::ImageBlock::TYPE_NAME)
+              draw_iblock_shape(shape)
+            else
+              id = shape.identifier
+              unless @stamps.include?(id)
+                create_basic_shape_stamp(shape)
+                @stamps << id
+              end
+              pdf_stamp(shape)
+            end
           end
-          pdf_stamp(shape)
-        end
-      end
 
-      def draw_pageno_shape(shape, page)
-        @pdf.draw_shape_pageno(shape, page.no, page.report.page_count)
-      end
+          def draw_pageno_shape(shape, page)
+            @pdf.draw_shape_pageno(shape, page.no, page.report.page_count)
+          end
 
-      # @see #draw_shape
-      def draw_list_shape(shape)
-        drawer = @lists[shape.id] ||= List.new(@pdf, shape.format)
-        drawer.draw(shape)
-      end
+          # @see #draw_shape
+          def draw_list_shape(shape)
+            drawer = @lists[shape.id] ||= List.new(@pdf, shape.format)
+            drawer.draw(shape)
+          end
 
-      # @see #draw_shape
-      def draw_tblock_shape(shape)
-        @pdf.draw_shape_tblock(shape)
-      end
+          # @see #draw_shape
+          def draw_tblock_shape(shape)
+            @pdf.draw_shape_tblock(shape)
+          end
 
-      # @see #draw_shape
-      def draw_iblock_shape(shape)
-        @pdf.draw_shape_iblock(shape)
-      end
+          # @see #draw_shape
+          def draw_iblock_shape(shape)
+            @pdf.draw_shape_iblock(shape)
+          end
 
-      # @param [Thinreports::Core::Shape::Base::Internal] shape
-      def create_basic_shape_stamp(shape)
-        case
-        when shape.type_of?('text')    then create_text_stamp(shape)
-        when shape.type_of?('image')   then create_image_stamp(shape)
-        when shape.type_of?('ellipse') then create_ellipse_stamp(shape)
-        when shape.type_of?('rect')    then create_rect_stamp(shape)
-        when shape.type_of?('line')    then create_line_stamp(shape)
-        end
-      end
+          # @param [Thinreports::Core::Shape::Base::Internal] shape
+          def create_basic_shape_stamp(shape)
+            if shape.type_of?('text')
+              create_text_stamp(shape)
+            elsif shape.type_of?('image')
+              create_image_stamp(shape)
+            elsif shape.type_of?('ellipse')
+              create_ellipse_stamp(shape)
+            elsif shape.type_of?('rect')
+              create_rect_stamp(shape)
+            elsif shape.type_of?('line')
+              create_line_stamp(shape)
+            end
+          end
 
-      # @see #create_basic_shape_stamp
-      def create_image_stamp(shape)
-        create_pdf_stamp(shape) do
-          @pdf.draw_shape_image(shape)
-        end
-      end
+          # @see #create_basic_shape_stamp
+          def create_image_stamp(shape)
+            create_pdf_stamp(shape) do
+              @pdf.draw_shape_image(shape)
+            end
+          end
 
-      # @see #create_basic_shape_stamp
-      def create_rect_stamp(shape)
-        create_pdf_stamp(shape) do
-          @pdf.draw_shape_rect(shape)
-        end
-      end
+          # @see #create_basic_shape_stamp
+          def create_rect_stamp(shape)
+            create_pdf_stamp(shape) do
+              @pdf.draw_shape_rect(shape)
+            end
+          end
 
-      # @see #create_basic_shape_stamp
-      def create_ellipse_stamp(shape)
-        create_pdf_stamp(shape) do
-          @pdf.draw_shape_ellipse(shape)
-        end
-      end
+          # @see #create_basic_shape_stamp
+          def create_ellipse_stamp(shape)
+            create_pdf_stamp(shape) do
+              @pdf.draw_shape_ellipse(shape)
+            end
+          end
 
-      # @see #create_basic_shape_stamp
-      def create_line_stamp(shape)
-        create_pdf_stamp(shape) do
-          @pdf.draw_shape_line(shape)
-        end
-      end
+          # @see #create_basic_shape_stamp
+          def create_line_stamp(shape)
+            create_pdf_stamp(shape) do
+              @pdf.draw_shape_line(shape)
+            end
+          end
 
-      # @see #create_basic_shape_stamp
-      def create_text_stamp(shape)
-        create_pdf_stamp(shape) do
-          @pdf.draw_shape_text(shape)
+          # @see #create_basic_shape_stamp
+          def create_text_stamp(shape)
+            create_pdf_stamp(shape) do
+              @pdf.draw_shape_text(shape)
+            end
+          end
         end
       end
     end
-
   end
 end

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

@@ -1,32 +1,6 @@
-# coding: utf-8
+# frozen_string_literal: true
 
-module Prawn
-  class Document
-    alias_method :original_width_of, :width_of
+require_relative 'prawn_ext/width_of'
+require_relative 'prawn_ext/calc_image_dimensions'
 
-    def width_of(string, options={})
-      font.compute_width_of(string, options) +
-        (character_spacing * (font.character_count(string) - 1))
-    end
-  end
-
-  module Images
-    class Image
-      alias_method :original_calc_image_dimensions, :calc_image_dimensions
-
-      def calc_image_dimensions(options)
-        if options[:auto_fit]
-          w = options[:width] || width
-          h = options[:height] || height
-
-          box_width, box_height = options.delete(:auto_fit)
-
-          if w > box_width || h > box_height
-            options[:fit] = [box_width, box_height]
-          end
-        end
-        original_calc_image_dimensions(options)
-      end
-    end
-  end
-end
+Prawn::Font::AFM.hide_m17n_warning = true

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Thinreports
+  module Generator
+    module PrawnExt
+      module CalcImageDimensions
+        # Implement :auto_fit option for image size calculation.
+        #
+        # When the image is larger than the box, the original: fit option does not change
+        # the image size. The :auto_fit option changes the image size to fit in the box
+        # while maintaining the aspect ratio.
+        #
+        # Usage:
+        #   image '/path/to/image.png', at: [100, 100], auto_fit: [100, 100]
+        #
+        def calc_image_dimensions(options)
+          if options[:auto_fit]
+            image_width = options[:width] || width
+            image_height = options[:height] || height
+
+            box_width, box_height = options.delete(:auto_fit)
+
+            options[:fit] = [box_width, box_height] if image_width > box_width || image_height > box_height
+          end
+          super(options)
+        end
+      end
+    end
+  end
+end
+
+Prawn::Images::Image.prepend Thinreports::Generator::PrawnExt::CalcImageDimensions

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Thinreports
+  module Generator
+    module PrawnExt
+      module WidthOf
+        # TODO: Remove this path when a version of prawn that includes the following PR is released:
+        # https://github.com/prawnpdf/prawn/pull/1117
+        #
+        # This PR makes this patch unnecessary.
+        #
+        #
+        # Subtract the width of one character space from the string width calculation result.
+        #
+        # The original Prawn::Document#width_of returns the following result:
+        #
+        #  Width of Character is 1
+        #  Width of Character Space is 1
+        #
+        #   width_of('abcd') #=> 4 + 4 = 8
+        #
+        # In this width_of, returns the following result:
+        #
+        #   width_of('abcd') #=> 4 + 3 = 7
+        #
+        def width_of(*)
+          width = super - character_spacing
+          width > 0 ? width : 0
+        end
+      end
+    end
+  end
+end
+
+Prawn::Document.prepend Thinreports::Generator::PrawnExt::WidthOf

data/lib/thinreports/layout.rb

@@ -1,17 +1,15 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 module Thinreports
-
   module Layout
     # @see Thinreports::Layout::Base#initialize
     def self.new(filename, options = {})
       Base.new(filename, options)
     end
   end
-
 end
 
-require 'thinreports/layout/version'
-require 'thinreports/layout/base'
-require 'thinreports/layout/format'
-require 'thinreports/layout/legacy_schema'
+require_relative 'layout/version'
+require_relative 'layout/base'
+require_relative 'layout/format'
+require_relative 'layout/legacy_schema'

data/lib/thinreports/layout/base.rb

@@ -1,8 +1,7 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 module Thinreports
   module Layout
-
     class Base
       EXT_NAME = 'tlf'
       include Utils
@@ -13,11 +12,9 @@ module Thinreports
         # @raise [Thinreports::Errors::InvalidLayoutFormat]
         # @raise [Thinreports::Errors::IncompatibleLayoutFormat]
         def load_format(filename)
-          filename += ".#{EXT_NAME}" unless filename =~/\.#{EXT_NAME}$/
+          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
@@ -36,8 +33,8 @@ module Thinreports
       # @option options [Symbol] :id (nil)
       def initialize(filename, options = {})
         @filename = filename
-        @format   = self.class.load_format(filename)
-        @id       = options[:id]
+        @format = self.class.load_format(filename)
+        @id = options[:id]
       end
 
       # @return [Boolean] Return the true if is default layout.
@@ -45,6 +42,5 @@ module Thinreports
         @id.nil?
       end
     end
-
   end
 end

data/lib/thinreports/layout/format.rb

@@ -1,28 +1,32 @@
-# coding: utf-8
+# frozen_string_literal: true
+
 require 'json'
 
 module Thinreports
   module Layout
     class Format < Core::Shape::Manager::Format
-      config_reader last_version: %w( version )
-      config_reader report_title: %w( title )
-      config_reader page_paper_type: %w( report paper-type ),
-                    page_width: %w( report width ),
-                    page_height: %w( report height ),
-                    page_orientation: %w( report orientation )
+      config_reader last_version: %w[version]
+      config_reader report_title: %w[title]
+      config_reader page_paper_type: %w[report paper-type],
+                    page_width: %w[report width],
+                    page_height: %w[report height],
+                    page_orientation: %w[report orientation]
 
       class << self
         def build(filename)
           schema = JSON.parse(read_file(filename))
+          schema_version = Layout::Version.new(schema['version'])
 
-          unless Layout::Version.compatible?(schema['version'])
+          unless schema_version.compatible?
             raise Errors::IncompatibleLayoutFormat.new(
-              filename, schema['version'], Thinreports::Layout::Version.inspect_required_rules
+              filename, schema['version'],
+              Layout::Version.compatible_rules.join(' and ')
             )
           end
 
-          if schema['version'] < '0.9.0'
-            warn '[DEPRECATION] Support for the layout file with old format that generated with Editor 0.8 or lower will be dropped in Thinreports 1.1.' \
+          if schema_version.legacy?
+            warn '[DEPRECATION] Support for the layout file with old format' \
+                 ' that generated with Editor 0.8 or lower will be dropped in Thinreports 1.1.' \
                  ' Please convert to new layout format using Thinreports Editor 0.9 or 1.0.'
             schema = Layout::LegacySchema.new(schema).upgrade
           end
@@ -31,7 +35,7 @@ module Thinreports
         end
 
         def read_file(filename)
-          File.open(filename, 'r:UTF-8') {|f| f.read }
+          File.read(filename, encoding: 'UTF-8')
         end
       end
 
@@ -53,7 +57,7 @@ module Thinreports
           next if id.empty? && type != 'page-number'
 
           item = Core::Shape::Format(type).new(item_schema)
-          self.shapes[item.id.to_sym] = item
+          shapes[item.id.to_sym] = item
         end
       end
     end