lite-report 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '01200390e3a06669140612cf102393844a3121b27b71905e3df0adcfa275a299'
+  data.tar.gz: 808ce98ff9635dcd92d59b09eeec9a397b556f2f4d064e5e76c67ff4e99cc282
+SHA512:
+  metadata.gz: 53eb09f4960b0aa89e5cc6391cc86bdb674b115a171414bb88ee45992e4724b0a9c467c2e491beb744177c41f7553bc113ba51cf339a4e2159ea0b9db410071e
+  data.tar.gz: 99ccc7f5f644d53486843984f3211589ce7bd07a3f738dadbfad1de83020d44f52b971ec50cc1857855b8003be4b81510c16d1f5e7f242ea846e08b120035e1b

data/.fasterer.yml

@@ -0,0 +1,19 @@
+speedups:
+  block_vs_symbol_to_proc: true
+  each_with_index_vs_while: false
+  fetch_with_argument_vs_block: true
+  for_loop_vs_each: true
+  getter_vs_attr_reader: true
+  gsub_vs_tr: true
+  hash_merge_bang_vs_hash_brackets: true
+  keys_each_vs_each_key: true
+  map_flatten_vs_flat_map: true
+  module_eval: true
+  proc_call_vs_yield: true
+  rescue_vs_respond_to: true
+  reverse_each_vs_reverse_each: true
+  select_first_vs_detect: true
+  select_last_vs_reverse_detect: true
+  setter_vs_attr_writer: true
+  shuffle_first_vs_sample: true
+  sort_vs_sort_by: true

data/.gitignore

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

data/.rspec

@@ -0,0 +1,4 @@
+--backtrace
+--color
+--format progress
+--order random

data/.rubocop.yml

