umlaut 4.0.3 → 4.1.0.pre.2

data/lib/umlaut/test_help.rb

@@ -0,0 +1,159 @@
+require 'vcr'
+
+module Umlaut
+  # Some methods helpful in writing automated tests against Umlaut. Used in
+  # Umlaut, can also be used in your local app or Umlaut plugin. 
+  #
+  # Add to your test_helper.rb:
+  #
+  #    require 'umlaut/test_help'
+  #    include Umlaut::TestHelp
+  module TestHelp
+    # Methods you can use to make a mocked up Rails Request and corersponding Umlaut Request
+    # Pass in a URL, absolute or partial, eg "/resolve?isbn=X"
+    def fake_rails_request(umlaut_url)  
+      # hard to figure out how to mock a request, this seems to work
+      ActionController::TestRequest.new(Rack::MockRequest.env_for(umlaut_url))    
+    end
+
+    def fake_umlaut_request(umlaut_url)
+      rails_request = fake_rails_request(umlaut_url)
+      Request.find_or_create(rails_request.params, {}, rails_request)
+    end
+
+    # The list of configured services is global state. Sometimes
+    # we want to test with a specific configuration list. An experimental
+    # hacky way to let you do that. Yes, this is a smell of a bad design,
+    # but we do what we can. 
+    #
+    # This is in progress and still needs more api, this is still too hard. 
+    def with_service_config(hash)
+      original = ServiceStore.config
+      ServiceStore.config = hash
+      yield
+    ensure
+      ServiceStore.config = original
+    end
+
+    # Assert that, for a given request, a service with a given id registered
+    # a DispatchedService with status DispatchedService::Succesful
+    #     assert_dispatched(umalut_request, "service_id")
+    #
+    # Assert that a service with a given id registered a DispatchedService
+    # with another status. 
+    #      assert_dispatched(umlaut_request, "service_id", DispatchedService::FailedTemporary)
+    def assert_dispatched(request, service_id, status = DispatchedService::Successful)
+      dispatched = request.dispatched_services.to_a.find {|ds| ds.service_id == service_id}
+
+      assert dispatched.present?, "No DispatchedService record for service_id `#{service_id}`"
+
+      if status
+        assert_equal status, dispatched.status
+      end
+    end
+
+    # Assert that for a given umlaut request, a service with a given ID
+    # recorded at least one ServiceResponse of any type:
+    #      assert_service_responses(umlaut_service, "service_id")
+    #
+    # Assert that it recorded exactly `number` of ServiceResponses
+    #      assert_service_responses(umlaut_service, 'service_id', :number => 5)
+    #
+    # Assert that it recorded some ServiceResponses, and _at least one_ of those
+    # ServiceResponses was of each of the kind(s) specified. With or without
+    # :number. 
+    #      assert_service_resposnes(umlaut_service, 'service_id', :includes_type => :fulltext)
+    #      assert_service_resposnes(umlaut_service, 'service_id', :number => 5, :includes_type => :fulltext)
+    #      assert_service_resposnes(umlaut_service, 'service_id', :number => 5, :includes_type => [:fulltext, :highlighted_link])
+    #
+    # On assertion success, the method will return the array of ServiceResponse 
+    # objects found, OR if :number => 1, the single ServiceResponse not in an array
+    # for convenience. 
+    def assert_service_responses(request, service_id, options = {})
+      number = options[:number]
+      type_names  = Array(options[:includes_type])
+
+      responses = request.service_responses.to_a.find_all {|r| r.service_id == service_id}
+
+      if number
+        assert_equal number, responses.length, "Found #{responses.length} ServiceResponses from service id `#{service_id}`, expected #{number}"
+      else
+        assert responses.length > 0, "No ServiceResponse found for service id `#{service_id}"
+      end
+
+      type_names.each do |kind|
+        assert responses.find {|sr| sr.service_type_value_name == kind.to_s}, "The generated ServiceResponses for service id `#{service_id}` must include type #{kind}" if number.to_i > 0
+      end
+
+      if number == 1
+        return responses.first
+      else
+        return responses
+      end
+
+    end
+
+    # Keep it in a seperate module so people can include just that if they want
+    # Umlaut::TestHelp::TestWithCassette. If you've already included Umlaut::TestHelp
+    # into your 
+    module TestWithCassette
+      # Helper to create a Test::Unit style test that is wrapped in
+      # VCR.use_cassette for testing. If you supply a 'group' option, 
+      # then the cassettes will be placed on the file system in a directory
+      # based on that group, and the VCR cassettes will also be tagged
+      # with that group name. 
+      #
+      # Extract this whole thing to a gem for sharing?
+      #
+      # An alternative to this method is using rspec (but not in Umlaut,
+      # we don't use rspec) OR using minitest-rails or minitest-spec-rails
+      # with minitest/spec style and the minitest-vcr gem. I've had mixed
+      # success with minitest/spec in rails. 
+      #
+      #     extend TestWithCassette
+      #     test_with_cassette("do something", :group) do
+      #       assert_...
+      #     end
+      def test_with_cassette(name, group = nil, vcr_options ={}, &block)
+        # cribbed from Rails and modified for VCR
+        # https://github.com/rails/rails/blob/b451de0d6de4df6bc66b274cec73b919f823d5ae/activesupport/lib/active_support/testing/declarative.rb#L25
+
+        test_name_safe = name.gsub(/\s+/,'_')
+
+        test_method_name = "test_#{test_name_safe}".to_sym
+
+        raise "#{test_method_name} is already defined in #{self}" if methods.include?(test_method_name)
+
+        cassette_name = vcr_options.delete(:cassette)
+        unless cassette_name
+          # calculate default cassette name from test name
+          cassette_name = test_name_safe
+          # put in group subdir if group
+          cassette_name = "#{group}/#{cassette_name}" if group
+        end
+
+        # default tag with groupname, can be over-ridden.
+        vcr_options = {:tag => group}.merge(vcr_options) if group
+
+        if block_given?
+          define_method(test_method_name) do
+            VCR.use_cassette(cassette_name , vcr_options) do
+              instance_eval &block
+            end
+          end
+        else
+          define_method(test_method_name) do
+            flunk "No implementation provided for #{name}"
+          end
+        end
+      end  
+    end
+
+  end
+end
+
+
+
+
+
+

