ruby_report 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6fe86c76ce5314abc47fa276b0fa779c235a76d5cfb2ec9697eb40c69d1585b2
+  data.tar.gz: 0a89259818e654808d7ee0de1a579fd2b3c30e2a347b75a8a041b1a1f92beb8f
+SHA512:
+  metadata.gz: 570979045b5f739cc43b845b312311955d517e19a988e1ac1f92ddc93fe91d75aab7400120b7d2143b6cd9e5af403ff37ebdb66df9fc97b636b2064b836cb0cb
+  data.tar.gz: a7025a83548a80f90169c56cf0b2a4d5a903ad6611e5adc68749708618171910222bf5a96b27fc76de5a530c3f04ed747799ed2102b710993fa7cb60af31b238

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 0.0.1 (2018-04-17)
+- Initial pre-release version. ([@klondaiker][])

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) Alexandr Zavgorodnev
+
+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,145 @@
+# Ruby Report
+A simple report generator
+
+## Installation
+Add this line to your application's `Gemfile`:
+
+```ruby
+gem "ruby_report"
+gem "caxlsx" # optional: for generate xlsx
+```
+
+And then execute:
+
+```sh
+bundle install
+```
+
+## Usage
+
+Create class
+```ruby
+class UserReport < RubyReport::Report
+  columns :name, :age, :role, :created_at
+end
+```
+
+Initialize object with data
+```ruby
+# data is ActiveRecords or array of objects
+report = UserReport.new(data: User.all)
+```
+
+Generate report
+```ruby
+# Hash
+report.to_h # {header: ["Name", "Age", "Role"], rows: [["Sasha", 18, "Student"]]}
+
+# CSV
+report.to_csv # IOString
+
+# XLSX
+report.to_xlsx(worksheet_name: "Worksheet") # IOString
+```
+
+## Details
+Get header
+```ruby
+report.header # ["Name", "Age", "Role"]
+```
+
+Default translates for header get from i18n
+```ruby
+I18n.t("ruby_reports.#{report.class.name.underscore}.headers.#{key}")
+```
+
+Determine custom header
+```ruby
+UserReport.new(data: data, header_builder: ->(key, _report) { "Custom #{key}" })
+```
+
+Get rows
+```ruby
+report.rows # [["Sasha", 18, "Student"], ["Jack", 30, "Worker"]]
+```
+
+Select columns
+```ruby
+report = UserReport.new(data: data, columns: [:name, :age])
+report.headers #["Name", "Age"]
+report.rows #[["Sasha", 18], ["Jack", 30]]
+```
+
+Custom row
+```ruby
+UserReport.new(data: data, row_resolver: ->(row) { row.user })
+```
+
+Custom row builder
+```ruby
+UserReport.new(data: data, row_builder: ->(_row, _key, _report) { "" })
+```
+
+Decorators
+```ruby
+class UserDecorator < RubyReport::Decorator
+  def role
+    I18n.t("roles.#{object.role}")
+  end
+end
+
+class UserReport < RubyReport::Report
+  columns :name, :age, :role, decorators: [UserDecorator]
+end
+```
+
+Formatters
+
+```ruby
+class TimeFormatter < RubyReport::Formatter
+  def format(value)
+    return value unless [::Time, ActiveSupport::TimeWithZone].include?(value.class)
+    value.utc.to_formatted_s(:report)
+  end
+end
+
+class UserReport < RubyReport::Report
+  columns :name, :age, :role, :created_at, formatters: [TimeFormatter]
+end
+```
+
+Decorator and Formatter with scope
+```ruby
+class UserDecorator < RubyReport::Decorator
+  def role
+    I18n.t("roles.#{object.role}", account_name: scope[:account].name)
+  end
+end
+
+report = UserReport.new(data: users, scope: {account: account})
+```
+
+Append/prepend other reports
+
+```ruby
+class AccountReport < RubyReport::Report
+  columns :name
+end
+
+class AddressReport < RubyReport::Report
+  columns :street
+end
+
+user_report.prepend_report(account_report)
+user_report.add_report(address_report)
+```
+
+XLSX with any worksheets
+```ruby
+require "ruby_report/generator/xlsx"
+
+generator = RubyReport::Generator::Xlsx.new
+generator.add_report(report, worksheet_name: "Worksheet 1")
+generator.add_report(other_report, worksheet_name: "Worksheet 2")
+generator.generate # IOString
+```

