rails_csv_renderer 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 660d1de18d4f98f836f8ece40ad26cfa0a39a075
-  data.tar.gz: 71d8cf91962e28da4c43efee012d2720db554217
+  metadata.gz: be2a02e163df9e40eb13fc2a2f84f4037d1fb1bb
+  data.tar.gz: 2995b56dbdfb98207f1ac9bfb9499e06813b3085
 SHA512:
-  metadata.gz: 874f2818485fe8e655fb0c5d4b161407b7e837777e47431272271a698b9d89d2c43292908b69b7d92dfa9699fcbe8d7f52b9124647344fca52433c4903e76cab
-  data.tar.gz: 032513b1c958d5d2effcec6732fc1ea66fc1f0836a5fcae397673531a8bc934095e39caf37d994ae63f733aa9b485faab92396c1ae5c8e56374a30c21eecf68a
+  metadata.gz: e0c9a2506b68e27c5a67f17020c8a3b520319eb502fab0a7820233bc48c8641b8ddd95d35adb78411cd9eae6c2fa2003e061701c1304eba16a968679f572ad34
+  data.tar.gz: 692e3b63fdfb9305055158a248b171edc0cfe134277a68dceba8d38f544129f88d1ba3fa846be98b48d55967e9d14ce70eb3c7e270f60335556c13f6c2c9920f

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+## 0.2.1
+
+  * Fix: init renderer
+  * Add :columns option
+
+## 0.1.0
+
+  * Initial Release

data/README.md

@@ -52,6 +52,28 @@ Will render a CSV file similar to:
   </tr>
 </table>
 
+### Options
+
+You can pass few options at call of rendrer:
+
+* *:filename* - Name of file. Optional
+* *:csv_options* - Options for CSV generator. [Availible options](http://www.ruby-doc.org/stdlib-2.1.2/libdoc/csv/rdoc/CSV.html#method-c-new). Optional
+* *:columns* - Array of variables and methods. Name of columns will be created based on your translations. Optional
+
+Example
+
+```ruby
+class ReportsController < ApplicationController
+  def index
+    @reports = Report.all
+
+    respond_to do |format|
+      format.csv  { render csv: @reports, filename: 'custom-reports.csv', csv_options: { col_sep: '\t' }, columns: [:created_at, :title] }
+    end
+  end
+end
+```
+
 ### Localize column's names
 
 If you have translations for model's attributes under scope [:activerecord, :attributes, \*model_name\*] names of columns will be
@@ -59,11 +81,11 @@ automatically translated.
 
 ### Customize CSV
 
-To customize your CSV file you should add next methods to model **csv_header**(class method), **csv_row**.
+To customize your CSV file with different methods and name of columns you should add next methods to model **csv_header**(class method), **csv_row**.
 
-**csv_header** should return array with column's titles.
+* **csv_header** should return array with column's titles.
 
-**csv_row** should return array with values for columns.
+* **csv_row** should return array with values for columns.
 
 ```ruby
 class Cat < ActiveRecord::Base

data/lib/rails_csv_renderer/renderable.rb

@@ -7,7 +7,7 @@ module RailsCsvRenderer
     # Options is configuration set for generated CSV file
 
     def to_custom_csv(options = {})
-      csv_options = default_csv_options.merge(options)
+      csv_options = default_csv_options.merge(options[:csv_options] || {})
 
       if is_active_record?
         if !(model.respond_to?(:csv_header) || model.respond_to?(:csv_row)) || model.class_variable_defined?(:@@dynamic_generated_csv_methods)
@@ -30,7 +30,7 @@ module RailsCsvRenderer
     private
 
     def define_csv_methods(options)
-      columns = model.column_names
+      columns = options[:columns] || model.column_names
 
       model.class_variable_set(:@@dynamic_generated_csv_methods, true)
       model.class_eval(%Q{

data/lib/rails_csv_renderer/renderer.rb

@@ -3,12 +3,13 @@ require 'action_controller/metal/renderers'
 
 module RailsCsvRenderer
   class Renderer
-    def initialize!
-      ActionController::Renderers.add :csv do |obj, options|
+    def self.initialize!
+      ActionController::Renderers.add(:csv) do |obj, options|
         filename = options[:filename] || "#{ Rails.application.class.parent_name }-report-#{ Time.current }.csv"
-        csv.extend RailsCsvRenderer::Renderable
-        data = csv.to_custom_csv(options[:csv_options])
-        send_data data, type: Mime::CSV, disposition: "attachment; filename=#{filename}"
+        obj.extend RailsCsvRenderer::Renderable
+        data = obj.to_custom_csv(options)
+        send_data(data, type: Mime::CSV, disposition: "attachment; filename=#{filename}")
+      end
     end
   end
 end

data/lib/rails_csv_renderer/version.rb

@@ -1,3 +1,3 @@
 module RailsCsvRenderer
-  VERSION = "0.1.0"
+  VERSION = "0.2.1"
 end

data/spec/lib/renderable_spec.rb

@@ -60,7 +60,7 @@ describe RailsCsvRenderer::Renderable do
 
         context 'with csv options' do
           it 'includes columns and methods with configured separators' do
-            options = { col_sep: "\t", row_sep: "\r\n" }
+            options = { csv_options: { col_sep: "\t", row_sep: "\r\n" } }
             expect(renderable_collection.to_custom_csv(options)).to eql "Id\tFull name\r\n1\tJohn Smith\r\n2\tAdam Kowalczyk\r\n3\tDennis Menace\r\n"
           end
         end
@@ -73,6 +73,23 @@ describe RailsCsvRenderer::Renderable do
             owner.cats << Cat.first
             expect(renderable_collection.to_custom_csv).to eql "Id,Name,Person\n1,Kitty,#{ owner.id }\n"
           end
+
+          context 'options with :columns' do
+            it 'includes columns and methods in specific order' do
+              options = { columns: [:name] }
+              expect(renderable_collection.to_custom_csv(options)).to eql "Name\nKitty\n"
+            end
+
+            context 'with localized name of atributes' do
+              before { I18n.locale = :ru }
+              after { I18n.locale = :en }
+
+              it 'includes columns and methods in specific order with localized headerd' do
+                options = { columns: [:name] }
+                expect(renderable_collection.to_custom_csv(options)).to eql "Кличка\nKitty\n"
+              end
+            end
+          end
         end
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_csv_renderer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Dennis Sheleh
@@ -61,6 +61,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md