xls_exporter 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.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 2e3bad06d6aaee0001521bcadf5c246b4bb802e8
4
+ data.tar.gz: '01082d6a75c2a0c264d2cf0cf7101c3a6632b58f'
5
+ SHA512:
6
+ metadata.gz: 59d31aa2289bfe1504a4b3e04303c347f44d05502328049c0910a108c8ef6c6d2dd36945cadfd20d45dcb81dfafa2a04c0a8b765f5428453219d9759401d0e63
7
+ data.tar.gz: 7e1d1c3692de8eb4c64aa6fa98fb5abfce4e20620ff069c6eca49d040457375e8770dc6943e599e0f76ce68b8faac435494075a7602ff6732439be4f07ae1fcd
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
@@ -0,0 +1,4 @@
1
+ language: ruby
2
+ rvm:
3
+ - 2.2.3
4
+ before_install: gem install bundler -v 1.11.2
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in xls_exporter.gemspec
4
+ gemspec
@@ -0,0 +1,55 @@
1
+ # XlsExporter
2
+
3
+ ## Installation
4
+
5
+ Add this line to your application's Gemfile:
6
+
7
+ ```ruby
8
+ gem 'xls_exporter'
9
+ ```
10
+
11
+ And then execute:
12
+
13
+ $ bundle
14
+
15
+ Or install it yourself as:
16
+
17
+ $ gem install xls_exporter
18
+
19
+ ## Usage
20
+
21
+ ```ruby
22
+ class User
23
+ attr_accessor :id, :first_name, :last_name, :email
24
+ end
25
+
26
+
27
+ require 'xls_exporter'
28
+
29
+ XlsExport.export do
30
+ filename 'your-file-name'
31
+
32
+ add_sheet 'your-sheet-name'
33
+ export_models collection, :id, { full_name: -> { first_name + last_name } }, { user_email: :email }
34
+ end
35
+ ```
36
+
37
+ Result
38
+
39
+ | ID | Full Name | User Email |
40
+ |----|----------------|-------------------------------|
41
+ | 1 | Zhora Zhukov | victory_marshal@army.su |
42
+ | 2 | Petr The First | borody@doloi.ru |
43
+ | 3 | Vladimir P. | babushka_would_be@dedushka.ru |
44
+
45
+
46
+ ## Development
47
+
48
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
49
+
50
+ To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`.
51
+
52
+ ## Contributing
53
+
54
+ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/xls_exporter. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
55
+
@@ -0,0 +1,10 @@
1
+ require 'bundler/gem_tasks'
2
+ require 'rake/testtask'
3
+
4
+ Rake::TestTask.new(:test) do |t|
5
+ t.libs << 'test'
6
+ t.libs << 'lib'
7
+ t.test_files = FileList['test/**/*_test.rb']
8
+ end
9
+
10
+ task :default => :spec
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require 'bundler/setup'
4
+ require 'xls_exporter'
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require 'pry'
11
+ # Pry.start
12
+
13
+ require 'irb'
14
+ IRB.start
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,8 @@
1
+ require 'xls_exporter/version'
2
+ require 'xls_exporter/exporter'
3
+
4
+ module XlsExporter
5
+ def self.export(&block)
6
+ Exporter.export(&block)
7
+ end
8
+ end
@@ -0,0 +1,76 @@
1
+ require 'spreadsheet'
2
+
3
+ module XlsExporter
4
+ class Exporter
5
+ def self.export(&block)
6
+ exporter = new
7
+ exporter.instance_exec(&block)
8
+ exporter.save!
9
+ end
10
+
11
+ def initialize
12
+ @book = Spreadsheet::Workbook.new
13
+ end
14
+
15
+ def add_sheet(sheet_name = nil)
16
+ save_sheet! if @sheet
17
+ @headers = []
18
+ @body = []
19
+ @sheet = @book.create_worksheet
20
+
21
+ @sheet.name = sheet_name
22
+ end
23
+
24
+ def filename(new_filename)
25
+ @filename = new_filename
26
+ end
27
+
28
+ def headers(*args)
29
+ @headers = args
30
+ end
31
+
32
+ def body(new_body)
33
+ @body = new_body
34
+ end
35
+
36
+ def humanize_columns(columns)
37
+ columns.map do |column|
38
+ column = column.keys.first if column.is_a? Hash
39
+ column.to_s.humanize
40
+ end
41
+ end
42
+
43
+ def export_models(scope, *columns)
44
+ headers(*humanize_columns(columns))
45
+ to_body = scope.map do |instance|
46
+ columns.map do |column|
47
+ column = column.values.first if column.is_a? Hash
48
+ if column.is_a? Proc
49
+ instance.instance_exec(&column)
50
+ elsif column.is_a? Symbol
51
+ instance.send column
52
+ end
53
+ end
54
+ end
55
+ body to_body
56
+ end
57
+
58
+ def save_sheet!
59
+ @sheet.row(0).concat(@headers)
60
+ @body.each_with_index do |row, index|
61
+ @sheet.row(index + 1).concat(row)
62
+ end
63
+ end
64
+
65
+ def save!
66
+ save_sheet!
67
+ if @filename.present?
68
+ filename = "./#{@filename}_#{Time.now.to_i}.xls"
69
+ @book.write(filename)
70
+ puts "Report has been saved as #{filename}"
71
+ else
72
+ @book
73
+ end
74
+ end
75
+ end
76
+ end
@@ -0,0 +1,3 @@
1
+ module XlsExporter
2
+ VERSION = '1.0.0'
3
+ end
@@ -0,0 +1,24 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'xls_exporter/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = 'xls_exporter'
8
+ spec.version = XlsExporter::VERSION
9
+ spec.authors = ['Artyom Keydunov', 'Pavel Kalashnikov']
10
+ spec.email = ['kalashnikovisme@gmail.com']
11
+
12
+ spec.summary = %q{Creates xls files with collection attributes.}
13
+ spec.homepage = 'https://github.com/kalashnikovisme/xls-exporter'
14
+
15
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
16
+ spec.bindir = 'exe'
17
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
18
+ spec.require_paths = ['lib']
19
+
20
+ spec.add_development_dependency 'bundler', '~> 1.11'
21
+ spec.add_development_dependency 'rake', '~> 10.0'
22
+ spec.add_development_dependency 'minitest', '~> 5.0'
23
+ spec.add_dependency 'spreadsheet'
24
+ end
metadata ADDED
@@ -0,0 +1,111 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: xls_exporter
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.0.0
5
+ platform: ruby
6
+ authors:
7
+ - Artyom Keydunov
8
+ - Pavel Kalashnikov
9
+ autorequire:
10
+ bindir: exe
11
+ cert_chain: []
12
+ date: 2017-02-07 00:00:00.000000000 Z
13
+ dependencies:
14
+ - !ruby/object:Gem::Dependency
15
+ name: bundler
16
+ requirement: !ruby/object:Gem::Requirement
17
+ requirements:
18
+ - - "~>"
19
+ - !ruby/object:Gem::Version
20
+ version: '1.11'
21
+ type: :development
22
+ prerelease: false
23
+ version_requirements: !ruby/object:Gem::Requirement
24
+ requirements:
25
+ - - "~>"
26
+ - !ruby/object:Gem::Version
27
+ version: '1.11'
28
+ - !ruby/object:Gem::Dependency
29
+ name: rake
30
+ requirement: !ruby/object:Gem::Requirement
31
+ requirements:
32
+ - - "~>"
33
+ - !ruby/object:Gem::Version
34
+ version: '10.0'
35
+ type: :development
36
+ prerelease: false
37
+ version_requirements: !ruby/object:Gem::Requirement
38
+ requirements:
39
+ - - "~>"
40
+ - !ruby/object:Gem::Version
41
+ version: '10.0'
42
+ - !ruby/object:Gem::Dependency
43
+ name: minitest
44
+ requirement: !ruby/object:Gem::Requirement
45
+ requirements:
46
+ - - "~>"
47
+ - !ruby/object:Gem::Version
48
+ version: '5.0'
49
+ type: :development
50
+ prerelease: false
51
+ version_requirements: !ruby/object:Gem::Requirement
52
+ requirements:
53
+ - - "~>"
54
+ - !ruby/object:Gem::Version
55
+ version: '5.0'
56
+ - !ruby/object:Gem::Dependency
57
+ name: spreadsheet
58
+ requirement: !ruby/object:Gem::Requirement
59
+ requirements:
60
+ - - ">="
61
+ - !ruby/object:Gem::Version
62
+ version: '0'
63
+ type: :runtime
64
+ prerelease: false
65
+ version_requirements: !ruby/object:Gem::Requirement
66
+ requirements:
67
+ - - ">="
68
+ - !ruby/object:Gem::Version
69
+ version: '0'
70
+ description:
71
+ email:
72
+ - kalashnikovisme@gmail.com
73
+ executables: []
74
+ extensions: []
75
+ extra_rdoc_files: []
76
+ files:
77
+ - ".gitignore"
78
+ - ".travis.yml"
79
+ - Gemfile
80
+ - README.md
81
+ - Rakefile
82
+ - bin/console
83
+ - bin/setup
84
+ - lib/xls_exporter.rb
85
+ - lib/xls_exporter/exporter.rb
86
+ - lib/xls_exporter/version.rb
87
+ - xls_exporter.gemspec
88
+ homepage: https://github.com/kalashnikovisme/xls-exporter
89
+ licenses: []
90
+ metadata: {}
91
+ post_install_message:
92
+ rdoc_options: []
93
+ require_paths:
94
+ - lib
95
+ required_ruby_version: !ruby/object:Gem::Requirement
96
+ requirements:
97
+ - - ">="
98
+ - !ruby/object:Gem::Version
99
+ version: '0'
100
+ required_rubygems_version: !ruby/object:Gem::Requirement
101
+ requirements:
102
+ - - ">="
103
+ - !ruby/object:Gem::Version
104
+ version: '0'
105
+ requirements: []
106
+ rubyforge_project:
107
+ rubygems_version: 2.5.2
108
+ signing_key:
109
+ specification_version: 4
110
+ summary: Creates xls files with collection attributes.
111
+ test_files: []