thinreports 0.6.0.pre3 → 0.7.0

data/README.rdoc

@@ -1,69 +1,74 @@
 = ThinReports Generator
 
 ThinReports is Open Source Reporting Solution for Ruby.
-And it provide you these tools.
+And it provides you these tools:
 
-* ThinReports Editor (GUI Layout Editor)
-* ThinReports Generator (Report Generation Interface for Ruby)
+* ThinReports Editor (GUI Designer)
+* ThinReports Generator (Report Generator for Ruby)
 
-Please refer to {Official Site}[http://www.thinreports.org/] and
-{Project Site}[http://osc.matsukei.net/projects/thinreports/wiki] for more details.
+You can see more details:
+
+* {Official Site}[http://www.thinreports.org/]
+* {Project Site}[http://osc.matsukei.net/projects/thinreports/wiki]
 
 == Quick Start
 
 Getting started with ThinReports Generator can be as simple as:
 
- require 'thinreports'
+  require 'thinreports'
   
- report = ThinReports::Report.new :layout => 'report.tlf'
- report.start_new_page do
-   page.item(:title).value('ThinReports')
- end
+  report = ThinReports::Report.new :layout => 'report.tlf'
+  report.start_new_page do
+    page.item(:title).value('ThinReports')
+  end
   
- report.generate_file(:pdf, 'report.pdf')
+  # :pdf is used as default when the type argument of a #generate_file is omitted.
+  report.generate_file('report.pdf')
 
 Or can be as:
-  
- ThinReports::Report.generate_file(:pdf, 'report.pdf', :layout => 'report.tlf') do
-   start_new_page
+
+  ThinReports::Report.generate_file(:pdf, 'report.pdf', :layout => 'report.tlf') do
+    start_new_page
     
-   page.item(:title).value('ThinReports')
+    page.item(:title).value('ThinReports')
     
-   start_new_page
+    start_new_page
     
-   page.item(:title).value('ThinReports').style(:fill, 'red')
- end
-  
+    page.item(:title).value('ThinReports').style(:color, '#ff0000')
+  end
+
 {Learn more}[http://osc.matsukei.net/projects/thinreports/wiki/Getting_Started].
 
-== Documentation
+== Release Note
+
+* {Changelog}[http://osc.matsukei.net/projects/thinreports/wiki/Changelog]
 
-We provide you a few useful resources to help you get started with ThinReports.
+== Documentation
 
 * {Getting Started}[http://osc.matsukei.net/projects/thinreports/wiki/Getting_Started]
 * {Guide}[http://osc.matsukei.net/projects/thinreports/wiki/Guide]
-* {Roadmap}[http://osc.matsukei.net/projects/thinreports/roadmap]
-* {Changelog}[http://osc.matsukei.net/projects/thinreports/wiki/Changelog]
+* {Examples}[http://osc.matsukei.net/projects/thinreports/wiki/Examples]
+* {HowTos}[http://osc.matsukei.net/projects/thinreports/wiki/HowTos]
 
-== Source Code
+== Project
 
-Please see {here}[http://osc.matsukei.net/projects/thinreports/wiki/Source_Code].
+* {Roadmap}[http://osc.matsukei.net/projects/thinreports/roadmap]
+* {Issue Tracker (Read-Only)}[http://osc.matsukei.net/projects/thinreports/issues]
+* {Source Code}[http://osc.matsukei.net/projects/thinreports/wiki/Source_Code]
 
-== Community Support
+== Help
 
 * {Open Forum}[http://osc.matsukei.net/projects/thinreports/boards]
-* {Issue Tracker (Read-Only)}[http://osc.matsukei.net/projects/thinreports/issues]
 
 == Dependencies
 
-* <code>prawn</code> <code>= 0.11.1</code>
-* <code>json</code> <code>>= 1.4.6</code>
-  (Only for less than Ruby 1.9)
+* <code>prawn</code> <code>= 0.12.0</code>
+* <code>json</code> <code>>= 1.4.6</code> (Only for less than Ruby 1.9)
 
 === Note
 
 We tested on <code>Ruby 1.8.7</code> and <code>1.9.2</code>.
-We recommend <code>1.9.2+</code>.
+But we recommend <code>1.9.2+</code>.
 
 == Resources
 
@@ -71,7 +76,7 @@ We recommend <code>1.9.2+</code>.
 
 ThinReports includes the following fonts.
 
-* IPAFonts: Copyright(c) 2003-2011 Information-technology Promotion Agency, Japan.
+* IPAFonts: Copyright(c) 2003-2011 Information-technology Promotion Agency, Japan.  
   Please see the lincense file {IPA_Font_License_Agreement_v1.0.txt}[http://ipafont.ipa.go.jp/ipa_font_license_v1.html].
 
 == License

data/doc/yardoc_templates/default/layout/html/footer.erb

@@ -7,4 +7,4 @@
     ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
     var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
   })();
-</script>
+</script

data/lib/thinreports.rb

@@ -2,9 +2,10 @@
 
 module ThinReports
   # The current version.
-  VERSION = '0.6.0.pre3'
+  VERSION = '0.7.0'
 end
 
+require 'thinreports/config'
 require 'thinreports/core'
 require 'thinreports/report'
 require 'thinreports/layout'

data/lib/thinreports/config.rb

@@ -0,0 +1,21 @@
+# coding: utf-8
+
+module ThinReports
+  # @yield [config]
+  # @yieldparam [ThinReports::Configuration] config
+  def self.configure(&block)
+    block_exec_on(self.config, &block)
+  end
+  
+  # @return [ThinReports::Configuration]
+  def self.config
+    @config ||= ThinReports::Configuration.new
+  end
+  
+  class Configuration
+    # @return [ThinReports::Generator::Configuration]
+    def generator
+      @generator ||= ThinReports::Generator::Configuration.new
+    end
+  end
+end

data/lib/thinreports/core/errors.rb

@@ -7,6 +7,10 @@ module ThinReports
     end
     
     class UnknownShapeStyleName < Basic
+      def initialize(style, availables)
+        super("The specified style name, '#{style}', cannot be used. " +
+              "The available styles are #{availables.map{|s| ":#{s}"}.join(', ')}.")
+      end
     end
     
     class UnknownShapeType < Basic
@@ -22,9 +26,15 @@ module ThinReports
     end
     
     class UnknownItemId < Basic
+      def initialize(id, item_type = 'Basic')
+        super("The layout does not have a #{item_type} Item with id '#{id}'.")
+      end
     end
     
     class DisabledListSection < Basic
+      def initialize(section)
+        super("The #{section} section is disabled.")
+      end
     end
     
     class UnknownEventType < Basic
@@ -34,6 +44,9 @@ module ThinReports
     end
     
     class UnknownGeneratorType < Basic
+      def initialize(type)
+        super("The specified generator type, '#{type}', was not found.")
+      end
     end
     
     class NoConfigurationFound < Basic
@@ -49,7 +62,7 @@ module ThinReports
       def initialize(filename, fileversion, required_rules)
         super("Generator #{ThinReports::VERSION} can not be built this file, " +
               "'#{File.basename(filename)}'." +
-              "This file is created in the Editor of version '#{fileversion}', " +
+              "This file is updated in the Editor of version '#{fileversion}', " +
               "but Generator requires version #{required_rules}.")
       end      
     end

data/lib/thinreports/core/format/builder.rb

@@ -1,6 +1,11 @@
 # coding: utf-8
 
-require 'json'
+begin
+  require 'json'
+rescue LoadError
+  puts 'ThinReports requires json >= 1.4.6. ' +
+       'Please `gem install json` and try again.'
+end
 
 module ThinReports
   module Core::Format

data/lib/thinreports/core/page.rb

@@ -5,8 +5,8 @@ module ThinReports
     
     class BlankPage
       # @return [Integer]
-			attr_accessor :no
-			
+      attr_accessor :no
+      
       # @param [Boolean] count (nil)
       def initialize(count = nil)
         @count = count.nil? ? true : count
@@ -61,7 +61,7 @@ module ThinReports
           new_page.manager.shapes[id] = new_shape
           
           if new_shape.internal.type_of?(:list)
-						new_page.manager.lists[id] = new_shape
+            new_page.manager.lists[id] = new_shape
           end
         end
         new_page
@@ -71,11 +71,11 @@ module ThinReports
       # @option options [:create, :copy] :at (:create)
       # @private
       def finalize(options = {})
-				at = options[:at] || :create
-				
+        at = options[:at] || :create
+        
         # For list shapes.
         if at == :create
-					manager.lists.values.each {|list| list.manager.finalize }
+          manager.lists.values.each {|list| list.manager.finalize }
         end
         
         @finalized = true

data/lib/thinreports/core/shape.rb

@@ -28,14 +28,11 @@ module ThinReports
       # @private
       def self.find_by_type(type)
         case type
-        when Tblock::TYPE_NAME
-          Tblock
-        when List::TYPE_NAME
-          List
-        when Text::TYPE_NAME
-          Text
-        when *Basic::TYPE_NAMES
-          Basic
+        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 *Basic::TYPE_NAMES    then Basic
         else
           raise ThinReports::Errors::UnknownShapeType
         end
@@ -45,9 +42,11 @@ module ThinReports
   end
 end
 
+require 'thinreports/core/shape/style'
 require 'thinreports/core/shape/manager'
 require 'thinreports/core/shape/base'
 require 'thinreports/core/shape/basic'
 require 'thinreports/core/shape/text'
-require 'thinreports/core/shape/tblock'
+require 'thinreports/core/shape/text_block'
+require 'thinreports/core/shape/image_block'
 require 'thinreports/core/shape/list'

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

@@ -13,29 +13,27 @@ module ThinReports
       end
       private_class_method :format_delegators
       
-      AVAILABLE_STYLES = [:fill, :stroke]
-      
       attr_reader :parent
       attr_reader :format
-      attr_accessor :attrs, :states
+      attr_writer :style
+      attr_accessor :states
       
       def initialize(parent, format)
         @parent = parent
         @format = format
-        
         @states = {}
-        @attrs  = {}
+        @style  = nil
         
         @finalized_attributes = nil
       end
       
-      def attributes
-        @finalized_attributes ||= (format.svg_attrs || {}).merge(attrs)
+      def style
+        raise NotImplementedError
       end
       
       def copy(new_parent, &block)
         new_internal = self.class.new(new_parent, format)
-        new_internal.attrs  = attrs.simple_deep_copy
+        new_internal.style  = style.copy
         new_internal.states = states.simple_deep_copy
         
         block.call(new_internal) if block_given?
@@ -47,10 +45,6 @@ module ThinReports
         self
       end
       
-      def available_style?(style_name)
-        AVAILABLE_STYLES.include?(style_name)
-      end
-      
       def type_of?(type_name)
         raise NotImplementedError
       end

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

@@ -13,3 +13,6 @@ end
 require 'thinreports/core/shape/basic/format'
 require 'thinreports/core/shape/basic/internal'
 require 'thinreports/core/shape/basic/interface'
+require 'thinreports/core/shape/basic/block_format'
+require 'thinreports/core/shape/basic/block_internal'
+require 'thinreports/core/shape/basic/block_interface'

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

@@ -0,0 +1,12 @@
+# coding: utf-8
+
+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

@@ -0,0 +1,25 @@
+# coding: utf-8
+
+module ThinReports
+  module Core::Shape
+    
+    class Basic::BlockInterface < Basic::Interface
+      # @overload value(val)
+      #   Set a val
+      #   @param [Object] val
+      #   @return [self]
+      # @overload value
+      #   Return the value
+      #   @return [Object]
+      def value(*args)
+        if args.empty?
+          internal.read_value
+        else
+          internal.write_value(args.first)
+          self
+        end
+      end
+    end
+    
+  end
+end

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

@@ -0,0 +1,33 @@
+# coding: utf-8
+
+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

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

@@ -4,27 +4,53 @@ module ThinReports
   module Core::Shape
     
     class Basic::Interface < Base::Interface
-      internal_delegators :visible?, :id, :type
+      internal_delegators :type
+      
+      # @return [String]
+      def id
+        internal.id.dup
+      end
       
       # @param [Boolean] visibility
       # @return [self]
       def visible(visibility)
-        internal.visible(visibility)
+        internal.style.visible = visibility
         self
       end
       
-      # @param [Symbol] style_name
-      # @param [String] value
-      # @return [self]
-      def style(style_name, value)
-        unless internal.available_style?(style_name)
-          raise ThinReports::Errors::UnknownShapeStyleName
+      # @return [Boolean]
+      def visible?
+        internal.style.visible
+      end
+      
+      # @overload style(style_name)
+      #   @param [Symbol] style_name
+      #   @return [Object]
+      # @overload style(style_name, value)
+      #   @param [Symbol] style_name
+      #   @param [String, Symbol, Number, Array] value
+      #   @return [self]
+      # @overload style(style_name, value1, value2)
+      #   @param [Symbol] style_name
+      #   @param [String, Number] value1
+      #   @param [String, Number] value2
+      #   @return [self]
+      def style(*args)
+        case args.length
+        when 1
+          internal.style[args.first]
+        when 2
+          internal.style[args.first] = args.last
+          self
+        when 3
+          internal.style[args.shift] = args
+          self
+        else
+          raise ArgumentError, '#style requires 1 or 2, 3 arguments'
         end
-        internal.svg_attr(style_name, value)
-        self
       end
       
-      # @param [Hash] settings
+      # @param [Hash] settings :style_name => value
       # @return [self]
       def styles(settings)
         settings.each{ |args| style(*args) }