thinreports 0.7.7 → 0.8.0

data/lib/thinreports/core/utils.rb

@@ -1,40 +1,41 @@
 # coding: utf-8
 
-module ThinReports
-  module Core
-    
-    # @private
-    module Utils
-      def block_exec_on(context, &block)
-        return context unless block_given?
-        
-        if block.arity == 1
-          block.call(context)
-        else
-          context.instance_eval(&block)
-        end
-        context
+module Thinreports
+  module Utils
+    def self.included(klass)
+      klass.extend self
+    end
+
+    def deep_copy(src)
+      case src
+      when Hash
+        src.inject({}) {|h, (k, v)| h[k] = (v.dup rescue v); h }
+      when Array
+        src.map {|a| a.dup rescue a }
+      else
+        raise ArgumentError
+      end
+    end
+
+    def blank_value?(value)
+      case value
+      when String   then value.empty?
+      when NilClass then true
+      else false
       end
-      
-      if RUBY_VERSION < '1.9'
-        def ruby_18
-          yield
-        end
-        def ruby_19
-          false
-        end
+    end
+
+    def call_block_in(scope, &block)
+      return scope unless block_given?
+
+      if block.arity == 1
+        block.call(scope)
       else
-        def ruby_18
-          false
-        end
-        def ruby_19
-          yield
-        end
+        scope.instance_eval(&block)
       end
+      scope
     end
-    
   end
-end
 
-# Include global methods.
-include ThinReports::Core::Utils
+  extend Utils
+end

data/lib/thinreports/generator.rb

@@ -1,24 +1,22 @@
 # coding: utf-8
 
-module ThinReports
+module Thinreports
 
   module Generator
     # @param [Symbol] type
-    # @param report (see ThinReports::Generator::Base#initialize)
-    # @param options (see ThinReports::Generator::Base#initialize)
+    # @param report (see Thinreports::Generator::Base#initialize)
+    # @param options (see Thinreports::Generator::Base#initialize)
     def self.new(type, report, options = {})
       unless generator = registry[type]
-        raise ThinReports::Errors::UnknownGeneratorType.new(type)
+        raise Thinreports::Errors::UnknownGeneratorType.new(type)
       end
       generator.new(report, options)
     end
-    
-    # @private
+
     def self.register(type, generator)
       registry[type] = generator
     end
-    
-    # @private
+
     def self.registry
       @generators ||= {}
     end

data/lib/thinreports/generator/base.rb

@@ -1,49 +1,40 @@
 # coding: utf-8
 
-module ThinReports
+module Thinreports
   module Generator
-    
+
     # @abstract
     class Base
-      # @return [ThinReports::Report::Base]
-      # @private
+      # @return [Thinreports::Report::Base]
       attr_reader :report
 
       # @return [Hash]
-      # @private
       attr_reader :options
-      
-      # @private
+
       def self.inherited(g)
         Generator.register(g.name.split('::').last.downcase.to_sym, g);
       end
-      
-      # @param [ThinReports::Report::Base] report
+
+      # @param [Thinreports::Report::Base] report
       # @param [Hash] options
       def initialize(report, options = {})
         report.finalize
-        
+
         @report  = report.internal
         @options = options || {}
       end
-      
-      # @return [String]
-      # @abstract
-      def generate
-        raise NotImplementedError
-      end
-      
-      # @param [String] filename
+
+      # @param [String, nil] filename
+      # @return [String, nil]
       # @abstract
-      def generate_file(filename)
+      def generate(filename = nil)
         raise NotImplementedError
       end
-      
-      # @private
+
       def default_layout
         report.default_layout
-      end      
+      end
     end
-    
+
   end
-end
+end

data/lib/thinreports/generator/configuration.rb

@@ -1,30 +1,31 @@
 # coding: utf-8
 
-module ThinReports
+module Thinreports
   module Generator
-    
+
+    # @deprecated This class will be removed in the next major version.
     class Configuration
       # @return [Symbol]
       attr_reader :default
-      
+
       def initialize
         @default = :pdf
       end
