lite-report 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fec247c1ce8a3f5a03f01b9d389c50be4400c02ec1e4cc8fc2de8092b0d67747
-  data.tar.gz: 78f4d4b3d9f1557f2c26447ac6223affc786f8938e5d0b442d8c233530051ffb
+  metadata.gz: 6c47012894f22e7cb6329fd29cd11d674436a26e0721042f92f8686827854ff2
+  data.tar.gz: 5bc35bc9c3f4604121aeb9a9fe519a582f4da4ed5aa7aed0afbd64e8fba5591d
 SHA512:
-  metadata.gz: b016454a0f0f3e9eada7b1db8bb0c177b23e85cae65c01f23c024c6ece93b3e741f1a358ab5e0fff845db8c016904dda1c8da2ee5b13756374ca43173915a2e7
-  data.tar.gz: acb39fcfdd3c6e61482b3ccb789e706c8160e3beadacba090e289a3e7d1225231c490de249ddba1910e83c10bf9463c1adb1e754de6f06636290150acf7f87f0
+  metadata.gz: fb991fc839a2287a65de08bc70c3e44cc59a003618a2ef4db6eb2f05ece1e028c12ab71c86f6242c8423a723e6dd826414d2eb123fcd8af6b853146672aff5a9
+  data.tar.gz: b957984a667255674fd66e2122e2c813b515cbe04daff7c5e0227eb74c44c3c0425024945012a857901b92e3131277c7774e812a04f8e59802afb4d52c25672a

data/.rubocop.yml

@@ -1,12 +1,16 @@
 require:
   - rubocop-performance
+  - rubocop-rake
   - rubocop-rspec
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.7
+  NewCops: enable
   DisplayCopNames: true
   DisplayStyleGuide: true
-LineLength:
-  Max: 100
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
 Layout/EmptyLinesAroundBlockBody:
   Exclude:
     - 'spec/**/**/*'
@@ -14,6 +18,14 @@ Layout/EmptyLinesAroundClassBody:
   EnforcedStyle: empty_lines_except_namespace
 Layout/EmptyLinesAroundModuleBody:
   EnforcedStyle: empty_lines_except_namespace
+Layout/LineLength:
+  Max: 100
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/**/*'

data/.travis.yml

@@ -4,6 +4,7 @@ cache: bundler
 rvm:
 - 2.5
 - 2.6
+- 2.7
 - ruby-head
 matrix:
   fast_finish: true

data/CHANGELOG.md

@@ -6,9 +6,30 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [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
+
+## [1.0.4] - 2020-02-11
+### Changed
+- Fix record instance not generating
+
+## [1.0.3] - 2019-08-24
+### Changed
+- Fix broken configuration option
+
 ## [1.0.2] - 2019-08-24
 ### Changed
-- Imporved how configuration works
+- Improved how configuration works
 
 ## [1.0.1] - 2019-08-15
 ### Changed

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lite-report (1.0.2)
+    lite-report (1.1.0)
       activerecord
       activerecord-import
       deep_pluck
@@ -9,132 +9,142 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (6.0.0)
-      actionview (= 6.0.0)
-      activesupport (= 6.0.0)
-      rack (~> 2.0)
+    actionpack (6.1.0)
+      actionview (= 6.1.0)
+      activesupport (= 6.1.0)
+      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.0)
-      activesupport (= 6.0.0)
+    actionview (6.1.0)
+      activesupport (= 6.1.0)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activemodel (6.0.0)
-      activesupport (= 6.0.0)
-    activerecord (6.0.0)
-      activemodel (= 6.0.0)
-      activesupport (= 6.0.0)
-    activerecord-import (1.0.2)
+    activemodel (6.1.0)
+      activesupport (= 6.1.0)
+    activerecord (6.1.0)
+      activemodel (= 6.1.0)
+      activesupport (= 6.1.0)
+    activerecord-import (1.0.7)
       activerecord (>= 3.2)
-    activesupport (6.0.0)
+    activesupport (6.1.0)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.1, >= 2.1.8)
-    ast (2.4.0)
-    builder (3.2.3)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.1)
+    builder (3.2.4)
     colorize (0.8.1)
