ruby-reports 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 607ca468bb6cc003dd6d1982538fe62f2d58ddaf
+  data.tar.gz: 7e58b3ca2062cf8d351a9ec201014b7e119b0857
+SHA512:
+  metadata.gz: 996cc830263eda8dc5a8a584d72b26e0bf60bf89d3322962682e70d057ecbbb0501e1824a37e7d26a6b1682f5b5e00118acc9625fed6e4e912f6bbb57c5b144e
+  data.tar.gz: c25b1718b161c12a77207dbb8dacbc07f2e6b6ffe27c3bc62df4063faefc19fa8e53e981d2fd7c968fa0649cc872c7a0587b826bf59a994a4bf6a082dccf5d6f

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.10.6
+addons:
+  code_climate:
+    repo_token: 363fef79ea0d646c43a20ea27d2cc4e3b97c4500023c8dc2ba25b027018a1ec9

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Sergey D.
+
+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,99 @@
+# Ruby::Reports [![Build Status](https://travis-ci.org/sclinede/ruby-reports.svg)](https://travis-ci.org/sclinede/ruby-reports) [![Code Climate](https://codeclimate.com/github/sclinede/ruby-reports/badges/gpa.svg)](https://codeclimate.com/github/sclinede/ruby-reports) [![Test Coverage](https://codeclimate.com/github/sclinede/ruby-reports/badges/coverage.svg)](https://codeclimate.com/github/sclinede/ruby-reports/coverage)
+
+This gem was written for report automation provided by DSL. See [Usage](#usage) for details
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruby-reports'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruby-reports
+
+## Usage <a id="usage"></a>
+
+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:
+```ruby
+  class MyNiceReport < Ruby::Reports::CsvReport
+    config(
+      source: :fetch_data,
+      expire_in: 15 * 60,
+      encoding: Ruby::Reports::CP1251,
+      directory: File.join('/home', 'my_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(self)
+    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 < Ruby::Reports::Services::QueryBuilder
+      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"
+```
+
+## 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](https://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](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ruby/reports"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/ruby/reports/base_report.rb

@@ -0,0 +1,179 @@
+# coding: utf-8
+# Resque namespace
+module Ruby
+  # Resque::Reports namespace
+  module Reports
+    # Class describes base report class for inheritance.
+    # BaseReport successor must implement "write(io, force)" method
+    # and may specify file extension with "extension" method call
+    # example:
+    #
+    #   class CustomTypeReport < Resque::Reports::BaseReport
+    #     extension :type # specify that report file must ends
+    #                     # with '.type', e.g. 'abc.type'
+    #
+    #     # Method specifies how to output report data
+    #     def write(io, force)
+    #       io << 'Hello World!'
+    #     end
+    #   end
+    #
+    # BaseReport provides following DSL, example:
+    #
+    #   class CustomReport < CustomTypeReport
+    #     # include Resque::Reports::Common::BatchedReport
+    #     #   overrides data retrieving to achieve batching
+    #     #   if included 'source :select_data' becomes needless
+    #
+    #     queue :custom_reports # Resque queue name
+    #     source :select_data # method called to retrieve report data
+    #     encoding UTF8 # file encoding
+    #     expire_in 86_400 # cache time of the file, default: 86_400
+    #
+    #     # Specify in which directory to keep this type files
+    #     directory File.join(Dir.tmpdir, 'resque-reports')
+    #
+    #     # Describe table using 'column' method
+    #     table do |element|
+    #       column 'Column 1 Header', :decorate_one
+    #       column 'Column 2 Header', decorate_two(element[1])
+    #       column 'Column 3 Header', 'Column 3 Cell'
+    #       column 'Column 4 Header', :formatted_four, formatter: :just_cute
+    #     end
+    #
+    #     # Class initialize if needed
+    #     # NOTE: must be used instead of define 'initialize' method
+    #     # Default behaviour is to receive in *args Hash with report attributes
+    #     # like: CustomReport.new(main_param: 'value') => calls send(:main_param=, 'value')
+    #     create do |param|
+    #       @main_param = param
+    #     end
+    #
+    #     def self.just_cute_formatter(column_value)
+    #       "I'm so cute #{column_value}"
+    #     end
+    #
+    #     # decorate method, called by symbol-name
+    #     def decorate_one(element)
+    #       "decorate_one: #{element[0]}"
+    #     end
+    #
+    #     # decorate method, called directly when filling cell
+    #     def decorate_two(text)
+    #       "decorate_two: #{text}"
+    #     end
+    #
+    #     # method returns report data Enumerable
+    #     def select_data
+    #       [[0, 'text0'], [1, 'text1']]
+    #     end
+    #   end
+    class BaseReport
+      extend Forwardable
+
+      class << self
+        attr_reader :config_hash, :table_block, :progress_handle_block, :error_handle_block
+
+        def config(hash)
+          @config_hash = hash
+        end
+
+        def table(&block)
+          @table_block = block
+        end
+
+        def build(options = {})
+          force = options.delete(:force)
+
+          report = new(options)
+          report.build(force)
+
+          report
+        end
+      end
+
+      attr_reader :args, :job_id, :events_handler
+      def_delegators :cache_file, :filename, :exists?, :ready?
+
+      #--
+      # Public instance methods
+      #++
+
+      def initialize(*args)
+        @args = args
+        assign_attributes
+      end
+
+      # Builds report synchronously
+      def build(force = false)
+        @table = nil if force
+        @events_handler = Services::EventsHandler.new(@progress_handle_block, @error_handle_block)
+
+        cache_file.open(force) { |file| write(file, force) }
+      end
+
+      def progress_handler(&block)
+        @progress_handle_block = block
+      end
+
+      def error_handler(&block)
+        @error_handle_block = block
+      end
+
+      private
+
+      def formatter
+        nil
+      end
+
+      def config
+        @config ||= Config.new(self.class.config_hash)
+      end
+
+      def assign_attributes
+        if args && (attrs_hash = args.first) && attrs_hash.is_a?(Hash)
+          attrs_hash.each { |name, value| instance_variable_set("@#{name}", value) }
+        end
+      end
+
+      def query
+        # descendant of QueryBuilder or SqlQuery with #take_batch(limit, offset) method defined
+        # @query ||= Query.new(self)
+        fail NotImplementedError
+      end
+
+      def iterator
+        @iterator ||= Services::DataIterator.new(query, config)
+      end
+
+      def table
+        @table ||= Services::TableBuilder.new(self, self.class.table_block, config, formatter)
+      end
+
+      def cache_file
+        @cache_file ||= CacheFile.new(config.directory,
+                                      Services::FilenameGenerator.generate(args, config.extension),
+                                      expire_in: config.expire_in, coding: config.encoding)
+      end
+
+      # Method specifies how to output report data
+      # @param [IO] io stream for output
+      # @param [true, false] force write to output or skip due its existance
+      def write(io, force)
+        # You must use ancestor methods to work with report data:
+        # 1) iterator.data_size => returns source data size (calls #count on data
+        #                 retrieved from 'source')
+        # 2) iterator.data_each => yields given block for each source data element
+        # 3) table.build_header => returns Array of report column names
+        # 4) table.build_row(object) => returns Array of report cell
+        #                               values (same order as header)
+        # 5) events_handler.progress(progress, total) => call to iterate job progress
+        # 6) events_handler.error(error) => call to handle error in job
+        #
+        # HINT: You may override data_size and data_each, to retrieve them
+        #       effectively
+        fail NotImplementedError
+      end
+    end # class BaseReport
+  end # module Report
+end # module Resque

data/lib/ruby/reports/cache_file.rb

@@ -0,0 +1,84 @@
+require 'tempfile'
+# coding: utf-8
+module Ruby
+  module Reports
+    # Class describes how to storage and access cache file
+    # NOTE: Every time any cache file is opening,
+    #       cache is cleared from old files.
+    class CacheFile
+      DEFAULT_EXPIRE_TIME = 86_400
+      DEFAULT_CODING = 'utf-8'.freeze
+
+      attr_reader :dir, :ext, :coding, :expiration_time
+      def initialize(dir, filename, options = {})
+        @dir = dir
+        @filename = File.join(dir, filename)
+        @ext = File.extname(@filename)
+
+        # options
+        @coding = options[:coding] || DEFAULT_CODING
+        @expiration_time = options[:expire_in] || DEFAULT_EXPIRE_TIME
+      end
+
+      def exists?
+        !expired?(@filename)
+      end
+      alias_method :ready?, :exists?
+
+      def filename
+        fail 'File doesn\'t exist, check exists? before' unless exists?
+        @filename
+      end
+
+      def open(force = false)
+        prepare_cache_dir
+
+        (force ? clear : return) if File.exists?(@filename)
+
+        with_tempfile do |tempfile|
+          yield tempfile
+
+          tempfile.close
+          FileUtils.cp(tempfile.path, @filename)
+          FileUtils.chmod(0644, @filename)
+        end
+      end
+
+      def clear
+        FileUtils.rm_f(@filename)
+      end
+
+      protected
+
+      def with_tempfile
+        yield(tempfile = Tempfile.new(Digest::MD5.hexdigest(@filename), :encoding => coding))
+      ensure
+        return unless tempfile
+        tempfile.close unless tempfile.closed?
+        tempfile.unlink
+      end
+
+      def prepare_cache_dir
+        FileUtils.mkdir_p dir # create folder if not exists
+        clear_expired_files
+      end
+
+      def clear_expired_files
+        # TODO: avoid races when worker building
+        #       his report longer than @expiration_time
+        FileUtils.rm_f cache_files_array.select { |fname| expired?(fname) }
+      end
+
+      def expired?(fname)
+        return true unless File.file?(fname)
+        File.mtime(fname) + expiration_time < Time.now
+      end
+
+      def cache_files_array
+        Dir.new(dir)
+           .map { |fname| File.join(dir, fname) if File.extname(fname) == ext }
+           .compact
+      end
+    end
+  end
+end

data/lib/ruby/reports/config.rb

@@ -0,0 +1,34 @@
+module Ruby
+  module Reports
+    class Config
+      BATCH_SIZE = 10_000
+      DEFAULT_EXPIRE_TIME = 86_400
+      DEFAULT_CODING = 'utf-8'.freeze
+      DEFAULT_CSV_OPTIONS = {col_sep: ';', row_sep: "\r\n"}
+
+      DEFAULT_CONFIG_ATTRIBUTES = [
+        :directory,
+        :source,
+        :extension,
+        :batch_size,
+        :encoding,
+        :expire_in,
+        :csv_options,
+        :storage
+      ]
+
+      def self.config_attributes
+        DEFAULT_CONFIG_ATTRIBUTES
+      end
+
+      attr_accessor(*config_attributes)
+      attr_initialize config_attributes do
+        @batch_size ||= BATCH_SIZE
+        @encoding ||= DEFAULT_CODING
+        @expire_in ||= DEFAULT_EXPIRE_TIME
+        @csv_options ||= DEFAULT_CSV_OPTIONS
+        @storage ||= Storages::OBJECT
+      end
+    end
+  end
+end

data/lib/ruby/reports/csv_report.rb

@@ -0,0 +1,77 @@
+# coding: utf-8
+require 'csv'
+
+module Ruby
+  module Reports
+    # Class to inherit from for custom CSV reports
+    # To make your custom report you must define at least:
+    #   1. directory, is where to write reports to
+    #   2. source, is symbol of method that retrieves report data
+    #   3. table, report table configuration using DSL
+    class CsvReport < BaseReport
+      attr_reader :csv_options
+
+      def initialize(*args)
+        config.extension = :csv
+        super
+        @csv_options = config.csv_options
+      end
+
+      def write(io, force = false)
+        # You must use ancestor methods to work with report data:
+        #   1) data_size => returns source data size
+        #   2) data_each => yields given block for each source data element
+        #   3) build_table_header => returns Array of report column names
+        #   4) build_table_row(object) => returns Array of report cell values
+        #                                 (same order as header)
+        progress = 0
+
+        CSV(io, csv_options) do |csv|
+          write_line csv, table.build_header
+
+          iterator.data_each(force) do |data_element|
+            begin
+              write_line csv, table.build_row(data_element)
+            rescue
+              events_handler.error
+            end
+
+            events_handler.progress(progress += 1, iterator.data_size)
+          end
+
+          events_handler.progress(progress, iterator.data_size, true)
+        end
+      end
+
+      def write_line(csv, row_cells)
+        csv << row_cells
+      end
+
+      #--
+      # Event handling #
+      #++
+      #
+
+      def progress_message(*args)
+        'Выгрузка отчета в CSV'
+      end
+
+      def error_message(error)
+        error_message = []
+        error_message << 'Выгрузка отчета невозможна. '
+        error_message << case error
+                         when Encoding::UndefinedConversionError
+                           <<-ERR_MSG.gsub(/^ {29}/, '')
+                             Символ #{error.error_char} не поддерживается
+                             заданной кодировкой
+                           ERR_MSG
+                         when EncodingError
+                           'Ошибка преобразования в заданную кодировку'
+                         else
+                           fail error
+                         end
+        error_message * ' '
+      end
+    end # class CsvReport
+  end # module Report
+end # module Ruby

data/lib/ruby/reports/services/data_iterator.rb

@@ -0,0 +1,42 @@
+module Ruby
+  module Reports
+    module Services
+      class DataIterator
+        attr_reader :custom_source
+        pattr_initialize :query, :config do
+          @custom_source = query.send(config.source) if config.source
+        end
+
+        def iterate_custom_source
+          custom_source.each do |row|
+            yield row
+          end
+        end
+        # Internal: Выполняет запрос строк отчета пачками
+        #
+        # Returns Nothing
+        def data_each(force = false, &block)
+          return iterate_custom_source(&block) if custom_source
+
+          batch_offset = 0
+
+          while (rows = query.request_batch(batch_offset)).count > 0 do
+            rows.each { |row| yield row }
+            batch_offset += config.batch_size
+          end
+        end
+
+        # Internal: Возвращает общее кол-во строк в отчете
+        #
+        # Returns Fixnum
+        def data_size
+          @data_size ||= if custom_source
+                           custom_source.count
+                         else
+                           query.request_count
+                         end
+        end
+      end
+    end
+  end
+end

data/lib/ruby/reports/services/events_handler.rb

@@ -0,0 +1,23 @@
+module Ruby
+  module Reports
+    module Services
+      class EventsHandler
+        PROGRESS_STEP = 10
+
+        pattr_initialize :progress_callback, :error_callback do
+          @error_callback ||= ->(e) { fail e }
+        end
+
+        def progress(progress, total, force = false)
+          if progress_callback && (force || progress % PROGRESS_STEP == 0)
+            progress_callback.call progress, total
+          end
+        end
+
+        def error
+          error_callback ? error_callback.call($ERROR_INFO) : fail
+        end
+      end
+    end
+  end
+end

data/lib/ruby/reports/services/filename_generator.rb

@@ -0,0 +1,51 @@
+require 'digest'
+
+# coding: utf-8
+module Ruby
+  module Reports
+    module Services
+      # Module that generates file name
+      # Usage:
+      #   class SomeClass
+      #     include Resque::Reports::Extensions::FilenameGen
+      #
+      #     # ...call somewhere...
+      #     fname = generate_filename(%w(a b c), 'pdf')
+      #     # 'fname' value is something like this:
+      #     #   "a60428ee50f1795819b8486c817c27829186fa40.pdf"
+      #   end
+      class FilenameGenerator
+        DEFAULT_EXTENSION = 'txt'
+
+        def self.generate(args, fextension = nil)
+          "#{hash(self.class.to_s, *args)}.#{fextension || DEFAULT_EXTENSION}"
+        end
+
+        private
+
+        def self.hash(*args)
+          Digest::SHA1.hexdigest(obj_to_string(args))
+        end
+
+        def self.obj_to_string(obj)
+          case obj
+          when Hash
+            s = []
+            obj.keys.sort.each do |k|
+              s << obj_to_string(k)
+              s << obj_to_string(obj[k])
+            end
+            s.to_s
+          when Array
+            s = []
+            obj.each { |a| s << obj_to_string(a) }
+            s.to_s
+          else
+            obj.to_s
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/ruby/reports/services/query_builder.rb

@@ -0,0 +1,113 @@
+module Ruby
+  module Reports
+    module Services
+      class QueryBuilder
+        extend Forwardable
+        pattr_initialize :report, :config
+
+        def request_count
+          execute(count)[0]['count'].to_i
+        end
+
+        def request_batch(offset)
+          execute take_batch(config.batch_size, offset)
+        end
+
+        private
+
+        def_delegator :connection, :execute
+
+        def connection
+          ActiveRecord::Base.connection
+        end
+
+        # Internal: Возвращает отфильтрованный запрос отчета
+        #
+        # Returns Arel::SelectManager
+        def query
+          filter base_query
+        end
+
+        # Internal: Полезный метод для хранения Arel::Table объектов для запроса отчета
+        #
+        # Returns Hash, {:table_name => #<Arel::Table @name="table_name">, ...}
+        def tables
+          return @tables if defined? @tables
+
+          tables = models.map(&:arel_table)
+
+          @tables = tables.reduce({}) { |a, e| a.store(e.name, e) && a }.with_indifferent_access
+        end
+
+        # Internal: Полезный метод для join'а необходимых таблиц через Arel
+        #
+        # Returns Arel
+        def join_tables(source_table, *joins)
+          joins.inject(source_table) { |query, joined| query.join(joined[:table]).on(joined[:on]) }
+        end
+
+        # Internal: Размер пачки отчета
+        #
+        # Returns Fixnum
+        def batch_size
+          BATCH_SIZE
+        end
+
+        # Internal: Модели используемые в отчете
+        #
+        # Returns Array of Arel::Table
+        def models
+          fail NotImplementedError
+        end
+
+        # Internal: Основной запрос отчета (Arel)
+        #
+        # Returns Arel::SelectManager
+        def base_query
+          fail NotImplementedError
+        end
+
+        # Internal: Поля запрашиваемые отчетом
+        #
+        # Returns String (SQL)
+        def select
+          fail NotImplementedError
+        end
+
+        # Internal: Порядок строк отчета
+        #
+        # Returns String (SQL)
+        def order_by
+          nil
+        end
+
+        # Internal: Фильтры отчета
+        #
+        # Returns Arel::SelectManager
+        def filter(query)
+          query
+        end
+
+        # Internal: Запрос количества строк в отчете
+        #
+        # Returns String (SQL)
+        def count
+          query.project(Arel.sql('COUNT(*) as count')).to_sql
+        end
+
+        # Internal: Запрос пачки строк отчета
+        #
+        #   offset - Numeric, число строк на которое сдвигается запрос
+        #
+        # Returns String (SQL)
+        def take_batch(limit, offset)
+          query.project(Arel.sql(select))
+               .take(limit)
+               .skip(offset)
+               .order(order_by)
+               .to_sql
+        end
+      end
+    end
+  end
+end

data/lib/ruby/reports/services/table_builder.rb

@@ -0,0 +1,103 @@
+require 'facets/hash/rekey'
+require 'iron/dsl'
+
+# coding: utf-8
+# Ruby namespace
+module Ruby
+  # Resque::Reports namespace
+  module Reports
+    # Resque::Reports::Extensions namespace
+    module Services
+      # Defines report table building logic
+      class TableBuilder
+        attr_reader :building_header
+        pattr_initialize :report, :table_block, :config, :formatter do
+          init_table
+        end
+
+        def column(name, value = nil, options = {})
+          if (skip_if = options.delete(:skip_if))
+            if skip_if.is_a?(Symbol)
+              return if report.send(skip_if)
+            elsif skip_if.respond_to?(:call)
+              return if skip_if.call
+            end
+          end
+
+          building_header ? add_header_cell(name) : add_row_cell(value, options)
+        end
+
+        def build_row(row)
+          @row = row.is_a?(Hash) ? row.rekey! : row
+          row = DslProxy.exec(self, @row, &table_block)
+          cleanup_row
+          row
+        end
+
+        def build_header
+          @building_header = true
+          header = DslProxy.exec(self, Dummy.new, &table_block)
+          @building_header = false
+
+          cleanup_header
+          header
+        end
+
+        private
+
+        def encoded_string(obj)
+          obj.to_s.encode(config.encoding, invalid: :replace, undef: :replace)
+        end
+
+        def init_table
+          cleanup_header
+          cleanup_row
+        end
+
+        def cleanup_row
+          @table_row = []
+        end
+
+        def cleanup_header
+          @table_header = []
+        end
+
+        def add_header_cell(column_name)
+          @table_header << encoded_string(column_name)
+        end
+
+        def add_row_cell(column_value, options = {})
+          column_value = read_from_storage(column_value) if column_value.is_a? Symbol
+
+          if (formatter_name = options[:formatter])
+            column_value = formatter.send(formatter_name, column_value)
+          end
+
+          @table_row << encoded_string(column_value)
+        end
+
+        def read_from_storage(column)
+          case config.storage
+          when :object
+            @row.public_send(column)
+          when :hash
+            @row[column]
+          else
+            fail 'Unknown Storage set in report config'
+          end
+        end
+
+        class Dummy
+          def method_missing(method, *arguments, &block)
+            nil
+          end
+
+          def respond_to?(method, include_private = false)
+            true
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/ruby/reports/services.rb

@@ -0,0 +1,5 @@
+require 'ruby/reports/services/data_iterator'
+require 'ruby/reports/services/events_handler'
+require 'ruby/reports/services/filename_generator'
+require 'ruby/reports/services/query_builder'
+require 'ruby/reports/services/table_builder'

data/lib/ruby/reports/storages.rb

@@ -0,0 +1,9 @@
+module Ruby
+  module Reports
+    module Storages
+      HASH = :hash
+      OBJECT = :object
+    end
+  end
+end
+

data/lib/ruby/reports/version.rb

@@ -0,0 +1,7 @@
+# coding: utf-8
+module Ruby
+  module Reports
+    VERSION = '0.0.3'
+  end
+end
+

data/lib/ruby/reports.rb

@@ -0,0 +1,20 @@
+require 'forwardable'
+require 'attr_extras'
+
+require 'ruby/reports/services'
+
+require 'ruby/reports/cache_file'
+require 'ruby/reports/base_report'
+require 'ruby/reports/csv_report'
+require 'ruby/reports/cache_file'
+require 'ruby/reports/config'
+require 'ruby/reports/storages'
+
+require 'ruby/reports/version'
+
+module Ruby
+  module Reports
+    CP1251 = 'cp1251'.freeze
+    UTF8 = 'utf-8'.freeze
+  end
+end

data/ruby-reports.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ruby/reports/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ruby-reports'
+  spec.version       = Ruby::Reports::VERSION
+  spec.authors       = ['Sergey D.']
+  spec.email         = ['sclinede@gmail.com']
+
+  spec.summary       = 'Make your custom reports from any source to CSV by provided DSL'
+  spec.description   = 'Make your custom reports from any source to CSV by provided DSL'
+  spec.homepage      = 'https://github.com/sclinede/ruby-reports'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'iron-dsl'
+  spec.add_runtime_dependency 'attr_extras'
+  spec.add_runtime_dependency 'facets'
+
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rspec', '>= 2.14.0'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'timecop', '~> 0.7.1'
+  spec.add_development_dependency 'codeclimate-test-reporter'
+end

metadata

@@ -0,0 +1,195 @@
+--- !ruby/object:Gem::Specification
+name: ruby-reports
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Sergey D.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  name: iron-dsl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  name: attr_extras
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  name: facets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Make your custom reports from any source to CSV by provided DSL
+email:
+- sclinede@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ruby/reports.rb
+- lib/ruby/reports/base_report.rb
+- lib/ruby/reports/cache_file.rb
+- lib/ruby/reports/config.rb
+- lib/ruby/reports/csv_report.rb
+- lib/ruby/reports/services.rb
+- lib/ruby/reports/services/data_iterator.rb
+- lib/ruby/reports/services/events_handler.rb
+- lib/ruby/reports/services/filename_generator.rb
+- lib/ruby/reports/services/query_builder.rb
+- lib/ruby/reports/services/table_builder.rb
+- lib/ruby/reports/storages.rb
+- lib/ruby/reports/version.rb
+- ruby-reports.gemspec
+homepage: https://github.com/sclinede/ruby-reports
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Make your custom reports from any source to CSV by provided DSL
+test_files: []