data/lib/umlaut/version.rb

@@ -1,8 +1,8 @@
 module Umlaut
-  VERSION = "4.0.3"
+  VERSION = "4.1.0.pre.2"
 
   # This is used in Umlaut's .gemspec for generating the gem,
   # and is also used in the umlaut app generator to make sure
   # we're generating with a compatible Rails version. 
-  RAILS_COMPAT_SPEC = [">= 3.2.12", "< 4.2.0"]
+  RAILS_COMPAT_SPEC = [">= 3.2.12", "< 4.3.0"]
 end

data/lib/umlaut.rb

@@ -2,6 +2,7 @@ require 'umlaut/version'
 require 'umlaut/routes'
 require 'umlaut/util'
 
+
 # not sure why including openurl gem doesn't do the require, but it
 # seems to need this. 
 require 'openurl'
@@ -32,10 +33,41 @@ module Umlaut
       app.config.assets.precompile << "umlaut_ui.js"
     end
 
-    initializer "#{engine_name}.backtrace_cleaner" do |app|
+    initializer "#{engine_name}.preload" do
+      require 'service_type_value' # stored in lib, load it ourselves, after Umlaut::Engine is loaded
+    end
+
+    config.whitelisted_backtrace = {}
+    config.whitelisted_backtrace[self.root] = self.engine_name
 