-      
-      # @return [ThinReports::Generator::PDF::Configuration]
+
+      # @return [Thinreports::Generator::PDF::Configuration]
       def pdf
         @pdf ||= PDF::Configuration.new
       end
-      
+
       # @param [Symbol] type
       # @return [void]
       def default=(type)
         unless Generator.registry.key?(type)
-          raise ThinReports::Errors::UnknownGeneratorType.new(type)
+          raise Thinreports::Errors::UnknownGeneratorType.new(type)
         end
         @default = type
       end
     end
-    
+
   end
-end
+end

data/lib/thinreports/generator/pdf.rb

@@ -1,68 +1,65 @@
 # coding: utf-8
 
 begin
-  gem 'prawn', '0.12.0'
+  gem 'prawn', '1.3.0'
   require 'prawn'
 rescue LoadError
-  puts 'ThinReports requires Prawn = 0.12.0. ' +
-       'Please `gem install prawn -v 0.12.0` and try again.'
+  puts 'Thinreports requires Prawn = 1.3.0. ' +
+       'Please `gem install prawn -v 1.3.0` and try again.'
 end
 
-module ThinReports
+module Thinreports
   module Generator
-    
+
     class PDF < Base
-      # @param report (see ThinReports::Generator::Base#initialize)
+      # @param report (see Thinreports::Generator::Base#initialize)
       # @param [Hash] options
       # @option options [Hash] :security (nil)
       #   See Prawn::Document#encrypt_document
       def initialize(report, options)
         super
-        
+
         title = default_layout ? default_layout.format.report_title : nil
 
-        @pdf = Document.new(options, :Title => title)
+        @document = Document.new(options, Title: title)
         @drawers = {}
       end
-      
-      # @see ThinReports::Generator::Base#generate
-      def generate
-        draw_report
-        @pdf.render
-      end
-      
-      # @see ThinReports::Generator::Base#generate_file
-      def generate_file(filename)
+
+      # @see Thinreports::Generator::Base#generate
+      def generate(filename = nil)
         draw_report
-        @pdf.render_file(filename)
+        filename ? @document.render_file(filename) : @document.render
       end
-      
+
     private
-      
+
       def draw_report
         report.pages.each do |page|
           draw_page(page)
         end
       end
-      
+
       def draw_page(page)
-        return @pdf.add_blank_page if page.blank?
-        
+        return @document.add_blank_page if page.blank?
+
         format = page.layout.format
-        @pdf.start_new_page(format)
-        
+        @document.start_new_page(format)
+
         drawer(format).draw(page)
       end
-      
+
       def drawer(format)
-        @drawers[format.identifier] ||= Drawer::Page.new(@pdf, format)
-      end      
+        @drawers[format.identifier] ||= Drawer::Page.new(@document, format)
+      end
     end
-    
+
   end
 end
 
 require 'thinreports/generator/pdf/configuration'
 require 'thinreports/generator/pdf/prawn_ext'
 require 'thinreports/generator/pdf/document'
-require 'thinreports/generator/pdf/drawer'
+require 'thinreports/generator/pdf/drawer/base'
+require 'thinreports/generator/pdf/drawer/page'
+require 'thinreports/generator/pdf/drawer/list'
+require 'thinreports/generator/pdf/drawer/list_section'

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

@@ -1,20 +1,25 @@
 # coding: utf-8
 
-module ThinReports
+module Thinreports
   module Generator
-    
+
+    # @deprecated This class will be removed in the next major version.
     class PDF::Configuration
       # @return [Array]
       attr_reader :eudc_fonts
-      
+
       def initialize
         @eudc_fonts = []
       end
-      
+
       # @param [String, Array<String>] fonts
       def eudc_fonts=(fonts)
+        warn '[DEPRECATION] `eudc_fonts=` is deprecated and will be removed in ' +
+             'the next major version of thinreports. ' +
+             'Please use `Thinreports.config.fallback_fonts=` instead.'
+
         fonts = [fonts] unless fonts.is_a?(::Array)
