acts_as_caxlsx 1.0.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 448c5c50dbff1b5d6a745ae7335f445069fab20539b98df37d257edda4f8c9a9
+  data.tar.gz: d64c0d7721f2b13f6fc6c67f088b4f8ab4c38252aa5c3fbe9bd883b3356bd2b5
+SHA512:
+  metadata.gz: c624c6baa51827f86e78fdd32d334b44fa2d23ced1fcf7f301a4635ad16ed26158d4f71b331e5030e652ceb9a4aaa69e70077da7ef882eaea4f291767a580d08
+  data.tar.gz: 2f93f2401e12d28d56577b3b07f59d3056b8097a88b5cd9ea6b46f08dd8d6a847de50821d5128d3068a4129e0525595b53caac9f74ed0ae817d56029d8c1efdf

data/.yardopts

@@ -0,0 +1,7 @@
+--protected
+--no-private
+--main README.md
+--title "acts_as_xlsx: a rails plug in for axlsx"
+-
+LICENSE
+CHANGELOG.md

data/CHANGELOG.md

@@ -0,0 +1,27 @@
+CHANGELOG
+---------
+
+- **July.27.12**: 1.0.6
+  - conditionaly register XLSX mime type
+
+- **February.14.12**: 1.0.5
+  - acts_as_xlsx propery declares it's dependancy on i18n instead of relying on the parent gem.
+
+- **December.7.11**: 1.0.4
+  - acts_as_xlsx now supports specifying the Axlsx package the export will be added to
+  - Support for custom named and I18n names for worksheets.
+
+- **December.6.11**: 1.0.3
+  - Added Mime type definition for rails to support respond_to |format| style handling in controllers.
+
+- **December.3.11**: 1.0.2
+    Added support for chained method columns like :'model.association.attribute'
+
+- **October.30.11**: 1.0.1
+  - Patch for inclusion error
+
+- **October.30.11**: 1.0.0
+  - First release
+
+- **October.30.11**: 1.0.0a
+  - First pre release

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2011 Randy Morgan
+
+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,68 @@
+# Acts as XLSX
+
+[![Build Status](https://secure.travis-ci.org/caxlsx/acts_as_caxlsx.png)](http://travis-ci.org/caxlsx/acts_as_caxlsx/)
+
+## Notice: Community Axlsx Organization
+
+To better maintain the Axlsx ecosystem, all related gems have been forked or moved to the following community organization: 
+
+http://github.com/caxlsx
+
+[Join the Caxlsx Slack channel](https://join.slack.com/t/caxlsx/shared_invite/enQtOTI5OTM0MzI1Njk5LTBlMDQzNDk2YzkwODMxMmVkODMyYzJiZGU5NTQ3YTg5NTBlN2IwZTlmNTRjNzhiY2E0MDY2OTEyYmFlODI5NjA)
+
+## Synopsis
+
+Acts_as_xlsx is an active record plugin for automatic Office Open XML Spreadsheet Generation using Axlsx. It makes generating excel spreadsheets from any subclass of ActiveRecord::Base as simple as a couple of lines of code.
+
+## Feature List
+
+1. Mixes into active record base to provide to_xlsx
+
+2. Can work at the end of any series of finder methods.
+
+3. Can accept any set of find options
+
+4. Automates localization of column heading with i18n support
+
+5. Lets you specify columns and methods chains you want to call to populate your table in one go.
+
+6. Gives you access to the axlsx package so you can add styles, charts and pictures to satisfy those flashy sales guys.
+
+7. Plays nicely with both ruby 1.8.7 + rails 2.3 as well as ruby 1.9.3 + rails 3
+
+8. Automatically registers xlsx Mime type for use in respond_to web-service support.
+
+9. Allows you to specify the Axlsx package to add your data to so you can create a single workbook with a sheet for each to_xlsx call.
+
+
+## Install
+
+To install, add the following to your Gemfile:
+
+```ruby
+gem 'acts_as_xlsx', git: 'https://github.com/caxlsx/acts_as_xlsx.git'
+```
+
+
+## Usage
+
+The following Usage guides need to be extracted and added to this README
+
+- http://axlsx.blog.randym.net/2011/12/using-actsasxlsx-to-generate-excel-data.html
+- http://axlsx.blog.randym.net/2011/12/axlsx-making-excel-reports-with-ruby-on.html
+
+
+## Documentation
+
+Detailed documentation is available at:
+
+[https://www.rubydoc.info/gems/acts_as_xlsx/](https://www.rubydoc.info/gems/acts_as_xlsx/)
+
+
+## Credits
+
+Originally created by Randy Morgan - @randym
+
+Forked in 2019, to enable the community to maintain the Axlsx ecosystem - http://github.com/caxlsx
+
+Open source software is a community effort. None of this could have been done without the help of [our Contributors](https://github.com/caxlsx/acts_as_xlsx/graphs/contributors).

data/Rakefile

@@ -0,0 +1,24 @@
+require File.expand_path(File.dirname(__FILE__) + '/lib/acts_as_xlsx/version.rb')
+
+task :build => :gendoc do
+  system "gem build acts_as_xlsx.gemspec"
+end
+
+task :gendoc do   
+  system "yardoc"
+end
+
+task :test do 
+     require 'rake/testtask'
+     Rake::TestTask.new do |t|
+       t.libs << 'test'
+       t.test_files = FileList['test/**/tc_*.rb']
+       t.verbose = true
+     end
+end
+
+task :release => :build do
+  system "gem push acts_as_xlsx-#{Axlsx::Ar::VERSION}.gem"
+end
+
+task :default => :test

data/lib/acts_as_caxlsx.rb

@@ -0,0 +1 @@
+require 'acts_as_xlsx.rb'

data/lib/acts_as_xlsx/ar.rb

@@ -0,0 +1,100 @@
+# -*- coding: utf-8 -*-
+# Axlsx is a gem or generating excel spreadsheets with charts, images and many other features. 
+# 
+# acts_as_xlsx provides integration into active_record for Axlsx.
+# 
+require 'axlsx'
+
+# Adding to the Axlsx module 
+# @see http://github.com/randym/axlsx
+module Axlsx
+  # === Overview
+  # This module defines the acts_as_xlsx class method and provides to_xlsx support to both AR classes and instances
+  module Ar
+    
+    def self.included(base) # :nodoc:
+      base.send :extend, ClassMethods
+    end
+    
+    # Class methods for the mixin
+    module ClassMethods
+
+      # defines the class method to inject to_xlsx
+      # @option options [Array, Symbol] columns an array of symbols defining the columns and methods to call in generating sheet data for each row.
+      # @option options [String] i18n (default nil) The path to search for localization. When this is specified your i18n.t will be used to determine the labels for columns.
+      # @example
+      #       class MyModel < ActiveRecord::Base
+      #          acts_as_xlsx :columns=> [:id, :created_at, :updated_at], :i18n => 'activerecord.attributes'
+      def acts_as_xlsx(options={})
+        cattr_accessor :xlsx_i18n, :xlsx_columns
+        self.xlsx_i18n = options.delete(:i18n) || false
+        self.xlsx_columns = options.delete(:columns)
+        extend Axlsx::Ar::SingletonMethods
+      end
+    end
+
+    # Singleton methods for the mixin
+    module SingletonMethods
+
+      # Maps the AR class to an Axlsx package
+      # options are passed into AR find
+      # @param [Array, Array] columns as an array of symbols or a symbol that defines the attributes or methods to render in the sheet.
+      # @option options [Integer] header_style to apply to the first row of field names
+      # @option options [Array, Symbol] types an array of Axlsx types for each cell in data rows or a single type that will be applied to all types.
+      # @option options [Integer, Array] style The style to pass to Worksheet#add_row
+      # @option options [String] i18n The path to i18n attributes. (usually activerecord.attributes)
+      # @option options [Package] package An Axlsx::Package. When this is provided the output will be added to the package as a new sheet.  # @option options [String] name This will be used to name the worksheet added to the package. If it is not provided the name of the table name will be humanized when i18n is not specified or the I18n.t for the table name.
+      # @see Worksheet#add_row
+      def to_xlsx(options = {})
+        if self.xlsx_columns.nil?
+          self.xlsx_columns = self.column_names.map { |c| c = c.to_sym }
+        end
+
+        row_style = options.delete(:style)
+        header_style = options.delete(:header_style) || row_style
+        types = [options.delete(:types) || []].flatten
+
+        i18n = options.delete(:i18n) || self.xlsx_i18n
+        columns = options.delete(:columns) || self.xlsx_columns
+
+        p = options.delete(:package) || Package.new
+        row_style = p.workbook.styles.add_style(row_style) unless row_style.nil?
+        header_style = p.workbook.styles.add_style(header_style) unless header_style.nil?
+        i18n = self.xlsx_i18n == true ? 'activerecord.attributes' : i18n
+        sheet_name = options.delete(:name) || (i18n ? (self.xlsx_i18n == true ? self.model_name.human : I18n.t("#{i18n}.#{table_name.underscore}")) : table_name.humanize) 
+        data = options.delete(:data) || where(options[:where]).order(options[:order]).to_a
+        data = data.compact.flatten
+
+
+        return p if data.empty?
+        p.workbook.add_worksheet(:name=>sheet_name) do |sheet|
+          
+          col_labels = if i18n
+                         columns.map { |c| self.xlsx_i18n == true ? self.human_attribute_name(c) : I18n.t("#{i18n}.#{self.name.underscore}.#{c}") }                         
+                       else
+                         columns.map { |c| c.to_s.humanize }
+                       end
+          
+          sheet.add_row col_labels, :style=>header_style
+          
+          data.each do |r|
+            row_data = columns.map do |c|
+              if c.to_s =~ /\./
+                v = r; c.to_s.split('.').each { |method| !v.nil? ? v = v.send(method) : v = ""; }; v
+              else
+                r.send(c)                
+              end
+            end
+            sheet.add_row row_data, :style=>row_style, :types=>types
+          end
+        end
+        p
+      end
+    end
+  end
+end
+
+require 'active_record'
+ActiveRecord::Base.send :include, Axlsx::Ar
+
+

data/lib/acts_as_xlsx/version.rb

@@ -0,0 +1,6 @@
+module Axlsx
+  module Ar
+    # The current version of the gem
+    VERSION = "1.0.8"
+  end
+end

data/lib/acts_as_xlsx.rb

@@ -0,0 +1,9 @@
+require 'acts_as_xlsx/ar.rb'
+begin
+  # The mime type to be used in respond_to |format| style web-services in rails
+  unless defined? Mime::XLSX
+    Mime::Type.register "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", :xlsx
+  end
+rescue NameError
+  puts "Mime module not defined. Skipping registration of xlsx"
+end

data/test/database.yml

@@ -0,0 +1,3 @@
+sqlite3:
+  adapter: sqlite3
+  database: test/acts_as_xlsx.sqlite3.db

data/test/helper.rb

@@ -0,0 +1,72 @@
+  config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+  ActiveRecord::Base.establish_connection(config['sqlite3'])
+  ActiveRecord::Schema.define(:version => 0) do
+    begin
+    drop_table :author, :force => true
+    drop_table :authors, :force => true
+    drop_table :comments, :force => true
+    drop_table :posts, :force => true
+    rescue
+      #dont really care if the tables are not dropped
+    end
+
+    create_table(:authors, :force => true) do |t|
+      t.string :name
+    end
+
+    create_table(:comments, :force => true) do |t|
+      t.text :content
+      t.integer :post_id
+      t.integer :author_id
+      t.timestamps
+    end
+
+     create_table(:posts, :force => true) do |t|
+      t.string :name
+      t.string :title
+      t.text :content
+      t.integer :votes
+      t.timestamps
+    end
+
+  end
+  
+class Author < ActiveRecord::Base
+  acts_as_xlsx
+  has_many :comments
+end
+
+class Comment < ActiveRecord::Base
+  acts_as_xlsx
+  belongs_to :post
+  belongs_to :author
+end
+
+class Post < ActiveRecord::Base
+  acts_as_xlsx
+  has_many :comments
+  def ranking
+    a = Post.all.order("votes desc")      
+    a.index(self) + 1
+  end  
+  def last_comment
+    self.comments.last.content
+  end
+end
+
+  posts = []
+  posts << Post.new(:name => "first post", :title => "This is the first post", :content=> "I am a very good first post!", :votes => 1)
+  posts << Post.new(:name => "second post", :title => "This is the second post", :content=> "I am the best post!", :votes => 7)
+  posts.each { |p| p.save! }
+
+  authors = []
+  authors << Author.new(:name => 'bob')
+  authors << Author.new(:name => 'joe')
+
+  comments = []
+  comments << Comment.new(:post => posts[0], :content => "wow, that was a nice post!", :author=>authors[1])
+  comments << Comment.new(:content => "Are you really the best post?", :post => posts[1], :author=>authors[0])
+  comments << Comment.new(:content => "Only until someone posts better!", :post => posts[1], :author=>authors[0])
+  comments.each { |c| c.save }
+
+

data/test/tc_acts_as_xlsx.rb

@@ -0,0 +1,77 @@
+#!/usr/bin/env ruby -w
+require 'test/unit'
+require "acts_as_xlsx.rb"
+require 'active_record'
+
+require File.expand_path(File.join(File.dirname(__FILE__), 'helper'))
+
+class TestActsAsXlsx < Test::Unit::TestCase
+
+  class Post < ActiveRecord::Base
+    acts_as_xlsx :columns=>[:name, :title, :content, :votes, :ranking], :i18n => 'activerecord.attributes'
+  end
+
+  def test_xlsx_options
+    assert_equal([:name, :title, :content, :votes, :ranking], Post.xlsx_columns)
+    assert_equal('activerecord.attributes', Post.xlsx_i18n)
+  end
+
+end
+
+class TestToXlsx < Test::Unit::TestCase
+  def test_to_xlsx_with_package
+    p = Post.to_xlsx
+    Post.to_xlsx :package=>p, :name=>'another posts'
+    assert_equal p.workbook.worksheets.size, 2
+  end
+
+  def test_to_xlsx_with_name
+    p = Post.to_xlsx :name=>'bob'
+    assert_equal(p.workbook.worksheets.first.name, 'bob')    
+  end
+
+  def test_xlsx_columns
+    assert_equal( Post.xlsx_columns, Post.column_names.map {|c| c.to_sym})
+  end
+
+  def test_to_xslx_vanilla
+    p = Post.to_xlsx
+    assert_equal("Id",p.workbook.worksheets.first.rows.first.cells.first.value)
+    assert_equal(2,p.workbook.worksheets.first.rows.last.cells.first.value)
+  end
+  
+  
+  def test_to_xslx_with_provided_data
+    p = Post.to_xlsx :data => Post.where(:title => "This is the first post").all
+    assert_equal("Id",p.workbook.worksheets.first.rows.first.cells.first.value)
+    assert_equal(1,p.workbook.worksheets.first.rows.last.cells.first.value)
+  end
+  
+
+  def test_columns
+    p = Post.to_xlsx :columns => [:name, :title, :content, :votes]
+    sheet = p.workbook.worksheets.first
+    assert_equal(sheet.rows.first.cells.size, Post.xlsx_columns.size - 3)
+    assert_equal("Name",sheet.rows.first.cells.first.value)
+    assert_equal(7,sheet.rows.last.cells.last.value)
+  end
+
+  def test_method_in_columns
+    p = Post.to_xlsx :columns=>[:name, :votes, :content, :ranking]
+    sheet = p.workbook.worksheets.first
+    assert_equal("Name", sheet.rows.first.cells.first.value)
+    assert_equal(Post.last.ranking, sheet.rows.last.cells.last.value)
+  end
+
+  def test_chained_method
+    p = Post.to_xlsx :columns=>[:name, :votes, :content, :ranking, :'comments.last.content', :'comments.first.author.name']
+    sheet = p.workbook.worksheets.first
+    assert_equal("Name", sheet.rows.first.cells.first.value)
+    assert_equal(Post.last.comments.last.author.name, sheet.rows.last.cells.last.value)
+  end
+
+  
+  
+end
+
+

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_caxlsx
+version: !ruby/object:Gem::Version
+  version: 1.0.8
+platform: ruby
+authors:
+- Randy Morgan
+- Noel Peden
+bindir: bin
+cert_chain: []
+date: 2025-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: caxlsx
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+description: |2
+      acts_as_xlsx lets you turn any ActiveRecord::Base inheriting class into an excel spreadsheet.
+      It can be added to any finder method or scope chain and can use localized column and sheet names with I18n.
+email: noel@peden.biz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".yardopts"
+- CHANGELOG.md
+- LICENSE
+- README.md
+- Rakefile
+- lib/acts_as_caxlsx.rb
+- lib/acts_as_xlsx.rb
+- lib/acts_as_xlsx/ar.rb
+- lib/acts_as_xlsx/version.rb
+- test/database.yml
+- test/helper.rb
+- test/tc_acts_as_xlsx.rb
+homepage: https://github.com/caxlsx/acts_as_caxlsx
+licenses: []
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: ActiveRecord support for Axlsx
+test_files:
+- test/database.yml
+- test/helper.rb
+- test/tc_acts_as_xlsx.rb