openstax_utilities 3.0.0 → 4.0.0

data/spec/lib/openstax/utilities/access_policy_spec.rb

@@ -1,11 +1,11 @@
-require 'spec_helper'
+require 'rails_helper'
 
 module OpenStax
   module Utilities
 
     describe AccessPolicy do
 
-      let!(:user) { User.create }
+      let!(:user) { FactoryGirl.create :user }
 
       it 'responds to any _allowed? calls' do
         AccessPolicy.register(User, DummyAccessPolicy)

data/spec/rails_helper.rb

@@ -0,0 +1,54 @@
+ENV["RAILS_ENV"] ||= 'test'
+
+require 'spec_helper'
+require File.expand_path("../dummy/config/environment", __FILE__)
+require 'rspec/rails'
+require 'factory_girl_rails'
+require 'faker'
+require 'squeel'
+
+# Add additional requires below this line. Rails is not loaded until this point!
+
+# Requires supporting ruby files with custom matchers and macros, etc, in
+# spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
+# run as spec files by default. This means that files in spec/support that end
+# in _spec.rb will both be required and run as specs, causing the specs to be
+# run twice. It is recommended that you do not name files matching this glob to
+# end with _spec.rb. You can configure this pattern with the --pattern
+# option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
+#
+# The following line is provided for convenience purposes. It has the downside
+# of increasing the boot-up time by auto-requiring all files in the support
+# directory. Alternatively, in the individual `*_spec.rb` files, manually
+# require only the support files necessary.
+#
+# Dir[Rails.root.join("spec/support/**/*.rb")].each { |f| require f }
+
+# Checks for pending migrations before tests are run.
+# If you are not using ActiveRecord, you can remove this line.
+ActiveRecord::Migration.maintain_test_schema!
+
+RSpec.configure do |config|
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  # config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  # config.use_transactional_fixtures = true
+
+  # RSpec Rails can automatically mix in different behaviours to your tests
+  # based on their file location, for example enabling you to call `get` and
+  # `post` in specs under `spec/controllers`.
+  #
+  # You can disable this behaviour by removing the line below, and instead
+  # explicitly tag your specs with their type, e.g.:
+  #
+  #     RSpec.describe UsersController, :type => :controller do
+  #       # ...
+  #     end
+  #
+  # The different available types are documented in the features, such as in
+  # https://relishapp.com/rspec/rspec-rails/docs
+  config.infer_spec_type_from_file_location!
+end

data/spec/routines/openstax/utilities/abstract_keyword_search_routine_spec.rb

