RubyGems - openstax_utilities - Versions diffs - 3.0.0 → 4.0.0 - Mend

openstax_utilities 3.0.0 → 4.0.0

Files changed (62) hide show

checksums.yaml +8 -8
data/Rakefile +4 -3
data/app/handlers/openstax/utilities/abstract_keyword_search_handler.rb +92 -0
data/app/routines/openstax/utilities/abstract_keyword_search_routine.rb +149 -0
data/lib/openstax/utilities/delegate_access_control.rb +5 -0
data/lib/openstax/utilities/engine.rb +4 -8
data/lib/openstax/utilities/helpers/datetime.rb +4 -4
data/{app/helpers → lib}/openstax/utilities/osu_helper.rb +9 -1
data/lib/openstax/utilities/version.rb +1 -1
data/lib/openstax_utilities.rb +1 -7
data/spec/dummy/README.md +1 -1
data/spec/dummy/Rakefile +1 -2
data/spec/dummy/app/assets/javascripts/application.js +3 -5
data/spec/dummy/app/assets/stylesheets/application.css +5 -3
data/spec/dummy/app/controllers/application_controller.rb +3 -3
data/spec/dummy/app/handlers/users_search.rb +11 -0
data/spec/dummy/app/routines/search_users.rb +22 -0
data/spec/dummy/app/views/layouts/application.html.erb +2 -2
data/spec/dummy/bin/bundle +3 -0
data/spec/dummy/bin/rails +4 -0
data/spec/dummy/bin/rake +4 -0
data/spec/dummy/config.ru +1 -1
data/spec/dummy/config/application.rb +1 -37
data/spec/dummy/config/boot.rb +4 -9
data/spec/dummy/config/database.yml +8 -8
data/spec/dummy/config/environment.rb +3 -3
data/spec/dummy/config/environments/development.rb +19 -19
data/spec/dummy/config/environments/production.rb +41 -30
data/spec/dummy/config/environments/test.rb +17 -15
data/spec/dummy/config/initializers/assets.rb +8 -0
data/spec/dummy/config/initializers/cookies_serializer.rb +3 -0
data/spec/dummy/config/initializers/filter_parameter_logging.rb +4 -0
data/spec/dummy/config/initializers/inflections.rb +6 -5
data/spec/dummy/config/initializers/mime_types.rb +0 -1
data/spec/dummy/config/initializers/session_store.rb +1 -6
data/spec/dummy/config/initializers/wrap_parameters.rb +6 -6
data/spec/dummy/config/locales/en.yml +20 -2
data/spec/dummy/config/routes.rb +0 -3
data/spec/dummy/config/secrets.yml +22 -0
data/spec/dummy/db/migrate/0_create_users.rb +8 -2
data/spec/dummy/db/schema.rb +13 -7
data/spec/dummy/public/404.html +54 -13
data/spec/dummy/public/422.html +54 -13
data/spec/dummy/public/500.html +53 -12
data/spec/factories/user.rb +8 -0
data/spec/handlers/openstax/utilities/abstract_keyword_search_handler_spec.rb +93 -0
data/spec/lib/openstax/utilities/access_policy_spec.rb +2 -2
data/spec/rails_helper.rb +54 -0
data/spec/routines/openstax/utilities/abstract_keyword_search_routine_spec.rb +114 -0
data/spec/spec_helper.rb +80 -11
metadata +102 -24
data/app/assets/javascripts/openstax_utilities.js +0 -0
data/app/assets/stylesheets/openstax_utilities.css +0 -4
data/spec/dummy/app/assets/stylesheets/scaffold.css +0 -56
data/spec/dummy/app/controllers/users_controller.rb +0 -87
data/spec/dummy/app/views/users/_form.html.erb +0 -17
data/spec/dummy/app/views/users/edit.html.erb +0 -6
data/spec/dummy/app/views/users/index.html.erb +0 -21
data/spec/dummy/app/views/users/new.html.erb +0 -5
data/spec/dummy/app/views/users/show.html.erb +0 -5
data/spec/dummy/config/initializers/secret_token.rb +0 -7
data/spec/dummy/script/rails +0 -6

data/spec/dummy/app/controllers/application_controller.rb CHANGED Viewed

@@ -1,5 +1,5 @@
 class ApplicationController < ActionController::Base
-  protect_from_forgery
-  attr_accessor :current_user
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
 end

data/spec/dummy/app/handlers/users_search.rb ADDED Viewed

@@ -0,0 +1,11 @@
+# Dummy handler for testing the general keyword search
+class UsersSearch < OpenStax::Utilities::AbstractKeywordSearchHandler
+  self.search_routine = SearchUsers
+  self.max_items = 10
+  self.min_characters = 3
+  def authorized?
+    true
+  end
+end

