lp_csv_exportable 0.1.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3805b8cffef76f6642c1a073d98efa651b1a3d07
+  data.tar.gz: 07b0b866d5857e622d31045f180e06a97077dd9b
+SHA512:
+  metadata.gz: 592194d4195a038db32d718b997dde273ff62a171237abc1f73a24cb2db60dba14105877ef574a87f3735e0f6860bb42c40f4751353a5effa833c343e8c3c921
+  data.tar.gz: a6370821f0dffab8b52cb9f3276e1b3acc62efa455ca55a0cd1f1ba6c9490b56a132259ad47ef128916466f057c1a2a8423be498acb163ceee0acce8a40b9a09

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in lp_csv_exportable.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Ryan Francis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+LpCSVExportable
+===
+
+What is LpCSVExportable?
+---
+
+LpCSVExportable makes it really easy to export your data into a CSV. It is easy to implement, but also highly extendable.
+
+Installation
+---
+
+```ruby
+gem 'lp_csv_exportable'
+```
+
+```
+bundle
+```
+
+Basic Usage
+---
+
+Create a class that includes the module `LpCSVExportable::CanExportAsCSV`
+
+```
+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]
+end
+```
+
+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:
+
+```
+  def index
+    users = User.all
+
+    respond_to do |format|
+      format.csv do
+        export = ExportUsers.new(collection: attendees)
+        send_data export.to_csv
+      end
+    end
+  end
+```
+
+TODO
+---
+
+- Readme: More complex examples
+- Readme: Ways to extend

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "lp_csv_exportable"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# 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 "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/lp_csv_exportable/can_export_as_csv.rb

@@ -0,0 +1,78 @@
+module LpCSVExportable
+  module CanExportAsCSV
+    attr_reader :collection
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    def initialize(args = {})
+      @collection = args[:collection]
+      after_init(args)
+    end
+
+    def to_csv
+      CSV.generate do |csv|
+        csv << headers
+        data_matrix.each do |row|
+          csv << row
+        end
+      end
+    end
+
+    private
+
+    def after_init(args = {})
+      # hook
+    end
+
+    def columns
+      self.class.columns_hashes.map do |hash|
+        CSVColumn.new(hash)
+      end
+    end
+
+    def headers
+      columns.map(&:header)
+    end
+
+    def data_matrix
+      # array of arrays
+      # i.e. rows 2+ of CSV
+      collection.map do |obj|
+        columns.map do |column|
+          column.format(retrieve_value(obj, column))
+        end
+      end
+    end
+
+    def retrieve_value(obj, column)
+      # only one method to retrieve value
+      return call_model_method(column.model_method, obj) if column.model_method.present?
+      # chain methods to retrieve value (jsonb store)
+      # i.e. employee.market_data.min
+      column.model_methods.inject(obj) do |memo, model_method|
+        call_model_method(model_method, memo)
+      end
+    end
+
+    def call_model_method(model_method, memo)
+      if respond_to?(model_method)
+        send(model_method, memo)
+      else
+        memo.try(:send, model_method)
+      end
+    end
+
+    # Configuration...
+    module ClassMethods
+      def column(header, options = {})
+        columns_hashes << { header: header }.merge(options)
+      end
+
+      def columns_hashes
+        @columns_hashes ||= []
+      end
+    end
+  end
+end

data/lib/lp_csv_exportable/csv_column.rb

@@ -0,0 +1,24 @@
+module LpCSVExportable
+  class CSVColumn
+    attr_reader :header, :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)
+      after_init(args)
+    end
+
+    def format(result)
+      return send(type, result) if respond_to?(type)
+      result
+    end
+
+    private
+
+    def after_init(args = {})
+      # hook for subclasses
+    end
+  end
+end

data/lib/lp_csv_exportable/version.rb

@@ -0,0 +1,3 @@
+module LpCSVExportable
+  VERSION = '0.1.5'.freeze
+end

data/lib/lp_csv_exportable.rb

@@ -0,0 +1,8 @@
+require 'lp_csv_exportable/version'
+require 'csv'
+
+module LpCSVExportable
+end
+
+require 'lp_csv_exportable/csv_column'
+require 'lp_csv_exportable/can_export_as_csv'

data/lp_csv_exportable.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lp_csv_exportable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'lp_csv_exportable'
+  spec.version       = LpCSVExportable::VERSION
+  spec.authors       = ['Ryan Francis']
+  spec.email         = ['ryan@launchpadlab.com']
+
+  spec.summary       = %q{Easily export data to CSV}
+  spec.description   = %q{Export from your Rails app to CSV in no time.}
+  spec.homepage      = 'http://github.com/launchpadlab/lp_csv_exportable'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: lp_csv_exportable
+version: !ruby/object:Gem::Version
+  version: 0.1.5
+platform: ruby
+authors:
+- Ryan Francis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Export from your Rails app to CSV in no time.
+email:
+- ryan@launchpadlab.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/lp_csv_exportable.rb
+- lib/lp_csv_exportable/can_export_as_csv.rb
+- lib/lp_csv_exportable/csv_column.rb
+- lib/lp_csv_exportable/version.rb
+- lp_csv_exportable-0.1.2.gem
+- lp_csv_exportable-0.1.3.gem
+- lp_csv_exportable-0.1.4.gem
+- lp_csv_exportable.gemspec
+homepage: http://github.com/launchpadlab/lp_csv_exportable
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Easily export data to CSV
+test_files: []