resque-reports 0.0.2 → 0.3.0

data/lib/resque-reports.rb

@@ -1,2 +1,3 @@
 # coding: utf-8
 require 'resque/reports'
+require_relative '../app/jobs/resque/reports/report_job'

data/resque-reports.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |gem|
   gem.version       = Resque::Reports::VERSION
   gem.authors       = ['Sergey D.']
   gem.email         = ['sclinede@gmail.com']
-  gem.description   = 'Make your custom reports to CSV with resque by simple DSL'
-  gem.summary       = 'resque-reports 0.0.1'
+  gem.description   = 'Make your custom reports to CSV in background using Resque with simple DSL'
+  gem.summary       = 'resque-reports'
   gem.homepage      = 'https://github.com/sclinede/resque-reports'
   gem.license       = "MIT"
 
@@ -18,10 +18,12 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ['lib']
 
-  gem.add_dependency 'resque-integration', '~> 0.2.9'
-  gem.add_dependency 'facets', '>= 2.9.3'
+  gem.add_dependency 'resque-integration', '>= 0.2.9'
+  gem.add_dependency 'activesupport' # избавиться от зависимости
 
   gem.add_development_dependency "bundler", "~> 1.3"
   gem.add_development_dependency "rake"
-  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rspec', '>= 2.14.0'
+  gem.add_development_dependency 'rspec-given', '~> 3.0'
+  gem.add_development_dependency 'simplecov'
 end

data/spec/resque/reports/base_report_spec.rb

@@ -0,0 +1,196 @@
+# coding: utf-8
+require 'spec_helper'
+require 'stringio'
+
+require 'resque-reports'
+
+class MyTypeReport < Resque::Reports::BaseReport
+  extension :type
+
+  def write(io, force = false)
+    write_line io, build_table_header
+
+    data_each(true) do |element|
+      write_line io, build_table_row(element)
+    end
+  end
+
+  def write_line(io, row)
+    io << "#{row.nil? ? 'nil' : row.join('|')}\r\n"
+  end
+end
+
+class MyReport < MyTypeReport
+  queue :my_type_reports
+  source :select_data
+  encoding UTF8
+
+  directory File.join(Dir.tmpdir, 'resque-reports')
+
+  table do |element|
+    column 'First one', :decorate_first
+    column 'Second', decorate_second(element[:two])
+  end
+
+  create do |param|
+    @main_param = param
+  end
+
+  def decorate_first(element)
+    "decorated: #{element[:one]}"
+  end
+
+  def decorate_second(text)
+    "#{text} - is second"
+  end
+
+  def select_data
+    [{one: 'one', two: 'one'}, {one: @main_param, two: @main_param}]
+  end
+end
+
+describe 'Resque::Reports::BaseReport successor' do
+  let(:io) { StringIO.new }
+  let(:my_report) { MyReport.new('test') }
+  let(:dummy) { Resque::Reports::Extensions::Dummy.new }
+
+  describe '#extension' do
+    before { File.stub(:exists? => true) }
+
+    it { File.extname(my_report.filename).should eq '.type' }
+  end
+
+  describe '#source' do
+    before { my_report.stub(select_data: [dummy]) }
+
+    it { my_report.should_receive(:select_data) }
+
+    after { my_report.build true }
+  end
+
+  describe '#directory' do
+    subject { my_report.instance_variable_get(:@cache_file) }
+    let(:tmpdir) { File.join(Dir.tmpdir, 'resque-reports') }
+
+    it { subject.instance_variable_get(:@dir).should eq tmpdir }
+  end
+
+  describe '#create' do
+    it { my_report.instance_variable_get(:@main_param).should eq 'test' }
+  end
+
+  describe '#encoding' do
+    subject { my_report.instance_variable_get(:@cache_file) }
+    let(:utf_coding) { Resque::Reports::Extensions::Encodings::UTF8 }
+
+    it { subject.instance_variable_get(:@coding).should eq utf_coding }
+  end
+
+  describe '#write' do
+    subject { MyReport.new('#write test') }
+
+    before do
+      subject.stub(:data_each) { |&block| block.call(dummy) }
+      subject.stub(build_table_row: ['row'])
+      subject.stub(build_table_header: ['header'])
+
+      subject.write(io)
+    end
+
+    it { io.string.should eq "header\r\nrow\r\n" }
+  end
+
+  describe '#bg_build' do
+    let(:job_class) { Resque::Reports::ReportJob }
+
+    context 'when report is building twice' do
+      subject { MyReport.new('#bg_build test') }
+
+      before { job_class.stub(enqueue: 'job_id') }
+
+      it do
+        job_class
+          .should_receive(:enqueue)
+          .with('MyReport', '["#bg_build test",true]')
+          .twice
+      end
+
+      after do
+        2.times { subject.bg_build true }
+      end
+    end
+
+    context 'when report is building' do
+      subject { MyReport.new('#bg_build test') }
+
+      before { job_class.stub(enqueue: 'job_id') }
+
+      it do
+        job_class
+          .should_receive(:enqueue)
+          .with('MyReport', '["#bg_build test",true]')
+      end
+
+      after  { subject.bg_build true }
+    end
+
+    context 'when report is not build yet' do
+      subject { MyReport.new('#bg_build test') }
+
+      before do
+        job_class.stub(enqueued?: double('Meta', meta_id: 'enqueued_job_id'))
+      end
+
+      it { subject.bg_build(true).should eq 'enqueued_job_id' }
+    end
+  end
+
+  describe '#build' do
+    subject { MyReport.new('#build test') }
+
+    it { subject.should_receive(:decorate_first).twice }
+
+    after  { subject.build true }
+
+    context 'when report was built' do
+      subject { MyReport.new('was built test') }
+
+      before { subject.build true }
+
+      its(:exists?) { should be_true }
+      it 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
+          REPORT
+      end
+    end
+  end
+
+  describe '#data_each' do
+    subject { MyReport.new('#data_each test') }
+
+    it { subject.should_receive(:data_each) }
+
+    after { subject.write(io) }
+  end
+
+  describe '#build_table_header' do
+    subject { MyReport.new('#build_table_header test') }
+
+    it { subject.should_receive(:build_table_header) }
+
+    after { subject.write(io) }
+  end
+
+  describe '#build_table_row' do
+    subject { MyReport.new('#build_table_row test') }
+
+    it { subject.should_receive(:build_table_row).twice }
+
+    after { subject.write(io) }
+  end
+
+end

