thinreports 0.7.6 → 0.8.0

data/lib/thinreports/core/shape/text_block/formatter/number.rb

@@ -2,23 +2,22 @@
 
 require 'bigdecimal'
 
-module ThinReports
+module Thinreports
   module Core::Shape::TextBlock
-    
-    # @private
+
     class Formatter::Number < Formatter::Basic
-      
+
     private
-      
+
       def apply_format_to(value)
         precision = format.format_number_precision
         delimiter = format.format_number_delimiter
-        
+
         if_applicable value do |val|
-          unless precision.blank?
+          unless blank_value?(precision)
             val = number_with_precision(val, precision)
           end
-          unless delimiter.blank?
+          unless blank_value?(delimiter)
             val = number_with_delimiter(val, delimiter)
           end
           val
@@ -34,16 +33,16 @@ module ThinReports
         end
         val.nil? ? value : block.call(val)
       end
-      
+
       def number_with_delimiter(value, delimiter = ',')
         value.to_s.gsub(/(\d)(?=(\d{3})+(?!\d))/){ "#{$1}#{delimiter}" }
       end
-      
+
       def number_with_precision(value, precision = 3)
         value = BigDecimal(value.to_s).round(precision)
         sprintf("%.#{precision}f", value)
       end
     end
-    
+
   end
-end
+end

data/lib/thinreports/core/shape/text_block/formatter/padding.rb

@@ -1,45 +1,22 @@
 # coding: utf-8
 
-module ThinReports
+module Thinreports
   module Core::Shape::TextBlock
-    
-    # @private
+
     class Formatter::Padding < Formatter::Basic
-      
-    private
-    
-    ruby_18 do
-      def apply_format_to(value)
-        value = value.to_s
-        
-        char_length = value.unpack('U*').length
-        pad_length  = format.format_padding_length
-        
-        if pad_length > char_length
-          pad_strs = format.format_padding_char * (pad_length - char_length)
-          if format.format_padding_rdir?
-            value + pad_strs
-          else
-            pad_strs + value
-          end
-        else
-          value
-        end
-      end
-    end
-    
-    ruby_19 do
+
+      private
+
       def apply_format_to(value)
         value.to_s.send(format.format_padding_rdir? ? :ljust : :rjust,
                         format.format_padding_length,
                         format.format_padding_char)
       end
-    end
-    
+
       def applicable?(value)
-        !format.format_padding_char.blank? && format.format_padding_length > 0
+        !blank_value?(format.format_padding_char) && format.format_padding_length > 0
       end
     end
-    
+
   end
-end
+end

data/lib/thinreports/core/shape/text_block/formatter.rb

@@ -1,14 +1,13 @@
 # coding: utf-8
 
-module ThinReports
+module Thinreports
   module Core::Shape::TextBlock
-    
-    # @private
+
     module Formatter
-      # @param [ThinReports::Core::Shape::TextBlock::Format] format
-      # @return [ThinReports::Core::Shape::TextBlock::Formatter::Base]
+      # @param [Thinreports::Core::Shape::TextBlock::Format] format
+      # @return [Thinreports::Core::Shape::TextBlock::Formatter::Base]
       def self.setup(format)
-        klass = if format.format_type.blank?
+        klass = if Thinreports.blank_value?(format.format_type)
           Basic
         else
           case format.format_type
@@ -16,13 +15,13 @@ module ThinReports
           when 'datetime' then Datetime
           when 'padding'  then Padding
           else
-            raise ThinReports::Errors::UnknownFormatterType
+            raise Thinreports::Errors::UnknownFormatterType
           end
         end
         klass.new(format)
       end
     end
-    
+
   end
 end
 

data/lib/thinreports/core/shape/text_block/interface.rb

@@ -1,6 +1,6 @@
 # coding: utf-8
 
-module ThinReports
+module Thinreports
   module Core::Shape
     
     class TextBlock::Interface < Basic::BlockInterface
@@ -23,7 +23,7 @@ module ThinReports
     
     private
       
-      # @see ThinReports::Core::Shape::Base::Interface#init_internal
+      # @see Thinreports::Core::Shape::Base::Interface#init_internal
       def init_internal(parent, format)
         TextBlock::Internal.new(parent, format)
       end

data/lib/thinreports/core/shape/text_block/internal.rb

@@ -1,26 +1,25 @@
 # coding: utf-8
 
