iprog_export_model_to_xlsx 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16fb880fb6db032ebf95a6af2552846b6c513eca11dde338ca141d0c9605488a
-  data.tar.gz: 63fbf3246266fe70cdd7828aa263e523274c6f9e04106e85cc9e169ea90a3985
+  metadata.gz: '0647085c8ca57f92dab776075b418c802a53e54e8c1963cdce368ed1fc45c323'
+  data.tar.gz: 2964cde8dd4ee9810e98bb03fcb33703abdbacf9dad92a17a407189ef3ea1fc3
 SHA512:
-  metadata.gz: 4decbe461688515865cef8e4a7e4a1a985465e44b2d3baa42a46d0f561c9d9a58f80b336ac9828b0be73c13d5636972234a7b0cb735e02448db226792aefcab4
-  data.tar.gz: 46310f025a69bc1eec6cc3292ee9c3f41affa98ed1a4e763d1092e981b357f49f3555c11e98f4ce59844632e505fbc8041444b4e07d55731c8d5da44035b8946
+  metadata.gz: f9ab6f3f7b913099c89bd891057029c2a60a6f250bb0a2acafd413d6380898407e9528687912429f53f43757130b62727af8d155a06440c79052916d5d916d3d
+  data.tar.gz: 5244e6f1e68cf8031de3cd9cd457be6f57b9b7d0bff8811071721292b25563720bcb3b74fd1b6f6c059067299a18d122f347fa83c3fbf698c5d27b95741d8682

data/README.md

@@ -1,9 +1,8 @@
-# IprogExportModelToXlsx
 
-Welcome to IprogExportModelToXlsx! This gem provides functionality to export ActiveRecord models to XLSX format.
+# Iprog Export Model ToXlsx
+Welcome to iprog_export_model_to_xlsx! This gem provides functionality to export ActiveRecord models to XLSX format.
 
 ## Installation
-
 To install the gem and add it to your application's Gemfile, run:
 
     $ bundle add iprog_export_model_to_xlsx
@@ -12,49 +11,128 @@ If you're not using Bundler to manage dependencies, install the gem by running:
 
     $ gem install iprog_export_model_to_xlsx
 
-## Usage
-
-To use the gem in your project, include it with:
+## Initialization
+To use the gem in your rails project, include it with:
 
+    # app/models/model.rb
     require 'iprog_export_model_to_xlsx'
-    
+
+    class Model < ApplicationRecord
+     extend IprogExportModelToXlsx
+    end
+
 You can then export your models to XLSX format as shown below.
 
 ### Basic Usage
-
 Export without any options:
 
-    Model.export_to_xlsx('models.xlsx')
+    # with default filepath
+    Model.export_to_xlsx 
+     Output file: rails_app_folder/models.xlsx
     
-### Usage with Options
+    # with custom filepath
+    Model.export_to_xlsx('public/custom_models.xlsx')
+     Output file: rails_app_folder/public/models.xlsx
 
+### Sample with Options in a Model Class
 You can customize the export by providing options:
-
-    options = {
-     exclude_columns: ['created_at', 'updated_at'],
-     limit: 100
-    }
+	
+	# adding custom class methods
+	require 'iprog_export_model_to_xlsx'
     
