thinreports 0.7.6 → 0.8.0

data/lib/thinreports/core/shape/list/section_interface.rb

@@ -1,48 +1,47 @@
 # coding: utf-8
 
-module ThinReports
+module Thinreports
   module Core::Shape
-    
+
     class List::SectionInterface < Base::Interface
       include Core::Shape::Manager::Target
-      
+
       undef_method :list
       internal_delegators :height
-      
-      # @param [ThinReports::Core::Shape::List::Page] parent
-      # @param [ThinReports::Core::Shape::List::SectionFormat] format
+
+      # @param [Thinreports::Core::Shape::List::Page] parent
+      # @param [Thinreports::Core::Shape::List::SectionFormat] format
       # @param [Symbol] section_name
       def initialize(parent, format, section_name)
         super(parent, format)
         internal.section_name = section_name
-        
+
         initialize_manager(format) do |f|
           Core::Shape::Interface(self, f)
         end
       end
-      
-      # @param [ThinReports::Core::Shape::List::Page] parent
-      # @return [ThinReports::Core::Shape::List::SectionInterface]
-      # @private
+
+      # @param [Thinreports::Core::Shape::List::Page] parent
+      # @return [Thinreports::Core::Shape::List::SectionInterface]
       def copy(parent)
         new_sec = super
         new_sec.internal.section_name = internal.section_name
-        
+
         manager.shapes.each do |id, shape|
           new_sec.manager.shapes[id] = shape.copy(new_sec)
         end
         new_sec
       end
-      
+
     private
-      
+
       # @param parent (see #initialize)
       # @param format (see #initialize)
-      # @return [ThinReports::Core::Shape::List::SectionInternal]
+      # @return [Thinreports::Core::Shape::List::SectionInternal]
       def init_internal(parent, format)
         List::SectionInternal.new(parent, format)
       end
     end
-    
+
   end
 end

data/lib/thinreports/core/shape/list/section_internal.rb

@@ -1,33 +1,32 @@
 # coding: utf-8
 
-module ThinReports
+module Thinreports
   module Core::Shape
-    
-    # @private
+
     class List::SectionInternal < Base::Internal
       format_delegators :height,
                         :relative_left,
                         :relative_top,
                         :svg_tag
-      
+
       # @return [Symbol]
       attr_accessor :section_name
-      
+
       def style
         @style ||= Style::Base.new(format)
       end
-      
+
       # @param [Numeric] ry
       def move_top_to(ry)
         states[:relative_top] = ry
       end
-      
+
       # @return [Array<Numeric>]
       def relative_position
         [relative_left,
          relative_top + (states[:relative_top] || 0)]
       end
     end
-    
+
   end
 end

data/lib/thinreports/core/shape/list/store.rb

@@ -1,34 +1,33 @@
 # coding: utf-8
 
-module ThinReports
+module Thinreports
   module Core::Shape
-    
+
     class List::Store < ::Struct
-      # @private
+      include Utils
+
       def self.init(attrs)
         new(attrs).new
       end
-      
-      # @private
+
       def self.new(attrs)
         super(*attrs.keys) do
           @default_values = attrs.values
-          
+
           def self.default_values
-            @default_values.simple_deep_copy
+            deep_copy(@default_values)
           end
         end
       end
-      
+
       def initialize
         super(*self.class.default_values)
       end
-      
-      # @private
+
       def copy
         self.class.new
       end
     end
-    
+
   end
 end

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

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

data/lib/thinreports/core/shape/manager/format.rb

@@ -1,28 +1,27 @@
 # coding: utf-8
 
-module ThinReports
+module Thinreports
   module Core::Shape
-    
-    # @private
+
     class Manager::Format < Core::Format::Base
       # @return [Symbol, Integer]
       attr_reader :identifier
-      
-      config_reader :layout => %w( svg )
-      
+
+      config_reader layout: %w( svg )
+
       def initialize(config, id = nil, &block)
         super(config, &block)
         @identifier = id || self.object_id
       end
-      
+
       def find_shape(id)
         shapes[id]
       end
-      
+
       def shapes
-        @shapes ||= ThinReports::Core::OrderedHash.new
+        @shapes ||= {}
       end
     end
-    
+
   end
-end
+end

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

@@ -1,15 +1,16 @@
 # coding: utf-8
 
-module ThinReports
+module Thinreports
   module Core::Shape
-    
-    # @private
+
     class Manager::Internal
+      include Utils
+
       attr_reader :format
       attr_reader :shapes
       attr_reader :lists
-      
-      # @param [ThinReports::Core::Manager::Format] format
+
+      # @param [Thinreports::Core::Manager::Format] format
       # @param [Proc] init_item_handler
       def initialize(format, init_item_handler)
         @format = format
@@ -17,13 +18,13 @@ module ThinReports
         @lists  = {}
         @init_item_handler = init_item_handler
       end
-      
+
       # @param [String, Symbol] id
