thinreports 0.9.1 → 0.10.0

data/lib/thinreports/layout/legacy_schema.rb

@@ -1,10 +1,11 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 require 'json'
 require 'rexml/document'
 
 module Thinreports
   module Layout
+    # rubocop:disable Metrics/ClassLength
     class LegacySchema
       include Utils
 
@@ -13,9 +14,10 @@ module Thinreports
         @legacy_svg = legacy_schema['svg'].dup
         @legacy_item_schemas = extract_legacy_item_schemas(legacy_svg)
 
-        normalize_svg!(@legacy_svg)
+        @legacy_svg = cleanup_svg(@legacy_svg)
       end
 
+      # rubocop:disable Metrics/AbcSize
       def upgrade
         config = legacy_schema['config']
         page_config = config['page']
@@ -28,7 +30,12 @@ module Thinreports
             'width' => page_config['width'].to_f,
             'height' => page_config['height'].to_f,
             'orientation' => page_config['orientation'],
-            'margin' => page_config.values_at('margin-top', 'margin-right', 'margin-bottom', 'margin-left').map(&:to_f)
+            'margin' => page_config.values_at(
+              'margin-top',
+              'margin-right',
+              'margin-bottom',
+              'margin-left'
+            ).map(&:to_f)
           },
           'items' => item_schemas
         }
@@ -41,6 +48,7 @@ module Thinreports
         build_item_schemas_from_svg(svg.elements['/svg/g'])
       end
 
+      # rubocop:disable Metrics/CyclomaticComplexity
       def build_item_schemas_from_svg(svg_elements)
         return [] unless svg_elements
 
