RubyGems - acts_as_xlsx - Versions diffs - 1.0.0 - Mend

acts_as_xlsx 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (33) hide show

data/CHANGELOG.md +0 -0
data/Gemfile +8 -0
data/Gemfile.lock +32 -0
data/LICENSE +22 -0
data/README.md +95 -0
data/Rakefile +18 -0
data/acts_as_xlsx.gemspec +38 -0
data/doc/Axlsx.html +124 -0
data/doc/Axlsx/Ar.html +199 -0
data/doc/Axlsx/Ar/ClassMethods.html +259 -0
data/doc/Axlsx/Ar/InstanceMethods.html +188 -0
data/doc/Axlsx/Ar/SingletonMethods.html +348 -0
data/doc/_index.html +146 -0
data/doc/class_list.html +47 -0
data/doc/css/common.css +1 -0
data/doc/css/full_list.css +55 -0
data/doc/css/style.css +322 -0
data/doc/file.LICENSE.html +86 -0
data/doc/file.README.html +166 -0
data/doc/file_list.html +52 -0
data/doc/frames.html +13 -0
data/doc/index.html +166 -0
data/doc/js/app.js +205 -0
data/doc/js/full_list.js +167 -0
data/doc/js/jquery.js +16 -0
data/doc/method_list.html +70 -0
data/doc/top-level-namespace.html +103 -0
data/lib/axlsx/acts_as_xlsx.rb +87 -0
data/test/acts_as_xlsx.sqlite3.db +0 -0
data/test/database.yml +3 -0
data/test/helper.rb +72 -0
data/test/tc_acts_as_xlsx.rb +49 -0
metadata +157 -0

data/doc/top-level-namespace.html ADDED Viewed

@@ -0,0 +1,103 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Top Level Namespace
+    &mdash; Acts As Xlsx (Axlsx)
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  relpath = '';
+  if (relpath != '') relpath += '/';
+</script>
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <script type="text/javascript" charset="utf-8">
+      if (window.top.frames.main) document.body.className = 'frames';
+    </script>
+    <div id="header">
+      <div id="menu">
+    <a href="_index.html">Index</a> &raquo;
+    <span class="title">Top Level Namespace</span>
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+      <div id="search">
+    <a id="class_list_link" href="#">Class List</a>
+    <a id="method_list_link" href="#">Method List</a>
+    <a id="file_list_link" href="#">File List</a>
+</div>
+      <div class="clear"></div>
+    </div>
+    <iframe id="search_frame"></iframe>
+    <div id="content"><h1>Top Level Namespace
+</h1>
+<dl class="box">
+</dl>
+<div class="clear"></div>
+<h2>Defined Under Namespace</h2>
+<p class="children">
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Axlsx.html" title="Axlsx (module)">Axlsx</a></span>
+</p>
+</div>
+    <div id="footer">
+  Generated on Thu Dec  1 00:04:39 2011 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.7.3 (ruby-1.9.3).
+</div>
+  </body>
+</html>

data/lib/axlsx/acts_as_xlsx.rb ADDED Viewed

@@ -0,0 +1,87 @@
+# 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) ||  self.column_names.map { |c| c = c.to_sym }
+        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] 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)
+      # @see Worksheet#add_row
+      def to_xlsx(options = {})
+        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 = 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?
+        data = [*find(:all, options)]
+        data.compact!
+        data.flatten!
+        return p if data.empty?
+        p.workbook.add_worksheet(:name=>table_name.humanize) do |sheet|
+          col_labels = if i18n
+                         columns.map { |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|
+            sheet.add_row columns.map { |c| r.send(c) }, :style=>row_style, :types=>types
+          end
+        end
+        p
+      end
+    end
+  end
+end
+require 'active_record'
+ActiveRecord::Base.send :include, Axlsx::Ar

data/test/acts_as_xlsx.sqlite3.db ADDED Viewed

Binary file

data/test/database.yml ADDED Viewed

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

data/test/helper.rb ADDED Viewed

@@ -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.find(: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 ADDED Viewed

@@ -0,0 +1,49 @@
+#!/usr/bin/env ruby -w
+require 'test/unit'
+require "axlsx/acts_as_xlsx"
+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_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_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
+end

metadata ADDED Viewed

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_xlsx
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease:
+platform: ruby
+authors:
+- Randy Morgan
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2011-12-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: axlsx
+  requirement: &2153137140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.10
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153137140
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &2153136660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.9
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153136660
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: &2153135840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153135840
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &2153135180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153135180
+- !ruby/object:Gem::Dependency
+  name: rdiscount
+  requirement: &2153134060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153134060
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &2153133120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153133120
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2153132140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: *2153132140
+description: ! '    acts_as_xlsx lets you turn any ActiveRecord::Base inheriting class
+  into an excel spreadsheet.
+'
+email: digital.ipseity@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- acts_as_xlsx.gemspec
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- Rakefile
+- README.md
+- lib/axlsx/acts_as_xlsx.rb
+- doc/_index.html
+- doc/Axlsx/Ar/ClassMethods.html
+- doc/Axlsx/Ar/InstanceMethods.html
+- doc/Axlsx/Ar/SingletonMethods.html
+- doc/Axlsx/Ar.html
+- doc/Axlsx.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/file.LICENSE.html
+- doc/file.README.html
+- doc/file_list.html
+- doc/frames.html
+- doc/index.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/top-level-namespace.html
+- test/acts_as_xlsx.sqlite3.db
+- test/database.yml
+- test/helper.rb
+- test/tc_acts_as_xlsx.rb
+homepage: https://github.com/randym/acts_as_xlsx
+licenses: []
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 1.8.10
+signing_key:
+specification_version: 3
+summary: ActiveRecord support for Axlsx
+test_files: []
+has_rdoc: acts_as_xlsx