-    Model.export_to_xlsx('models.xlsx', options)
-
-## Development
-
-After cloning the repository, run `bin/setup` to install dependencies. For an interactive prompt to experiment with the code, run `bin/console`.
-
-To install the gem locally, use:
-
-    $ bundle exec rake install
-
-To release a new version, update the version number in `version.rb` and then run:
-
-    $ bundle exec rake release
-
-This will create a git tag for the version, push the git commits and the tag, and push the `.gem` file to [RubyGems.org](https://rubygems.org).
-
+    class Model < ApplicationRecord
+     extend IprogExportModelToXlsx
+     
+     def self.export_published_items_to_xlsx filepath = nil
+	  
+      # Custom condition
+	  custom_conditions = ->(scope) { scope.where(status: 'published') }
+	
+	  # Custom column formats
+	  column_formats = { 'status' => ->(value) { value.upcase } }
+
+	  # Custom progress callback
+	  custom_progress_callback = ->(current, total) { puts "Custom Progress: Exported #{current}/#{total} records" } 
+	
+      options = {
+       exclude_columns: ['created_at', 'updated_at'],
+       limit: 100,
+       conditions: custom_conditions,
+       column_formats: column_formats,
+       sheet_name: "Published Items",
+       progress_callback: custom_progress_callback
+      }
+    
+      # with custom filepath
+      export_to_xlsx(filepath, options)
+	    
+	  # OR
+	   
+	  # with default filepath
+	  export_to_xlsx(filepath, options)
+	 end
+	end
+	
+	# Usage with custom file path
+	 Model.export_published_items_to_xlsx("published_items.xlsx")
+	  Output: rails_app_folder/published_items.xlsx
+	 
+	# Usage with default file path
+	 Model.export_published_items_to_xlsx
+	  Output: rails_app_folder/models.xlsx
+  
+### Sample in a Service Class
+ Create a service class:
+   
+     # app/services/model_export_service.rb
+     class ModelExportService
+      attr_reader :model, :exclude_columns, :limit, :conditions, :sheet_name, :column_formats, :progress_callback
+      
+      def initialize(model, exclude_columns: [], limit: nil, conditions:  nil, sheet_name: nil, column_formats: {}, progress_callback: nil )
+       @model             = model.constantize
+       @exclude_columns   = exclude_columns
+       @limit             = limit
+       @conditions        = conditions
+       @sheet_name        = sheet_name
+       @column_formats    = column_formats
+       @progress_callback = progress_callback
+      end
+	  
+	  def export_to_xlsx(file_path = nil)
+	   options = {
+	    exclude_columns: exclude_columns,
+	    limit: limit,
+	    conditions: conditions,
+	    sheet_name: sheet_name,
+	    column_formats: column_formats,
+	    progress_callback: progress_callback
+	   }
+       
+       model.export_to_xlsx(file_path, options)
+      rescue StandardError => e
+       raise IprogExportModelToXlsx::Error, "Failed to export to XLSX: #{e.message}"
+	  end
+     end
+     
+     # Usage
+     model_export_service = ModelExportService.new("Model",
+       excluded_columns: ["created_at", "updated_at"], 
+       limit: 100, 
+       column_formats:  { 'status' => ->(value) { value.upcase } }, 
+       progress_callback: ->(current, total) { puts "Custom Progress: Exported #{current}/#{total} records" }
+     )
+     
+     # Usage with custom file path
+	  model_export_service.export_to_xlsx("published_items.xlsx")
+	   Output: rails_app_folder/published_items.xlsx
+	 
+	 # Usage with default file path
+	  model_export_service.export_to_xlsx
+	   Output: rails_app_folder/models.xlsx
+	 
+ 
 ## Contributing
-
 Bug reports and pull requests are welcome on GitHub at https://github.com/iprog21/iprog_export_model_to_xlsx.
 
 ## License
-
 This gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/iprog_export_model_to_xlsx/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module IprogExportModelToXlsx
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/iprog_export_model_to_xlsx.rb

@@ -6,26 +6,40 @@ require "axlsx"
 module IprogExportModelToXlsx
   class Error < StandardError; end
 
-  def export(file_path, options = {})
+  def export_to_xlsx(file_path = nil, options = {})
     exclude_columns = options[:exclude_columns] || []
-    limit           = options[:limit]
-    attributes      = attribute_names - exclude_columns
-    package         = Axlsx::Package.new
+    limit = options[:limit]
+    conditions = options[:conditions] || ->(scope) { scope }
+    sheet_name = options[:sheet_name] || self.name
+    column_formats = options[:column_formats] || {}
+    progress_callback = options[:progress_callback] || default_progress_callback
+    filtered_file_path = file_path || "#{self.name.to_s.downcase}s.xlsx"
 
-    package.workbook.add_worksheet(name: name) do |sheet|
-      # Headers
-      sheet.add_row attributes
+    attributes = self.attribute_names - exclude_columns
 
-      # Data
-      scope = all
+    workbook = Axlsx::Package.new
+    workbook.workbook.add_worksheet(name: sheet_name) do |sheet|
+      sheet.add_row(attributes.map(&:upcase))
+      scope = self.all
+      scope = conditions.call(scope)
       scope = scope.limit(limit) if limit
-      scope.each do |record|
-        sheet.add_row record.attributes.slice(*attributes).values
+      total_records = scope.size
+      scope.each_with_index do |record, index|
+        row_data = record.attributes.slice(*attributes).map do |attr, value|
+          column_formats[attr] ? column_formats[attr].call(value) : value
+        end
+        sheet.add_row(row_data)
+        progress_callback.call(index + 1, total_records)
       end
     end
-
-    package.serialize(file_path)
+    workbook.serialize(filtered_file_path)
   rescue StandardError => e
-    rails Iprog::Arde::Error, "Failed to export to XLSX: #{e.message}"
+    raise Iprog::Arde::Error, "Failed to export to XLSX: #{e.message}"
+  end
+
+  private
+
+  def default_progress_callback
+    ->(current, total) { puts "Exported #{current}/#{total} records" }
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iprog_export_model_to_xlsx
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Jayson Presto
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-04 00:00:00.000000000 Z
+date: 2024-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: caxlsx