dry-view 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d0cd65b1329feef3497caadc8f41521850546d9c60aa673d035215bcaaee922
-  data.tar.gz: 46e2e12a0d192dd2e7443c334bc62fdd86ff76f1aa308c1b1ac14a921e67565b
+  metadata.gz: 5484205327cc47a66db6ae6df71a2e6647a690b8709aaf8ccbe3be80f7416a99
+  data.tar.gz: 10cb4443866ab17bcd16d90de09e733f3569d3b95ebf84bcffaaebaab068f964
 SHA512:
-  metadata.gz: f235921f2631c60446690342c388cc624665f21a9a1e40e979efa285bfa8fd73c3a0f4bb453931e1fc25cdc5a6201d58f42a7a4a6275a96c2f5d641f0ec23961
-  data.tar.gz: 2cc2906563bcd30b21c1034d0ffb97c395e77898b8ab7d117cdf11aa52462c7a874e05ddb66a59c600c29a31c65f7e3808fae4f447df817cdedbc255e7d0c179
+  metadata.gz: 9bd666e31aa5078cd99ed81c3934ba32969c709657ff53efc2e24e8902c9758fb3824c8e665184a24c14d45e182a4af950007764029e9c7715994563749f9222
+  data.tar.gz: 9ce17b5ef3be59a4de48acc9c084c1803387000f2c18339b1b39b93aaa3412ce013755e03435dca6525b72be6f919f29580b98f87dac0f7d2754208cd8476adf

data/.travis.yml

@@ -13,11 +13,11 @@ before_script:
 after_script:
   - "[ -d coverage ] && ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT"
 rvm:
-  - 2.6.0
+  - 2.6.1
   - 2.5.3
   - 2.4.5
   - 2.3.8
-  - jruby-9.2.5.0
+  - jruby-9.2.6.0
 notifications:
   email: false
   webhooks:

data/CHANGELOG.md