-        
+
         fonts.each do |f|
           unless File.extname(f.to_s) == '.ttf'
             raise ArgumentError, 'The EUDC Fonts can specify only the TTF file.'
@@ -23,6 +28,6 @@ module ThinReports
         @eudc_fonts = fonts
       end
     end
-    
+
   end
 end

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

@@ -7,39 +7,43 @@ require 'thinreports/generator/pdf/document/draw_shape'
 require 'thinreports/generator/pdf/document/parse_svg'
 require 'thinreports/generator/pdf/document/page'
 
-module ThinReports
+module Thinreports
   module Generator
-    
-    # @private
+
     class PDF::Document
+      include Utils
+
       include PDF::Font
       include PDF::ParseColor
       include PDF::Graphics
       include PDF::DrawShape
       include PDF::ParseSVG
       include PDF::Page
-      
-      # @param options (see ThinReports::Generator::PDF#initialize)
+
+      # @return [Prawn::Document]
+      attr_reader :pdf
+
+      # @param options (see Thinreports::Generator::PDF#initialize)
       # @param [Hash] metadata
       # @option metadata [String] :Title
       def initialize(options = {}, metadata = {})
         @pdf = Prawn::Document.new(
-          :skip_page_creation => true,
-          :margin => [0, 0],
-          :info   => {:CreationDate => Time.now, 
-                      :Creator      => 'ThinReports Generator for Ruby ' +
-                                        ThinReports::VERSION}.merge(metadata)
+          skip_page_creation: true,
+          margin: [0, 0],
+          info: {CreationDate: Time.now,
+                      Creator: 'Thinreports Generator for Ruby ' +
+                                        Thinreports::VERSION}.merge(metadata)
         )
         # Setup to Prawn::Document.
         setup_fonts
         setup_custom_graphic_states
-        
+
         # Encrypts the document.
         if options[:security]
           @pdf.encrypt_document(options[:security])
         end
       end
-      
+
       # Delegate to Prawn::Document#render
       # @see Prawn::Document#render
       def render
@@ -47,21 +51,21 @@ module ThinReports
         finalize
         result
       end
-      
+
       # Delegate to Prawn::Document#render_file
       # @see Prawn::Document#render_file
       def render_file(*args)
         finalize
         pdf.render_file(*args)
       end
-      
+
       # @param [Numeric, String] x
       # @param [Numeric, String] y
       def translate(x, y, &block)
         x, y = rpos(x, y)
         pdf.translate(x, y, &block)
       end
-      
+
       # @param [String] stamp_id
       # @param [Array<Numeric>] at (nil)
       def stamp(stamp_id, at = nil)
@@ -71,34 +75,30 @@ module ThinReports
           pdf.stamp(stamp_id)
         end
       end
-      
+
       # Delegate to Prawn::Document#create_stamp
       # @param [String] id
       # @see Prawn::Document#create_stamp
       def create_stamp(id, &block)
         pdf.create_stamp(id, &block)
       end
-      
-      # @private
+
       # @see #pdf
       def internal
         @pdf
       end
-      
+
     private
-      
-      # @return [Prawn::Document]
-      attr_reader :pdf
-      
+
       def finalize
         clean_temp_images
       end
-      
+
       # @param [Array<String, Numeric>] values
       # @return [Numeric, Array<Numeric>, nil]
       def s2f(*values)
         return nil if values.empty?
-        
+
         if values.size == 1
           if value = values.first
             value.is_a?(::Numeric) ? value : value.to_f
@@ -107,7 +107,7 @@ module ThinReports
           values.map {|v| s2f(v) }
         end
       end
-      
+
       # @param [Numeric, String] x
       # @param [Numeric, String] y
       # @return [Array<Float>]
@@ -116,7 +116,7 @@ module ThinReports
         [x, -y]
       end
       alias_method :rpos, :map_to_upper_left_relative_position
-      
+
       # @param [Numeric, String] x
       # @param [Numeric, String] y
       # @return [Array<Float>]
@@ -126,6 +126,6 @@ module ThinReports
       end
       alias_method :pos, :map_to_upper_left_position
     end
-    
+
   end
 end