fortitude 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 25c2a3082f9eea925e6db1ad349f3d9ec45a9760
-  data.tar.gz: 4a95b0676e6b63b98ca69148bedc517b98b4955f
+  metadata.gz: b8fe2be7aaffdb2b3e57d0b26fdacbc2c1124a57
+  data.tar.gz: 01ada85328794df979d33ccff7a2ea41f88425f3
 SHA512:
-  metadata.gz: 88825dbca457537fb59373f3d345e119cd4b26d099befb5b56cea5885bf912161ff589775504657423e6b82b4852d7fead44df625af14bd226089dd644944ca2
-  data.tar.gz: 8bca6d9fa509fa98cc8abe0c630a790f9ff2f7b98544096e147aa986367332a08408b6d252533f7894552d24963f76b8d4e83898bf42f91d098035ef4653c28a
+  metadata.gz: 7394aeae5282f4109dbbe772a882ae066043a253813fc63b6b4e0d1ebdabb31de3e998a66969c347b37262c3a3365af2d6a1bf084e15ed9a8f9a6afa9c672ff5
+  data.tar.gz: 58b2ad3cdddd71f0120f9039ab9112ecaa4fc542c2104e98565341898e36c6b247dd7c60c07f39cee47d4fb5c47f95f11b0d27bbb75a605050c41fe47d38bd51

data/.travis.yml

@@ -3,14 +3,14 @@ rvm:
     - "1.9.3"
     - "2.0.0"
     - "2.1.2"
-    - "jruby-1.7.12"
+    - "jruby-1.7.15"
 env:
-    - FORTITUDE_SPECS_RAILS_VERSION=4.1.1
-    - FORTITUDE_SPECS_RAILS_VERSION=4.0.5
-    - FORTITUDE_SPECS_RAILS_VERSION=3.2.18
+    - FORTITUDE_SPECS_RAILS_VERSION=4.1.6
+    - FORTITUDE_SPECS_RAILS_VERSION=4.0.10
+    - FORTITUDE_SPECS_RAILS_VERSION=3.2.19
     - FORTITUDE_SPECS_RAILS_VERSION=3.1.12
     - FORTITUDE_SPECS_RAILS_VERSION=3.0.20
-    - FORTITUDE_NATIVE_EXTENSIONS=false FORTITUDE_SPECS_RAILS_VERSION=4.1.1
+    - FORTITUDE_NATIVE_EXTENSIONS=false FORTITUDE_SPECS_RAILS_VERSION=4.1.6
     - FORTITUDE_NATIVE_EXTENSIONS=false FORTITUDE_SPECS_RAILS_VERSION=3.0.20
 before_script:
     - export JRUBY_OPTS="$JRUBY_OPTS -J-Xmx128m -J-Xms128m -J-Xss2048k"
@@ -18,11 +18,11 @@ matrix:
     exclude:
         # Rails 4.x doesn't support Ruby 1.8.7
         -   rvm: 1.8.7
-            env: FORTITUDE_SPECS_RAILS_VERSION=4.1.1
+            env: FORTITUDE_SPECS_RAILS_VERSION=4.1.6
         -   rvm: 1.8.7
-            env: FORTITUDE_NATIVE_EXTENSIONS=false FORTITUDE_SPECS_RAILS_VERSION=4.1.1
+            env: FORTITUDE_NATIVE_EXTENSIONS=false FORTITUDE_SPECS_RAILS_VERSION=4.1.6
         -   rvm: 1.8.7
-            env: FORTITUDE_SPECS_RAILS_VERSION=4.0.5
+            env: FORTITUDE_SPECS_RAILS_VERSION=4.0.10
         # 2014-06-19 ageweke -- ARGH. After trying about seventeen different things, no matter what I do,
         # Travis fails JRuby builds about 20% of the time with "Killed". Their documentation indicates that this
         # is likely an out-of-memory issue (i.e., entire VM's memory is consumed). However, I'm running JRuby with
@@ -34,17 +34,17 @@ matrix:
         # one manually to make sure there aren't other failures, too. This is very frustrating, but I can't seem to
         # find a way around it. If there's a fix out there somewhere, I'm all ears!
     allow_failures:
