thinreports 0.7.7 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8bd5e81c97f873dec7aea631b5ee9a3f2194bdad
-  data.tar.gz: 8e84d4b9e83f60c98293305d2f4f937ae65697a3
+  metadata.gz: 52d5b58f89d69995f780cad5fee9ee7d9476ba48
+  data.tar.gz: 1ac6e9e07a7fb3776137cd9d4663fdbae832418e
 SHA512:
-  metadata.gz: db8ff91414f3f2826c6dc4d58b2dfc77fd824075a363da23d7bdbeb0049cca5b72f4fdf2c04cc7b33641baf6ed383705ad791d28376cc152e648cf5cf7950349
-  data.tar.gz: f6198bc83cc5eb2566c20e50223a1c74a9d09a04b47b06e4c78111efafbe1f8ae2394026378909d57090acefaa8ed8681b8488f2815b3e8942ebf69a384f0975
+  metadata.gz: 5bd6e15835d02834f428649d474bcdf398e1e550f406652c1827539628e2e83b1aa4e8a550e2003d1521ed950f011dbb9b858101bde330c2eb44322a68eb6dad
+  data.tar.gz: 25ec1244b98b2da6558b05ab5e36650993574c26aae541ed077934169e4f9ae0154b2a0e7153bedfa668e8f3107ca586fd0cac1b67cab461854559f3c12929de

data/.gitignore

@@ -1,9 +1,6 @@
 Gemfile.lock
 *.gem
-*.swp
 *.pdf
-
-.bundle/
-doc/yardoc
-.yardoc/
-coverage
+.bundle
+.yardoc
+doc

data/.travis.yml

@@ -1,16 +1,10 @@
 language: ruby
 
-before_install:
-  - gem update --system 2.1.11
-  - gem --version
-rvm: 
-  - 1.8.7
+rvm:
   - 1.9.3
   - 2.0.0
-  - 2.1.0
+  - 2.1.6
+  - 2.2.2
   - jruby
-env:
-  - JRUBY_OPTS=--1.8
-
-script: rake test:unit
 
+script: rake test

data/CHANGELOG.md

