resque-reports 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+source 'http://apress:montalcino@gems.dev.apress.ru'
+
+# Specify your gem's dependencies in resque-reports.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Dolganov Sergey
+
+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

@@ -0,0 +1,13 @@
+Resque::Reports
+==============
+
+Introduction goes here.
+
+
+Example
+=======
+
+Example goes here.
+
+
+Copyright (c) 2013 Dolganov Sergey, released under the MIT license

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/app/jobs/resque/reports/report_job.rb

@@ -0,0 +1,22 @@
+# coding: utf-8
+module Resque
+  module Reports
+    # ReportJob accepts report_type and current report arguments to build it in background
+    class ReportJob
+      include Resque::Integration
+
+      queue :reports
+      unique { |report_type, args_json| [report_type, args_json] }
+
+      def self.execute(report_type, args_json)
+        report_class = constant(report_type) # Get report class from string (through ActiveSupport)
+        raise "Resque::Reports::ReportJob can work only with successors of Resque::Reports::BaseReport, but got #{report_class}" unless report_class.ancestors.include? BaseReport
+
+        args = Json.parse(args_json)
+        report = report_class.new *args
+
+        report.build
+      end
+    end # class ReportJob
+  end # module Reports
+end # module Resque

data/init.rb

@@ -0,0 +1,4 @@
+# coding: utf-8
+Core.init_plugin do
+  ActiveSupport::Dependencies.autoload_paths << "#{File.dirname(__FILE__)}/app/jobs"
+end

data/lib/resque/reports/base_report.rb

@@ -0,0 +1,151 @@
+# coding: utf-8
+module Resque
+  module Reports
+    class BaseReport
+      # TODO: Hook initialize of successor to collect init params into @args array
+      # include ActiveSupport
+      extend Forwardable
+      include Encodings # include encoding constants CP1251, UTF8...
+
+      class << self
+        protected
+
+        attr_reader :row_object, 
+                    :directory, 
+                    :create_block
+
+        attr_accessor :extension, 
+                      :encoding, 
+                      :source_method, 
+                      :table_block, 
+                      :header_collecting
+        
+        alias_method :source_method, :source
+
+        def table(&block)
+          @table_block = block
+        end
+
+        def create(&block)
+          @create_block = block
+        end
+
+        def build_table_row(row_object)
+          header_collecting = false
+
+          @row_object = row_object # for instance decorate methods calls
+          row = @table_block.call(row_object)
+
+          finish_row
+
+          row
+        end
+
+        def build_table_header
+          header_collecting = true
+          @table_block.call(nil)
+        end
+
+        def get_data
+          send(@source_method)
+        end
+      end # class methods
+
+      # Constants
+
+      DEFAULT_EXTENSION = 'txt'
+
+      # Public instance methods
+
+      def initialize(*args)
+        create_block.call(*args) if create_block
+
+        @args = args
+        extension ||= DEFAULT_EXTENSION
+
+        @cache_file = CacheFile.new(directory, generate_filename, coding: encoding)
+
+        init_table
+      end
+
+      def build
+        @cache_file.open { |file| write file }
+      end
+
+      def bg_build
+        report_class = self.class.to_s
+        args_json = @args.to_json
+
+        # Check report if it already in progress and tring return its job_id...
+        job_id = ReportJob.enqueued?(report_class, args_json).try(:meta_id)
+        
+        # ...and start new job otherwise
+        ReportJob.enqueue(report_class, args_json) unless job_id
+      end
+
+      def_delegators :@cache_file, :filename, :exists?
+
+      protected
+
+      # You must use ancestor methods to work with report data:
+      #   1) get_data => returns Enumerable of report source objects
+      #   2) build_table_header => returns Array of report column names
+      #   3) build_table_row(object) => returns Array of report cell values (same order as header)
+      def write(io)
+        raise NotImplementedError, "write must be implemented in successor"          
+      end
+      
+      def column(name, value)
+        add_column_header(name) || add_column_cell(value)
+      end
+
+      private
+
+      def_delegators 'self.class',
+                     :directory, 
+                     :extension, 
+                     :encoding,
+                     :get_data, 
+                     :build_table_header, 
+                     :build_table_row,
+                     :header_collecting, 
+                     :row_object,
+                     :create_block
+
+      # Fill report table #
+
+      def init_table
+        @table_header = []
+        @table_row = []
+      end
+
+      def add_column_header(column_name)
+        @table_header << column_name if header_collecting
+      end
+
+      def add_column_cell(column_value)
+        return if header_collecting
+        column_value = send(column_value, row_object) if column_value.is_a? Symbol
+        @table_row << encoded_string(value)
+      end
+
+      def encoded_string(obj)
+        obj.to_s.encode(encoding, :invalid => :replace, :undef => :replace)
+      end
+
+      def finish_row
+        @table_row = []
+      end
+
+      # Generate filename #
+      
+      def generate_filename
+        "#{ self.class }-#{ hash_args }.#{ extension }"
+      end
+
+      def hash_args
+        Digest::SHA1.hexdigest(@args.to_json)
+      end
+    end # class BaseReport
+  end # module Report
+end # module Resque

