rtf_rails 0.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+gem 'rails', '>=3.0.0'
+gem 'rtf', '~> 0.3.3'
+
+group :development do
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.1.rc"
+  gem "jeweler", "~> 1.8.3"
+end

data/Gemfile.lock

@@ -0,0 +1,96 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.2.1)
+      actionpack (= 3.2.1)
+      mail (~> 2.4.0)
+    actionpack (3.2.1)
+      activemodel (= 3.2.1)
+      activesupport (= 3.2.1)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.1)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.1)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.2)
+    activemodel (3.2.1)
+      activesupport (= 3.2.1)
+      builder (~> 3.0.0)
+    activerecord (3.2.1)
+      activemodel (= 3.2.1)
+      activesupport (= 3.2.1)
+      arel (~> 3.0.0)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.1)
+      activemodel (= 3.2.1)
+      activesupport (= 3.2.1)
+    activesupport (3.2.1)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.0)
+    erubis (2.7.0)
+    git (1.2.5)
+    hike (1.2.1)
+    i18n (0.6.0)
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    journey (1.0.3)
+    json (1.6.5)
+    mail (2.4.1)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.17.2)
+    multi_json (1.1.0)
+    polyglot (0.3.3)
+    rack (1.4.1)
+    rack-cache (1.1)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rails (3.2.1)
+      actionmailer (= 3.2.1)
+      actionpack (= 3.2.1)
+      activerecord (= 3.2.1)
+      activeresource (= 3.2.1)
+      activesupport (= 3.2.1)
+      bundler (~> 1.0)
+      railties (= 3.2.1)
+    railties (3.2.1)
+      actionpack (= 3.2.1)
+      activesupport (= 3.2.1)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.6)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rtf (0.3.3)
+    sprockets (2.1.2)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    thor (0.14.6)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.31)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.1.rc)
+  jeweler (~> 1.8.3)
+  rails (>= 3.0.0)
+  rdoc (~> 3.12)
+  rtf (~> 0.3.3)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Alejandro Juarez Robles
+
+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/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Walton Hoops
+
+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.rdoc

@@ -0,0 +1,99 @@
+= Rtf::Rails
+
+Rtf::Rails provides a simple way of creating RTF views in Rails 3 using the rtf library.
+
+To use Rtf::Rails simply add the line
+
+    gem 'rtf_rails'
+
+to your Gemfile and then run
+
+    bundle install
+
+That's it!  You can now create views named
+
+    [action].rtf.rtf_rb
+
+which will be used whenever the user requests a page with a 'rtf' extension
+
+== Usage
+
+=== Basic Usage
+
+Rtf::Rails is designed to provide only a very thin wrapper around Rtf itself.  A Rtf::Rails view should consist of only a call to the function rtf_document and a block.  This will create an instance of Rtf::Document and yield it to the block.
+For a simple rtf view try:
+
+views/.../simple.rtf.rtf_rb
+
+  rtf_document() do |rtf|
+    rtf << "Hello World"
+  end
+
+This will create a simple PDF with only the text Hello World.
+
+=== Partials
+
+While layouts do not yet work with Rtf::Rails, partials work fine.  Rendering a partial is much like in a normal view.  For example:
+
+views/.../partial.rtf.rtf_rb
+
+  rtf_document do |rtf|
+    render "frontpage", :rtf => rtf
+    rtf << "something else"
+  end
+
+views/.../_frontpage.rtf.rtf_rb
+
+  rtf << "frontpage action!!"
+
+
+As you might expect this will result in a rtf with a leading page.
+
+=== Instance Variables
+
+Like normal Rails views, instance variables assigned in the controller are made available in the view.  For example:
+
+home_controller.rb
+
+  class HomeController < ApplicationController
+    def index
+      @people=['Jane','John','Jack']
+    end
+  end
+
+views/.../index.rtf.rtf_rb
+
+  rtf_document(:page_layout => :landscape) do |rtf|
+    @people.each {|person| rtf << person}
+  end
+
+This will produce a rtf with Jane, John, and Jack all written on seperate lines.
+
+
+=== Force Saving
+
+The :force_download option makes the browser display a 'save as' dialog rather than attempting to display the content in browser (this is achieved by setting the Content-Dispoition header).
+
+views/.../saveas.rtf.rtf_rb
+
+  rtf_document(:force_download=>true) do |rtf|
+    rtf << "Hello World"
+  end
+
+Finally is the :filename option.  This allows you to override the default filename to something other than the name of the action.
+Note: You should include the .rtf extension in the filename.  Rtf::Rails will not do this for you.
+
+views/.../filename.rtf.rtf_rb
+
+  rtf_document(:filename=>'Hello.rtf') do |rtf|
+    rtf << "Hello World"
+  end
+
+This will result in the user being promted to download a file named 'Hello.rtf'.
+
+== Gotchas
+
+The one major gotcha at this point is that layouts do not work.  Do not attempt to make an app/views/layouts/application.rtf.rtf_rb.  All your rtf views will quit.  This is something I hope to fix in a later release.  In the meantime I recommend using custom classes like the one above to achieve a similair effect.
+
+
+Copyright (c) 2012 MonsterLabs, released under the MIT license

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "rtf_rails"
+  gem.homepage = "http://github.com/monsterlabs/rtf_rails"
+  gem.has_rdoc = false
+  gem.extra_rdoc_files = ["README.rdoc"]
+  gem.license = "MIT"
+  gem.summary = %Q{Integrates RTF gem into Rails in a natural way}
+  gem.description = %Q{Rtf::Rails provides a simple way of creating RTF views in Rails 3 using the rtf library.}
+  gem.email = "alex@monsterlabs.com.mx"
+  gem.authors = ["Alejandro Juarez Robles"]
+  gem.add_dependency('rails', '>=3.0.0')
+  gem.add_dependency('rtf', '~> 0.3.3')
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rtf_rails #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/init.rb