@@ -78,7 +86,7 @@ module Thinreports
           'display' => display(attributes['x-display']),
           'texts' => texts,
           'style' => {
-            'font-family' => [ attributes['font-family'] ],
+            'font-family' => [attributes['font-family']],
             'font-size' => attributes['font-size'].to_f,
             'color' => attributes['fill'],
             'font-style' => font_style(attributes),
@@ -144,7 +152,7 @@ module Thinreports
       end
 
       def image_item_schema(attributes)
-        _, image_type, image_data = attributes['xlink:href'].match(%r|^data:(image/[a-z]+?);base64,(.+)|).to_a
+        _, image_type, image_data = attributes['xlink:href'].match(%r{^data:(image/[a-z]+?);base64,(.+)}).to_a
 
         {
           'id' => attributes['x-id'],
@@ -173,7 +181,7 @@ module Thinreports
           'target' => attributes['x-target'],
           'display' => display(attributes['x-display']),
           'style' => {
-            'font-family' => [ attributes['font-family'] ],
+            'font-family' => [attributes['font-family']],
             'font-size' => attributes['font-size'].to_f,
             'color' => attributes['fill'],
             'font-style' => font_style(attributes),
@@ -235,7 +243,7 @@ module Thinreports
           'format' => text_format,
           'reference-id' => attributes['x-ref-id'],
           'style' => {
-            'font-family' => [ attributes['font-family'] ],
+            'font-family' => [attributes['font-family']],
             'font-size' => attributes['font-size'].to_f,
             'color' => attributes['fill'],
             'font-style' => font_style(attributes),
@@ -368,9 +376,9 @@ module Thinreports
         items
       end
 
-      def normalize_svg!(svg)
-        svg.gsub!(/<!--SHAPE.*?SHAPE-->/, '')
-        svg.gsub!(/<!--LAYOUT(.*?)LAYOUT-->/) { $1 }
+      def cleanup_svg(svg)
+        cleaned_svg = svg.gsub(/<!--SHAPE.*?SHAPE-->/, '')
+        cleaned_svg.gsub(/<!--LAYOUT(.*?)LAYOUT-->/) { $1 }
       end
     end
   end

data/lib/thinreports/layout/version.rb

@@ -1,42 +1,39 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 module Thinreports
   module Layout
+    class Version
+      COMPATIBLE_RULES = ['>= 0.8.0', '< 1.0.0'].freeze
+      NEW_SCHEMA_FROM = '0.9.0'.freeze
 
-    module Version
-      REQUIRED_RULES = ['>= 0.8.0', '< 1.0.0']
+      class << self
+        def compatible_rules
+          COMPATIBLE_RULES
+        end
+      end
 
-      # @param [String] version
-      # @return [Boolean]
-      def self.compatible?(version)
-        compare(version, *REQUIRED_RULES)
+      def initialize(schema_version)
+        @schema_version = normalize_version(schema_version)
       end
 
-      # @param [String] base
-      # @param [Array<String>] rules
-      # @return [Boolean]
-      def self.compare(base, *rules)
-        rules.all? do |rule|
+      def compatible?
+        self.class.compatible_rules.all? do |rule|
           op, ver = rule.split(' ')
-          comparable_version(base).send(op.to_sym, comparable_version(ver))
+          schema_version.send(op.to_sym, normalize_version(ver))
         end
       end
 
-      # @return [String]
-      def self.inspect_required_rules
-        '(' + REQUIRED_RULES.join(' and ') + ')'
+      def legacy?
+        @schema_version < normalize_version(NEW_SCHEMA_FROM)
       end
 
-      # @param [String] version
-      # @return [String]
-      def self.comparable_version(version)
-        if version =~ /pre/
-          version.sub(/pre(\d*)$/) { $1 == '' ? '1' : $1 }
-        else
-          "#{version}.99"
-        end
+      private
+
+      attr_reader :schema_version
+
+      def normalize_version(version)
+        Gem::Version.create(version)
       end
     end
-
   end
 end

data/lib/thinreports/report.rb

@@ -1,7 +1,6 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 module Thinreports
-
   module Report
     # @see Thinreports::Report::Base#initialize
     def self.new(*args)
@@ -18,9 +17,8 @@ module Thinreports
       Base.generate(*args, &block)
     end
   end
-
 end
 
-require 'thinreports/report/base'
-require 'thinreports/report/internal'
-require 'thinreports/report/page'
+require_relative 'report/base'
+require_relative 'report/internal'
+require_relative 'report/page'

data/lib/thinreports/report/base.rb

@@ -1,8 +1,7 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 module Thinreports
   module Report
-
     class Base
       extend  Forwardable
       include Utils
@@ -14,9 +13,8 @@ module Thinreports
         # @yieldparam [Thinreports::Report::Base] report
         # @return [Thinreports::Report::Base]
         def create(options = {}, &block)
-          unless block_given?
-            raise ArgumentError, '#create requires a block'
-          end
+          raise ArgumentError, '#create requires a block' unless block_given?
+
           report = new(options)
           call_block_in(report, &block)
           report.finalize
@@ -24,43 +22,28 @@ module Thinreports
           report
         end
 
-        # @overload generate(type, options = {}, &block)
-        #   @param [Symbol] type
-        #   @param [Hash] options
-        #   @option options [Hash] :report ({}) Options for Report.
-        #   @option options [Hash] :generator ({}) Options for Generator.
-        # @overload generate(options = {}, &block)
-        #   @param [Hash] options
-        #   @option options [Hash] :report ({}) Options for Report.
-        #   @option options [Hash] :generator ({}) Options for Generator.
+        # @param layout (see #initialize)
+        # @param filename (see #generate)
+        # @param security (see #generate)
+        # @param [Hash] report ({}) DEPRECATED. Options for Report.
+        # @param [Hash] generator ({}) DEPRECATED. Options for Generator.
         # @yield (see .create)
         # @yieldparam (see .create)
         # @return [String]
-        def generate(*args, &block)
+        def generate(layout: nil, filename: nil, security: nil, report: {}, generator: {}, &block)
           raise ArgumentError, '#generate requires a block' unless block_given?
 
-          report_opts, generator_opts = extract_options!(args)
+          if report.any? || generator.any?
+            warn '[DEPRECATION] :report and :generator argument has been deprecated. ' \
+                 'Use :layout and :filename, :security argument instead.'
+          end
 
-          report = create(report_opts, &block)
-          report.generate(*args.push(generator_opts))
-        end
+          layout ||= report[:layout]
+          filename ||= generator[:filename]
+          security ||= generator[:security]
 
-        # @param [Array] args
-        # @return [Array<Hash>]
-        def extract_options!(args)
-          if args.last.is_a?(::Hash)
-            options = args.pop
-
-            generator = options.delete(:generator) || {}
-            report    = options.delete(:report) || {}
-
-            if options.key?(:layout)
-              report[:layout] = options.delete(:layout)
-            end
-            [report, generator.merge(options)]
-          else
-            [{}, {}]
-          end
+          report = create(layout: layout, &block)
+          report.generate(filename: filename, security: security)
         end
       end
 
@@ -150,7 +133,7 @@ module Thinreports
       def add_blank_page(options = {})
         internal.add_page(Report::BlankPage.new(options[:count]))
       end
-      alias_method :blank_page, :add_blank_page
+      alias blank_page add_blank_page
 
       # @param [Symbol, nil] id
       # @return [Thinreports::Layout::Base]
@@ -163,24 +146,15 @@ module Thinreports
         end
       end
 
-      # @overload generate(options = {})
-      #   @param [Hash] options ({})
-      #   @return [String]
-      # @overload generate(type, options = {})
-      #   This way has been DEPRECATED. Use instead #generate(options = {}).
-      #   @param [Symbol] type
-      #   @return [String]
+      # @param [String] filename
+      # @param [Hash] security (see http://prawnpdf.org/api-docs/2.0/Prawn/Document/Security.html#encrypt_document-instance_method)
+      # @return [String]
       # @example Generate PDF data
       #   report.generate # => "%PDF-1.4...."
       # @example Create a PDF file
       #   report.generate(filename: 'foo.pdf')
-      def generate(*args)
-        options = args.last.is_a?(::Hash) ? args.pop : {}
-        type = args.first || Thinreports.config.generator.default
-        filename = options.delete(:filename)
-        generator = Thinreports::Generator.new(type, self, options)
-
-        generator.generate(filename)
+      def generate(filename: nil, security: nil)
+        Thinreports::Generator::PDF.new(self, security: security).generate(filename)
       end
 
       # @see Thinreports::Core::Shape::Manager::Target#list
@@ -191,6 +165,5 @@ module Thinreports
 
       def_delegators :internal, :finalize, :finalized?
     end
-
   end
 end

data/lib/thinreports/report/internal.rb

@@ -1,8 +1,7 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 module Thinreports
   module Report
-
     class Internal
       attr_reader :pages
       attr_reader :page
@@ -19,9 +18,9 @@ module Thinreports
         @default_layout = options[:layout] ? init_layout(options[:layout]) : nil
 
         @layout_registry = {}
-        @finalized  = false
-        @pages      = []
-        @page       = nil
+        @finalized = false
+        @pages = []
+        @page = nil
         @page_count = 0
 
         @page_create_handler = nil
@@ -52,10 +51,10 @@ module Thinreports
       end
 
       def finalize
-        unless finalized?
-          finalize_current_page
-          @finalized = true
-        end
+        return if finalized?
+
+        finalize_current_page
+        @finalized = true
       end
 
       def finalized?
@@ -79,7 +78,7 @@ module Thinreports
         layout
       end
 
-    private
+      private
 
       def insert_page(new_page)
         @pages << new_page
@@ -102,6 +101,5 @@ module Thinreports
         Thinreports::Layout.new(filename, id: id)
       end
     end
-
   end
 end

data/lib/thinreports/report/page.rb

@@ -1,8 +1,7 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 module Thinreports
   module Report
-
     class BlankPage
       # @example
       #   3.times do
@@ -51,8 +50,8 @@ module Thinreports
       def initialize(report, layout, options = {})
         super(options.key?(:count) ? options[:count] : true)
 
-        @report    = report
-        @layout    = layout
+        @report = report
+        @layout = layout
         @finalized = false
 
         initialize_manager(layout.format) do |f|
@@ -65,6 +64,7 @@ module Thinreports
         false
       end
 
+      # rubocop:disable Metrics/AbcSize
       def copy
         new_page = self.class.new(report, layout, count: count?)
 
@@ -86,7 +86,7 @@ module Thinreports
 
         # For list shapes.
         if at == :create
-          manager.lists.values.each {|list| list.manager.finalize }
+          manager.lists.values.each { |list| list.manager.finalize }
         end
 
         @finalized = true
@@ -96,6 +96,5 @@ module Thinreports
         @finalized
       end
     end
-
   end
 end

data/lib/thinreports/version.rb

@@ -1,5 +1,5 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 module Thinreports
-  VERSION = '0.9.1'
+  VERSION = '0.10.0'.freeze
 end

data/test/schema_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Thinreports
   module SchemaHelper
     BASIC_SCHEMA_JSON = <<-EOF
@@ -108,12 +110,11 @@ EOF
 EOF
 
     def layout_file(options = {})
-      # FIXME: '0.9.0' -> Thinreports::VERSION
-      version = options[:version] || '0.9.0'
+      schema_version = options[:version] || Thinreports::VERSION
       schema_json = options[:schema] || BASIC_SCHEMA_JSON
 
       Tempfile.open %w( test-thinreports-layout .tlf ) do |file|
-        file.puts (schema_json % { version: version })
+        file.puts (schema_json % { version: schema_version })
         file
       end
     end

data/test/test_helper.rb

@@ -1,14 +1,13 @@
-# coding: utf-8
+# frozen_string_literal: true
 
-gem 'minitest' # for 1.9.3
 require 'minitest/autorun'
 require 'minitest/spec'
 require 'minitest/unit'
 require 'mocha/mini_test'
+require 'pdf/inspector'
 
 require 'digest/sha1'
 require 'pathname'
-require 'chunky_png'
 require 'thinreports'
 
 require 'schema_helper'
@@ -35,6 +34,13 @@ module Thinreports::TestHelper
     ROOT.join('tmp')
   end
 
+  def analyze_pdf_images(pdf_data)
+    analyzer = PDF::Inspector::XObject.analyze(pdf_data)
+    analyzer.page_xobjects
+      .reduce(:merge).values
+      .select { |o| o.hash[:Subtype] == :Image }
+  end
+
   def teardown
     super
     FileUtils.rm Dir.glob(temp_path.join('*'))