rails-excel-reporter 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 980f4f3ce34363580563962788c6d6066d88bca4c156d11bfc6a4305a9f23e03
-  data.tar.gz: 218cff5d4b639629b76e48262e17ec3ffe180c773c83b3ec7cd558a822129d1e
+  metadata.gz: 9b6f920ce797a160c37ecc253bc0046b4212df1857966fec30100d4fcdad15d2
+  data.tar.gz: 5f9d145e21d5a5970178d8da52a1972345e78a6b64777bc05a7954dcf71b1cef
 SHA512:
-  metadata.gz: 16418a929a485fd2e1215280024b0a366b6cefc65a08b9df506a5fff40cb255473ab6ae52fd28406cd19699e2ce44a0f8b1ac098e8691f201006ea7d31c5be24
-  data.tar.gz: 4acfa9b21a2f59426b7a19abb3471f960c4042f51eac7fb4fd4dd74356ed3f86ed28a3cbbf8dd5d9376bfe91e06b83dc161ed29feba7018cae4939a94b2581b8
+  metadata.gz: 23ee34c51036cc83cd9030ea76466b76a1af1778e6817ceac117d760569ea327e9b93c18c222ee4909349f346bda6c4a1334813db47fc452e28061f1ca71c9b7
+  data.tar.gz: 62953ee7433e7dc98483013549b1a1d32d5e80b5a90a7296a1754856b3269baab298db3a927c1e7eb3d17ed4ad51a1dcce52422426185dcb84eec8a7a3cc84a0

data/Gemfile

@@ -3,3 +3,8 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'rake', '~> 13.0'
+
+group :development, :test do
+  gem 'rubocop', '~> 1.78'
+  gem 'rubocop-performance', '~> 1.24'
+end

data/Gemfile.lock

@@ -1,10 +1,10 @@
 PATH
   remote: .
   specs:
-    rails-excel-reporter (0.2.0)
-      activesupport (>= 7.0)
+    rails-excel-reporter (1.0.0)
+      activesupport (>= 8.0)
       caxlsx (~> 4.0)
-      rails (>= 7.0)
+      rails (>= 8.0)
 
 GEM
   remote: https://rubygems.org/
@@ -125,6 +125,7 @@ GEM
     marcel (1.0.4)
     method_source (1.1.0)
     mini_mime (1.1.5)
+    mini_portile2 (2.8.9)
     minitest (5.25.5)
     net-imap (0.5.9)
       date
@@ -247,6 +248,10 @@ GEM
     rubocop-ast (1.45.1)
       parser (>= 3.3.7.2)
       prism (~> 1.4)
+    rubocop-performance (1.25.0)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
     ruby-progressbar (1.13.0)
     rubyzip (2.4.1)
     securerandom (0.4.1)
@@ -256,6 +261,8 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.13.1)
     simplecov_json_formatter (0.1.4)
+    sqlite3 (1.7.3)
+      mini_portile2 (~> 2.8.0)
     sqlite3 (1.7.3-aarch64-linux)
     sqlite3 (1.7.3-arm-linux)
     sqlite3 (1.7.3-arm64-darwin)
@@ -297,7 +304,8 @@ DEPENDENCIES
   rake (~> 13.0)
   rspec (~> 3.0)
   rspec-rails (~> 5.0)
-  rubocop (~> 1.0)
+  rubocop (~> 1.78)
+  rubocop-performance (~> 1.24)
   simplecov (~> 0.21)
   sqlite3 (~> 1.4)
   yard (~> 0.9)

data/README.md

@@ -463,8 +463,8 @@ end
 
 ## Requirements
 
-- Ruby 2.7+
-- Rails 7.0+
+- Ruby 3.2+
+- Rails 8.0+
 - caxlsx ~> 4.0
 
 ## Contributing

data/lib/rails_excel_reporter/base.rb

@@ -23,16 +23,18 @@ module RailsExcelReporter
       if attrs.empty?
         @attributes ||= []
       else
-        @attributes = attrs.map do |attr|
-          case attr
-          when Symbol
-            { name: attr, header: attr.to_s.humanize }
-          when Hash
-            symbolize_hash_keys(attr)
-          else
-            { name: attr.to_sym, header: attr.to_s.humanize }
-          end
-        end
+        @attributes = attrs.map { |attr| process_attribute attr }
+      end
+    end
+
+    def self.process_attribute(attr)
+      case attr
+      when Symbol
+        { name: attr, header: attr.to_s.humanize }
+      when Hash
+        symbolize_hash_keys(attr)
+      else
+        { name: attr.to_sym, header: attr.to_s.humanize }
       end
     end
 
@@ -51,7 +53,7 @@ module RailsExcelReporter
 
     def self.inherited(subclass)
       super
-      subclass.instance_variable_set(:@attributes, @attributes.dup) if @attributes
+      subclass.instance_variable_set :@attributes, @attributes.dup if @attributes
     end
 
     def attributes
@@ -70,18 +72,18 @@ module RailsExcelReporter
     end
 
     def save_to(path)
-      File.open(path, 'wb') do |file|
-        file.write(to_xlsx)
+      File.open path, 'wb' do |file|
+        file.write to_xlsx
       end
     end
 
     def filename
