lite-report 1.0.0

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-leap-day

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'lite/report'
+
+# 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/generators/lite/report/install_generator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+module Lite
+  module Report
+    class InstallGenerator < Rails::Generators::Base
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_initializer_file
+        copy_file('install.rb', 'config/initializers/lite-report.rb')
+      end
+
+    end
+  end
+end

data/lib/generators/lite/report/templates/install.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+Lite::Report.configure do |config|
+  config.csv_options = {}
+  config.data_options = {}
+  config.import_options = {}
+end

data/lib/lite/report.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'csv'
+require 'lite/report/version'
+
+%w[converters encoders filters headers processors records transporters].each do |file_name|
+  require "lite/report/helpers/#{file_name}"
+end
+
+%w[configuration base array hash record].each do |file_name|
+  require "lite/report/#{file_name}"
+end
+
+require 'generators/lite/report/install_generator'

data/lib/lite/report/array.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class Lite::Report::Array < Lite::Report::Base
+
+  def export
+    generate_or_stream_export!
+  end
+
+  def import
+    CSV.foreach(@data, @csv_options)
+       .with_object([]) do |row, array|
+         row = convert_to_array!(row)
+         array << process_import_row!(row)
+       end
+  end
+
+end

data/lib/lite/report/base.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+class Lite::Report::Base
+
+  include Lite::Report::Helpers::Converters
+  include Lite::Report::Helpers::Encoders
+  include Lite::Report::Helpers::Filters
+  include Lite::Report::Helpers::Headers
+  include Lite::Report::Helpers::Processors
+  include Lite::Report::Helpers::Records
+  include Lite::Report::Helpers::Transporters
+
+  def initialize(data, csv_options: {}, data_options: {}, import_options: {})
+    @data = data
+    @csv_options = Lite::Report.configuration.csv_options.merge(csv_options)
+    @data_options = Lite::Report.configuration.data_options.merge(data_options)
+    @import_options = Lite::Report.configuration.import_options.merge(import_options)
+  end
+
+  class << self
+
+    def export(data, csv_options: {}, data_options: {}, import_options: {})
+      klass = new(
+        data,
+        csv_options: csv_options,
+        data_options: data_options,
+        import_options: import_options
+      )
+
+      klass.export
+    end
+
+    def import(data, csv_options: {}, data_options: {}, import_options: {})
+      klass = new(
+        data,
+        csv_options: csv_options,
+        data_options: data_options,
+        import_options: import_options
+      )
+
+      klass.import
+    end
+
+  end
+
+  private
+
+  def values!(row)
+    case row.class.name
+    when 'CSV::Row' then row.fields
+    when 'Hash' then row.values
+    else row
+    end
+  end
+
+end

data/lib/lite/report/configuration.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Lite
+  module Report
+
+    class Configuration
+
+      attr_accessor :csv_options, :data_options, :import_options
+
+      def initialize
+        @csv_options = {}
+        @data_options = {}
+        @import_adapter = {}
+      end
+
+    end
+
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    def self.configuration=(config)
+      @configuration = config
+    end
+
+    def self.configure
+      yield(configuration)
+    end
+
+  end
+end

data/lib/lite/report/hash.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+class Lite::Report::Hash < Lite::Report::Base
+
+  def export
+    assign_headers_to_csv_options!
+    generate_or_stream_export!
+  end
+
+  def import
+    CSV.foreach(@data, @csv_options)
+       .with_object([]) do |row, array|
+         next if header_row?(row)
+
+         row = convert_to_hash!(row)
+         array << process_import_row!(row)
+       end
+  end
+
+  private
+
+  def assign_headers_to_csv_options!
+    return unless write_headers?
+
+    @csv_options[:headers] ||= @data.first.keys
+  end
+
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Lite
+  module Report
+    module Helpers
+      module Converters
+
+        private
+
+        def convert_to_array!(row)
+          case row.class.name
+          when 'CSV::Row' then row.fields
+          else row
+          end
+        end
+
+        def convert_to_hash!(row)
+          case row.class.name
+          when 'Array' then ::Hash[(0..(row.size - 1)).zip(row)]
+          when 'CSV::Row' then row.to_hash
+          else row
+          end
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Lite
+  module Report
+    module Helpers
+      module Encoders
+
+        private
+
+        def encode(cell)
+          return cell unless cell.is_a?(String)
+
+          cell.tr('"', '').encode!(*@data_options[:encode])
+        end
+
+        def encode?(delete: false)
+          return @data_options.delete(:encode) if delete
+
+          @data_options[:encode]
+        end
+
+        def encode!(row)
+          case row.class.name
+          when 'Hash' then encode_hash!(row)
+          else encode_array!(row)
+          end
+        end
+
+        def encode_array!(row)
+          row.map { |cell| encode(cell) }
+        end
+
+        def encode_hash!(row)
+          row.map.with_object({}) do |(key, val), hash|
+            hash[encode(key)] = encode(val)
+          end
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Lite
+  module Report
+    module Helpers
+      module Filters
+
+        private
+
+        def except?(delete: false)
+          return @data_options.delete(:except) if delete
+
+          @data_options[:except]
+        end
+
+        def filter?(delete: false)
+          only?(delete: delete) || except?(delete: delete)
+        end
+
+        def filter!(row)
+          case row.class.name
+          when 'Array' then filter_array!(row)
+          when 'Hash' then filter_hash!(row)
+          end
+        end
+
+        def filter_array!(row)
+          if only?
+            row.keep_if.with_index { |_, i| @data_options[:only].include?(i) }
+          elsif except?
+            row.delete_if.with_index { |_, i| @data_options[:except].include?(i) }
+          else
+            row
+          end
+        end
+
+        def filter_hash!(row)
+          if only?
+            row.keep_if { |key, _| @data_options[:only].include?(key) }
+          elsif except?
+            row.keep_if { |key, _| @data_options[:except].include?(key) }
+          else
+            row
+          end
+        end
+
+        def only?(delete: false)
+          return @data_options.delete(:only) if delete
+
+          @data_options[:only]
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Lite
+  module Report
+    module Helpers
+      module Headers
+
+        private
+
+        def header_row?(row)
+          return false unless row.respond_to?(:header_row?)
+
+          row.header_row?
+        end
+
+        def headers?(delete: false)
+          return @csv_options.delete(:headers) if delete
+
+          @csv_options[:headers]
+        end
+
+        def return_headers?(delete: false)
+          return @csv_options.delete(:return_headers) if delete
+
+          @csv_options[:return_headers]
+        end
+
+        def write_headers?(delete: false)
+          return @csv_options.delete(:write_headers) if delete
+
+          @csv_options[:write_headers]
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Lite
+  module Report
+    module Helpers
+      module Processors
+
+        private
+
+        def process_export_row!(row)
+          row = filter!(row) if filter?
+          row = values!(row)
+          row = encode!(row) if encode?
+          row
+        end
+
+        def process_import_row!(row)
+          row = filter!(row) if filter?
+          row = encode!(row) if encode?
+          row
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Lite
+  module Report
+    module Helpers
+      module Records
+
+        private
+
+        def class_columns(data)
+          return data.klass.column_names if ransack_class?(data)
+
+          data.column_names
+        end
+
+        def klass
+          @data_options[:klass]
+        end
+
+        def ransack_class?(data)
+          return false unless defined?(Ransack)
+
+          data.is_a?(Ransack::Search)
+        end
+
+      end
+    end
+  end
+end