Ruby::Reports

This gem was written for report automation provided by DSL. See Usage for details

Installation

Add this line to your application's Gemfile:

gem 'ruby-reports'

And then execute:

$ bundle

Or install it yourself as:

$ gem install ruby-reports

Usage

Main concept is following:

• You have report class where you define attributes, column names and mapped to them keys from source data
• Report has query method. It defines what object will serve data querying from any source
• (Optional) Report has formatter method. It defines what object will serve cell value formatting

Example:

  class MyNiceReport < Ruby::Reports::CsvReport
    config(
      source: :fetch_data,
      expire_in: 15 * 60,
      storage: Ruby::Reports::Storages::HASH,
      encoding: Ruby::Reports::CP1251,
      directory: File.join('home', 'nice_reports')
    )

    table do
      column 'ID', :id
      column 'User Name', :username
      column 'Email', :email, formatter: :mail_to_link
      column 'Last Seen', :last_seen_date, formatter: :date
    end

    def formatter
      @formatter ||= Formatter.new
    end

    def query
      @query ||= Query.new
    end

    class Formatter
      def mail_to_link(email)
        "mailto:#{email}"
      end

      def date(date)
        Date.parse(date).strftime('%d.%m.%Y')
      end
    end

    class Query
      def fetch_data
        [
          {id: 1, username: 'user#1', email: 'user1@reports.org', last_seen_date: '2015/06/06'},
          {id: 2, username: 'user#2', email: 'user2@reports.org', last_seen_date: '2015/02/07'},
          {id: 3, username: 'user#3', email: 'user3@reports.org', last_seen_date: '2015/08/13'}
        ]
      end
    end
  end

  > report = MyNiceReport.build
  # => #<MyNiceReport:0x00000002171a68 ...>
  > report.ready?
  # => true
  > report.filename
  # => '/home/my_home/nice_reports/asdvdsadvasdv.csv'
  > IO.read(report.filename)
  # => "ID;User Name;Email;Last Seen\r\n1;user#1;mailto:user1@reports.org;06.06.2015\r\n
  # 2;user#2;mailto:user2@reports.org;07.02.2015\r\n3;user#3;mailto:user3@reports.org;13.08.2015\r\n"

Advanced Usage

Here comes example of creating report with dynamicaly defined columns list:

  class MyDynamicCsvReport < Ruby::Reports::CsvReport
    config(
      source: :select_data,
      storage: Ruby::Reports::Storages::HASH,
      encoding: 'utf-8',
      csv_options: {col_sep: ',', row_sep: "\n"},
      directory: File.join(Dir.home, '.ruby-reports')
    )

    table do |row|
      column 'First one', decorate_first(row[:first])
      column 'Second', "#{row[:second]} - is second"
      columns_list.each do |col|
        column col.to_s, col.to_sym
      end
    end

    class << self
      attr_accessor :columns_list

      def decorate_first(element)
        "decorated: #{element}"
      end
    end

    attr_reader :main_param
    def initialize(param, cols = nil)
      super
      self.class.columns_list = cols || [:third]
      @main_param = param
    end

    def query
      @query ||= Query.new(self, config)
    end

    class Query < ::Ruby::Reports::Services::QueryBuilder
      def select_data
        [{:first => :one, :second => report.main_param, :third => 3}]
      end
    end
  end

  > report = MyDynamicCsvReport.build('Main param', [:third, :four])
  # => #<MyDynamicCsvReport:0x00000002171a68 ...>
  > report.ready?
  # => true
  > IO.read(report.filename)
  # => "First one,Second,third,four\ndecorated: one,Main param - is second,3,\"\"\n"

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/sclinede/ruby-reports.

License

The gem is available as open source under the terms of the MIT License.