columnify 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23799bf1b20790cb982bc05c5e24e8f0637ac827312e53b451ae64dc41d0539b
-  data.tar.gz: ffafc917c8970d1f81d9babb0d6c7a11e7d91a4fb1bb344bb22966ccdd9b2b1b
+  metadata.gz: eb341ed259e90cc3c387e4b9d5ca32f52a492d929382297470da93bd6570c13e
+  data.tar.gz: b85795e08d28b364ca3cdab2c657c2ce567795db9045c09bc1a8b68e5a5ff846
 SHA512:
-  metadata.gz: 148bd6c17c6e69f7cd2c7ddec98969f41bf15bcb962868025af25f2d7ff8ce0cbd2d1681985d575df76e85ca75f74393ef1d8d050b0e8c93e9f160e667fb8073
-  data.tar.gz: 55133f1e214cf02f8f811006c1978867d609474e282d4de34ad7488e306bffc7e3a2829b035ff254c8a383b943ab543f8c8268372b54700e5ed8e1c5fd4acf72
+  metadata.gz: '0859c1b06a9db307b586c247329ad959609cb8e8ba5647df9871fe1a33b26850d00844538ee6108b5cb7859c8a91ec821a097cfb35e2e034850744ab18c1489b'
+  data.tar.gz: 3a96c7b355368521a2805a037f91d04e6a421ec1a222c7606498d1808c13bce7bfa12fc8bbbbd16819037721658edfa2c2d21c8bacada986d3867293e5e9192a

data/.gitignore

@@ -9,3 +9,4 @@
 
 # rspec failure tracking
 .rspec_status
+*.gem

data/Gemfile.lock

