export_data 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86b436786e1d9b8b361706c377c622301a2d08592dc078ffa3466c0636cdb35c
-  data.tar.gz: 75be141bfb3c6bc41cedb5784a08e12169fd5e623a3edecfc0f61423237cad60
+  metadata.gz: 1ab81156058b3dfacec423e23f5e77b25f8433d4e1bbe0276e5e6a2ce93aa38e
+  data.tar.gz: 71ee5b2efc5e84bacfb1f553c0184ac958d0c9bc44cdd1f620a4bd1eb0844752
 SHA512:
-  metadata.gz: aa13331c6cfeb321435b526cb52894bfc695cf2f58bb49025072b59cd33e6b7b96e4c6a1cfea0e8cea09de378df7a72cc146a7a22b060cabe4433a4ddd4442a0
-  data.tar.gz: 200e95402b53ad395af2075cfcffdbd53cf41cc5b724eeb1e9ee57e63e2eb9c39109d30ecddbb0be6858c16d921e065c1e8197606c60a82344a7de5d4bc23ab0
+  metadata.gz: 3deda7a2fbaa674968ab65cdeb461f5fdcea89582120d3dbde83b18668879538729ab1ece8f85cd0d81f9540fc91b9bb10a0cefb130d639f2619d4d4873ca05b
+  data.tar.gz: f0423c7c7f728a287b78f34f304a65f5fc8f46334c4f7607b4009aa45d3a25fae6e1ccdc2eaa0f1c9aadfc5eb5c7b23384093922575e943e76aa3dab6a16a0f4

data/README.md

@@ -12,35 +12,59 @@ Then, run `bundle install` to install the gem.
 
 ## Usage
 
-To use the DataExport::Exporter class, follow these steps
-
-Assuming you have 50 `User` records in your database and your User model represents these records, you can follow these steps:
-
-1) Open your Rails console:
-
-```ruby
-  rails console
-```
-
-2) Retrieve the user records from your database:
+### Exporting Data to CSV
 
 ```ruby
-  users = User.all
+    require 'data_export_gem'
+    
+    # Prepare data
+    data = [
+      { id: 1, name: 'John', age: 30 },
+      { id: 2, name: 'Alice', age: 25 }
+    ]
+    
+    # Create an instance of the exporter
+    exporter = DataExportGem::Exporter.new
+    
+    # Export data to a CSV file
+    exporter.export_to_csv(data, 'output.csv')
 ```
-- This will fetch all the user records from your User model and store them in the users variable.
 
-3) Specify the file path where the CSV file will be saved:
+### Exporting Data to XLSX
 
 ```ruby
-  file_path = 'users.csv'
+    require 'data_export_gem'
+    
+    # Prepare data
+    data = [
+      { id: 1, name: 'John', age: 30 },
+      { id: 2, name: 'Alice', age: 25 }
+    ]
+    
+    # Create an instance of the exporter
+    exporter = DataExportGem::Exporter.new
+    
+    # Export data to a XLS file
+    exporter.export_to_xls(data, 'output.xls')
 ```
 
-4) Call the `DataExport::Exporter.export_to_csv` method to export the user records to the CSV file:
+### Exporting Data to Text
 
 ```ruby
-  DataExport::Exporter.export_to_csv(users, file_path)
+    require 'data_export_gem'
+    
+    # Prepare data
+    data = [
+      { id: 1, name: 'John', age: 30 },
+      { id: 2, name: 'Alice', age: 25 }
+    ]
+    
+    # Create an instance of the exporter
+    exporter = DataExportGem::Exporter.new
+    
+    # Export data to a TXT file
+    exporter.export_to_csv(data, 'output.txt')
 ```
-- This line exports the user records in the `users` variable to the specified CSV file.
 
 ## Development
 

data/export_data.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/ronakabhattrz/export_data"
   spec.metadata["changelog_uri"] = "https://github.com/ronakabhattrz/export_data/blob/main/CHANGELOG.md"
+  spec.metadata["documentation_uri"] = "https://www.rubydoc.info/gems/export_data/#{DataExport::VERSION}"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -28,8 +29,13 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
-
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 1.0"
+  spec.add_development_dependency "yard", "~> 0.9"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_runtime_dependency 'axlsx', '~> 2.0'
+  spec.add_runtime_dependency 'roo', '~> 2.0'
+  
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html
 end

data/lib/export_data/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DataExport
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/export_data.rb

@@ -12,17 +12,26 @@ module DataExport
     # Exports data to a CSV file.
     #
     # This method takes an array of objects and exports them to a CSV file
