RubyGems - thinreports-rails - Versions diffs - 0.1.2 - Mend

thinreports-rails 0.1.2

Files changed (19) hide show

data/.gitignore +19 -0
data/Gemfile +4 -0
data/LICENSE +22 -0
data/README.md +117 -0
data/lib/thinreports-rails.rb +3 -0
data/lib/thinreports-rails/railtie.rb +13 -0
data/lib/thinreports-rails/template_handler.rb +73 -0
data/lib/thinreports-rails/version.rb +4 -0
data/test/test_app/app/views/orders/_header.pdf.thinreports +2 -0
data/test/test_app/app/views/orders/_other_header.pdf.thinreports +3 -0
data/test/test_app/app/views/orders/index.pdf.thinreports +8 -0
data/test/test_app/app/views/orders/index.tlf +1 -0
data/test/test_app/app/views/orders/no_tlf.pdf.thinreports +2 -0
data/test/test_app/app/views/orders/other_tlf_path.pdf.thinreports +8 -0
data/test/test_app/app/views/reports/other.tlf +1 -0
data/test/test_app/test_app.rb +51 -0
data/test/thinreports-rails_test.rb +30 -0
data/thinreports-rails.gemspec +18 -0
metadata +88 -0

data/.gitignore ADDED Viewed

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/log
+test/version_tmp
+tmp
+log

data/Gemfile ADDED Viewed

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+# Specify your gem's dependencies in thinreports-rails.gemspec
+gemspec

data/LICENSE ADDED Viewed

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Takeshi Shinoda
+MIT License
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md ADDED Viewed