-      timestamp = Time.now.strftime(RailsExcelReporter.config.date_format).gsub('-', '_')
+      timestamp = Time.now.strftime(RailsExcelReporter.config.date_format).gsub '-', '_'
       "#{worksheet_name.parameterize}_report_#{timestamp}.xlsx"
     end
 
     def stream
-      StringIO.new(to_xlsx)
+      StringIO.new to_xlsx
     end
 
     def to_h
@@ -114,25 +116,29 @@ module RailsExcelReporter
 
     def render
       validate_attributes!
-
       before_render
 
-      @tempfile = Tempfile.new([filename.gsub('.xlsx', ''), '.xlsx'],
-                               RailsExcelReporter.config.temp_directory)
-
-      package = ::Axlsx::Package.new
-      workbook = package.workbook
+      create_tempfile
+      create_worksheet
 
-      worksheet = workbook.add_worksheet(name: worksheet_name)
+      @rendered = true
+      after_render
+    end
 
-      add_headers(worksheet)
-      add_data_rows(worksheet)
+    def create_tempfile
+      @tempfile = Tempfile.new [filename.gsub('.xlsx', ''), '.xlsx'],
+                               RailsExcelReporter.config.temp_directory
+    end
 
-      package.serialize(@tempfile.path)
+    def create_worksheet
+      package = ::Axlsx::Package.new
+      workbook = package.workbook
+      worksheet = workbook.add_worksheet name: worksheet_name
 
-      @rendered = true
+      add_headers worksheet
+      add_data_rows worksheet
 
-      after_render
+      package.serialize @tempfile.path
     end
 
     def validate_attributes!
@@ -141,56 +147,79 @@ module RailsExcelReporter
 
     def add_headers(worksheet)
       header_values = attributes.map { |attr| attr[:header] }
-      header_style = build_caxlsx_style(get_header_style)
+      add_header_row worksheet, header_values
+      add_auto_filter worksheet
+    end
+
+    def add_header_row(worksheet, header_values)
+      header_style = build_caxlsx_style get_header_style
 
       if header_style.any?
-        style_id = worksheet.workbook.styles.add_style(header_style)
-        worksheet.add_row(header_values, style: style_id)
+        style_id = worksheet.workbook.styles.add_style header_style
+        worksheet.add_row header_values, style: style_id
       else
-        worksheet.add_row(header_values)
+        worksheet.add_row header_values
       end
+    end
 
-      worksheet.auto_filter = "A1:#{column_letter(attributes.size)}1"
+    def add_auto_filter(worksheet)
+      worksheet.auto_filter = "A1:#{column_letter attributes.size}1"
     end
 
     def add_data_rows(worksheet)
       with_progress_tracking do |object, _progress|
-        before_row(object)
-
-        row_values = attributes.map do |attr|
-          get_attribute_value(object, attr[:name])
-        end
+        process_data_row worksheet, object
+      end
+    end
 
-        row_styles = attributes.map do |attr|
-          style_options = build_caxlsx_style(get_column_style(attr[:name]))
-          worksheet.workbook.styles.add_style(style_options) if style_options.any?
-        end
+    def process_data_row(worksheet, object)
+      before_row object
+      row_values = build_row_values object
+      row_styles = build_row_styles worksheet
+      worksheet.add_row row_values, style: row_styles
+      after_row object
+    end
 
-        worksheet.add_row(row_values, style: row_styles)
+    def build_row_values(object)
+      attributes.map do |attr|
+        get_attribute_value object, attr[:name]
+      end
+    end
 
-        after_row(object)
+    def build_row_styles(worksheet)
+      attributes.map do |attr|
+        style_options = build_caxlsx_style get_column_style(attr[:name])
+        worksheet.workbook.styles.add_style style_options if style_options.any?
       end
     end
 
     def get_attribute_value(object, attribute_name)
-      if respond_to?(attribute_name)
-        @object = object
-        result = send(attribute_name)
-        @object = nil
-        result
-      elsif object.respond_to?(attribute_name)
-        object.send(attribute_name)
-      elsif object.respond_to?(:[])
-        object[attribute_name] || object[attribute_name.to_s]
+      if respond_to? attribute_name
+        call_custom_method object, attribute_name
+      elsif object.respond_to? attribute_name
+        object.send attribute_name
+      elsif object.respond_to? :[]
+        get_hash_value object, attribute_name
       end
     end
 
+    def call_custom_method(object, attribute_name)
+      @object = object
+      result = send attribute_name
+      @object = nil
+      result
+    end
+
+    def get_hash_value(object, attribute_name)
+      object[attribute_name] || object[attribute_name.to_s]
+    end
+
     attr_reader :object
 
     def collection_data
       @collection_data ||= stream_data.map do |item|
         attributes.map do |attr|
-          get_attribute_value(item, attr[:name])
+          get_attribute_value item, attr[:name]
         end
       end
     end

data/lib/rails_excel_reporter/configuration.rb

@@ -3,17 +3,7 @@ module RailsExcelReporter
     attr_accessor :default_styles, :date_format, :streaming_threshold, :temp_directory
 
     def initialize
-      @default_styles = {
-        header: {
-          bg_color: '4472C4',
-          fg_color: 'FFFFFF',
-          bold: true,
-          border: { style: :thin, color: '000000' }
-        },
-        cell: {
-          border: { style: :thin, color: 'CCCCCC' }
-        }
-      }
+      @default_styles = default_style_config
       @date_format = '%Y-%m-%d'
       @streaming_threshold = 1000
       @temp_directory = nil