-      # @return [ThinReports::Core::Shape::Basic::Format]
+      # @return [Thinreports::Core::Shape::Basic::Format]
       def find_format(id)
         format.find_shape(id.to_sym)
       end
-      
+
       # @param [String, Symbol] id
       # @param limit (see #valid_type?)
       def find_item(id, limit = {})
@@ -39,28 +40,28 @@ module ThinReports
           return nil
         end
       end
-      
+
       # @param [String, Symbol] id
-      # @return [ThinReports::Core::Shape::Base::Interface, nil]
+      # @return [Thinreports::Core::Shape::Base::Interface, nil]
       def final_shape(id)
         # When shape was found in registry.
         if shape = shapes[id]
           return nil unless shape.visible?
-          
+
           # In the case of TextBlock or ImageBlock.
           if shape.internal.type_of?(:block)
-            shape.internal.real_value.blank? ? nil : shape
+            blank_value?(shape.internal.real_value) ? nil : shape
           else
             shape
           end
         # When shape was not found in registry.
         elsif f = find_format(id)
           return nil unless f.display?
-          
+
           case f.type
           # In the case of TextBlock.
           when TextBlock::TYPE_NAME
-            f.has_reference? || !f.value.blank? ? init_item(f) : nil
+            f.has_reference? || !blank_value?(f.value) ? init_item(f) : nil
           # In the case of ImageBlock, Return the nil constantly.
           when ImageBlock::TYPE_NAME
             nil
@@ -72,16 +73,16 @@ module ThinReports
           nil
         end
       end
-      
-      # @param [ThinReports::Core::Shape::Basic::Format] format
+
+      # @param [Thinreports::Core::Shape::Basic::Format] format
       def init_item(format)
         @init_item_handler.call(format)
       end
-      
+
       # @param [String] type
       # @param [Hash] limit
-      # @option [String] :only
-      # @option [String] :except
+      # @option limit [String] :only
+      # @option limit [String] :except
       # @return [Booldan]
       def valid_type?(type, limit = {})
         return true if limit.empty?
@@ -95,6 +96,6 @@ module ThinReports
         end
       end
     end
-    
+
   end
-end
+end

data/lib/thinreports/core/shape/manager/target.rb

@@ -1,12 +1,13 @@
 # coding: utf-8
 
-module ThinReports
+module Thinreports
   module Core::Shape
-    
+
     module Manager::Target
-      # @private
+      include Utils
+
       attr_reader :manager
-      
+
       # @example
       #   item(:title).value('Title').style(:fill, 'red')
       #
@@ -14,72 +15,100 @@ module ThinReports
       #     value('Title')
       #     style(:fill, 'red')
       #   end
-      #   
+      #
       #   item(:title) do |t|
       #     t.value('Title')
       #     t.style(:fill, 'red')
       #   end
+      #   item(:list)       # => Error: UnknownItemId
+      #   item(:unknown_id) # => Error: UnknownItemId
       # @param [String, Symbol] id
       # @yield [item,]
-      # @yieldparam [ThinReports::Core::Shape::Base::Interface] item
-      # @raise [ThinReports::Errors::UnknownItemId] If not found
-      # @return [ThinReports::Core::Shape::Base::Interface]
+      # @yieldparam [Thinreports::Core::Shape::Base::Interface] item
+      # @raise [Thinreports::Errors::UnknownItemId]
+      # @return [Thinreports::Core::Shape::Base::Interface]
       def item(id, &block)
-        shape = find_item(id, :except => Core::Shape::List::TYPE_NAME)
-        
+        shape = find_item(id, except: Core::Shape::List::TYPE_NAME)
+
         unless shape
-          raise ThinReports::Errors::UnknownItemId.new(id)
+          raise Thinreports::Errors::UnknownItemId.new(id)
         else
-          block_exec_on(shape, &block)
+          call_block_in(shape, &block)
         end
       end
-      
-      # @param [Hash] item_values :id => value
+
+      # @example
+      #   page[:text_block].style(:bold, true)
+      #   page[:rect].style(:border_color, 'red')
+      #
+      #   page[:list]       # => Error: UnknownItemId
+      #   page[:unknown_id] # => Error: UnknownItemId
+      # @param [String, Symbol] id
+      # @return [Thinreports::Core::Shape::Base::Interface]
+      def [](id)
+       item(id)
+      end
+
+      # @example
+      #   page[:text_block]  = 'Title'
+      #   page[:image_block] = '/path/to/image.png'
+      #   page[:list]        = 'value' # => Error: UnknownItemId
+      #   page[:ellipse]     = 'value' # => Error: NoMethodError #value
+      #   page[:unknown_id]  = 'value' # => Error: UnknownItemId
+      # @param [String, Symbol] id
+      # @param [Object] value
+      def []=(id, value)
+       item(id).value = value
+      end
+
+      # @example
+      #   page.values text_block: 'value',
+      #               image_block: '/path/to/image.png'
+      # @param [Hash] item_values
       def values(item_values)
         item_values.each {|id, val| item(id).value(val)}
       end
-      
-      # @deprecated Please use the #values method instead.
-      # @see #values
-      def items(*args)
-        warn '[DEPRECATION] The #items method is deprecated. ' +
-             'Please use the #values method instead.'
-        values(*args)
-      end
-      
+
       # @param [Symbol, String] id
       # @return [Boolean]
       def item_exists?(id)
         !!manager.find_format(id)
       end
       alias_method :exists?, :item_exists?
-      
+
+      # @example
+      #   report.list.add_row do |row|
+      #     row.item(:price).value(1000)
+      #   end
+      #
+      #   report.list(:list_id) # => List
+      #   report.list(:text_block_id) # => raises UnknownItemId
       # @see #item
       def list(id = nil, &block)
-        shape = find_item(id ||= :default, :only => Core::Shape::List::TYPE_NAME)
+        shape = find_item(id ||= :default, only: Core::Shape::List::TYPE_NAME)
 
         unless shape
-          raise ThinReports::Errors::UnknownItemId.new(id, 'List')
+          raise Thinreports::Errors::UnknownItemId.new(id, 'List')
         else
           manager.lists[id.to_sym] ||= shape
-          block_exec_on(shape, &block)
+          call_block_in(shape, &block)
         end
       end
 
     private
-      
-      # @param format (see ThinReports::Core::Shape::Manager::Internal#initialize)
+
+      # @param format (see Thinreports::Core::Shape::Manager::Internal#initialize)
       # @yield [format] Handler for initialize item.
-      # @yieldparam [ThinReports::Core::Shape::Basic::Format] format
+      # @yieldparam [Thinreports::Core::Shape::Basic::Format] format
       def initialize_manager(format, &block)
         @manager = Manager::Internal.new(format, block)
       end
-      
-      # @see ThinReports::Core::Shape::Manager::Internal#find_item
+
+      # @see Thinreports::Core::Shape::Manager::Internal#find_item
       def find_item(id, limit = {})
         manager.find_item(id, limit)
       end
     end
-    
+
   end
-end
+end

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

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

data/lib/thinreports/core/shape/page_number/format.rb

@@ -0,0 +1,25 @@
+# coding: utf-8
+
+module Thinreports
+  module Core::Shape
+
+    class PageNumber::Format < Basic::Format
+      config_reader :overflow, :target, :box
+      config_reader default_format: %w( format )
+
+      def id
+        unless @id
+          @id = read('id')
+          @id = self.class.next_default_id if blank_value?(@id)
+        end
+        @id
+      end
+
+      def self.next_default_id
+        @id_counter ||= 0
+        "__pageno#{@id_counter += 1}"
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,27 @@
+# coding: utf-8
+
+module Thinreports
+  module Core::Shape
+
+    class PageNumber::Interface < Basic::Interface
+      internal_delegators :reset_format
+
+      def format(*args)
+        if args.empty?
+          internal.read_format
+        else
+          internal.write_format(args.first)
+          self
+        end
+      end
+
+    private
+    
+      # @see Thinreports::Core::Shape::Base::Interface#init_internal
+      def init_internal(parent, format)
+        PageNumber::Internal.new(parent, format)
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,57 @@
+# coding: utf-8
+
+module Thinreports
+  module Core::Shape
+
+    class PageNumber::Internal < Basic::Internal
+      format_delegators :box
+
+      def read_format
+        states.key?(:format) ? states[:format] : format.default_format.dup
+      end
+
+      def reset_format
+        states.delete(:format)
+      end
+
+      def write_format(format)
+        states[:format] = format.to_s
+      end
+
+      def build_format(page_no, page_count)
+        return '' if blank_value?(read_format)
+
+        if start_page_number > 1
+          page_no += start_page_number - 1
+          page_count += start_page_number - 1
+        end
+
+        read_format.dup.tap do |f|
+          f.gsub! '{page}', page_no.to_s
+          f.gsub! '{total}', page_count.to_s
+        end
+      end
+
+      def style
+        @style ||= PageNumber::Style.new(format)
+      end
+
+      def for_report?
+        blank_value?(format.target)
+      end
+
+      def type_of?(type_name)
+        type_name == :pageno
+      end
+
+      def start_page_number
+        for_report? ? parent.report.start_page_number : 1
+      end
+    end
+
+    class PageNumber::Style < Style::Text
+      accessible_styles.delete :valign
+    end
+
+  end
+end

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

@@ -0,0 +1,15 @@
+# coding: utf-8
+
+module Thinreports
+  module Core::Shape
+
+    module PageNumber
+      TYPE_NAME = 's-pageno'
+    end
+
+  end
+end
+
+require 'thinreports/core/shape/page_number/format'
+require 'thinreports/core/shape/page_number/internal'
+require 'thinreports/core/shape/page_number/interface'