lotus_admin 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ad4c293efddd78c53545e0c36f058d03c259751e
-  data.tar.gz: 9698ab1d3491b93ee79a66b6f07d5a163195d07f
+  metadata.gz: 4a9240be9d5d6c8e2984eae7a3fc3f059fd6b853
+  data.tar.gz: f728a8239f07eb2e08708903031b2fbb542dcc4b
 SHA512:
-  metadata.gz: ab59485d6568188378061c231edc6ab033f7fcc15f98c43a41dcfaa7b4bc9980949017a93b720adc75928335191bea352f72fc069c02f3313fd92fe1e72cbca5
-  data.tar.gz: 472832ebb676e795a81d68e896cacb052806f9636dddcd7f6dc6320badf7138c6aae05a19a447b5261a251404bcba838d81612bd252d7c2287d31c415fec9655
+  metadata.gz: b0393e4130d668a2e614404a5c95f46831a113649e5d3d5280e6ba73c6ef2cc1bbbc986f8ddff75457581bb43f723deae40ca546bca7637263dc38fbf2b33667
+  data.tar.gz: 3a7f73827b2a68988937535df3aeba48234f5e9efc68ee2ecf75344a2b1998b772202af5df257dbc4df8c6cd28c5c1b1f3160339f916e683a2d9efa1779a8cad

data/app/controllers/concerns/lotus_admin/file_streamer.rb

@@ -0,0 +1,74 @@
+module LotusAdmin
+  module FileStreamer
+    extend ActiveSupport::Concern
+
+    included do
+      include ActionController::Live
+
+      class_attribute :_exporter_class, instance_accessor: false
+      class_attribute :_exporter_filename, instance_accessor: false
+
+      let(:exporter) { self.class._exporter_class }
+    end
+
+    # Usage
+    #
+    # class LotusAdmin::OrganizationsController < LotusAdmin::AuthenticatedController
+    #   exporter OrganizationExporter
+    #
+    #   # optional filename customization in context of controller
+    #   exports_filename { "organizations-#{ params[:parent_id] }" }
+    # end
+    class_methods do
+      def exporter(exporter_class)
+        self._exporter_class = exporter_class
+      end
+
+      def exports_filename(&block)
+        self._exporter_filename = block
+      end
+    end
+
+    # Usage
+    #
+    # def index
+    #   super do |format|
+    #     format.pdf { ... }
+    #   end
+    # end
+    #
+    # Will automatically stream CSV from configured exporter
+    def index(&block)
+      super do |format|
+        if self.class._exporter_class.present?
+          format.csv do
+            if self.class._exporter_filename.present?
+              filename = instance_exec(&self.class._exporter_filename)
+            end
+
+            filename = "#{ resource_class.model_name.human(count: 2) }-exports-#{ SecureRandom.uuid }" if filename.blank?
+
+            stream_file filename.parameterize, 'csv' do |stream|
+              self.class._exporter_class.stream(ransack_object.result, stream) # full query, not just paginated
+            end
+          end
+        end
+
+        block.call(format) if block.present?
+      end
+    end
+
+    private
+
+    def stream_file(filename, extension, &block)
+      response.headers["Content-Type"] = "application/octet-stream"
+      response.headers["Content-Disposition"] = "attachment; filename=#{filename}.#{extension}"
+
+      begin
+        yield response.stream
+      ensure
+        response.stream.close
+      end
+    end
+  end
+end

data/app/controllers/concerns/lotus_admin/resourceful_controller.rb

@@ -14,4 +14,12 @@ module LotusAdmin::ResourcefulController
       self._resource_class = model_class
     end
   end
+
+  def index(&block)
+    respond_to do |format|
+      format.html
+
+      block.call(format) if block.present?
+    end
+  end
 end

data/app/controllers/lotus_admin/authenticated_controller.rb

@@ -2,6 +2,7 @@ class LotusAdmin::AuthenticatedController < LotusAdmin::ApplicationController
   include LotusAdmin::PermittedParams
   include LotusAdmin::FilterableController
   include LotusAdmin::ResourcefulController
+  include LotusAdmin::FileStreamer
 
   before_action :authenticate_administrator!
   around_action :use_user_time_zone, if: :administrator_signed_in?

data/app/services/lotus_admin/exporter.rb

