fortitude 0.0.10 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8bb4132288b19b7135818f839fdad33953691ae3
-  data.tar.gz: ec5255b4ff32bc3415f71598b23bd08e234b23c9
+  metadata.gz: ef3f1d9ea4fed42b18ff222ae38850effb0f9fae
+  data.tar.gz: 555f72bda0961a863c4c418ffe59fbaee11250cd
 SHA512:
-  metadata.gz: 3479f4ef5ad1ba1a8bd09eb0a0f22f1359817dc9e60835ec88ffdd4533b3c1a1be0afe2fc643a2879478351dfbd20f02b502e45f197b23dec52e7d8c035bc559
-  data.tar.gz: 7fed6d1581ab88a136174d0930a576dde5659a53cc6510822da2f0b47dfaf49f24eabbb50c6ca5ad5ee2792a35ee24c11e378e6dca333ad45fc9a9194d79270c
+  metadata.gz: e4491a8d9a39112a5ba3b39ae093d2d312eb1507eab816fe13846c7b8d92f4fc4239057f9751ab1019462795d5c19f3994d9ceb56dd9eaf76934be7e41339686
+  data.tar.gz: 9308e4d70f1cc45765e731983d02262dbab9988bb59a0092ef78c701196ec2e76a1025331c288ebafaa16ccfa340e0ba8ec1bc19590165e9c413475feff37c5f

data/CHANGES.md

@@ -1,5 +1,16 @@
 # Fortitude Releases
 
+## 0.9.0, 29 November 2014
+
+Updated Fortitude's version number to 0.9.0: at this point, Fortitude should be considered fully production-ready,
+as it is used successfully in multiple very large systems and bug reports are increasingly rare. I don't want to
+release a 1.0 until there's excellent documentation, but the codebase seems to be ready.
+
+* Added explicit support for eager-loading Fortitude widget classes under `views/` for Rails applications. This both
+  should improve first-run performance of Fortitude-using Rails applications in production, and should avoid an
+  occasional problem where Fortitude widget classes were not properly loaded in environments that used eager loading,
+  rather than autoloading, for classes.
+
 ## 0.0.10, 25 November 2014
 
 * Fixed an issue where `#capture` was not working properly if you rendered a widget using `render :widget =>` in a

data/Gemfile

@@ -5,3 +5,4 @@ gemspec
 
 gem 'erector'
 # gem 'erector-rails4', :path => '../erector-rails4'
+gem 'oop_rails_server', :path => '../oop_rails_server'

data/lib/fortitude/extensions/native_extensions.rb

@@ -17,7 +17,8 @@ else
   rescue LoadError => le
     $stderr.puts <<-EOM
 WARNING: The Fortitude gem cannot load its native extensions. Performance may be reduced by a factor of 3-5x!
-         Load path: #{$:.inspect}
+         Load path:
+            #{$:.join("\n            ")}
          Error: #{le.message} (#{le.class})
 EOM
     native_loaded = false

data/lib/fortitude/rails/railtie.rb

@@ -71,6 +71,10 @@ module Fortitude
         ::ActiveSupport::Dependencies.module_eval do
           @@_fortitude_views_root = views_root
 
+          def self._fortitude_views_root
+            @@_fortitude_views_root
+          end
+
           # This is the method that gets called to auto-generate namespacing empty
           # modules (_e.g._, the toplevel <tt>Views::</tt> module) for directories
           # under an autoload path.
@@ -176,8 +180,54 @@ module Fortitude
           alias_method_chain :search_for_file, :fortitude
         end
 