@@ -0,0 +1 @@
+require 'rtf_rails'

data/lib/rtf_rails.rb

@@ -0,0 +1,39 @@
+require 'rtf'
+module Rtf
+  module Rails
+
+    module RtfHelper
+      def rtf_document(opts={})
+        download = opts.delete(:force_download)
+        filename = opts.delete(:filename)
+        rtf = RTF::Document.new(RTF::Font.new(RTF::Font::ROMAN, 'Times New Roman'))
+        yield rtf if block_given?
+
+        disposition(download, filename) if (download || filename)
+
+        rtf.to_rtf
+      end
+
+      def disposition(download, filename)
+        download = true if (filename && download == nil)
+        disposition = download ? "attachment;" : "inline;"
+        disposition += " filename=\"#{filename}\"" if filename
+        headers["Content-Disposition"] = disposition
+      end
+    end
+
+    class TemplateHandler
+      class_attribute :default_format
+      self.default_format = :rtf
+
+      def self.call(template)
+        "#{template.source.strip}"
+      end
+    end
+    
+  end
+end
+
+Mime::Type.register_alias("application/rtf", :rtf) unless Mime::Type.lookup_by_extension(:rtf)
+ActionView::Template.register_template_handler(:rtf_rb, Rtf::Rails::TemplateHandler)
+ActionView::Base.send(:include, Rtf::Rails::RtfHelper)

data/rails/init.rb

@@ -0,0 +1 @@
+require 'rtf_rails'

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rtf_rails'
+
+class Test::Unit::TestCase
+end

data/test/test_rtf_rails.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestRtfRails < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: rtf_rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Alejandro Juarez Robles
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-02 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70231713158360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70231713158360
+- !ruby/object:Gem::Dependency
+  name: rtf
+  requirement: &70231713157880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *70231713157880
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &70231713157400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: *70231713157400
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70231713156920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.rc
+  type: :development
+  prerelease: false
+  version_requirements: *70231713156920
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &70231713156440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: *70231713156440
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70231713155960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70231713155960
+- !ruby/object:Gem::Dependency
+  name: rtf
+  requirement: &70231713155480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *70231713155480
+description: Rtf::Rails provides a simple way of creating RTF views in Rails 3 using
+  the rtf library.
+email: alex@monsterlabs.com.mx
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- init.rb
+- lib/rtf_rails.rb
+- rails/init.rb
+- test/helper.rb
+- test/test_rtf_rails.rb
+homepage: http://github.com/monsterlabs/rtf_rails
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4310985505342677727
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Integrates RTF gem into Rails in a natural way
+test_files: []