data/lib/resque/reports/cache_file.rb

@@ -0,0 +1,70 @@
+# coding: utf-8
+module Resque
+  module Reports
+    class CacheFile
+
+      DEFAULT_EXPIRE_TIME = 1.day
+      DEFAULT_CODING = 'utf-8'
+
+      # TODO: Description!
+      def initialize(dir, filename, options = {})
+        @dir = dir
+        @filename = File.join(dir, filename)
+
+        # options
+        @coding = options[:coding] || DEFAULT_CODING
+        @expiration_time = options[:expire_in] || DEFAULT_EXPIRE_TIME
+      end
+
+      def exists?
+        File.exists?(@filename)
+      end
+      alias_method :exists?, :ready?
+
+      def filename
+        raise "File doesn't exists, check for its existance before" unless exists?
+        @filename
+      end
+
+      def open
+        prepare_cache_dir
+
+        remove_unfinished_on_error do
+          File.open(@filename, @coding) do |file|
+            yield file
+          end
+        end
+      end
+
+      protected
+
+      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
+        files_to_delete = cache_files_array.select { |fname| expired?(fname) }
+
+        FileUtils.rm_f files_to_delete
+      end
+
+      def expired?(fname)
+        File.file?(fname) && File.mtime(fname) + @expiration_time < Time.now
+      end
+
+      def cache_files_array
+        Dir.new(@dir).map { |fname| File.join(@dir.path, fname) }
+      end
+
+      def remove_unfinished_on_error
+        yield
+      rescue => error
+        FileUtils.rm_f @filename # remove everything that was written due to it inconsistance
+        raise error # don't suppress any errors here
+      end
+    end
+  end
+end

data/lib/resque/reports/callbacks.rb

@@ -0,0 +1,50 @@
+# coding: utf-8
+module Resque
+  module Reports
+    module Callbacks
+
+      # TODO: сделать гибкой логику колбеков и хендлеров
+    	module ClassMethods
+        protected
+
+    	  PROGRESS_INTERVAL = 10
+
+        # Callbacks
+
+        # rubocop:disable TrivialAccessors
+
+        # Set callback for watching progress of export
+        # @yield [progress] block to be executed on progress
+        # @yieldparam progress [Integer] current progress
+        # @yieldparam total [Integer] data length
+        def on_progress(&block)
+          @progress_callback = block
+        end
+
+        # Set callback on error
+        # @yield [error] block to be executed when error occurred
+        # @yieldparam [Exception] error
+        def on_error(&block)
+          @error_callback = block
+        end
+
+        # rubocop:enable TrivialAccessors
+
+        # Handlers
+        def handle_progress(progress, force = false)
+          if @progress_callback && (force || progress % self.class::PROGRESS_INTERVAL == 0)
+            @progress_callback.call progress, @data.size
+          end
+        end
+
+        def handle_error
+          @error_callback ? @error_callback.call($ERROR_INFO) : raise
+        end
+      end    	
+    end
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+  end
+end

data/lib/resque/reports/csv_report.rb

@@ -0,0 +1,60 @@
+# coding: utf-8
+module Resque
+  module Reports
+    class CsvReport < BaseReport
+      extend Forwardable
+      include Callbacks # include on_progress, on_error callbacks, and handle_progress, handle_errors handlers
+
+      class << self
+        attr_accessor :csv_options
+      end 
+
+      DEFAULT_CSV_OPTIONS = { col_sep: ';', row_sep: "\r\n" }
+
+      extension :csv
+
+      def_delegator 'self.class', :csv_options
+
+      def initialize(*args)
+        csv_options = DEFAULT_CSV_OPTIONS.merge(csv_options)
+        super(*args)
+      end
+
+      # Callbacks
+      on_progress { |progress, total| at(progress, total, progress_message(progress, total)) }
+      on_error { |error| raise error }
+
+      # You must use ancestor methods to work with data:
+      #   1) get_data => returns Enumerable of source objects
+      #   2) build_table_header => returns Array of column names
+      #   3) build_table_row(object) => returns Array of cell values (same order as header)
+      def write(io)        
+        progress = 0
+
+        CSV(io, csv_options) do |csv|
+          data_collection = get_data
+          
+          if data_collection.size > 0
+            write_line csv, build_table_header
+
+            data_collection.each do |data_element|
+              begin
+                write_line csv, build_table_row(data_element)
+              rescue
+                handle_error
+              end
+
+              handle_progress(progress += 1)
+            end
+
+            handle_progress(progress, true)
+          end
+        end       
+      end
+
+      def write_line(csv, row_cells)
+        csv << row_cells
+      end
+    end # class CsvReport
+  end # module Report
+end # module Resque

data/lib/resque/reports/encodings.rb