@@ -0,0 +1,114 @@
+require 'rails_helper'
+
+module OpenStax
+  module Utilities
+    describe AbstractKeywordSearchRoutine do
+
+      let!(:john_doe) { FactoryGirl.create :user, name: "John Doe",
+                                           username: "doejohn",
+                                           email: "john@doe.com" }
+
+      let!(:jane_doe) { FactoryGirl.create :user, name: "Jane Doe",
+                                           username: "doejane",
+                                           email: "jane@doe.com" }
+
+      let!(:jack_doe) { FactoryGirl.create :user, name: "Jack Doe",
+                                           username: "doejack",
+                                           email: "jack@doe.com" }
+
+      before(:each) do
+        100.times do
+          FactoryGirl.create(:user)
+        end
+      end
+
+      it "filters results based on one field" do
+        items = SearchUsers.call('last_name:dOe').outputs[:items]
+
+        expect(items).to include(john_doe)
+        expect(items).to include(jane_doe)
+        expect(items).to include(jack_doe)
+        items.each do |item|
+          expect(item.name.downcase).to match(/\A[\w]* doe[\w]*\z/i)
+        end
+      end
+
+      it "filters results based on multiple fields" do
+        items = SearchUsers.call('first_name:jOhN last_name:DoE').outputs[:items]
+
+        expect(items).to include(john_doe)
+        expect(items).not_to include(jane_doe)
+        expect(items).not_to include(jack_doe)
+        items.each do |item|
+          expect(item.name).to match(/\Ajohn[\w]* doe[\w]*\z/i)
+        end
+      end
+
+      it "filters results based on multiple keywords per field" do
+        items = SearchUsers.call('first_name:JoHn,JaNe last_name:dOe').outputs[:items]
+
+        expect(items).to include(john_doe)
+        expect(items).to include(jane_doe)
+        expect(items).not_to include(jack_doe)
+        items.each do |item|
+          expect(item.name).to match(/\A[john|jane][\w]* doe[\w]*\z/i)
+        end
+      end
+
+      it "orders results by multiple fields in different directions" do
+        items = SearchUsers.call('username:DoE', order_by: 'cReAtEd_At AsC, iD')
+                          .outputs[:items]
+        expect(items).to include(john_doe)
+        expect(items).to include(jane_doe)
+        expect(items).to include(jack_doe)
+        john_index = items.index(john_doe)
+        jane_index = items.index(jane_doe)
+        jack_index = items.index(jack_doe)
+        expect(jane_index).to be > john_index
+        expect(jack_index).to be > jane_index
+        items.each do |item|
+          expect(item.username).to match(/\Adoe[\w]*\z/i)
+        end
+
+        items = SearchUsers.call('username:dOe', order_by: 'CrEaTeD_aT dEsC, Id DeSc')
+                          .outputs[:items]
+        expect(items).to include(john_doe)
+        expect(items).to include(jane_doe)
+        expect(items).to include(jack_doe)
+        john_index = items.index(john_doe)
+        jane_index = items.index(jane_doe)
+        jack_index = items.index(jack_doe)
+        expect(jane_index).to be < john_index
+        expect(jack_index).to be < jane_index
+        items.each do |item|
+          expect(item.username).to match(/\Adoe[\w]*\z/i)
+        end
+      end
+
+      it "paginates results" do
+        all_items = SearchUsers.call('').outputs[:items].to_a
+
+        items = SearchUsers.call('', per_page: 20).outputs[:items]
+        expect(items.limit(nil).offset(nil).count).to eq all_items.count
+        expect(items.limit(nil).offset(nil).to_a).to eq all_items
+        expect(items.count).to eq 20
+        expect(items.to_a).to eq all_items[0..19]
+
+        for page in 1..5
+          items = SearchUsers.call('', page: page, per_page: 20).outputs[:items]
+          expect(items.limit(nil).offset(nil).count).to eq all_items.count
+          expect(items.limit(nil).offset(nil).to_a).to eq all_items
+          expect(items.count).to eq 20
+          expect(items.to_a).to eq all_items.slice(20*(page-1), 20)
+        end
+
+        items = SearchUsers.call('', page: 1000, per_page: 20).outputs[:items]
+        expect(items.limit(nil).offset(nil).count).to eq all_items.count
+        expect(items.limit(nil).offset(nil).to_a).to eq all_items
+        expect(items.count).to eq 0
+        expect(items.to_a).to be_empty
+      end
+
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,16 +1,85 @@
-ENV['RAILS_ENV'] ||= 'test'
+# This file was generated by the `rails generate rspec:install` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
 
-require File.expand_path("../dummy/config/environment.rb",  __FILE__)
-require 'rspec/rails'
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
 
-Rails.backtrace_cleaner.remove_silencers!
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
 
-# Load support files
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
 
-RSpec.configure do |config|
-  config.mock_with :rspec
-  config.use_transactional_fixtures = true
-  config.infer_base_class_for_anonymous_controllers = false
-  config.order = "random"
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openstax_utilities
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 4.0.0
 platform: ruby
 authors:
 - JP Slavinsky
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-08 00:00:00.000000000 Z
+date: 2014-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,6 +24,34 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: lev
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: keyword_search
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -52,7 +80,49 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Utilities for OpenStax web sites
+- !ruby/object:Gem::Dependency
+  name: factory_girl_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: squeel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Shared utilities for OpenStax web sites
 email:
 - jps@kindlinglabs.com
 executables: []
@@ -62,9 +132,8 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- app/assets/javascripts/openstax_utilities.js
-- app/assets/stylesheets/openstax_utilities.css
-- app/helpers/openstax/utilities/osu_helper.rb
+- app/handlers/openstax/utilities/abstract_keyword_search_handler.rb
+- app/routines/openstax/utilities/abstract_keyword_search_routine.rb
 - app/views/osu/shared/_action_list.html.erb
 - lib/openstax/utilities/access.rb
 - lib/openstax/utilities/access_policy.rb
@@ -81,6 +150,7 @@ files:
 - lib/openstax/utilities/helpers/misc.rb
 - lib/openstax/utilities/helpers/partials.rb
 - lib/openstax/utilities/network.rb
+- lib/openstax/utilities/osu_helper.rb
 - lib/openstax/utilities/ruby.rb
 - lib/openstax/utilities/settings.rb
 - lib/openstax/utilities/text.rb
@@ -91,17 +161,15 @@ files:
 - spec/dummy/app/access_policies/dummy_access_policy.rb
 - spec/dummy/app/assets/javascripts/application.js
 - spec/dummy/app/assets/stylesheets/application.css
-- spec/dummy/app/assets/stylesheets/scaffold.css
 - spec/dummy/app/controllers/application_controller.rb
