Module: OpenStax::Utilities

Defined in:
lib/openstax_utilities.rb,
lib/openstax_utilities.rb,
lib/openstax/utilities/enum.rb,
lib/openstax/utilities/text.rb,
lib/openstax/utilities/engine.rb,
lib/openstax/utilities/network.rb,
lib/openstax/utilities/version.rb,
lib/openstax/utilities/settings.rb,
lib/openstax/utilities/osu_helper.rb,
lib/openstax/utilities/action_list.rb,
lib/openstax/utilities/access_policy.rb,
lib/openstax/utilities/classy_helper.rb,
lib/openstax/utilities/acts_as_numberable.rb,
app/routines/openstax/utilities/order_relation.rb,
lib/openstax/utilities/delegate_access_control.rb,
app/routines/openstax/utilities/search_relation.rb,
app/routines/openstax/utilities/limit_and_paginate_relation.rb,
app/routines/openstax/utilities/search_and_organize_relation.rb,
lib/openstax/utilities/access.rb

Defined Under Namespace

Modules: Access, ActsAsNumberable, DelegateAccessControl, Helpers, OsuHelper, Settings, Text Classes: AccessPolicy, ActionList, ClassyHelper, Configuration, Engine, Enum, LimitAndPaginateRelation, OrderRelation, SearchAndOrganizeRelation, SearchRelation

Constant Summary collapse

VERSION = 
"4.2.1"

Class Method Summary collapse

Class Method Details

.configuration ⇒ Object 



51
52
53
 
# File 'lib/openstax_utilities.rb', line 51

def configuration
  @configuration ||= Configuration.new
end

.configure {|configuration| ... } ⇒ Object

Configuration machinery.

To configure OpenStax Utilities, put the following code in your applications initialization logic (eg. in the config/initializers in a Rails app)

OpenStax::Utilities.configure do |config|
  config.<parameter name> = <parameter value>
  ...
end

Yields:



47
48
49
 
# File 'lib/openstax_utilities.rb', line 47

def configure
  yield configuration
end

.generate_url(*urls) ⇒ Object 



3
4
5
6
7
8
 
# File 'lib/openstax/utilities/network.rb', line 3

def self.generate_url(*urls)
  params = urls.pop if urls.last.is_a? Hash
  uri = URI.join(*urls)
  uri.query = params.to_query if params
  uri.to_s
end