@@ -0,0 +1,220 @@
+## 0.8.0
+
+This release is a stepping stone to next major version 1.0.0 release.
+
+  * Upgrade to Prawn 1.3 and drop support for Ruby 1.8.7 (#11)
+  * Change name of root module to Thinreports from ThinReports (#15)
+  * Implement `Item#value=` method (#20)
+  * Implement new list callbacks (#17)
+  * Implement `page[:item_id]=` as alias for `page.item(:item_id).value=` (#22)
+  * Support font-size style for Text and TextBlock (#23)
+  * Support for setting the default fallback font (#7)
+  * Remove `Report#generate_file` method (#13)
+  * Deprecate `Report#events`, and implement new callbacks (#18)
+  * Deprecate `List#events`, recommend to use `List#on_page_finalize` callback or create manually (#9)
+
+### Upgrade to Prawn 1.3 and drop support for Ruby 1.8.7
+
+We have dropped support for MRI 1.8.7 and 1.8 mode JRuby by upgrading to Prawn 1.3.
+Currently supported versions are MRI 1.9.3 and 2.0.0 or higher, JRuby(1.9 mode) 1.7 or higher.
+
+### Change name of root module to Thinreports from ThinReports
+
+We have changed name of root module to `Thinreports` from `ThinReports`.
+Old name `ThinReports` has been enabling as alias, but it will be removed
+in the next major release.
+
+### Deprecate `List#events` and `List#store`
+
+`List#events` and `List#store` have been deprecated.
+
+```ruby
+report.layout.config.list do |list|
+  list.events.on :page_footer_insert do |e|
+    # ...
+  end
+  # => warn: "[DEPRECATION] ..."
+
+  list.events.on :footer_insert do |e|
+    # ...
+  end
+  # => warn: "[DEPRECATION] ..."
+
+  list.events.on :page_finalize do |e|
+    # ...
+  end
+  # => warn: "[DEPRECATION] ..."
+end
+
+list.store.price += 0 # => warn: "[DEPRECATION] ..."
+```
+
+Please use new callbacks instead:
+
+```ruby
+report.list do |list|
+  price = 0
+
+  list.on_page_footer_insert do |footer|
+    footer.item(:price).value = price
+  end
+
+  list.on_footer_insert do |footer|
+    # ...
+  end
+
+  list.on_page_finalize do
+    # ...
+  end
+end
+```
+
+See [Issue #17](https://github.com/thinreports/thinreports-generator/issues/17), [Issue #9](https://github.com/thinreports/thinreports-generator/issues/9) and [examples/list_events](https://github.com/thinreports/thinreports-generator/tree/master/examples/list_events) for further details.
+
+### Deprecate `Report#events`, and implement new callbacks
+
+`Report#events` has been deprecated:
+
+```ruby
+report.events.on :page_create do |e|
+  e.page.item(:text1).value('Text1')
+end
+# => warn: "[DEPRECATION] ..."
+
+report.events.on :generate do |e|
+  e.pages.each do |page|
+    page.item(:text2).value('Text2')
+  end
+end
+# => warn: "[DEPRECATION] ..."
+```
+
+Please use `Report#on_page_create` callback instead.
+However `Report#on_generate` callback has not been implemented,
+but you can do the same things using `Report#pages` method.
+
+```ruby
+report.on_page_create do |page|
+  page.item(:text1).value('Text1')
+end
+
+report.pages.each do |page|
+  page.item(:text2).value('Text2')
+end
+
+report.generate filename: 'foo.pdf'
+```
+
+See [Issue #18](https://github.com/thinreports/thinreports-generator/issues/18) for further details.
+
+### Implement `page[:item_id]=` as alias for `page.item(:item_id).value=` (#22)
+
+```ruby
+# New setter, same as `page.item(:text_block).value = 'tblock value'`
+page[:text_block] = 'tblock value'
+# New getter, same as `page.item(:text_block).value`
+page[:text_block] # => "tblock value"
+page.item(:text_block).value # => "tblock value"
+
+page[:image_block] = '/path/to/image.png'
+page[:image_block] # => "/path/to/image.png"
+```
+
+See [Issue #22](https://github.com/thinreports/thinreports-generator/issues/22) for further details.
+
+### Implement `Item#value=` method
+
+```ruby
+page.item(:text_block).value('value')
+page.item(:text_block).value = 'value'
+page.item(:image_block).src('/path/to/image.tlf')
+page.item(:image_block).src = '/path/to/image.tlf'
+```
+
+See [Issue #20](https://github.com/thinreports/thinreports-generator/issues/20) for further details.
+
+### Support font-size style for Text and TextBlock
+
+```ruby
+page.item(:text).style(:font_size, 20)
+page.item(:text_block).style(:font_size, 20)
+page.item(:text_block).style(:font_size) # => 20
+```
+
+See [Issue #23](https://github.com/thinreports/thinreports-generator/issues/23) for further details.
+
+### Support for setting the default fallback font
+
+Please see [Issue #7](https://github.com/thinreports/thinreports-generator/issues/7) for further details.
+
+## 0.7.7.1
+
+  * No release for generator
+
+## 0.7.7
+
+### Features
+
+  * ページ番号ツール [Katsuya Hidaka]
+  * New "Word-wrap" property of TextBlock [Katsuya Hidaka]
+  * B4/B5 の ISO サイズを追加 [Takumi FUJISE / Minoru Maeda / Katsuya Hidaka]
+  * generate filename: 'foo.pdf' を実装、#generate_file を非推奨へ [Katsuya Hidaka]
+  * start_new_page layout: 'file.tlf' でもデフォルトレイアウトが設定されるよう改善 [Eito Katagiri / Katsuya Hidaka]
+
+### Bug fixes
+
+  * Report#use_layout で list の設定を行うとエラーが発生する [Katsuya Hidaka]
+  * Layout::Format#page_margin_right が不正な値を返す [Katsuya Hidaka]
+  * セキュリティを設定した PDF を印刷すると "このページにはエラーがあります..." メッセージが表示される [Katsuya Hidaka]
+  * B4 サイズで出力した PDF の用紙サイズが正しくない [Takumi FUJISE / Katsuya Hidaka]
+
+## 0.7.6
+
+### Features
+
+  * デフォルトレイアウトを書き換え可能へ変更 [Katsuya Hidaka]
+
+### Bug fixes
+
+  * Fix raise NoMethodError when has no default layout [Katsuya Hidaka]
+
+## 0.7.5
+
+### Features
+
+  * テキストブロックのオーバフロープロパティ [Katsuya Hidaka]
+  * list メソッドのデフォルト id と Report#list の追加 [Katsuya Hidaka]
+
+### Bug fixes
+
+  * gem install 時にRDoc生成時のエラーが表示される場合がある [Katsuya Hidaka]
+  * エディターにて一覧表ツールのヘッダーを使わない場合の動作について [吉田 和弘 / Katsuya Hidaka]
+
+## 0.7.0
+
+### Features
+
+  * Listに :page_finalize イベントを追加
+  * ダイナミックスタイルの拡充
+  * イメージブロックの実装
+  * Tblockで行間、横位置、縦位置、文字間隔の指定を可能に
+  * Prawn 0.12.0 を採用
+  * メタ情報のタイトルに反映
+  * Example Test環境の構築
+  * 外字の埋め込みサポート
+  * clean taskの削除
+  * YARD Docのテンプレート追加
+  * ロードするprawnのバージョンを固定
+  * .generate, .generate_fileメソッドのオプション指定をフラット化
+  * 単行モードテキストブロックがレイアウトで定義した「高さ」の影響を受けないように
+  * PXD形式の出力フォーマット廃止とデフォルトタイプの導入
+  * $KCODEによる文字カウント処理の改善
+  * List#headerの挙動を改善
+  * Errors::UnknownItemId 時のエラーメッセージを分かりやすく
+  * テスト漏れに対するテストコード作成とテスト
+
+### Bug fixes
+
+  * フッターが挿入時、リスト領域をオーバフローしない場合でも改ページされる場合がある
+  * Tblockで基本書式のみ設定されている場合、その書式が反映されない
+  * Tblockがフォントサイズに対して小さすぎる場合にエラー

data/Gemfile

@@ -2,6 +2,6 @@ source 'http://rubygems.org'
 
 gemspec
 
-# For 1.8.7
-gem 'json', '>= 1.4.6' unless RUBY_VERSION > '1.9'
-
+group :example do
+  gem 'pdf-inspector'
+end

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Matsukei Co.,Ltd.
+Copyright (c) 2015 Matsukei Co.,Ltd.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -0,0 +1,286 @@
+# Thinreports Generator [![Join the chat at https://gitter.im/thinreports/thinreports-generator](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/thinreports/thinreports-generator?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
+[![Gem Version](https://badge.fury.io/rb/thinreports.svg)](http://badge.fury.io/rb/thinreports)
+[![](http://img.shields.io/travis/thinreports/thinreports-generator.svg?style=flat)](http://travis-ci.org/thinreports/thinreports-generator)
+[![](http://img.shields.io/codeclimate/github/thinreports/thinreports-generator.svg?style=flat)](https://codeclimate.com/github/thinreports/thinreports-generator)
+[![](http://img.shields.io/gemnasium/thinreports/thinreports-generator.svg?style=flat)](https://gemnasium.com/thinreports/thinreports-generator)
+
+[Thinreports](http://www.thinreports.org) is an open source report generating tool for Ruby.
+
+  * Thinreports Editor (GUI Designer)
+  * Thinreports Generator (Report Generator for Ruby)
+
+## Getting Started
+
+  * [Installation Guide](http://www.thinreports.org/documentation/getting-started/installation.html)
+  * [Quick Start Guide](http://www.thinreports.org/documentation/getting-started/quickstart.html)
+  * [Examples](https://github.com/thinreports/thinreports-examples)
+  * [Rails4 Example](https://github.com/thinreports/thinreports-rails4-example)
+  * [Changelog](https://github.com/thinreports/thinreports-generator/blob/master/CHANGELOG.md)
+  * [Discussion Group](https://groups.google.com/forum/#!forum/thinreports)
+  * [![Join the chat at https://gitter.im/thinreports/thinreports-generator](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/thinreports/thinreports-generator?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
+## Supported versions
+
+  * Ruby 1.9.3, 2.0, 2.1, 2.2
+  * JRuby 1.7.0+ (1.9 mode)
+
+## Quick Reference
+
+**NOTE:** You need to create a layout file `.tlf` using [Thinreports Editor](http://www.thinreports.org/features/editor/).
+
+### Basic Objects and Basic Usage
+
+```ruby
+require 'thinreports'
+
+report = Thinreports::Report.new layout: 'report.tlf'
+
+report.start_new_page do
+  item(:title).value('Thinreports')
+end
+
+report.start_new_page do |page|
+  # Item Finder
+  page.item(:item_id) # => Item object
+  page[:item_id]      # => Item object
+
+  # Text block
+  page.item(:text_block).value('Pure Ruby')
+  page.item(:text_block).value = 'Pure Ruby'
+  page[:text_block] = 'Pure Ruby'
+  page.item('text_block').set('value', color: '#0000ff')
+  page.item(:text_block).format_enabled(false)
+
+  # Image block
+  page.item(:image_block).src('/path/to/image.png')
+  page.item(:image_block).src = '/path/to/image.png'
+  page[:image_block] = '/path/to/image.png'
+  require 'open-uri'
+  page.item(:image_block).src(open('http://www.thinreports.org/assets/logos/thinreports-logo.png'))
+
+  # Attributes
+  page.item(:any).hide
+  page.item(:any).show
+  page.item(:any).visible(true)
+  page.item(:any).visible? # => true
+  page.item(:any).id # => "any"
+
+  # Styles
+  page.item(:text).style(:color, 'red')
+  page.item(:text).style(:bold, true)
+  page.item(:text).style(:italic, true)
+  page.item(:text).style(:linethrough, true)
+  page.item(:text).style(:underline, true)
+  page.item(:text).style(:font_size, 20)
+
+  page.item(:text).style(:align, :left or :center or :right)
+  page.item(:text).style(:valign, :top or :center or :bottom)
+
+  page.item(:rectangle).style(:border_color, '#ff0000')
+                       .style(:border_width, 1)
+                       .style(:fill_color, '#ffffff')
+
+  # Bulk setting of styles
+  page.item(:text).styles(color: '#00000', align: :right)
+
+  # Bulk setting of values
+  page.values text_block_a: 'value', text_block_b: 'value'
+
+  # Helpers
+  page.item_exists?(:existing_id)  # => true
+  page.item_exists?('existing_id') # => true
+  page.item_exists?(:unknown_id)   # => false
+end
+
+report.generate(filename: 'report.pdf')
+```
+
+```ruby
+Thinreports::Report.generate(filename: 'report.pdf', layout: 'report.tlf') do |report|
+  report.start_new_page do |page|
+    # :
+  end
+end
+```
+
+### Report and Page
+
+```ruby
+report = Thinreports::Report.new layout: 'foo.tlf'
+
+3.times { report.start_new_page }
+
+# Returns all pages
+report.pages # => [<Report::Page>, <Report::Page>, <Report::Page>]
+# Returns number of pages
+report.page_count # => 3
+
+# Add a blank page
+report.add_blank_page
+
+report.pages.last # => Report::BlankPage
+```
+
+### Using multiple layouts
+
+```ruby
+report = Thinreports::Report.new
+
+report.use_layout '/path/to/default.tlf', default: true
+report.use_layout '/path/to/other1.tlf', id: :other
+
+report.start_new_page do |page|
+  # use '/path/to/default.tlf' layout
+end
+
+report.start_new_page layout: :other do |page|
+  # use '/path/to/other1.tlf' layout
+end
+
+report.start_new_page layout: '/path/to/other2.tlf' do |page|
+  # use '/path/to/other2.tlf' layout
+end
+```
+
+### Callbacks
+
+```ruby
+report = Thinreports::Report.new layout: 'foo.tlf'
+
+# It will be called before finalizing each page
+report.on_page_create do |page|
+  page.item(:text).value('Text for all pages')
+end
+```
+
+See also [examples/report_callbacks](https://github.com/thinreports/thinreports-generator/tree/master/examples/report_callbacks).
+
+### List
+
+```ruby
+report = Thinreports::Report.new layout: 'list.tlf'
+
+report.list.header do |header|
+  header.item(:text_block).value('Title')
+end
+
+10.times do |n|
+  report.list.add_row do |row|
+    row.item(:text_block).value(n)
+  end
+end
+
+report.generate(filename: 'list.pdf')
+```
+
+```ruby
+report = Thinreports::Report.new layout: 'list_with_footer.tlf'
+
+report.list do |list|
+  total_price = 0
+  price_per_page = 0
+
+  list.on_page_finalize do
+    total_price += price_per_page
+    price_per_page = 0
+  end
+
+  list.on_page_footer_insert do |footer|
+    footer.values price: price_per_page
+  end
+
+  list.on_footer_insert do |footer|
+    footer.item(:price).value(total_price)
+  end
+
+  [100, 200, 300].each do |price|
+    list.add_row do |row|
+      row[:price] = price
+    end
+    price_per_page += price
+  end
+end
+```
+
+See also  [examples/list_events](https://github.com/thinreports/thinreports-generator/tree/master/examples/list_events).
+
+### Page Number
+
+```ruby
+# Setting starting number of page
+report.start_page_number_from 5
+
+# Setting whether to count new page
+report.start_new_page count: true # default
+report.start_new_page count: false
+
+# Change styles
+report.start_new_page do |page|
+  page.item(:pageno).hide
+  page.item(:pageno).show
+  page.item(:pageno).visible(false)
+  page.item(:pageno).styles(color: 'red', bold: true)
+end
+```
+
+See also [examples/page_number](https://github.com/thinreports/thinreports-generator/blob/master/examples/page_number) and [examples/list_page_number](https://github.com/thinreports/thinreports-generator/blob/master/examples/list_page_number).
+
+### Configuring fallback fonts
+
+```ruby
+Thinreports.configure do |config|
+  config.fallback_fonts = '/path/to/fallback.ttf'
+end
+
+Thinreports.config.fallback_fonts = ['/path/to/font_a.ttf', '/path/to/font_b.ttf']
+```
+
+See also [examples/eudc](https://github.com/thinreports/thinreports-generator/blob/master/examples/eudc).
+
+## Features
+
+Features of Editor is [here](http://www.thinreports.org/features/editor/).
+
+### Easy to generate PDF
+
+Design layout using Editor, then embed values to text field in layout.
+
+### Simple runtime environment
+
+Ruby, RubyGems, Prawn and Generator.
+
+### Dynamic operation
+
+Generator can dynamically:
+
+  * change value of TextBlock and ImageBlock
+  * change style (border, fill, visibility, position, color, font) of Shape
+
+### Others
+
+  * External characters (Gaiji) for Japanese
+
+## Contributing
+
+### Report bug, post your suggestion
+
+If you find bugs or improvements for the Editor, please report it [here](https://github.com/thinreports/thinreports-generator/issues/new).
+
+### Sending a Pull Request
+
+  1. Fork it
+  2. Clone your forked repository
+  3. Create your feature branch: `git checkout -b my-new-feature`
+  4. Fix your feature
+  5. Commit your changes: `git commit -am 'Fixed some bugs or features'`
+  6. Push to the branch: `git push origin my-new-feature`
+  7. Create new Pull Request
+
+## License
+
+Thinreports Generator is licensed under the [MIT-License](https://github.com/thinreports/thinreports-generator/blob/master/MIT-LICENSE).
+
+## Copyright
+
+&copy; 2010-2015 [Matsukei Co.,Ltd](http://www.matsukei.co.jp).