+        # Two important comments here:
+        #
+        # 1: We also need to patch ::Rails::Engine.eager_load! so that it loads classes under app/views/. However, we
+        # can't just add it to the normal eager load paths, because that will allow people to do "require 'foo/bar'"
+        # and have it match app/views/foo/bar.rb, which we don't want. So, instead, we load these classes ourselves.
+        # Note that we ALSO have to do things slightly differently than Rails does it, because we need to skip loading
+        # 'foo.rb' if 'foo.html.rb' exists -- and because we have to require the fully-qualified pathname, since
+        # app/views is not actually on the load path.
+        #
+        # 2: I (ageweke) added this very late in the path of Fortitude development, after trying to use Fortitude in a
+        # deployment (production) environment in which widgets just weren't getting loaded at all. Yet there's something
+        # I don't understand: clearly, without this code, widgets will not be eager-loaded (which is probably not a
+        # great thing for performance reasons)...but I think they still should get auto-loaded and hence actually work
+        # just fine. But they don't in that environment (you'll get errors like "uninitialized constant Views::Base").
+        # Since I understand what's going on and have the fix for it here, that's fine...except that I can't seem to
+        # write a spec for it, because I don't know how to actually *make* it fail. If anybody comes along later and
+        # knows what would make it fail (and I double-checked, and we don't have autoloading disabled in production or
+        # anything like that), let me know, so that I can write a spec for this. Thanks!
+        ::Rails::Engine.class_eval do
+          def eager_load_with_fortitude!
+            eager_load_without_fortitude!
+            eager_load_fortitude_views!
+          end
+
+          def eager_load_fortitude_views!
+            load_path = ::ActiveSupport::Dependencies._fortitude_views_root
+            all_files = Dir.glob("#{load_path}/**/*.rb")
+            matcher = /\A#{Regexp.escape(load_path.to_s)}\/(.*)\.rb\Z/
+
+            all_files.sort.each do |full_path|
+              filename = File.basename(full_path, ".rb")
+              directory = File.dirname(full_path)
+
+              longer_name_regex = /^#{Regexp.escape(filename)}\..+\.rb$/i
+              longer_name = Dir.entries(directory).detect { |e| e =~ longer_name_regex }
+
+              unless longer_name
+                require_dependency File.join('views', full_path.sub(matcher, '\1'))
+              end
+            end
+          end
+
+          alias_method_chain :eager_load!, :fortitude
+        end
+
         # And, finally, this is where we add our root to the set of autoload paths.
         ::ActiveSupport::Dependencies.autoload_paths << views_root
+        # app.config.eager_load_paths << views_root
 
         # This is our support for partials. Fortitude doesn't really have a distinction between
         # partials and "full" templates -- everything is just a widget, which is much more elegant --

data/lib/fortitude/version.rb

@@ -1,3 +1,3 @@
 module Fortitude
-  VERSION = "0.0.10"
+  VERSION = "0.9.0"
 end

data/spec/rails/class_loading_system_spec.rb

@@ -1,11 +1,6 @@
 describe "Rails class-loading support", :type => :rails do
   uses_rails_with_template :class_loading_system_spec
 
-  it "should not load classes under app/views without the Views:: prefix" do
-    expect_exception('the_class_should_not_load', 'NameError',
-      /uninitialized constant ClassLoadingSystemSpec::ClassShouldNotLoad/i)
-  end
-
   it "should allow me to define classes under Views:: outside of app/views, like in lib/views" do
     expect_match('lib_views', /hello: i am lib\/views/)
   end
@@ -53,9 +48,9 @@ describe "Rails class-loading support", :type => :rails do
     expect_match('bar', /bar WITH html/)
   end
 
-  # it "should not let me define a widget in a file starting with an underscore, and autoload it" do
-  #   expect_exception('underscore_widget', 'NameError', /uninitialized constant Views::ClassLoadingSystemSpec::UnderscoreWidget/)
-  # end
+  it "should let me define a widget in a file starting with an underscore, and autoload it" do
+    expect_match('underscore_widget_surrounding', /surrounding_widget before.*this is underscore_widget.*surrounding_widget after/)
+  end
 
   it "should not let me 'require' files in app/views without a views/ prefix" do
     expect_exception('require_loaded_underscore_widget_without_views', 'LoadError', /(cannot load such file|no such file to load)/)
@@ -68,4 +63,8 @@ describe "Rails class-loading support", :type => :rails do
   it "should let me render a widget defined outside of app/views/ if I use render :widget" do
     expect_match('render_widget_outside_app_views', /arbitrary_name_some_widget/)
   end
+
+  it "should not load view classes with any module nesting applied" do
+    expect_match('show_module_nesting', /module_nesting: \[\]/)
+  end
 end

data/spec/rails/development_mode_system_spec.rb