-        -   rvm: jruby-1.7.12
-            env: FORTITUDE_SPECS_RAILS_VERSION=4.1.1
-        -   rvm: jruby-1.7.12
-            env: FORTITUDE_SPECS_RAILS_VERSION=4.0.5
-        -   rvm: jruby-1.7.12
-            env: FORTITUDE_SPECS_RAILS_VERSION=3.2.18
-        -   rvm: jruby-1.7.12
+        -   rvm: jruby-1.7.15
+            env: FORTITUDE_SPECS_RAILS_VERSION=4.1.6
+        -   rvm: jruby-1.7.15
+            env: FORTITUDE_SPECS_RAILS_VERSION=4.0.10
+        -   rvm: jruby-1.7.15
+            env: FORTITUDE_SPECS_RAILS_VERSION=3.2.19
+        -   rvm: jruby-1.7.15
             env: FORTITUDE_SPECS_RAILS_VERSION=3.1.12
-        -   rvm: jruby-1.7.12
+        -   rvm: jruby-1.7.15
             env: FORTITUDE_SPECS_RAILS_VERSION=3.0.20
-        -   rvm: jruby-1.7.12
-            env: FORTITUDE_NATIVE_EXTENSIONS=false FORTITUDE_SPECS_RAILS_VERSION=4.1.1
-        -   rvm: jruby-1.7.12
+        -   rvm: jruby-1.7.15
+            env: FORTITUDE_NATIVE_EXTENSIONS=false FORTITUDE_SPECS_RAILS_VERSION=4.1.6
+        -   rvm: jruby-1.7.15
             env: FORTITUDE_NATIVE_EXTENSIONS=false FORTITUDE_SPECS_RAILS_VERSION=3.0.20

data/CHANGES.md

@@ -1,5 +1,36 @@
 # Fortitude Releases
 
+## 0.0.5, 22 September 2014
+
+* You can now load both Fortitude and Erector at the same time into a project, and it will "just work": Erector
+  widgets will render using Erector, and Fortitude widgets will render using Fortitude. (Fortitude takes over the
+  actual template engine registration for `.rb` files, and uses a trick to keep Erector from displacing it; it then
+  looks at the widget class being rendered, and delegates all Erector rendering directly to Erector.)
+* When inside a widget, you can now render a sub-widget using `widget MyWidget.new(...)` — _i.e._, passing an
+  actual widget instance — or using `widget MyWidget, { :param1 => value1 }` — _i.e._, passing a widget
+  class and a `Hash` of assignments (which can be omitted if the widget doesn't have any `need`s).
+* Fixed an issue where, _e.g._, calling `#render_to_string` on a Fortitude widget within a Rails controller, and then
+  also rendering a Fortitude widget as the template for that action, would cause a method to be called on `nil`.
+* Added `Fortitude::RenderingContext#parent_widget`, which returns the parent widget of the current widget during
+  rendering at runtime. (In other words, this is not the superclass of the current widget, but the widget that caused
+  this widget to get rendered, using either `Fortitude::Widget#widget` or `render :partial => ...`.) This can, of
+  course, be `nil` if there is no current parent widget.
+* Added `Fortitude::Widget.all_fortitude_superclasses`, which returns an `Array` of all superclasses of a widget up to,
+  but not including, `Fortitude::Widget` itself.
+* Added `Fortitude::Widget.widget_class_from_file`, which accepts the path to a file and an array of "root" directories
+  to look under (_i.e._, assuming you're using something like Rails' autoloading mechanism), and returns the `Class`
+  object for the widget that's contained in that file. This uses a series of mechansims to try to detect the class
+  that's present in the file: a "magic comment" that can be present in the file, an array of class names to try
+  that you can pass in, the position of the class in the file hierarchy, and scanning the source text itself.
+* Added a `record_tag_emission` class-level setting that tells a widget to call `#emitting_tag!` on the
+  `Fortitude::RenderingContext` when emitting a tag; you can use this to build various systems that need to know where
+  in the hierarchy of tags we are at the moment.
+* The object being returned from Fortitude tag methods — which, in general, you should never use — now
+  inherits from `Object`, not `BasicObject`, so that some built-in methods like `#is_a?` can be safely called on it.
+  This is for use in some users' environments doing funny things with the Ruby runtime that end up calling methods
+  like that on the return values of widget `#content` methods, which very often just end up being the tag return
+  value object.
+
 ## 0.0.4, 24 June 2014
 
 * Added support for building a JRuby-specific gem to the gemspec, so that things work smoothly for JRuby users.

data/Gemfile

@@ -3,3 +3,4 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in fortitude.gemspec
 gemspec
 
+gem 'erector'

data/README-erector.md

@@ -18,7 +18,7 @@ garbage as ERb/Erubis);
 * Full, complete native HTML5 support (with selectable X/HTML4.01 Strict/Transitional/Frameset doctypes);
 * Enforces HTML element-nesting and attribute-name rules, and enforce ID uniqueness across a page (configurable, and off by default);
 * In development, beautiful HTML comments around each widget, showing what class is being rendered, the values of all variables supplied to that class, and the nesting depth of that widget;