@@ -22,6 +12,30 @@ module RailsExcelReporter
     def temp_directory
       @temp_directory || Dir.tmpdir
     end
+
+    private
+
+    def default_style_config
+      {
+        header: header_style,
+        cell: cell_style
+      }
+    end
+
+    def header_style
+      {
+        bg_color: '4472C4',
+        fg_color: 'FFFFFF',
+        bold: true,
+        border: { style: :thin, color: '000000' }
+      }
+    end
+
+    def cell_style
+      {
+        border: { style: :thin, color: 'CCCCCC' }
+      }
+    end
   end
 
   class << self
@@ -30,7 +44,7 @@ module RailsExcelReporter
     end
 
     def configure
-      yield(configuration)
+      yield configuration
     end
 
     def config

data/lib/rails_excel_reporter/controller_helpers.rb

@@ -4,31 +4,38 @@ module RailsExcelReporter
       filename = options[:filename] || report.filename
       disposition = options[:disposition] || 'attachment'
 
-      send_data(
+      send_data \
         report.to_xlsx,
         filename: filename,
-        type: 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
+        type: excel_content_type,
         disposition: disposition
-      )
     end
 
     def stream_excel_report(report, options = {})
       filename = options[:filename] || report.filename
-
-      response.headers['Content-Type'] = 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
-      response.headers['Content-Disposition'] = "attachment; filename=\"#{filename}\""
-      response.headers['Content-Transfer-Encoding'] = 'binary'
-      response.headers['Last-Modified'] = Time.now.httpdate
-
+      set_excel_response_headers filename
       self.response_body = report.stream
     end
 
     def excel_report_response(report, options = {})
       if report.should_stream?
-        stream_excel_report(report, options)
+        stream_excel_report report, options
       else
-        send_excel_report(report, options)
+        send_excel_report report, options
       end
     end
+
+    private
+
+    def set_excel_response_headers(filename)
+      response.headers['Content-Type'] = excel_content_type
+      response.headers['Content-Disposition'] = "attachment; filename=\"#{filename}\""
+      response.headers['Content-Transfer-Encoding'] = 'binary'
+      response.headers['Last-Modified'] = Time.now.httpdate
+    end
+
+    def excel_content_type
+      'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
+    end
   end
 end

data/lib/rails_excel_reporter/railtie.rb

@@ -7,29 +7,42 @@ module RailsExcelReporter
     end
 
     initializer 'rails_excel_reporter.include_controller_helpers' do
-      ActiveSupport.on_load(:action_controller) do
+      ActiveSupport.on_load :action_controller do
         include RailsExcelReporter::ControllerHelpers
       end
     end
 
     config.after_initialize do
-      if defined?(Rails.application) && Rails.application
-        begin
-          reports_path = Rails.root.join('app/reports')
-
-          if Rails.application.paths['app/reports']
-            unless Rails.application.paths['app/reports'].paths.include?(reports_path.to_s)
-              Rails.application.paths['app/reports'] << reports_path.to_s
-            end
-
-            if Rails.application.paths['app/reports'].respond_to?(:eager_load!)
-              Rails.application.paths['app/reports'].eager_load!
-            end
-          end
-        rescue StandardError => e
-          Rails.logger.warn("RailsExcelReporter: Failed to configure app/reports path: #{e.message}") if Rails.logger
-        end
+      configure_reports_path if rails_application_available?
+    end
+
+    private
+
+    def self.rails_application_available?
+      defined?(Rails.application) && Rails.application
+    end
+
+    def self.configure_reports_path
+      reports_path = Rails.root.join 'app/reports'
+      setup_reports_path reports_path if Rails.application.paths['app/reports']
+    rescue StandardError => e
+      log_configuration_warning e
+    end
+
+    def self.setup_reports_path(reports_path)
+      app_reports_paths = Rails.application.paths['app/reports']
+
+      unless app_reports_paths.paths.include? reports_path.to_s
+        app_reports_paths << reports_path.to_s
       end
+
+      app_reports_paths.eager_load! if app_reports_paths.respond_to? :eager_load!
+    end
+
+    def self.log_configuration_warning(error)
+      return unless Rails.logger
+
+      Rails.logger.warn "RailsExcelReporter: Failed to configure app/reports path: #{error.message}"
     end
   end
 end

data/lib/rails_excel_reporter/streaming.rb

@@ -1,7 +1,7 @@
 module RailsExcelReporter
   module Streaming
     def self.included(base)
-      base.extend(ClassMethods)
+      base.extend ClassMethods
     end
 
     module ClassMethods
@@ -21,19 +21,23 @@ module RailsExcelReporter
     def collection_size
       return @collection_size if defined?(@collection_size)
 
-      @collection_size = if @collection.respond_to?(:count)
-                           @collection.count
-                         elsif @collection.respond_to?(:size)
-                           @collection.size
-                         elsif @collection.respond_to?(:length)
-                           @collection.length
-                         else
-                           @collection.to_a.size
-                         end
+      @collection_size = calculate_collection_size
     end
 
