iprog_export_model_to_xlsx 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 16fb880fb6db032ebf95a6af2552846b6c513eca11dde338ca141d0c9605488a
+  data.tar.gz: 63fbf3246266fe70cdd7828aa263e523274c6f9e04106e85cc9e169ea90a3985
+SHA512:
+  metadata.gz: 4decbe461688515865cef8e4a7e4a1a985465e44b2d3baa42a46d0f561c9d9a58f80b336ac9828b0be73c13d5636972234a7b0cb735e02448db226792aefcab4
+  data.tar.gz: 46310f025a69bc1eec6cc3292ee9c3f41affa98ed1a4e763d1092e981b357f49f3555c11e98f4ce59844632e505fbc8041444b4e07d55731c8d5da44035b8946

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Jayson Presto
+
+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,60 @@
+# IprogExportModelToXlsx
+
+Welcome to IprogExportModelToXlsx! 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
+
+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:
+
+    require 'iprog_export_model_to_xlsx'
+    
+You can then export your models to XLSX format as shown below.
+
+### Basic Usage
+
+Export without any options:
+
+    Model.export_to_xlsx('models.xlsx')
+    
+### Usage with Options
+
+You can customize the export by providing options:
+
+    options = {
+     exclude_columns: ['created_at', 'updated_at'],
+     limit: 100
+    }
+    
+    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).
+
+## 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/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "iprog_export_model_to_xlsx"
+
+# 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.
+
+require "irb"
+IRB.start(__FILE__)

data/bin/rubocop

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "rubygems"
+require "bundler/setup"
+
+# explicit rubocop config increases performance slightly while avoiding config confusion.
+ARGV.unshift("--config", File.expand_path("../.rubocop.yml", __dir__))
+
+load Gem.bin_path("rubocop", "rubocop")

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/iprog_export_model_to_xlsx/version.rb

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

data/lib/iprog_export_model_to_xlsx.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative "iprog_export_model_to_xlsx/version"
+require "axlsx"
+
+module IprogExportModelToXlsx
+  class Error < StandardError; end
+
+  def export(file_path, options = {})
+    exclude_columns = options[:exclude_columns] || []
+    limit           = options[:limit]
+    attributes      = attribute_names - exclude_columns
+    package         = Axlsx::Package.new
+
+    package.workbook.add_worksheet(name: name) do |sheet|
+      # Headers
+      sheet.add_row attributes
+
+      # Data
+      scope = all
+      scope = scope.limit(limit) if limit
+      scope.each do |record|
+        sheet.add_row record.attributes.slice(*attributes).values
+      end
+    end
+
+    package.serialize(file_path)
+  rescue StandardError => e
+    rails Iprog::Arde::Error, "Failed to export to XLSX: #{e.message}"
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: iprog_export_model_to_xlsx
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Jayson Presto
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-08-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: caxlsx
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+- !ruby/object:Gem::Dependency
+  name: caxlsx_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.4
+description: A gem for exporting activerecord data to XLSX files using the axlsx gem.
+email:
+- iprog21@jaysonpresto.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- bin/console
+- bin/rubocop
+- bin/setup
+- lib/iprog_export_model_to_xlsx.rb
+- lib/iprog_export_model_to_xlsx/version.rb
+homepage: https://github.com/iprog21/iprog_export_model_to_xlsx.git
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/iprog21/iprog_export_model_to_xlsx.git
+  source_code_uri: https://github.com/iprog21/iprog_export_model_to_xlsx.git
+  changelog_uri: https://github.com/iprog21/iprog_export_model_to_xlsx/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.14
+signing_key:
+specification_version: 4
+summary: A gem for exporting activerecord data to XLSX files.
+test_files: []