@@ -23,6 +23,11 @@ describe "Rails development-mode support", :type => :rails do
     expect_match("reload_widget_with_html_extension", /with_html_extension.*helper: yo/)
   end
 
+  it "should not autoload classes that live under views/ but don't start with a Views:: prefix" do
+    expect_exception('the_class_should_not_load', 'NameError',
+      /uninitialized constant DevelopmentModeSystemSpec::ClassShouldNotLoad/i)
+  end
+
   it "should let you change the controller, and that should work fine, too" do
     expect(rails_server.get("replaced/reload_widget")).to match(/datum\s+one\s+datum/)
     sleep 1

data/spec/rails/templates/class_loading_system_spec/app/controllers/class_loading_system_spec_controller.rb

@@ -1,8 +1,4 @@
 class ClassLoadingSystemSpecController < ApplicationController
-  def the_class_should_not_load
-    render :text => ::ClassLoadingSystemSpec::ClassShouldNotLoad.name
-  end
-
   def lib_views
     # nothing here
   end
@@ -53,6 +49,10 @@ class ClassLoadingSystemSpecController < ApplicationController
     # nothing here
   end
 
+  def underscore_widget_surrounding
+    # nothing here
+  end
+
   def foo
     # nothing here
   end
@@ -75,4 +75,8 @@ class ClassLoadingSystemSpecController < ApplicationController
     require 'arbitrary_name/some_widget'
     render :widget => ArbitraryName::SomeWidget.new
   end
+
+  def show_module_nesting
+    # nothing here
+  end
 end

data/spec/rails/templates/class_loading_system_spec/app/views/class_loading_system_spec/show_module_nesting.rb

@@ -0,0 +1,7 @@
+$_show_module_nesting = Module.nesting
+
+class Views::ClassLoadingSystemSpec::ShowModuleNesting < Fortitude::Widgets::Html5
+  def content
+    text "module_nesting: #{$_show_module_nesting.inspect}"
+  end
+end

data/spec/rails/templates/class_loading_system_spec/app/views/class_loading_system_spec/underscore_widget.rb

@@ -0,0 +1,5 @@
+class Views::ClassLoadingSystemSpec::UnderscoreWidget < Fortitude::Widgets::Html5
+  def content
+    text "this is underscore_widget"
+  end
+end

data/spec/rails/templates/class_loading_system_spec/app/views/class_loading_system_spec/underscore_widget_surrounding.rb

@@ -0,0 +1,7 @@
+class Views::ClassLoadingSystemSpec::UnderscoreWidgetSurrounding < Fortitude::Widgets::Html5
+  def content
+    text "surrounding_widget before"
+    widget Views::ClassLoadingSystemSpec::UnderscoreWidget
+    text "surrounding_widget after"
+  end
+end

data/spec/rails/templates/development_mode_system_spec/app/controllers/development_mode_system_spec_controller.rb

@@ -1,4 +1,8 @@
 class DevelopmentModeSystemSpecController < ApplicationController
+  def the_class_should_not_load
+    render :text => ::DevelopmentModeSystemSpec::ClassShouldNotLoad.name
+  end
+
   def reload_widget
     @datum = "one"
   end

data/spec/rails/templates/{class_loading_system_spec/app/views/class_loading_system_spec → development_mode_system_spec/app/views/development_mode_system_spec}/class_should_not_load.rb

@@ -1,4 +1,4 @@
-module ClassLoadingSystemSpec
+module DevelopmentModeSystemSpec
   class ClassShouldNotLoad
     class << self
       def is_loaded

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fortitude
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.9.0
 platform: ruby
 authors:
 - Andrew Geweke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-25 00:00:00.000000000 Z
+date: 2014-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -277,9 +277,11 @@ files:
 - spec/rails/templates/class_loading_system_spec/app/views/class_loading_system_spec/autoload_one_widget_from_another.rb
 - spec/rails/templates/class_loading_system_spec/app/views/class_loading_system_spec/bar.html.rb
 - spec/rails/templates/class_loading_system_spec/app/views/class_loading_system_spec/bar.rb