+    private
+
+    def calculate_collection_size
+      return @collection.count if @collection.respond_to? :count
+      return @collection.size if @collection.respond_to? :size
+      return @collection.length if @collection.respond_to? :length
+
+      @collection.to_a.size
+    end
+
+    public
+
     def stream_data(&block)
-      return enum_for(:stream_data) unless block_given?
+      return enum_for :stream_data unless block_given?
 
       if should_stream?
         stream_large_dataset(&block)
@@ -43,27 +47,26 @@ module RailsExcelReporter
     end
 
     def with_progress_tracking
-      return enum_for(:with_progress_tracking) unless block_given?
-
-      total = collection_size
-      current = 0
+      return enum_for :with_progress_tracking unless block_given?
 
+      total, current = collection_size, 0
       stream_data do |item|
         current += 1
-        progress = OpenStruct.new(current: current, total: total, percentage: (current.to_f / total * 100).round(2))
-
-        @progress_callback&.call(progress)
-
+        progress = build_progress_info current, total
+        @progress_callback&.call progress
         yield item, progress
       end
     end
 
-    private
+    def build_progress_info(current, total)
+      percentage = (current.to_f / total * 100).round 2
+      OpenStruct.new current: current, total: total, percentage: percentage
+    end
 
     def stream_large_dataset(&block)
-      if @collection.respond_to?(:find_each)
+      if @collection.respond_to? :find_each
         @collection.find_each(batch_size: 1000, &block)
-      elsif @collection.respond_to?(:each)
+      elsif @collection.respond_to? :each
         @collection.each(&block)
       else
         @collection.to_a.each(&block)
@@ -71,7 +74,7 @@ module RailsExcelReporter
     end
 
     def stream_small_dataset(&block)
-      if @collection.respond_to?(:each)
+      if @collection.respond_to? :each
         @collection.each(&block)
       else
         @collection.to_a.each(&block)

data/lib/rails_excel_reporter/styling.rb

@@ -1,7 +1,7 @@
 module RailsExcelReporter
   module Styling
     def self.included(base)
-      base.extend(ClassMethods)
+      base.extend ClassMethods
     end
 
     module ClassMethods
@@ -16,7 +16,7 @@ module RailsExcelReporter
 
       def inherited(subclass)
         super
-        subclass.instance_variable_set(:@styles, @styles.dup) if @styles
+        subclass.instance_variable_set :@styles, @styles.dup if @styles
       end
     end
 
@@ -24,36 +24,37 @@ module RailsExcelReporter
       style_options = self.class.styles[style_name.to_sym] || {}
       return unless style_options.any?
 
-      worksheet.add_style(cell_range, style_options)
+      worksheet.add_style cell_range, style_options
     end
 
     def build_caxlsx_style(style_options)
       caxlsx_options = {}
+      apply_style_mappings caxlsx_options, style_options
+      caxlsx_options
+    end
 
-      caxlsx_options[:bg_color] = style_options[:bg_color] if style_options[:bg_color]
-
-      caxlsx_options[:fg_color] = style_options[:fg_color] if style_options[:fg_color]
-
-      caxlsx_options[:b] = style_options[:bold] if style_options[:bold]
-
-      caxlsx_options[:i] = style_options[:italic] if style_options[:italic]
-
-      caxlsx_options[:alignment] = style_options[:alignment] if style_options[:alignment]
-
-      caxlsx_options[:border] = style_options[:border] if style_options[:border]
-
-      caxlsx_options[:sz] = style_options[:font_size] if style_options[:font_size]
+    private
 
-      caxlsx_options[:font_name] = style_options[:font_name] if style_options[:font_name]
+    def apply_style_mappings(caxlsx_options, style_options)
+      style_mappings.each do |from_key, to_key|
+        caxlsx_options[to_key] = style_options[from_key] if style_options[from_key]
+      end
+    end
 
-      caxlsx_options
+    def style_mappings
+      {
+        bg_color: :bg_color, fg_color: :fg_color, bold: :b, italic: :i,
+        alignment: :alignment, border: :border, font_size: :sz, font_name: :font_name
+      }
     end
 
+    public
+
     def merge_styles(*style_names)
       merged = {}
       style_names.each do |style_name|
         style_options = self.class.styles[style_name.to_sym] || {}
-        merged = deep_merge_hashes(merged, style_options)
+        merged = deep_merge_hashes merged, style_options
       end
       merged
     end
@@ -61,13 +62,13 @@ module RailsExcelReporter
     def get_column_style(column_name)
       column_style = self.class.styles[column_name.to_sym] || {}
       default_style = RailsExcelReporter.config.default_styles[:cell] || {}
-      deep_merge_hashes(default_style, column_style)
+      deep_merge_hashes default_style, column_style
     end
 
     def get_header_style
       header_style = self.class.styles[:header] || {}
       default_style = RailsExcelReporter.config.default_styles[:header] || {}
-      deep_merge_hashes(default_style, header_style)
+      deep_merge_hashes default_style, header_style
     end
 
     private
@@ -75,13 +76,17 @@ module RailsExcelReporter
     def deep_merge_hashes(hash1, hash2)
       result = hash1.dup
       hash2.each do |key, value|
