hanami-view 1.0.0.beta1 → 1.0.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c9d9b96f95c854ea1e077fa9eba2f0a12231a17a
-  data.tar.gz: 3765632751a65ae3796b713fa5ba18513c602ef9
+  metadata.gz: b09fc59502d563ea4210c73bc5909553a2f5cb03
+  data.tar.gz: f9a822d9f11356243c2d4ed6d67dc5d2edbf60a5
 SHA512:
-  metadata.gz: e6eb1ffb5750b24e53ad193372b96be6c3369d06d7d0320aa575e95ecad959c070c0aa70ce8821b84f0ccf7a7125daa8a8de77e3e25285c77efd663e1d99eb75
-  data.tar.gz: 27335f0f15b60e3c3460cb60825ff2059c1a2a26b464f9d6847e20a13d592d45ca6236e70569204a94c1d7898635e74371851442adc2974b7467753885ff65a7
+  metadata.gz: '00858c90d06b8eddf6c5d497b3dd5f03df9edb8fb620248d300b26017b94eafc49eb2866d34241204ba72e8abd30096700dc8884f338202fc680665848e70603'
+  data.tar.gz: e6602693088e2fbc2f1a54cae40278266bc542d65992d6e3b02c7830d744b1634d8142f5a5376265e6509264f1280ddb20f83f4ce046c386dd704184b1fa523a

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 # Hanami::View
 View layer for Hanami
 
+## v1.0.0.beta2 - 2017-03-17
+### Changed
+- [Luca Guidi] Remove deprecated `Hanami::View::Rendering::LayoutScope#content`
+
 ## v1.0.0.beta1 - 2017-02-14
 ### Added
 - [Luca Guidi] Official support for Ruby: MRI 2.4

data/LICENSE.md

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

data/README.md

