csv_composer 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6220ec5129f3168f1a59775a32bfdc9139c9f8ea
+  data.tar.gz: eb76a39ae13c4c52d0b4fa43e85aaaea641cc796
+SHA512:
+  metadata.gz: 86bfa69b651a4d6f800ca5d1296c4b67e2ee97a3f24c9fb4d1c6fcce872b1230e54db2eb044491e6d9746e0523cd82f64d23ff60bd230e733ad3d87bb3d0bf19
+  data.tar.gz: 0f7af2630ddbf78a7d7a100c67f9f8c0f0017cb7ce58ac8bdacb33e50a8a2f26dccdb13a7d370753ef6f25322a48954d8de49a574e279583001695d8bda90127

data/.gitignore

@@ -0,0 +1,54 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+*.iml
+.idea/
+.travis.yml

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in csv_composer.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    csv_composer (1.0.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.10.3)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.14)
+  csv_composer!
+  minitest (~> 5.0)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.0

data/LICENSE

@@ -0,0 +1,22 @@
+
+MIT License
+
+Copyright (c) 2018 Twist Bioscience
+
+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,80 @@
+# CsvComposer
+
+Csv composer is a flexible and generic csv writer and exporter. Allows you to easily control whatever you 
+want to do in each step of csv making, such as how to:
+- iterate over the collection
+- generate file header
+- generate rows
+- export final output
+
+Easy to set up, just extend composer entities to create your own custom csv's or use the generic one.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'csv_composer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install csv_composer
+
+## Usage
+
+Basic usage:
+
+```ruby
+    collection = [
+      { id: 'element1', value: 'value1'},
+      { id: 'element2', value: 'value2'},
+      { id: 'element3', value: 'value3'}            
+    ]
+    
+    exporter = CsvComposer::Generic.new
+    exporter.compose(collection)
+```
+
+Where collection could be everything that includes Enumerable module (and implements each method).
+This way you are able to implement your custom iterators.
+
+## Custom csvs exporters
+You can create your own custom exporters just extending CsvComposer::Base.
+
+Override your own custom 'columns_mapping' to map every kind of object (in the collection) to csv value using lambdas:
+
+```ruby
+    def generic_lambda
+      ->(item, key) { item[key] || '' }
+    end
+    
+    def columns_mapping
+      [
+        { id: 'Id', key: :id, lambda: generic_lambda },
+        { id: 'Value', key: :value, lambda: generic_lambda }
+      ]
+    end
+``` 
+Create and set your own custom Header processors extending 'CsvComposer::HeaderProcessors::Base' and your own custom 
+ItemProcessors 'extending CsvComposer::ItemProcessors::Base'
+
+Finally create and set your own custom file exporters extending 'CsvComposer::FileExporters::Base' to 
+export csv to wherever location you want such as a file, upload it to the cloud, etc.  
+
+Optionally you can send a second parameter to 'compose' method with a hash containing custom options that will be sent into
+both header and item processor that you can use when overriding them. 
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Twistbioscience/csv_composer

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "csv_composer"
+
+# 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/csv_composer.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "csv_composer/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "csv_composer"
+  spec.version       = CsvComposer::VERSION
+  spec.authors       = ["Jorge Smulevici"]
+  spec.email         = ["jsmulevici@twistbioscience.com", "open-source@twistbioscience.com"]
+  spec.licenses      = ['MIT']
+
+  spec.summary       = %q{csv exporter}
+  spec.description   = %q{Easy and generic csv writer and exporter}
+  spec.homepage      = "https://github.com/Twistbioscience/csv_composer"
+
+  # 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"] = "TODO: Set to 'http://mygemserver.com'"
+  # 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 "minitest", "~> 5.0"
+end

data/lib/csv_composer.rb

@@ -0,0 +1,16 @@
+require "csv_composer/version"
+
+module CsvComposer
+  require 'csv_composer/base'
+  require 'csv_composer/generic'
+  require 'csv_composer/writer'
+
+  require 'csv_composer/header_processors/base'
+  require 'csv_composer/header_processors/generic'
+
+  require 'csv_composer/item_processors/base'
+  require 'csv_composer/item_processors/generic'
+
+  require 'csv_composer/file_exporters/base'
+  require 'csv_composer/file_exporters/string_io'
+end

data/lib/csv_composer/base.rb

@@ -0,0 +1,34 @@
+module CsvComposer
+  class Base
+
+    def compose(items, opts = {})
+      content = write(items, opts)
+      export(content, opts)
+    end
+
+    private
+
+    def header_processor
+    end
+
+    def item_processor
+    end
+
+    def exporter
+    end
+
+    def columns_mapping
+      # Create a mapping for each column in the export CSV
+    end
+
+    def write(collection, writing_options = {})
+      writer = Writer.new
+      writer.write(header_processor.new, item_processor.new, collection, columns_mapping, writing_options)
+    end
+
+    def export(content, opts = {})
+      exporter.new.export(content, opts)
+    end
+
+  end
+end

