xport 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6e0b568866d5b2f9c8680d14fe7266ec09b5eb32
+  data.tar.gz: 5051b3e1619135362ec775465583ba1b700621b1
+SHA512:
+  metadata.gz: ef2450eb7859f679931eb58b9eaf05fa7d97cd90ca16f850b8190885be4d099dd2cd15b2c0c525df6058d21fb2a6cdd451ebb3ef49959e07a529ac2e755818ab
+  data.tar.gz: 01022f1cea1427d8faf3b512759c13a52a86910be75cc64cf44b38b822b8cc0535db9f3726041d038ddcb6453b50366aca1ba1a5d735a3803cbcb169a39b72cb

data/lib/generators/xport/install/install_generator.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Xport
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      def self.next_migration_number(dirname)
+        if ActiveRecord::Base.timestamped_migrations
+          Time.new.utc.strftime("%Y%m%d%H%M%S")
+        else
+          format("%.3d", current_migration_number(dirname) + 1)
+        end
+      end
+
+      def create_migrations
+        migration_template 'migration.rb', 'db/migrate/create_downloads.rb'
+      end
+    end
+  end
+end

data/lib/generators/xport/install/templates/migration.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class CreateDownloads < ActiveRecord::Migration
+  def up
+    create_table :downloads do |t|
+      t.string   :user_id
+      t.string   :file_filename
+      t.string   :filename
+      t.string   :job_id
+      t.string   :export_klass_name
+      t.string   :export_model_name
+      t.text     :query
+      t.integer  :records_count
+      t.datetime :exported_at
+      t.string   :export_additional_columns, array: true, default: []
+      t.timestamps
+    end
+  end
+
+  def down
+    drop_table :downloads
+  end
+end

data/lib/xport/axlsx.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Xport
+  module Axlsx
+    def to_xlsx(&block)
+      formatter = Xport::Axlsx::Formatter.new(self)
+      to_file(formatter, &block)
+    end
+
+    class Formatter
+      attr_reader :export, :workbook, :worksheet
+
+      delegate :builder, to: :export
+
+      def initialize(export)
+        @export    = export
+        @package   = ::Axlsx::Package.new
+        @workbook  = @package.workbook
+        @worksheet = @workbook.add_worksheet
+
+        # Support Numbers and multiline strings in Excel Mac 2011
+        # https://github.com/randym/axlsx/issues/252
+        @package.use_shared_strings = true
+      end
+
+      def to_file
+        @package.to_stream
+      end
+
+      def add_header_row(row)
+        worksheet.add_row row, style: header_style
+      end
+
+      def add_row(row)
+        values = row.map { |v| v.is_a?(Xport::Cell) ? v.value : v }
+        axlsx_row = worksheet.add_row(values, style: styles, types: builder.types)
+        row.each.with_index do |cell, i|
+          next unless cell.is_a?(Xport::Cell)
+          axlsx_cell = axlsx_row.cells[i]
+          axlsx_cell.color = cell.color
+          if cell.comment
+            worksheet.add_comment(
+              ref: axlsx_cell.reference(false),
+              author: 'Conditions',
+              text: cell.comment,
+              visible: false
+            )
+          end
+        end
+      end
+
+      def merge_header_cells(range)
+        worksheet.merge_cells worksheet.rows.first.cells[range]
+      end
+
+      def column_widths(*widths)
+        worksheet.column_widths(*widths)
+      end
+
+      private
+
+      def styles
+        @styles ||= builder.styles.map do |options|
+          workbook.styles.add_style(options) if options
+        end
+      end
+
+      def header_style
+        @header_style ||= workbook.styles.add_style b: true
+      end
+    end
+  end
+end

data/lib/xport/cell.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Xport
+  class Cell
+    attr_accessor :value, :color, :comment
+  end
+end

data/lib/xport/csv.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Xport
+  module CSV
+    def to_csv(&block)
+      formatter = Xport::CSV::Formatter.new(self)
+      to_file(formatter, &block)
+    end
+
+    class Formatter
+      def initialize(export)
+        @io  = StringIO.new
+        @csv = ::CSV.new(@io)
+      end
+
+      def to_file
+        @io.rewind
+        @io
+      end
+
+      def add_row(row)
+        values = row.map { |v| v.is_a?(Xport::Cell) ? v.value : v }
+        @csv << values
+      end
+      alias_method :add_header_row, :add_row
+
+      def merge_header_cells(range); end
+      def column_widths(*widths); end
+    end
+  end
+end