data/lib/ruby_report/builder/default_header_builder.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module RubyReport
+  module Builder
+    module DefaultHeaderBuilder
+      def self.call(key, report)
+        if defined?(::I18n)
+          ::I18n.t("ruby_report.#{underscore(report.class.name.to_s)}.headers.#{key}")
+        else
+          key.to_s
+        end
+      end
+
+      private
+
+      def self.underscore(name)
+        word = name.gsub("::", "/")
+        word.gsub!(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
+        word.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+        word.downcase!
+        word
+      end
+    end
+  end
+end

data/lib/ruby_report/builder/default_row_builder.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RubyReport
+  module Builder
+    module DefaultRowBuilder
+      def self.call(row, key, _report)
+        row.public_send(key)
+      end
+    end
+  end
+end

data/lib/ruby_report/decorator.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module RubyReport
+  class Decorator < SimpleDelegator
+    attr_reader :scope
+
+    def initialize(obj, scope = {})
+      super(obj)
+      @scope = scope
+    end
+  end
+end

data/lib/ruby_report/formatter.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module RubyReport
+  class Formatter < SimpleDelegator
+    attr_reader :scope
+
+    def initialize(obj, scope = {})
+      super(obj)
+      @scope = scope
+    end
+
+    def method_missing(method, *args, &block)
+      format(super)
+    end
+
+    def respond_to_missing?(method, include_private)
+      super
+    end
+
+    def format(value)
+      value
+    end
+  end
+end

data/lib/ruby_report/generator/base.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module RubyReport
+  module Generator
+    class Base
+      def add_report(report, **opts)
+        raise NotImplementedError
+      end
+
+      def generate
+        raise NotImplementedErro
+      end
+    end
+  end
+end

data/lib/ruby_report/generator/csv.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "csv"
+
+module RubyReport
+  module Generator
+    class Csv < Base
+      def add_report(report, **_opts)
+        @report = report
+      end
+
+      def generate
+        temp_file = ::Tempfile.new
+
+        ::CSV.open(temp_file.path, "wb") do |csv|
+          csv << report.header
+
+          report.each_row do |row|
+            csv << row
+          end
+        end
+
+        temp_file
+      end
+
+      private
+
+      attr_reader :report
+    end
+  end
+end

data/lib/ruby_report/generator/hash.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module RubyReport
+  module Generator
+    class Hash < Base
+      def add_report(report, **_opts)
+        @report = report
+      end
+
+      def generate
+        {header: report.header, rows: report.rows}
+      end
+
+      private
+
+      attr_reader :report
+    end
+  end
+end

data/lib/ruby_report/generator/xlsx.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require "caxlsx"
+
+module RubyReport
+  module Generator
+    class Xlsx < Base
+      WORKSHEET_LETTERS_COUNT = 25
+      ESCAPE_REGEXP = /["~#%&:;<>!=',@{|}\/?*()+\[\]$]/
+      XLSX_XSS_SYMBOLS = %w[+ - = @ {=].freeze
+
+      class Worksheet
+        SIZES = {header_height: 40, item_height: 20}.freeze
+        ALIGNMENT = {vertical: :center, horizontal: :left, wrap_text: true}.freeze
+        COLORS = {tb: "0a9700", white: "ff"}.freeze
+
+        def initialize(workbook, name)
+          @workbook = workbook
+          @worksheet = @workbook.add_worksheet(name: name)
+          @styles = ::OpenStruct.new(
+            item: @workbook.styles.add_style(alignment: ALIGNMENT),
+            header: @workbook.styles.add_style(
+              bg_color: COLORS.fetch(:tb),
+              fg_color: COLORS.fetch(:white),
+              alignment: ALIGNMENT
+            )
+          )
+        end
+
+        def add_header(data)
+          worksheet.add_row(
+            data, style: styles.header, height: SIZES.fetch(:header_height)
+          )
+        end
+
+        def add_row(data)
+          worksheet.add_row(
+            data, style: styles.item, height: SIZES.fetch(:item_height)
+          )
+        end
+
+        private
+
+        attr_reader :workbook, :worksheet, :styles
+      end
+
+      def initialize
+        @package = ::Axlsx::Package.new.tap { |package| package.use_shared_strings = true }
+        @workbook = package.workbook
+        @reports = []
+      end
+
+      def add_report(report, worksheet_name:)
+        reports << {
+          report: report,
+          worksheet: Worksheet.new(workbook, sanitize_worksheet_name(worksheet_name)),
+        }
+      end
+
+      def generate
+        reports.each do |report|
+          worksheet = report[:worksheet]
+          report = report[:report]
+
+          worksheet.add_header(report.header)
+
+          report.each_row do |row|
+            next if row.empty?
+
+            worksheet.add_row(sanitize_row(row))
+          end
+        end
+
+        package.to_stream
+      end
+
+      private
+
+      attr_reader :package, :workbook, :reports
+
+      def sanitize_row(row)
+        row.map do |el|
+          el.is_a?(String) && el.start_with?(*XLSX_XSS_SYMBOLS) ? "'#{el}" : el
+        end
+      end
+
+      def sanitize_worksheet_name(name)
+        truncate(name.gsub(ESCAPE_REGEXP, ""), WORKSHEET_LETTERS_COUNT)
+      end
+
+      def truncate(string, length)
+        string.length > length ? string[0...length] : string
+      end
+    end
+  end
+end

data/lib/ruby_report/report.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+module RubyReport
+  class Report
+    class << self
+      attr_reader :columns_set, :decorators, :formatters
+
+      def columns(*keys, decorators: ::RubyReport::Decorator, formatters: ::RubyReport::Formatter)
+        @columns_set = Set.new(keys)
+        @decorators = decorators
+        @formatters = formatters
+      end
+    end
+
+    def initialize(
+      data:, scope: nil, columns: nil,
+      header_builder: ::RubyReport::Builder::DefaultHeaderBuilder,
+      row_builder: ::RubyReport::Builder::DefaultRowBuilder,
+      row_resolver: ->(row) { row }
+    )
+      @data = data
+      @scope = scope
+      @columns =
+        if columns.nil?
+          self.class.columns_set || raise("Columns not defined")
+        else
+          Set.new(columns)
+        end
+      @header_builder = header_builder
+      @row_builder = row_builder
+      @row_resolver = row_resolver
+      @reports = [self]
+    end
+
+    def add_report(report)
+      reports << report
+    end
+
+    def prepend_report(report)
+      reports.unshift(report)
+    end
+
+    def header
+      @header ||= reports.flat_map do |report|
+        if report == self
+          report.build_header
+        else
+          report.header
+        end
+      end
+    end
+
+    def rows
+      @rows ||= each_row.to_a
+    end
+
+    def each_row
+      return enum_for(:each_row) unless block_given?
+
+      method =
+        if data.respond_to?(:find_each)
+          :find_each
+        else
+          :each
+        end
+
+      data.public_send(method) do |row|
+        yield collect_row(row)
+      end
+    end
+
+    def to_with(generator, **opts)
+      report = generator.new
+      report.add_report(self, **opts)
+      report.generate
+    end
+
+    [:hash, :csv, :xlsx].each do |type|
+      define_method("to_#{type}") do |**opts|
+        require "ruby_report/generator/#{type}"
+
+        to_with(
+          Object.const_get("::RubyReport::Generator::#{type.to_s.capitalize}"),
+          **opts
+        )
+      end
+    end
+
+    alias_method :to_h, :to_hash
+
+    def build_header
+      columns.map do |key|
+        header_builder.call(key, self)
+      end
+    end
+
+    def build_row(row)
+      current_row = row_resolver.call(row)
+
+      return [] unless current_row
+
+      Array(decorators).each { |decorator| current_row = decorator.new(current_row, scope) }
+      Array(formatters).each { |formatter| current_row = formatter.new(current_row, scope) }
+
+      columns.map do |key|
+        row_builder.call(current_row, key, self)
+      end
+    end
+
+    def collect_row(row)
+      result_row = []
+
+      reports.each do |report|
+        result_row +=
+          if report == self
+            report.build_row(row)
+          else
+            report.collect_row(row)
+          end
+      end
+
+      result_row
+    end
+
+    private
+
+    attr_reader :data, :scope, :columns, :header_builder, :row_builder, :row_resolver, :reports
+
+    def decorators
+      self.class.decorators
+    end
+
+    def formatters
+      self.class.formatters
+    end
+  end
+end

data/lib/ruby_report/version.rb

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

data/lib/ruby_report.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "ruby_report/builder/default_header_builder"
+require "ruby_report/builder/default_row_builder"
+
+require "ruby_report/generator/base"
+
+require "delegate"
+require "ruby_report/decorator"
+require "ruby_report/formatter"
+
+require "ruby_report/report"
+
+module RubyReport
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: ruby_report
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alexandr Zavgorodnev
+bindir: bin
+cert_chain: []
+date: 2025-04-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: 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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.2
+- !ruby/object:Gem::Dependency
+  name: caxlsx
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: creek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.3
+description: A simple report generator
+email: klondaiker@bk.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/ruby_report.rb
+- lib/ruby_report/builder/default_header_builder.rb
+- lib/ruby_report/builder/default_row_builder.rb
+- lib/ruby_report/decorator.rb
+- lib/ruby_report/formatter.rb
+- lib/ruby_report/generator/base.rb
+- lib/ruby_report/generator/csv.rb
+- lib/ruby_report/generator/hash.rb
+- lib/ruby_report/generator/xlsx.rb
+- lib/ruby_report/report.rb
+- lib/ruby_report/version.rb
+homepage: https://github/klondaiker/ruby_report
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: 0.0.0
+test_files: []