-      engine_root_regex = Regexp.escape (self.root.to_s + File::SEPARATOR)
+    # The Rails backtrace cleaner strips some lines from exception backtraces,
+    # and prettifies the lines left. 
+    #
+    # Umlaut uses the default backtrace cleaner for cleaning backtraces
+    # for outputting in error logs in various places. 
+    #
+    # We want to make sure Umlaut lines stay in the backtrace and are prettified,
+    # so we customize the default backtrace cleaner. You can add additional
+    # gems (such as Umlaut plugins) to the whitelist of ones to keep in the
+    # backtrace, for instance a Rails engine gem might define an initializer
+    # in it's engine class, inserted to run BEFORE this one, that adds
+    # itself, like:
+    #
+    #       initializer "#{engine_name}.backtrace_cleaner", :before => "umlaut.backtrace_cleaner" do
+    #         Umlaut::Engine.config.whitelisted_backtrace[self.root] = self.engine_name
+    #       end
+    initializer "#{engine_name}.backtrace_cleaner" do |app|
+      # config.whitelisted_backtrace is a hash from root file path t
+      # short name. We want to turn the filepaths into regexes left-anchored
+      # and with trailing separator. 
+      whitelisted_path_regexes = config.whitelisted_backtrace.inject({}) do |h, (k, v)| 
+        h[/^#{Regexp.escape(k.to_s + File::SEPARATOR)}/] = v.to_s
+        h
+      end
+      union_name_re = Regexp.union whitelisted_path_regexes.values.collect {|n| /^#{Regexp.escape n}/}
+      union_path_re = Regexp.union whitelisted_path_regexes.keys
 
+      
       # Clean those ERB lines, we don't need the internal autogenerated
       # ERB method, what we do need (line number in ERB file) is already there
       Rails.backtrace_cleaner.add_filter do |line|
@@ -44,13 +76,12 @@ module Umlaut
 
       # Remove our own engine's path prefix, even if it's 
       # being used from a local path rather than the gem directory. 
-      Rails.backtrace_cleaner.add_filter do |line|
-        line.sub(/^#{engine_root_regex}/, "#{engine_name} ")
+      whitelisted_path_regexes.each_pair do |path_re, name|
+        Rails.backtrace_cleaner.add_filter do |line|
+          line.sub(path_re, "#{name} ")
+        end
       end
 
-      # This actually seemed not to be neccesary, and wasn't behaving right? Let's
-      # try without it...
-      #
       # Keep Umlaut's own stacktrace in the backtrace -- we have to remove Rails
       # silencers and re-add them how we want. 
       Rails.backtrace_cleaner.remove_silencers!
@@ -59,8 +90,8 @@ module Umlaut
       # it's from Umlaut engine
       Rails.backtrace_cleaner.add_silencer do |line|
         (line !~ Rails::BacktraceCleaner::APP_DIRS_PATTERN) &&
-        (line !~ /^#{engine_root_regex}/  ) &&
-        (line !~ /^#{engine_name} /)
+        (line !~ union_name_re  ) &&
+        (line !~ union_path_re  )
       end
     end
     
@@ -69,5 +100,9 @@ module Umlaut
     #initializer("#{engine_name}.patch_connection_pool", :before => "active_record.initialize_database") do |app|
       load File.join(self.root, "active_record_patch", "connection_pool.rb")
     #end
+
   end
 end
+
+
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: umlaut
 version: !ruby/object:Gem::Version
-  version: 4.0.3
+  version: 4.1.0.pre.2
 platform: ruby
 authors:
 - Jonathan Rochkind, et al
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-03 00:00:00.000000000 Z
+date: 2015-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -19,7 +19,7 @@ dependencies:
         version: 3.2.12
     - - <
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 4.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: 3.2.12
     - - <
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 4.3.0
 - !ruby/object:Gem::Dependency
   name: jquery-rails
   requirement: !ruby/object:Gem::Requirement
@@ -361,6 +361,7 @@ files:
 - app/helpers/umlaut/footer_helper.rb
 - app/helpers/umlaut/helper.rb
 - app/helpers/umlaut/html_head_helper.rb
+- app/helpers/umlaut/section_highlights.rb
 - app/helpers/umlaut/url_generation.rb
 - app/mailers/emailer.rb
 - app/mailers/feedback_mailer.rb
@@ -385,7 +386,6 @@ files:
 - app/models/request.rb
 - app/models/service_response.rb
 - app/models/service_store.rb
-- app/models/service_type_value.rb
 - app/models/service_wave.rb
 - app/models/sfx4/abstract/README.md
 - app/models/sfx4/abstract/az_extra_info.rb
@@ -502,6 +502,7 @@ files:
 - lib/generators/umlaut/install_generator.rb
 - lib/generators/umlaut/remove_turbolinks_generator.rb
 - lib/generators/umlaut_app_template.rb
+- lib/service_type_value.rb
 - lib/tasks/umlaut.rake
 - lib/tasks/umlaut_asset_compile.rake
 - lib/tasks/umlaut_migrate_permalinks.rake
@@ -509,6 +510,7 @@ files:
 - lib/truncate_to_db_limit.rb
 - lib/umlaut.rb
 - lib/umlaut/routes.rb
+- lib/umlaut/test_help.rb
 - lib/umlaut/util.rb
 - lib/umlaut/version.rb
 homepage: https://github.com/team-umlaut/umlaut
@@ -525,12 +527,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.4.4
 signing_key: 
 specification_version: 4
 summary: For Libraries, a just-in-time last-mile service aggregator, taking OpenURL