data/spec/resque/reports/csv_report_spec.rb

@@ -0,0 +1,89 @@
+# coding: utf-8
+require 'spec_helper'
+require 'stringio'
+
+require 'resque/reports/csv_report'
+
+class MyCsvReport < Resque::Reports::CsvReport
+  queue :csv_reports
+  source :select_data
+  encoding UTF8
+
+  csv_options col_sep: ',', row_sep: "\n"
+
+  directory File.join(Dir.home, '.resque-reports')
+
+  table do |element|
+    column 'First one', :decorate_first
+    column 'Second', "#{element} - is second"
+  end
+
+  create do |param|
+    @main_param = param
+  end
+
+  def decorate_first(element)
+    "decorated: #{element}"
+  end
+
+  def select_data
+    [:one, @main_param]
+  end
+end
+
+class MyCsvDefaultsReport < Resque::Reports::CsvReport
+  source :select_data
+  encoding UTF8
+
+  directory File.join(Dir.tmpdir, 'resque-reports')
+
+  table do |element|
+    column 'Uno', "#{element} - is value"
+  end
+
+  def select_data
+    [:one, @main_param]
+  end
+end
+
+describe 'Resque::Reports::CsvReport successor' do
+  describe '.csv_options' do
+    context 'when custom options not set' do
+      subject { MyCsvDefaultsReport.new }
+
+      it 'sets csv_options defaults' do
+        subject.options.should eq MyCsvReport::DEFAULT_CSV_OPTIONS
+      end
+    end
+
+    context 'when custom options are set' do
+      subject { MyCsvReport.new('csv_options test') }
+
+      let(:my_options) do
+        MyCsvReport::DEFAULT_CSV_OPTIONS.merge(col_sep: ',', row_sep: "\n")
+      end
+
+      it 'merges csv_options with defaults' do
+        subject.options.should eq my_options
+      end
+    end
+  end
+
+  describe '#build' do
+    context 'when report was built' do
+      subject { MyCsvReport.new('was built test') }
+
+      before { subject.build true }
+
+      its(:exists?) { should be_true }
+      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
+          CSV
+      end
+    end
+  end
+end