-    concurrent-ruby (1.1.5)
-    crass (1.0.4)
-    database_cleaner (1.7.0)
-    deep_pluck (1.1.1)
+    concurrent-ruby (1.1.7)
+    crass (1.0.6)
+    database_cleaner (1.8.5)
+    deep_pluck (1.1.4)
       activerecord (>= 3)
       pluck_all (>= 1.2.3)
-    diff-lcs (1.3)
-    erubi (1.8.0)
-    fasterer (0.6.0)
+      rails_compatibility (>= 0.0.1)
+    diff-lcs (1.4.4)
+    erubi (1.10.0)
+    fasterer (0.8.3)
       colorize (~> 0.7)
-      ruby_parser (>= 3.13.0)
+      ruby_parser (>= 3.14.1)
     generator_spec (0.9.4)
       activesupport (>= 3.0.0)
       railties (>= 3.0.0)
-    i18n (1.6.0)
+    i18n (1.8.7)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.3)
-    loofah (2.2.3)
+    loofah (2.8.0)
       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.4)
-      mini_portile2 (~> 2.4.0)
-    parallel (1.17.0)
-    parser (2.6.3.0)
-      ast (~> 2.4.0)
-    pluck_all (2.0.4)
+    method_source (1.0.0)
+    mini_portile2 (2.5.0)
+    minitest (5.14.3)
+    nokogiri (1.11.1)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    pluck_all (2.2.1)
       activesupport (>= 3.0.0)
-    polyamorous (2.3.0)
-      activerecord (>= 5.0)
-    rack (2.0.7)
+      rails_compatibility (>= 0.0.2)
+    racc (1.5.2)
+    rack (2.2.3)
     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.2.0)
-      loofah (~> 2.2, >= 2.2.2)
-    railties (6.0.0)
-      actionpack (= 6.0.0)
-      activesupport (= 6.0.0)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    rails_compatibility (0.0.2)
+      activerecord (>= 3)
+    railties (6.1.0)
+      actionpack (= 6.1.0)
+      activesupport (= 6.1.0)
       method_source
       rake (>= 0.8.7)
-      thor (>= 0.20.3, < 2.0)
+      thor (~> 1.0)
     rainbow (3.0.0)
-    rake (12.3.3)
-    ransack (2.3.0)
-      actionpack (>= 5.0)
-      activerecord (>= 5.0)
-      activesupport (>= 5.0)
+    rake (13.0.3)
+    ransack (2.4.1)
+      activerecord (>= 5.2.4)
+      activesupport (>= 5.2.4)
       i18n
-      polyamorous (= 2.3.0)
-    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)
+    regexp_parser (2.0.3)
+    rexml (3.2.4)
+    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.8.0)
-    rspec-mocks (3.8.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.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.74.0)
-      jaro_winkler (~> 1.5.1)
+      rspec-support (~> 3.10.0)
+    rspec-rails (4.0.2)
+      actionpack (>= 4.2)
+      activesupport (>= 4.2)
+      railties (>= 4.2)
+      rspec-core (~> 3.10)
+      rspec-expectations (~> 3.10)
+      rspec-mocks (~> 3.10)
+      rspec-support (~> 3.10)
+    rspec-support (3.10.1)
+    rubocop (1.7.0)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    rubocop-performance (1.4.1)
-      rubocop (>= 0.71.0)
-    rubocop-rspec (1.35.0)
-      rubocop (>= 0.60.0)
-    ruby-progressbar (1.10.1)
-    ruby_parser (3.13.1)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.4.0)
+      parser (>= 2.7.1.5)
+    rubocop-performance (1.9.2)
+      rubocop (>= 0.90.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.5.1)
+      rubocop
+    rubocop-rspec (2.1.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    ruby_parser (3.15.0)
       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)