@@ -1,3 +1,27 @@
+# 0.7.0 / 2019-03-06
+
+### Added
+
+- Raise a `Dry::View::UndefinedConfigError` when a view is called but no paths have been configured (timriley in [#130][pr130])
+
+### Changed
+
+- [BREAKING] Move `Dry::View::Renderer::TemplateNotFoundError` to `Dry::View::TemplateNotFoundError` (timriley in [#130][pr130])
+- [BREAKING] `Dry::View::UndefinedConfigError` is raised instead of `Dry::View::UndefinedTemplateError` when a view is called but no template has been configured (timriley in [#130][pr130])
+- Stop searching upwards through parent directories when rendering a view's template (as opposed to partials) (timriley in [#130][pr130])
+- Stop searching in `shared/` subdirectories when rendering a view's template (as opposed to partials) (timriley in [#130][pr130])
+- Adjust template lookup cache keys to ensure no false hits (timriley in [#130][pr130])
+
+### Fixed
+
+- Avoid a `SystemStackError` when a view is configured with a template that cannot be found on the filesystem (timriley in [#129][pr129])
+
+[Compare v0.6.0...v0.7.0](https://github.com/dry-rb/dry-view/compare/v0.6.0...v0.7.0)
+
+
+[pr129]: https://github.com/dry-rb/dry-view/pull/129
+[pr130]: https://github.com/dry-rb/dry-view/pull/130
+
 # 0.6.0 / 2019-01-30
 
 ### Added

data/lib/dry/view.rb

@@ -7,6 +7,7 @@ require "dry/inflector"
 
 require_relative "view/context"
 require_relative "view/exposures"
+require_relative "view/errors"
 require_relative "view/part_builder"
 require_relative "view/path"
 require_relative "view/render_environment"
@@ -33,9 +34,6 @@ module Dry
   #
   # @api public
   class View
-    # @api private
-    UndefinedTemplateError = Class.new(StandardError)
-
     # @api private
     DEFAULT_RENDERER_OPTIONS = {default_encoding: "utf-8"}.freeze
 
@@ -459,7 +457,7 @@ module Dry
     # @return [Rendered] rendered view object
     # @api public
     def call(format: config.default_format, context: config.default_context, **input)
-      raise UndefinedTemplateError, "no +template+ configured" unless config.template
+      ensure_config
 
       env = self.class.render_env(format: format, context: context)
       template_env = self.class.template_env(format: format, context: context)
@@ -469,7 +467,7 @@ module Dry
 
       if layout?
         layout_env = self.class.layout_env(format: format, context: context)
-        output = layout_env.template(self.class.layout_path, layout_env.scope(config.scope, layout_locals(locals))) { output }
+        output = env.template(self.class.layout_path, layout_env.scope(config.scope, layout_locals(locals))) { output }
       end
 
       Rendered.new(output: output, locals: locals)
@@ -477,6 +475,12 @@ module Dry
 
     private
 
+    # @api private
+    def ensure_config
+      raise UndefinedConfigError.new(:paths) unless Array(config.paths).any?
+      raise UndefinedConfigError.new(:template) unless config.template
+    end
+
     # @api private
     def locals(render_env, input)
       exposures.(context: render_env.context, **input) do |value, exposure|

data/lib/dry/view/errors.rb

@@ -0,0 +1,27 @@
+module Dry
+  class View
+    # Error raised when critical settings are not configured
+    #
+    # @api private
+    class UndefinedConfigError < StandardError
+      def initialize(key)
+        super("no +#{key}+ configured")
+      end
+    end
+
+    # Error raised when template could not be found within a view's configured
+    # paths
+    #
+    # @api private
+    class TemplateNotFoundError < StandardError
+      def initialize(template_name, lookup_paths)
+        msg = [
+          "Template +#{template_name}+ could not be found in paths:",
+          lookup_paths.map { |path| " - #{path}"}
+        ].join("\n\n")
+
+        super(msg)
+      end
+    end
+  end
+end

data/lib/dry/view/path.rb

@@ -22,14 +22,14 @@ module Dry
 
       def initialize(dir, root: dir)
         @dir = Pathname(dir)
-        @root = root
+        @root = Pathname(root)
       end
 
-      def lookup(name, format, include_shared: true)
-        fetch_or_store(dir, root, name, format) do
-          template?(name, format) ||
-            (include_shared && template?("shared/#{name}", format)) ||
-            !root? && chdir("..").lookup(name, format)
+      def lookup(name, format, child_dirs: [], parent_dir: false)
+        fetch_or_store(dir, root, name, format, child_dirs, parent_dir) do
+          lookup_template(name, format) ||
+            lookup_in_child_dirs(name, format, child_dirs: child_dirs) ||
+            parent_dir && lookup_in_parent_dir(name, format, child_dirs: child_dirs)
         end
       end
 
@@ -48,10 +48,21 @@ module Dry
       end
 
       # Search for a template using a wildcard for the engine extension
-      def template?(name, format)
+      def lookup_template(name, format)
         glob = dir.join("#{name}.#{format}.*")
         Dir[glob].first
       end
+
+      def lookup_in_child_dirs(name, format, child_dirs:)
+        child_dirs.reduce(nil) { |_, dir|
+          template = chdir(dir).lookup(name, format)
+          break template if template
+        }
+      end
+
+      def lookup_in_parent_dir(name, format, child_dirs:)
+        !root? && chdir("..").lookup(name, format, child_dirs: child_dirs, parent_dir: true)
+      end
     end
   end
 end

data/lib/dry/view/renderer.rb

@@ -2,6 +2,7 @@
 
 require "dry/core/cache"
 require "dry/equalizer"
+require_relative "errors"
 require_relative "tilt"
 
 module Dry
@@ -15,8 +16,6 @@ module Dry
 
       include Dry::Equalizer(:paths, :format, :engine_mapping, :options)
 
-      TemplateNotFoundError = Class.new(StandardError)
-
       attr_reader :paths, :format, :engine_mapping, :options
 
       def initialize(paths, format:, engine_mapping: nil, **options)
@@ -26,19 +25,24 @@ module Dry
         @options = options
       end
 
-      def template(name, scope, &block)
-        path = lookup(name)
+      def template(name, scope, **lookup_options, &block)
+        path = lookup(name, **lookup_options)
 
         if path
           render(path, scope, &block)
         else
-          msg = "Template #{name.inspect} could not be found in paths:\n#{paths.map { |pa| "- #{pa.to_s}" }.join("\n")}"
-          raise TemplateNotFoundError, msg
+          raise TemplateNotFoundError.new(name, paths)
         end
       end
 
       def partial(name, scope, &block)
-        template(name_for_partial(name), scope, &block)
+        template(
+          name_for_partial(name),
+          scope,
+          child_dirs: %w[shared],
+          parent_dir: true,
+          &block
+        )
       end
 
       def render(path, scope, &block)
@@ -51,15 +55,15 @@ module Dry
         self.class.new(new_paths, format: format, **options)
       end
 
-      def lookup(name)
-        paths.inject(false) { |_, path|
-          result = path.lookup(name, format, include_shared: false)
+      private
+
+      def lookup(name, **options)
+        paths.inject(nil) { |_, path|
+          result = path.lookup(name, format, **options)
           break result if result
         }
       end
 
-      private
-
       def name_for_partial(name)
         name_segments = name.to_s.split(PATH_DELIMITER)
         name_segments[0..-2].push("#{PARTIAL_PREFIX}#{name_segments[-1]}").join(PATH_DELIMITER)

data/lib/dry/view/version.rb

@@ -3,6 +3,6 @@
 module Dry
   class View
     # @api private
-    VERSION = "0.6.0"
+    VERSION = "0.7.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dry-view
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Tim Riley
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-29 00:00:00.000000000 Z
+date: 2019-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tilt
@@ -157,6 +157,7 @@ files:
 - lib/dry/view.rb
 - lib/dry/view/context.rb
 - lib/dry/view/decorated_attributes.rb
+- lib/dry/view/errors.rb
 - lib/dry/view/exposure.rb
 - lib/dry/view/exposures.rb
 - lib/dry/view/part.rb
@@ -192,8 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: A complete, standalone view rendering system that gives you everything you