-module ThinReports
+module Thinreports
   module Core::Shape
-    
-    # @private
+
     class TextBlock::Internal < Basic::BlockInternal
       format_delegators :multiple?
-      
+
       def initialize(*args)
         super(*args)
-        
+
         @reference = nil
         @formatter = nil
-        
+
         @style = Style::Text.new(format)
         @style.accessible_styles.delete(:valign) unless multiple?
       end
-      
+
       def style
         @style
       end
-      
+
       def read_value
         if format.has_reference?
           @reference ||= parent.item(format.ref_id)
@@ -29,16 +28,16 @@ module ThinReports
           super
         end
       end
-      
+
       def write_value(val)
         if format.has_reference?
           warn 'The set value was not saved, ' +
-               "Because '#{format.id}' refers to '#{format.ref_id}'."
+               "Because '#{format.id}' has reference to '#{format.ref_id}'."
         else
           super
         end
       end
-      
+
       def real_value
         if format_enabled?
           formatter.apply(read_value)
@@ -46,31 +45,31 @@ module ThinReports
           super
         end
       end
-      
+
       def format_enabled(enabled)
         states[:format_enabled] = enabled
       end
-      
+
       def format_enabled?
         return false if multiple?
-        
+
         if states.key?(:format_enabled)
           states[:format_enabled]
         else
-          !format.format_base.blank? || format.has_format?
+          !blank_value?(format.format_base) || format.has_format?
         end
       end
-      
+
       def type_of?(type_name)
         type_name == :tblock || super
       end
-      
+
     private
-      
+
       def formatter
         @formatter ||= TextBlock::Formatter.setup(format)
       end
     end
-    
+
   end
-end
+end

data/lib/thinreports/core/shape/text_block.rb

@@ -1,6 +1,6 @@
 # coding: utf-8
 
-module ThinReports
+module Thinreports
   module Core::Shape
     
     module TextBlock

data/lib/thinreports/core/shape.rb

@@ -1,44 +1,41 @@
 # coding: utf-8
 
-module ThinReports
+module Thinreports
   module Core
-    
+
     module Shape
-      # @private
       def Interface(parent, format)
         find_by_type(format.type)::Interface.new(parent, format)
       end
-      
-      # @private
+
       def Format(type)
         find_by_type(type)::Format
       end
-      
-      # @private
+
       def Configuration(type)
         klass = find_by_type(type)
         unless klass.const_defined?(:Configuration)
-          raise ThinReports::Errors::NoConfigurationFound, type
+          raise Thinreports::Errors::NoConfigurationFound, type
         end
         klass.const_get(:Configuration)
       end
-      
+
       module_function :Interface, :Format, :Configuration
-      
-      # @private
+
       def self.find_by_type(type)
         case type
         when TextBlock::TYPE_NAME  then TextBlock
         when ImageBlock::TYPE_NAME then ImageBlock
         when List::TYPE_NAME       then List
         when Text::TYPE_NAME       then Text
+        when PageNumber::TYPE_NAME then PageNumber
         when *Basic::TYPE_NAMES    then Basic
         else
-          raise ThinReports::Errors::UnknownShapeType
+          raise Thinreports::Errors::UnknownShapeType
         end
       end
     end
-  
+
   end
 end
 
@@ -50,3 +47,4 @@ require 'thinreports/core/shape/text'
 require 'thinreports/core/shape/text_block'
 require 'thinreports/core/shape/image_block'
 require 'thinreports/core/shape/list'
+require 'thinreports/core/shape/page_number'

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/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/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/draw_shape.rb

@@ -1,18 +1,17 @@
 # coding: utf-8
 
-module ThinReports
+module Thinreports
   module Generator
-    
-    # @private
+
     module PDF::DrawShape
-      # @param [ThinReports::Core::Shape::TextBlock::Internal] shape
+      # @param [Thinreports::Core::Shape::TextBlock::Internal] shape
       def draw_shape_tblock(shape)
         x, y, w, h = shape.box.values_at('x', 'y', 'width', 'height')
-        
+
         content = shape.real_value.to_s
         unless content.empty?
           attrs = shape_text_attrs(shape)
-          
+
           unless shape.multiple?
             content = content.gsub(/\n/, ' ')
             attrs[:single] = true
@@ -20,49 +19,56 @@ module ThinReports
           text_box(content, x, y, w, h, attrs)
         end
       end