data/spec/resque/reports/report_job_spec.rb

@@ -0,0 +1,140 @@
+# coding: utf-8
+require 'spec_helper'
+require 'resque-reports'
+
+module Reports
+  class MyCsvReport < Resque::Reports::CsvReport
+    queue :csv_reports
+    source :select_data
+    encoding UTF8
+
+    directory File.join(Dir.home, '.resque-reports')
+
+    table do |element|
+      column 'First', "#{element} - is first"
+    end
+
+    create do |param1, param2|
+      @main_param = param1
+      @secondary_param = param2
+    end
+
+    def select_data
+      [:one, @main_param]
+    end
+  end
+end
+
+describe Resque::Reports::ReportJob do
+  let(:my_report) { Reports::MyCsvReport.new('.execute test', 'test') }
+  let(:exec_params) do
+    ['Reports::MyCsvReport', '[".execute test", "test",true]']
+  end
+
+  describe '.execute' do
+    before { Reports::MyCsvReport.stub(new: my_report) }
+
+    context 'when building report' do
+      before { my_report.stub(build: nil) }
+
+      it do
+        expect(Reports::MyCsvReport)
+          .to receive(:new).with('.execute test', 'test')
+      end
+      it { expect(my_report).to receive(:build).with(true) }
+
+      after { described_class.execute(*exec_params) }
+
+    end
+    context 'when wrong class given' do
+      it 'sends invalid class name' do
+        expect { described_class.execute('MyWrongReport', '[true]') }
+          .to raise_error(NameError)
+      end
+
+      it 'sends class that is not BaseReport successor' do
+        expect { described_class.execute('Object', '[true]') }
+          .to raise_error(RuntimeError)
+      end
+    end
+
+    context 'when events are firing' do
+      before do
+        described_class.stub(get_meta: {})
+        described_class.get_meta.stub(save: true)
+      end
+
+      context 'when progress total is zero' do
+        before do
+          my_report.stub(select_data: [])
+          my_report.stub(data_size: 0)
+        end
+
+        it { described_class.should_not_receive(:at) }
+
+        after { described_class.execute(*exec_params) }
+      end
+
+      context 'when works default handlers' do
+        context 'when error occurs' do
+          before { my_report.stub(:build_table_row) { fail 'Custom error' } }
+
+          it do
+            expect { described_class.execute(*exec_params) }
+              .to raise_error('Custom error')
+          end
+        end
+
+        context 'when progress is changed' do
+          it { described_class.should_receive(:at).with(2, 2, nil) }
+
+          after { described_class.execute(*exec_params) }
+        end
+      end
+
+      context 'when works custom handlers' do
+        context 'when error occurs' do
+          before do
+            my_report.stub(:error_message) { |e| fail "Boom! #{e.message}" }
+            my_report.stub(:build_table_row) { fail 'Custom error' }
+          end
+
+          it do
+            expect { described_class.execute(*exec_params) }
+              .to raise_error('Boom! Custom error')
+          end
+        end
+
+        context 'when progress is changed' do
+          before do
+            my_report.stub(:progress_message) do |progress, total|
+              "my progress: #{progress} / #{total}"
+            end
+          end
+
+          it do
+            described_class
+              .should_receive(:at)
+              .with(2, 2, 'my progress: 2 / 2')
+          end
+
+          after { described_class.execute(*exec_params) }
+        end
+      end
+
+      context 'when task is performed by resque' do
+        context 'when error occurs' do
+          before do
+            my_report.stub(:error_message) { |e| fail "Boom! #{e.message}" }
+            my_report.stub(:build_table_row) { fail 'Custom error' }
+          end
+
+          it do
+            expect { described_class.execute(*exec_params) }
+              .to raise_error('Boom! Custom error')
+          end
+        end
+      end
+    end
+  end
+end