grape-axlsx 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2ba370a9110a9e5c07526bfa2d988ad119b91094
+  data.tar.gz: 857f6fea4218dffd5799a99da14c50123ebb8ec9
+SHA512:
+  metadata.gz: 3852907ad61e6e481b49875b5bc0fd98d8d93d533f4b4b57298e2da4a29f5a8010760e97ef918bbdfb92008d0d553335851676c017e8e69e85c712b5f66d70ce
+  data.tar.gz: 32117e739923779077190f0fc9e9d1ca62a88b2e545addf113adae8c92073de39ce97717a73f7e037a16f7e931f70f7fd9cf980f7922887109d6668eaf411c86

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in grape-axlsx.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Ivan Kabluchkov
+
+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,78 @@
+# Grape::Axlsx
+
+Use [Axlsx](https://github.com/randym/axlsx) templates in [Grape](https://github.com/ruby-grape/grape)
+
+Based on [grape-jbuilder](https://github.com/milkcocoa/grape-jbuilder) and [axlsx-rails](https://github.com/straydogstudio/axlsx_rails)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'grape-axlsx'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install grape-axlsx
+
+## Usage
+
+### Setup view root directory
+
+```ruby
+use Rack::Config do |env|
+  env['api.tilt.root'] = '/path/to/view/root/directory'
+end
+```
+
+### Setup Axlsx Formatter for xlsx api format
+
+```ruby
+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
+
+```ruby
+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
+
+```ruby
+# 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

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/grape-axlsx.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'grape/axlsx/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "grape-axlsx"
+  spec.version       = Grape::Axlsx::VERSION
+  spec.authors       = ["Ivan Kabluchkov"]
+  spec.email         = ["ikabluchkov@gmail.com"]
+
+  spec.summary       = %q{Use Axlsx in Grape}
+  spec.description   = %q{Simple implementation for using Axlsx templates in Grape.}
+  spec.homepage      = "https://github.com/lfidnl/grape-axlsx"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "grape", ">= 0.3"
+  spec.add_dependency "axlsx"
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/grape/axlsx.rb

@@ -0,0 +1,5 @@
+require "axlsx"
+
+require "grape/axlsx/version"
+require "grape/axlsx/renderer"
+require "grape/formatter/axlsx"

data/lib/grape/axlsx/renderer.rb

@@ -0,0 +1,34 @@
+module Grape
+  module Axlsx
+    class Renderer
+      attr_reader :view_path, :template
+
+      def initialize(view_path, template)
+        @view_path, @template = view_path, template
+      end
+
+      def render(scope)
+        unless view_path
+          raise "Use Rack::Config to set 'api.tilt.root' in config.ru"
+        end
+
+        context = scope.instance_eval { binding }
+        eval "xlsx_package = ::Axlsx::Package.new; #{template_content}; xlsx_package.to_stream.string;", context
+      end
+
+      private
+
+      def file
+        File.join view_path, template_with_extension
+      end
+
+      def template_with_extension
+        template[/\.axlsx$/] ? template : "#{template}.axlsx"
+      end
+
+      def template_content
+        File.read(file)
+      end
+    end
+  end
+end

data/lib/grape/axlsx/version.rb

@@ -0,0 +1,5 @@
+module Grape
+  module Axlsx
+    VERSION = "0.1.0"
+  end
+end

data/lib/grape/formatter/axlsx.rb

@@ -0,0 +1,26 @@
+module Grape
+  module Formatter
+    class Axlsx
+      attr_reader :env, :endpoint, :object
+
+      def self.call(object, env)
+        new(object, env).call
+      end
+
+      def initialize(object, env)
+        @object, @env = object, env
+        @endpoint     = env['api.endpoint']
+      end
+
+      def call
+        Grape::Axlsx::Renderer.new(env['api.tilt.root'], template).render(endpoint)
+      end
+
+      private
+
+      def template
+        endpoint.options.fetch(:route_options, {})[:axlsx]
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: grape-axlsx
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ivan Kabluchkov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: grape
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: axlsx
+  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.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple implementation for using Axlsx templates in Grape.
+email:
+- ikabluchkov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- grape-axlsx.gemspec
+- lib/grape/axlsx.rb
+- lib/grape/axlsx/renderer.rb
+- lib/grape/axlsx/version.rb
+- lib/grape/formatter/axlsx.rb
+homepage: https://github.com/lfidnl/grape-axlsx
+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.5.0
+signing_key: 
+specification_version: 4
+summary: Use Axlsx in Grape
+test_files: []