-        result[key] = if result[key].is_a?(Hash) && value.is_a?(Hash)
-                        deep_merge_hashes(result[key], value)
-                      else
-                        value
-                      end
+        result[key] = merge_hash_value result[key], value
       end
       result
     end
+
+    def merge_hash_value(existing_value, new_value)
+      if existing_value.is_a?(Hash) && new_value.is_a?(Hash)
+        deep_merge_hashes existing_value, new_value
+      else
+        new_value
+      end
+    end
   end
 end

data/lib/rails_excel_reporter/version.rb

@@ -1,3 +1,3 @@
 module RailsExcelReporter
-  VERSION = '0.3.0'
+  VERSION = '1.0.0'
 end

data/rails_excel_reporter.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.description   = 'A Ruby gem that integrates seamlessly with Ruby on Rails to generate Excel reports using a simple DSL. Features include streaming, styling, callbacks, and Rails helpers.'
   spec.homepage      = 'https://github.com/EliSebastian/rails-excel-reporter.git'
   spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
+  spec.required_ruby_version = Gem::Requirement.new '>= 3.2.0'
 
   spec.metadata['allowed_push_host'] = 'https://rubygems.org'
   spec.metadata['homepage_uri'] = spec.homepage
@@ -22,14 +22,13 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'activesupport', '>= 7.0'
+  spec.add_dependency 'activesupport', '>= 8.0'
   spec.add_dependency 'caxlsx', '~> 4.0'
-  spec.add_dependency 'rails', '>= 7.0'
+  spec.add_dependency 'rails', '>= 8.0'
 
   spec.add_development_dependency 'pry', '~> 0.14'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rspec-rails', '~> 5.0'
-  spec.add_development_dependency 'rubocop', '~> 1.0'
   spec.add_development_dependency 'simplecov', '~> 0.21'
   spec.add_development_dependency 'sqlite3', '~> 1.4'
   spec.add_development_dependency 'yard', '~> 0.9'

data/spec/rails_excel_reporter/base_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 RSpec.describe RailsExcelReporter::Base do
-  let(:sample_data) do
+  let :sample_data do
     [
       OpenStruct.new(id: 1, name: 'John Doe', email: 'john@example.com', created_at: Time.parse('2024-01-01')),
       OpenStruct.new(id: 2, name: 'Jane Smith', email: 'jane@example.com', created_at: Time.parse('2024-01-02')),
@@ -9,8 +9,8 @@ RSpec.describe RailsExcelReporter::Base do
     ]
   end
 
-  let(:report_class) do
-    Class.new(RailsExcelReporter::Base) do
+  let :report_class do
+    Class.new RailsExcelReporter::Base do
       attributes :id, :name, :email
 
       def name
@@ -19,7 +19,7 @@ RSpec.describe RailsExcelReporter::Base do
     end
   end
 
-  let(:report) { report_class.new(sample_data) }
+  let(:report) { report_class.new sample_data }
 
   describe 'class methods' do
     describe '.attributes' do
@@ -34,7 +34,7 @@ RSpec.describe RailsExcelReporter::Base do
 
     describe '.attribute' do
       it 'adds a single attribute with custom header' do