-- spec/rails/templates/class_loading_system_spec/app/views/class_loading_system_spec/class_should_not_load.rb
 - spec/rails/templates/class_loading_system_spec/app/views/class_loading_system_spec/foo.rb
 - spec/rails/templates/class_loading_system_spec/app/views/class_loading_system_spec/lib_views.rb
+- spec/rails/templates/class_loading_system_spec/app/views/class_loading_system_spec/show_module_nesting.rb
+- spec/rails/templates/class_loading_system_spec/app/views/class_loading_system_spec/underscore_widget.rb
+- spec/rails/templates/class_loading_system_spec/app/views/class_loading_system_spec/underscore_widget_surrounding.rb
 - spec/rails/templates/class_loading_system_spec/app/views/class_loading_system_spec/use_lib_widget_from_view_widget.rb
 - spec/rails/templates/class_loading_system_spec/app/views/class_loading_system_spec/use_models_widget_from_view_widget.rb
 - spec/rails/templates/class_loading_system_spec/app/views/some_namespace/some_other_namespace/.git_keep
@@ -340,6 +342,7 @@ files:
 - spec/rails/templates/development_mode_system_spec/app/views/development_mode_mailer/mailer_formatting_test.rb
 - spec/rails/templates/development_mode_system_spec/app/views/development_mode_mailer/mailer_layout_test.rb
 - spec/rails/templates/development_mode_system_spec/app/views/development_mode_mailer/mailer_view_test.rb
+- spec/rails/templates/development_mode_system_spec/app/views/development_mode_system_spec/class_should_not_load.rb
 - spec/rails/templates/development_mode_system_spec/app/views/development_mode_system_spec/form.rb
 - spec/rails/templates/development_mode_system_spec/app/views/development_mode_system_spec/mailer_formatting_test.rb
 - spec/rails/templates/development_mode_system_spec/app/views/development_mode_system_spec/mailer_layout_test.rb
@@ -622,9 +625,11 @@ test_files:
 - spec/rails/templates/class_loading_system_spec/app/views/class_loading_system_spec/autoload_one_widget_from_another.rb
 - spec/rails/templates/class_loading_system_spec/app/views/class_loading_system_spec/bar.html.rb
 - spec/rails/templates/class_loading_system_spec/app/views/class_loading_system_spec/bar.rb
-- spec/rails/templates/class_loading_system_spec/app/views/class_loading_system_spec/class_should_not_load.rb
 - spec/rails/templates/class_loading_system_spec/app/views/class_loading_system_spec/foo.rb
 - spec/rails/templates/class_loading_system_spec/app/views/class_loading_system_spec/lib_views.rb
+- spec/rails/templates/class_loading_system_spec/app/views/class_loading_system_spec/show_module_nesting.rb
+- spec/rails/templates/class_loading_system_spec/app/views/class_loading_system_spec/underscore_widget.rb
+- spec/rails/templates/class_loading_system_spec/app/views/class_loading_system_spec/underscore_widget_surrounding.rb
 - spec/rails/templates/class_loading_system_spec/app/views/class_loading_system_spec/use_lib_widget_from_view_widget.rb
 - spec/rails/templates/class_loading_system_spec/app/views/class_loading_system_spec/use_models_widget_from_view_widget.rb
 - spec/rails/templates/class_loading_system_spec/app/views/some_namespace/some_other_namespace/.git_keep
@@ -685,6 +690,7 @@ test_files:
 - spec/rails/templates/development_mode_system_spec/app/views/development_mode_mailer/mailer_formatting_test.rb
 - spec/rails/templates/development_mode_system_spec/app/views/development_mode_mailer/mailer_layout_test.rb
 - spec/rails/templates/development_mode_system_spec/app/views/development_mode_mailer/mailer_view_test.rb
+- spec/rails/templates/development_mode_system_spec/app/views/development_mode_system_spec/class_should_not_load.rb
 - spec/rails/templates/development_mode_system_spec/app/views/development_mode_system_spec/form.rb
 - spec/rails/templates/development_mode_system_spec/app/views/development_mode_system_spec/mailer_formatting_test.rb
 - spec/rails/templates/development_mode_system_spec/app/views/development_mode_system_spec/mailer_layout_test.rb