inversion 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5303515e3e875a3c5ed98c9e0a8ac874892997214298548ca4640849344465c
-  data.tar.gz: d2fb3f646b2e09934705a89b680c411d1fb9b0ad38dd0bf863ec25534f6ae85d
+  metadata.gz: 772c7fe7c3b9c566e4962e424da512a6bb2f52d9aa401d20317af3a744310793
+  data.tar.gz: 4a7d20b35a0e5b15730fa59998ebca00f448eccc5f5f7af23718c1bf356038f6
 SHA512:
-  metadata.gz: 0ea0c5321afd08e14d5bb8a1e86a53f7905d1092098f2f06ef1d51e590000154c81fc576e4d4ff6fd4faf677c5ae44babc9e634e1236ed10dbb10d628ad36b40
-  data.tar.gz: 3a30aac016541f7e625283ccc4544306c8c375097932e8dede95479a61bffebfe1ac9e5352879e65055ed9fc97130519da0868a4c24a920115f531ef81178a47
+  metadata.gz: 2d1d273ca7ca57b36cdc411d5bba92d1b1189c26e087090cff257ff4d0f78cb25e32902f6007ea148eb49e9e9570a45802ad4187ea87688f8007621886b44090
+  data.tar.gz: 7d6f6e8a5868fe4f8a0f7f4835dcbfcdd66a8e06b3c2cffae7255e3b07bc70fd614c9213e0dcaaa0db40c6d7f252f89d6c8c80a8ac6ab6984e571f9458728f34

data/History.md

@@ -2,6 +2,13 @@
 
 ---
 
