thinreports 0.7.6 → 0.8.0

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

@@ -1,28 +1,35 @@
 # coding: utf-8
 
-module ThinReports
-  module Generator
-    
-    # @private
-    class PDF::Drawer::Page < PDF::Drawer::Base
+module Thinreports
+  module Generator::PDF::Drawer
+
+    class Page < Base
       # @param (see PDF::Drawer::Base#initialize)
       def initialize(pdf, format)
         super
         @lists = {}
       end
-      
-      # @param [ThinReports::Core::Shape::Manager::Internal] manager
-      def draw(manager)
+
+      # @param [Thinreports::Report::Page] page
+      def draw(page)
+        manager = page.manager
+
         manager.format.shapes.each_key do |id|
-          if shape = manager.final_shape(id)
-            draw_shape(shape.internal)
+          next unless shape = manager.final_shape(id)
+
+          shape = shape.internal
+
+          if shape.type_of?(:pageno)
+            # 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
-      
+
     private
-      
-      # @param [ThinReports::Core::Shape::Base::Internal] shape
+
       def draw_shape(shape)
         case
         when shape.type_of?(:tblock)
@@ -32,7 +39,7 @@ module ThinReports
         when shape.type_of?(:iblock)
           draw_iblock_shape(shape)
         else
-          id = shape_stamp_id(shape)
+          id = shape.identifier
           unless @stamps.include?(id)
             create_basic_shape_stamp(shape)
             @stamps << id
@@ -40,24 +47,28 @@ module ThinReports
           pdf_stamp(shape)
         end
       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] ||= PDF::Drawer::List.new(@pdf, shape.format)
+        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_iblock_shape(shape)
         @pdf.draw_shape_iblock(shape)
       end
-      
-      # @param [ThinReports::Core::Shape::Base::Internal] shape
+
+      # @param [Thinreports::Core::Shape::Base::Internal] shape
       def create_basic_shape_stamp(shape)
         case
         when shape.type_of?(:text)    then create_text_stamp(shape)
@@ -67,35 +78,35 @@ module ThinReports
         when shape.type_of?(:line)    then 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_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_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
@@ -103,6 +114,6 @@ module ThinReports
         end
       end
     end
-    
+
   end
 end

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

@@ -1,31 +1,32 @@
 # coding: utf-8
 
-# @private
 module Prawn
-  # @private
   class Document
-    # Create around alias.
     alias_method :original_width_of, :width_of
-    
+
     def width_of(string, options={})
       font.compute_width_of(string, options) +
         (character_spacing * (font.character_count(string) - 1))
     end
-    
-  private
-    # Create around alias.
-    alias_method :original_calc_image_dimensions, :calc_image_dimensions
-    
-    def calc_image_dimensions(info, options)
-      if options[:auto_fit]
-        w, h = info.width, info.height
-        sw, sh = options.delete(:auto_fit)
-        
-        if w > sw || h > sh
-          options[:fit] = [sw, sh]
+  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
-      original_calc_image_dimensions(info, options)
     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)
-        
-        drawer(format).draw(page.manager)
+        @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.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/layout/base.rb

@@ -1,49 +1,36 @@
 # coding: utf-8
 
-module ThinReports
+module Thinreports
   module Layout
-    
+
     class Base
       EXT_NAME = 'tlf'
-      
+      include Utils
+
       class << self
         # @param [String] filename
-        # @return [ThinReports::Layout::Format]
-        # @raise [ThinReports::Errors::InvalidLayoutFormat]
-        # @raise [ThinReports::Errors::IncompatibleLayoutFormat]
-        # @private
+        # @return [Thinreports::Layout::Format]
+        # @raise [Thinreports::Errors::InvalidLayoutFormat]
+        # @raise [Thinreports::Errors::IncompatibleLayoutFormat]
         def load_format(filename)
           filename += ".#{EXT_NAME}" unless filename =~/\.#{EXT_NAME}$/
-          
+
           unless File.exists?(filename)
-            raise ThinReports::Errors::LayoutFileNotFound
+            raise Thinreports::Errors::LayoutFileNotFound
           end
           # Build format.
-          ThinReports::Layout::Format.build(filename)
-        end
-        
-        # @private
-        def Page
-          const_defined?(:Page) ? Page : Core::Page
-        end
-        
-      private
-        
-        # @private
-        def PageHelpers(&block)
-          const_set(:Page, ::Class.new(Core::Page, &block))
+          Thinreports::Layout::Format.build(filename)
         end
       end
-      
-      # @private
+
       attr_reader :format
-      
+
       # @return [String]
       attr_reader :filename
-      
+
       # @return [Symbol]
       attr_reader :id
-      
+
       # @param [String] filename
       # @param [Hash] options
       # @option options [Symbol] :id (nil)
@@ -52,27 +39,28 @@ module ThinReports
         @format   = self.class.load_format(filename)
         @id       = options[:id]
       end
-      
+
       # @return [Boolean] Return the true if is default layout.
       def default?
         @id.nil?
       end
-      
+
       # @yield [config]
       # @yieldparam [List::Configuration] config
       # @return [List::Configuration]
       def config(&block)
         @config ||= Layout::Configuration.new(self)
-        block_exec_on(@config, &block)
+        call_block_in(@config, &block)
       end
-      
-      # @param [ThinReports::Report::Base] parent
+
+      # @param [Thinreports::Report::Base] parent
+      # @param [Hash] options ({})
+      # @option option [Boolean] :count (true)
       # @return [Page]
-      # @private
-      def init_new_page(parent)
-        self.class.Page.new(parent, self)
+      def new_page(parent, options = {})
+        Report::Page.new(parent, self, options)
       end
     end
