caracal-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: adb1feddfbe63116a2ee52a308f0bc0db2ee8942
+  data.tar.gz: 39165bf8dd33040c07d6e0ca600026d5ccf64e98
+SHA512:
+  metadata.gz: 85c6d51dc91ee6573adc4e04efd8851bc9aa4b9ac9c06b9d85de6f57a4b7a8fd28a5c0089d0c623acd28c67956ec9bbeb817f23eb02e666a2536a34f90d1ac59
+  data.tar.gz: 9307effc71b92b3bad2e0dd7a08404280f979d6c692f9271f83aa28b8bd47c95eeeec27979e11fe152a3108f9f11d0df99157c49ed6cd3fdf805659dbc70d079

data/.gitignore

@@ -0,0 +1,26 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+gemfiles/*.gemfile.lock
+spec/dummy/db
+spec/dummy/log
+spec/dummy/tmp

data/Appraisals

@@ -0,0 +1,17 @@
+appraise 'rails-3.2' do
+  gem 'rails',        '~> 3.2.18'
+  gem 'sqlite3'
+  gem 'caracal',      path: '~/workspace/plia/caracal', ref: 'e2b84b191efe6b7871259201413c13918091c6b4'
+end
+
+appraise 'rails-4.0' do
+  gem 'rails',        '~> 4.0.5'
+  gem 'sqlite3'
+  gem 'caracal',      path: '~/workspace/plia/caracal', ref: 'e2b84b191efe6b7871259201413c13918091c6b4'
+end
+
+appraise 'rails-4.1' do
+  gem 'rails',        '~> 4.1.1'
+  gem 'sqlite3'
+  gem 'caracal',      path: '~/workspace/plia/caracal', ref: 'e2b84b191efe6b7871259201413c13918091c6b4'
+end

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Trade Informatics, Inc
+
+MIT License
+
+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,99 @@
+# Caracal-Rails
+
+[Caracal](https://github.com/ibpinc/caracal) is a ruby library for dynamically creating professional-quality Microsoft Word documents (.docx). 
+
+Caracal-Rails is a drop in solution for registering the Microsoft Word mime type and for establishing a template handler in Rails for the :docx format.  All caracal documents are rendered with an explicit block passing an argument named `docx`.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'caracal-rails'
+
+Then execute:
+
+    $ bundle install
+
+
+## Usage
+
+Design your controller normally:
+
+    class ReportsController < ApplicationController
+      def show
+        # collect your models/view models here
+      end
+    end
+    
+Then add a view file with the Caracal extension:
+
+    apps/views/reports/show.docx.caracal
+    
+Inside your view, simply issue Caracal commands on the document object:
+    
+    docx.file_name 'quarterly_report'
+    
+    docx.font 'Arial'
+    docx.font 'Droid Serif'
+    
+    docx.style 'special' do
+      font   'Droid Serif'
+      italic true
+      size   16
+    end
+    
+    docx.content do
+      h1 'Quarterly Report'
+      hr
+      h2 'Client A'
+      p  'Lorem ipsum dolor...'
+      p do
+        text 'Normal text'
+        link 'Link text', 'http://www.google.com/', class: 'special
+        text 'More normal text'
+      end
+      img image_url('example.png'), width: 300, height: 200, align: 'right'
+      br
+      table data, border: 1 do
+        cell_style  rows(0), background_color: '3366cc', color: 'ffffff', bold: true
+      end
+      page
+      p 'This is an bulleted list'
+      ul do
+        li do
+          strong 'Item 1'
+          text   'More text'
+        end
+        li 'Item 2'
+      end
+      ...
+    end
+
+*See the [Caracal](https://github.com/ibpinc/caracal) library for more details.*  
+
+
+## Contributing
+
+1. Fork it ( https://github.com/ibpinc/caracal-rails/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
+
+
+## Why is It Called Caracal?
+
+Because my son likes caracals. :)
+
+
+## Inspiration
+
+A tip of the hat to the wonderful PDF generation libraries [Prawn](https://github.com/prawnpdf/prawn) and [Prawnto](https://github.com/GetJobber/prawnto).
+
+
+## License
+
+Copyright (c) 2014 Trade Informatics, Inc
+
+[MIT License](https://github.com/ibpinc/caracal-rails/blob/master/LICENSE.txt)

data/Rakefile

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

data/caracal-rails.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'caracal/rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'caracal-rails'
+  spec.version       = Caracal::Rails::VERSION
+  spec.authors       = ['Trade Informatics', 'John Dugan']
+  spec.email         = ['jpdugan@gmail.com']
+  spec.summary       = %q{ Caracal::Rails makes using Caracal in Rails a no-brainer. }
+  spec.description   = %q{ Caracal::Rails takes care of registering Microsoft Word output with Rails. Essentially, this involves registering the mime type, establishing a template handler for .docx formats, and establishing sane defaults for generating professional quality Word documents. }
+  spec.homepage      = 'https://github.com/ibpinc/caracal-rails'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+  
+  spec.add_dependency 'caracal',  '~> 0.1'
+  spec.add_dependency 'rails',    '>= 3.2'
+  
+  spec.add_development_dependency 'appraisal',        '~> 1.0'
+  spec.add_development_dependency 'bundler',          '~> 1.6'
+  spec.add_development_dependency 'rspec-rails',      '~> 3.0'
+end

data/gemfiles/rails_3.2.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 3.2.18"
+gem "sqlite3"
+
+gemspec :path => "../"

data/gemfiles/rails_4.0.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 4.0.5"
+gem "sqlite3"
+
+gemspec :path => "../"

data/gemfiles/rails_4.1.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 4.1.1"
+gem "sqlite3"
+
+gemspec :path => "../"

data/lib/caracal-rails.rb

@@ -0,0 +1,29 @@
+require 'caracal'
+require 'caracal/rails/template_handler'
+require 'caracal/rails/version'
+require 'tilt'
+require 'tilt/caracal'
+
+
+module Caracal
+  module Rails
+    class Railtie < ::Rails::Railtie
+      
+      #----------------------------------------------------
+      # Register mime types and template handlers.
+      #
+      initializer 'caracal.registrations' do
+        Tilt.register 'caracal', Tilt::CaracalTemplate
+
+        unless Mime::Type.lookup_by_extension(:docx)
+          Mime::Type.register('application/vnd.openxmlformats-officedocument.wordprocessingml.document', :docx)
+        end
+
+        ActiveSupport.on_load(:action_view) do
+          ActionView::Template.register_template_handler :caracal, Caracal::Rails::TemplateHandler
+        end
+      end
+      
+    end
+  end
+end

data/lib/caracal/rails/template_handler.rb

@@ -0,0 +1,11 @@
+module Caracal
+  module Rails
+    class TemplateHandler
+      
+      def self.call(template)
+        "Tilt.new('#{ template.identifier }').render(self)"
+      end
+      
+    end
+  end
+end

data/lib/caracal/rails/version.rb

@@ -0,0 +1,5 @@
+module Caracal
+  module Rails
+    VERSION = '0.1.0'
+  end
+end

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,16 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery
+//= require jquery_ujs
+//= require turbolinks
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/controllers/statics_controller.rb

@@ -0,0 +1,3 @@
+class StaticsController < ApplicationController
+  def index; end
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/app/views/statics/show.docx.caracal

@@ -0,0 +1 @@
+docx.file_name 'test.docx'

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+begin
+  load File.expand_path("../spring", __FILE__)
+rescue LoadError
+end
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+begin
+  load File.expand_path("../spring", __FILE__)
+rescue LoadError
+end
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/bin/spring

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+# This file loads spring without using Bundler, in order to be fast
+# It gets overwritten when you run the `spring binstub` command
+
+unless defined?(Spring)
+  require "rubygems"
+  require "bundler"
+
+  if match = Bundler.default_lockfile.read.match(/^GEM$.*?^    spring \((.*?)\)$.*?^$/m)
+    ENV["GEM_PATH"] = ([Bundler.bundle_path.to_s] + Gem.path).join(File::PATH_SEPARATOR)
+    ENV["GEM_HOME"] = ""
+    Gem.paths = ENV
+
+    gem "spring", match[1]
+    require "spring/binstub"
+  end
+end

data/spec/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Rails.application

data/spec/dummy/config/application.rb

@@ -0,0 +1,23 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(*Rails.groups)
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end