@@ -0,0 +1,13 @@
+# coding: utf-8
+module Resque
+  module Reports
+  	module Encodings
+  		def self.included(base)
+  			base.class_eval do 
+          CP1251 = 'w:windows1251'
+          UTF8 = 'utf-8'
+  			end
+  		end  		
+  	end
+  end
+end

data/lib/resque/reports/version.rb

@@ -0,0 +1,5 @@
+module Resque
+  module Reports
+    VERSION = "0.0.1"
+  end
+end

data/lib/resque/reports.rb

@@ -0,0 +1,18 @@
+# coding: utf-8
+require 'forwardable'
+require 'facets/kernel/constant'
+
+require 'resque-integration'
+
+require 'resque/reports/version'
+require 'resque/reports/cache_file'
+require 'resque/reports/callbacks'
+require 'resque/reports/encodings'
+require 'resque/reports/base_report'
+require 'resque/reports/csv_report'
+
+module Resque
+  module Reports
+
+  end
+end

data/lib/resque-reports.rb

@@ -0,0 +1,2 @@
+# coding: utf-8
+require 'resque/reports'

data/resque-reports.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'resque/reports/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'resque-reports'
+  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.homepage      = 'https://github.com/sclinede/resque-reports'
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  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_development_dependency "bundler", "~> 1.3"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency 'rspec'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,75 @@
+# -*- encoding : utf-8 -*-
+# - Sort through your spec_helper file. Place as much environment loading
+#   code that you don't normally modify during development in the
+#   Spork.prefork block.
+# - Place the rest under Spork.each_run block
+# - Any code that is left outside of the blocks will be ran during preforking
+#   and during each_run!
+# - These instructions should self-destruct in 10 seconds.  If they don't,
+#   feel free to delete them.
+require 'spork'
+
+Spork.prefork do
+  require 'active_support'
+  # Loading more in this block will cause your tests to run faster. However,
+  # if you change any configuration or code from libraries loaded here, you'll
+  # need to restart spork for it take effect.
+  # This file is copied to spec/ when you run 'rails generate rspec:install'
+  ENV['RAILS_ENV'] ||= 'test'
+
+  FileUtils.cp(File.expand_path('../../../../../config/sphinx.yml', __FILE__), File.expand_path('../dummy/config/sphinx.yml', __FILE__))
+
+  require File.expand_path('../dummy/config/application', __FILE__)
+  require "#{Rails.application.paths.vendor.plugins.first}/core_domains/lib/core/domains/testing/test_helper"
+  require File.expand_path('../dummy/config/environment', __FILE__)
+  require 'rspec/rails'
+  require 'rspec/autorun'
+  require 'factory_girl'
+  require 'shoulda-matchers'
+  require 'capybara/rails'
+  require 'capybara/rspec'
+
+  # Requires supporting ruby files with custom matchers and macros, etc,
+  # in spec/support/ and its subdirectories.
+  Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+  Dir["#{Rails.application.paths.vendor.plugins.first}/core/spec/support/**/*.rb"].each { |f| require f }
+  Dir["#{File.dirname(__FILE__)}/factories/**/*.rb"].each { |f| require f }
+
+  use_plugin_support
+  use_plugin_factories
+
+  RSpec.configure do |config|
+    # ## Mock Framework
+    #
+    # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+    #
+    # config.mock_with :mocha
+    # config.mock_with :flexmock
+    # config.mock_with :rr
+
+    # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+    config.fixture_path = "#{File.dirname(__FILE__)}/fixtures"
+
+    # If you're not using ActiveRecord, or you'd prefer not to run each of your
+    # examples within a transaction, remove the following line or assign false
+    # instead of true.
+    config.use_transactional_fixtures = true
+
+    # If true, the base class of anonymous controllers will be inferred
+    # automatically. This will be the default behavior in future versions of
+    # rspec-rails.
+    config.infer_base_class_for_anonymous_controllers = false
+
+    if ENV['CI'].present?
+      config.color_enabled = true
+      config.tty = true
+      config.formatter = :documentation
+    end
+
+    config.backtrace_clean_patterns = []
+  end
+end
+
+Spork.each_run do
+  # This code will be run each time you run your specs.
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: resque-reports
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Sergey D.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: resque-integration
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.9
+- !ruby/object:Gem::Dependency
+  name: facets
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.9.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.9.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Make your custom reports to CSV with resque by simple DSL
+email:
+- sclinede@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- MIT-LICENSE
+- README
+- Rakefile
+- app/jobs/resque/reports/report_job.rb
+- init.rb
+- lib/resque-reports.rb
+- lib/resque/reports.rb
+- lib/resque/reports/base_report.rb
+- lib/resque/reports/cache_file.rb
+- lib/resque/reports/callbacks.rb
+- lib/resque/reports/csv_report.rb
+- lib/resque/reports/encodings.rb
+- lib/resque/reports/version.rb
+- resque-reports.gemspec
+- spec/spec_helper.rb
+homepage: https://github.com/sclinede/resque-reports
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: resque-reports 0.0.1
+test_files:
+- spec/spec_helper.rb
+has_rdoc: