tramway-export 0.1.4 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af9b78d49eec7bcdbcf6b11f6c173748d889c209dee386ec33f318b643436fa8
-  data.tar.gz: 3c1546aed1ee45a57546ecc5f32a2161c306fdf580227ade54425f3afd895957
+  metadata.gz: 8629ca9795a930ddd76a2838536e4dca3d116a21fded0978ad8278b366e0d9d3
+  data.tar.gz: 178e67ebb1b2cce89b9ab863190151dedb5e93aa8924c019c0e0fc1042d96a81
 SHA512:
-  metadata.gz: 633a6472e18d8142213e8c4cbe64dc8959a05cf8ac1ef38ac2853df4d200cc651f33feaf24b3625e3ba9dfdbda7a114840ed67697ad9f4a769caf030192ee46b
-  data.tar.gz: 9cc083bf8bf268bb4512b4ea103624ca52b55eb2321fa329b3ef2bf358ae9e46da63ecf6e742179744a495c6be4606e458caa98f8dbfa4ed339c057f08892a9c
+  metadata.gz: b6501955c42631a2607883c0a6ddd44443646ce35f090d4dface449d496906bf045ef7fdae7bd227b81c95230cea6c4e0088c3a1906c0bfdc16a1adac1e7d033
+  data.tar.gz: b8ec8841c5c3a493a54509030ed17c9b063c7922f58c4aad2900de771a82a26bcf1ebee6ace7acd39fd42aab55114e6f710d5c7215f61a44e211f4ac2ead63c2

data/README.md

@@ -26,6 +26,7 @@ Tramway::Export.set_exportable_models YourModel, project: :your_project_name
 
 #### 4. Create decorator that describes, how your model should be exported. You need to create exactly decorator name `app/decorators/#{your_model_name}_xls_decorator.rb`
 
+**If you have constant list of columns just use `columns` method this way**
 
 *app/decorators/your_model_xls_decorator.rb*
 
