useful_renderers 0.0.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 63c4b461671436a8635c0dcb32cf225d0e348ce6
-  data.tar.gz: 8372d535dd0b4a04a083d2c7fc9cb326d436f039
+SHA256:
+  metadata.gz: b45070a2de797541d5adc36450bb071956c65b10d1318f33d891334e01493bdb
+  data.tar.gz: 42c7b8e6c222f43d719caf545b4cdfa99d3dece8b205a1d8ad622dd8f3acaa79
 SHA512:
-  metadata.gz: 2c5d3fd4049896dc2309faf428467de4486dd9e8c190f71d16bab39a5bc7f5b6483d213f05357e3a3d3dbfdb8155b0d8f3c60b9e696c9fb63c251eee104c7981
-  data.tar.gz: 36bd0e1b55359baf50e907a6eba4f4d846c0c4d6edfad8360fa6e604e268181263014c473d4be760a8d77ee9c81a708ec7d3d015308ec3e42f31b199452ef42c
+  metadata.gz: 594e329714e524b8d006e1a4d5e53e1f97fae8aff7f65b17a7da753f183f3c5594f32ab744a4052e2c8c66de1b14d12cf79b8aad8cbf471a7904f7c48f3753c9
+  data.tar.gz: d096a66632c5a9e8b7c75dfd4b8a9fb9170be3c0a399d8b9707ca16b8918932305016fe577b682b7c3058e827f6df7994c554fe30317ef51af07d3f759a510d7

data/.gitignore

@@ -1,7 +1,7 @@
 .DS_Store
 /.bundle/
 /.yardoc
-/Gemfile.lock
+Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/

data/README.md

@@ -1,10 +1,9 @@
 # UsefulRenderers
 
