caracal-rails 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2eb4b9d05daec06006dadbf3957e46737654baee0f4c0a5df8acae982c1ada61
-  data.tar.gz: 719cbefd24e98d26d09260fcd67ee61edf1f598f20964e303bf89cf3359a0a88
+  metadata.gz: a1f20228fa4a74595fc007ff0d9ec6d84d271135dfdaac535c7ad7c1fc5039f8
+  data.tar.gz: 0206e6242135c9c4ace8c20c272bd4ff5f40dcc9b78dbcc407e7758cbc552a61
 SHA512:
-  metadata.gz: 7672ad6d880149a24fe49690d0d0ea6229f5313d3605d7a6bb137ef00cefd810a068864e641a0910a526598823f9998d00031f05931fc8d7399f8816ad1a93e4
-  data.tar.gz: f34463c65d18523be6652fc6f6bf17e1bd026e64b7e5fb8532fddcafa850dba472eb864d408b7771bf8f7c017e4c250e8388503c6590e1c38d9aa1ceec56acbc
+  metadata.gz: d35b7b86b5550e65a84a44d0a4ad1832b633547bc0590c8d8f63d4826ccf8568ad922d4fd10e9f8a33e933ac925ccf6890797c0f27a4292d2f29ebc46e0a998e
+  data.tar.gz: 690165c748ab92ec13ef194dcb881ccb0dcea2839f14cc6c28d3b1af6dac749869f12fc97be5efdb21ec535bd36c63776f57ca260bcba27fd6f77d1f15e338c0

data/.github/workflows/ci.yml