@@ -54,6 +55,20 @@ class YourModelXlsDecorator < Tramway::Export::Xls::ApplicationDecorator
   end
 end
 ```
+**If you don't have constant list of columns, use `flexible_columns` this way**
+
+Just imagine: our model contains method `values` and we want to have columns according to `values` keys. You shouldn't create methods for every column. Just use `Proc`. It's provided by gem `xls_exporter`. You can read more about [here](https://github.com/kalashnikovisme/xls-exporter).
+
+*app/decorators/your_model_xls_decorator.rb*
+```ruby
+class YourModelXlsDecorator < Tramway::Export::Xls::ApplicationDecorator
+  def flexible_columns
+    object.values.keys.map do |key|
+      { key.to_sym => -> { object.values.dig(key) } }
+    end
+  end
+end
+```
 
 #### 5. Restart your server and visit index page of models in your admin panel
 

data/app/controllers/tramway/export/exports_controller.rb

@@ -3,13 +3,13 @@
 require 'xls_exporter'
 
 class Tramway::Export::ExportsController < Tramway::Admin::ApplicationController
-  def show
+  def index
     scope = params[:scope].present? ? params[:scope] : :all
     model_class = model_class_name(params[:model])
     xls_decorator_class = xls_decorator_class_name(params[:model])
     records = model_class.active.order(id: :desc).send scope
     records = records.ransack(params[:filter]).result if params[:filter].present?
-    records = records.send "#{current_user.role}_scope", current_user.id
+    records = records.send "#{current_admin.role}_scope", current_admin.id
     records = xls_decorator_class.decorate records
 
     columns = xls_decorator_class.columns + records.map(&:flexible_columns).flatten.uniq do |hash|
@@ -17,6 +17,8 @@ class Tramway::Export::ExportsController < Tramway::Admin::ApplicationController
     end
 
     book = ::XlsExporter.export do
+      default_style horizontal_align: :center, vertical_align: :center, text_wrap: true
+
       add_sheet 'List'
 
       export_models records, *columns
@@ -26,9 +28,48 @@ class Tramway::Export::ExportsController < Tramway::Admin::ApplicationController
     send_data stream.string, content_type: 'application/xls', filename: xls_decorator_class.filename
   end
 
+  def show
+    head(:unprocessable_entity) && return unless available?
+
+    model_class = model_class_name(params[:model])
+    xls_collection_decorator_class = xls_collection_decorator_class_name(params[:model], params[:collection])
+    records = model_class.find(params[:id]).send(params[:collection]).active.order(id: :desc)
+    records = records.send "#{current_admin.role}_scope", current_admin.id
+    records = xls_collection_decorator_class.decorate records
+
+    columns = xls_collection_decorator_class.columns + records.map(&:flexible_columns).flatten.uniq do |hash|
+      hash&.keys&.first
+    end
+
+    book = ::XlsExporter.export do
+      default_style horizontal_align: :center, vertical_align: :center, text_wrap: true
+
+      add_sheet xls_collection_decorator_class.sheet_name
+
+      export_models records, *columns
+    end
+    stream = StringIO.new
+    book.write stream
+    send_data stream.string, content_type: 'application/xls', filename: xls_collection_decorator_class.filename
+  end
+
   private
 
   def xls_decorator_class_name(model_name)
     "#{model_name}XlsDecorator".constantize
   end
+
+  def xls_collection_decorator_class_name(model_name, collection)
+    "#{model_name}::#{collection.camelize}XlsDecorator".constantize
+  end
+
+  def available?
+    if params[:collection].present?
+      ::Tramway::Export.exportable_model?(params[:model], project: @application.name) && Tramway::Export.exportable_models(project: @application.name)&.map do |config|
+        config.is_a?(Hash) && config.values.first.map(&:to_s).include?(params[:collection])
+      end&.include?(true)
+    else
+      ::Tramway::Export.exportable_model?(params[:model], project: @application.name)
+    end
+  end
 end

data/app/decorators/tramway/export/application_decorator.rb

@@ -6,6 +6,8 @@ class Tramway::Export::ApplicationDecorator
   end
 
   class << self
+    include Tramway::Core::Delegating::ClassHelper
+
     def columns
       []
     end

data/app/decorators/tramway/export/xls/application_decorator.rb

@@ -4,6 +4,9 @@ module Tramway
   module Export
     module Xls
       class ApplicationDecorator < Tramway::Export::ApplicationDecorator
+        def flexible_columns
+          []
+        end
       end
     end
   end

data/app/views/tramway/export/_button.html.haml

@@ -6,4 +6,4 @@
       = fa_icon(:download)
     .dropdown-menu{ aria: { labelledby: id } }
       - decorator_class.collections.each do |collection|
-        = link_to collection_human_name(model_name: model_name, collection_name: collection), Tramway::Export::Engine.routes.url_helpers.exports_path(model: model_class, scope: collection, filter: params[:filter]&.permit!), class: 'dropdown-item'
+        = link_to collection_human_name(model_name: model_name, collection_name: collection), Tramway::Export::Engine.routes.url_helpers.exports_path(model: model_class, scope: collection, filter: params[:filter].present? ? params[:filter].permit! : nil), class: 'dropdown-item'

data/config/routes.rb

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
 Tramway::Export::Engine.routes.draw do
-  resources :exports, only: [] do
-    collection do
-      get :show
-    end
-  end
+  resources :exports, only: [ :show, :index ]
 end

data/lib/tramway/export.rb

@@ -7,18 +7,19 @@ module Tramway
     class << self
       def set_exportable_models(*models, project:)
         @exportable_models ||= {}
-        @exportable_models[project] ||= []
-        @exportable_models[project] += models
+        @exportable_models[project.to_sym] ||= []
+        @exportable_models[project.to_sym] += models
+      end
+
+      def exportable_models(project:)
+        @exportable_models[project.to_sym]
       end
 
       def exportable_model?(model_class, project:)
         return false unless project.present?
 
-        @exportable_models[project.to_sym]&.include? model_class
-      end
-
-      def exportable_models
-        @exportable_models
+        @exportable_models[project.to_sym]&.include?(model_class) ||
+          @exportable_models[project.to_sym].map { |config| config.is_a?(Hash) && config.keys.first.to_s == model_class.to_s }.include?(true)
       end
     end
   end

data/lib/tramway/export/version.rb

@@ -2,6 +2,6 @@
 
 module Tramway
   module Export
-    VERSION = '0.1.4'
+    VERSION = '0.2'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tramway-export
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: '0.2'
 platform: ruby
 authors:
 - Pavel Kalashnikov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-03 00:00:00.000000000 Z
+date: 2021-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: xls_exporter
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.2'
 description: Rails engine for exporting data
 email:
 - kalashnikovisme@gmail.com
@@ -69,7 +69,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Rails engine for exporting data