data/lib/xport/download_presenter.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Xport
+  class DownloadPresenter
+    attr_reader :h
+
+    def initialize(download, h)
+      @download = download
+      @h        = h
+    end
+
+    def progress_bar(job_id)
+      return unless job_id
+      job = Resque::Plugins::Status::Hash.get(job_id)
+      return unless job
+
+      case job.status
+      when Resque::Plugins::Status::STATUS_COMPLETED
+        nil
+      when Resque::Plugins::Status::STATUS_QUEUED
+        progress_bar_pending
+      else
+        h.content_tag(:div, class: 'progress', data: { component: 'Future.ProgressBar' }) do
+          h.content_tag(:div, class: 'progress-bar', style: "width: #{job.pct_complete}%") do
+            "#{job.pct_complete}% #{job.message}"
+          end
+        end
+      end
+    end
+
+    def progress_bar_pending
+      message = I18n.translate(
+        'helpers.progress_bar.please_wait_pending',
+        count: Resque.info[:pending]
+      )
+
+      h.content_tag(:div, class: 'progress', data: { component: 'Future.ProgressBar' }) do
+        h.content_tag(:div, class: 'progress-bar progress-bar-pending', style: 'width: 100%') do
+          h.content_tag(:span, message)
+        end
+      end
+    end
+  end
+end

data/lib/xport/downloads_controller_methods.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Xport
+  module DownloadsControllerMethods
+    extend ActiveSupport::Concern
+
+    included do
+      before_action :set_download, only: %i(show update destroy)
+      before_action :set_downloads, only: :index
+    end
+
+    def index; end
+
+    def show
+      respond_to do |format|
+        format.html do
+          if !request.xhr? && @download.file?
+            redirect_to format: @download.type
+          else
+            render 'show'
+          end
+        end
+
+        format.any(:xlsx, :csv) do
+          send_data @download.file.read, filename: @download.filename
+        end
+      end
+    end
+
+    def update
+      @download.schedule_export!
+      redirect_to @download
+    end
+
+    def destroy
+      @download.destroy
+      redirect_to action: 'index'
+    end
+
+    private
+
+    def resource_class
+      controller_path.classify.constantize
+    end
+
+    def set_download
+      @download = resource_class.find(params[:id])
+    end
+
+    def set_downloads
+      @downloads = resource_class.page(params[:page])
+    end
+  end
+end

data/lib/xport/export.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+module Xport
+  class Export
+    attr_reader :workbook, :objects, :builder
+
+    class_attribute :builder_block
+
+    def self.columns(&block)
+      self.builder_block = block
+    end
+
+    def initialize(objects = [])
+      @objects = objects
+      @builder = Xport::ExportBuilder.new(self, &builder_block)
+    end
+
+    def to_file(formatter = nil, &block)
+      preload!
+      # TODO: There shouldn't be a default formatter
+      formatter ||= Xport::Axlsx::Formatter.new(self)
+      write_contents(formatter, &block)
+      formatter.to_file
+    end
+
+    def object_class
+      self.class.name.sub(/Export/, '').singularize.constantize
+    end
+
+    # TODO: Extract to xport-downloads?
+    def download(filename:, user: nil)
+      return unless objects.respond_to?(:to_sql)
+      download                   = download_class.new
+      download.user              = user
+      download.export_klass_name = self.class.name
+
+      if objects.respond_to?(:model)
+        download.export_model_name = objects.model.name
+      end
+      if respond_to?(:additional_columns)
+        download.export_additional_columns = additional_columns
+      end
+      # TODO: Remove `unprepared_statement` call when `to_sql` is fixed
+      # https://github.com/rails/rails/issues/18379
+      object_class.connection.unprepared_statement do
+        download.query = objects.to_sql
+      end
+      download.filename = filename
+      download.save!
+      download.schedule_export!
+      download
+    end
+
+    def download_class
+      module_name = self.class.to_s.deconstantize
+      if module_name.present?
+        "#{module_name}::Download".constantize
+      else
+        Download
+      end
+    end
+
+    private
+
+    def preload!; end
+
+    def write_contents(formatter, &block)
+      write_header(formatter)
+      write_body(formatter, &block)
+      write_widths(formatter)
+    end
+
+    def write_header(formatter)
+      if builder.grouped?
+        group_row = []
+        builder.groups_with_offset_and_colspan.each do |group, offset, colspan|
+          group_row << human_attribute_name(group)
+          (colspan - 1).times do
+            group_row << nil
+          end
+        end
+        formatter.add_header_row group_row
+
+        builder.groups_with_offset_and_colspan.each do |group, offset, colspan|
+          colspan -= 1
+          formatter.merge_header_cells(offset..offset + colspan)
+        end
+      end
+      formatter.add_header_row header_row
+    end
+
+    def write_body(formatter)
+      each_object do |object, rownum|
+        yield rownum, objects.size if block_given?
+        formatter.add_row object_row(object)
+      end
+    end
+
+    def write_widths(formatter)
+      formatter.column_widths(*builder.widths)
+    end
+
+    def find_in_batches?
+      false
+    end
+
+    def each_object(&block)
+      if find_in_batches?
+        objects.find_each.with_index(&block)
+      else
+        objects.each_with_index(&block)
+      end
+    end
+
+    def header_row
+      builder.headers.map do |name|
+        human_attribute_name(name)
+      end
+    end
+
+    def human_attribute_name(name)
+      return if name.to_s.start_with?('empty')
+
+      klass = object_class
+      case name
+      when String
+        name
+      when Symbol
+        klass.human_attribute_name(name)
+      end
+    end
+
+    def object_row(object)
+      builder.columns.map.with_index do |name, index|
+        block = builder.blocks[index]
+        if block
+          value = instance_exec(object, &block)
+        elsif respond_to?(name, true)
+          value = send(name, object)
+        else
+          value = object.send(name)
+          if respond_to?("convert_#{name}", true)
+            value = send("convert_#{name}", value)
+          end
+        end
+        value
+      end
+    end
+
+    def helper
+      ApplicationController.helpers
+    end
+  end
+end