@@ -0,0 +1,117 @@
+# ThinreportsRails
+ThinReporsRails is constructed by Rails Template Handler [ThinReports](http://www.thinreports.org/ "ThinReposts") the PDF.
+Oldname: thinreports-handler
+## Supported versions
+* Ruby 1.8.7, 1.9.3
+* Rails 3.0.X, 3.1.X, 3.2.X
+* ThinReports 0.7.X
+## Installation
+Add this line to your application's Gemfile:
+    gem 'thinreports-rails'
+And then execute:
+    $ bundle
+Or install it yourself as:
+    $ gem install thinreports-rails
+## Usage
+### Example to, Display in the browser.
+#### Controllers
+``` ruby
+class OrdersController < ApplicationController
+  def index
+    @orders = Order.all
+  end
+end
+```
+#### Views
+app/views/orders/index.pdf.thinreports
+``` ruby
+report.set_layout # ! <= Required. default use: orders/index.tlf
+report.start_new_page
+report.page.values printed_at: Time.now
+@orders.each do |order|
+  report.page.list(:list).add_row do |row|
+    row.item(:col1).value order.name
+    row.item(:col2).value order.num
+  end
+end
+```
+### Example to, Download PDF.
+``` ruby
+class OrdersController < ApplicationController
+  def index
+    @orders = Order.all
+    respond_to do |format|
+      format.pdf {
+        send_data render_to_string, filename: 'foo.pdf', type: 'application/pdf', disposition: 'attachment'
+      }
+    end
+  end
+end
+```
+### Configuration
+### Layout file(.tlf) and options.
+Example of using the `app/views/reports/index.tlf`.
+Write code like this to `index.pdf.thinreports`.
+`:layout_options` is an option `ThinReports::Report::Base#use_layout` method.
+``` ruby
+report.set_layout tlf: 'reports/index', layout_options: { default: true }
+```
+### generate options.
+``` ruby
+report.generate_options(security: {
+  user_password: 'foo',
+  owner_password: 'bar',
+  permissions: {
+    print_document: false,
+    modify_contents: false,
+    copy_contents: false
+  }
+})
+```
+### Partial
+For exsample to use, `app/views/orders/_header.pdf.thinreports`.
+`title` is local variable in `_header.pdf.thinreports`.
+``` ruby
+report.partial! 'header', title: title
+```
+## Authour
+* TwitterID: @takeshinoda
+* Blog: http://d.hatena.ne.jp/takeshinoda/
+## Contributing
+m(__)m, send me pull request.
+## Copyright
+Copyright (c) 2012 Takeshi Shinoda.

data/lib/thinreports-rails.rb ADDED Viewed

@@ -0,0 +1,3 @@
+require "thinreports-rails/version"
+require "thinreports-rails/railtie"

data/lib/thinreports-rails/railtie.rb ADDED Viewed

@@ -0,0 +1,13 @@
+require 'rails'
+module ThinreportsRails
+  class Railtie < ::Rails::Railtie
+    initializer 'thinreports-rails' do
+      ::ActiveSupport.on_load(:action_view) do
+        ::Mime::Type.register('application/pdf', :pdf) unless ::Mime::Type.lookup_by_extension(:pdf)
+        require 'thinreports-rails/template_handler'
+      end
+    end
+  end
+end

data/lib/thinreports-rails/template_handler.rb ADDED Viewed

@@ -0,0 +1,73 @@
+# encoding: utf-8
+require 'delegate'
+require 'active_support/core_ext'
+require 'thinreports'
+module ThinreportsRails
+  class ThinreportsTemplate < SimpleDelegator
+    attr_accessor :_generate_options
+    def initialize(thinreports_report_base_obj, template_context, template_virtual_path)
+      @_template_context = template_context
+      @_template_virtual_path = template_virtual_path
+      super(thinreports_report_base_obj)
+    end
+    def partial!(options, locals = {})
+      case options
+      when Hash
+        options[:locals] ||= {}
+        options[:locals].merge!(:report => self)
+        @_template_context.render(options)
+      else
+        @_template_context.render(options, locals.merge(:report => self))
+      end
+    end
+    def search_tlf_path(virtual_path)
+      "#{virtual_path || @_template_virtual_path}.tlf"
+    end
+    def generate_options(options)
+      self._generate_options = options
+    end
+    def set_layout(options = {})
+      _options = options ? options.dup: {}
+      tlf_path = search_tlf_path(_options[:tlf])
+      ActionController::Base.view_paths.each do |view_path|
+        full_path = File.join(view_path.to_s, tlf_path)
+        if File.exist?(full_path)
+          return self.use_layout(full_path, *([_options[:layout_options]].compact))
+        end
+      end
+      raise("#{tlf_path} not found.")
+    end
+  end
+  class TemplateHandler
+    cattr_accessor :default_format
+    self.default_format = 'application/pdf'
+    def self.call(template)
+      %{
+        if defined?(report)
+          #{template.source}
+        else
+          generate_options = nil
+          ThinReports::Report.create do |__report__|
+            report = ThinreportsRails::ThinreportsTemplate.new(__report__, self, '#{template.virtual_path}')
+            #{template.source}
+            generate_options = report._generate_options
+          end.generate(*([generate_options].compact))
+        end
+      }
+    end
+  end
+end
+ActionView::Template.register_template_handler :thinreports, ThinreportsRails::TemplateHandler

data/lib/thinreports-rails/version.rb ADDED Viewed

@@ -0,0 +1,4 @@
+module ThinreportsRails
+  VERSION = "0.1.2"
+end

data/test/test_app/app/views/orders/_header.pdf.thinreports ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ report.start_new_page
2	+ report.page.values :printed_at => Time.at(OrdersController::CURRENT) # 2012-06-27 11:41:33 +0900

data/test/test_app/app/views/orders/_other_header.pdf.thinreports ADDED Viewed

@@ -0,0 +1,3 @@
+report.start_new_page
+report.page.values :printed_at => current_time

data/test/test_app/app/views/orders/index.pdf.thinreports ADDED Viewed

@@ -0,0 +1,8 @@
+report.set_layout
+report.partial! 'header'
+@orders.each do |order|
+  report.page.list(:list).add_row do |row|
+    row.item(:col1).value order.name
+    row.item(:col2).value order.num
+  end
+end

data/test/test_app/app/views/orders/index.tlf ADDED Viewed

@@ -0,0 +1 @@

+ {"version":"0.7.0","finger-print":1367137149,"config":{"title":"Japanese Paper","option":{},"page":{"paper-type":"A4","orientation":"portrait","margin-top":"20","margin-bottom":"20","margin-left":"20","margin-right":"20"}},"svg":"<svg width=\"595.2\" height=\"841.8\" xmlns=\"http://www.w3.org/2000/svg\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" preserveAspectRatio=\"none\" viewBox=\"0 0 595.2 841.8\"><g class=\"canvas\"><g class=\"s-text\" stroke-width=\"0\" fill=\"#000000\" fill-opacity=\"1\" kerning=\"auto\" x-display=\"true\" x-id=\"\" font-size=\"48\" font-family=\"IPAPMincho\" font-weight=\"normal\" font-style=\"normal\" text-anchor=\"middle\" text-decoration=\"none\" x-width=\"263\" x-height=\"52\" x-left=\"166.1\" x-top=\"20\"><rect class=\"s-text-box\" stroke=\"none\" fill=\"#000000\" fill-opacity=\"0.001\" width=\"263\" height=\"52\" x=\"166.1\" y=\"20\"></rect><text class=\"s-text-l0\" xml:space=\"preserve\" stroke=\"none\" fill=\"inherit\" fill-opacity=\"1\" text-decoration=\"none\" x=\"297.6\" y=\"62\">\u30c6\u30b9\u30c8\u6ce8\u6587\u66f8</text></g><line stroke=\\\"#000000\\\" stroke-width=\\\"1\\\" fill=\\\"none\\\" class=\\\"s-line\\\" x-display=\\\"true\\\" x-stroke-type=\\\"solid\\\" stroke-dasharray=\\\"none\\\" x-id=\\\"\\\" x1=\\\"67\\\" x2=\\\"622.2\\\" y1=\\\"235\\\" y2=\\\"235\\\"></line><line stroke=\\\"#000000\\\" stroke-width=\\\"1\\\" fill=\\\"none\\\" class=\\\"s-line\\\" x-display=\\\"true\\\" x-stroke-type=\\\"solid\\\" stroke-dasharray=\\\"none\\\" x-id=\\\"\\\" x1=\\\"622.2\\\" x2=\\\"622.2\\\" y1=\\\"250.1\\\" y2=\\\"249.1\\\"></line>\"},\"translate\":{\"x\":-47,\"y\":-30}},\"header\":{\"height\":7.4,\"svg\":{\"tag\":\"g\",\"content\":\"\"},\"translate\":{\"x\":-47,\"y\":-30}},\"header-enabled\":\"true\",\"svg\":{\"tag\":\"g\",\"attrs\":{}},\"content-height\":503.70000000000005,\"page-break\":\"true\"}SHAPE--><line stroke=\"#000000\" stroke-width=\"1\" fill=\"none\" class=\"s-line\" x-display=\"true\" x-stroke-type=\"solid\" stroke-dasharray=\"none\" x-id=\"\" x1=\"158.8\" x2=\"427.4\" y1=\"84\" y2=\"84\"></line></g></svg>"}

data/test/test_app/app/views/orders/no_tlf.pdf.thinreports ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ report.set_layout :tlf => 'orders/no_tlf'
2	+ report.partial! 'header'

data/test/test_app/app/views/orders/other_tlf_path.pdf.thinreports ADDED Viewed

@@ -0,0 +1,8 @@
+report.set_layout :tlf => 'reports/other'
+report.partial! 'other_header', :current_time => Time.at(OrdersController::CURRENT) # 2012-06-27 11:41:33 +0900
+@orders.each do |order|
+  report.page.list(:list).add_row do |row|
+    row.item(:col1).value order.name
+    row.item(:col2).value order.num
+  end
+end

data/test/test_app/app/views/reports/other.tlf ADDED Viewed

@@ -0,0 +1 @@

data/test/test_app/test_app.rb ADDED Viewed

@@ -0,0 +1,51 @@
+require 'action_controller/railtie'
+require 'action_view/railtie'
+module ThinreportsRailsTestApp
+  class Application < Rails::Application
+    config.active_support.deprecation = :log
+    config.root = File.dirname(__FILE__)
+  end
+end
+ThinreportsRailsTestApp::Application.initialize!
+# Route
+ThinreportsRailsTestApp::Application.routes.draw do
+  resources :orders, :only => [:index] do
+    collection do
+      get 'no_tlf'
+      get 'other_tlf_path'
+    end
+  end
+end
+# Model
+class Order
+  attr_accessor :name, :num
+  def initialize(name, num)
+    self.name = name
+    self.num  = num
+  end
+end
+# Controller
+class ApplicationController < ActionController::Base; end
+class OrdersController < ApplicationController
+  CURRENT = 1340764893 # 2012-06-27 11:41:33 +0900
+  def index
+    @orders = [Order.new('order1', 2),
+               Order.new('order2', 10)]
+    respond_to do |f|
+      f.pdf { render }
+    end
+  end
+  alias no_tlf index
+  alias other_tlf_path index
+end

data/test/thinreports-rails_test.rb ADDED Viewed

@@ -0,0 +1,30 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rubygems'
+require 'test/unit'
+require 'thinreports-rails'
+require 'test_app/test_app'
+require 'rails'
+require 'rails/test_help'
+class ThinReportsRailsTest < ActionController::TestCase
+  tests OrdersController
+  test 'index.tlf is selected.' do
+    get :index, :format => :pdf
+    assert_response :success
+  end
+  test 'other tlf can select.' do
+    get :other_tlf_path, :format => :pdf
+    assert_response :success
+  end
+  test 'tlf can not choose not. raise Exception.' do
+    assert_raise(ActionView::Template::Error) { get :no_tlf, :format => :pdf }
+  end
+end

data/thinreports-rails.gemspec ADDED Viewed

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/thinreports-rails/version', __FILE__)
+Gem::Specification.new do |gem|
+  gem.authors       = ["Takeshi Shinoda"]
+  gem.email         = ["takeshinoda@gmail.com"]
+  gem.description   = %q{Rails plugin for Thinreports DSL.}
+  gem.summary       = %q{Rails plugin for Thinreports DSL.}
+  gem.homepage      = "https://github.com/takeshinoda/thinreports-rails"
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "thinreports-rails"
+  gem.require_paths = ["lib"]
+  gem.version       = ThinreportsRails::VERSION
+  gem.add_dependency "thinreports", '~>0.7.0'
+end

metadata ADDED Viewed

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: thinreports-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+  prerelease:
+platform: ruby
+authors:
+- Takeshi Shinoda
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2012-07-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thinreports
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+description: Rails plugin for Thinreports DSL.
+email:
+- takeshinoda@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- lib/thinreports-rails.rb
+- lib/thinreports-rails/railtie.rb
+- lib/thinreports-rails/template_handler.rb
+- lib/thinreports-rails/version.rb
+- test/test_app/app/views/orders/_header.pdf.thinreports
+- test/test_app/app/views/orders/_other_header.pdf.thinreports
+- test/test_app/app/views/orders/index.pdf.thinreports
+- test/test_app/app/views/orders/index.tlf
+- test/test_app/app/views/orders/no_tlf.pdf.thinreports
+- test/test_app/app/views/orders/other_tlf_path.pdf.thinreports
+- test/test_app/app/views/reports/other.tlf
+- test/test_app/test_app.rb
+- test/thinreports-rails_test.rb
+- thinreports-rails.gemspec
+homepage: https://github.com/takeshinoda/thinreports-rails
+licenses: []
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 1.8.24
+signing_key:
+specification_version: 3
+summary: Rails plugin for Thinreports DSL.
+test_files:
+- test/test_app/app/views/orders/_header.pdf.thinreports
+- test/test_app/app/views/orders/_other_header.pdf.thinreports
+- test/test_app/app/views/orders/index.pdf.thinreports
+- test/test_app/app/views/orders/index.tlf
+- test/test_app/app/views/orders/no_tlf.pdf.thinreports
+- test/test_app/app/views/orders/other_tlf_path.pdf.thinreports
+- test/test_app/app/views/reports/other.tlf
+- test/test_app/test_app.rb
+- test/thinreports-rails_test.rb