@@ -0,0 +1,146 @@
+PATH
+  remote: .
+  specs:
+    columnify (0.1.0)
+      rails (>= 5.0, <= 6.0)
+      spreadsheet
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.2.3)
+      actionpack (= 5.2.3)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailer (5.2.3)
+      actionpack (= 5.2.3)
+      actionview (= 5.2.3)
+      activejob (= 5.2.3)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.2.3)
+      actionview (= 5.2.3)
+      activesupport (= 5.2.3)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.3)
+      activesupport (= 5.2.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.2.3)
+      activesupport (= 5.2.3)
+      globalid (>= 0.3.6)
+    activemodel (5.2.3)
+      activesupport (= 5.2.3)
+    activerecord (5.2.3)
+      activemodel (= 5.2.3)
+      activesupport (= 5.2.3)
+      arel (>= 9.0)
+    activestorage (5.2.3)
+      actionpack (= 5.2.3)
+      activerecord (= 5.2.3)
+      marcel (~> 0.3.1)
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    builder (3.2.4)
+    concurrent-ruby (1.1.6)
+    crass (1.0.6)
+    diff-lcs (1.3)
+    erubi (1.9.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    loofah (2.4.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (0.9.2)
+    mimemagic (0.3.4)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    minitest (5.14.0)
+    nio4r (2.5.2)
+    nokogiri (1.10.9)
+      mini_portile2 (~> 2.4.0)
+    rack (2.2.2)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (5.2.3)
+      actioncable (= 5.2.3)
+      actionmailer (= 5.2.3)
+      actionpack (= 5.2.3)
+      actionview (= 5.2.3)
+      activejob (= 5.2.3)
+      activemodel (= 5.2.3)
+      activerecord (= 5.2.3)
+      activestorage (= 5.2.3)
+      activesupport (= 5.2.3)
+      bundler (>= 1.3.0)
+      railties (= 5.2.3)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (5.2.3)
+      actionpack (= 5.2.3)
+      activesupport (= 5.2.3)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    ruby-ole (1.2.12.2)
+    spreadsheet (1.2.6)
+      ruby-ole (>= 1.0)
+    sprockets (4.0.0)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.6)
+      thread_safe (~> 0.1)
+    websocket-driver (0.7.1)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  columnify!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.2

data/README.md

@@ -7,6 +7,7 @@ The `columnify` gem helps you easily render Excel files through your controller
 - [Columnify](#columnify)
   - [Table of contents](#table-of-contents)
   - [Installing Columnify](#installing-columnify)
+  - [Usage](#usage)
   - [Contributing](#contributing)
   - [License](#license)
   - [Code of Conduct](#code-of-conduct)
@@ -39,6 +40,17 @@ $ rails g columnify:install
 
 This will just register the `xls` mime type inside the `config/initializers/mime_types.rb` file.
 
+## Usage
+
+The gem will add a renderer and a template handler for you to easily handle the creation of the Excel file:
+
+```ruby
+# app/views/posts/index.xls.columnify
+spreadsheet.worksheet @posts, :id, :title, :content
+```
+
+So the usage for the views is just to call the `workbook` method, send the array or active record collection, followed by the set of attributes or methods you want to appear on the `xls` file.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/kurenn/columnify. 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.

data/columnify.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "spreadsheet"
+  spec.add_dependency 'rails', '>= 5.0', '<= 6.0'
 
   spec.add_development_dependency "bundler", "~> 1.17"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/columnify.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require "columnify/version"
-require "columnify/railtie"
+require 'columnify/version'
+require 'columnify/railtie'
 
 module Columnify
   module Mime

data/lib/columnify/columnify_template.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
-require "action_dispatch/http/mime_type"
-require "spreadsheet"
+require 'action_dispatch/http/mime_type'
+require 'spreadsheet'
+require 'columnify/worksheet'
 
 class ColumnifyTemplate
   class << self
@@ -15,31 +16,9 @@ class ColumnifyTemplate
     super(*args)
   end
 
-  def workbook
-    @workbook ||= Spreadsheet::Workbook.new
-  end
-
   def worksheet(resources, *args)
-    sheet = workbook.create_worksheet(name: worksheet_name.to_s)
-
-    sheet.row(0).concat args.map(&:to_s).map(&:humanize)
-
-    resources.each_with_index do |resource, index|
-      args.each do |method_name|
-        sheet.row(index + 1).push(resource.send(method_name))
-      end
-    end
-
-    buffer = StringIO.new
-    workbook.write(buffer)
-    buffer.rewind
-    buffer.read
-  end
-
-  private
-
-  def worksheet_name
-    DateTime.now.to_i
+    worksheet = Columnify::Worksheet.new(resources, *args)
+    worksheet.create
   end
 end
 

data/lib/columnify/railtie.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'rails'
+
 module Columnify
   class Railtie < Rails::Railtie
     initializer :columnify do

data/lib/columnify/version.rb

@@ -1,3 +1,3 @@
 module Columnify
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/columnify/worksheet.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Columnify
+  class Worksheet
+    def initialize(resources, *args)
+      @options = args.extract_options!
+      @column_names = @options[:column_names].presence || args
+      @attributes = args
+      @resources = resources
+      @buffer = StringIO.new
+      @workbook = Spreadsheet::Workbook.new
+    end
+
+    def create
+      inject_column_names
+      inject_data
+      write_workbook_buffer
+      read
+    end
+
+    private
+
+    def read
+      @buffer.rewind
+      @buffer.read
+    end
+
+    def write_workbook_buffer
+      @workbook.write(@buffer)
+    end
+
+    def inject_column_names
+      sheet.row(0).concat humanized_columns
+    end
+
+    def inject_data
+      @resources.each_with_index do |resource, index|
+        sheet.column(index).default_format = cell_format
+        @attributes.each do |method_name|
+          sheet.row(index + 1).default_format = cell_format
+          sheet.row(index + 1).push(resource.send(method_name))
+        end
+      end
+    end
+
+    def cell_format
+      @cell_format ||= Spreadsheet::Format.new text_wrap: true
+    end
+
+    def humanized_columns
+      @humanized_columns ||= @column_names.map(&:to_s).map(&:humanize)
+    end
+
+    def sheet
+      @sheet ||= @workbook.create_worksheet(name: worksheet_name)
+    end
+
+    def worksheet_name
+      Time.now.to_i.to_s
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: columnify
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Abraham Kuri
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-06 00:00:00.000000000 Z
+date: 2020-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: spreadsheet
@@ -24,6 +24,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -78,6 +98,7 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -89,6 +110,7 @@ files:
 - lib/columnify/columnify_template.rb
 - lib/columnify/railtie.rb
 - lib/columnify/version.rb
+- lib/columnify/worksheet.rb
 - lib/generators/columnify/install_generator.rb
 homepage: https://github.com/kurenn/columnify
 licenses:
@@ -109,8 +131,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A simple Excel & CSV Rails Responder