-- spec/dummy/app/controllers/users_controller.rb
+- spec/dummy/app/handlers/users_search.rb
 - spec/dummy/app/helpers/application_helper.rb
 - spec/dummy/app/models/user.rb
+- spec/dummy/app/routines/search_users.rb
 - spec/dummy/app/views/layouts/application.html.erb
-- spec/dummy/app/views/users/_form.html.erb
-- spec/dummy/app/views/users/edit.html.erb
-- spec/dummy/app/views/users/index.html.erb
-- spec/dummy/app/views/users/new.html.erb
-- spec/dummy/app/views/users/show.html.erb
+- spec/dummy/bin/bundle
+- spec/dummy/bin/rails
+- spec/dummy/bin/rake
 - spec/dummy/config.ru
 - spec/dummy/config/application.rb
 - spec/dummy/config/boot.rb
@@ -110,22 +178,28 @@ files:
 - spec/dummy/config/environments/development.rb
 - spec/dummy/config/environments/production.rb
 - spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/assets.rb
 - spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/cookies_serializer.rb
+- spec/dummy/config/initializers/filter_parameter_logging.rb
 - spec/dummy/config/initializers/inflections.rb
 - spec/dummy/config/initializers/mime_types.rb
-- spec/dummy/config/initializers/secret_token.rb
 - spec/dummy/config/initializers/session_store.rb
 - spec/dummy/config/initializers/wrap_parameters.rb
 - spec/dummy/config/locales/en.yml
 - spec/dummy/config/routes.rb
+- spec/dummy/config/secrets.yml
 - spec/dummy/db/migrate/0_create_users.rb
 - spec/dummy/db/schema.rb
 - spec/dummy/public/404.html
 - spec/dummy/public/422.html
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
-- spec/dummy/script/rails
+- spec/factories/user.rb
+- spec/handlers/openstax/utilities/abstract_keyword_search_handler_spec.rb
 - spec/lib/openstax/utilities/access_policy_spec.rb
+- spec/rails_helper.rb
+- spec/routines/openstax/utilities/abstract_keyword_search_routine_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/openstax/openstax_utilities
 licenses:
@@ -155,17 +229,15 @@ test_files:
 - spec/dummy/app/access_policies/dummy_access_policy.rb
 - spec/dummy/app/assets/javascripts/application.js
 - spec/dummy/app/assets/stylesheets/application.css
-- spec/dummy/app/assets/stylesheets/scaffold.css
 - spec/dummy/app/controllers/application_controller.rb
-- spec/dummy/app/controllers/users_controller.rb
+- spec/dummy/app/handlers/users_search.rb
 - spec/dummy/app/helpers/application_helper.rb
 - spec/dummy/app/models/user.rb
+- spec/dummy/app/routines/search_users.rb
 - spec/dummy/app/views/layouts/application.html.erb
-- spec/dummy/app/views/users/_form.html.erb
-- spec/dummy/app/views/users/edit.html.erb
-- spec/dummy/app/views/users/index.html.erb
-- spec/dummy/app/views/users/new.html.erb
-- spec/dummy/app/views/users/show.html.erb
+- spec/dummy/bin/bundle
+- spec/dummy/bin/rails
+- spec/dummy/bin/rake
 - spec/dummy/config/application.rb
 - spec/dummy/config/boot.rb
 - spec/dummy/config/database.yml
@@ -173,14 +245,17 @@ test_files:
 - spec/dummy/config/environments/development.rb
 - spec/dummy/config/environments/production.rb
 - spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/assets.rb
 - spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/cookies_serializer.rb
+- spec/dummy/config/initializers/filter_parameter_logging.rb
 - spec/dummy/config/initializers/inflections.rb
 - spec/dummy/config/initializers/mime_types.rb
-- spec/dummy/config/initializers/secret_token.rb
 - spec/dummy/config/initializers/session_store.rb
 - spec/dummy/config/initializers/wrap_parameters.rb
 - spec/dummy/config/locales/en.yml
 - spec/dummy/config/routes.rb
+- spec/dummy/config/secrets.yml
 - spec/dummy/config.ru
 - spec/dummy/db/migrate/0_create_users.rb
 - spec/dummy/db/schema.rb
@@ -190,6 +265,9 @@ test_files:
 - spec/dummy/public/favicon.ico
 - spec/dummy/Rakefile
 - spec/dummy/README.md
-- spec/dummy/script/rails
+- spec/factories/user.rb
+- spec/handlers/openstax/utilities/abstract_keyword_search_handler_spec.rb
 - spec/lib/openstax/utilities/access_policy_spec.rb
+- spec/rails_helper.rb
+- spec/routines/openstax/utilities/abstract_keyword_search_routine_spec.rb
 - spec/spec_helper.rb