Git Product home page Git Product logo

grape-axlsx's Introduction

Grape::Axlsx

Use Axlsx templates in Grape

Based on grape-jbuilder and axlsx-rails

Installation

Add this line to your application's Gemfile:

gem 'grape-axlsx'

And then execute:

$ bundle

Or install it yourself as:

$ gem install grape-axlsx

Usage

Setup view root directory

use Rack::Config do |env|
  env['api.tilt.root'] = '/path/to/view/root/directory'
end

Setup Axlsx Formatter for xlsx api format

class API < Grape::API
  content_type :xlsx, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
  format :xlsx
  formatter :xlsx, Grape::Formatter::Axlsx
end

Specify axlsx template path

resources :users do
  get axlsx: 'users/user.xlsx.axlsx' do
    @users = User.all
  end
end

# or you can omit .axlsx extension

...
get axlsx: 'users/user.xlsx' do
...

Example of axlsx template

# NOTE: xlsx_package is predefined instance of Axlsx::Package
wb = xlsx_package.workbook
wb.add_worksheet(name: "Users list") do |sheet|
  sheet.add_row ["id", "First name", "Last name", "Middle name"]
  @users.each do |user|
    sheet.add_row [user.id, user.first_name, user.last_name, user.middle_name]
  end
end

Contributing

  1. Fork it ( https://github.com/lfidnl/grape-axlsx/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

grape-axlsx's People

Contributors

lfidnl avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.