tramway-export 0.1.0.1 → 0.1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8a28bffa99e723823389b97dc255132840d45082e6cd1983a76e2c28f678196
-  data.tar.gz: 107fa809104440a7c3fb9528dbd21750b5e62fac72eba2da8bc1237c8df89202
+  metadata.gz: f81d260bc4a950883e9aa07590b826cd222c640d314bd2126032f95e2a0f2d90
+  data.tar.gz: f24f5e6c3ce21b57026ef7cfb92e700414151b311406bdfe79d78b5a8b6f5df0
 SHA512:
-  metadata.gz: 2caa6491848f3f0398295f35d80f03d621b8ca02fab4b8847132ea63948fb4f571917391b694ca67dea210a0cf254217ada1e226f34362e59342b216eb7f489f
-  data.tar.gz: 71e40c79c77e859c0d3848c26e76426116dae437e05147e5f19c53aa8a78d9e42a2866698c793283f7be2025dfb99aa3039b9f162af1d9425caa63b273f20111
+  metadata.gz: '095b3def7d0dff5635ff436b9ae49a2fca7c29846aa3adc944825ba968c83814cf3faca6fd63dddd373d5d6e383dc194ff12a10e4729e68d4705ef12192dfb6e'
+  data.tar.gz: f9a708408a6e9b37d2cb86272b6ecdc088d2f0e3031077384bfd45ed03ea4969cb4e69767272fcde2d621c59ecbc9ad1b5b4fa4575994cfa8a7caddfb13e5fc0

data/README.md

@@ -1,26 +1,63 @@
 # Tramway::Export
-Short description and motivation.
 
-## Usage
-How to use my plugin.
+Plugin for tramway-admin gem. Provides exporting collections to Excel files.
 
-## Installation
-Add this line to your application's Gemfile:
+## Installation & Usage
+
+#### 1. Add this line to your application's Gemfile:
 
 ```ruby
+gem 'tramway-admin'
 gem 'tramway-export'
 ```
 
-And then execute:
+##### 2. And then execute:
 ```bash
 $ bundle
 ```
 
-Or install it yourself as:
-```bash
-$ gem install tramway-export
+#### 3. Add exportable models to tramway initializer
+
+*config/initializers/tramway.rb*
+
+```ruby
+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}_xlsx_decorator.rb`
+
+
+*app/decorators/your_model_xlsx_decorator.rb*
+
+```ruby
+class YourModelXlsxDecorator < Tramway::Export::Xlsx::ApplicationDecorator
+  class << self
+    def columns
+      %i[column1 column2 column3] # here array of strings or symbols with columns names. It'll be used as headers in Excel file 
+    end
+    
+    def filename
+      `your_file_name.xlsx`
+    end
+  end
+  
+  def column1
+    # getting value
+  end
+  
+  def column2
+    # getting value
+  end
+  
+  def column3
+    # getting value
+  end
+end
+```
+
+#### 5. Restart your server and visit index page of models in your admin panel
+
+
 ## Contributing
 Contribution directions go here.
 

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

@@ -1,4 +1,4 @@
-- if Tramway::Export.exportable_model? model_class, project: @application_engine
+- if Tramway::Export.exportable_model? model_class, project: (@application_engine || @application.name)
   - model_name = model_class.name.underscore
   - id = "export-#{model_name}"
   .btn-group{ role: :group }

data/lib/tramway/export/version.rb

@@ -2,6 +2,6 @@
 
 module Tramway
   module Export
-    VERSION = '0.1.0.1'
+    VERSION = '0.1.0.2'
   end
 end

data/lib/tramway/export.rb

@@ -13,6 +13,7 @@ module Tramway
 
       def exportable_model?(model_class, project:)
         return false unless project.present?
+
         @exportable_models[project.to_sym]&.include? model_class
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tramway-export
 version: !ruby/object:Gem::Version
-  version: 0.1.0.1
+  version: 0.1.0.2
 platform: ruby
 authors:
 - Pavel Kalashnikov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-11 00:00:00.000000000 Z
+date: 2020-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: xls_exporter