ruport 1.7.1 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 636885e1621e78e27ce9148ddbb546346af876f3
-  data.tar.gz: 71811d3ae2c717ad82b1084a03fb8cc91c559add
+SHA256:
+  metadata.gz: b8b980ae054fa6d3d42e224431277d3deb471aa2e7132ea144bdb63bff3b3642
+  data.tar.gz: 9b5784e616ce0cbce9e218995cb7c3b36eb625cc18a75eea8642092713a391c4
 SHA512:
-  metadata.gz: bf3d70cf7c384439b4584f0d4c6b4f3665753dd343fd35a0b300652be74e4fc92c247c10e706e5ce44e2d437f3fa70ac24ee7500dc22fcd7465c67a52f81ddba
-  data.tar.gz: 0231ae8d2a78ef511f3429c1159974ba6d07361545c77db0839dcf3d923281607b35f14d768e939f26295e54dc5f04cae831f13ae0e7b43bd6c04e6628377f8d
+  metadata.gz: 5ecded8ff524e85d5c9a5bb6312b7bb50cdd5fa0f74540059c4c41c50d9b4cd3c679d6c176dc0a19564eca53590b77374ef00fe2a9afd9a742f0e35b0b88c79c
+  data.tar.gz: 5045f9a47bee0f414ff26222784ce782f2d01329f7f8448196ba6c91974e160fdfcb1d9fdc95318db4246fc67f0f16804e1a965b2856758bc66431b5c17502c9

data/CHANGELOG.md

@@ -0,0 +1,38 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased] - undecided
+
+## [1.8.0] - 2022-09-20
+
+### Added
+
+- Markdown formatter [#54](https://github.com/ruport/ruport/pull/54)
+- Ruby 3.0 support
+
+### Changed
+
+- Reduced allocations to improve performance [#34](https://github.com/ruport/ruport/pull/34)
+- Update Prawn version to 2.4.0 [#44](https://github.com/ruport/ruport/pull/44) [#57](https://github.com/ruport/ruport/pull/57) [#64](https://github.com/ruport/ruport/pull/64)
+
+## [1.7.1] - 2017-05-02
+
+### Changed
+
+- Improved errors when missing gems.
+- Added ruby 1.9 support
+- Removed dependency on `fastercsv` gem
+
+## [1.7.0] - 2011-01-06
+
+## [1.6.3] - 2009-12-12
+
+
+[Unreleased]: https://github.com/ruport/ruport/compare/v1.8.0...HEAD
+[1.8.0]: https://github.com/ruport/ruport/compare/v1.7.1...v1.8.0
+[1.7.1]: https://github.com/ruport/ruport/compare/v1.7.0...v1.7.1
+[1.7.0]: https://github.com/ruport/ruport/compare/v1.6.3...v1.7.0
+[1.6.3]: https://github.com/ruport/ruport/compare/v1.6.2...v1.6.3

data/HACKING

@@ -23,23 +23,7 @@ contributions to our project.  Here are a few different ways you can help.
 If any of these things sound appealing to you, there are a few things
 you should do:
 
-1) Sign up on the mailing list: http://list.rubyreports.org/
-
-2) Post and introduce yourself, letting us know what you'd like to work on OR
-   Find sandal or mikem836 on #ruport
-
-3) Please read the MakingChangeRequests, ReportingDefects, and
-   SubmittingPatches Trac wiki pages, as appropriate.
-
-   - http://stonecode.svnrepository.com/ruport/trac.cgi/wiki/MakingChangeRequests
-
-   - http://stonecode.svnrepository.com/ruport/trac.cgi/wiki/ReportingDefects
-
-   - http://stonecode.svnrepository.com/ruport/trac.cgi/wiki/SubmittingPatches
-
-4) Please pull the latest code from SVN trunk:
-   http://stonecode.svnrepository.com/svn/ruport/ruport/trunk
-
+1) Head over to https://github.com/ruport/ruport
 
 This should hopefully be enough to get you on the right track.  We welcome your
 questions and ideas, so don't be afraid to contact us.

data/{README.rdoc → README.md}

