thinreports 0.7.7 → 0.8.0

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

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

data/lib/thinreports/core/shape/basic/block_format.rb

@@ -1,12 +1,11 @@
 # coding: utf-8
 
-module ThinReports
+module Thinreports
   module Core::Shape
-    
-    # @private
+
     class Basic::BlockFormat < Basic::Format
       config_reader :value, :box
     end
-    
+
   end
 end

data/lib/thinreports/core/shape/basic/block_interface.rb

@@ -1,8 +1,8 @@
 # coding: utf-8
 
-module ThinReports
+module Thinreports
   module Core::Shape
-    
+
     class Basic::BlockInterface < Basic::Interface
       # @overload value(val)
       #   Set a val
@@ -19,7 +19,12 @@ module ThinReports
           self
         end
       end
+
+      # @param [Object] val
+      def value=(val)
+        value(val)
+      end
     end
-    
+
   end
-end
+end

data/lib/thinreports/core/shape/basic/block_internal.rb

@@ -1,33 +1,32 @@
 # coding: utf-8
 
-module ThinReports
+module Thinreports
   module Core::Shape
-    
-    # @private
+
     class Basic::BlockInternal < Basic::Internal
       format_delegators :box
-      
+
       def style
         @style ||= Style::Basic.new(format)
       end
-      
+
       def read_value
         states.key?(:value) ? states[:value] : format.value.dup
       end
       alias_method :value, :read_value
-      
+
       def write_value(val)
         states[:value] = val
       end
-      
+
       def real_value
         read_value
       end
-      
+
       def type_of?(type_name)
         type_name == :block
       end
     end
-    
+
   end
-end
+end

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

@@ -1,26 +1,27 @@
 # coding: utf-8
 
-module ThinReports
+module Thinreports
   module Core::Shape
-    
-    # @private
+
     class Basic::Format < Core::Format::Base
+      include Utils
+
       config_reader :type, :id
-      config_reader :svg_tag     => %w( svg tag ),
-                    :svg_attrs   => %w( svg attrs )
-                    
+      config_reader svg_tag: %w( svg tag ),
+                    svg_attrs: %w( svg attrs )
+
       config_checker 'true', :display
-      
+
       class << self
       private
-        
+
         # @param [Hash] raw_format
-        # @return [ThinReports::Core::Shape::Basic::Format]
+        # @return [Thinreports::Core::Shape::Basic::Format]
         def build_internal(raw_format)
           new(raw_format)
         end
       end
     end
-    
+
   end
 end

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

@@ -1,6 +1,6 @@
 # coding: utf-8
 
-module ThinReports
+module Thinreports
   module Core::Shape
     
     class Basic::Interface < Base::Interface
@@ -50,7 +50,7 @@ module ThinReports
         end
       end
       
-      # @param [Hash] settings :style_name => value
+      # @param [Hash] settings style_name: value
       # @return [self]
       def styles(settings)
         settings.each{ |args| style(*args) }
@@ -73,7 +73,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)
         Basic::Internal.new(parent, format)
       end

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

@@ -1,17 +1,16 @@
 # coding: utf-8
 
-module ThinReports
+module Thinreports
   module Core::Shape
-    
-    # @private
+
     class Basic::Internal < Base::Internal
       # Delegate to Format's methods
       format_delegators :id, :svg_tag, :type
-      
+
       def style
         @style ||= Style::Graphic.new(format)
       end
-      
+
       def type_of?(type_name)
         ['s-basic', self.type].include?("s-#{type_name}")
       end

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

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

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

@@ -1,13 +1,12 @@
 # coding: utf-8
 
-module ThinReports
+module Thinreports
   module Core::Shape
-    
-    # @private
+
     class ImageBlock::Format < Basic::BlockFormat
-      config_reader :position_x => %w( position-x ),
-                    :position_y => %w( position-y )
+      config_reader position_x: %w( position-x ),
+                    position_y: %w( position-y )
     end
-    
+
   end
 end

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

@@ -1,19 +1,21 @@
 # coding: utf-8
 
-module ThinReports
+module Thinreports
   module Core::Shape