-      
-      # @param [ThinReports::Core::Shape::Basic::Internal] shape
+
+      def draw_shape_pageno(shape, page_no, page_count)
+        x, y, w, h = shape.box.values_at('x', 'y', 'width', 'height')
+
+        text_box(shape.build_format(page_no, page_count), x, y, w, h,
+                 common_text_attrs(shape.style.svg_attrs))
+      end
+
+      # @param [Thinreports::Core::Shape::Basic::Internal] shape
       def draw_shape_image(shape)
         x, y, w, h = shape.style.svg_attrs.values_at('x', 'y', 'width', 'height')
         base64image(extract_base64_string(shape.style.svg_attrs['xlink:href']),
                     x, y, w, h)
       end
-      
-      # @param [ThinReports::Core::Shape::ImageBlock::Internal] shape
+
+      # @param [Thinreports::Core::Shape::ImageBlock::Internal] shape
       def draw_shape_iblock(shape)
         x, y, w, h = shape.box.values_at('x', 'y', 'width', 'height')
-        unless shape.src.blank?
+        unless blank_value?(shape.src)
           posx = shape.format.position_x
           posy = shape.format.position_y
-          
+
           image_box(shape.src, x, y, w, h,
-                    :position_x => posx ? posx.to_sym : nil,
-                    :position_y => posy ? posy.to_sym : nil)
+                    position_x: posx ? posx.to_sym : nil,
+                    position_y: posy ? posy.to_sym : nil)
         end
       end
-      
-      # @param [ThinReports::Core::Shape::Text::Internal] shape
+
+      # @param [Thinreports::Core::Shape::Text::Internal] shape
       def draw_shape_text(shape)
         x, y, w, h = shape.box.values_at('x', 'y', 'width', 'height')
-        text(shape.text.join("\n"), x, y, w, h, 
+        text(shape.text.join("\n"), x, y, w, h,
              shape_text_attrs(shape))
       end
-      
-      # @param [ThinReports::Core::Shape::Basic::Internal] shape
+
+      # @param [Thinreports::Core::Shape::Basic::Internal] shape
       def draw_shape_ellipse(shape)
         args = shape.style.svg_attrs.values_at('cx', 'cy', 'rx', 'ry')
         args << common_graphic_attrs(shape.style.svg_attrs)
         ellipse(*args)
       end
-      
-      # @param [ThinReports::Core::Shape::Basic::Internal] shape
+
+      # @param [Thinreports::Core::Shape::Basic::Internal] shape
       def draw_shape_line(shape)
         args = shape.style.svg_attrs.values_at('x1', 'y1', 'x2', 'y2')
         args << common_graphic_attrs(shape.style.svg_attrs)
         line(*args)
       end
-      
-      # @param [ThinReports::Core::Shape::Basic::Internal] shape
+
+      # @param [Thinreports::Core::Shape::Basic::Internal] shape
       def draw_shape_rect(shape)
         args = shape.style.svg_attrs.values_at('x', 'y', 'width', 'height')
         args << common_graphic_attrs(shape.style.svg_attrs) do |attrs|
@@ -70,26 +76,29 @@ module ThinReports
         end
         rect(*args)
       end
-    
+
     private
-      
-      # @param [ThinReports::Core::Shape::Text::Internal, ThinReports::Core::Shape::TextBlock::Internal] shape
+
+      # @param [Thinreports::Core::Shape::Text::Internal, Thinreports::Core::Shape::TextBlock::Internal] shape
       # @return [Hash]
       def shape_text_attrs(shape)
         format = shape.format
-        
+
         common_text_attrs(shape.style.svg_attrs) do |attrs|
           # Set the :line_height option.
-          attrs[:line_height] = format.line_height unless format.line_height.blank?
+          attrs[:line_height] = format.line_height unless blank_value?(format.line_height)
           # Set the :valign option.
           attrs[:valign]      = shape.style.valign
 
-          # Set the :overflow option.
-          attrs[:overflow] = text_overflow(format.overflow) if shape.type_of?(:tblock)
+          if shape.type_of?(:tblock)
+            # Set the :overflow option.
+            attrs[:overflow] = text_overflow(format.overflow)
+            # Set the :word_wrap option
+            attrs[:word_wrap] = text_word_wrap(format.word_wrap)
+          end
         end
       end
-      
     end
-    
+
   end
 end