@@ -1,4 +1,7 @@
-= What Ruport Is
+[![Build Status][BS img]](https://travis-ci.org/ruport/ruport)
+[![Coverage Status][CS img]](https://coveralls.io/r/ruport/ruport)
+
+## What Ruport Is
 
 Ruby Reports (Ruport) is an extensible reporting system.
 
@@ -20,9 +23,9 @@ of helper functions that will let you build complex reports while maintaining
 a DRY and consistent interface.
 
 To get a quick feel for what you can accomplish with Ruport, take a look at
-a few simple examples provided on our web site.
+a few simple examples provided on our web site:
 
-http://ruport.github.io/examples.html
+https://ruport.github.io/examples.html
 
 Since Ruport's core support is intentionally minimalistic, you may be looking
 for some higher level support for specific needs such as graphing, invoices,
@@ -30,71 +33,57 @@ report mailing support, etc.  For this, you may wish to take a look at the
 ruport-util package, which contains some generally useful tools and libraries
 to extend Ruport's capabilities.
 
-= Installation
+## Installation
 
 To install ruport via rubygems:
 
-  sudo gem install ruport
+```sh
+$ sudo gem install ruport
+```
 
 Check to see if it installed properly:
 
-  ruby -rubygems -e "require 'ruport'; puts Ruport::VERSION"
+```sh
+$ ruby -e "require 'ruport'; puts Ruport::VERSION"
+```
 
 If you get an error, please let us know on our mailing list.
 
-=== Dependencies
+### Dependencies
 
-==== Formatting
+#### Formatting
 
 Ruport relies on PDF::Writer for its formatting support.
 If you want to make use of textile helpers, you'll also need RedCloth.
 
-==== Database interaction
+#### Database interaction
 
-If you wish to use Ruport to report against a rails project,
-a camping project, or do standalone acts_as_reportable reports, you'll need
-ActiveRecord and the acts_as_reportable gem.
+If you wish to use Ruport to report against a Rails project, you'll need
+ActiveRecord and the `acts_as_reportable` gem.
 
 If you want to use Ruport::Query for raw SQL support, you'll need to
-install ruport-util, RubyDBI and whatever database drivers you might need.
+install `ruport-util`, `RubyDBI` and whatever database drivers you might
+need.
 
-= Resources
+## Resources
 
 Our developers have published a free-content book about all things
 Ruport, including complete coverage of acts_as_reportable and some of
 ruport-util's features.  This book serves as the definitive guide to
 Ruport, so all users should become acquainted with it:
 
-  http://ruport.github.io
-
-The next best way to get help and make suggestions is the Ruport mailing list.
-This software is on the move, so the list is the most reliable way of getting
-up to date information.
-
--  You can sign up and/or view the archives here:
-   http://groups.google.com/group/ruby-reports
+https://ruport.github.io
 
 If you are looking to dig a little deeper, there are a couple more resources
 that may be helpful to you.
 
--  The latest stable API documentation is available at:
-   http://rubydoc.info/gems/ruport/frames
-
--  Our issues tracker is at http://github.com/ruport/ruport/issues
+- The latest stable API documentation is available at: http://rubydoc.info/gems/ruport/frames
+- The code repository is on GitHub: https://github.com/ruport/ruport
+- Our issues tracker is at https://github.com/ruport/ruport/issues
 
-= Hacking
+## Hacking
 
-If you'd like to contribute code to Ruport, please join our development
-mailing list, and let us know what you'd like to do!
-
-http://groups.google.com/group/ruport-dev
-
-The main Git repository is on GitHub:
-http://github.com/ruport/ruport
-
-It also may be worthwhile to join this list if you plan on running edge
-versions of Ruport, as this is where we make announcements about major
-breakage in trunk.
+If you'd like to contribute code to Ruport, fork the repository and open a PR!
 
 We are very responsive to contributors, and review every patch we receive
 fairly quickly.  Most contributors who successfully get a patch or two applied
@@ -103,3 +92,6 @@ development team.  Since we view every user as potential contributor, this
 approach works well for us.
 
 So if you want to help out with Ruport, we'll happy accept your efforts!
+
+[BS img]: https://travis-ci.org/ruport/ruport.svg?branch=master
+[CS img]: https://coveralls.io/repos/ruport/ruport/badge.png?branch=master

data/Rakefile

@@ -1,7 +1,6 @@
 require "rubygems"
 require "bundler/setup"
 
-require "rdoc/task"
 require "rake/testtask"
 require 'bundler/gem_tasks'
 
@@ -17,15 +16,6 @@ Rake::TestTask.new do |test|
   test.verbose = true
 end
 
-RDoc::Task.new do |rdoc|
-  rdoc.rdoc_files.include( "README.rdoc",
-                           "AUTHORS", "COPYING",
-                           "LICENSE", "lib/" )
-  rdoc.main     = "README.rdoc"
-  rdoc.rdoc_dir = "doc/html"
-  rdoc.title    = "Ruport Documentation"
-end
-
 task :run_benchmarks do
   files = FileList["util/bench/**/**/*.rb"]
   files.sort!

data/examples/row_renderer.rb

@@ -6,7 +6,7 @@ class CSV2Something < Ruport::Controller
 
   module Helpers
     def table_feeder
-      Table(options.csv_file,:has_names => false) { |t,r| yield(r) }
+      Table(options.csv_file,:has_names => false) { |_t,r| yield(r) }
     end
   end
 

data/examples/simple_pdf_lines.rb

@@ -18,7 +18,7 @@ class PDFLines < Ruport::Formatter::PDF
 end
 
 # generate 35 random lines
-data = (0..34).inject([]) { |s,r|
+data = (0..34).inject([]) { |s,_r|
   s << [rand(100),100+rand(400)]
 }
 

data/examples/trac_ticket_status.rb

@@ -41,7 +41,7 @@ class TracSummaryReport
     Grouping(table,:by => :date)
   end
 
-  def renderable_data(format)
+  def renderable_data(_format)
     summary = feed_data.summary :date,
       :opened => lambda { |g| g.sigma { |r| r.opened  } },
       :closed => lambda { |g| g.sigma { |r| r.closed  } },

data/lib/ruport/controller.rb

@@ -216,7 +216,7 @@ class Ruport::Controller
     def built_in_formats
      { :html => Ruport::Formatter::HTML,
        :csv  => Ruport::Formatter::CSV,
-       :pdf  => Ruport::Formatter::PDF,
+       :pdf  => Ruport::Formatter::PrawnPDF,
        :prawn_pdf => Ruport::Formatter::PrawnPDF,
        :text => Ruport::Formatter::Text }
     end

data/lib/ruport/data/grouping.rb

@@ -99,7 +99,7 @@ module Ruport::Data
       if @subgroups.empty?
         @subgroups = grouped_data(group_column)
       else
-        @subgroups.each {|name,group|
+        @subgroups.each {|_name,group|
           group.send(:create_subgroups, group_column)
         }
       end
@@ -172,7 +172,7 @@ module Ruport::Data
         cols = Array(options[:by]).dup
         @data = data.to_group.send(:grouped_data, cols.shift)
         cols.each do |col|
-          @data.each do |name,group|
+          @data.each do |_name,group|
             group.send(:create_subgroups, col)
           end
         end    
@@ -200,9 +200,9 @@ module Ruport::Data
     #
     def each 
       if @order.respond_to?(:call) 
-        @data.sort_by { |n,g| @order[g] }.each { |n,g| yield(n,g) }
+        @data.sort_by { |_n,g| @order[g] }.each { |n,g| yield(n,g) }
       elsif @order == :name
-        @data.sort_by { |n,g| n }.each { |name,group| yield(name,group) } 
+        @data.sort_by { |n,_g| n }.each { |name,group| yield(name,group) }
       else
         @data.each { |name,group| yield(name,group) }
       end
@@ -216,7 +216,7 @@ module Ruport::Data
     #   by_size = grouping.sort_grouping_by { |g| g.size }
     def sort_grouping_by(type=nil,&block)
       a = Grouping.new(:by => @grouped_by, :order => type || block)
-      each { |n,g| a << g }
+      each { |_n,g| a << g }
       return a
     end
                                                           
@@ -285,7 +285,7 @@ module Ruport::Data
       else 
         cols = procs.keys + [field]   
       end
-      expected = Table.new(:column_names => cols) { |t|
+      Table.new(:column_names => cols) { |t|
         each do |name,group|
           t << procs.inject({field => name}) do |s,r|
             s.merge(r[0] => r[1].call(group))
@@ -327,7 +327,7 @@ module Ruport::Data
     #   grouping.sigma { |r| r.col2 + 1 } #=> 15
     #
     def sigma(column=nil)
-      inject(0) do |s, (group_name, group)|
+      inject(0) do |s, (_group_name, group)|
         if column
           s + group.sigma(column)
         else

data/lib/ruport/data/record.rb

@@ -55,10 +55,10 @@ module Ruport::Data
       case(data)
       when Array
         @attributes = options[:attributes] || (0...data.length).to_a
-        @data = @attributes.inject({}) { |h,a| h.merge(a => data.shift) }
+        @data = @attributes.each_with_object({}) { |a, h| h[a.freeze] = data.shift }
       when Hash
-        @data = data.dup
-        @attributes = options[:attributes] || data.keys
+        @data = data
+        @attributes = options[:attributes] || @data.keys
       end
     end        
     
@@ -140,7 +140,7 @@ module Ruport::Data
       case name
       when String,Symbol
         self[name] || send(name)
-      when Fixnum
+      when Integer
         self[name]
       else
         raise ArgumentError, "Whatchu Talkin' Bout, Willis?"

data/lib/ruport/data/table.rb

@@ -50,7 +50,7 @@ module Ruport::Data
         ordering = self.class.row_order_to_group_order(@pivot_order)
         pivot_column_grouping.sort_grouping_by!(ordering) if ordering
 
-        @row = pivot_column_grouping.map { |name,grouping| name }
+        @row = pivot_column_grouping.map { |name,_grouping| name }
       end
 
       # Column in the first column in the pivoted table (without the group column)
@@ -71,10 +71,10 @@ module Ruport::Data
       end
 
       def values
-        @values ||= Hash.new do |values, column_entry|
+        @values ||= Hash.new do |row_values, column_entry|
           rows_group = rows_groups[column_entry]
 
-          values[column_entry] =
+          row_values[column_entry] =
             row.inject({}) do |values, row_entry|
               matching_rows = rows_group.rows_with(@pivot_column => row_entry)
               values[row_entry] = perform_operation(matching_rows)
@@ -132,7 +132,7 @@ module Ruport::Data
           rows && rows.inject(0) { |sum,row| sum+row[summary_column] }
         end
 
-        def count(rows, summary_column)
+        def count(rows, _summary_column)
           rows && rows.length
         end
 
@@ -259,7 +259,7 @@ module Ruport::Data
         table = self.new(options) do |feeder|
           first_line = true
 
-          ::CSV.send(msg,param,options[:csv_options]) do |row|
+          ::CSV.send(msg,param, **options[:csv_options]) do |row|
             if first_line
               adjust_for_headers(feeder.data,row,options)
               first_line = false
@@ -560,8 +560,8 @@ module Ruport::Data
     #   data.add_columns ['new_column_1','new_column_2'], :default => 1
     #
     def add_columns(names,options={})
-      raise "Greg isn't smart enough to figure this out.\n"+
-            "Send ideas in at http://list.rubyreports.org" if block_given?
+      raise "Greg isn't smart enough to figure this out.\n" \
+            "Send ideas in at github" if block_given?
       need_reverse = !!(options[:after] || options[:position])
       names = names.reverse if need_reverse
       names.each { |n| add_column(n,options) }
@@ -576,7 +576,7 @@ module Ruport::Data
     #    table.remove_column("apple") #=> removes column named apple
     #
     def remove_column(col)
-      col = column_names[col] if col.kind_of? Fixnum
+      col = column_names[col] if col.kind_of? Integer
       column_names.delete(col)
       each { |r| r.send(:delete,col) }
     end
@@ -666,7 +666,7 @@ module Ruport::Data
     #       +-----------+
     #
     def swap_column(a,b)
-      if [a,b].all? { |r| r.kind_of? Fixnum }
+      if [a,b].all? { |r| r.kind_of? Integer }
        col_a,col_b = column_names[a],column_names[b]
        column_names[a] = col_b
        column_names[b] = col_a

data/lib/ruport/formatter/csv.rb

@@ -55,7 +55,7 @@ module Ruport
     #
     def csv_writer
       @csv_writer ||= options.formatter ||
-        ::CSV.instance(output, options.format_options || {})
+        ::CSV.instance(output, **(options.format_options || {}))
     end
 
     # Generates table header by turning column_names into a CSV row.

data/lib/ruport/formatter/markdown.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module Ruport
+  # This class produces Markdown table output from Ruport::Table data.
+  #
+  # === Rendering Options
+  # <tt>:alignment:</tt> Default alignment for all columns.
+  # Allowed values are :left, :center and :right. Default is :left.
+  #
+  # <tt>:column_alignments:</tt> Alignments for specific columns.
+  # You can configure alignments by using
+  # Hash (key: column name, value: alignment)
+  class Formatter::MarkDown < Formatter
+    renders :markdown, for: [Controller::Table]
+
+    # Hook for setting available options using a template.
+    def apply_template
+      apply_table_format_template(template.table)
+    end
+
+    # Uses the column names from the given Data::Table to generate
+    # a table header.
+    # If no column names are given, first row will be
+    # treated as table header.
+    def build_table_header
+      names = column_names(data)
+      build_md_row(output, names)
+      build_md_row(output, alignment_strings(names))
+    end
+
+    # Generates body of Markdown table data.
+    # Following characters will be replaced as escape.
+    #
+    # * | -> &#124;
+    # * newline code(\\n) -> \<br>
+    def build_table_body
+      body =
+        if data.column_names && !data.column_names.empty?
+          data
+        else
+          data[1..-1]
+        end
+      body.each { |row| build_md_row(output, row) }
+    end
+
+    private
+
+    def column_names(data)
+      if data.column_names && !data.column_names.empty?
+        data.column_names
+      else
+        data[0]
+      end
+    end
+
+    def build_md_row(output, row)
+      output << "|"
+      output << row.to_a.map { |cell| escape(cell.to_s.dup) }.join('|')
+      output << "|\n"
+    end
+
+    def escape(cell)
+      cell.gsub!("|", "&#124;")
+      cell.gsub!("\n", "<br>")
+      cell
+    end
+
+    def alignment_strings(column_names)
+      column_names.map(&method(:alignment_string))
+    end
+
+    def alignment_string(column_name)
+      case column_alignment(column_name)
+      when :right
+        "--:"
+      when :center
+        ":-:"
+      else
+        ":--"
+      end
+    end
+
+    def column_alignment(column_name)
+      if options.column_alignments && options.column_alignments.key?(column_name)
+        options.column_alignments[column_name]
+      elsif options.alignment
+        options.alignment
+      else
+        :left
+      end
+    end
+
+    def apply_table_format_template(template)
+      template = (template || {}).merge(options.table_format || {})
+      options.alignment ||= template[:alignment]
+      options.column_alignments =
+        merget_column_alignments(options, template)
+    end
+
+    def merget_column_alignments(options, template)
+      (template[:column_alignments] || {})
+        .merge(options.column_alignments || {})
+    end
+  end
+end

data/lib/ruport/formatter/prawn_pdf.rb

@@ -4,7 +4,7 @@ module Ruport
     renders :prawn_pdf, :for =>[Controller::Row, Controller::Table,
                               Controller::Group, Controller::Grouping]
 
-    attr_accessor :pdf
+    attr_writer :pdf
 
     def method_missing(id,*args, &block)
       pdf.send(id,*args, &block)
@@ -12,7 +12,7 @@ module Ruport
 
     def initialize
       require 'prawn'
-      require 'prawn/layout'
+      require 'prawn/table'
     end
 
     def pdf
@@ -20,7 +20,7 @@ module Ruport
         ::Prawn::Document.new(options[:pdf_format] || {} ))
     end
 
-    def draw_table(table, format_opts={})
+    def draw_table(table, format_opts={}, &block)
       m = "PDF Formatter requires column_names to be defined"
       raise FormatterError, m if table.column_names.empty?
 
@@ -33,10 +33,10 @@ module Ruport
       if options[:table_format]
         opt = options[:table_format] 
       else
-        opt = {}
+        opt = format_opts
       end
 
-      pdf.table(table_array,opt)
+      pdf.table(table_array, opt, &block)
 
     end
 
@@ -48,15 +48,15 @@ module Ruport
       output << pdf.render
     end
 
-    def build_table_body
-      draw_table(data)
+    def build_table_body(&block)
+      draw_table(data, &block)
     end
 
     def build_group_body
       render_table data, options.to_hash.merge(:formatter => pdf)
     end
 
-    def build_grouping_body
+    def build_grouping_body(&block)
       data.each do |name,group|
 
         # Group heading
@@ -65,8 +65,95 @@ module Ruport
 
         # Table
         move_down(10)
-        draw_table group
+        draw_table group, &block
       end
     end
+
+    # Hook for setting available options using a template. See the template
+    # documentation for the available options and their format.
+    def apply_template
+      apply_page_format_template(template.page)
+      apply_text_format_template(template.text)
+      apply_table_format_template(template.table)
+      apply_column_format_template(template.column)
+      apply_heading_format_template(template.heading)
+      apply_grouping_format_template(template.grouping)
+    end
+
+    private
+
+    def apply_page_format_template(t)
+      options.pdf_format ||= {}
+      t = (t || {}).merge(options.page_format || {})
+      options.pdf_format[:page_size] ||= t[:size]
+      options.pdf_format[:page_layout] ||= t[:layout]
+    end
+
+    def apply_text_format_template(t)
+      t = (t || {}).merge(options.text_format || {})
+      options.text_format = t unless t.empty?
+    end
+
+    def apply_table_format_template(t)
+      t = (t || {}).merge(options.table_format || {})
+      options.table_format = t unless t.empty?
+    end
+
+    def apply_column_format_template(t)
+      t = (t || {}).merge(options.column_format || {})
+      column_opts = {}
+      column_opts.merge!(:justification => t[:alignment]) if t[:alignment]
+      column_opts.merge!(:width => t[:width]) if t[:width]
+      unless column_opts.empty?
+        if options.table_format
+          if options.table_format[:column_options]
+            options.table_format[:column_options] =
+              column_opts.merge(options.table_format[:column_options])
+          else
+            options.table_format.merge!(:column_options => column_opts)
+          end
+        else
+          options.table_format = { :column_options => column_opts }
+        end
+      end
+    end
+
+    def apply_heading_format_template(t)
+      t = (t || {}).merge(options.heading_format || {})
+      heading_opts = {}
+      heading_opts.merge!(:justification => t[:alignment]) if t[:alignment]
+      heading_opts.merge!(:bold => t[:bold]) unless t[:bold].nil?
+      heading_opts.merge!(:title => t[:title]) if t[:title]
+      unless heading_opts.empty?
+        if options.table_format
+          if options.table_format[:column_options]
+            if options.table_format[:column_options][:heading]
+              options.table_format[:column_options][:heading] =
+                heading_opts.merge(
+                  options.table_format[:column_options][:heading]
+                )
+            else
+              options.table_format[:column_options].merge!(
+                :heading => heading_opts
+              )
+            end
+          else
+            options.table_format.merge!(
+              :column_options => { :heading => heading_opts }
+            )
+          end
+        else
+          options.table_format = {
+            :column_options => { :heading => heading_opts }
+          }
+        end
+      end
+    end
+
+    def apply_grouping_format_template(t)
+      t = (t || {}).merge(options.grouping_format || {})
+      options.style ||= t[:style]
+    end
+
   end
 end