data/spec/dummy/app/routines/search_users.rb ADDED Viewed

@@ -0,0 +1,22 @@
+# Dummy routine for testing the general keyword search
+class SearchUsers < OpenStax::Utilities::AbstractKeywordSearchRoutine
+  self.initial_relation = User.unscoped
+  self.search_proc = lambda { |with|
+    with.keyword :username do |names|
+      snames = to_string_array(names, append_wildcard: true)
+      @items = @items.where{username.like_any snames}
+    end
+    with.keyword :first_name do |names|
+      snames = to_string_array(names, append_wildcard: true)
+      @items = @items.where{name.like_any snames}
+    end
+    with.keyword :last_name do |names|
+      snames = to_string_array(names, append_wildcard: true).collect{|name| "% #{name}"}
+      @items = @items.where{name.like_any snames}
+    end
+  }
+  self.sortable_fields_map = {'name' => :name, 'created_at' => :created_at, 'id' => :id}
+end

data/spec/dummy/app/views/layouts/application.html.erb CHANGED Viewed

@@ -2,8 +2,8 @@
 <html>
 <head>
   <title>Dummy</title>
-  <%= stylesheet_link_tag    "application", :media => "all" %>
-  <%= javascript_include_tag "application" %>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
   <%= csrf_meta_tags %>
 </head>
 <body>

data/spec/dummy/bin/bundle ADDED Viewed

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails ADDED Viewed

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake ADDED Viewed

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/config.ru CHANGED Viewed

@@ -1,4 +1,4 @@
 # This file is used by Rack-based servers to start the application.
 require ::File.expand_path('../config/environment',  __FILE__)
-run Dummy::Application
+run Rails.application

data/spec/dummy/config/application.rb CHANGED Viewed

@@ -2,7 +2,7 @@ require File.expand_path('../boot', __FILE__)
 require 'rails/all'
-Bundler.require
+Bundler.require(*Rails.groups)
 require "openstax_utilities"
 module Dummy
@@ -11,16 +11,6 @@ module Dummy
     # Application configuration should go into files in config/initializers
     # -- all .rb files in that directory are automatically loaded.
-    # Custom directories with classes and modules you want to be autoloadable.
-    # config.autoload_paths += %W(#{config.root}/extras)
-    # Only load the plugins named here, in the order given (default is alphabetical).
-    # :all can be used as a placeholder for all plugins not explicitly named.
-    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
-    # Activate observers that should always be running.
-    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
     # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
     # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
     # config.time_zone = 'Central Time (US & Canada)'
@@ -28,32 +18,6 @@ module Dummy
     # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
     # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
     # config.i18n.default_locale = :de
-    # Configure the default encoding used in templates for Ruby 1.9.
-    config.encoding = "utf-8"
-    # Configure sensitive parameters which will be filtered from the log file.
-    config.filter_parameters += [:password]
-    # Enable escaping HTML in JSON.
-    config.active_support.escape_html_entities_in_json = true
-    # Use SQL instead of Active Record's schema dumper when creating the database.
-    # This is necessary if your schema can't be completely dumped by the schema dumper,
-    # like if you have constraints or database-specific column types
-    # config.active_record.schema_format = :sql
-    # Enforce whitelist mode for mass assignment.
-    # This will create an empty whitelist of attributes available for mass-assignment for all models
-    # in your app. As such, your models will need to explicitly whitelist or blacklist accessible
-    # parameters by using an attr_accessible or attr_protected declaration.
-    config.active_record.whitelist_attributes = true
-    # Enable the asset pipeline
-    config.assets.enabled = true
-    # Version of your assets, change this if you want to expire all your assets
-    config.assets.version = '1.0'
   end
 end

data/spec/dummy/config/boot.rb CHANGED Viewed