@@ -0,0 +1,33 @@
+name: CI
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    name: Ruby ${{ matrix.ruby }} / Rails ${{ matrix.rails }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        # Rails 7.2 requires Ruby >= 3.1; Rails 8.x requires Ruby >= 3.2,
+        # so these are paired explicitly rather than crossed.
+        include:
+          - { ruby: '3.1', rails: '~> 7.1.0' }
+          - { ruby: '3.2', rails: '~> 7.2.0' }
+          - { ruby: '3.3', rails: '~> 8.0.0' }
+          - { ruby: '3.4', rails: '~> 8.1.0' }
+    env:
+      RAILS_VERSION: ${{ matrix.rails }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rspec

data/CHANGELOG.md

@@ -0,0 +1,23 @@
+#### v1.0.3
+
+* Security
+  * The template handler no longer interpolates the template path into generated Ruby source. A path containing a single quote closed the string literal, so the remainder was compiled as code by Rails; an ordinary apostrophe in a directory name raised a `SyntaxError` instead. The path is now escaped with `String#inspect`. (@dlauer)
+
+* Bug Fixes
+  * Corrected five outdated examples in the README, each confirmed against caracal 1.5.0: `font` and `style` take a hash or block rather than a string, `cell_style` uses `:background` rather than `:background_color`, `br` is not a document level command, and `strong` is not a command at all. (reported by @Alan-M-Thomaz)
+
+* Enhancements
+  * Added continuous integration across Ruby 3.1 to 3.4 and Rails 7.1 to 8.1. (@dlauer)
+  * Relaxed the bundler development dependency, which made `bundle install` impossible on current bundler, and raised rspec-rails so the suite runs on modern Rails. (@dlauer)
+  * Replaced Appraisal, whose configuration referenced a local checkout and covered only Rails 3.2 to 4.1, with a `RAILS_VERSION` environment variable read by the Gemfile. (@dlauer)
+  * Raised the rails floor to `>= 6.0`, matching the two argument template handler signature this gem ships. (@dlauer)
+  * Modernised the dummy application used by the suite: it now loads only the railties it needs rather than `rails/all`, which required ActiveRecord and sqlite3 for a gem that uses neither. (@dlauer)
+
+
+#### v1.0.2
+
+* Bug Fixes
+  * Added the second parameter to the template handler, which Rails 6 requires. (@emp823)
+
+
+*Releases before v1.0.2 predate this changelog; see the git history for details.*

data/Gemfile

@@ -1,3 +1,6 @@
 source 'https://rubygems.org'
 
 gemspec
+
+# lets CI test against specific Rails versions
+gem 'rails', ENV['RAILS_VERSION'] if ENV['RAILS_VERSION']

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Trade Informatics, Inc
+Copyright (c) 2014 Urvin LLC
 
 MIT License
 

data/README.md

@@ -1,10 +1,10 @@
 # Caracal-Rails
 
-[Caracal](https://github.com/trade-informatics/caracal) is a ruby library for dynamically creating professional-quality Microsoft Word documents.
+[Caracal](https://github.com/urvin-compliance/caracal) is a ruby library for dynamically creating professional-quality Microsoft Word documents.
 
 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 a reference to the Caracal::Document object named `docx`.
 
-Please see the [caracal-example](https://github.com/trade-informatics/caracal-example) repository for
+Please see the [caracal-example](https://github.com/urvin-compliance/caracal-example) repository for
 a working demonstration of the library's capabilities.
 
 ## Installation
@@ -42,9 +42,11 @@ Specify the format `docx` in your route:
 
 Inside your view, simply issue Caracal commands on the document object:
 
-    docx.font 'Droid Serif'
+    docx.font name: 'Droid Serif'
 
-    docx.style 'special' do
+    docx.style do
+      id     'special'
+      name   'Special'
       font   'Droid Serif'
       italic true
       size   16
@@ -61,28 +63,27 @@ Inside your view, simply issue Caracal commands on the document object:
         text ' in the middle.'
       end
       docx.img image_url('https://www.example.com/logo.png'), width: 300, height: 200, align: 'right'
-      docx.br
       docx.table client.tablular_data, border_size: 4 do
-        cell_style  rows[0], background_color: '3366cc', color: 'ffffff', bold: true
+        cell_style  rows[0], background: '3366cc', color: 'ffffff', bold: true
       end
       docx.page
       docx.p 'This is an bulleted list.'
       docx.ul do
         li do
-          strong 'Item 1'
-          text   'More text'
+          text 'Item 1', bold: true
+          text ' More text'
         end
         li 'Item 2'
       end
     end
 
 
-*See the [Caracal](https://github.com/trade-informatics/caracal) library for more details.*  
+*See the [Caracal](https://github.com/urvin-compliance/caracal) library for more details.*  
 
 
 ## Contributing
 
-1. Fork it ( https://github.com/trade-informatics/caracal-rails/fork )
+1. Fork it ( https://github.com/urvin-compliance/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`)
@@ -101,6 +102,6 @@ A tip of the hat to the wonderful PDF generation libraries [Prawn](https://githu
 
 ## License
 
-Copyright (c) 2014 Trade Informatics, Inc
+Copyright (c) 2014 Urvin LLC
 
-[MIT License](https://github.com/trade-informatics/caracal-rails/blob/master/LICENSE.txt)
+[MIT License](https://github.com/urvin-compliance/caracal-rails/blob/master/LICENSE.txt)

data/caracal-rails.gemspec

@@ -6,22 +6,26 @@ 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.authors       = ['Urvin LLC', 'Dave Lauer']
+  spec.email         = ['dave@plia.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.homepage      = 'https://github.com/urvin-compliance/caracal-rails'
   spec.license       = 'MIT'
 
+  spec.metadata      = {
+    'source_code_uri' => 'https://github.com/urvin-compliance/caracal-rails',
+    'bug_tracker_uri' => 'https://github.com/urvin-compliance/caracal-rails/issues'
+  }
+
   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',  '~> 1.0'
-  spec.add_dependency 'rails',    '>= 3.2'
+  spec.add_dependency 'rails',    '>= 6.0'
 
-  spec.add_development_dependency 'appraisal',        '~> 1.0'
-  spec.add_development_dependency 'bundler',          '~> 1.6'
-  spec.add_development_dependency 'rspec-rails',      '~> 3.0'
+  spec.add_development_dependency 'bundler',          '>= 1.6'
+  spec.add_development_dependency 'rspec-rails',      '>= 6.0'
 end

data/lib/caracal/rails/template_handler.rb

@@ -3,7 +3,7 @@ module Caracal
     class TemplateHandler
       
       def self.call(template, source = nil)
-        "Tilt.new('#{ template.identifier }').render(self)"
+        "Tilt.new(#{ template.identifier.inspect }).render(self)"
       end
       
     end

data/lib/caracal/rails/version.rb

@@ -1,5 +1,5 @@
 module Caracal
   module Rails
-    VERSION = '1.0.2'
+    VERSION = '1.0.3'
   end
 end

data/spec/dummy/config/application.rb

@@ -1,6 +1,8 @@
 require File.expand_path('../boot', __FILE__)
 
-require 'rails/all'
+require 'rails'
+require 'action_controller/railtie'
+require 'action_view/railtie'
 
 # Require the gems listed in Gemfile, including any gems
 # you've limited to :test, :development, or :production.

data/spec/dummy/config/environments/test.rb

@@ -5,7 +5,7 @@ Dummy::Application.configure do
   # test suite. You never need to work with it otherwise. Remember that
   # your test database is "scratch space" for the test suite and is wiped
   # and recreated between test runs. Don't rely on the data there!
-  config.cache_classes = true
+  config.enable_reloading = false
 
   # Do not eager load code on boot. This avoids loading your whole application
   # just for the purpose of running a single test. If you are using a tool that
@@ -13,15 +13,15 @@ Dummy::Application.configure do
   config.eager_load = false
 
   # Configure static asset server for tests with Cache-Control for performance.
-  config.serve_static_assets  = true
-  config.static_cache_control = 'public, max-age=3600'
+  config.public_file_server.enabled = true
+  config.public_file_server.headers = { 'Cache-Control' => 'public, max-age=3600' }
 
   # Show full error reports and disable caching.
   config.consider_all_requests_local       = true
   config.action_controller.perform_caching = false
 
   # Raise exceptions instead of rendering exception templates.
-  config.action_dispatch.show_exceptions = false
+  config.action_dispatch.show_exceptions = :none
 
   # Disable request forgery protection in test environment.
   config.action_controller.allow_forgery_protection = false
@@ -29,7 +29,6 @@ Dummy::Application.configure do
   # Tell Action Mailer not to deliver emails to the real world.
   # The :test delivery method accumulates sent emails in the
   # ActionMailer::Base.deliveries array.
-  config.action_mailer.delivery_method = :test
 
   # Print deprecation notices to the stderr.
   config.active_support.deprecation = :stderr

data/spec/lib/caracal/rails/template_handler_spec.rb

@@ -12,8 +12,28 @@ describe Caracal::Rails::TemplateHandler do
     describe '#call' do
       let(:template) { double('template', identifier: 'show.docx.caracal') }
       let(:actual)   { Caracal::Rails::TemplateHandler.call(template) }
-      
-      it { expect(actual).to eq "Tilt.new('show.docx.caracal').render(self)" }
+
+      it { expect(actual).to eq %q{Tilt.new("show.docx.caracal").render(self)} }
+
+      describe 'when the path contains a quote' do
+        let(:template) { double('template', identifier: %q{/views/o'brien/show.docx.caracal}) }
+
+        it 'escapes it rather than breaking out of the string' do
+          expect(actual).to eq %q{Tilt.new("/views/o'brien/show.docx.caracal").render(self)}
+        end
+
+        it 'produces source that still parses as ruby' do
+          expect { RubyVM::InstructionSequence.compile(actual) }.not_to raise_error
+        end
+      end
+
+      describe 'when the path is hostile' do
+        let(:template) { double('template', identifier: %q{/tmp/x'); system('id'); ('}) }
+
+        it 'keeps the whole path inside the string literal' do
+          expect(actual).to eq %q{Tilt.new("/tmp/x'); system('id'); ('").render(self)}
+        end
+      end
     end
     
   end

data/spec/lib/caracal-rails_spec.rb

@@ -49,8 +49,12 @@ describe Caracal::Rails::Railtie do
      
      # .handler_for_extension
      describe '#handler_for_extension' do
+       # The railtie registers the handler inside ActiveSupport.on_load(:action_view),
+       # which fires when ActionView::Base is first loaded rather than during boot.
+       before { ActionView::Base.empty }
+
        let(:actual) { ActionView::Template.handler_for_extension(:caracal) }
-       
+
        it { expect(actual).to eq Caracal::Rails::TemplateHandler }
      end
      

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: caracal-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
-- Trade Informatics
-- John Dugan
-autorequire: 
+- Urvin LLC
+- Dave Lauer
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-15 00:00:00.000000000 Z
+date: 2026-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: caracal
@@ -31,76 +31,60 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
-- !ruby/object:Gem::Dependency
-  name: appraisal
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '6.0'
 description: " 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. "
 email:
-- jpdugan@gmail.com
+- dave@plia.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
-- Appraisals
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - caracal-rails.gemspec
-- gemfiles/rails_3.2.gemfile
-- gemfiles/rails_4.0.gemfile
-- gemfiles/rails_4.1.gemfile
 - lib/caracal-rails.rb
 - lib/caracal/rails/template_handler.rb
 - lib/caracal/rails/version.rb
@@ -148,11 +132,13 @@ files:
 - spec/lib/caracal/rails/template_handler_spec.rb
 - spec/lib/caracal/rails/version.rb
 - spec/spec_helper.rb
-homepage: https://github.com/ibpinc/caracal-rails
+homepage: https://github.com/urvin-compliance/caracal-rails
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  source_code_uri: https://github.com/urvin-compliance/caracal-rails
+  bug_tracker_uri: https://github.com/urvin-compliance/caracal-rails/issues
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -167,8 +153,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 summary: Caracal::Rails makes using Caracal in Rails a no-brainer.
 test_files:

data/Appraisals

@@ -1,17 +0,0 @@
-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/gemfiles/rails_3.2.gemfile

@@ -1,8 +0,0 @@
-# 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

@@ -1,8 +0,0 @@
-# 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

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