lite-report 1.0.5 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e19a104989a720b33c1d0be498695c26352a0a607d8a2c89af66705958398ed1
-  data.tar.gz: 2df858892aff83bad0042f486e4d9501b7a7ef5886c9139b5496c0c9ac37af73
+  metadata.gz: e5306a141edec1f32743651c3fe81fc7d9f99a4f091ae21b2cee30de8e428b02
+  data.tar.gz: bef4ad772798d30c09c27ad0807201b0701062372b52ca7adfc3094715a6c636
 SHA512:
-  metadata.gz: 153acef279ba609c0b02f30b0651fb5c085231dbc22d713499ffd38b254d0881821060bbe02947eadf2f1f2b853ca002e998460bb918a4fccd9bc60484261a97
-  data.tar.gz: 6001668ff0e2751a674abaec2331ba43f9aec2eda280ac66b5c40c7f234fcb2f505c0ec1b4d7f9e72f2add92c1469aa6622bf959aee89f558e9596c1310ec227
+  metadata.gz: effd567e92022ea1c3487694d41d692cb46fb5f01678676627d3c9deca79739c3fd61ce0994157067ad4ba0430f459a65b1fd5c61e541a33511056ebe7eb6355
+  data.tar.gz: 1d165fe27b4495ab9a594f7ff4c7f91f23c40d92309044c53ca21815134d6349ef6f4dd4fd538d1359db9a318c68989c31424c38b94738bd39b44255cccf5f07

data/.rubocop.yml

@@ -1,11 +1,14 @@
 require:
   - rubocop-performance
+  - rubocop-rake
   - rubocop-rspec
 AllCops:
   TargetRubyVersion: 2.7
   NewCops: enable
   DisplayCopNames: true
   DisplayStyleGuide: true
+Gemspec/RequiredRubyVersion:
+  Enabled: false
 Layout/EmptyLinesAroundAttributeAccessor:
   Enabled: true
 Layout/EmptyLinesAroundBlockBody:

data/CHANGELOG.md

@@ -6,6 +6,24 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.20.0] - 2021-07-18
+### Removed
+- Removed `activerecord-import` dependency
+- Removed `deep_pluck` dependency
+
+## [1.1.1] - 2021-05-07
+### Changed
+- Linter fixes
+
+## [1.1.0] - 2021-01-06
+### Added
+- Added Exporter helper class
+- Added rubocop-rake linter
+
+## [1.0.6] - 2020-10-10
+### Added
+- Added improved Ruby 2.7 support
+
 ## [1.0.5] - 2020-07-03
 ### Added
 - Added Ruby 2.7 support

data/Gemfile.lock

@@ -1,75 +1,70 @@
 PATH
   remote: .
   specs:
-    lite-report (1.0.5)
+    lite-report (1.2.0)
       activerecord
