resque-reports 0.3.2 → 0.3.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YTQ0NGJiYjk0OGMyYWVhYmU4OGVmNzhiNWNhZmI0ZWFlYzI4OTMyOQ==
+    NTJmMWQwMTcwNDczZTgwMzkxNDkzOTlhZjA2NjI3MTkzMGEyYTgxMg==
   data.tar.gz: !binary |-
-    MTJmMDEzZmQ0OGIxZTdkMmE4NjdlYmI0ZDIwNzc1YjNhOWNiYWZmOQ==
+    YjVhNTg1NjllZmM4Y2Y4YzI5OTJlMTQyNjdhOTZlMjM2NDJlZjcyNg==
 SHA512:
   metadata.gz: !binary |-
-    ZTk3NWJhMzcyZjBjNTA4MDE3OWQ5NzkzZGVjZTRmYTY2MjdjM2Q1OTE2MTBm
-    NGZiMTRkOGQ2OWE2NTY0YTk0ZDVjY2UwNzMxZDk3ODVjNTQ3NzA1NzgxNTgw
-    ZTBlMjRkYWIwYTQ4ODBmNmQ0OWFiZDI3ZTJmODc0ZTIxODVjNzM=
+    MDE3OWE2ZGFjODZhZDgxYzRlOGFiOGU3MzMwZTdiNjZlYmEwOGI3ZTc2MjFl
+    MDhhNDYwZGRkODY5MTY1ZDQ1MTdlNGU2Mzc0MWI3ZWIwODhlMTNiN2EzMGVi
+    Nzg1Mzc1Y2U5Y2EwMmM0OTVhYjJjODg1NGFlZDNlYTMwNzUwNDA=
   data.tar.gz: !binary |-
-    ZmJkYTIzYjZiYjZiYTgwYThhODMzZTc1NmRkMTYxYWRkMzU1ZWY2NjU5OWUx
-    MTJkYTI3NWQ1NjRjODBiODdiYTVlN2VjZjA5MDU0OGUzODU1YzE5NWZhMWYy
-    YzE2YTNlMTk3MTcwMjNkZDAxMDMxOWZjYzg4ZWJiNzI2MTViM2Y=
+    NGE1MDM5OTA1M2ExNzgxMzE1MGNkMmI4NTlhZmY3NzQzYzJhMTQwMmIxYTAw
+    N2JlZjVhY2E3YTVlYzkzNDMwNzc4N2FjMGVhM2Q3NGFhY2QyMGJhYjU0MmU4
+    YmJmNjNjMWZmYmQwNTUxNzQzNWY2MWI3YWFlOTExYzI4NTdlOGM=

data/lib/resque/reports/base_report.rb

@@ -18,9 +18,13 @@ module Resque
     #     end
     #   end
     #
-    # BaseReport provides followed DSL, example:
+    # 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
@@ -33,14 +37,21 @@ module Resque
     #       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
+    #     # 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]}"
@@ -143,6 +154,12 @@ module Resque
         if create_block
           define_singleton_method(:create_dispatch, create_block)
           create_dispatch(*args)
+        else
+          if args && (attrs_hash = args.first) && attrs_hash.is_a?(Hash)
+            attrs_hash.each do |name, value|
+              send("#{name}=", value)
+            end
+          end
         end
 
         @args = args

data/lib/resque/reports/common/batched_report.rb

@@ -0,0 +1,119 @@
+# coding: utf-8
+module Resque::Reports::Common::BatchedReport
+  extend ActiveSupport::Concern
+
+  BATCH_SIZE = 10_000
+
+  module InstanceMethods
+    # Internal: Выполняет запрос отчета пачками и выполняет block для каждой пачки
+    #   Переопредленный метод из Resque::Reports
+    #
+    # Returns Nothing
+    def data_each(force = false)
+      0.step(data_size, batch_size) do |batch_offset|
+        ActiveRecord::Base.connection.execute(batched_query(batch_offset)).each do |element|
+          yield element
+        end
+      end
+    end
+
+    # Internal: Возвращает общее кол-во строк в отчете
+    #   Переопредленный метод из Resque::Reports
+    #
+    # Returns Fixnum
+    def data_size
+      @data_size ||= ActiveRecord::Base.connection.execute(count_query)[0]['count'].to_i
+    end
+
+    protected
+
+    # 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.inject({}) { |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) do |query, joined|
+        query.join(joined[:table]).on(joined[:on])
+      end
+    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
+      nil
+    end
+
+    # Internal: Фильтры отчета
+    #
+    # Returns Arel::SelectManager
+    def filter(query)
+      query
+    end
+
+    # Internal: Запрос количества строк в отчете
+    #
+    # Returns String (SQL)
+    def count_query
+      query.project(Arel.sql('COUNT(*) as count')).to_sql
+    end
+
+    # Internal: Запрос пачки строк отчета
+    #
+    #   offset - Numeric, число строк на которое сдвигается запрос
+    #
+    # Returns String (SQL)
+    def batched_query(offset)
+      query.project(Arel.sql(select))
+           .take(batch_size)
+           .skip(offset)
+           .order(order)
+           .to_sql
+    end
+  end
+end