+## v1.5.0 [2023-04-20] Mahlon E. Smith <mahlon@martini.nu>
+
+Improvements:
+
+- Add Roda framework (https://roda.jeremyevans.net/) plugin support.
+
+
 ## v1.4.0 [2022-12-21] Michael Granger <ged@faeriemud.org>
 
 Improvements:

data/README.md

@@ -10,7 +10,7 @@ github
 : https://github.com/ged/inversion
 
 docs
-: http://deveiate.org/code/Inversion
+: http://deveiate.org/code/inversion
 
 
 ## Description

data/lib/inversion.rb

@@ -25,7 +25,7 @@ module Inversion
 	warn ">>> Inversion requires Ruby 2.4.0 or later. <<<" if RUBY_VERSION < '2.4.0'
 
 	# Library version constant
-	VERSION = '1.4.0'
+	VERSION = '1.5.0'
 
 	# Version-control revision constant
 	REVISION = %q$Revision$

data/lib/roda/plugins/inversion.rb

@@ -0,0 +1,225 @@
+# -*- ruby -*-
+# vim: set nosta noet ts=4 sw=4 ft=ruby:
+
+require 'inversion'
+require 'loggability'
+
+class Roda
+	module RodaPlugins
+
+		# A templated content-generation plugin for Roda Apps. It uses the
+		# Inversion[http://deveiate.org/projects/Inversion] templating system.
+		#
+		# It adds:
+		#
+		# * a preloaded/cached template table
+		# * a mechanism for fetching templates from the table
+		# * a global layout template which is automatically wrapped around responses
+		#
+		# Note: This is based almost entirely off the Strelka plugin of identical
+		# function.
+		#
+		# == Usage
+		#
+		# To use it, just load the <tt>:inversion</tt> plugin in your app:
+		#
+		#   plugin :inversion, '/path/to/templates/directory'
+		#
+		# You can specify more than one templates directory; they'll be searched in the order
+		# you specify for the named template and the first match wins:
+		#
+		#   plugin :inversion '/more/specific/templates', '/generic/app/templates'
+		#
+		# Then declare one or more templates that your application will use:
+		#
+		#   templates console:   'views/console.tmpl',
+		#             proctable: 'partials/proctable.tmpl'
+		#
+		# Then, inside your app, you can fetch a copy of one or more of the templates and
+		# return it as the response:
+		#
+		#   r.root do
+		#       tmpl = template( :console )
+		#       tmpl.message = "Everything's up."
+		#       tmpl.proctable = proctable
+		#       return tmpl
+		#   end
+		#
+		#
+		# You can also just return the template if you don't need to do anything else to the
+		# response.
+		#
+		# When returning a template, either in the body of the response or directly, it will
+		# automatically set a few attributes for commonly-used objects:
+		#
+		# request ::          The current Roda::Request
+		# response ::         The current Roda::Response
+		# app ::              The application object (Roda::App instance).
+		#
+		# If your app will *only* be loading and returning a template without doing anything
+		# with it, you can return just its name:
+		#
+		#   r.root do
+		#       return :console
+		#   end
+		#
+		# It will be loaded, set as the response body, and the above common objects added to it.
+		#
+		#
+		# === Layouts
+		#
+		# Very often, you'll want all or most of the views in your app to share a common page
+		# layout. To accomplish this, you can declare a layout template:
+		#
+		#   layout 'layout.tmpl'
+		#
+		# Any template that you return will be set as the 'body' attribute of this layout
+		# template (which you'd place into the layout with <tt><?attr body ?></tt>) and the
+		# layout rendered as the body of the response.
+		#
+		# Note that if you want any of the "common objects" from above with a layout template,
+		# they'll be set on it since it's the top-level template, but you can still access them
+		# using the <tt><?import ?></tt> directive:
+		#
+		#   <?import request, app ?>
+		#
+		#
+		# == Template Locations
+		#
+		# Inversion looks for templates in a load path much like Ruby does for libraries that
+		# you 'require'. It contains just the current working directory by default. You can add
+		# your own template directories via the config file (under +template_paths+ in
+		# the +templates+ section), or programmatically from your application.
+		#
+		module Inversion
+
+			### Add the specified +template_paths+ to Inversion.
+			def self::configure( app, *template_paths )
+				::Inversion::Template.template_paths.concat( template_paths )
+			end
+
+
+			module ClassMethods
+
+				### Add this Gem's template location to the Inversion search path.
+				def self::extended( subclass )
+					subclass.instance_variable_set( :@template_map, {} )
+					subclass.instance_variable_set( :@layout_template, nil )
+
+					super
+				end
+
+
+				# The map of template names to template file paths.
+				attr_reader :template_map
+
+				# An optional layout/wrap template.
+				attr_accessor :layout_template
+
+
+				### Load instances for all the template paths specified in the App's class
+				### and return them in a hash keyed by name (Symbol).
+				def templates( hash )
+					@template_map = hash.each_with_object( {} ) do |(name, path), map|
+						enc = Encoding.default_internal || Encoding::UTF_8
+						map[ name ] = ::Inversion::Template.load( path, encoding: enc )
+						map
+					end
+
+					return self.template_map
+				end
+
+
+				### Load an Inversion::Template for the layout template.
+				def layout( tmpl )
+					enc = Encoding.default_internal || Encoding::UTF_8
+					self.layout_template = ::Inversion::Template.load( tmpl, encoding: enc )
+					return self.layout_template
+				end
+			end
+
+
+			module InstanceMethods
+
+				### Return a previously declared template object.
+				def template( tmpl )
+					template = self.class.template_map[ tmpl ] or
+						raise ArgumentError, "no %p template registered!" % [ tmpl ]
+					template.reload if template.changed?
+					return template.dup
+				end
+			end
+
+
+			module RequestMethods
+
+				### Hook block results for template rendering.
+				def block_result_body( result )
+					if ( template = self.extract_template_from_result( result ) )
+
+						# Wrap the template in a layout if there is one
+						template = self.wrap_in_layout( template )
+
+						# Set some default stuff on the top-level template
+						self.set_common_attributes( template )
+
+						return template.render
+					else
+						super
+					end
+				end
+
+
+				#########
+				protected
+				#########
+
+				### Fetch the template from the +result+ (if there is one) and return it.
+				def extract_template_from_result( result )
+					templates = self.scope.class.template_map
+
+					# Result is a template name.
+					if result.is_a?( Symbol ) && templates.key?( result )
+						return scope.template( result )
+
+						# Result is a template object.
+					elsif result.respond_to?( :render )
+						return result
+					end
+
+					# Not templated; returned as-is
+					return nil
+				end
+
+
+				### Wrap the specified +content+ template in the layout template and
+				### return it. If there isn't a layout declared, just return +content+ as-is.
+				def wrap_in_layout( content )
+					layout = self.scope.class.layout_template or return content
+
+					layout.reload if layout.changed?
+					l_template = layout.dup
+					l_template.body = content
+
+					return l_template
+				end
+
+
+				### Set some default values from the request in the given top-level +template+.
+				def set_common_attributes( template )
+					template.request  = self
+					template.response = self.scope.response
+					template.app      = self.scope
+				end
+
+			end
+
+		end # module Inversion
+
+
+		# Hook: Inform Roda that we exist.
+		register_plugin :inversion, Inversion
+
+	end # module RodaPlugins
+end # class Roda
+

data/spec/inversion/refinements_spec.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/env rspec -cfd -b
+# vim: set noet nosta sw=4 ts=4 :
+
+
+require_relative '../helpers'
+
+require 'ripper'
+require 'inversion/refinements'
+
+
+RSpec.describe Inversion, "refinements" do
+
+	using Inversion::Refinements
+
+	it "exposes the Ripper::TokenPattern::MatchData's #tokens array" do
+		tagpattern = Ripper::TokenPattern.compile( '$(ident) $(sp) $(ident)' )
+		matchdata = tagpattern.match( "foo bar" )
+		expect( matchdata.tokens.map {|tok| tok[1]} ).to eq([ :on_ident, :on_sp, :on_ident ])
+	end
+
+end
+

data/spec/roda/plugins/inversion_spec.rb

@@ -0,0 +1,91 @@
+#!/usr/bin/env rspec -cfd -b
+# vim: set noet nosta sw=4 ts=4 :
+
+require_relative '../../helpers'
+
+begin
+	require 'roda'
+	$roda_support = true
+rescue LoadError => err
+	warn "Roda support testing disabled: %p: %s" % [ err.class, err.message ]
+	$roda_support = false
+end
+
+
+RSpec.describe "Roda support", :if => $roda_support do
+	include Rack::Test::Methods if defined?( ::Rack )
+
+	before( :all ) do
+		setup_logging( :fatal )
+	end
+
+	before( :each ) do
+		allow( Inversion::Template ).to receive( :load ).and_return( tmpl )
+		app.app # looks weird, but creates an instance for Rack::Test.
+	end
+
+	let( :tmpl ) { Inversion::Template.new("Hi <?attr name ?>!") }
+
+	let( :app ) do
+		Class.new( Roda ) do
+			plugin :inversion
+			templates \
+				tmpl: 'template.tmpl'
+
+			route do |r|
+				r.get "symbol" do
+					:tmpl
+				end
+
+				r.get "unknown" do
+					template( :nope )
+				end
+
+				r.get "template" do
+					tmpl = template( :tmpl )
+					tmpl.name = "handsome"
+					return tmpl
+				end
+			end
+		end
+	end
+
+
+	it "registers itself with Roda on demand" do
+		plugs = Roda::RodaPlugins.instance_variable_get( :@plugins )
+		expect( plugs[:inversion] ).to be( Roda::RodaPlugins::Inversion )
+	end
+
+
+	it "extends the Roda DSL with a #template helper method" do
+		expect( app.instance_methods ).to include( :template )
+	end
+
+
+	it "falls through to Roda default behavior on unmapped symbols" do
+		get '/nonexistent'
+		expect( last_response ).to_not be_ok
+	end
+
+
+	it "can reference a known template via symbol" do
+		get '/symbol'
+		expect( last_response ).to be_ok
+		expect( last_response.body ).to eq( 'Hi !' )
+	end
+
+
+	it "can render a returned template via template()" do
+		get '/template'
+		expect( last_response ).to be_ok
+		expect( last_response.body ).to eq( 'Hi handsome!' )
+	end
+
+
+	it "fails fast if referencing an unknown template at runtime" do
+		expect {
+			get '/unknown'
+		}.to raise_error( ArgumentError, /no :nope template registered/ )
+	end
+end
+

metadata

@@ -1,40 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: inversion
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Michael Granger
 - Mahlon E. Smith
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIID+DCCAmCgAwIBAgIBBDANBgkqhkiG9w0BAQsFADAiMSAwHgYDVQQDDBdnZWQv
-  REM9RmFlcmllTVVEL0RDPW9yZzAeFw0yMjAxMDcyMzU4MTRaFw0yMzAxMDcyMzU4
-  MTRaMCIxIDAeBgNVBAMMF2dlZC9EQz1GYWVyaWVNVUQvREM9b3JnMIIBojANBgkq
-  hkiG9w0BAQEFAAOCAY8AMIIBigKCAYEAvyVhkRzvlEs0fe7145BYLfN6njX9ih5H
-  L60U0p0euIurpv84op9CNKF9tx+1WKwyQvQP7qFGuZxkSUuWcP/sFhDXL1lWUuIl
-  M4uHbGCRmOshDrF4dgnBeOvkHr1fIhPlJm5FO+Vew8tSQmlDsosxLUx+VB7DrVFO
-  5PU2AEbf04GGSrmqADGWXeaslaoRdb1fu/0M5qfPTRn5V39sWD9umuDAF9qqil/x
-  Sl6phTvgBrG8GExHbNZpLARd3xrBYLEFsX7RvBn2UPfgsrtvpdXjsHGfpT3IPN+B
-  vQ66lts4alKC69TE5cuKasWBm+16A4aEe3XdZBRNmtOu/g81gvwA7fkJHKllJuaI
-  dXzdHqq+zbGZVSQ7pRYHYomD0IiDe1DbIouFnPWmagaBnGHwXkDT2bKKP+s2v21m
-  ozilJg4aar2okb/RA6VS87o+d7g6LpDDMMQjH4G9OPnJENLdhu8KnPw/ivSVvQw7
-  N2I4L/ZOIe2DIVuYH7aLHfjZDQv/mNgpAgMBAAGjOTA3MAkGA1UdEwQCMAAwCwYD
-  VR0PBAQDAgSwMB0GA1UdDgQWBBRyjf55EbrHagiRLqt5YAd3yb8k4DANBgkqhkiG
-  9w0BAQsFAAOCAYEASrm1AbEoxACZ9WXJH3R5axV3U0CA4xaETlL2YT+2nOfVBMQ9
-  0ZlkPx6j4ghKJgAIi1TMfDM2JyPJsppQh8tiNccDjWc62UZRY/dq26cMqf/lcI+a
-  6YBuEYvzZfearwVs8tHnXtwYV3WSCoCOQaB+nq2lA1O+nkKNl41WOsVbNama5jx3
-  8cQtVSEEmZy6jIDJ8c5TmBJ7BQUDEUEWA/A3V42Xyctoj7DvUXWE0lP+X6ypAVSr
-  lFh3TS64D7NTvxkmg7natUoCvobl6kGl4yMaqE4YRTlfuzhpf91TSOntClqrAOsS
-  K1s56WndQj3IoBocdY9mQhDZLtLHofSkymoP8btBlj5SsN24TiF0VMSZlctSCYZg
-  GKyHim/MMlIfGOWsgfioq5jzwmql7W4CDubbb8Lkg70v+hN2E/MnNVAcNE3gyaGc
-  P5YP5BAbNW+gvd3QHRiWTTuhgHrdDnGdXg93N2M5KHn1ug8BtPLQwlcFwEpKnlLn
-  btEP+7EplFuoiMfd
+  MIIENDCCApygAwIBAgIBATANBgkqhkiG9w0BAQsFADAiMSAwHgYDVQQDDBdtYWhs
+  b24vREM9bWFydGluaS9EQz1udTAeFw0yMTAxMTcwMDQzMDZaFw0zMTAxMTUwMDQz
+  MDZaMCIxIDAeBgNVBAMMF21haGxvbi9EQz1tYXJ0aW5pL0RDPW51MIIBojANBgkq
+  hkiG9w0BAQEFAAOCAY8AMIIBigKCAYEAsRZyNGaL3I8T2AkQsHKyixW10CY6T715
+  uOztbmZImekhmgE9Uj5xZCnUP4xG5ToJffgkxcbepyJwIHCjEQg7viL9EsA+rMNb
+  UX8dsa9jpvVD6nHAdoW8G0ee7SRBXhCfyNma8FtkDJfw2bwdKhxUKiHsULCSQ0Pd
+  p+4d5NnldgfB8cf4Hz9Ai/8FHacWnZVEiHa4Ngb5Fe42OUs+4XDQdpcgA7wCY633
+  q9rRVGK7MW9BzMv+hhQfElQMn1eDMgQVpO543viDT8JatwhhcYmKdzwTIIPAIybf
+  8MfJaimsh20OAqs3FAXNKjDVFbcXFfKUXXgVgMjUoEK5+Lp+pKPZXU4bIi5oYZqB
+  OttGPMD5rOWlAooWNQ7xbdHByUVqJmALSWHqPHdvVmAVsW8tNoB1qGbM+C6o80Ie
+  9H0389ja3TW4JK/0w/gFUmrVvYKRll44HaxS9nXNpiYBipbJmlR/R9qoe54ImQje
+  Z4vsWrWiDrK/oVYlUXOy7SE/jUAQF9UzAgMBAAGjdTBzMAkGA1UdEwQCMAAwCwYD
+  VR0PBAQDAgSwMB0GA1UdDgQWBBSx8TRqCmTPOARICKiZ3c66sIG3pTAcBgNVHREE
+  FTATgRFtYWhsb25AbWFydGluaS5udTAcBgNVHRIEFTATgRFtYWhsb25AbWFydGlu
+  aS5udTANBgkqhkiG9w0BAQsFAAOCAYEAHbiAZTe46/kp1Tkm4s6D30VBaYaAdaYG
+  bZIaAaHtJO9MbUNS0FA01fxQpptjpOQT3cNNf8CX8UHPTaSuPFMfgVWj1xiX7Byb
+  hqhUcUTENOuUxxWGDCa4orCFctc3yihojTKGtbhODHVSHf9DRDyalRcvmyWzxMFT
+  XtBS05OUXc9O1bKqzNaRc9nMGw6Y+V79hIex4mZlMBkhTeVKxeeweCXfELXOQRmB
+  FgPgUyQn0AaSpplx0YoWdy/99fEkXSMvgeEoiR1ApR6aUuTlvIr1yUgzVBpWU4mE
+  XC+Ig+3jhqufGyE/Do+1M7n5QLpgGfpy3QmoOiKeYt3XzR5Z7XoxCAaKHNRxVEga
+  ojmVnDNlLQkkZZkbFNGPHjCIBs7h+6eoIYvy/eQ82c4vd6w9rR4v9bKUL8NNkcSz
+  49pOzX5KHZLTS9DKeaP/xcGPz6C8MiwQdYrZarr2SHRASX1zFa79rkItO8kE6RDr
+  b6WDF79UvZ55ajtE00TiwqjQL/ZPEtbd
   -----END CERTIFICATE-----
-date: 2022-12-21 00:00:00.000000000 Z
+date: 2023-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: loggability
@@ -154,14 +155,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: roda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.67'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.67'
 - !ruby/object:Gem::Dependency
   name: rspec-wait
   requirement: !ruby/object:Gem::Requirement
@@ -292,12 +307,13 @@ files:
 - lib/inversion/template/uriencodetag.rb
 - lib/inversion/template/yieldtag.rb
 - lib/inversion/tilt.rb
+- lib/roda/plugins/inversion.rb
 - spec/data/sinatra/hello.inversion
 - spec/data/unknown-tag.tmpl
 - spec/helpers.rb
 - spec/inversion/mixins_spec.rb
-- spec/inversion/monkeypatches_spec.rb
 - spec/inversion/parser_spec.rb
+- spec/inversion/refinements_spec.rb
 - spec/inversion/renderstate_spec.rb
 - spec/inversion/sinatra_spec.rb
 - spec/inversion/template/attrtag_spec.rb
@@ -331,15 +347,17 @@ files:
 - spec/inversion/template_spec.rb
 - spec/inversion/tilt_spec.rb
 - spec/inversion_spec.rb
+- spec/roda/plugins/inversion_spec.rb
 homepage: https://hg.sr.ht/~ged/Inversion
 licenses:
 - BSD-3-Clause
 metadata:
   homepage_uri: https://hg.sr.ht/~ged/Inversion
-  documentation_uri: http://deveiate.org/code/Inversion
+  documentation_uri: http://deveiate.org/code/inversion
+  changelog_uri: http://deveiate.org/code/inversion/History_md.html
   source_uri: https://hg.sr.ht/~ged/Inversion/browse
   bug_tracker_uri: https://todo.sr.ht/~ged/Inversion/browse
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -354,8 +372,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.3.26
+signing_key: 
 specification_version: 4
 summary: Inversion is a templating system for Ruby.
 test_files: []

data/spec/inversion/monkeypatches_spec.rb

@@ -1,25 +0,0 @@
-#!/usr/bin/env rspec -cfd -b
-# vim: set noet nosta sw=4 ts=4 :
-
-
-require_relative '../helpers'
-
-require 'ripper'
-require 'inversion/monkeypatches'
-
-
-RSpec.describe Inversion, "monkeypatches" do
-
-	describe Inversion::RipperAdditions do
-
-		it "exposes the Ripper::TokenPattern::MatchData's #tokens array" do
-			tagpattern = Ripper::TokenPattern.compile( '$(ident) $(sp) $(ident)' )
-			matchdata = tagpattern.match( "foo bar" )
-			expect( matchdata.tokens.map {|tok| tok[1]} ).to eq([ :on_ident, :on_sp, :on_ident ])
-		end
-
-	end
-
-
-end
-