-      activerecord-import
-      deep_pluck
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (6.0.3.2)
-      actionview (= 6.0.3.2)
-      activesupport (= 6.0.3.2)
-      rack (~> 2.0, >= 2.0.8)
+    actionpack (6.1.4)
+      actionview (= 6.1.4)
+      activesupport (= 6.1.4)
+      rack (~> 2.0, >= 2.0.9)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (6.0.3.2)
-      activesupport (= 6.0.3.2)
+    actionview (6.1.4)
+      activesupport (= 6.1.4)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activemodel (6.0.3.2)
-      activesupport (= 6.0.3.2)
-    activerecord (6.0.3.2)
-      activemodel (= 6.0.3.2)
-      activesupport (= 6.0.3.2)
-    activerecord-import (1.0.5)
-      activerecord (>= 3.2)
-    activesupport (6.0.3.2)
+    activemodel (6.1.4)
+      activesupport (= 6.1.4)
+    activerecord (6.1.4)
+      activemodel (= 6.1.4)
+      activesupport (= 6.1.4)
+    activesupport (6.1.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
-    ast (2.4.1)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
     builder (3.2.4)
     colorize (0.8.1)
-    concurrent-ruby (1.1.6)
+    concurrent-ruby (1.1.9)
     crass (1.0.6)
-    database_cleaner (1.8.5)
-    deep_pluck (1.1.4)
-      activerecord (>= 3)
-      pluck_all (>= 1.2.3)
-      rails_compatibility (>= 0.0.1)
+    database_cleaner (2.0.1)
+      database_cleaner-active_record (~> 2.0.0)
+    database_cleaner-active_record (2.0.1)
+      activerecord (>= 5.a)
+      database_cleaner-core (~> 2.0.0)
+    database_cleaner-core (2.0.1)
     diff-lcs (1.4.4)
-    erubi (1.9.0)
-    fasterer (0.8.3)
+    erubi (1.10.0)
+    fasterer (0.9.0)
       colorize (~> 0.7)
       ruby_parser (>= 3.14.1)
     generator_spec (0.9.4)
       activesupport (>= 3.0.0)
       railties (>= 3.0.0)
-    i18n (1.8.3)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    loofah (2.6.0)
+    loofah (2.10.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     method_source (1.0.0)
-    mini_portile2 (2.4.0)
-    minitest (5.14.1)
-    nokogiri (1.10.9)
-      mini_portile2 (~> 2.4.0)
-    parallel (1.19.2)
-    parser (2.7.1.4)
+    mini_portile2 (2.5.3)
+    minitest (5.14.4)
+    nokogiri (1.11.7)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
+    parallel (1.20.1)
+    parser (3.0.2.0)
       ast (~> 2.4.1)
-    pluck_all (2.0.4)
-      activesupport (>= 3.0.0)
-    polyamorous (2.3.2)
-      activerecord (>= 5.2.1)
+    racc (1.5.2)
     rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
@@ -78,70 +73,70 @@ GEM
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.3.0)
       loofah (~> 2.3)
-    rails_compatibility (0.0.2)
-      activerecord (>= 3)
-    railties (6.0.3.2)
-      actionpack (= 6.0.3.2)
-      activesupport (= 6.0.3.2)
+    railties (6.1.4)
+      actionpack (= 6.1.4)
+      activesupport (= 6.1.4)
       method_source
-      rake (>= 0.8.7)
-      thor (>= 0.20.3, < 2.0)
+      rake (>= 0.13)
+      thor (~> 1.0)
     rainbow (3.0.0)
-    rake (13.0.1)
-    ransack (2.3.2)
-      activerecord (>= 5.2.1)
-      activesupport (>= 5.2.1)
+    rake (13.0.6)
+    ransack (2.4.2)
+      activerecord (>= 5.2.4)
+      activesupport (>= 5.2.4)
       i18n
-      polyamorous (= 2.3.2)
-    regexp_parser (1.7.1)
-    rexml (3.2.4)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-rails (4.0.1)
-      actionpack (>= 4.2)
-      activesupport (>= 4.2)
-      railties (>= 4.2)
-      rspec-core (~> 3.9)
-      rspec-expectations (~> 3.9)
-      rspec-mocks (~> 3.9)
-      rspec-support (~> 3.9)
-    rspec-support (3.9.3)
-    rubocop (0.86.0)
+      rspec-support (~> 3.10.0)
+    rspec-rails (5.0.1)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      railties (>= 5.2)
+      rspec-core (~> 3.10)
+      rspec-expectations (~> 3.10)
+      rspec-mocks (~> 3.10)
+      rspec-support (~> 3.10)
+    rspec-support (3.10.2)
+    rubocop (1.18.3)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.7)
+      regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 0.0.3, < 1.0)
+      rubocop-ast (>= 1.7.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.1.0)
-      parser (>= 2.7.0.1)
-    rubocop-performance (1.6.1)
-      rubocop (>= 0.71.0)
-    rubocop-rspec (1.41.0)
-      rubocop (>= 0.68.1)
-    ruby-progressbar (1.10.1)
-    ruby_parser (3.14.2)
-      sexp_processor (~> 4.9)
-    sexp_processor (4.15.0)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.8.0)
+      parser (>= 3.0.1.1)
+    rubocop-performance (1.11.4)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.4.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    ruby_parser (3.16.0)
+      sexp_processor (~> 4.15, >= 4.15.1)
+    sexp_processor (4.15.3)
     sqlite3 (1.4.2)
