btedev-comma 0.1.7

Sign up to get free protection for your applications and to get access to all the features.
data/MIT-LICENSE ADDED
@@ -0,0 +1,20 @@
1
+ Copyright (c) 2009 Marcus Crafter
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining
4
+ a copy of this software and associated documentation files (the
5
+ "Software"), to deal in the Software without restriction, including
6
+ without limitation the rights to use, copy, modify, merge, publish,
7
+ distribute, sublicense, and/or sell copies of the Software, and to
8
+ permit persons to whom the Software is furnished to do so, subject to
9
+ the following conditions:
10
+
11
+ The above copyright notice and this permission notice shall be
12
+ included in all copies or substantial portions of the Software.
13
+
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.markdown ADDED
@@ -0,0 +1,124 @@
1
+ = COMMA
2
+
3
+ [http://github.com/crafterm/comma](http://github.com/crafterm/comma)
4
+
5
+ == DESCRIPTION:
6
+
7
+ Comma is a CSV (ie. comma separated values) generation extension for Ruby objects, that lets you seamlessly define a CSV output format via a small DSL. Comma works well on pure Ruby objects with attributes, as well as complex ones such as ActiveRecord objects with associations, extensions, etc. It doesn't distinguish between attributes, methods, associations, extensions, etc - they all are considered equal and invoked identically via the Comma DSL description. Multiple different CSV output descriptions can also be defined.
8
+
9
+ When multiple objects in an Array are converted to CSV, the output includes generation of a header row reflected from names of the properties requested, or specified via the DSL.
10
+
11
+ CSV can be a bit of a boring format - the motivation behind Comma was to have a CSV extension that was simple, flexible, and would treat attributes, methods, associations, etc, all the same without the need for any complex configuration, and also work on Ruby objects, not just ActiveRecord or other base class derivatives.
12
+
13
+ An example Comma CSV enabled ActiveRecord class:
14
+
15
+ class Book < ActiveRecord::Base
16
+
17
+ # ================
18
+ # = Associations =
19
+ # ================
20
+ has_many :pages
21
+ has_one :isbn
22
+ belongs_to :publisher
23
+
24
+ # ===============
25
+ # = CSV support =
26
+ # ===============
27
+ comma do
28
+
29
+ name
30
+ description
31
+
32
+ pages :size => 'Pages'
33
+ publisher :name
34
+ isbn :number_10 => 'ISBN-10', :number_13 => 'ISBN-13'
35
+ blurb 'Summary'
36
+
37
+ end
38
+
39
+ end
40
+
41
+ Annotated, the comma description is as follows:
42
+
43
+ # starts a Comma description block, generating 2 methods #to_comma and #to_comma_headers for this class.
44
+ comma do
45
+
46
+ # name, description are attributes of Book with the header being reflected as 'Name', 'Description'
47
+ name
48
+ description
49
+
50
+ # pages is an association returning an array, :size is called on the association results, with the header name specifed as 'Pages'
51
+ pages :size => 'Pages'
52
+
53
+ # publisher is an association returning an object, :name is called on the associated object, with the reflected header 'Name'
54
+ publisher :name
55
+
56
+ # isbn is an association returning an object, :number_10 and :number_13 are called on the object with the specified headers 'ISBN-10' and 'ISBN-13'
57
+ isbn :number_10 => 'ISBN-10', :number_13 => 'ISBN-13'
58
+
59
+ # blurb is an attribute of Book, with the header being specified directly as 'Summary'
60
+ blurb 'Summary'
61
+
62
+ end
63
+
64
+ In the above example, any of the declarations (name, description, pages, publisher, isbn, blurb, etc), could be methods, attributes, associations, etc - no distinction during configuration is required, as everything is invoked via Ruby's #send method.
65
+
66
+ You can get the CSV representation of any object by calling the to_comma method, optionally providing a CSV description name to use.
67
+
68
+ Object values are automatically converted to strings via to_s allowing you to reuse any existing to_s methods on your objects (instead of having to call particular properties or define CSV specific output methods). Header names are also automatically humanized when reflected (eg. replacing _ characters with whitespace). The 'isbn' example above shows how multiple values can be added to the CSV output.
69
+
70
+ Multiple CSV descriptions can also be specified for the same class, eg:
71
+
72
+ class Book < ActiveRecord::Base
73
+
74
+ # ================
75
+ # = Associations =
76
+ # ================
77
+ has_many :pages
78
+ has_one :isbn
79
+ belongs_to :publisher
80
+
81
+ # ===============
82
+ # = CSV support =
83
+ # ===============
84
+ comma do
85
+
86
+ name
87
+ description
88
+
89
+ pages :size => 'Pages'
90
+ publisher :name
91
+ isbn :number_10 => 'ISBN-10', :number_13 => 'ISBN-13'
92
+ blurb 'Summary'
93
+
94
+ end
95
+
96
+ comma :brief do
97
+
98
+ name
99
+ description
100
+ blurb 'Summary'
101
+
102
+ end
103
+
104
+ end
105
+
106
+ You can specify which output format you would like to use via an optional parameter to to_comma:
107
+
108
+ Book.limited(10).to_comma(:brief)
109
+
110
+ Specifying no description name to to_comma is equivalent to specifying :default as the description name.
111
+
112
+ When used with Rails (ie. add 'comma' as a gem dependency), Comma automatically adds support for rendering CSV output in your controllers:
113
+
114
+ class BooksController < ApplicationController
115
+
116
+ def index
117
+ respond_to do |format|
118
+ format.csv { render :csv => Book.limited(50) }
119
+ end
120
+ end
121
+
122
+ end
123
+
124
+ If you have any questions or suggestions for Comma, please feel free to contact me at crafterm@redartisan.com, all feedback welcome!
@@ -0,0 +1,60 @@
1
+ module Comma
2
+
3
+ class Extractor
4
+
5
+ def initialize(instance, &block)
6
+ @instance = instance
7
+ @block = block
8
+ @results = []
9
+ end
10
+
11
+ def results
12
+ instance_eval &@block
13
+ @results
14
+ end
15
+ end
16
+
17
+ class HeaderExtractor < Extractor
18
+
19
+ def method_missing(sym, *args, &block)
20
+ @results << sym.to_s.humanize if args.blank?
21
+
22
+ args.each do |arg|
23
+ case arg
24
+ when Hash
25
+ arg.each do |k, v|
26
+ @results << ((v.is_a? String) ? v : v.to_s.humanize)
27
+ end
28
+ when Symbol
29
+ @results << arg.to_s.humanize
30
+ when String
31
+ @results << arg
32
+ else
33
+ raise "Unknown header symbol #{arg.inspect}"
34
+ end
35
+ end
36
+ end
37
+ end
38
+
39
+ class DataExtractor < Extractor
40
+
41
+ def method_missing(sym, *args, &block)
42
+ @results << @instance.send(sym).to_s if args.blank?
43
+
44
+ args.each do |arg|
45
+ case arg
46
+ when Hash
47
+ arg.each do |k, v|
48
+ @results << @instance.send(sym).send(k).to_s
49
+ end
50
+ when Symbol
51
+ @results << @instance.send(sym).send(arg).to_s
52
+ when String
53
+ @results << @instance.send(sym).to_s
54
+ else
55
+ raise "Unknown data symbol #{arg.inspect}"
56
+ end
57
+ end
58
+ end
59
+ end
60
+ end
data/lib/comma.rb ADDED
@@ -0,0 +1,53 @@
1
+ require 'activesupport'
2
+ require 'fastercsv'
3
+ require 'comma/extractors'
4
+
5
+ class Array
6
+ def to_comma(style = :default)
7
+ FasterCSV.generate do |csv|
8
+ return "" if empty?
9
+ csv << first.to_comma_headers(style)
10
+ each do |object|
11
+ csv << object.to_comma(style)
12
+ end
13
+ end
14
+ end
15
+ end
16
+
17
+ class Object
18
+ class_inheritable_accessor :comma_formats
19
+
20
+ def self.comma(style = :default, &block)
21
+ (self.comma_formats ||= {})[style] = block
22
+ end
23
+
24
+ def to_comma(style = :default)
25
+ raise "No comma format for class #{self.class} defined for style #{style}" unless self.comma_formats and self.comma_formats[style]
26
+ Comma::DataExtractor.new(self, &self.comma_formats[style]).results
27
+ end
28
+
29
+ def to_comma_headers(style = :default)
30
+ raise "No comma format for class #{self.class} defined for style #{style}" unless self.comma_formats and self.comma_formats[style]
31
+ Comma::HeaderExtractor.new(self, &self.comma_formats[style]).results
32
+ end
33
+ end
34
+
35
+ if defined?(ActionController)
36
+ module RenderAsCSV
37
+
38
+ def self.included(base)
39
+ base.send :include, InstanceMethods
40
+ base.alias_method_chain :render, :csv
41
+ end
42
+
43
+ module InstanceMethods
44
+ def render_with_csv(options = nil, extra_options = {}, &block)
45
+ return render_without_csv(options, extra_options, &block) unless (options.respond_to? '[]') and options[:csv]
46
+ send_data Array(options[:csv]).to_comma(options[:style] ||= :default), :filename => "test.csv"
47
+ end
48
+ end
49
+
50
+ end
51
+
52
+ ActionController::Base.send :include, RenderAsCSV
53
+ end
metadata ADDED
@@ -0,0 +1,75 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: btedev-comma
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.7
5
+ platform: ruby
6
+ authors:
7
+ - Barry Ezell
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+
12
+ date: 2009-04-08 00:00:00 -07:00
13
+ default_executable:
14
+ dependencies:
15
+ - !ruby/object:Gem::Dependency
16
+ name: fastercsv
17
+ type: :runtime
18
+ version_requirement:
19
+ version_requirements: !ruby/object:Gem::Requirement
20
+ requirements:
21
+ - - ">="
22
+ - !ruby/object:Gem::Version
23
+ version: 1.4.0
24
+ version:
25
+ - !ruby/object:Gem::Dependency
26
+ name: activesupport
27
+ type: :runtime
28
+ version_requirement:
29
+ version_requirements: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: 2.2.2
34
+ version:
35
+ description:
36
+ email: barrye@gmail.com
37
+ executables: []
38
+
39
+ extensions: []
40
+
41
+ extra_rdoc_files: []
42
+
43
+ files:
44
+ - README.markdown
45
+ - MIT-LICENSE
46
+ - lib/comma.rb
47
+ - lib/comma/extractors.rb
48
+ has_rdoc: false
49
+ homepage: http://github.com/btedev/comma
50
+ post_install_message:
51
+ rdoc_options: []
52
+
53
+ require_paths:
54
+ - lib
55
+ required_ruby_version: !ruby/object:Gem::Requirement
56
+ requirements:
57
+ - - ">="
58
+ - !ruby/object:Gem::Version
59
+ version: "0"
60
+ version:
61
+ required_rubygems_version: !ruby/object:Gem::Requirement
62
+ requirements:
63
+ - - ">="
64
+ - !ruby/object:Gem::Version
65
+ version: "0"
66
+ version:
67
+ requirements: []
68
+
69
+ rubyforge_project:
70
+ rubygems_version: 1.2.0
71
+ signing_key:
72
+ specification_version: 2
73
+ summary: Fork of Marcus Crafter's Ruby Comma Seperated Values generation library
74
+ test_files: []
75
+