-        klass = Class.new(RailsExcelReporter::Base)
+        klass = Class.new RailsExcelReporter::Base
         klass.attribute :custom_field, header: 'Custom Header'
 
         expect(klass.attributes).to contain_exactly(
@@ -51,7 +51,7 @@ RSpec.describe RailsExcelReporter::Base do
       end
 
       it 'accepts custom worksheet name' do
-        custom_report = report_class.new(sample_data, worksheet_name: 'Custom Sheet')
+        custom_report = report_class.new sample_data, worksheet_name: 'Custom Sheet'
         expect(custom_report.worksheet_name).to eq('Custom Sheet')
       end
 
@@ -94,8 +94,8 @@ RSpec.describe RailsExcelReporter::Base do
       end
 
       it 'returns true for large collections' do
-        large_data = (1..2000).map { |i| OpenStruct.new(id: i, name: "User #{i}") }
-        large_report = report_class.new(large_data)
+        large_data = (1..2000).map { |i| OpenStruct.new id: i, name: "User #{i}" }
+        large_report = report_class.new large_data
         expect(large_report.should_stream?).to be true
       end
     end
@@ -116,10 +116,10 @@ RSpec.describe RailsExcelReporter::Base do
 
       it 'saves to file' do
         temp_path = '/tmp/test_report.xlsx'
-        report.save_to(temp_path)
+        report.save_to temp_path
         expect(File.exist?(temp_path)).to be true
         expect(File.size(temp_path)).to be > 0
-        File.delete(temp_path)
+        File.delete temp_path
       end
     end
 
@@ -135,16 +135,16 @@ RSpec.describe RailsExcelReporter::Base do
 
   describe 'error handling' do
     it 'raises error when no attributes are defined' do
-      empty_class = Class.new(RailsExcelReporter::Base)
-      empty_report = empty_class.new([])
+      empty_class = Class.new RailsExcelReporter::Base
+      empty_report = empty_class.new []
 
       expect { empty_report.to_xlsx }.to raise_error(RuntimeError, /No attributes defined/)
     end
   end
 
   describe 'callbacks' do
-    let(:callback_class) do
-      Class.new(RailsExcelReporter::Base) do
+    let :callback_class do
+      Class.new RailsExcelReporter::Base do
         attributes :id, :name
 
         attr_reader :before_render_called, :after_render_called,
@@ -176,7 +176,7 @@ RSpec.describe RailsExcelReporter::Base do
       end
     end
 
-    let(:callback_report) { callback_class.new(sample_data) }
+    let(:callback_report) { callback_class.new sample_data }
 
     it 'calls all callbacks in correct order' do
       callback_report.to_xlsx

data/spec/rails_excel_reporter/controller_helpers_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 RSpec.describe RailsExcelReporter::ControllerHelpers do
-  let(:controller_class) do
+  let :controller_class do
     Class.new do
       include RailsExcelReporter::ControllerHelpers
 
@@ -24,7 +24,7 @@ RSpec.describe RailsExcelReporter::ControllerHelpers do
     end
   end
 
-  let(:mock_response) do
+  let :mock_response do
     Class.new do
       attr_accessor :headers, :body
 
@@ -36,28 +36,28 @@ RSpec.describe RailsExcelReporter::ControllerHelpers do
 
   let(:controller) { controller_class.new }
 
-  let(:report_class) do
-    Class.new(RailsExcelReporter::Base) do
+  let :report_class do
+    Class.new RailsExcelReporter::Base do
       attributes :id, :name
     end
   end
 
-  let(:sample_data) do
+  let :sample_data do
     [
       OpenStruct.new(id: 1, name: 'John'),
       OpenStruct.new(id: 2, name: 'Jane')
     ]
   end
 
-  let(:report) { report_class.new(sample_data) }
+  let(:report) { report_class.new sample_data }
 
   before do
-    stub_const('MockResponse', mock_response)
+    stub_const 'MockResponse', mock_response
   end
 
   describe '#send_excel_report' do
     it 'sends Excel data with default filename' do
-      controller.send_excel_report(report)
+      controller.send_excel_report report
 
       expect(controller.sent_data).to be_a(String)
       expect(controller.send_options[:filename]).to match(/\.xlsx$/)
@@ -66,13 +66,13 @@ RSpec.describe RailsExcelReporter::ControllerHelpers do
     end
 
     it 'sends Excel data with custom filename' do
-      controller.send_excel_report(report, filename: 'custom_report.xlsx')
+      controller.send_excel_report report, filename: 'custom_report.xlsx'
 
       expect(controller.send_options[:filename]).to eq('custom_report.xlsx')
     end
 
     it 'sends Excel data with custom disposition' do
-      controller.send_excel_report(report, disposition: 'inline')
+      controller.send_excel_report report, disposition: 'inline'
 
       expect(controller.send_options[:disposition]).to eq('inline')
     end
@@ -80,9 +80,10 @@ RSpec.describe RailsExcelReporter::ControllerHelpers do
 
   describe '#stream_excel_report' do
     it 'sets up streaming response headers' do
-      controller.stream_excel_report(report)
+      controller.stream_excel_report report
 
-      expect(controller.response.headers['Content-Type']).to eq('application/vnd.openxmlformats-officedocument.spreadsheetml.sheet')
+      expected_content_type = 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
+      expect(controller.response.headers['Content-Type']).to eq(expected_content_type)
       expect(controller.response.headers['Content-Disposition']).to match(/attachment; filename=/)
       expect(controller.response.headers['Content-Transfer-Encoding']).to eq('binary')
       expect(controller.response.headers['Last-Modified']).to be_present
@@ -90,7 +91,7 @@ RSpec.describe RailsExcelReporter::ControllerHelpers do
     end
 
     it 'uses custom filename in Content-Disposition' do
-      controller.stream_excel_report(report, filename: 'custom_stream.xlsx')
+      controller.stream_excel_report report, filename: 'custom_stream.xlsx'
 
       expect(controller.response.headers['Content-Disposition']).to include('custom_stream.xlsx')
     end
@@ -101,21 +102,21 @@ RSpec.describe RailsExcelReporter::ControllerHelpers do
       allow(report).to receive(:should_stream?).and_return(false)
       expect(controller).to receive(:send_excel_report).with(report, {})
 
-      controller.excel_report_response(report)
+      controller.excel_report_response report
     end
 
     it 'uses stream_excel_report for large reports' do
       allow(report).to receive(:should_stream?).and_return(true)
       expect(controller).to receive(:stream_excel_report).with(report, {})
 
-      controller.excel_report_response(report)
+      controller.excel_report_response report
     end
 
     it 'passes options to the appropriate method' do
       allow(report).to receive(:should_stream?).and_return(false)
       expect(controller).to receive(:send_excel_report).with(report, { filename: 'test.xlsx' })
 
-      controller.excel_report_response(report, filename: 'test.xlsx')
+      controller.excel_report_response report, filename: 'test.xlsx'
     end
   end
 end

data/spec/rails_excel_reporter/streaming_spec.rb

@@ -1,16 +1,16 @@
 require 'spec_helper'
 
 RSpec.describe RailsExcelReporter::Streaming do
-  let(:small_data) do
-    (1..10).map { |i| OpenStruct.new(id: i, name: "User #{i}") }
+  let :small_data do
+    (1..10).map { |i| OpenStruct.new id: i, name: "User #{i}" }
   end
 
-  let(:large_data) do
-    (1..2000).map { |i| OpenStruct.new(id: i, name: "User #{i}") }
+  let :large_data do
+    (1..2000).map { |i| OpenStruct.new id: i, name: "User #{i}" }
   end
 
-  let(:report_class) do
-    Class.new(RailsExcelReporter::Base) do
+  let :report_class do
+    Class.new RailsExcelReporter::Base do
       attributes :id, :name
     end
   end
@@ -28,44 +28,44 @@ RSpec.describe RailsExcelReporter::Streaming do
 
   describe '#should_stream?' do
     it 'returns false for small collections' do
-      report = report_class.new(small_data)
+      report = report_class.new small_data
       expect(report.should_stream?).to be false
     end
 
     it 'returns true for large collections' do
-      report = report_class.new(large_data)
+      report = report_class.new large_data
       expect(report.should_stream?).to be true
     end
   end
 
   describe '#collection_size' do
     it 'calculates size for arrays' do
-      report = report_class.new(small_data)
+      report = report_class.new small_data
       expect(report.collection_size).to eq(10)
     end
 
     it 'uses count method when available' do
-      mock_collection = double('Collection')
+      mock_collection = double 'Collection'
       allow(mock_collection).to receive(:count).and_return(100)
 
-      report = report_class.new(mock_collection)
+      report = report_class.new mock_collection
       expect(report.collection_size).to eq(100)
     end
 
     it 'falls back to size method' do
-      mock_collection = double('Collection')
+      mock_collection = double 'Collection'
       allow(mock_collection).to receive(:respond_to?).with(:count).and_return(false)
       allow(mock_collection).to receive(:respond_to?).with(:size).and_return(true)
       allow(mock_collection).to receive(:size).and_return(50)
 
-      report = report_class.new(mock_collection)
+      report = report_class.new mock_collection
       expect(report.collection_size).to eq(50)
     end
   end
 
   describe '#stream_data' do
     it 'yields each item in small collections' do
-      report = report_class.new(small_data)
+      report = report_class.new small_data
       yielded_items = []
 
       report.stream_data do |item|
@@ -76,7 +76,7 @@ RSpec.describe RailsExcelReporter::Streaming do
     end
 
     it 'uses find_each for large ActiveRecord-like collections' do
-      mock_collection = double('ActiveRecord Collection')
+      mock_collection = double 'ActiveRecord Collection'
       allow(mock_collection).to receive(:respond_to?).with(:count).and_return(true)
       allow(mock_collection).to receive(:count).and_return(2000)
       allow(mock_collection).to receive(:respond_to?).with(:find_each).and_return(true)
@@ -86,7 +86,7 @@ RSpec.describe RailsExcelReporter::Streaming do
         large_data.each(&block)
       end
 
-      report = report_class.new(mock_collection)
+      report = report_class.new mock_collection
 
       report.stream_data do |item|
         yielded_items << item
@@ -96,7 +96,7 @@ RSpec.describe RailsExcelReporter::Streaming do
     end
 
     it 'returns enumerator when no block given' do
-      report = report_class.new(small_data)
+      report = report_class.new small_data
       enumerator = report.stream_data
 
       expect(enumerator).to be_a(Enumerator)
@@ -106,7 +106,7 @@ RSpec.describe RailsExcelReporter::Streaming do
 
   describe '#with_progress_tracking' do
     it 'tracks progress and yields items with progress info' do
-      report = report_class.new(small_data)
+      report = report_class.new small_data
       progress_updates = []
 
       report.with_progress_tracking do |_item, progress|

data/spec/rails_excel_reporter/styling_spec.rb

@@ -1,8 +1,8 @@
 require 'spec_helper'
 
 RSpec.describe RailsExcelReporter::Styling do
-  let(:styled_class) do
-    Class.new(RailsExcelReporter::Base) do
+  let :styled_class do
+    Class.new RailsExcelReporter::Base do
       attributes :id, :name, :email
 
       style :header, {
@@ -22,14 +22,14 @@ RSpec.describe RailsExcelReporter::Styling do
     end
   end
 
-  let(:sample_data) do
+  let :sample_data do
     [
       OpenStruct.new(id: 1, name: 'John', email: 'john@example.com'),
       OpenStruct.new(id: 2, name: 'Jane', email: 'jane@example.com')
     ]
   end
 
-  let(:report) { styled_class.new(sample_data) }
+  let(:report) { styled_class.new sample_data }
 
   describe 'class methods' do
     describe '.style' do
@@ -66,12 +66,12 @@ RSpec.describe RailsExcelReporter::Styling do
 
     describe '#get_column_style' do
       it 'returns merged column style with defaults' do
-        id_style = report.get_column_style(:id)
+        id_style = report.get_column_style :id
         expect(id_style[:alignment]).to eq({ horizontal: :center })
       end
 
       it 'returns default style for undefined columns' do
-        email_style = report.get_column_style(:email)
+        email_style = report.get_column_style :email
         expect(email_style).to eq(RailsExcelReporter.config.default_styles[:cell])
       end
     end
@@ -86,7 +86,7 @@ RSpec.describe RailsExcelReporter::Styling do
           alignment: { horizontal: :center }
         }
 
-        caxlsx_style = report.build_caxlsx_style(style_options)
+        caxlsx_style = report.build_caxlsx_style style_options
 
         expect(caxlsx_style[:bg_color]).to eq('FF0000')
         expect(caxlsx_style[:fg_color]).to eq('FFFFFF')
@@ -101,7 +101,7 @@ RSpec.describe RailsExcelReporter::Styling do
         styled_class.style :base, { bold: true, font_size: 10 }
         styled_class.style :override, { font_size: 12, italic: true }
 
-        merged = report.merge_styles(:base, :override)
+        merged = report.merge_styles :base, :override
 
         expect(merged[:bold]).to be true
         expect(merged[:font_size]).to eq(12)
@@ -112,7 +112,7 @@ RSpec.describe RailsExcelReporter::Styling do
 
   describe 'inheritance' do
     it 'inherits styles from parent class' do
-      child_class = Class.new(styled_class) do
+      child_class = Class.new styled_class do
         style :email, { italic: true }
       end
 

data/spec/spec_helper.rb

@@ -24,7 +24,7 @@ RSpec.configure do |config|
   config.order = :random
   Kernel.srand config.seed
 
-  config.before(:each) do
-    RailsExcelReporter.instance_variable_set(:@configuration, nil)
+  config.before :each do
+    RailsExcelReporter.instance_variable_set :@configuration, nil
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-excel-reporter
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Elí Sebastian Herrera Aguilar
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-07-14 00:00:00.000000000 Z
+date: 2025-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '8.0'
 - !ruby/object:Gem::Dependency
   name: caxlsx
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '8.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -94,20 +94,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.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: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -159,7 +145,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- CLAUDE.md
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -197,14 +182,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: Generate Excel reports (.xlsx) in Rails with a simple DSL

data/CLAUDE.md

@@ -1,94 +0,0 @@
-# CLAUDE.md
-
-This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
-
-## Project Overview
-
-This is a Ruby gem called `rails-excel-reporter` that provides a simple DSL for generating Excel reports (.xlsx format) in Ruby on Rails applications. The gem uses the `caxlsx` library (version 4.x) for Excel generation and includes features like streaming for large datasets, custom styling, callbacks, and Rails controller helpers.
-
-## Development Commands
-
-### Testing
-```bash
-# Run all tests
-bundle exec rspec
-
-# Run specific test file
-bundle exec rspec spec/rails_excel_reporter/base_spec.rb
-
-# Run tests with documentation format
-bundle exec rspec --format documentation
-```
-
-### Code Quality
-```bash
-# Run linter
-bundle exec rubocop
-
-# Generate documentation
-bundle exec yard
-```
-
-### Build and Install
-```bash
-# Build the gem
-gem build rails_excel_reporter.gemspec
-
-# Install locally
-gem install rails-excel-reporter-0.1.0.gem
-```
-
-## Architecture
-
-### Core Components
-
-1. **`RailsExcelReporter::Base`** (`lib/rails_excel_reporter/base.rb`) - Main class that report classes inherit from. Contains the core DSL and rendering logic.
-
-2. **Modules:**
-   - **`Styling`** (`lib/rails_excel_reporter/styling.rb`) - Handles custom styling for headers, columns, and cells
-   - **`Streaming`** (`lib/rails_excel_reporter/streaming.rb`) - Manages streaming for large datasets with configurable thresholds
-   - **`ControllerHelpers`** (`lib/rails_excel_reporter/controller_helpers.rb`) - Provides Rails controller methods for sending Excel responses
-
-3. **`Configuration`** (`lib/rails_excel_reporter/configuration.rb`) - Global configuration management with defaults for styling, streaming thresholds, and file paths
-
-4. **`ReportGenerator`** (`lib/generators/report/report_generator.rb`) - Rails generator for scaffolding new report classes
-
-### Key Patterns
-
-- **DSL Design**: Uses `attributes` class method to define report columns with support for custom headers and methods
-- **Streaming**: Automatically streams large datasets (>1000 records by default) using `find_each` for ActiveRecord or manual iteration
-- **Styling**: Supports custom styling through the `style` class method with conversion to caxlsx format
-- **Callbacks**: Provides `before_render`, `after_render`, `before_row`, and `after_row` hooks
-- **Flexible Data Sources**: Works with ActiveRecord collections, arrays, and any enumerable
-
-### Report Class Structure
-
-```ruby
-class MyReport < RailsExcelReporter::Base
-  attributes :column1, :column2, { name: :column3, header: "Custom Header" }
-  
-  style :header, { bg_color: "4472C4", fg_color: "FFFFFF", bold: true }
-  style :column1, { alignment: { horizontal: :center } }
-  
-  # Custom attribute methods override default behavior
-  def column1
-    # Access current record via `object`
-    object.column1.upcase
-  end
-end
-```
-
-### Error Handling
-
-The gem defines specific error classes:
-- `RailsExcelReporter::Error` - Base error class
-- `AttributeNotFoundError` - When an attribute doesn't exist on the data source
-- `InvalidConfigurationError` - For configuration issues
-
-## File Structure
-
-- `lib/rails_excel_reporter.rb` - Main entry point and module definition
-- `lib/rails_excel_reporter/` - Core gem modules
-- `lib/generators/` - Rails generator for creating report classes
-- `spec/` - RSpec test suite
-- `rails_excel_reporter.gemspec` - Gem specification