-    zeitwerk (2.1.9)
+    sexp_processor (4.15.1)
+    sqlite3 (1.4.2)
+    thor (1.0.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (1.7.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
@@ -151,8 +161,9 @@ DEPENDENCIES
   rspec-rails
   rubocop
   rubocop-performance
+  rubocop-rake
   rubocop-rspec
   sqlite3
 
 BUNDLED WITH
-   2.0.1
+   2.1.4

data/README.md

@@ -31,6 +31,7 @@ Or install it yourself as:
 * [Array](#array)
 * [Hash](#hash)
 * [Record](#record)
+* [Exporter](#exporter)
 * [Stream](#stream)
 * [Port](#port)
 
@@ -144,6 +145,32 @@ Lite::Report::Record.import(
 )
 ```
 
+## 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)
+    }
+  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/array.rb

@@ -7,7 +7,7 @@ class Lite::Report::Array < Lite::Report::Base
   end
 
   def import
-    CSV.foreach(@data, @csv_options)
+    CSV.foreach(@data, **@csv_options)
        .with_object([]) do |row, array|
          row = convert_to_array!(row)
          array << process_import_row!(row)

data/lib/lite/report/configuration.rb

@@ -10,7 +10,7 @@ module Lite
       def initialize
         @csv_options = {}
         @data_options = {}
-        @import_adapter = {}
+        @import_options = {}
       end
 
     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/hash.rb

@@ -8,7 +8,7 @@ class Lite::Report::Hash < Lite::Report::Base
   end
 
   def import
-    CSV.foreach(@data, @csv_options)
+    CSV.foreach(@data, **@csv_options)
        .with_object([]) do |row, array|
          next if header_row?(row)
 

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

@@ -10,7 +10,14 @@ module Lite
         def encode(cell)
           return cell unless cell.is_a?(String)
 
-          cell.tr('"', '').encode!(*@data_options[:encode])
+          cell = cell.tr('"', '')
+          return cell if @data_options[:encode].empty?
+
+          cell.encode!(
+            @data_options[:encode][0],
+            @data_options[:encode][1],
+            **@data_options[:encode][2]
+          )
         end
 
         def encode?(delete: false)

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

@@ -10,7 +10,7 @@ module Lite
         def class_columns(data)
           return data.klass.column_names if ransack_class?(data)
 
-          data.column_names
+          data.try(:column_names) || data.class.column_names
         end
 
         def klass

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

@@ -8,7 +8,7 @@ module Lite
         private
 
         def generate_export!
-          CSV.generate(@csv_options) do |csv|
+          CSV.generate(**@csv_options) do |csv|
             @data.each do |row|
               csv << process_export_row!(row)
             end
@@ -33,7 +33,7 @@ module Lite
 
             @data.each do |row|
               row = process_export_row!(row)
-              csv << CSV.generate_line(row, @csv_options)
+              csv << CSV.generate_line(row, **@csv_options)
             end
           end
         end

data/lib/lite/report/record.rb

@@ -18,7 +18,7 @@ class Lite::Report::Record < Lite::Report::Base
     @data = Lite::Report::Hash.import(@data, csv_options: @csv_options, data_options: @data_options)
                               .each { |row| row.delete(:id) || row.delete('id') }
 
-    klass.import(@data, @import_options)
+    klass.import(@data, **@import_options)
   end
 
   private
@@ -43,6 +43,7 @@ class Lite::Report::Record < Lite::Report::Base
     columns = class_columns(@data)
     @data = @data.result if ransack_class?(@data)
     @data = @data.deep_pluck(*columns)
+    @data = [@data] if !@data.respond_to?(:each) || !@data.is_a?(Array)
   end
 
   def generate_export!

data/lib/lite/report/version.rb

@@ -3,7 +3,7 @@
 module Lite
   module Report
 
-    VERSION ||= '1.0.2'
+    VERSION ||= '1.1.0'
 
   end
 end

data/lite-report.gemspec

@@ -51,6 +51,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.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Juan Gomez
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-08-24 00:00:00.000000000 Z
+date: 2021-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -192,6 +192,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  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: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -220,7 +234,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - j.gomez@drexed.com
 executables: []
@@ -249,6 +263,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
@@ -264,7 +279,7 @@ homepage: http://drexed.github.io/lite-report
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -279,8 +294,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
-signing_key: 
+rubygems_version: 3.2.4
+signing_key:
 specification_version: 4
 summary: Import and export Ruby and Rails objects to flat files and vice versa
 test_files: []