lp_csv_exportable 0.1.6 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27cb7b83786f789431b64a9bbf8873e3123bedcf
-  data.tar.gz: 13706fb398738f69d914c5161a526c9973feb1d7
+  metadata.gz: ffe1ee3b0b2d1e86a1424ffd542e637ee88a91a6
+  data.tar.gz: 25ef7ec02dc545f68235305ebf9f845c635c3cb3
 SHA512:
-  metadata.gz: 4d9d48093288b6d91c293bce15cfc4aad9dc13085be75e2acdb4e6d86fa1ea607a7671bdd7007462fc9bcacdc73421dace781813edbdd6d63f9af031f2df3739
-  data.tar.gz: fc3919e22f6ef0d83a7b57f339880e544f0a6ab0e59d5be21b17868f1f6c9445fd08d8394d46f2605181dd2700e4d6ad25cfac698c34e8181d0fae8248e2a594
+  metadata.gz: 9ae801398f7c3b26cca38295c51d19fb5ee793b020cfc8b65fc9ca54eeaf128ee954ab233f8106bdaf4f4eb668db19eb6597e2c4f94ce68e481209b9b296ee40
+  data.tar.gz: 2910dd27654e9fdc6aa3572ad931373236bba4ae99a1470ce2676c99b3c2eb6647a3b6dfaf739d2af4b5a9308fd78df51608a89caf05a06ecbceb7c7468a8ca4

data/README.md

@@ -22,20 +22,22 @@ Basic Usage
 
 Create a class that includes the module `LpCSVExportable::CanExportAsCSV`
 
-```
+```ruby
 class ExportUsers
   include LpCSVExportable::CanExportAsCSV
 
-  column 'First Name', model_method: :first_name
-  column 'Last Name', model_method: :last_name
-  column 'Email', model_method: :email
-  column 'Role', model_methods: %i[membership name]
+  column :first_name
+  column :last_name
+  column :email
+  column 'User Role', model_methods: %i[membership name]
 end
 ```
 
+Note: the header argument can be either a symbol or a string.
+
 And then to export, simply instantiate your class and pass in your `collection`, then call `to_csv`. For example, in a Rails controller action, you would do:
 
-```
+```ruby
   def index
     users = User.all
 
@@ -49,6 +51,55 @@ And then to export, simply instantiate your class and pass in your `collection`,
   end
 ```
 
+<<<<<<< HEAD
+The Column Method
+---
+
+Every column in a CSV contains (1) a header, and (2) data for each row. The first argument to our `column` method is the header name. The second argument is an `options` hash which includes the following:
+
+```
+model_method
+model_methods
+```
+
+`model_method` is used to determine how to access the data on the object. Let's say we are exporting a CSV of users and our `User` object has a `first_name` database column. In order to access the first name of a user, we need to call `first_name` on an instance of `User`. Therefore, the following would suffice:
+
+```ruby
+column 'First Name', model_method: :first_name
+```
+
+When the first argument to `column` is a symbol and no value is passed for model_method or model_methods, we will assume it is both the header and the model method. That's why the following will work:
+
+```ruby
+column :first_name
+```
+
+You can also chain methods by using `model_methods` like so:
+
+```ruby
+column 'First Name', model_methods: [:names, :first]
+```
+
+Finally, you can use custom methods on your Export class like so:
+
+```ruby
+class ExportUsers
+  include LpCSVExportable::CanExportAsCSV
+
+  column 'Full Name', model_method: :full_name
+
+  def full_name(obj)
+    [obj.first_name, obj.last_name].compact.join(' ')
+  end
+end
+```
+
+If you would like to default a column to a specific value if the model method returns `nil`, use the `default_value` key when defining the column.
+
+```
+column 'Email', model_method: :email, default_value: 'N/A'
+```
+
 TODO
 ---
 

data/bin/console

@@ -7,8 +7,8 @@ require "lp_csv_exportable"
 # with your gem easier. You can also use a different console, if you like.
 
 # (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
+require "pry"
+Pry.start
 
 require "irb"
 IRB.start(__FILE__)

data/lib/lp_csv_exportable.rb

@@ -1,5 +1,6 @@
 require 'lp_csv_exportable/version'
 require 'csv'
+require 'active_support/all'
 
 module LpCSVExportable
 end

data/lib/lp_csv_exportable/can_export_as_csv.rb

@@ -1,6 +1,6 @@
 module LpCSVExportable
   module CanExportAsCSV
-    attr_accessor :collection
+    attr_accessor :collection, :column_class
 
     def self.included(base)
       base.extend ClassMethods
@@ -17,14 +17,18 @@ module LpCSVExportable
 
     private
 
+    def column_class
+      @column_class ||= CSVColumn
+    end
+
     def columns
       self.class.columns_hashes.map do |hash|
-        CSVColumn.new(hash)
+        column_class.new(hash)
       end
     end
 
     def headers
-      columns.map(&:header)
+      columns.map { |c| c.header.try(:to_s) }
     end
 
     def data_matrix
@@ -51,7 +55,7 @@ module LpCSVExportable
       if respond_to?(model_method)
         send(model_method, memo)
       else
-        memo.try(:send, model_method)
+        memo.try(model_method)
       end
     end
 
@@ -64,7 +68,9 @@ module LpCSVExportable
     # Configuration...
     module ClassMethods
       def column(header, options = {})
-        columns_hashes << { header: header }.merge(options)
+        column_settings = { header: header }
+        column_settings[:model_method] = header if header.is_a?(Symbol) && options[:model_methods].nil?
+        columns_hashes << column_settings.merge(options)
       end
 
       def columns_hashes

data/lib/lp_csv_exportable/csv_column.rb

@@ -1,17 +1,19 @@
 module LpCSVExportable
   class CSVColumn
-    attr_reader :header, :model_method, :model_methods, :type
+    attr_reader :header, :default_value, :model_method, :model_methods, :type
 
     def initialize(args = {})
       @header = args[:header]
       @model_method = args[:model_method]
       @model_methods = args[:model_methods]
       @type = args.fetch(:type, :string)
+      @default_value = args.fetch(:default_value, '')
       after_init(args)
     end
 
     def format(result)
-      return send(type, result) if respond_to?(type)
+      return formatted_result(result) if respond_to?(type)
+      return default_value if use_default?(result)
       result
     end
 
@@ -20,5 +22,15 @@ module LpCSVExportable
     def after_init(args = {})
       # hook for subclasses
     end
+
+    def use_default?(result)
+      default_value.present? && result.nil?
+    end
+
+    def formatted_result(result)
+      formatted = send(type, result)
+      return default_value if use_default?(formatted)
+      formatted
+    end
   end
 end

data/lib/lp_csv_exportable/version.rb

@@ -1,3 +1,3 @@
 module LpCSVExportable
-  VERSION = '0.1.6'.freeze
+  VERSION = '0.2.8'.freeze
 end

data/lp_csv_exportable.gemspec

@@ -33,4 +33,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.14'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry'
+
+  spec.add_dependency 'activesupport'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lp_csv_exportable
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.8
 platform: ruby
 authors:
 - Ryan Francis
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-22 00:00:00.000000000 Z
+date: 2017-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Export from your Rails app to CSV in no time.
 email:
 - ryan@launchpadlab.com
@@ -97,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Easily export data to CSV