@@ -1,10 +1,5 @@
-require 'rubygems'
-gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
-if File.exist?(gemfile)
-  ENV['BUNDLE_GEMFILE'] = gemfile
-  require 'bundler'
-  Bundler.setup
-end
-$:.unshift File.expand_path('../../../../lib', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/database.yml CHANGED Viewed

@@ -3,23 +3,23 @@
 #
 #   Ensure the SQLite 3 gem is defined in your Gemfile
 #   gem 'sqlite3'
-development:
+#
+default: &default
   adapter: sqlite3
-  database: db/development.sqlite3
   pool: 5
   timeout: 5000
+development:
+  <<: *default
+  database: db/development.sqlite3
 # Warning: The database defined as "test" will be erased and
 # re-generated from your development database when you run "rake".
 # Do not set this db to the same as development or production.
 test:
-  adapter: sqlite3
+  <<: *default
   database: db/test.sqlite3
-  pool: 5
-  timeout: 5000
 production:
-  adapter: sqlite3
+  <<: *default
   database: db/production.sqlite3
-  pool: 5
-  timeout: 5000

data/spec/dummy/config/environment.rb CHANGED Viewed

@@ -1,5 +1,5 @@
-# Load the rails application
+# Load the Rails application.
 require File.expand_path('../application', __FILE__)
-# Initialize the rails application
-Dummy::Application.initialize!
+# Initialize the Rails application.
+Rails.application.initialize!

data/spec/dummy/config/environments/development.rb CHANGED Viewed

@@ -1,37 +1,37 @@
-Dummy::Application.configure do
-  # Settings specified here will take precedence over those in config/application.rb
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
   # In the development environment your application's code is reloaded on
   # every request. This slows down response time but is perfect for development
   # since you don't have to restart the web server when you make code changes.
   config.cache_classes = false
-  # Log error messages when you accidentally call methods on nil.
-  config.whiny_nils = true
+  # Do not eager load code on boot.
+  config.eager_load = false
-  # Show full error reports and disable caching
+  # Show full error reports and disable caching.
   config.consider_all_requests_local       = true
   config.action_controller.perform_caching = false
-  # Don't care if the mailer can't send
+  # Don't care if the mailer can't send.
   config.action_mailer.raise_delivery_errors = false
-  # Print deprecation notices to the Rails logger
+  # Print deprecation notices to the Rails logger.
   config.active_support.deprecation = :log
-  # Only use best-standards-support built into browsers
-  config.action_dispatch.best_standards_support = :builtin
+  # Raise an error on page load if there are pending migrations.
+  config.active_record.migration_error = :page_load
-  # Raise exception on mass assignment protection for Active Record models
-  config.active_record.mass_assignment_sanitizer = :strict
-  # Log the query plan for queries taking more than this (works
-  # with SQLite, MySQL, and PostgreSQL)
-  config.active_record.auto_explain_threshold_in_seconds = 0.5
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
-  # Do not compress assets
-  config.assets.compress = false
+  # Adds additional error checking when serving assets at runtime.
+  # Checks for improperly declared sprockets dependencies.
+  # Raises helpful error messages.
+  config.assets.raise_runtime_errors = true
-  # Expands the lines which load the assets
-  config.assets.debug = true
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
 end

data/spec/dummy/config/environments/production.rb CHANGED Viewed

@@ -1,67 +1,78 @@
-Dummy::Application.configure do
-  # Settings specified here will take precedence over those in config/application.rb
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
-  # Code is not reloaded between requests
+  # Code is not reloaded between requests.
   config.cache_classes = true
-  # Full error reports are disabled and caching is turned on
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both threaded web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+  # Full error reports are disabled and caching is turned on.
   config.consider_all_requests_local       = false
   config.action_controller.perform_caching = true
-  # Disable Rails's static asset server (Apache or nginx will already do this)
+  # Enable Rack::Cache to put a simple HTTP cache in front of your application
+  # Add `rack-cache` to your Gemfile before enabling this.
+  # For large-scale production use, consider using a caching reverse proxy like nginx, varnish or squid.
+  # config.action_dispatch.rack_cache = true
+  # Disable Rails's static asset server (Apache or nginx will already do this).
   config.serve_static_assets = false
-  # Compress JavaScripts and CSS
-  config.assets.compress = true
+  # Compress JavaScripts and CSS.
+  config.assets.js_compressor = :uglifier
+  # config.assets.css_compressor = :sass
-  # Don't fallback to assets pipeline if a precompiled asset is missed
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
   config.assets.compile = false
-  # Generate digests for assets URLs
+  # Generate digests for assets URLs.
   config.assets.digest = true
-  # Defaults to nil and saved in location specified by config.assets.prefix
-  # config.assets.manifest = YOUR_PATH
+  # `config.assets.precompile` and `config.assets.version` have moved to config/initializers/assets.rb
-  # Specifies the header that your server uses for sending files
+  # Specifies the header that your server uses for sending files.
   # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
   # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
   # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
   # config.force_ssl = true
-  # See everything in the log (default is :info)
-  # config.log_level = :debug
+  # Set to :debug to see everything in the log.
+  config.log_level = :info
-  # Prepend all log lines with the following tags
+  # Prepend all log lines with the following tags.
   # config.log_tags = [ :subdomain, :uuid ]
-  # Use a different logger for distributed setups
+  # Use a different logger for distributed setups.
   # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
-  # Use a different cache store in production
+  # Use a different cache store in production.
   # config.cache_store = :mem_cache_store
-  # Enable serving of images, stylesheets, and JavaScripts from an asset server
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
   # config.action_controller.asset_host = "http://assets.example.com"
-  # Precompile additional assets (application.js, application.css, and all non-JS/CSS are already added)
-  # config.assets.precompile += %w( search.js )
-  # Disable delivery errors, bad email addresses will be ignored
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
   # config.action_mailer.raise_delivery_errors = false
-  # Enable threaded mode
-  # config.threadsafe!
   # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
-  # the I18n.default_locale when a translation can not be found)
+  # the I18n.default_locale when a translation cannot be found).
   config.i18n.fallbacks = true
-  # Send deprecation notices to registered listeners
+  # Send deprecation notices to registered listeners.
   config.active_support.deprecation = :notify
-  # Log the query plan for queries taking more than this (works
-  # with SQLite, MySQL, and PostgreSQL)
-  # config.active_record.auto_explain_threshold_in_seconds = 0.5
+  # Disable automatic flushing of the log to improve performance.
+  # config.autoflush_log = false
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+  # Do not dump schema after migrations.
+  config.active_record.dump_schema_after_migration = false
 end

data/spec/dummy/config/environments/test.rb CHANGED Viewed

@@ -1,5 +1,5 @@
-Dummy::Application.configure do
-  # Settings specified here will take precedence over those in config/application.rb
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
   # The test environment is used exclusively to run your application's
   # test suite. You never need to work with it otherwise. Remember that
@@ -7,31 +7,33 @@ Dummy::Application.configure do
   # and recreated between test runs. Don't rely on the data there!
   config.cache_classes = true
-  # Configure static asset server for tests with Cache-Control for performance
-  config.serve_static_assets = true
-  config.static_cache_control = "public, max-age=3600"
+  # Do not eager load code on boot. This avoids loading your whole application
+  # just for the purpose of running a single test. If you are using a tool that
+  # preloads Rails for running tests, you may have to set it to true.
+  config.eager_load = false
-  # Log error messages when you accidentally call methods on nil
-  config.whiny_nils = true
+  # Configure static asset server for tests with Cache-Control for performance.
+  config.serve_static_assets  = true
+  config.static_cache_control = 'public, max-age=3600'
-  # Show full error reports and disable caching
+  # Show full error reports and disable caching.
   config.consider_all_requests_local       = true
   config.action_controller.perform_caching = false
-  # Raise exceptions instead of rendering exception templates
+  # Raise exceptions instead of rendering exception templates.
   config.action_dispatch.show_exceptions = false
-  # Disable request forgery protection in test environment
-  config.action_controller.allow_forgery_protection    = false
+  # Disable request forgery protection in test environment.
+  config.action_controller.allow_forgery_protection = false
   # Tell Action Mailer not to deliver emails to the real world.
   # The :test delivery method accumulates sent emails in the
   # ActionMailer::Base.deliveries array.
   config.action_mailer.delivery_method = :test
-  # Raise exception on mass assignment protection for Active Record models
-  config.active_record.mass_assignment_sanitizer = :strict
-  # Print deprecation notices to the stderr
+  # Print deprecation notices to the stderr.
   config.active_support.deprecation = :stderr
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
 end

data/spec/dummy/config/initializers/assets.rb ADDED Viewed

@@ -0,0 +1,8 @@
+# Be sure to restart your server when you modify this file.
+# Version of your assets, change this if you want to expire all your assets.
+Rails.application.config.assets.version = '1.0'
+# Precompile additional assets.
+# application.js, application.css, and all non-JS/CSS in app/assets folder are already added.
+# Rails.application.config.assets.precompile += %w( search.js )

data/spec/dummy/config/initializers/cookies_serializer.rb ADDED Viewed

@@ -0,0 +1,3 @@
+# Be sure to restart your server when you modify this file.
+Rails.application.config.action_dispatch.cookies_serializer = :json

data/spec/dummy/config/initializers/filter_parameter_logging.rb ADDED Viewed

@@ -0,0 +1,4 @@
+# Be sure to restart your server when you modify this file.
+# Configure sensitive parameters which will be filtered from the log file.
+Rails.application.config.filter_parameters += [:password]

data/spec/dummy/config/initializers/inflections.rb CHANGED Viewed

@@ -1,15 +1,16 @@
 # Be sure to restart your server when you modify this file.
-# Add new inflection rules using the following format
-# (all these examples are active by default):
-# ActiveSupport::Inflector.inflections do |inflect|
+# Add new inflection rules using the following format. Inflections
+# are locale specific, and you may define rules for as many different
+# locales as you wish. All of these examples are active by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
 #   inflect.plural /^(ox)$/i, '\1en'
 #   inflect.singular /^(ox)en/i, '\1'
 #   inflect.irregular 'person', 'people'
 #   inflect.uncountable %w( fish sheep )
 # end
-#
 # These inflection rules are supported but not enabled by default:
-# ActiveSupport::Inflector.inflections do |inflect|
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
 #   inflect.acronym 'RESTful'
 # end