columnify 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 23799bf1b20790cb982bc05c5e24e8f0637ac827312e53b451ae64dc41d0539b
+  data.tar.gz: ffafc917c8970d1f81d9babb0d6c7a11e7d91a4fb1bb344bb22966ccdd9b2b1b
+SHA512:
+  metadata.gz: 148bd6c17c6e69f7cd2c7ddec98969f41bf15bcb962868025af25f2d7ff8ce0cbd2d1681985d575df76e85ca75f74393ef1d8d050b0e8c93e9f160e667fb8073
+  data.tar.gz: 55133f1e214cf02f8f811006c1978867d609474e282d4de34ad7488e306bffc7e3a2829b035ff254c8a383b943ab543f8c8268372b54700e5ed8e1c5fd4acf72

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 1.17.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at kurenn@icalialabs.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in columnify.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Abraham Kuri
+
+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,52 @@
+# Columnify
+
+The `columnify` gem helps you easily render Excel files through your controller actions with ease.
+
+
+## Table of contents
+- [Columnify](#columnify)
+  - [Table of contents](#table-of-contents)
+  - [Installing Columnify](#installing-columnify)
+  - [Contributing](#contributing)
+  - [License](#license)
+  - [Code of Conduct](#code-of-conduct)
+
+## Installing Columnify
+
+You need to include the `columnify` gem inside your `Gemfile`:
+
+```ruby
+gem 'columnify', '~> 0.0.1'
+```
+
+or you can install the latest build:
+
+```ruby
+gem 'columnify', git: 'https://github.com/kurenn/columnify.git'
+```
+
+Install the gem by running the bundle command:
+
+```
+$ bundle install
+```
+
+After running the `bundle` command, you can now run the installer.
+
+```console
+$ rails g columnify:install
+```
+
+This will just register the `xls` mime type inside the `config/initializers/mime_types.rb` 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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Columnify project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/kurenn/columnify/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "columnify"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/columnify.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "columnify/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "columnify"
+  spec.version = Columnify::VERSION
+  spec.authors = ["Abraham Kuri"]
+  spec.email = ["kurenn@icalialabs.com"]
+
+  spec.summary = %q{A simple Excel & CSV Rails Responder}
+  spec.description = %q{A powerful Rails responder to create Excel & CSV files with ease}
+  spec.homepage = "https://github.com/kurenn/columnify"
+  spec.license = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "spreadsheet"
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/columnify.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "columnify/version"
+require "columnify/railtie"
+
+module Columnify
+  module Mime
+    XLS = "application/xls".freeze
+  end
+end

data/lib/columnify/action_controller.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "action_controller"
+
+ActionController::Renderers.add :xls do |filename, options|
+  # force layout false
+  options[:layout] = false
+
+  # disposition / filename
+  disposition = options.delete(:disposition) || "attachment"
+  file_name = options.delete(:filename) || "#{filename.gsub(/^.*\//, "")}.xls"
+
+  send_data render_to_string(options), type: Columnify::Mime::XLS, filename: file_name, disposition: disposition
+end

data/lib/columnify/columnify_template.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "action_dispatch/http/mime_type"
+require "spreadsheet"
+
+class ColumnifyTemplate
+  class << self
+    attr_accessor :template_lookup_options
+  end
+
+  self.template_lookup_options = {handlers: [:columnify]}
+
+  def initialize(context, *args)
+    @context = context
+    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
+  end
+end
+
+class ColumnifyHandler
+  cattr_accessor :default_format
+  self.default_format = Columnify::Mime::XLS
+
+  def self.call(template, source = nil)
+    source ||= template.source
+    # this juggling is required to keep line numbers right in the error
+    %{__already_defined = defined?(spreadsheet); spreadsheet||=ColumnifyTemplate.new(self); #{source}}
+  end
+end

data/lib/columnify/railtie.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Columnify
+  class Railtie < Rails::Railtie
+    initializer :columnify do
+      ActiveSupport.on_load(:action_view) do
+        require "columnify/columnify_template"
+        ActionView::Template.register_template_handler :columnify, ColumnifyHandler
+      end
+
+      ActiveSupport.on_load(:action_controller) do
+        require "columnify/action_controller"
+      end
+    end
+  end
+end

data/lib/columnify/version.rb

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

data/lib/generators/columnify/install_generator.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "rails/generators/base"
+
+module Columnify
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      def register_mime_type
+        append_to_file "config/initializers/mime_types.rb",
+                       %Q{Mime::Type.register "#{Columnify::Mime::XLS}", :xls}
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: columnify
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Abraham Kuri
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: spreadsheet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A powerful Rails responder to create Excel & CSV files with ease
+email:
+- kurenn@icalialabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- columnify.gemspec
+- lib/columnify.rb
+- lib/columnify/action_controller.rb
+- lib/columnify/columnify_template.rb
+- lib/columnify/railtie.rb
+- lib/columnify/version.rb
+- lib/generators/columnify/install_generator.rb
+homepage: https://github.com/kurenn/columnify
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: A simple Excel & CSV Rails Responder
+test_files: []