-    # specified by the `file_path`. It expects that the first object in the
-    # array defines the column names for the CSV file.
+    # specified by the `file_path`. It expects that each object's `attributes`
+    # method returns a hash of attribute names and values. The method first
+    # writes the header row using the attribute names from the first object,
+    # and then writes the data rows using the attribute values of each object.
     #
-    # @param objects [Array] The objects to export to CSV.
+    # @param objects [Array] The objects to export to a CSV file.
     # @param file_path [String] The path to the CSV file to be created.
     #
-    # @example Export user data to CSV:
+    # @example Export user data to a CSV file:
     #   objects = [user1, user2]
     #   DataExport::Exporter.export_to_csv(objects, 'users.csv')
     #
     # @return [void]
+    #
+    # @note If the `objects` array is empty, this method will output a message and
+    #   not create a file.
+    # @raise [CSV::MalformedCSVError] If an error occurs while writing to the CSV file,
+    #   an error message will be displayed.
+    # @raise [Errno::ENOENT] If an error occurs while creating or writing to the file,
+    #   an error message will be displayed.
     def self.export_to_csv(objects, file_path)
       begin
         CSV.open(file_path, 'w') do |csv|
@@ -46,6 +55,27 @@ module DataExport
       end
     end
     
+    # Exports data to a text file.
+    #
+    # This method takes an array of objects and exports them to a text file
+    # specified by the `file_path`. It expects that each object's `attributes`
+    # method returns an array of attribute values. Each attribute value is joined
+    # using a tab character ('\t') as a delimiter to create tab-separated values
+    # in the text file.
+    #
+    # @param objects [Array] The objects to export to a text file.
+    # @param file_path [String] The path to the text file to be created.
+    #
+    # @example Export user data to a text file:
+    #   objects = [user1, user2]
+    #   DataExport::Exporter.export_to_text(objects, 'users.txt')
+    #
+    # @return [void]
+    #
+    # @note If the `objects` array is empty, this method will output a message and
+    #   not create a file.
+    # @raise [Errno::ENOENT] If an error occurs while creating or writing to the file,
+    #   an error message will be displayed.
     def self.export_to_text(objects, file_path)
       begin
         File.open(file_path, 'w') do |file|
@@ -64,5 +94,50 @@ module DataExport
       end
     end
     
+    # ...
+    
+    # Exports data to an XLS (Excel) file.
+    #
+    # This method takes an array of objects and exports them to an XLS file
+    # specified by the `file_path`. It expects that each object's `attributes`
+    # method returns a hash of attribute names and values. The method creates an
+    # XLS workbook with a single worksheet and populates it with data from the
+    # objects.
+    #
+    # @param objects [Array] The objects to export to an XLS file.
+    # @param file_path [String] The path to the XLS file to be created.
+    #
+    # @example Export user data to an XLS file:
+    #   objects = [user1, user2]
+    #   DataExport::Exporter.export_to_xls(objects, 'users.xlsx')
+    #
+    # @return [void]
+    #
+    # @note If the `objects` array is empty, this method will create an empty XLS file.
+    # @raise [StandardError] If an error occurs while writing to the XLS file,
+    #   an error message will be displayed.
+    def self.export_to_xls(objects, file_path)
+      begin
+        Axlsx::Package.new do |p|
+          p.workbook.add_worksheet(name: 'Data') do |sheet|
+            if objects.empty?
+              puts 'No objects to export.' # Or handle this case as needed
+            else
+              # Write the header row using the attribute names from the first object
+              sheet.add_row(objects.first.attributes.keys)
+              
+              # Write the object's attribute values as data rows
+              objects.each do |obj|
+                sheet.add_row(obj.attributes.values)
+              end
+            end
+          end
+          p.serialize(file_path)
+        end
+      rescue StandardError => e
+        puts "An error occurred while exporting to XLS: #{e.message}"
+      end
+    end
+    
   end
 end

metadata

@@ -1,15 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: export_data
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - RONAK BHATT
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-05 00:00:00.000000000 Z
-dependencies: []
+date: 2023-09-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: axlsx
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: roo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 description: Simplify data import and export tasks in Rails applications.
 email:
 - ronakabhattrz@gmail.com
@@ -36,6 +120,7 @@ metadata:
   homepage_uri: https://github.com/ronakabhattrz/export_data
   source_code_uri: https://github.com/ronakabhattrz/export_data
   changelog_uri: https://github.com/ronakabhattrz/export_data/blob/main/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/export_data/0.4.0
 post_install_message:
 rdoc_options: []
 require_paths: