thinreports 0.9.1 → 0.11.0

data/lib/thinreports/layout/legacy_schema.rb

@@ -1,4 +1,4 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 require 'json'
 require 'rexml/document'
@@ -13,7 +13,7 @@ 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
 
       def upgrade
@@ -28,7 +28,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
         }
@@ -78,7 +83,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),
@@ -99,6 +104,7 @@ module Thinreports
           'width' => attributes['width'].to_f,
           'height' => attributes['height'].to_f,
           'display' => display(attributes['x-display']),
+          'border-radius' => attributes['rx'].to_i,
           'style' => {
             'border-width' => attributes['stroke-width'].to_f,
             'border-color' => attributes['stroke'],
@@ -144,7 +150,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 +179,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 +241,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),
@@ -269,9 +275,7 @@ module Thinreports
           'footer' => footer
         }
 
-        if page_footer['enabled']
-          page_footer['translate']['y'] += detail['height']
-        end
+        page_footer['translate']['y'] += detail['height'] if page_footer['enabled']
 
         if footer['enabled']
           footer['translate']['y'] += detail['height']
@@ -368,9 +372,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'
 
-    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
@@ -34,9 +33,7 @@ module Thinreports
         else
           id = options[:id].to_sym
 
-          if layout_registry.key?(id)
-            raise ArgumentError, "Id :#{id} is already in use."
-          end
+          raise ArgumentError, "Id :#{id} is already in use." if layout_registry.key?(id)
           layout_registry[id] = init_layout(layout, id)
         end
       end
@@ -52,10 +49,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?
@@ -75,11 +72,11 @@ module Thinreports
             raise ArgumentError, 'Invalid argument for layout.'
           end
 
-        @default_layout = layout unless @default_layout
+        @default_layout ||= layout
         layout
       end
 
-    private
+      private
 
       def insert_page(new_page)
         @pages << new_page
@@ -99,9 +96,10 @@ module Thinreports
       end
 
       def init_layout(filename, id = nil)
+        filename = filename.to_path if filename.is_a?(Pathname)
+
         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|
@@ -72,9 +71,7 @@ module Thinreports
           new_shape = shape.copy(new_page)
           new_page.manager.shapes[id] = new_shape
 
-          if new_shape.internal.type_of?(Core::Shape::List::TYPE_NAME)
-            new_page.manager.lists[id] = new_shape
-          end
+          new_page.manager.lists[id] = new_shape if new_shape.internal.type_of?(Core::Shape::List::TYPE_NAME)
         end
         new_page
       end
@@ -85,9 +82,7 @@ module Thinreports
         at = options[:at] || :create
 
         # For list shapes.
-        if at == :create
-          manager.lists.values.each {|list| list.manager.finalize }
-        end
+        manager.lists.each_value { |list| list.manager.finalize } if at == :create
 
         @finalized = true
       end
@@ -96,6 +91,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.11.0'
 end

data/thinreports.gemspec

@@ -1,7 +1,8 @@
-# coding: utf-8
+# frozen_string_literal: true
 
-$LOAD_PATH.unshift(File.expand_path('../lib/', __FILE__))
-require 'thinreports/version'
+rootdir = File.expand_path(File.dirname(__FILE__))
+
+require "#{rootdir}/lib/thinreports/version"
 
 Gem::Specification.new do |s|
   s.name        = 'thinreports'
@@ -11,24 +12,14 @@ Gem::Specification.new do |s|
   s.summary     = 'An open source report generation tool for Ruby.'
   s.description = 'Thinreports is an open source report generation tool for Ruby.'
   s.homepage    = 'http://www.thinreports.org'
-  s.licenses    = ['MIT']
-
-  s.platform              = Gem::Platform::RUBY
-  s.required_ruby_version = '>= 1.9.3'
+  s.license     = 'MIT'
 
-  s.rdoc_options     = ['--main', 'README.md']
-  s.extra_rdoc_files = ['README.md']
+  s.required_ruby_version = '>= 2.4.0'
 
-  s.files         = `git ls-files`.split($\)
-  s.test_files    = s.files.grep %r{^test/}
+  s.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^test/}) }
+  end
   s.require_paths = ['lib']
 
-  s.add_dependency 'prawn', '1.3.0'
-  s.add_dependency 'chunky_png', '~> 1.3'
-
-  s.add_development_dependency 'bundler', ['>= 1.0.0']
-  s.add_development_dependency 'minitest', ['>= 5.0.0']
-  s.add_development_dependency 'mocha', ['>= 0']
-  s.add_development_dependency 'rake', ['>= 0']
-  s.add_development_dependency 'yard'
+  s.add_dependency 'prawn', '~> 2.2.0'
 end