-<!-- [![Build Status](https://travis-ci.org/beerlington/render_csv.png?branch=master)](https://travis-ci.org/beerlington/render_csv)
-[![Gem Version](https://badge.fury.io/rb/render_csv.png)](http://badge.fury.io/rb/render_csv)
-[![Code Climate](https://codeclimate.com/github/beerlington/render_csv.png)](https://codeclimate.com/github/beerlington/render_csv)
-[![Dependency Status](https://gemnasium.com/beerlington/render_csv.png)](https://gemnasium.com/beerlington/render_csv)
- -->
+[![Gem Version](https://badge.fury.io/rb/useful_renderers.svg)](http://badge.fury.io/rb/useful_renderers)
+[![Code Climate](https://codeclimate.com/github/blueberryapps/useful_renderers/badges/gpa.svg)](https://codeclimate.com/github/blueberryapps/useful_renderers)
+[![Dependency Status](https://gemnasium.com/blueberryapps/useful_renderers.svg)](https://gemnasium.com/blueberryapps/useful_renderers)
+
 Rails renderers
 
 - CSV renderer for ActiveRecord collections
@@ -84,30 +83,24 @@ end
 
 ```ruby
 respond_to do |format|
-  format.csv  { render csv: @locations, only: [:address, :zip] }
+  format.csv  { render csv: @locations, only: [:address, :zip, 'country.state'] }
 end
 ```
 
-### Add methods as columns
-
-```ruby
-respond_to do |format|
-  format.csv  { render csv: @locations, add_methods: [:method1, :method2] }
-end
-```
+### Translate headers
 
-### Add methods as columns and exclude columns
+Using `Class.human_attribute_name(column_name)`
 
 ```ruby
 respond_to do |format|
-  format.csv  { render csv: @locations, except: [:id], add_methods: [:method1, :method2] }
+  format.csv  { render csv: @locations, translate: true }
 end
 ```
 
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/useful_renderers/fork )
+1. Fork it ( https://github.com/blueberryapps/useful_renderers/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/useful_renderers.rb

@@ -11,14 +11,14 @@ module UsefulRenderers
         filename = options[:filename] || options[:template]
         csv.extend UsefulRenderers::CsvRenderable
         data = csv.respond_to?(:to_csv) ? csv.to_csv(options) : csv
-        send_data data, type: Mime::CSV, disposition: "attachment; filename=#{filename}.csv"
+        send_data data, type: Mime[:csv], disposition: "attachment; filename=#{filename}.csv"
       end
 
-      ActionController.add_renderer :zip do |csv, options|
+      ActionController.add_renderer :zip do |zip, options|
         filename = options[:filename] || options[:template]
-        csv.extend UsefulRenderers::ZipRenderable
-        data = csv.respond_to?(:to_zip) ? csv.to_csv(options) : csv
-        send_data data, type: Mime::Zip, disposition: "attachment; filename=#{filename}.zip"
+        zip.extend UsefulRenderers::ZipRenderable
+        data = zip.respond_to?(:to_zip) ? zip.to_zip(options) : zip
+        send_data data, type: 'application/zip', disposition: "attachment; filename=#{filename}.zip"
       end
 
     end

data/lib/useful_renderers/csv_renderable.rb

@@ -5,19 +5,17 @@ module UsefulRenderers
 
     # Converts an array to CSV formatted string
     # Options include:
-    # :only => [:col1, :col2] # Specify which columns to include
+    # :only => [:col1, :col2]   # Specify which columns to include
     # :except => [:col1, :col2] # Specify which columns to exclude
-    # :add_methods => [:method1, :method2] # Include addtional methods that aren't columns
+    # :translate => boolean     # Translate headers
 
     def to_csv(options = {})
       klass = first.class
       return '' if empty?
       return join(',') unless klass.respond_to? :column_names
 
-      columns = klass.column_names
-      columns &= options[:only].map(&:to_s)        if options[:only]
-      columns -= options[:except].map(&:to_s)      if options[:except]
-      columns += options[:add_methods].map(&:to_s) if options[:add_methods]
+      columns = options[:only] ? options[:only].map(&:to_s) : klass.column_names
+      columns -= options[:except].map(&:to_s) if options[:except]
 
       headers = columns.dup
       headers.map!{|col| klass.human_attribute_name col } if options[:translate]
@@ -30,7 +28,9 @@ module UsefulRenderers
 
       CSV.generate(csv_options) do |row|
         self.each do |obj|
-          row << columns.map { |c| obj.send(c) }
+          row << columns.map do |column|
+            column.to_s.split('.').inject(obj) { |o, m| o.try(m) }
+          end
         end
       end
     end

data/lib/useful_renderers/version.rb

@@ -1,3 +1,3 @@
 module UsefulRenderers
-  VERSION = "0.0.2"
+  VERSION = "0.2.0"
 end

data/spec/lib/csv_renderable_spec.rb

@@ -44,12 +44,21 @@ describe UsefulRenderers::CsvRenderable do
       end
     end
 
+    context 'options with :only param including methods' do
+      it 'returns only columns specified' do
+        options = { only: [:name, :human_age] }
+
+        expect(csv_renderable_array.to_csv(options))
+          .to eql "name,human_age\nO'Connor,25\nRuby,25\nShelby,33\n"
+      end
+    end
+
     context 'options with :exclude param' do
       it 'excludes columns specified' do
         options = { except: [:age] }
 
         expect(csv_renderable_array.to_csv(options))
-          .to eql "id,name,weight\n7,O'Connor,76.8\n8,Ruby,68.2\n9,Shelby,64.0\n"
+          .to eql "id,name,weight\n#{sebastian.id},O'Connor,76.8\n#{ruby.id},Ruby,68.2\n#{shelby.id},Shelby,64.0\n"
       end
     end
 
@@ -58,7 +67,7 @@ describe UsefulRenderers::CsvRenderable do
         options = { add_methods: [:human_age] }
 
         expect(csv_renderable_array.to_csv(options))
-          .to eql "id,name,age,weight,human_age\n10,O'Connor,3,76.8,25\n11,Ruby,3,68.2,25\n12,Shelby,5,64.0,33\n"
+          .to eql "id,name,age,weight,human_age\n#{sebastian.id},O'Connor,3,76.8,25\n#{ruby.id},Ruby,3,68.2,25\n#{shelby.id},Shelby,5,64.0,33\n"
       end
     end
 
@@ -75,7 +84,7 @@ describe UsefulRenderers::CsvRenderable do
       it 'translate header with human_attribute_name' do
         options = { only: [:id, :name], translate: true }
         expect(csv_renderable_array.to_csv(options))
-          .to eql "Id,Dog name\n16,O'Connor\n17,Ruby\n18,Shelby\n"
+          .to eql "Id,Dog name\n#{sebastian.id},O'Connor\n#{ruby.id},Ruby\n#{shelby.id},Shelby\n"
       end
     end
   end

data/useful_renderers.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'rails', '>= 3.0'
+  spec.add_dependency 'rails', '>= 5.0'
   spec.add_dependency 'rubyzip', '>= 1.0.0'
 
   spec.add_development_dependency 'rspec-rails', '>= 2.12'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: useful_renderers
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Ondrej Bartas
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-12-04 00:00:00.000000000 Z
+date: 2020-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
@@ -139,7 +139,7 @@ homepage: ''
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -154,9 +154,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.0.1
+signing_key:
 specification_version: 4
 summary: Adds a custom CSV and ZIP renderer to Rails applications
 test_files: