lotus-view 0.4.4 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dda1cba5c497595dbff0db4c47d5c0728579af21
-  data.tar.gz: c69552c1116c135f86715a31b084612528e86f49
+  metadata.gz: e4af30e053bd980adee58a5c31b34d1a47672a2c
+  data.tar.gz: 9215a2d92a5f5c8b76e4a77d13bfae59f996cde2
 SHA512:
-  metadata.gz: 0f8e135e3739e623393fb7df975c1680c7299dd91300414277d16a3143b7089a8fe3c8c0d42eda3b02c355cb61652b9234cb16b77f4211d1f747968dfa930bf0
-  data.tar.gz: 45e78d2c9910b4f3e9bfff52162cb08478fd6f663b094c16aae59ec1148d33389db6a9d9237dc837fd48a0bb9956ecd0267abcbc35b4de7875d0b3ff3b3367be
+  metadata.gz: 2933b16f795e1fcd6f62b0739b035ebe9a0798cb4a9debffb40a01b72f5d65d95b16bbf4e72a3e2a64993bc3c32aba09c2200b804a5ad40205b34ac404b9dfc2
+  data.tar.gz: b735e3c0352fdcc0e8a685b148caf332543d514a840765c54ff49df52972f38bccc18d2ec110e126dc76706de44dee04c9d97820e1a1804fc7417d2e7c0dc031

data/CHANGELOG.md

@@ -1,6 +1,18 @@
 # Lotus::View
 View layer for Lotus
 
+## v0.5.0 - 2016-01-12
+### Added
+- [Luca Guidi] Added `Lotus::View::Configuration#default_encoding` to set the encoding for templates
+
+### Fixed
+- [Luca Guidi] Let exceptions to be raised as they occur in rendering context. This fixes misleading backtraces for exceptions.
+- [Martin Rubi] Raise a `Lotus::View::MissingTemplateError` when rendering a missing partial from a template
+- [Luca Guidi] Fix for `template.erb is not valid US-ASCII (Encoding::InvalidByteSequenceError)` when system encoding is not set
+
+### Changed
+- [Liam Dawson] Introduced `Lotus::View::Error` and let all the framework exceptions to inherit from it.
+
 ## v0.4.4 - 2015-09-30
 ### Added
 - [Luca Guidi] Autoescape for layout helpers.

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Luca Guidi
+Copyright (c) 2014-2016 Luca Guidi
 
 MIT License
 

data/README.md

@@ -573,6 +573,11 @@ Lotus::View.configure do
   #
   root '/path/to/root'
 
+  # Default encoding for templates
+  # Argument: String, defaults to utf-8
+  #
+  default_encoding 'koi-8'
+
   # Set the Ruby namespace where to lookup for views
   # Argument: Class, Module, String, defaults to Object
   #
@@ -845,4 +850,4 @@ __Lotus::View__ uses [Semantic Versioning 2.0.0](http://semver.org)
 
 ## Copyright
 
-Copyright 2014-2015 Luca Guidi – Released under MIT License
+Copyright 2014-2016 Luca Guidi – Released under MIT License

data/lib/lotus/layout.rb

@@ -78,7 +78,7 @@ module Lotus
       #
       # ApplicationLayout.template # => 'application'
       def template
-        super.gsub(suffix, '')
+        super.sub(suffix, '')
       end
 
       # Template name suffix

data/lib/lotus/view.rb

@@ -7,6 +7,7 @@ require 'lotus/view/inheritable'
 require 'lotus/view/rendering'
 require 'lotus/view/escape'
 require 'lotus/view/dsl'
+require 'lotus/view/errors'
 require 'lotus/layout'
 require 'lotus/presenter'
 
@@ -15,37 +16,7 @@ module Lotus
   #
   # @since 0.1.0
   module View
-    # Missing template error
-    #
-    # This is raised at the runtime when Lotus::View cannot find a template for
-    # the requested format.
-    #
-    # We can't raise this error during the loading phase, because at that time
-    # we don't know if a view implements its own rendering policy.
-    # A view is allowed to override `#render`, and this scenario can make the
-    # presence of a template useless. One typical example is the usage of a
-    # serializer that returns the output string, without rendering a template.
-    #
-    # @since 0.1.0
-    class MissingTemplateError < ::StandardError
-      def initialize(template, format)
-        super("Can't find template '#{ template }' for '#{ format }' format.")
-      end
-    end
-
-    # Missing format error
-    #
-    # This is raised at the runtime when rendering context lacks of the :format
-    # key.
-    #
-    # @since 0.1.0
-    #
-    # @see Lotus::View::Rendering#render
-    class MissingFormatError < ::StandardError
-    end
-
     include Utils::ClassAttribute
-
     # Framework configuration
     #
     # @since 0.2.0
@@ -268,10 +239,10 @@ module Lotus
       conf.add_view(base)
 
       base.class_eval do
-        extend Inheritable.dup
-        extend Dsl.dup
-        extend Rendering.dup
-        extend Escape.dup
+        extend Inheritable
+        extend Dsl
+        extend Rendering
+        extend Escape
 
         include Utils::ClassAttribute
         class_attribute :configuration

data/lib/lotus/view/configuration.rb

@@ -29,6 +29,12 @@ module Lotus
       # @api private
       DEFAULT_ROOT = '.'.freeze
 
+      # Default encoding
+      #
+      # @since 0.5.0
+      # @api private
+      DEFAULT_ENCODING = Encoding::UTF_8
+
       attr_reader :load_paths
       attr_reader :views
       attr_reader :layouts
@@ -237,6 +243,55 @@ module Lotus
         end
       end
 
+      # Default encoding for templates
+      #
+      # This is part of a DSL, for this reason when this method is called with
+      # an argument, it will set the corresponding instance variable. When
+      # called without, it will return the already set value, or the default.
+      #
+      # @overload default_encoding(value)
+      #   Sets the given value
+      #   @param value [String,Encoding] a string representation of the encoding,
+      #     or an Encoding constant
+      #
+      #   @raise [ArgumentError] if the given value isn't a supported encoding
+      #
+      # @overload default_encoding
+      #   Gets the value
+      #   @return [Encoding]
+      #
+      # @since 0.5.0
+      #
+      # @example Set UTF-8 As A String
+      #   require 'lotus/view'
+      #
+      #   Lotus::View.configure do
+      #     default_encoding 'utf-8'
+      #   end
+      #
+      # @example Set UTF-8 As An Encoding Constant
+      #   require 'lotus/view'
+      #
+      #   Lotus::View.configure do
+      #     default_encoding Encoding::UTF_8
+      #   end
+      #
+      # @example Raise An Error For Unknown Encoding
+      #   require 'lotus/view'
+      #
+      #   Lotus::View.configure do
+      #     default_encoding 'foo'
+      #   end
+      #
+      #     # => ArgumentError
+      def default_encoding(value = nil)
+        if value.nil?
+          @default_encoding
+        else
+          @default_encoding = Encoding.find(value)
+        end
+      end
+
       # Prepare the views.
       #
       # The given block will be yielded when `Lotus::View` will be included by
@@ -347,11 +402,12 @@ module Lotus
       # @api private
       def duplicate
         Configuration.new.tap do |c|
-          c.namespace  = namespace
-          c.root       = root
-          c.layout     = @layout # lazy loading of the class
-          c.load_paths = load_paths.dup
-          c.modules    = modules.dup
+          c.namespace        = namespace
+          c.root             = root
+          c.layout           = @layout # lazy loading of the class
+          c.default_encoding = default_encoding
+          c.load_paths       = load_paths.dup
+          c.modules          = modules.dup
         end
       end
 
@@ -370,7 +426,8 @@ module Lotus
       # @since 0.2.0
       # @api private
       def reset!
-        root(DEFAULT_ROOT)
+        root             DEFAULT_ROOT
+        default_encoding DEFAULT_ENCODING
 
         @views      = Set.new
         @layouts    = Set.new
@@ -400,6 +457,7 @@ module Lotus
       attr_writer :root
       attr_writer :load_paths
       attr_writer :layout
+      attr_writer :default_encoding
       attr_writer :modules
     end
   end

data/lib/lotus/view/dsl.rb

@@ -205,9 +205,9 @@ module Lotus
       #   Bookshelf::Api::Views::Books::Index.template # => 'books/index'
       def template(value = nil)
         if value.nil?
-          @@template ||= Rendering::TemplateName.new(name, configuration.namespace).to_s
+          @template ||= Rendering::TemplateName.new(name, configuration.namespace).to_s
         else
-          @@template = value
+          @template = value
         end
       end
 

data/lib/lotus/view/errors.rb

@@ -0,0 +1,47 @@
+module Lotus
+  module View
+    # @since 0.5.0
+    class Error < ::StandardError
+    end
+
+    # Missing template error
+    #
+    # This is raised at the runtime when Lotus::View cannot find a template for
+    # the requested format.
+    #
+    # We can't raise this error during the loading phase, because at that time
+    # we don't know if a view implements its own rendering policy.
+    # A view is allowed to override `#render`, and this scenario can make the
+    # presence of a template useless. One typical example is the usage of a
+    # serializer that returns the output string, without rendering a template.
+    #
+    # @since 0.1.0
+    class MissingTemplateError < Error
+      def initialize(template, format)
+        super("Can't find template '#{ template }' for '#{ format }' format.")
+      end
+    end
+
+    # Missing format error
+    #
+    # This is raised at the runtime when rendering context lacks of the :format
+    # key.
+    #
+    # @since 0.1.0
+    #
+    # @see Lotus::View::Rendering#render
+    class MissingFormatError < Error
+    end
+
+    # Missing template layout error
+    #
+    # This is raised at the runtime when Lotus::Layout cannot find it's template.
+    #
+    # @since 0.5.0
+    class MissingTemplateLayoutError < Error
+      def initialize(template)
+        super("Can't find layout template '#{ template }'")
+      end
+    end
+  end
+end

data/lib/lotus/view/inheritable.rb

@@ -27,7 +27,7 @@ module Lotus
       # @api private
       # @since 0.1.0
       def subclasses
-        @@subclasses ||= Set.new
+        @subclasses ||= Set.new
       end
 
       protected
@@ -47,7 +47,7 @@ module Lotus
       # @api private
       # @since 0.1.0
       def views
-        @@views ||= [ self ] + subclasses.to_a
+        @views ||= [ self ] + subclasses.to_a
       end
     end
   end

data/lib/lotus/view/rendering.rb

@@ -258,7 +258,7 @@ module Lotus
       #
       # @see Lotus::View::Rendering::Registry
       def registry
-        @@registry ||= Registry.new(self)
+        @registry ||= Registry.new(self)
       end
     end
   end

data/lib/lotus/view/rendering/layout_registry.rb

@@ -4,16 +4,6 @@ require 'lotus/view/rendering/templates_finder'
 module Lotus
   module View
     module Rendering
-      # Missing template layout error
-      #
-      # This is raised at the runtime when Lotus::Layout cannot find it's template.
-      #
-      # @since 0.3.0
-      class MissingTemplateLayoutError < ::StandardError
-        def initialize(template)
-          super("Can't find layout template '#{ template }'")
-        end
-      end
       # Holds the references of all the registered layouts.
       # As now the registry is unique at the level of the framework.
       #

data/lib/lotus/view/rendering/layout_scope.rb

@@ -210,8 +210,6 @@ module Lotus
           else
             ::Lotus::View::Escape.html(super)
           end
-        rescue ::NameError
-          ::Kernel.raise ::NoMethodError.new("undefined method `#{ m }' for #{ self.inspect }", m)
         end
 
         def renderer(options)

data/lib/lotus/view/rendering/partial_finder.rb

@@ -35,7 +35,7 @@ module Lotus
         # @api private
         def find
           if path = partial_template_under_view_path
-            View::Template.new path
+            View::Template.new(path, @view.configuration.default_encoding)
           else
             super
           end

data/lib/lotus/view/rendering/template.rb

@@ -36,10 +36,12 @@ module Lotus
         #
         # @return [String] the output of the rendering process.
         #
+        # @raise [Lotus::View::MissingTemplateError] if template can't be found
+        #
         # @api private
         # @since 0.1.0
         def render
-          template.render(scope)
+          (template or raise_missing_template_error).render(scope)
         end
 
         protected
@@ -50,6 +52,15 @@ module Lotus
         def scope
           Scope.new(@view, @options[:locals])
         end
+
+        # @since 0.5.0
+        # @api private
+        def raise_missing_template_error
+          raise MissingTemplateError.new(
+            @options.fetch(:template) { @options.fetch(:partial, nil) },
+            @options[:format]
+          )
+        end
       end
     end
   end

data/lib/lotus/view/rendering/templates_finder.rb

@@ -70,7 +70,7 @@ module Lotus
         #     # => [#<Lotus::View::Template:0x007f8a0a86a970 ... @file="/path/to/templates/articles/show.html.erb">]
         def find
           _find.map do |template|
-            View::Template.new(template)
+            View::Template.new(template, @view.configuration.default_encoding)
           end
         end
 

data/lib/lotus/view/template.rb

@@ -6,8 +6,8 @@ module Lotus
     #
     # @since 0.1.0
     class Template
-      def initialize(template)
-        @_template = Tilt.new(template)
+      def initialize(template, encoding = Encoding::UTF_8)
+        @_template = Tilt.new(template, nil, default_encoding: encoding)
       end
 
       # Returns the format that the template handles.

data/lib/lotus/view/version.rb

@@ -3,6 +3,6 @@ module Lotus
     # Defines the version
     #
     # @since 0.1.0
-    VERSION = '0.4.4'.freeze
+    VERSION = '0.5.0'.freeze
   end
 end

data/lotus-view.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.0.0'
 
   spec.add_runtime_dependency 'tilt',        '~> 2.0', '>= 2.0.1'
-  spec.add_runtime_dependency 'lotus-utils', '~> 0.5'
+  spec.add_runtime_dependency 'lotus-utils', '~> 0.6'
 
   spec.add_development_dependency 'bundler',  '~> 1.5'
   spec.add_development_dependency 'minitest', '~> 5'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lotus-view
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.5.0
 platform: ruby
 authors:
 - Luca Guidi
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-30 00:00:00.000000000 Z
+date: 2016-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tilt
@@ -38,14 +38,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -106,6 +106,7 @@ files:
 - lib/lotus/view.rb
 - lib/lotus/view/configuration.rb
 - lib/lotus/view/dsl.rb
+- lib/lotus/view/errors.rb
 - lib/lotus/view/escape.rb
 - lib/lotus/view/inheritable.rb
 - lib/lotus/view/rendering.rb
@@ -146,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: View layer for Lotus, with a separation between views and templates