data/lib/resque/reports/extensions/table_building.rb

@@ -1,3 +1,4 @@
+require 'active_support/core_ext/hash/indifferent_access'
 # coding: utf-8
 # Resque namespace
 module Resque
@@ -19,7 +20,6 @@ module Resque
         #     - data_each
         #     - data_size
         module ClassMethods
-
           attr_accessor :source_method
           alias_method :source, :source_method=
 
@@ -27,8 +27,8 @@ module Resque
             @table_block = block
           end
 
-          def column(name, value)
-            add_column_header(name) || add_column_cell(value)
+          def column(name, value, options = {})
+            add_column_header(name) || add_column_cell(value, options)
           end
 
           def init_table
@@ -40,12 +40,15 @@ module Resque
             @table_header << encoded_string(column_name) if @header_collecting
           end
 
-          def add_column_cell(column_value)
+          def add_column_cell(column_value, options = {})
             return if @header_collecting
 
             if column_value.is_a? Symbol
-              # Smells bad... changes input variable
-              column_value = @instance.send(column_value, @row_object)
+              column_value = @row_object[column_value]
+            end
+
+            if (formatter_name = options[:formatter])
+              column_value = send("#{formatter_name}_formatter".to_sym, column_value)
             end
 
             @table_row << encoded_string(column_value)
@@ -54,7 +57,8 @@ module Resque
           def build_table_row(row_object)
             @header_collecting = false
 
-            @row_object = row_object # for instance decorate methods calls
+            @row_object = row_object.is_a?(Hash) ? row_object.with_indifferent_access : row_object
+
             row = @table_block.call(@row_object)
 
             finish_row

data/lib/resque/reports/version.rb

@@ -1,7 +1,7 @@
 # coding: utf-8
 module Resque
   module Reports
-    VERSION = '0.3.2'
+    VERSION = '0.3.3'
   end
 end
 

data/spec/resque/reports/base_report_spec.rb

@@ -28,7 +28,7 @@ class MyReport < MyTypeReport
   directory File.join(Dir.tmpdir, 'resque-reports')
 
   table do |element|
-    column 'First one', :decorate_first
+    column 'First one', :one
     column 'Second', decorate_second(element[:two])
   end
 
@@ -36,10 +36,6 @@ class MyReport < MyTypeReport
     @main_param = param
   end
 
-  def decorate_first(element)
-    "decorated: #{element[:one]}"
-  end
-
   def decorate_second(text)
     "#{text} - is second"
   end
@@ -148,7 +144,7 @@ describe 'Resque::Reports::BaseReport successor' do
   describe '#build' do
     subject { MyReport.new('#build test') }
 
-    it { subject.should_receive(:decorate_first).twice }
+    it { subject.should_receive(:decorate_second).exactly(3).times }
 
     after  { subject.build true }
 
@@ -162,8 +158,8 @@ describe 'Resque::Reports::BaseReport successor' do
         File.read(subject.filename)
           .should eq <<-REPORT.gsub(/^ {12}/, '')
             First one|Second\r
-            decorated: one|one - is second\r
-            decorated: was built test|was built test - is second\r
+            one|one - is second\r
+            was built test|was built test - is second\r
           REPORT
       end
     end

data/spec/resque/reports/csv_report_spec.rb

@@ -14,20 +14,25 @@ class MyCsvReport < Resque::Reports::CsvReport
   directory File.join(Dir.home, '.resque-reports')
 
   table do |element|
-    column 'First one', :decorate_first
-    column 'Second', "#{element} - is second"
+    column 'First one', decorate_first(element[:first])
+    column 'Second', "#{element[:second]} - is second"
+    column 'Third', :third, formatter: :cute_third
   end
 
   create do |param|
     @main_param = param
   end
 
+  def self.cute_third_formatter(column_value)
+    "3'rd row element is: #{column_value}"
+  end
+
   def decorate_first(element)
     "decorated: #{element}"
   end
 
   def select_data
-    [:one, @main_param]
+    [{:first => :one, :second => @main_param, :third => 3}]
   end
 end
 
@@ -42,7 +47,7 @@ class MyCsvDefaultsReport < Resque::Reports::CsvReport
   end
 
   def select_data
-    [:one, @main_param]
+    []
   end
 end
 
@@ -79,9 +84,8 @@ describe 'Resque::Reports::CsvReport successor' do
       it do
         File.read(subject.filename)
           .should eq <<-CSV.gsub(/^ {12}/, "")
-            First one,Second
-            decorated: one,one - is second
-            decorated: was built test,was built test - is second
+            First one,Second,Third
+            decorated: one,was built test - is second,3'rd row element is: 3
           CSV
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: resque-reports
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Sergey D.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-07 00:00:00.000000000 Z
+date: 2014-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: resque-integration
@@ -128,6 +128,7 @@ files:
 - lib/resque/reports.rb
 - lib/resque/reports/base_report.rb
 - lib/resque/reports/cache_file.rb
+- lib/resque/reports/common/batched_report.rb
 - lib/resque/reports/csv_report.rb
 - lib/resque/reports/extensions.rb
 - lib/resque/reports/extensions/const.rb