@@ -866,6 +866,6 @@ __Hanami::View__ uses [Semantic Versioning 2.0.0](http://semver.org)
 
 ## Copyright
 
-Copyright 2014-2016 Luca Guidi – Released under MIT License
+Copyright 2014-2017 Luca Guidi – Released under MIT License
 
 This project was formerly known as Lotus (`lotus-view`).

data/lib/hanami/layout.rb

@@ -107,6 +107,7 @@ module Hanami
 
       private
 
+      # @api private
       def load_registry!
         @registry = nil
         registry.freeze

data/lib/hanami/view/configuration.rb

@@ -483,14 +483,21 @@ module Hanami
         end
       end
 
+      # @api private
       alias_method :unload!, :reset!
 
       protected
+      # @api private
       attr_writer :namespace
+      # @api private
       attr_writer :root
+      # @api private
       attr_writer :load_paths
+      # @api private
       attr_writer :layout
+      # @api private
       attr_writer :default_encoding
+      # @api private
       attr_writer :modules
     end
   end

data/lib/hanami/view/errors.rb

@@ -17,6 +17,8 @@ module Hanami
     #
     # @since 0.1.0
     class MissingTemplateError < Error
+      # @since 0.1.0
+      # @api private
       def initialize(template, format)
         super("Can't find template '#{ template }' for '#{ format }' format.")
       end
@@ -39,6 +41,8 @@ module Hanami
     #
     # @since 0.5.0
     class MissingTemplateLayoutError < Error
+      # @since 0.5.0
+      # @api private
       def initialize(template)
         super("Can't find layout template '#{ template }'")
       end

data/lib/hanami/view/escape.rb

@@ -18,7 +18,6 @@ module Hanami
         # @return [Hanami::Utils::Escape::SafeString] the string marked as safe
         #
         # @since 0.4.0
-        # @api public
         #
         # @example View usage
         #   require 'hanami/view'
@@ -72,7 +71,6 @@ module Hanami
         #   autoescape
         #
         # @since 0.4.0
-        # @api public
         #
         # @see Hanami::View::Escape::Presenter
         #

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

@@ -43,6 +43,8 @@ module Hanami
         end
 
         protected
+        # @api private
+        # @since 0.1.0
         def prepare!
           templates.each do |template|
             @registry.merge! template.format => template
@@ -50,10 +52,14 @@ module Hanami
           @registry.any? or raise MissingTemplateLayoutError.new(@view)
         end
 
+        # @api private
+        # @since 0.1.0
         def templates
           TemplatesFinder.new(@view).find
         end
 
+        # @api private
+        # @since 0.1.0
         def format(context)
           context.fetch(:format) { raise MissingFormatError }
         end

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

@@ -1,6 +1,5 @@
 require 'hanami/view/rendering/null_local'
 require 'hanami/utils/escape'
-require 'hanami/utils/deprecation'
 
 module Hanami
   module View
@@ -118,55 +117,6 @@ module Hanami
           @locals || @scope.locals
         end
 
-        # Returns a content for the given key, by trying to invoke on the current
-        # scope, a method with the same name.
-        #
-        # The scope is made of locals and concrete methods from view and layout.
-        #
-        # @param key [Symbol] a method to invoke within current scope
-        # @return [String,NilClass] returning content if scope respond to the
-        #   requested method
-        #
-        # @deprecated Use {#local} instead
-        # @since 0.4.1
-        #
-        # @example
-        #   # Given the following layout template
-        #
-        #   <!doctype HTML>
-        #   <html>
-        #     <!-- ... -->
-        #     <body>
-        #       <!-- ... -->
-        #       <%= content :footer %>
-        #     </body>
-        #   </html>
-        #
-        #   # Case 1:
-        #   #   Products::Index doesn't respond to #footer, content will return nil
-        #   #
-        #   # Case 2:
-        #   #   Products::Show responds to #footer, content will send back
-        #   #     #footer returning value
-        #
-        #   module Products
-        #     class Index
-        #       include Hanami::View
-        #     end
-        #
-        #     class Show
-        #       include Hanami::View
-        #
-        #       def footer
-        #         "contents for footer"
-        #       end
-        #     end
-        #   end
-        def content(key)
-          Utils::Deprecation.new("#content is deprecated, please use #local")
-          __send__(key) if respond_to?(key)
-        end
-
         # It tries to invoke a method for the view or a local for the given key.
         # If the lookup fails, it returns a null object.
         #
@@ -224,6 +174,7 @@ module Hanami
         # @return [TrueClass,FalseClass]
         #
         # @since 0.3.0
+        # @api private
         #
         # @see http://ruby-doc.org/core/Object.html#method-i-respond_to-3F
         def respond_to?(m, include_all = false)
@@ -271,6 +222,7 @@ module Hanami
           end
         end
 
+        # @api private
         def renderer(options)
           if options[:partial]
             Rendering::Partial
@@ -280,6 +232,7 @@ module Hanami
         end
 
         private
+        # @api private
         def _options(options)
           options.dup.tap do |opts|
             opts.merge!(format: format)

data/lib/hanami/view/rendering/null_local.rb

@@ -20,21 +20,25 @@ module Hanami
         end
 
         # @since 0.7.0
+        # @api private
         def all?
           false
         end
 
         # @since 0.7.0
+        # @api private
         def any?
           false
         end
 
         # @since 0.7.0
+        # @api private
         def empty?
           true
         end
 
         # @since 0.7.0
+        # @api private
         def nil?
           true
         end

data/lib/hanami/view/rendering/partial.rb

@@ -20,6 +20,8 @@ module Hanami
       #   <%= render partial: 'shared/sidebar' %>
       class Partial < Template
         protected
+        # @api private
+        # @since 0.1.0
         def template
           PartialFinder.new(@view.class, @options).find
         end

data/lib/hanami/view/rendering/partial_file.rb

@@ -4,7 +4,17 @@ module Hanami
       # @since 0.7.0
       # @api private
       class PartialFile
-        attr_reader :key, :format, :template
+        # @since 0.7.0
+        # @api private
+        attr_reader :key
+
+        # @since 0.7.0
+        # @api private
+        attr_reader :format
+
+        # @since 0.7.0
+        # @api private
+        attr_reader :template
 
         # @since 0.7.0
         # @api private

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

@@ -60,15 +60,18 @@ module Hanami
           all.join(separator)
         end
 
+        # @api private
         def template_name
           *all, last = partial_name.split(separator)
           all.push( last.prepend(prefix) ).join(separator)
         end
 
+        # @api private
         def partial_name
           @options[:partial]
         end
 
+        # @api private
         def prefix
           PREFIX
         end

data/lib/hanami/view/rendering/partial_templates_finder.rb

@@ -21,6 +21,8 @@ module Hanami
         # @since 0.7.0
         PARTIAL_PARTS_SEPARATOR = '.'.freeze
 
+        # @api private
+        # @since 0.7.0
         attr_reader :configuration
 
         # Initializes a new PartialTemplatesFinder
@@ -28,6 +30,7 @@ module Hanami
         # @param configuration [Configuration] the configuration object
         #
         # @since 0.7.0
+        # @api private
         def initialize(configuration)
           @configuration = configuration
         end
@@ -37,6 +40,7 @@ module Hanami
         # @return [Array] array of PartialFinder objects
         #
         # @since 0.7.0
+        # @api private
         def find
           _find_partials(configuration.root).map do |template|
             partial_path, partial_base_name = Pathname(template).relative_path_from(configuration.root).split
@@ -67,4 +71,3 @@ module Hanami
     end
   end
 end
-

data/lib/hanami/view/rendering/registry.rb

@@ -94,31 +94,37 @@ module Hanami
         end
 
         private
+        # @api private
         def prepare!
           prepare_views!
           prepare_templates!
         end
 
+        # @api private
         def prepare_views!
           views.each do |view|
             @registry.merge! view.format || DEFAULT_FORMAT => [ view, template_for(view) ]
           end
         end
 
+        # @api private
         def prepare_templates!
           templates.each do |template|
             @registry.merge! template.format => [ view_for(template), template ]
           end
         end
 
+        # @api private
         def views
           @view.subclasses + [ @view ]
         end
 
+        # @api private
         def view_for(template)
           ViewFinder.new(@view).find(template)
         end
 
+        # @api private
         def template_for(view)
           templates.find {|template| template.format == view.format }
         end

data/lib/hanami/view/rendering/scope.rb

@@ -62,6 +62,7 @@ module Hanami
         end
 
         protected
+        # @api private
         def method_missing(m, *args, &block)
           ::Hanami::View::Escape.html(
             if @view.respond_to?(m)

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

@@ -45,10 +45,12 @@ module Hanami
         end
 
         protected
+        # @api private
         def template
           TemplateFinder.new(@view.class, @options).find
         end
 
+        # @api private
         def scope
           Scope.new(@view, @options[:locals])
         end

data/lib/hanami/view/rendering/template_finder.rb

@@ -40,10 +40,12 @@ module Hanami
         end
 
         protected
+        # @api private
         def template_name
           @options[:template]
         end
 
+        # @api private
         def format
           @options[:format]
         end

data/lib/hanami/view/rendering/template_name.rb

@@ -4,30 +4,43 @@ module Hanami
   module View
     module Rendering
       # @since 0.2.0
+      # @api private
       class TemplateName
+        # @since 0.2.0
+        # @api private
         NAMESPACE_SEPARATOR = '::'.freeze
 
+        # @since 0.2.0
+        # @api private
         def initialize(name, namespace)
           @name = name
           compile!(namespace)
         end
 
+        # @since 0.2.0
+        # @api private
         def to_s
           @name
         end
 
         private
+        # @since 0.2.0
+        # @api private
         def compile!(namespace)
           tokens(namespace) {|token| replace!(token) }
           @name = Utils::String.new(@name).underscore
         end
 
+        # @since 0.2.0
+        # @api private
         def tokens(namespace)
           namespace.to_s.split(NAMESPACE_SEPARATOR).each do |token|
             yield token
           end
         end
 
+        # @since 0.2.0
+        # @api private
         def replace!(token)
           @name.gsub!(%r{\A#{ token }#{ NAMESPACE_SEPARATOR }}, '')
         end

data/lib/hanami/view/rendering.rb

@@ -10,6 +10,8 @@ module Hanami
     #
     # @see Hanami::View::Rendering::InstanceMethods
     module Rendering
+      # @since 0.1.0
+      # @api private
       def self.extended(base)
         base.class_eval do
           include InstanceMethods
@@ -281,6 +283,7 @@ module Hanami
         @registry ||= Registry.new(self)
       end
 
+      # @api private
       def load_registry!
         @registry = nil
         registry.freeze

data/lib/hanami/view/version.rb

@@ -3,6 +3,6 @@ module Hanami
     # Defines the version
     #
     # @since 0.1.0
-    VERSION = '1.0.0.beta1'.freeze
+    VERSION = '1.0.0.beta2'.freeze
   end
 end

data/lib/hanami/view.rb

@@ -11,6 +11,9 @@ require 'hanami/view/errors'
 require 'hanami/layout'
 require 'hanami/presenter'
 
+# Hanami
+#
+# @since 0.1.0
 module Hanami
   # View
   #
@@ -103,7 +106,7 @@ module Hanami
     #
     # @return [Module] a copy of Hanami::View
     #
-    # @since 0.2.0
+    # @since 0.2.0
     #
     # @see Hanami::View#dupe
     # @see Hanami::View::Configuration

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hanami-view
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta1
+  version: 1.0.0.beta2
 platform: ruby
 authors:
 - Luca Guidi
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-14 00:00:00.000000000 Z
+date: 2017-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tilt