@@ -0,0 +1,113 @@
+module LotusAdmin
+  class Exporter
+    class_attribute :_columns, instance_accessor: false
+    class_attribute :_decorates, instance_accessor: false
+    class_attribute :_resource_class, instance_accessor: false
+
+    self._columns = []
+    self._decorates = false
+
+    # reset so that each subclass has it's own collection
+    def self.inherited(other)
+      other._columns = []
+    end
+
+    class Column
+      attr_reader :attribute_name, :title, :block
+      def initialize(attribute_name, title, &block)
+        @attribute_name = attribute_name
+        @title = title
+        @block = block || ->(model){ model.public_send(attribute_name) }
+      end
+
+      def data(model)
+        block.call(model)
+      end
+    end
+
+    class << self
+      def stream(*args)
+        new.stream(*args)
+      end
+
+      def generate(*args)
+        new.generate(*args)
+      end
+
+      private
+
+      def column(attribute_name, title = nil, &block)
+        self._columns << Column.new(attribute_name, title, &block)
+      end
+
+      def decorates(boolean)
+        self._decorates = boolean
+      end
+
+      def model(resource_class)
+        self._resource_class = resource_class
+      end
+    end
+
+    def generate(collection)
+      @collection = collection
+
+      CSV.generate do |csv|
+        csv << headers
+
+        content.each do |row|
+          csv << row
+        end
+      end
+    end
+
+    def stream(collection, stream)
+      stream.write CSV.generate_line(headers)
+
+      @collection = collection
+
+      content.each do |row|
+        stream.write CSV.generate_line(row)
+      end
+    end
+
+    private
+
+    def view_context
+      @view_context ||= begin
+        ActionView::Base.new(ActionController::Base.view_paths).tap do |view|
+          view.class_eval do
+            include Rails.application.routes.url_helpers
+            include ::ApplicationHelper if defined?(::ApplicationHelper)
+          end
+        end
+      end
+    end
+
+    def headers
+      self.class._columns.map do |column|
+        column.title.presence || self.class._resource_class.human_attribute_name(column.attribute_name)
+      end
+    end
+
+    def content
+      each_item.map do |record|
+        record = record.decorate(view_context) if decorator?
+
+        self.class._columns.map do |column|
+          column.data(record)
+        end
+      end
+    end
+
+    def each_item(&block)
+      return @collection.each.lazy unless @collection.respond_to?(:find_each)
+
+      @collection.find_each(batch_size: 500).lazy
+    end
+
+    def decorator?
+      self.class._decorates == true
+    end
+  end
+end

data/app/views/lotus_admin/shared/_collection_pagination.html.haml

@@ -1,7 +1,11 @@
 .row
-  .col-sm-6
+  .col-sm-5
     = paginate(collection, theme: 'lotus_admin')
 
-  .col-sm-6
+  .col-sm-2.text-center
+    - if exporter.present?
+      = link_to 'CSV', url_for(params: { q: params[:q]&.to_unsafe_h }, format: :csv)
+
+  .col-sm-5
     .pagination-info
       %small= page_entries_info(collection)

data/lib/lotus_admin/version.rb

@@ -1,3 +1,3 @@
 module LotusAdmin
-  VERSION = '0.3.1'
+  VERSION = '0.4.0'
 end

data/lib/lotus_admin.rb

@@ -1,5 +1,7 @@
 require "lotus_admin/engine"
 
+require 'csv'
+
 require 'devise'
 require 'simple_form'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lotus_admin
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Matt Millsaps-Brewer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-05 00:00:00.000000000 Z
+date: 2018-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -344,6 +344,7 @@ files:
 - app/assets/stylesheets/lotus_admin/components/_tables.scss
 - app/controllers/concerns/lotus_admin/devise_controllers.rb
 - app/controllers/concerns/lotus_admin/exposure.rb
+- app/controllers/concerns/lotus_admin/file_streamer.rb
 - app/controllers/concerns/lotus_admin/filterable_controller.rb
 - app/controllers/concerns/lotus_admin/permitted_params.rb
 - app/controllers/concerns/lotus_admin/resourceful_controller.rb
@@ -370,6 +371,7 @@ files:
 - app/models/lotus_admin/application_record.rb
 - app/models/lotus_admin/filters/configuration.rb
 - app/models/lotus_admin/user.rb
+- app/services/lotus_admin/exporter.rb
 - app/views/administrators/_links.html.haml
 - app/views/administrators/confirmations/new.html.haml
 - app/views/administrators/passwords/edit.html.haml