-    thor (1.0.1)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.7.0)
-    zeitwerk (2.3.1)
+    thor (1.1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.0.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
@@ -158,8 +153,9 @@ DEPENDENCIES
   rspec-rails
   rubocop
   rubocop-performance
+  rubocop-rake
   rubocop-rspec
   sqlite3
 
 BUNDLED WITH
-   2.1.4
+   2.2.24

data/README.md

@@ -31,6 +31,7 @@ Or install it yourself as:
 * [Array](#array)
 * [Hash](#hash)
 * [Record](#record)
+* [Exporter](#exporter)
 * [Stream](#stream)
 * [Port](#port)
 
@@ -134,16 +135,50 @@ Lite::Report::Record.export(
   }
 )
 
-# Convert CSV file to an array of records
+# Convert CSV file to an array of records (import options are from Rails `insert_all`)
 Lite::Report::Record.import(
   'path/to/file.csv',
   data_options: {
     klass: User,
     except: [:age, :sex]
+  },
+  import_options: {
+    unique_by: %w[Name Age]
   }
 )
 ```
 
+## Exporter
+
+Use exporters to filter, manipulate, and prepare data before final exportation.
+These are very helpful when working with complex datasets.
+
+```ruby
+class LimitedExporter < Lite::Report::Exporter
+
+  private
+
+  def serialize(record)
+    {
+      'Id' => record.id,
+      'Name' => "#{record.first_name} #{record.last_name}",
+      'Speed' => record.speed.ceil,
+      'Date' => record.to_s(:short)
+    }
+
+    # - or -
+
+    serializer = RecordSerializer.new(record)
+    serializer.serializable_hash
+  end
+
+end
+
+raw_data = User.where(age: 20..29)
+limited_data = LimitedExporter.call(raw_data)
+Lite::Report::Hash.export(limited_data)
+```
+
 ## Stream
 
 Stream is great option for preventing browser timeouts of downloading large CSV files by chunking

data/lib/lite/report.rb

@@ -7,7 +7,7 @@ require 'lite/report/version'
   require "lite/report/helpers/#{file_name}"
 end
 
-%w[configuration base array hash record].each do |file_name|
+%w[configuration base array hash record exporter].each do |file_name|
   require "lite/report/#{file_name}"
 end
 

data/lib/lite/report/exporter.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+class Lite::Report::Exporter
+
+  class NotImplementedError < StandardError; end
+
+  attr_reader :records
+
+  def initialize(records)
+    @records = records
+  end
+
+  class << self
+
+    def call(records)
+      instance = new(records)
+      instance.call
+    end
+
+  end
+
+  def call
+    results = []
+
+    if records.respond_to?(:find_each)
+      records.find_each { |record| results << serialize(record) }
+    elsif records.respond_to?(:each)
+      records.each { |record| results << serialize(record) }
+    else
+      results << serialize(records)
+    end
+
+    results
+  end
+
+  private
+
+  def serialize(record)
+    raise NotImplementedError
+  end
+
+end

data/lib/lite/report/helpers/converters.rb

@@ -16,7 +16,7 @@ module Lite
 
         def convert_to_hash!(row)
           case row.class.name
-          when 'Array' then ::Hash[(0..(row.size - 1)).zip(row)]
+          when 'Array' then (0..(row.size - 1)).zip(row).to_h
           when 'CSV::Row' then row.to_hash
           else row
           end

data/lib/lite/report/record.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
 require 'active_record'
-require 'activerecord-import'
-require 'deep_pluck'
 
 class Lite::Report::Record < Lite::Report::Base
 
@@ -16,9 +14,13 @@ class Lite::Report::Record < Lite::Report::Base
     assign_import_csv_options!
 
     @data = Lite::Report::Hash.import(@data, csv_options: @csv_options, data_options: @data_options)
-                              .each { |row| row.delete(:id) || row.delete('id') }
+                              .each do |row|
+                                row.delete(:id) || row.delete('id')
+                                (row['created_at'] ||= timestamp) if created_at_timestamp?
+                                (row['updated_at'] ||= timestamp) if updated_at_timestamp?
+                              end
 
-    klass.import(@data, @import_options)
+    klass.insert_all(@data, **@import_options)
   end
 
   private
@@ -41,9 +43,15 @@ class Lite::Report::Record < Lite::Report::Base
 
   def assign_export_data!
     columns = class_columns(@data)
-    @data = @data.result if ransack_class?(@data)
-    @data = @data.deep_pluck(*columns)
-    @data = [@data] unless @data.is_a?(Array)
+    @data = if ransack_class?(@data)
+              @data.result
+            elsif @data.try(:persisted?)
+              Array(@data)
+            else
+              @data
+            end
+
+    @data = @data.pluck(*columns).map { |values| columns.zip(values).to_h }
   end
 
   def generate_export!
@@ -56,4 +64,20 @@ class Lite::Report::Record < Lite::Report::Base
     super
   end
 
+  def timestamp
+    @timestamp ||= Time.try(:current) || Time.now
+  end
+
+  def created_at_timestamp?
+    return @created_at_timestamp if defined?(@created_at_timestamp)
+
+    @created_at_timestamp = klass.new.respond_to?(:created_at)
+  end
+
+  def updated_at_timestamp?
+    return @updated_at_timestamp if defined?(@updated_at_timestamp)
+
+    @updated_at_timestamp = klass.new.respond_to?(:updated_at)
+  end
+
 end

data/lib/lite/report/version.rb

@@ -3,7 +3,7 @@
 module Lite
   module Report
 
-    VERSION ||= '1.0.5'
+    VERSION = '1.2.0'
 
   end
 end

data/lite-report.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
     )
   else
     raise 'RubyGems 2.0 or newer is required to protect against ' \
-      'public gem pushes.'
+          'public gem pushes.'
   end
 
   # Specify which files should be added to the gem when it is released.
@@ -38,8 +38,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = %w[lib]
 
   spec.add_runtime_dependency 'activerecord'
-  spec.add_runtime_dependency 'activerecord-import'
-  spec.add_runtime_dependency 'deep_pluck'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'database_cleaner'
@@ -51,6 +49,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec-rails'
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'rubocop-performance'
+  spec.add_development_dependency 'rubocop-rake'
   spec.add_development_dependency 'rubocop-rspec'
   spec.add_development_dependency 'sqlite3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lite-report
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.2.0
 platform: ruby
 authors:
 - Juan Gomez
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-07-03 00:00:00.000000000 Z
+date: 2021-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -25,27 +25,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activerecord-import
-  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'
-- !ruby/object:Gem::Dependency
-  name: deep_pluck
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -53,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: database_cleaner
+  name: fasterer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: fasterer
+  name: generator_spec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: generator_spec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: ransack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: ransack
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -137,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -151,7 +137,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -165,7 +151,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -179,7 +165,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-performance
+  name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -249,6 +235,7 @@ files:
 - lib/lite/report/array.rb
 - lib/lite/report/base.rb
 - lib/lite/report/configuration.rb
+- lib/lite/report/exporter.rb
 - lib/lite/report/hash.rb
 - lib/lite/report/helpers/converters.rb
 - lib/lite/report/helpers/encoders.rb
@@ -279,7 +266,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.24
 signing_key:
 specification_version: 4
 summary: Import and export Ruby and Rails objects to flat files and vice versa