data/lib/csv_composer/file_exporters/base.rb

@@ -0,0 +1,7 @@
+module CsvComposer::FileExporters
+  class Base
+
+    def export(content, opts = {}) end
+
+  end
+end

data/lib/csv_composer/file_exporters/string_io.rb

@@ -0,0 +1,12 @@
+module CsvComposer::FileExporters
+  class StringIo < Base
+
+    def export(content, opts = { })
+      file = StringIO.open(content)
+      file.class.class_eval { attr_accessor :original_filename }
+      file.original_filename = opts[:filename]
+      file
+    end
+
+  end
+end

data/lib/csv_composer/generic.rb

@@ -0,0 +1,35 @@
+module CsvComposer
+  class Generic < Base
+    protected
+
+    def header_processor
+      HeaderProcessors::Generic
+    end
+
+    def item_processor
+      ItemProcessors::Generic
+    end
+
+    def hash_key_lambda
+      ->(item, key) { item[key] || '' }
+    end
+
+    def public_method_lambda
+      lambda do |item, method_name|
+        item.public_send(method_name)
+      end
+    end
+
+    def columns_mapping
+      [
+        { id: 'Id', key: :id, lambda: hash_key_lambda },
+        { id: 'Value', key: :value, lambda: hash_key_lambda }
+      ]
+    end
+
+    def exporter
+      FileExporters::StringIo
+    end
+
+  end
+end

data/lib/csv_composer/header_processors/base.rb

@@ -0,0 +1,7 @@
+module CsvComposer::HeaderProcessors
+  class Base
+
+    def process(columns_mapping, opts) end
+
+  end
+end

data/lib/csv_composer/header_processors/generic.rb

@@ -0,0 +1,11 @@
+module CsvComposer::HeaderProcessors
+  class Generic < Base
+
+    def process(columns_mapping, opts)
+      columns_mapping.map do |c|
+        c[:header] || ''
+      end
+    end
+
+  end
+end

data/lib/csv_composer/item_processors/base.rb

@@ -0,0 +1,7 @@
+module CsvComposer::ItemProcessors
+  class Base
+
+    def process(item, columns_mapping, opts) end
+
+  end
+end

data/lib/csv_composer/item_processors/generic.rb

@@ -0,0 +1,11 @@
+module CsvComposer::ItemProcessors
+  class Generic < Base
+
+    def process_value(item, columns_mapping, opts)
+      columns_mapping.map do |column|
+        column[:lambda].call(item, column[:key]) || ''
+      end
+    end
+
+  end
+end

data/lib/csv_composer/version.rb

@@ -0,0 +1,3 @@
+module CsvComposer
+  VERSION = '1.0.2'
+end

data/lib/csv_composer/writer.rb

@@ -0,0 +1,25 @@
+require 'csv'
+
+module CsvComposer
+  class Writer
+
+    def write(header_processor, item_processor, collection, columns_mapping, opts = {})
+      CSV.generate do |csv|
+        headers = header_processor.process(columns_mapping, opts)
+        csv << headers.compact
+        opts[:headers] = headers # We are adding the headers in case you need them to process your items
+        write_content(csv, item_processor, columns_mapping, collection, opts)
+      end
+    end
+
+    private
+
+    def write_content(csv, item_processor, columns_mapping, collection, opts)
+      collection.each do |item|
+        row_components = item_processor.process_value(item, columns_mapping, opts)
+        csv << row_components.compact
+      end
+    end
+
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: csv_composer
+version: !ruby/object:Gem::Version
+  version: 1.0.2
+platform: ruby
+authors:
+- Jorge Smulevici
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-12 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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Easy and generic csv writer and exporter
+email:
+- jsmulevici@twistbioscience.com
+- open-source@twistbioscience.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- csv_composer.gemspec
+- lib/csv_composer.rb
+- lib/csv_composer/base.rb
+- lib/csv_composer/file_exporters/base.rb
+- lib/csv_composer/file_exporters/string_io.rb
+- lib/csv_composer/generic.rb
+- lib/csv_composer/header_processors/base.rb
+- lib/csv_composer/header_processors/generic.rb
+- lib/csv_composer/item_processors/base.rb
+- lib/csv_composer/item_processors/generic.rb
+- lib/csv_composer/version.rb
+- lib/csv_composer/writer.rb
+homepage: https://github.com/Twistbioscience/csv_composer
+licenses:
+- MIT
+metadata: {}
+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.6.12
+signing_key: 
+specification_version: 4
+summary: csv exporter
+test_files: []