-    
+
   end
 end

data/lib/thinreports/layout/configuration.rb

@@ -1,27 +1,29 @@
 # coding: utf-8
 
-module ThinReports
+module Thinreports
   module Layout
-    
+
+    # @deprecated This class will be removed in the next major version.
     class Configuration
       include Core::Shape::Manager::Target
-      
-      undef_method :items, :values
-      
-      # @param [ThinReports::Layout::Base] layout
+
+      # @param [Thinreports::Layout::Base] layout
       def initialize(layout)
         initialize_manager(layout.format) do |f|
           Core::Shape::Configuration(f.type).new
         end
       end
-      
+
       # @param [String, Symbol] shape_id
       # @return [Object, nil]
-      # @private
       def activate(shape_id)
         (config = manager.shapes[shape_id.to_sym]) && config.copy
       end
+
+      def values
+        raise NoMethodError
+      end
     end
-    
+
   end
 end

data/lib/thinreports/layout/format.rb

@@ -2,44 +2,39 @@
 
 require 'digest/sha1'
 
-module ThinReports
+module Thinreports
   module Layout
-    
-    # @private
+
     class Format < Core::Shape::Manager::Format
-      config_reader :last_version        => %w( version )
-      config_reader :report_title        => %w( config title )
-      config_reader :page_paper_type     => %w( config page paper-type ),
-                    :page_width          => %w( config page width ),
-                    :page_height         => %w( config page height ),
-                    :page_orientation    => %w( config page orientation ),
-                    :page_margin_top     => %w( config page margin-top ),
-                    :page_margin_bottom  => %w( config page margin-bottom ),
-                    :page_margin_left    => %w( config page margin-left ), 
-                    :page_margin_left    => %w( config page margin-right )
-      
-      config_checker 'user', :user_paper_type => %w( config page paper-type )
-      
+      config_reader last_version: %w( version )
+      config_reader report_title: %w( config title )
+      config_reader page_paper_type: %w( config page paper-type ),
+                    page_width: %w( config page width ),
+                    page_height: %w( config page height ),
+                    page_orientation: %w( config page orientation )
+
+      config_checker 'user', user_paper_type: %w( config page paper-type )
+
       class << self
-        
+
       private
-        
+
         # @param [String] filename
         # @param [Hash] options
         # @option options [Boolean] :force (false)
         def build_internal(filename, options = {})
           build_once(filename, options[:force]) do |content, id|
             raw_format = parse_json(content)
-            
+
             # Check the compatibility of specified layout file.
-            unless ThinReports::Layout::Version.compatible?(raw_format['version'])
+            unless Thinreports::Layout::Version.compatible?(raw_format['version'])
               info = [filename, raw_format['version'],
-                      ThinReports::Layout::Version.inspect_required_rules]
-              raise ThinReports::Errors::IncompatibleLayoutFormat.new(*info)
+                      Thinreports::Layout::Version.inspect_required_rules]
+              raise Thinreports::Errors::IncompatibleLayoutFormat.new(*info)
             end
-            
+
             compact_format!(raw_format)
-            
+
             # Build and initialize format.
             new(raw_format, id) do |f|
               build_layout(f) do |type, shape_format|
@@ -49,17 +44,17 @@ module ThinReports
             end
           end
         end
-        
+
         # @param [Hash] raw_format A parsed json.
         def compact_format!(raw_format)
           %w( finger-print state version ).each {|attr| raw_format.delete(attr) }
         end
-        
+
         # @param [String] filename
         # @param [Boolean] force (false)
         def build_once(filename, force = false, &block)
           content = read_format_file(filename)
-          
+
           if force
             block.call(content, nil)
           else
@@ -67,19 +62,19 @@ module ThinReports
             built_format_registry[id] ||= block.call(content, id)
           end
         end
-        
+
         # @param [String] filename
         # @return [String]
         def read_format_file(filename)
           File.open(filename, 'r:UTF-8') {|f| f.read }
         end
-        
+
         # @return [Hash]
         def built_format_registry
           @built_format_registry ||= {}
-        end        
+        end
       end
     end
-    
+
   end
 end

data/lib/thinreports/layout/version.rb

@@ -1,18 +1,17 @@
 # coding: utf-8
 
-module ThinReports
+module Thinreports
   module Layout
-    
-    # @private
+
     module Version
-      REQUIRED_RULES = ['>= 0.6.0.pre3', '< 0.8.0']
-      
+      REQUIRED_RULES = ['>= 0.7.7.0', '< 1.0.0']
+
       # @param [String] version
       # @return [Boolean]
       def self.compatible?(version)
         compare(version, *REQUIRED_RULES)
       end
-      
+
       # @param [String] base
       # @param [Array<String>] rules
       # @return [Boolean]
@@ -22,12 +21,12 @@ module ThinReports
           comparable_version(base).send(op.to_sym, comparable_version(ver))
         end
       end
-      
+
       # @return [String]
       def self.inspect_required_rules
         '(' + REQUIRED_RULES.join(' and ') + ')'
       end
-      
+
       # @param [String] version
       # @return [String]
       def self.comparable_version(version)
@@ -38,6 +37,6 @@ module ThinReports
         end
       end
     end
-    
+
   end
 end

data/lib/thinreports/layout.rb

@@ -1,9 +1,9 @@
 # coding: utf-8
 
-module ThinReports
+module Thinreports
   
   module Layout
-    # @see ThinReports::Layout::Base#initialize
+    # @see Thinreports::Layout::Base#initialize
     def self.new(filename, options = {})
       Base.new(filename, options)
     end