obrientimothya-jasper-rails 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 27b2536c4d7b51fbabe8928203f7d833144e4adb
+  data.tar.gz: d011b05de9b966b9888abf06b79b9c01293d0653
+SHA512:
+  metadata.gz: a9af112add8c6d27712b0a58322d0815d135c97eae8a2d718a4a2b6e5bc34b4f4c518f2e6c6a822b184b781b06832ae67c2a6f9dbbeb8af844b5a1641066f3d7
+  data.tar.gz: 3197b86a0e15d3e35b78c51582d2f2043e213c6e8da043eb9fcc56ed3bb0e0ec747891f898a40f079823122f780204d121435b1e4b9b6395d60608bb79a9f6cb

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.DS_Store
+.project
+*.jasper

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+  gem 'rjb',           '>= 1.4.0'
+  
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+
+Copyright (C) 2012 Marlus Saraiva, Rodrigo Maia
+
+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

@@ -0,0 +1,136 @@
+# jasper-rails
+
+JasperReports/Rails integration using Rjb (Ruby Java Bridge)
+
+# News!
+- Updated to JasperReports 5.0.0
+- Global configuration (default report params)
+- Passing Java parameters directly
+
+## Dependencies
+
+You need a Java Virtual Machine installed and set up in order to use this gem.
+
+## Install
+
+```
+gem install jasper-rails
+```
+
+## Configure
+
+Add `jasper-rails` to your Gemfile:
+
+```ruby
+  gem "jasper-rails"
+```
+
+Note: If you're running your application on OS X, this is usually all you have to do. On Linux, you might have
+to set the JAVA_HOME. On Windows, good luck!
+
+For any issues related to the java/ruby integration, please check out: [http://rjb.rubyforge.org/](http://rjb.rubyforge.org/). You will find here plenty tips that might help you to solve your problem.
+
+## Using jasper-rails
+
+1) Tell your controller that it "responds to" :pdf and it "responds with" some list:
+
+Note: This list will become your datasource inside the report.
+
+```ruby
+  respond_to :html, :xml, :pdf
+
+  def index
+    @people = Person.all
+    respond_with @people
+  end
+```
+
+2) Create your jasper report source file using iReport or any compatible jasper tool.
+
+3) Set the "Query Text" and "The language for the dataset query" properties of your report.
+
+Note: If you're using iReport, you can find those properties in the "Properties panel".
+Don't forget to select the report root node in your "Report inspector".
+
+Example: If you have a list of people, you should have something like:
+* "Query Text" = /people/person
+* "The language for the dataset query" = xpath
+
+4) Design your report (add fields, groups, images, etc.)
+
+5) Save the report source file in your views folder (just like any other html view file):
+
+Example:
+
+* app/views/people/index.jrxml
+
+## Parameters
+
+```ruby
+  def index
+    @people = Person.all
+
+    # This variable will be available in your report!
+    @user = "John Doe"
+
+    respond_with @people
+  end
+```
+
+All you have to do now is to create, in iReport, a parameter called "user" (yes, without the "@") and drop it in your report!
+
+Limitation: By now, all parameters that aren't manually converted to Rjb java classes/instances are converted to java String. We intend to change this in the near future.
+
+## Passing Java parameters directly
+
+```ruby
+  title = (Rjb::import 'java.lang.String').new("The Beatles")
+  @parameter_that_is_a_java_class = (Rjb::import 'java.util.HashMap').new
+  @parameter_that_is_a_java_class.put("title", title)
+```
+
+For more information check out issue: [#13](https://github.com/fortesinformatica/jasper-rails/pull/13)
+
+## Global configuration
+
+You can change any default report param by setting JasperRails.config[:report_params], e.g., in your "config/application.rb" you might have something like:
+
+```ruby
+  config.after_initialize do
+    JasperRails.config[:report_params]["REPORT_LOCALE"] = JasperRails::Locale.new('pt', 'BR')
+  end
+```
+
+## RSpec integration
+Check out: [jasper-rails-rspec](http://github.com/fortesinformatica/jasper-rails-rspec).
+
+## DEMO
+For a running example, just clone: [jasper-rails-demo](http://github.com/fortesinformatica/jasper-rails-demo).
+
+## History
+This project was first developed at Grupo Fortes in 2011 and we have been using it in several projects since then.
+Pay attention that all the features it supports right now were based in those project's especific needs. Therefore you might find a lot of
+JasperResports' features that are not yet supported.
+
+## LICENSE
+
+Copyright (C) 2012 Marlus Saraiva, Rodrigo Maia
+
+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/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/config.ru

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.require :default, :development
+
+Combustion.initialize!
+run Combustion::Application

data/lib/jasper-rails.rb

@@ -0,0 +1,172 @@
+#
+# Copyright (C) 2012 Marlus Saraiva, Rodrigo Maia
+#
+# 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.
+
+require "jasper-rails/version"
+require "rails"
+require "rjb"
+require "action_controller/metal/responder"
+
+if Mime::Type.lookup_by_extension("pdf").nil?
+  Mime::Type.register "application/pdf", :pdf
+end
+
+module JasperRails
+
+  class << self
+    attr_accessor :config
+  end
+
+  module Jasper
+    module Rails
+      
+      def self.classpath
+        classpaths = '.'
+        Dir["#{File.dirname(__FILE__)}/java/*.jar"].each do |jar|
+          classpaths << File::PATH_SEPARATOR + File.expand_path(jar)
+        end
+
+        Dir["lib/*.jar"].each do |jar|
+          classpaths << File::PATH_SEPARATOR + File.expand_path(jar)
+        end
+        classpaths
+      end
+
+      def self.render_pdf(jasper_file, datasource, parameters, options)
+
+        if ENV['RAILS_ENV'] == 'development'
+          Rjb::load( classpath, ['-Djava.awt.headless=true', '-Djdbc.drivers=org.sqlite.JDBC','-Xms128M', '-Xmx256M'] ) unless Rjb::loaded?
+        end
+        if ENV['RAILS_ENV'] == 'production'
+          # Hack for Amazon Linux
+          #ENV['JAVA_HOME'] = "/usr/lib/jvm/java"
+          #ENV['LD_LIBRARY_PATH'] = "/usr/lib:/usr/lib/jvm/java/jre/lib/amd64:/usr/lib/jvm/java/jre/lib/amd64/server"
+          Rjb::load( classpath, ['-Djava.awt.headless=true', '-Djdbc.drivers=com.mysql.jdbc.Driver','-Xms128M', '-Xmx256M'] ) unless Rjb::loaded?
+        end
+
+
+        # The code below is to workaround declaring constants within methods
+        # We would like to delay these till a request is received to workaround Apache Passenger issue
+        locale                      = Rjb::import 'java.util.Locale'
+        jRException                 = Rjb::import 'net.sf.jasperreports.engine.JRException'
+        jasperCompileManager        = Rjb::import 'net.sf.jasperreports.engine.JasperCompileManager'
+        jasperExportManager         = Rjb::import 'net.sf.jasperreports.engine.JasperExportManager'
+        jasperFillManager           = Rjb::import 'net.sf.jasperreports.engine.JasperFillManager'
+        jasperPrint                 = Rjb::import 'net.sf.jasperreports.engine.JasperPrint'
+        jRXmlUtils                  = Rjb::import 'net.sf.jasperreports.engine.util.JRXmlUtils'
+        jREmptyDataSource           = Rjb::import 'net.sf.jasperreports.engine.JREmptyDataSource'
+        jRXPathQueryExecuterFactory = silence_warnings{Rjb::import 'net.sf.jasperreports.engine.query.JRXPathQueryExecuterFactory'}
+        inputSource                 = Rjb::import 'org.xml.sax.InputSource'
+        stringReader                = Rjb::import 'java.io.StringReader'
+        hashMap                     = Rjb::import 'java.util.HashMap'
+        byteArrayInputStream        = Rjb::import 'java.io.ByteArrayInputStream'
+        javaString                  = Rjb::import 'java.lang.String'
+        jFreeChart                  = Rjb::import 'org.jfree.chart.JFreeChart'
+        javaSystem                  = Rjb::import 'java.lang.System'
+        driverManager               = Rjb::import 'java.sql.DriverManager'
+        sqlException                = Rjb::import 'java.sql.SQLException'
+        if ENV['RAILS_ENV'] == 'development'
+          connection                = driverManager.getConnection("jdbc:sqlite:/Users/obrientimothya/Dropbox/development/vle/db/development.sqlite3")
+        end
+        if ENV['RAILS_ENV'] == 'production'
+          connection                = driverManager.getConnection("jdbc:mysql://#{ENV['RDS_HOSTNAME']}:#{ENV['RDS_PORT']}/#{ENV['RDS_DB_NAME']}", ENV['RDS_USERNAME'], ENV['RDS_PASSWORD'])
+        end
+
+
+        options ||= {}
+        parameters ||= {}
+        jrxml_file  = jasper_file.sub(/\.jasper$/, ".jrxml")
+
+        begin
+
+          # Default report params
+          config = {
+            :report_params=>{
+              "REPORT_LOCALE"    => locale.new('en', 'US'),
+              "XML_LOCALE"       => locale.new('en', 'US'),
+              "XML_DATE_PATTERN" => 'yyyy-MM-dd'
+            }
+          }
+
+          # Converting default report params to java HashMap
+          jasper_params = hashMap.new
+          config[:report_params].each do |k,v|
+            jasper_params.put(k, v)
+          end
+
+          # Convert the ruby parameters' hash to a java HashMap, but keeps it as
+          # default when they already represent a JRB entity.
+          # Pay attention that, for now, all other parameters are converted to string!
+          parameters.each do |key, value|
+            jasper_params.put(javaString.new(key.to_s), parameter_value_of(value))
+          end
+
+          # Compile it, if needed
+          if !File.exist?(jasper_file) || (File.exist?(jrxml_file) && File.mtime(jrxml_file) > File.mtime(jasper_file))
+            jasperCompileManager.compileReportToFile(jrxml_file, jasper_file)
+          end
+
+          jasper_print = jasperFillManager.fillReport(jasper_file, jasper_params, connection)
+          # Export it!
+          jasperExportManager._invoke('exportReportToPdf', 'Lnet.sf.jasperreports.engine.JasperPrint;', jasper_print)
+        rescue Exception=>e
+          if e.respond_to? 'printStackTrace'
+            ::Rails.logger.error e.message
+            e.printStackTrace
+          else
+            ::Rails.logger.error e.message + "\n " + e.backtrace.join("\n ")
+          end
+          raise e
+        end
+      end
+
+      # Returns the value without conversion when it's converted to Java Types.
+      # When isn't a Rjb class, returns a Java String of it.
+      def self.parameter_value_of(param)
+        javaString                  = Rjb::import 'java.lang.String'
+        # Using Rjb::import('java.util.HashMap').new, it returns an instance of
+        # Rjb::Rjb_JavaProxy, so the Rjb_JavaProxy parent is the Rjb module itself.
+        if param.class.parent == Rjb
+          param
+        else
+          javaString.new(param.to_s)
+        end
+      end
+    end
+  end
+
+  class ActionController::Responder
+    def to_pdf
+      #jasper_file = "#{Rails.root.to_s}/app/views/#{controller.controller_path}/#{controller.action_name}.jasper"
+      jasper_file =  (@options[:template] && "#{Rails.root.to_s}/app/views/#{controller.controller_path}/#{@options[:template]}") ||
+          "#{Rails.root.to_s}/app/views/#{controller.controller_path}/#{controller.action_name}.jasper"
+
+      params = {}
+      controller.instance_variables.each do |v|
+        params[v.to_s[1..-1]] = controller.instance_variable_get(v)
+      end
+
+      #controller.send_data Jasper::Rails::render_pdf(jasper_file, resource, params, options), :type => Mime::PDF
+      controller.send_data Jasper::Rails::render_pdf(jasper_file, resource, params, options), :type => Mime::PDF, :disposition => 'inline'
+    end
+  end
+
+end

data/lib/jasper-rails/version.rb

@@ -0,0 +1,4 @@
+# -*- encoding: utf-8 -*-
+module JasperRails
+  VERSION = "0.0.1"
+end

data/obrientimothya-jasper-rails.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "jasper-rails/version"
+
+Gem::Specification.new do |s|
+  s.name        = "obrientimothya-jasper-rails"
+  s.version     = JasperRails::VERSION
+  s.authors     = ["Marlus Saraiva", "Rodrigo Maia", "Timothy OBrien"]
+  s.summary     = %q{Custom Rails-Jaspersoft Tool}
+  s.description = %q{A FORK of the fortesinformatica/jasper-rails project for a particular project. NOT intended for wide use.}
+  s.email       = "obrien.timothy.a@gmail.com"
+  s.homepage    = "https://github.com/obrientimothya/jasper-rails"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency('rjb', '1.4.3')
+  s.add_development_dependency 'combustion', '~> 0.3.2'
+  s.add_development_dependency "rspec-rails"
+  s.add_development_dependency "jasper-rails-rspec"
+end

data/spec/controllers/people_controller_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+
+describe PeopleController do
+
+	describe "GET index" do
+    before do
+      Person.stub(:all).and_return([
+        Person.new(:name=>'john'  , :email=>'lennon@beatles.com'),
+        Person.new(:name=>'george', :email=>'harrison@beatles.com')
+      ])
+    end
+
+    it "should respond success" do
+      get :index, :format => :pdf
+
+      response.should be_success
+    end
+
+    it "should not contain nulls" do
+      get :index, :format => :pdf
+
+      response.should_not contain("null")
+    end
+
+    it "should show all fields in the report" do
+      get :index, :format => :pdf
+
+      response.should contain("john")
+      response.should contain("lennon@beatles.com")
+      response.should contain("george")
+      response.should contain("harrison@beatles.com")
+    end
+
+    it "should clip the text if it's larger than the Text Field" do
+      Person.stub(:all).and_return([
+        Person.new(:name=>'jonh'  , :email=>'a_very_long_text_that_is_larger_than_the_text_field_in_the_report')
+      ])
+
+      get :index, :format => :pdf
+
+      response.should_not contain("a_very_long_text_that_is_larger_than_the_text_field_in_the_report")
+      response.should contain("a_very_long_text_that_is_larger_than_the_text_field_in_the_")
+    end
+
+    it "should show the parameters defined in the controller" do
+      get :index, :format => :pdf
+
+      response.should contain("I'm a parameter. I was defined in the controller")
+    end
+
+	end
+
+  describe "GET compile_time_error_report" do
+
+    it "should raise a RuntimeError if the report's design is not valid" do
+      expect { get :compile_time_error_report, :format => :pdf }.to raise_error(RuntimeError, /Report design not valid/)
+    end
+
+  end
+
+  describe "GET runtime_error_report" do
+
+    it "should raise a RuntimeError if the report could not be filled due to a runtime error" do
+      expect { get :runtime_error_report, :format => :pdf }.to raise_error(RuntimeError)
+    end
+
+  end
+
+  describe "GET nil_datasource" do
+
+    it "should treat nil datasources" do
+      get :nil_datasource, :format => :pdf
+
+      response.should contain("I'm a parameter. I was defined in the controller")
+    end
+
+  end
+
+  describe "GET java_parameter" do
+
+    it "accepts java parameter without converting it to string" do
+      get :java_parameter, :format => :pdf
+
+      response.should contain("The Beatles")
+    end
+
+  end
+
+end