-* Fully compatible with Ruby 1.8.7-2.1.x, JRuby 1.7.11, and Rails 3.0.x-4.1.x;
+* Fully compatible with Ruby 1.8.7-2.1.x, JRuby 1.7.15, and Rails 3.0.x-4.1.x;
 * Full Tilt support, and can be used with or without Rails;
 * Much more thorough Rails support — all known Rails integration points have been resolved, and it should work
 as smoothly with Rails as does (_e.g._) ERb/Erubis;

data/lib/fortitude/erector.rb

@@ -0,0 +1,32 @@
+module Fortitude
+  module Erector
+    class << self
+      def is_erector_available?
+        @is_erector_available ||= begin
+          begin
+            gem 'erector'
+          rescue Gem::LoadError => le
+            # ok
+          end
+
+          begin
+            require 'erector'
+          rescue LoadError => le
+            # ok
+          end
+
+          if defined?(::Erector::Widget) then :yes else :no end
+        end
+
+        @is_erector_available == :yes
+      end
+
+      def is_erector_widget_class?(widget_class)
+        return false unless is_erector_available?
+        return true if widget_class == ::Erector::Widget
+        return false if widget_class == ::Object
+        return is_erector_widget_class?(widget_class.superclass)
+      end
+    end
+  end
+end

data/lib/fortitude/method_templates/tag_method_template.rb.smpl

@@ -1,9 +1,9 @@
 def #{method_name}(content_or_attributes = nil, attributes = nil)
   o = @_fortitude_output_buffer_holder.output_buffer
-  rc = @_fortitude_rendering_context                                       # :if needs_element_rules || needs_formatting
+  rc = @_fortitude_rendering_context                                       # :if record_emitting_tag || needs_formatting
 
-  this_tag = #{tag_object_const}                                           # :if needs_element_rules || needs_attribute_rules || needs_id_uniqueness
-  rc.record_tag(self, this_tag) do                                         # :if needs_element_rules
+  this_tag = #{tag_object_const}                                           # :if record_emitting_tag || needs_attribute_rules || needs_id_uniqueness
+  rc.emitting_tag!(self, this_tag, content_or_attributes, attributes) do   # :if record_emitting_tag
     format_output = rc.format_output?                                      # :if needs_formatting
     if format_output                                                       # :if needs_formatting
       rc.needs_newline!                                                    # :if needs_formatting && newline_before
@@ -36,7 +36,7 @@ def #{method_name}(content_or_attributes = nil, attributes = nil)
     elsif (! attributes)
       _fortitude_raise_no_content_allowed_error(#{tag_object_const})       # :if ! content_allowed
       o.#{concat_method}(#{open_const})
-      rc.record_tag(self, FORTITUDE_TEXT_PSEUDOTAG) { } unless content_or_attributes.instance_variable_get("@html_safe") # :if needs_element_rules
+      rc.emitting_tag!(self, FORTITUDE_TEXT_PSEUDOTAG, content_or_attributes, nil) { } unless content_or_attributes.instance_variable_get("@html_safe") # :if record_emitting_tag
       content_or_attributes.to_s.fortitude_append_escaped_string(o)        # :if escape_direct_content
       o.#{concat_method}(content_or_attributes.to_s)                       # :if ! escape_direct_content
       if block_given?
@@ -52,7 +52,7 @@ def #{method_name}(content_or_attributes = nil, attributes = nil)
       attributes.fortitude_append_as_attributes(o, nil)
       o.#{concat_method}(#{partial_open_end_const})
 
-      rc.record_tag(self, FORTITUDE_TEXT_PSEUDOTAG) { } unless content_or_attributes.instance_variable_get("@html_safe") # :if needs_element_rules
+      rc.emitting_tag!(self, FORTITUDE_TEXT_PSEUDOTAG, content_or_attributes, nil) { } unless content_or_attributes.instance_variable_get("@html_safe") # :if record_emitting_tag
       content_or_attributes.to_s.fortitude_append_escaped_string(o)        # :if escape_direct_content
       o.#{concat_method}(content_or_attributes.to_s)                       # :if ! escape_direct_content
       if block_given?
@@ -62,7 +62,7 @@ def #{method_name}(content_or_attributes = nil, attributes = nil)
       o.#{concat_method}(#{close_const})
     end
     rc.needs_newline! if format_output                                     # :if needs_formatting && newline_before
-  end                                                                      # :if needs_element_rules
+  end                                                                      # :if record_emitting_tag
 
   FORTITUDE_NO_RETURN_VALUE_FROM_TAGS
 end

data/lib/fortitude/method_templates/text_method_template.rb.smpl

@@ -1,9 +1,9 @@
 def tag_text(s)
   @_fortitude_rendering_context.about_to_output_non_whitespace!    # :if format_output
 
-  unless s.instance_variable_get("@html_safe")                     # :if needs_element_rules
-    @_fortitude_rendering_context.record_tag(self, FORTITUDE_TEXT_PSEUDOTAG) { } # :if needs_element_rules
-  end                                                              # :if needs_element_rules
+  unless s.instance_variable_get("@html_safe")                     # :if record_emitting_tag
+    @_fortitude_rendering_context.emitting_tag!(self, FORTITUDE_TEXT_PSEUDOTAG, s, nil) { } # :if record_emitting_tag
+  end                                                              # :if record_emitting_tag
 
   s.to_s.fortitude_append_escaped_string(@_fortitude_output_buffer_holder.output_buffer)
 end

data/lib/fortitude/rails/railtie.rb

@@ -197,8 +197,10 @@ module Fortitude
         # So, instead, we simply transform <tt>render :widget => ...</tt> into a <tt>render :text => ...</tt> of the
         # widget's output, and let Rails take it away from there.
         ::ActionController::Base.class_eval do
-          def fortitude_rendering_context(options)
-            @_fortitude_rendering_context ||= create_fortitude_rendering_context(options)
+          def fortitude_rendering_context_for(delegate_object, yield_block)
+            @_fortitude_rendering_contexts ||= { }
+            @_fortitude_rendering_contexts[delegate_object.object_id] ||= create_fortitude_rendering_context(
+              :delegate_object => delegate_object, :yield_block => yield_block)
           end
 
           def create_fortitude_rendering_context(options)
@@ -208,7 +210,7 @@ module Fortitude
           def render_with_fortitude(*args, &block)
             if (options = args[0]).kind_of?(Hash)
               if (widget = options[:widget])
-                rendering_context = fortitude_rendering_context(:delegate_object => self)
+                rendering_context = fortitude_rendering_context_for(self, nil)
                 widget.render_to(rendering_context)
 
                 options = options.dup
@@ -220,7 +222,7 @@ module Fortitude
               elsif (widget_block = options[:inline]) && (options[:type] == :fortitude)
                 options.delete(:inline)
 
-                rendering_context = fortitude_rendering_context(:delegate_object => self)
+                rendering_context = fortitude_rendering_context_for(self, nil)
                 widget_class = Class.new(Fortitude::Widgets::Html5)
                 widget_class.use_instance_variables_for_assigns(true)
                 widget_class.extra_assigns(:use)

data/lib/fortitude/rails/renderer.rb

@@ -1,4 +1,5 @@
 require 'fortitude/rendering_context'
+require 'fortitude/erector'
 
 ::ActiveSupport::SafeBuffer.class_eval do
   alias_method :fortitude_concat, :original_concat
@@ -10,7 +11,11 @@ module Fortitude
     class Renderer
       class << self
         # TODO: Refactor this and render :widget => ... support into one method somewhere.
-        def render(widget_class, template_handler, local_assigns, &block)
+        def render(widget_class, template_handler, local_assigns, is_partial, &block)
+          if ::Fortitude::Erector.is_erector_widget_class?(widget_class)
+            return ::Erector::Rails.render(widget_class, template_handler, local_assigns, is_partial, &block)
+          end
+
           total_assigns = template_handler.assigns.symbolize_keys.merge(local_assigns.symbolize_keys)
 
           needed_assigns = if widget_class.extra_assigns == :use
@@ -21,9 +26,7 @@ module Fortitude
 
           widget = widget_class.new(needed_assigns)
           template_handler.with_output_buffer do
-            rendering_context_options = { :delegate_object => template_handler, :yield_block => block }
-            controller = template_handler.controller
-            rendering_context = controller.fortitude_rendering_context(rendering_context_options)
+            rendering_context = template_handler.controller.fortitude_rendering_context_for(template_handler, block)
 
             # TODO: Refactor this -- both passing it into the constructor and setting yield_block here is gross.
             #

data/lib/fortitude/rails/template_handler.rb

@@ -6,10 +6,10 @@ module Fortitude
       def call(template, &block)
         require_dependency template.identifier
         widget_class_name = "views/#{template.identifier =~ %r(views/([^.]*)(\..*)?\.rb) && $1}".camelize
-        is_partial = File.basename(template.identifier) =~ /^_/
+        is_partial = !! (File.basename(template.identifier) =~ /^_/)
 
         <<-SRC
-        Fortitude::Rails::Renderer.render(#{widget_class_name}, self, local_assigns) { |*args| yield *args }
+        Fortitude::Rails::Renderer.render(#{widget_class_name}, self, local_assigns, #{is_partial.inspect}) { |*args| yield *args }
         SRC
       end
 
@@ -20,4 +20,19 @@ module Fortitude
   end
 end
 
-ActionView::Template.register_template_handler :rb, Fortitude::Rails::TemplateHandler.new
+::ActionView::Template.class_eval do
+  class << self
+    def _fortitude_register_template_handler!
+      register_template_handler_without_fortitude(:rb, Fortitude::Rails::TemplateHandler.new)
+    end
+
+    def register_template_handler_with_fortitude(*args, &block)
+      register_template_handler_without_fortitude(*args, &block)
+      ActionView::Template._fortitude_register_template_handler!
+    end
+
+    alias_method_chain :register_template_handler, :fortitude
+  end
+end
+
+ActionView::Template._fortitude_register_template_handler!

data/lib/fortitude/rendering_context.rb

@@ -1,4 +1,5 @@
 require 'fortitude/support/instance_variable_set'
+require 'fortitude/tags/render_widget_placeholder'
 
 module Fortitude
   class RenderingContext
@@ -66,9 +67,14 @@ module Fortitude
       !! @attribute_validation_disabled
     end
 
+    def record_render(args, &block)
+      record_widget(::Fortitude::Tags::RenderWidgetPlaceholder.new(args), &block)
+    end
+
     def record_widget(widget)
       start_widget!(widget)
       @current_widget_nesting << widget
+      @current_element_nesting << widget
       begin
         yield
       ensure
@@ -76,6 +82,10 @@ module Fortitude
         unless last.equal?(widget)
           raise "Something horrible happened -- the last widget we started was #{last}, but now we're ending #{widget}?!?"
         end
+        last = @current_element_nesting.pop
+        unless last.equal?(widget)
+          raise "Something horrible happened -- the last element we started was #{last}, but now we're ending #{widget}?!?"
+        end
         end_widget!(widget)
       end
     end
@@ -92,8 +102,12 @@ module Fortitude
       @current_widget_nesting.length - 1
     end
 
-    def record_tag(widget, tag_object)
-      validate_element_for_rules(widget, tag_object)
+    def parent_widget
+      @current_widget_nesting[-2]
+    end
+
+    def emitting_tag!(widget, tag_object, content_or_attributes, attributes)
+      validate_element_for_rules(widget, tag_object) if widget.class.enforce_element_nesting_rules
       @current_element_nesting << tag_object
 
       begin
@@ -106,6 +120,10 @@ module Fortitude
       end
     end
 
+    def current_element_nesting
+      @current_element_nesting
+    end
+
     def format_output?
       true
     end

data/lib/fortitude/tags/render_widget_placeholder.rb

@@ -0,0 +1,19 @@
+module Fortitude
+  module Tags
+    class RenderWidgetPlaceholder
+      attr_reader :render_args
+
+      def initialize(render_args)
+        @render_args = render_args
+      end
+
+      def name
+        :_fortitude_render_widget_placeholder
+      end
+
+      def validate_can_enclose!(widget, tag_object)
+        # nothing here, always OK
+      end
+    end
+  end
+end

data/lib/fortitude/tags/tag.rb

@@ -116,7 +116,9 @@ module Fortitude
       end
 
       def define_method_on!(mod, options = {})
-        options.assert_valid_keys(:enforce_element_nesting_rules, :enforce_attribute_rules, :enable_formatting, :enforce_id_uniqueness, :close_void_tags)
+        options.assert_valid_keys(
+          :record_emitting_tag, :enforce_attribute_rules, :enable_formatting,
+          :enforce_id_uniqueness, :close_void_tags)
 
         unless mod.respond_to?(:fortitude_tag_support_included?) && mod.fortitude_tag_support_included?
           mod.send(:include, ::Fortitude::Tags::TagSupport)
@@ -147,8 +149,8 @@ module Fortitude
         end
 
         text = Fortitude::MethodTemplates::SimpleTemplate.template('tag_method_template').result(
-          :name => name.to_s, :method_name => "tag_#{name}".to_s, :yield_call => yield_call, :concat_method => CONCAT_METHOD,
-          :needs_element_rules => !! options[:enforce_element_nesting_rules],
+          :name => name.to_s, :method_name => generated_method_name.to_s, :yield_call => yield_call, :concat_method => CONCAT_METHOD,
+          :record_emitting_tag => (!! options[:record_emitting_tag]),
           :needs_attribute_rules => !! options[:enforce_attribute_rules],
           :needs_id_uniqueness => !! options[:enforce_id_uniqueness],
           :needs_formatting => needs_formatting, :content_allowed => @content_allowed,
@@ -160,7 +162,19 @@ module Fortitude
           :partial_open_alone_end_const => tag_constant_name(:PARTIAL_OPEN_ALONE_END))
 
         mod.module_eval(text)
-        mod.alias_method(name, "tag_#{name}")
+        aliased_method_names.each { |an| mod.alias_method(an, generated_method_name) }
+      end
+
+      def generated_method_name
+        "tag_#{name}"
+      end
+
+      def aliased_method_names
+        [ name ]
+      end
+
+      def all_method_names
+        [ generated_method_name ] + aliased_method_names
       end
 
       private

data/lib/fortitude/tags/tag_return_value.rb

@@ -2,7 +2,7 @@ require 'fortitude/errors'
 
 module Fortitude
   module Tags
-    TAG_RETURN_VALUE_SUPERCLASS = if defined?(::BasicObject) then ::BasicObject else ::Object end
+    TAG_RETURN_VALUE_SUPERCLASS = ::Object
 
     class TagReturnValue < TAG_RETURN_VALUE_SUPERCLASS
       def method_missing(name, *args)

data/lib/fortitude/tags/tag_store.rb

@@ -37,6 +37,10 @@ module Fortitude
         out
       end
 
+      def tag_names
+        tags.keys
+      end
+
       def tags_added!(tags)
         tags_changed!(tags)
       end