data/lib/xport/export_builder.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Xport
+  class ExportBuilder
+    attr_reader :export, :columns, :headers, :groups, :styles, :types, :widths, :blocks
+
+    def initialize(export, &block)
+      @export  = export
+      @columns = []
+      @headers = []
+      @groups  = []
+      @styles  = []
+      @types   = []
+      @widths  = []
+      @blocks  = []
+      instance_exec(export, &block)
+    end
+
+    def column(name, type: nil, style: nil, width: nil, header: nil, group: nil, &block)
+      columns << name
+      headers << (header || name)
+      groups  << group
+      types   << type
+      styles  << style
+      widths  << width
+      blocks  << block
+    end
+
+    def grouped?
+      groups.any?
+    end
+
+    def groups_with_offset_and_colspan
+      offset  = 0
+      colspan = 1
+      [].tap do |result|
+        groups.each do |group|
+          last = result.last
+          # check if current group is same as last group
+          if last && last[0] == group
+            # if group is the same, update colspan
+            last[2] += 1
+          else
+            result << [group, offset, colspan]
+          end
+          offset  += 1
+        end
+      end
+    end
+  end
+end

data/lib/xport/export_controller_methods.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Xport
+  module ExportControllerMethods
+    def xport_export(export, filename:)
+      download = export.download(filename: filename, user: current_user)
+      if download
+        redirect_to download
+      else
+        send_data export.to_file.read, filename: filename
+      end
+    end
+  end
+end

data/lib/xport/version.rb

@@ -0,0 +1,3 @@
+module Xport
+  VERSION = "0.1.0"
+end

data/lib/xport.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/class/attribute'
+require 'active_support/core_ext/module/delegation'
+require 'active_support/concern'
+
+require 'xport/version'
+require 'xport/export'
+require 'xport/export_builder'
+require 'xport/cell'
+require 'xport/downloads_controller_methods'
+require 'xport/export_controller_methods'
+require 'xport/download_presenter'
+require 'xport/axlsx'
+require 'xport/csv'
+
+module Xport
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: xport
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Janis Vitols
+- Edgars Beigarts
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: axlsx
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: saxlsx
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/generators/xport/install/install_generator.rb
+- lib/generators/xport/install/templates/migration.rb
+- lib/xport.rb
+- lib/xport/axlsx.rb
+- lib/xport/cell.rb
+- lib/xport/csv.rb
+- lib/xport/download_presenter.rb
+- lib/xport/downloads_controller_methods.rb
+- lib/xport/export.rb
+- lib/xport/export_builder.rb
+- lib/xport/export_controller_methods.rb
+- lib/xport/version.rb
+homepage: 
+licenses: []
+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.6.11
+signing_key: 
+specification_version: 4
+summary: CSV/Excel exports with own DSL and background jobs
+test_files: []