-    
+
     class ImageBlock::Interface < Basic::BlockInterface
       # @see #value
       alias_method :src, :value
-      
+      # @see #value=
+      alias_method :src=, :value=
+
     private
-      
-      # @see ThinReports::Core::Shape::Base::Interface#init_internal
+
+      # @see Thinreports::Core::Shape::Base::Interface#init_internal
       def init_internal(parent, format)
         ImageBlock::Internal.new(parent, format)
       end
     end
-    
+
   end
-end
+end

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

@@ -1,16 +1,15 @@
 # coding: utf-8
 
-module ThinReports
+module Thinreports
   module Core::Shape
-    
-    # @private
+
     class ImageBlock::Internal < Basic::BlockInternal
       alias_method :src, :read_value
-      
+
       def type_of?(type_name)
         type_name == :iblock || super
       end
     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/list/configuration.rb

@@ -1,29 +1,45 @@
 # coding: utf-8
 
-module ThinReports
+module Thinreports
   module Core::Shape
-    
-    class List::Configuration
-      # @return [ThinReports::Core::Shape::List::Events]
-      attr_reader :events
 
-      # @return [ThinReports::Core::Shape::List::Store]
+    class List::Configuration
+      # @return [Thinreports::Core::Shape::List::Store]
+      # @deprecated
+      #   `List::Page#store` will be removed in the next major version.
+      #   You can create a list using #on_page_footer_insert, #on_footer_insert and #on_page_finalize callbacks instead.
+      #   See also https://github.com/thinreports/thinreports-generator/blob/master/examples/list_events/list_events.rb.
       attr_reader :store
 
-      # @param [ThinReports::Core::Shape::List::Events, nil] events (nil)
-      # @param [ThinReports::Core::Shape::List::Store, nil] store (nil)
+      # @param [Thinreports::Core::Shape::List::Events, nil] events (nil)
+      # @param [Thinreports::Core::Shape::List::Store, nil] store (nil)
       def initialize(events = nil, store = nil)
         @events = events || List::Events.new
         @store  = store
       end
-      
-      # @param [Hash] stores :name => default value
+
+      # @return [Thinreports::Core::Shape::List::Events]
+      # @deprecated
+      #   `List::Page#events` will be removed in the next major version.
+      #   Please use #on_page_footer_insert, #on_footer_insert and #on_page_finalize callbacks instead.
+      #   See also https://github.com/thinreports/thinreports-generator/blob/master/examples/list_events/list_events.rb.
+      def events
+        warn '[DEPRECATION] `List#events` will be removed in the next major version. ' +
+             'Please use #on_page_footer_insert, #on_footer_insert and #on_page_finalize callbacks instead. ' +
+             'See also https://github.com/thinreports/thinreports-generator/blob/master/examples/list_events/list_events.rb.'
+        @events
+      end
+
+      def internal_events
+        @events
+      end
+
+      # @param [Hash] stores name: default value
       def use_stores(stores)
         @store = List::Store.init(stores)
       end
-      
-      # @return [ThinReports::Core::Shape::List::Configuration]
-      # @private
+
+      # @return [Thinreports::Core::Shape::List::Configuration]
       def copy
         self.class.new(@events.copy, @store && @store.copy)
       end
@@ -33,7 +49,6 @@ module ThinReports
         List::TYPE_NAME
       end
     end
-    
+
   end
 end
-

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

@@ -1,6 +1,6 @@
 # coding: utf-8
 
-module ThinReports
+module Thinreports
   module Core::Shape
     
     class List::Events < Core::Events
@@ -11,34 +11,34 @@ module ThinReports
       end
       
       class PageEvent < Event
-        # @return [ThinReports::Core::Page]
+        # @return [Thinreports::Report::Page]
         attr_reader :page
         
-        # @param type (see ThinReports::Core::Events::Event#initialize)
-        # @param [ThinReports::Core::Shape::List::Page] target
-        # @param [ThinReports::Core::Page] page
+        # @param type (see Thinreports::Core::Events::Event#initialize)
+        # @param [Thinreports::Core::Shape::List::Page] target
+        # @param [Thinreports::Report::Page] page
         def initialize(type, target, page)
           super(type, target)
           @page = page
         end
         