@@ -0,0 +1,28 @@
+require:
+  - rubocop-performance
+  - rubocop-rspec
+AllCops:
+  TargetRubyVersion: 2.6
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+LineLength:
+  Max: 100
+Layout/EmptyLinesAroundBlockBody:
+  Exclude:
+    - 'spec/**/**/*'
+Layout/EmptyLinesAroundClassBody:
+  EnforcedStyle: empty_lines_except_namespace
+Layout/EmptyLinesAroundModuleBody:
+  EnforcedStyle: empty_lines_except_namespace
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/**/*'
+    - '*.gemspec'
+RSpec/ExampleLength:
+  Enabled: false
+Style/ClassAndModuleChildren:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Style/ExpandPathArguments:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,24 @@
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+- 2.5
+- 2.6
+- ruby-head
+matrix:
+  fast_finish: true
+  allow_failures:
+  - rvm: ruby-head
+before_install:
+- gem update --system
+- gem install bundler
+install:
+- bundle install --jobs=3 --retry=3
+script:
+- bundle exec rspec
+- bundle exec rubocop
+- bundle exec fasterer
+notifications:
+  email: false
+  slack:
+    secure: J2Lyk75M2pDeL1+aQRDNfr1+/V4uulBOYpd0DggsY/geQMTTvv6VEb6HjRuPfP0T+JOHMaOmPee7Y1xL5HoDabdUn03RdFoR0MCoW9bG3ZeHoJHaZMJBiNBLx1hA6945v3hgWtCnYVG4iFmfDgD26fXHiZHsitgcZqmrmVuoT1rzjHnd913Z4cCk2bROBk8vzXRhx3ebfXH2pdhr8Rv04Fwqu0mRWZfG15+G28F13yB99oYQoyq+AdQfZVUxdsJHYLox3hQzsSuJ3Qc3SQtmh6z7x7BTNqdL3CrKK2b1iCdu1guz40f3bQV7NA9zeuf/X46DZPVGULb6IYsTKhpqq1cPg5PAZCqxbaED8/yCeXA30p7j71SjkC98V+JK3KEhjpfYdruxMe9j/8P3axmbr4Du17oFoNVtVfqab1DfEqMXtKxn5LDoseHKG+YqfEjmMUPE7ZntGDs8Lt/EYHPakV91azNwB3XMSRGH2Fn7YhsnFUsQPFHXtP47qecWDpSzLjFRWBE+IO706YIymflsYXlBGQq42WaiVSiDu20iUGBCQTxoAQg2sXJpYtimYl9SoXfHlzV6Cl0LBND7/da23eTEq3sxC7bqa/XEEpAcamWkWndREJqBZmwsmXOLMlJ8I8dZ7plzjcGFDJ3NXsOjTmGqFlexlxtX0/ciMkED1yQ=

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+## [1.0.0] - 2019-07-08
+### Added
+- Initial project version

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at j.gomez@drexed.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in lite-report.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,155 @@
+PATH
+  remote: .
+  specs:
+    lite-report (1.0.0)
+      activerecord
+      activerecord-import
+      deep_pluck
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (5.2.3)
+      actionview (= 5.2.3)
+      activesupport (= 5.2.3)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.3)
+      activesupport (= 5.2.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activemodel (5.2.3)
+      activesupport (= 5.2.3)
+    activerecord (5.2.3)
+      activemodel (= 5.2.3)
+      activesupport (= 5.2.3)
+      arel (>= 9.0)
+    activerecord-import (1.0.2)
+      activerecord (>= 3.2)
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    ast (2.4.0)
+    builder (3.2.3)
+    colorize (0.8.1)
+    concurrent-ruby (1.1.5)
+    crass (1.0.4)
+    database_cleaner (1.7.0)
+    deep_pluck (1.1.1)
+      activerecord (>= 3)
+      pluck_all (>= 1.2.3)
+    diff-lcs (1.3)
+    erubi (1.8.0)
+    fasterer (0.5.1)
+      colorize (~> 0.7)
+      ruby_parser (>= 3.13.0)
+    generator_spec (0.9.4)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.3)
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (0.9.2)
+    mini_portile2 (2.4.0)
+    minitest (5.11.3)
+    nokogiri (1.10.3)
+      mini_portile2 (~> 2.4.0)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    pluck_all (2.0.4)
+      activesupport (>= 3.0.0)
+    rack (2.0.7)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.2.3)
+      actionpack (= 5.2.3)
+      activesupport (= 5.2.3)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
+    rainbow (3.0.0)
+    rake (12.3.2)
+    ransack (2.1.1)
+      actionpack (>= 5.0)
+      activerecord (>= 5.0)
+      activesupport (>= 5.0)
+      i18n
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-rails (3.8.2)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    rubocop (0.72.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-performance (1.4.0)
+      rubocop (>= 0.71.0)
+    rubocop-rspec (1.33.0)
+      rubocop (>= 0.60.0)
+    ruby-progressbar (1.10.1)
+    ruby_parser (3.13.1)
+      sexp_processor (~> 4.9)
+    sexp_processor (4.12.1)
+    sqlite3 (1.4.1)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  database_cleaner
+  fasterer
+  generator_spec
+  lite-report!
+  rake
+  ransack
+  rspec
+  rspec-rails
+  rubocop
+  rubocop-performance
+  rubocop-rspec
+  sqlite3
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Juan Gomez
+
+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,202 @@
+# Lite::Report
+
+[![Gem Version](https://badge.fury.io/rb/lite-report.svg)](http://badge.fury.io/rb/lite-report)
+[![Build Status](https://travis-ci.org/drexed/lite-report.svg?branch=master)](https://travis-ci.org/drexed/lite-report)
+
+Lite::Report is a library for importing and exporting Ruby and Rails objects to flat files and
+vice versa. Usage of the report module has many options so it is best if you check out the specs
+to see everything the library can do.
+
+**NOTE:** If you are coming from `ActiveReport`, please read the [port](#port) section.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lite-report'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lite-report
+
+## Table of Contents
+
+* [Configurations](#configurations)
+* [Array](#array)
+* [Hash](#hash)
+* [Record](#record)
+* [Stream](#stream)
+* [Port](#port)
+
+## Configurations
+
+`rails g lite:report:install` will generate the following file:
+`../config/initalizers/lite-report.rb`
+
+Place your default configs in this file.
+
+```ruby
+Lite::Report.configure do |config|
+  config.csv_options = {}
+  config.data_options = {}
+  config.import_options = {}
+end
+```
+
+## Array
+
+```ruby
+data = [
+  ['James Jones', 39, 'male', ...],
+  ['Pamela Anderson', 52, 'female', ...],
+  ['Dwayne Wade', 21, 'male', ...]
+]
+
+# Convert array of arrays to CSV file
+Lite::Report::Array.export(
+  data,
+  data_options: {
+    only: ['Age', 'Sex']
+  },
+  csv_options: {
+    write_headers: true,
+    headers: ['Name', 'Age', 'Sex', ...]
+  }
+)
+
+# Convert CSV file to an array of arrays
+Lite::Report::Array.import(
+  'path/to/file.csv',
+  data_options: {
+    except: ['Age', 'Sex']
+  },
+  csv_options: {
+    return_headers: true,
+    headers: ['Name', 'Age', 'Sex', ...]
+  }
+)
+```
+
+## Hash
+
+```ruby
+data = [
+  { 'Name' => 'James Jones', 'Age' => 39, 'Sex' => 'male', ...],
+  { 'Name' => 'Pamela Anderson', 'Age' => 52, 'Sex' => 'female', ...],
+  { 'Name' => 'Dwayne Wade', 'Age' => 21, 'Sex' => 'male', ...]
+]
+
+# Convert array of hashes to CSV file
+Lite::Report::Hash.export(
+  data,
+  data_options: {
+    only: ['Age', 'Sex']
+  },
+  csv_options: {
+    write_headers: true,
+    headers: ['Name', 'Age', 'Sex', ...]
+  }
+)
+
+# Convert CSV file to an array of hashes
+Lite::Report::Hash.import(
+  'path/to/file.csv',
+  data_options: {
+    except: ['Age', 'Sex']
+  },
+  csv_options: {
+    return_headers: true,
+    headers: ['Name', 'Age', 'Sex', ...]
+  }
+)
+```
+
+## Record
+
+```ruby
+data = User.where(age: 20..29)
+
+# Convert array/relation/ransack of records to CSV file
+Lite::Report::Record.export(
+  data,
+  data_options: {
+    only: [:age, :sex]
+  },
+  csv_options: {
+    write_headers: true,
+    headers: ['Name', 'Age', 'Sex', ...]
+  }
+)
+
+# Convert CSV file to an array of records
+Lite::Report::Record.import(
+  'path/to/file.csv',
+  data_options: {
+    klass: User,
+    except: [:age, :sex]
+  }
+)
+```
+
+## Stream
+
+Stream is great option for preventing browser timeouts of downloading large CSV files by chunking
+the results via an enumerator.
+
+```ruby
+class StreamingController < ApplicationController
+
+  def download
+    headers.delete("Content-Length")      # Tell Rack to stream the content
+    headers["Cache-Control"] = "no-cache" # Don't cache anything from this generated endpoint
+    headers["Content-Type"] = "text/csv"  # Tell the browser this is a CSV file
+    headers["X-Accel-Buffering"] = "no"   # Don't buffer when going through proxy servers
+
+    # Make the file download with a specific filename
+    headers["Content-Disposition"] = "attachment; filename=\"example.csv\""
+
+    self.response_body = report_body      # Set an Enumerator as the body
+    response.status = 200                 # Set the status to success
+  end
+
+  private
+
+  def report_body
+    Lite::Report::Hash.export(
+      data,
+      csv_options: { stream: true }
+    )
+  end
+
+end
+```
+
+## Port
+
+`Lite::Report` is NOT a compatible port of [ActiveReport](https://github.com/drexed/active_report).
+
+Please read the docs and go through the specs to view many examples.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/[USERNAME]/lite-report. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Lite::Report project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/lite-report/blob/master/CODE_OF_CONDUCT.md).