-        # @return [ThinReports::Core::Shape::List::Page]
+        # @return [Thinreports::Core::Shape::List::Page]
         alias_method :list, :target
       end
       
       class SectionEvent < Event
-        # @return [ThinReports::Core::Shape::List::Store]
+        # @return [Thinreports::Core::Shape::List::Store]
         attr_reader :store
         
-        # @param type (see ThinReports::Core::Events::Event#initialize)
-        # @param [ThinReports::Core::Shape::List::SectionInterface] target
-        # @param [ThinReports::Core::Shape::List::Store] store
+        # @param type (see Thinreports::Core::Events::Event#initialize)
+        # @param [Thinreports::Core::Shape::List::SectionInterface] target
+        # @param [Thinreports::Core::Shape::List::Store] store
         def initialize(type, target, store)
           super(type, target)
           @store = store
         end
         
-        # @return [ThinReports::Core::Shape::List::SectionInterface]
+        # @return [Thinreports::Core::Shape::List::SectionInterface]
         alias_method :section, :target
       end
     end

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

@@ -1,53 +1,52 @@
 # coding: utf-8
 
-module ThinReports
+module Thinreports
   module Core::Shape
-    
-    # @private
+
     class List::Format < Basic::Format
-      config_reader :height => %w( content-height )
-      config_checker 'true', :auto_page_break => %w( page-break )
-      
+      config_reader height: %w( content-height )
+      config_checker 'true', auto_page_break: %w( page-break )
+
       config_reader :header,
                     :detail,
                     :footer
-      config_reader :page_footer => %w( page-footer )
-      
-      config_checker 'true', :has_header => %w( header-enabled )
-      config_checker 'true', :has_footer => %w( footer-enabled )
-      config_checker 'true', :has_page_footer => %w( page-footer-enabled )
-      
-      config_reader :page_footer_height => %w( page-footer height )
-      config_reader :footer_height      => %w( footer height )
-      config_reader :header_height      => %w( header height )
-      config_reader :detail_height      => %w( detail height )
-      
+      config_reader page_footer: %w( page-footer )
+
+      config_checker 'true', has_header: %w( header-enabled )
+      config_checker 'true', has_footer: %w( footer-enabled )
+      config_checker 'true', has_page_footer: %w( page-footer-enabled )
+
+      config_reader page_footer_height: %w( page-footer height )
+      config_reader footer_height: %w( footer height )
+      config_reader header_height: %w( header height )
+      config_reader detail_height: %w( detail height )
+
       config_accessor :sections
-      
+
       # @param [Symbol] section_name
       # @return [Hash]
       def section(section_name)
         __send__(section_name)
       end
-      
+
       # @param [Symbol] section_name
       # @return [Boolean]
       def has_section?(section_name)
         section_name == :detail ? true : __send__(:"has_#{section_name}?")
       end
-      
+
       # @param [Symbol] section_name
       # @return [Numeric]
       def section_height(section_name)
         has_section?(section_name) ? __send__(:"#{section_name}_height") : 0
       end
-      
+
       class << self
-        
+
       private
-        
+
         # @param [Hash] raw_format
-        # @return [ThinReports::Core::Shape::List::Format]
+        # @return [Thinreports::Core::Shape::List::Format]
         def build_internal(raw_format)
           new(raw_format) do |f|
             f.sections = {}
@@ -57,16 +56,16 @@ module ThinReports
             build_section(:page_footer, f) if f.has_page_footer?
           end
         end
-        
+
         # @param [Symbol] section_name
-        # @param [ThinReports::Core::Shape::List::Format] list
-        # @return [ThinReports::Core::Shape::List::SectionFormat]
+        # @param [Thinreports::Core::Shape::List::Format] list
+        # @return [Thinreports::Core::Shape::List::SectionFormat]
         def build_section(section_name, list)
           list.sections[section_name] =
             List::SectionFormat.build(list.section(section_name))
         end
       end
     end
-    
+
   end
 end