3 |
8 |
20 |
5 | {% endif %}
6 | {{ title }}
7 | {% for p in paragraphs %}
8 |
14 |
--------------------------------------------------------------------------------
/regulations/static/regulations/js/source/models/sidebar-model.js:
--------------------------------------------------------------------------------
1 | 'use strict';
2 | var _ = require( 'underscore' );
3 | var Backbone = require( 'backbone' );
4 | var MetaModel = require( './meta-model' );
5 |
6 | Backbone.SidebarModel = MetaModel.extend( {} );
7 |
8 | var sidebarModel = new Backbone.SidebarModel( {
9 | supplementalPath: 'sidebar'
10 | } );
11 |
12 | module.exports = sidebarModel;
13 |
--------------------------------------------------------------------------------
/regulations/templates/regulations/chrome-search.html:
--------------------------------------------------------------------------------
1 | {% extends "regulations/chrome-empty-sidebar.html" %}
2 |
3 | {% block title %}
4 | Search of {{reg_part}} for {{q}} | eRegulations
5 | {% endblock %}
6 |
7 | {% block active_title %}
8 |
9 | Search results {{ results.total_hits }} result{{ results.total_hits|pluralize }}
10 |
11 | {% endblock %}
12 |
--------------------------------------------------------------------------------
/regulations/templates/regulations/specific/landing_1006.html:
--------------------------------------------------------------------------------
1 | {% extends "regulations/landing_base.html" %}
2 |
3 |
4 | {% block reg_title %}
5 | {{ p }}
9 | {% endfor %} 10 | {% for child_html in children %} 11 | {{ child_html | safe }} 12 | {% endfor %} 13 |Regulation F establishes procedures and criteria whereby states may apply to the Bureau for exemption of a class of debt collection practices within the applying state from the provisions of the Fair Debt Collection Practices Act.
6 | {% endblock %} -------------------------------------------------------------------------------- /regulations/templates/regulations/subpart.html: -------------------------------------------------------------------------------- 1 | {% comment %} 2 | Top-level subparts (which contain regulation text) 3 | {% endcomment %} 4 | 5 | {% if c.node_type == 'subpart' or c.node_type == 'emptypart' %} 6 | {% for section in c.children %} 7 | {% with c=section %} 8 | {% include "regulations/regulation_text.html" %} 9 | {% endwith %} 10 | {% endfor %} 11 | {% endif %} 12 | -------------------------------------------------------------------------------- /regulations/static/regulations/js/source/models/definition-model.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | var _ = require( 'underscore' ); 3 | var Backbone = require( 'backbone' ); 4 | var MetaModel = require( './meta-model' ); 5 | 6 | Backbone.DefinitionModel = MetaModel.extend( {} ); 7 | 8 | var definitionModel = new Backbone.DefinitionModel( { 9 | supplementalPath: 'definition' 10 | } ); 11 | 12 | module.exports = definitionModel; 13 | -------------------------------------------------------------------------------- /regulations/static/regulations/js/unittests/setup.js: -------------------------------------------------------------------------------- 1 | if (typeof process === 'object') { 2 | // Initialize node environment 3 | global.chai = require('chai'); 4 | global.expect = require('chai').expect; 5 | var plugin = require("chai-jq"); 6 | global.chai.use(plugin); 7 | 8 | require('jsdom-global')(); 9 | } else { 10 | window.expect = window.chai.expect; 11 | window.require = function() { /* noop */ }; 12 | } 13 | -------------------------------------------------------------------------------- /regulations/templates/regulations/specific/landing_1009.html: -------------------------------------------------------------------------------- 1 | {% extends "regulations/landing_base.html" %} 2 | 3 | 4 | {% block reg_title %} 5 |Regulation I applies to all depository institutions lacking Federal deposit insurance. It requires the disclosure of certain insurance-related information in periodic statements, account records, locations where deposits are normally received, and advertising.
6 | {% endblock %} -------------------------------------------------------------------------------- /dummy_api/start.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | git clone https://github.com/cfpb/regulations-core.git 3 | cd regulations-core 4 | pip install -r requirements.txt 5 | 6 | python manage.py syncdb 7 | python manage.py migrate 8 | python manage.py runserver 8282 & 9 | sleep 5 # give django enough time to startup 10 | 11 | # Load the data 12 | cd ../dummy_api 13 | for TAIL in $(find */* -type f | sort -r) 14 | do 15 | curl -X PUT http://localhost:8282/$TAIL -d @$TAIL 16 | done 17 | -------------------------------------------------------------------------------- /regulations/templates/regulations/landing_internal_disclaimer.html: -------------------------------------------------------------------------------- 1 | {% extends "regulations/landing_base.html" %} 2 | 3 | {% block reg_main_content %} 4 |Warning
5 |This content has only been vetted by a single developer. While it is 6 | usable, it may contain errors.
7 | 8 | {% block known_issues %} 9 |Known Issues
10 |-
11 |
- Indentation in appendix C may not be correct 12 |
Regulation 1081 prescribe rules of practice and procedure applicable to adjudication proceedings authorized by section 1053 of the Dodd-Frank Wall Street Reform and Consumer Protection Act of 2010 (Dodd-Frank Act) to ensure or enforce compliance with the provisions of Title X of the Dodd-Frank Act.
6 | {% endblock %} 7 | -------------------------------------------------------------------------------- /regulations/templates/regulations/sxs_with_disclaimer.html: -------------------------------------------------------------------------------- 1 | {% extends "regulations/paragraph-sxs.html" %} 2 | 3 | {% block sxs_disclaimer %} 4 |Legal Disclaimer:
5 |6 | All information in this part of the tool comes from CFPB preambles published on 7 | or after December 22, 2011. There may be other relevant analyses for this 8 | paragraph in other Federal Register notices. Please consult the Federal Register for 9 | additional information. 10 |
11 | {% endblock %} 12 | -------------------------------------------------------------------------------- /regulations/views/about.py: -------------------------------------------------------------------------------- 1 | from django.http import HttpResponse 2 | from django.template import RequestContext 3 | from django.template.loader import select_template 4 | from regulations.views import utils 5 | 6 | def about(request): 7 | context = {} 8 | utils.add_extras(context) 9 | c = RequestContext(request, context) 10 | t = select_template([ 11 | 'regulations/custom-about.html', 12 | 'regulations/about.html']) 13 | return HttpResponse(t.render(c)) 14 | -------------------------------------------------------------------------------- /regulations/templates/regulations/tree-with-wrapper.html: -------------------------------------------------------------------------------- 1 | {% comment %} 2 | Wrap tree.html in a list item. 3 | {% endcomment %} 4 | 5 |Regulation H enhances consumer protection and reduce fraud by directing states to adopt minimum uniform standards for the licensing and registration of residential mortgage loan originators and to participate in a nationwide mortgage licensing system and registry database of residential mortgage loan originators.
6 | {% endblock %} -------------------------------------------------------------------------------- /regulations/templates/regulations/layers/graphics.html: -------------------------------------------------------------------------------- 1 | {% load static from staticfiles %} 2 | 3 | {% comment %} 4 | Model form images 5 | {% endcomment %} 6 | 7 | 8 |
6 |
7 | We’re working on incorporating amendments to this regulation.
8 |
9 | In the meantime, please review
10 |
11 | CFPB rules recently published in the Federal Register.
12 |
13 |
--------------------------------------------------------------------------------
/docs/index.rst:
--------------------------------------------------------------------------------
1 | .. regulations documentation master file, created by
2 | sphinx-quickstart on Thu Jul 3 16:47:19 2014.
3 | You can adapt this file completely to your liking, but it should at least
4 | contain the root `toctree` directive.
5 |
6 | Welcome to regulations's documentation!
7 | =======================================
8 |
9 | Contents:
10 |
11 | .. toctree::
12 | :maxdepth: 4
13 |
14 | regulations
15 |
16 |
17 | Indices and tables
18 | ==================
19 |
20 | * :ref:`genindex`
21 | * :ref:`modindex`
22 | * :ref:`search`
23 |
24 |
--------------------------------------------------------------------------------
/regulations/static/regulations/css/less/media-queries.less:
--------------------------------------------------------------------------------
1 | /*
2 | Media Queries
3 | ==========================================================================
4 | media-queries.less imports layout and typographic media queries
5 | media-queries that are specific to modules/functionality may be located within the appropriate .less file
6 | */
7 |
8 | @import "breakpoints/min-width-1100.less";
9 | @import "breakpoints/max-width-1100.less";
10 | @import "breakpoints/max-width-780.less";
11 | @import "breakpoints/max-width-600.less";
12 | @import "breakpoints/max-width-480.less";
--------------------------------------------------------------------------------
/regulations/static/regulations/css/less/module/expandables.less:
--------------------------------------------------------------------------------
1 | .expandable {
2 | &:hover {
3 | background-color: @gray-10;
4 | cursor: pointer;
5 | }
6 | }
7 |
8 | .expand-button {
9 | color: @pacific;
10 | .avenir-next-demi;
11 | display: inline-block;
12 | text-transform: uppercase;
13 | font-size: .8em;
14 | cursor: pointer;
15 | }
16 |
17 | .expand-button:before {
18 | .cf-icon;
19 | content: "\e109";
20 | float: right;
21 | padding-left: 6px;
22 | }
23 |
24 | .open.expand-button:before {
25 | content: "\e111";
26 | }
27 |
--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
1 | language: python
2 | sudo: false
3 | python:
4 | - '2.7'
5 | before_install:
6 | - nvm use 6
7 | - npm install -g grunt-cli
8 | install:
9 | - pip install tox
10 | - ./frontendbuild.sh
11 | script:
12 | - tox
13 | - python2.7 setup.py bdist_wheel
14 | deploy:
15 | provider: releases
16 | skip_cleanup: true
17 | api_key:
18 | secure: NP1/DVXR4hpBiQWOADLoSqMPFrxzZUBUfwuGTwzIosH6+J10hesAki7HBBs6EFIlwaAisaA2Ygpcr8v4CA+Yi6C8bSgVJZL6oW1YRwLlQaOlJITHni21pyL+FcBZw1TEWaO+E8sPUMYvmjpWfgsvZsuAHbS6tVIVuYuFXHlRs9o=
19 | file_glob: true
20 | file: dist/*.whl
21 | on:
22 | tags: true
23 |
--------------------------------------------------------------------------------
/regulations/templates/regulations/interpretations.html:
--------------------------------------------------------------------------------
1 | {% comment %}
2 | For interpretations that appear in their natural place in the reg text
3 | {% endcomment %}
4 |
5 | {% if c.node_type == "interp" %}
6 | {{item.label|safe|upper}} - {{item.sub_label|safe}}
Section does not exist.
4 | 5 |Section {{reg_section}} does not exist in the regulation effective {{effective_date|date}}.
6 | 7 |-
8 |
- Try a different effective date of the regulation 9 |
- View another section of the regulation 10 |
- Or, try searching the regulation 11 |
5 |
6 |
7 | {% for row in header %}
8 |
22 |
23 |
--------------------------------------------------------------------------------
/regulations/tests/base_template_test.py:
--------------------------------------------------------------------------------
1 | from unittest import TestCase
2 | from django.template import RequestContext
3 | from django.template.loader import get_template
4 | from django.test import RequestFactory
5 |
6 |
7 | class TemplateTest(TestCase):
8 | def test_title_in_base(self):
9 | context = {
10 | 'env': 'dev',
11 | 'reg_part': '204',
12 | 'meta': {'cfr_title_number': '2'}}
13 | request = RequestFactory().get('/fake-path')
14 | c = RequestContext(request, context)
15 | t = get_template('regulations/base.html')
16 | rendered = t.render(c)
17 |
18 | title = '2 CFR Part 204 | eRegulations'
19 | self.assertTrue(title in rendered)
20 |
--------------------------------------------------------------------------------
/regulations/templates/regulations/logo.html:
--------------------------------------------------------------------------------
1 | {% comment %}
2 | Logo image/text. Expected to be overwritten.
3 | {% endcomment %}
4 |
5 | {% load static from staticfiles %}
6 |
7 |
8 | | {{ th.text }} | 11 | {% endfor %} 12 |
|---|
| {{ td }} | {% endfor %} 19 |
16 |
17 |
--------------------------------------------------------------------------------
/regulations/static/regulations/css/less/module/error.less:
--------------------------------------------------------------------------------
1 | /*
2 | Error.less
3 | ==========================================================================
4 | error.less contains styles for the generic 404, history 404, and 500 pages
5 | */
6 |
7 | .error {
8 |
9 | ul {
10 | padding: 0;
11 | }
12 |
13 | p,
14 | li {
15 | .avenir-next;
16 | }
17 |
18 | h3 {
19 | font-size: 1.75em;
20 | }
21 |
22 | .cf-icon-table-of-contents,
23 | .cf-icon-history,
24 | .cf-icon-search {
25 | color: @gray;
26 | margin-right: 10px;
27 | }
28 |
29 | .cf-icon-history,
30 | .cf-icon-table-of-contents {
31 | font-size: 1.1em;
32 | }
33 | }
34 |
35 | .section-not-found {
36 | margin: 40px 0 300px 0;
37 | }
--------------------------------------------------------------------------------
/regulations/static/regulations/js/unittests/specs/views/sidebar/sidebar-view-spec.js:
--------------------------------------------------------------------------------
1 | require('../../../setup');
2 | var sinon = require( 'sinon' );
3 |
4 | describe('Sidebar View:', function() {
5 |
6 | var view, definition, $, SidebarView;
7 |
8 | before(function() {
9 | $ = require('jquery');
10 | SidebarView = require('../../../../source/views/sidebar/sidebar-view');
11 | });
12 |
13 | beforeEach(function(){
14 |
15 | $( 'body' ).html(
16 | ''
17 | );
18 |
19 | function sidebarModelMock () {
20 |
21 | }
22 |
23 |
24 | // create a new instance of the view
25 | view = new SidebarView();
26 |
27 | });
28 |
29 | it('should construct a view', function() {
30 | expect(view).to.be.defined;
31 | });
32 |
33 | });
34 |
--------------------------------------------------------------------------------
/regulations/static/regulations/js/source/models/search-model.js:
--------------------------------------------------------------------------------
1 | 'use strict';
2 | var _ = require( 'underscore' );
3 | var Backbone = require( 'backbone' );
4 | var MetaModel = require( './meta-model' );
5 |
6 | Backbone.SearchModel = MetaModel.extend( {} );
7 |
8 | var searchModel = new Backbone.SearchModel( {
9 | supplementalPath: 'search',
10 |
11 | getAJAXUrl: function( id ) {
12 | var url,
13 | urlPrefix = window.APP_PREFIX;
14 |
15 | if ( urlPrefix ) {
16 | url = urlPrefix + 'partial/';
17 | }
18 | else {
19 | url = '/partial/';
20 | }
21 |
22 | if ( typeof this.supplementalPath !== 'undefined' ) {
23 | url += this.supplementalPath + '/';
24 | }
25 |
26 | url += id;
27 |
28 | return url;
29 | }
30 | } );
31 |
32 | module.exports = searchModel;
33 |
--------------------------------------------------------------------------------
/regulations/static/regulations/js/source/views/sidebar/sidebar-module-view.js:
--------------------------------------------------------------------------------
1 | 'use strict';
2 | var $ = require( 'jquery' );
3 | var _ = require( 'underscore' );
4 | var Backbone = require( 'backbone' );
5 | var RegModel = require( '../../models/reg-model' );
6 | Backbone.$ = $;
7 |
8 | var SidebarModuleView = Backbone.View.extend( {
9 | initialize: function() {
10 | var field;
11 | this.model = {};
12 |
13 | for ( field in this.options ) {
14 | if ( this.options.hasOwnProperty( field ) ) {
15 | this.model[field] = this.options[field];
16 | }
17 | }
18 |
19 | this.model.content = RegModel.get( this.model.id, this.render );
20 |
21 | return this;
22 | },
23 |
24 | render: function() {
25 | this.$el.html( this.model.content );
26 | }
27 | } );
28 |
29 | module.exports = SidebarModuleView;
30 |
--------------------------------------------------------------------------------
/regulations/tests/layers_definitions_tests.py:
--------------------------------------------------------------------------------
1 | from unittest import TestCase
2 |
3 | from regulations.generator.layers.definitions import DefinitionsLayer
4 |
5 |
6 | class DefinitionsLayerTest(TestCase):
7 | def test_create_definition_link(self):
8 | layer = {
9 | '202-3': {'ref': 'account:202-2-a'},
10 | 'referenced': {'account:202-2-a': {'reference': '202-2-a'}}
11 | }
12 | dl = DefinitionsLayer(layer)
13 | definition_link = dl.create_definition_link('account',
14 | ['202', '3'], 'account')
15 |
16 | url = '
15 | {{ partial_content|safe }}
20 |
21 |
22 | {% endblock %}
23 |
--------------------------------------------------------------------------------
/regulations/templatetags/reg_updates.py:
--------------------------------------------------------------------------------
1 | from django import template
2 | from django.conf import settings
3 |
4 |
5 | register = template.Library()
6 |
7 |
8 | @register.assignment_tag
9 | def update_in_progress(label_id):
10 | """Given a regulation, is there an update currently in progress?
11 |
12 | This template tag checks for a list in the Django setting
13 | EREGS_REGULATION_UPDATES, and, if that setting exists, checks if the given
14 | regulation part is in that list.
15 |
16 | Use it in a template like:
17 |
18 | {% update_in_progress label_id as reg_update_in_progress %}
19 | {% if reg_update_in_progress %}
20 | An update is in progress to this regulation.
21 | {% endif %} 22 | """ 23 | regulation_updates = getattr(settings, 'EREGS_REGULATION_UPDATES', []) 24 | reg_part = label_id.split('-')[0] 25 | return reg_part in regulation_updates 26 | -------------------------------------------------------------------------------- /regulations/settings/dev.py: -------------------------------------------------------------------------------- 1 | from .base import * 2 | 3 | DEBUG = True 4 | TEMPLATES[0]['OPTIONS']['debug'] = DEBUG 5 | 6 | # Add static file directories that live in subdirectories under static.in. 7 | STATIC_IN = root('static.in') 8 | STATICFILES_DIRS += tuple( 9 | os.path.join(STATIC_IN, d) 10 | for d in os.listdir(STATIC_IN) 11 | if os.path.isdir(os.path.join(STATIC_IN, d)) 12 | ) 13 | 14 | 15 | CACHES['default']['BACKEND'] = 'django.core.cache.backends.dummy.DummyCache' 16 | CACHES['eregs_longterm_cache']['BACKEND'] = 'django.core.cache.backends.dummy.DummyCache' 17 | CACHES['api_cache']['TIMEOUT'] = 5 # roughly per request 18 | 19 | OFFLINE_OUTPUT_DIR = '/tmp/' 20 | 21 | INSTALLED_APPS += ( 22 | 'django_nose', 23 | ) 24 | 25 | NOSE_ARGS = [ 26 | '--with-coverage', 27 | '--cover-package=regulations', 28 | '--exclude-dir=regulations/uitests' 29 | ] 30 | 31 | try: 32 | from local_settings import * 33 | except ImportError: 34 | pass 35 | -------------------------------------------------------------------------------- /regulations/static/regulations/css/less/module/diffs.less: -------------------------------------------------------------------------------- 1 | /* 2 | Diffs 3 | ========================================================================== 4 | diffs.less defines the visual appearance of regulations additions and deletions 5 | */ 6 | 7 | 8 | del { 9 | color: @gray-40; 10 | text-decoration: line-through; 11 | 12 | img { 13 | border: 2px solid @red; 14 | opacity: .7; 15 | } 16 | } 17 | 18 | ins { 19 | background-color: @green-20; 20 | text-decoration: none; 21 | font-style: italic; 22 | 23 | .key-term { 24 | background-color: @green-20; 25 | text-decoration: none; 26 | .avenir-next-demi-italic; 27 | 28 | .level-2 &, 29 | .supplement-section .level-1 & { 30 | .avenir-next-demi-italic; 31 | } 32 | } 33 | 34 | img { 35 | border: 2px solid @green-20; 36 | } 37 | } 38 | 39 | h2, 40 | h3, 41 | h4 { 42 | ins { 43 | .avenir-next-demi-italic 44 | } 45 | } -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | ## 12/31/2013 2 | 3 | * Markers in appendices are no longer based on lis; use the marker in the text 4 | * Help text for viewing regs in the rhs 5 | * Help text for diffs in the rhs 6 | * Spinner when loading definitions 7 | 8 | ## 12/17/2013 9 | 10 | * Application wide landing page 11 | * Improved diff view usability 12 | * Move indicator to right side of TOC 13 | * Remove underlines from additions 14 | * Italicize additions 15 | * Implement subparts in TOC 16 | * Make interpretation slidedowns more noticeable 17 | 18 | ## 12/03/2013 19 | 20 | * Enable drawer icons for browsers that do not support web fonts 21 | * Functional testing implemented with Saucelabs 22 | * Fix “See this interpretation” links in IE 23 | * Ensure all external links open in a new tab 24 | * Fix @font-face issues with IE “Save as PDF” functionality 25 | * Do not count search results that are found outside of sections, appendices, interpretations 26 | * Create dummy API data to generate interps and diffs 27 | -------------------------------------------------------------------------------- /regulations/static/regulations/js/unittests/runner.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Official Interpretation to {{ interp.for_label }}
8 | 9 |{{item.label|safe|upper}} - {{item.sub_label|safe}}
{{c.header|safe}}
8 | {% if c.marked_up %} 9 |10 | {{c.marked_up|safe}} 11 |
12 | {% endif %} 13 | 14 |-
15 | {% if c.children %}
16 | {% for node in c.children %}
17 | {% include "regulations/tree-with-wrapper.html" %}
18 | {% endfor %}
19 | {% endif %}
20 |
Help
3 | Show/Hide Contents 4 |
6 |
18 |
--------------------------------------------------------------------------------
/docs/regulations.settings.rst:
--------------------------------------------------------------------------------
1 | regulations.settings package
2 | ============================
3 |
4 | Submodules
5 | ----------
6 |
7 | regulations.settings.base module
8 | --------------------------------
9 |
10 | .. automodule:: regulations.settings.base
11 | :members:
12 | :undoc-members:
13 | :show-inheritance:
14 |
15 | regulations.settings.dev module
16 | -------------------------------
17 |
18 | .. automodule:: regulations.settings.dev
19 | :members:
20 | :undoc-members:
21 | :show-inheritance:
22 |
23 | regulations.settings.local_settings module
24 | ------------------------------------------
25 |
26 | .. automodule:: regulations.settings.local_settings
27 | :members:
28 | :undoc-members:
29 | :show-inheritance:
30 |
31 | regulations.settings.production module
32 | --------------------------------------
33 |
34 | .. automodule:: regulations.settings.production
35 | :members:
36 | :undoc-members:
37 | :show-inheritance:
38 |
39 |
40 | Module contents
41 | ---------------
42 |
43 | .. automodule:: regulations.settings
44 | :members:
45 | :undoc-members:
46 | :show-inheritance:
47 |
--------------------------------------------------------------------------------
/regulations/generator/layers/graphics.py:
--------------------------------------------------------------------------------
1 | from django.template import loader
2 | import utils
3 |
4 |
5 | class GraphicsLayer(object):
6 | shorthand = 'graphics'
7 |
8 | def __init__(self, layer_data):
9 | self.layer_data = layer_data
10 | self.template = loader.get_template('regulations/layers/graphics.html')
11 |
12 | def apply_layer(self, text_index):
13 | """Replace all instances of graphics with an img tag"""
14 | layer_pairs = []
15 | if text_index in self.layer_data:
16 | for graphic_info in self.layer_data[text_index]:
17 |
18 | context = {
19 | 'url': graphic_info['url'],
20 | 'alt': graphic_info['alt']
21 | }
22 |
23 | if 'thumb_url' in graphic_info:
24 | context['thumb_url'] = graphic_info['thumb_url']
25 |
26 | replacement = utils.render_template(self.template, context)
27 | layer_pairs.append((
28 | graphic_info['text'], replacement,
29 | graphic_info['locations']))
30 | return layer_pairs
31 |
--------------------------------------------------------------------------------
/regulations/static/regulations/js/source/views/header/header-view.js:
--------------------------------------------------------------------------------
1 | 'use strict';
2 | var $ = require( 'jquery' );
3 | var _ = require( 'underscore' );
4 | var Backbone = require( 'backbone' );
5 | var SubHead = require( './sub-head-view' );
6 | Backbone.$ = $;
7 |
8 | var HeaderView = Backbone.View.extend( {
9 | el: '.reg-header',
10 |
11 | initialize: function() {
12 | this.subHeadView = new SubHead();
13 | },
14 |
15 | events: {
16 | 'click .mobile-nav-trigger': 'toggleNav'
17 | },
18 |
19 | toggleNav: function( e ) {
20 | e.preventDefault();
21 | $( '.app-nav-list, .mobile-nav-trigger' ).toggleClass( 'open' );
22 | },
23 |
24 | contextMap: {
25 | changeSubHeadText: '_updateSubHead'
26 | },
27 |
28 | ask: function( message, context ) {
29 | if ( typeof this.contextMap[message] !== 'undefined' ) {
30 | this.contextMap[message].apply( context );
31 | }
32 | },
33 |
34 | // type = wayfinding or search
35 | // content = new content
36 | _updateSubHead: function( context ) {
37 | this.subHeadView.change(
38 | context.type,
39 | context.content
40 | );
41 | }
42 | } );
43 |
44 | module.exports = HeaderView;
45 |
--------------------------------------------------------------------------------
/regulations/templates/regulations/tree.html:
--------------------------------------------------------------------------------
1 | {% load formatting %}
2 | {% comment %}
3 | Template for inner paragraphs of a reg section
4 | {% endcomment %}
5 | {% if node.header %}
6 | {{ node.header | safe }}
7 | {% endif %}
8 |
9 | {%if node.marked_up %}
10 |
5 | {% if inline %}
6 |
37 |
--------------------------------------------------------------------------------
/regulations/static/regulations/js/unittests/specs/views/main/diff-view-spec.js:
--------------------------------------------------------------------------------
1 | require('../../../setup');
2 | var sinon = require( 'sinon' );
3 |
4 | describe('Diff View:', function() {
5 |
6 | var view, $, DiffView;
7 |
8 | before(function() {
9 | $ = require('jquery');
10 | DiffView = require('../../../../source/views/main/diff-view');
11 | });
12 |
13 | beforeEach(function(){
14 |
15 | // create a new instance of the view
16 | view = new DiffView();
17 |
18 | $('title').text('Comparison of 12 CFR § 1002.4 | eRegulations');
19 | document.title = 'Comparison of 12 CFR § 1002.4 | eRegulations';
20 | });
21 |
22 | it('should construct a view', function() {
23 | expect(view).to.be.defined;
24 | });
25 |
26 | it('should assemble the title', function() {
27 | view.id = '§1002.4';
28 | var title = view.assembleTitle();
29 | expect(title).to.be.equal('Comparison of §1002.4 | eRegulations');
30 | });
31 |
32 | it('should assemble the diff url', function() {
33 | var options = {
34 | id: '1005-1',
35 | baseVersion: '2011-12121',
36 | newerVersion: '2012-11111',
37 | fromVersion: '2012-11111'
38 | };
39 | var constructedUrl = view.assembleDiffURL(options);
40 | var url = '1005-1/2011-12121/2012-11111?from_version=2012-11111';
41 | expect(constructedUrl).to.be.equal(url);
42 | });
43 |
44 | });
45 |
--------------------------------------------------------------------------------
/regulations/static/regulations/js/source/views/breakaway/breakaway-view.js:
--------------------------------------------------------------------------------
1 | 'use strict';
2 | var $ = require( 'jquery' );
3 | var _ = require( 'underscore' );
4 | var Backbone = require( 'backbone' );
5 | var SxS = require( './sxs-view' );
6 | var Router = require( '../../router' );
7 | var BreakawayEvents = require( '../../events/breakaway-events' );
8 | var MainEvents = require( '../../events/main-events' );
9 | var SidebarEvents = require( '../../events/sidebar-events' );
10 | Backbone.$ = $;
11 |
12 | var BreakawayView = Backbone.View.extend( {
13 | childViews: {},
14 |
15 | initialize: function() {
16 | this.externalEvents = BreakawayEvents;
17 | this.listenTo( this.externalEvents, 'sxs:open', this.openSxS );
18 | },
19 |
20 | openSxS: function( context ) {
21 | context.url = context.regParagraph + '/' + context.docNumber + '?from_version=' + context.fromVersion;
22 |
23 | this.childViews.sxs = new SxS( context );
24 |
25 | if ( Router.hasPushState ) {
26 | Router.navigate( 'sxs/' + context.url );
27 | }
28 |
29 | MainEvents.trigger( 'breakaway:open', _.bind( this.removeChild, this ) );
30 | SidebarEvents.trigger( 'breakaway:open' );
31 | },
32 |
33 | removeChild: function() {
34 | this.childViews.sxs.remove();
35 | delete this.childViews.sxs;
36 | }
37 | } );
38 |
39 | var breakaway = new BreakawayView();
40 | module.exports = breakaway;
41 |
--------------------------------------------------------------------------------
/regulations/static/regulations/css/less/module/search-results.less:
--------------------------------------------------------------------------------
1 | /*
2 | Search Results
3 | ===========================
4 | search-results.less contains styles for search results
5 | */
6 |
7 | .search-results {
8 | margin-top: 30px;
9 | }
10 |
11 | h2.search-term {
12 | .avenir-next;
13 | margin-bottom: 0;
14 | }
15 |
16 | p.search-version {
17 | color: @gray;
18 | text-transform: uppercase;
19 | .avenir-next-demi;
20 | font-size: 0.875em;
21 | margin-top: 0;
22 | }
23 |
24 | .result-list {
25 |
26 | padding: 0;
27 |
28 | li {
29 | margin-top: 2em;
30 | }
31 |
32 | h3 {
33 | .avenir-next-demi;
34 | margin-bottom: 0;
35 | }
36 |
37 | p {
38 | margin-top: .5em;
39 | }
40 |
41 | p:before {
42 | content: '“';
43 | }
44 |
45 | p:after {
46 | content: '”';
47 | }
48 |
49 | .internal {
50 | color: @pacific;
51 | }
52 | }
53 |
54 | .search-nav {
55 |
56 | margin-top: 4em;
57 |
58 | a:link,
59 | a:visited {
60 | .avenir-next-demi;
61 | color: @pacific;
62 | text-decoration: none;
63 | }
64 |
65 | a:hover,
66 | a:active {
67 | border-bottom: 1px solid @pacific;
68 | }
69 |
70 | .next {
71 | padding: 0 15px 0 0;
72 | }
73 |
74 | .previous {
75 | padding: 0 0 0 15px;
76 | }
77 | }
78 |
--------------------------------------------------------------------------------
/regulations/tests/layers_location_replace_tests.py:
--------------------------------------------------------------------------------
1 | from unittest import TestCase
2 |
3 | from regulations.generator.layers.location_replace import *
4 |
5 |
6 | class LayersLocationReplaceTest(TestCase):
7 | def test_update_offsets_html(self):
8 | lr = LocationReplace()
9 | lr.update_offsets("a", "This is a test. It is only a test")
10 | self.assertEqual(lr.offsets, {0: (8, 9), 1: (27, 28)})
11 | lr.update_offsets("a", "This is a test. link")
12 | self.assertEqual(lr.offsets, {0: (8, 9)})
13 |
14 | def test_location_replace_text(self):
15 | lr = LocationReplace()
16 | replaced = lr.location_replace_text('Bunch of as as as',
17 | 'as', 'as', [0, 2])
18 | self.assertEqual('Bunch of as as as', replaced)
19 |
20 | lr = LocationReplace()
21 | replaced = lr.location_replace_text('Bunch of as as as',
22 | 'as', 'b', [0, 2])
23 | self.assertEqual('Bunch of b as b', replaced)
24 |
25 | lr = LocationReplace()
26 | replaced = lr.location_replace_text('Bunch of a_{s} a_{s} a_{s}',
27 | 'a_{s}', 'as', [0, 2])
28 | self.assertEqual('Bunch of as a_{s} as',
29 | replaced)
30 |
--------------------------------------------------------------------------------
/regulations/static/regulations/js/source/views/drawer/search-view.js:
--------------------------------------------------------------------------------
1 | 'use strict';
2 | var $ = require( 'jquery' );
3 | var _ = require( 'underscore' );
4 | var Backbone = require( 'backbone' );
5 | var Router = require( '../../router' );
6 | var MainEvents = require( '../../events/main-events' );
7 | var GAEvents = require( '../../events/ga-events' );
8 | Backbone.$ = $;
9 |
10 | var SearchView = Backbone.View.extend( {
11 | el: '#search',
12 |
13 | events: {
14 | 'change #version-select': 'logSearchVersion',
15 | 'submit': 'openSearchResults'
16 | },
17 |
18 | initialize: function() {
19 | // if the browser doesn't support pushState, don't
20 | // trigger click events for links
21 | if ( Router.hasPushState === false ) {
22 | this.events = {};
23 | }
24 | },
25 |
26 | logSearchVersion: function( e ) {
27 | var version = $( e.target ).val();
28 | GAEvents.sendEvent( 'searchVersion:change', version );
29 | },
30 |
31 | openSearchResults: function( e ) {
32 | sessionStorage.setItem( 'drawerDefault', 'search' );
33 |
34 | e.preventDefault();
35 | var $form = $( e.target ),
36 | options = {};
37 |
38 | options.query = $form.find( 'input[name=q]' )[0].value;
39 | options.searchVersion = $form.find( 'select[name=version]' )[0].value;
40 | MainEvents.trigger( 'search-results:open', null, options, 'search-results' );
41 | }
42 |
43 | } );
44 |
45 | module.exports = SearchView;
46 |
--------------------------------------------------------------------------------
/regulations/templates/regulations/specific/landing_1013.html:
--------------------------------------------------------------------------------
1 | {% extends "regulations/landing_base.html" %}
2 |
3 |
4 | {% block reg_title %}
5 | Notice: {{ document_number }}
6 |
7 |
8 |
10 |
32 | {% endblock %}
33 |
34 | {% block endscripts %}
35 |
36 | {% endblock %}
37 |
--------------------------------------------------------------------------------
/regulations/static/regulations/js/unittests/specs/views/header/header-view-spec.js:
--------------------------------------------------------------------------------
1 | require('../../../setup');
2 | var sinon = require( 'sinon' );
3 |
4 | describe('Header View:', function() {
5 |
6 | var view, $, e, HeaderView;
7 |
8 | before(function() {
9 | $ = require('jquery');
10 | HeaderView = require('../../../../source/views/header/header-view');
11 | sandbox = sinon.sandbox.create();
12 | });
13 |
14 | beforeEach(function(){
15 | // Adding a simplified version of the thing we want to test.
16 | $( 'body' ).html(
17 | '' +
18 | ' '
38 | );
39 |
40 | // create a new instance of the view
41 | view = new HeaderView();
42 |
43 | view.el = $('.reg-header');
44 |
45 | });
46 |
47 | it('should construct a view', function() {
48 | expect(view).to.be.defined;
49 | });
50 |
51 | });
52 |
--------------------------------------------------------------------------------
/regulations/tests/templatetags_in_context_tests.py:
--------------------------------------------------------------------------------
1 | from unittest import TestCase
2 |
3 | from django.template import Context, Template
4 |
5 |
6 | class TemplatetagsInContextTest(TestCase):
7 | def test_in_context(self):
8 | text = "{% load in_context %}"
9 | text += "1. {{ f1 }}{{ f2 }}{{ f3 }}{{ f4 }}\n"
10 | text += "{% begincontext c1 %}\n"
11 | text += "2. {{ f1 }}{{ f2 }}{{ f3 }}{{ f4 }}\n"
12 | text += "{% endcontext %}{% begincontext c1 c2 %}\n"
13 | text += "3. {{ f1 }}{{ f2 }}{{ f3 }}{{ f4 }}\n"
14 | text += "{% begincontext c2a %}\n"
15 | text += "4. {{ f1 }}{{ f2 }}{{ f3 }}{{ f4 }}\n"
16 | text += "{% endcontext %}{% endcontext %}\n"
17 | text += "5. {{ f1 }}{{ f2 }}{{ f3 }}{{ f4 }}"
18 |
19 | context = {'f1': 'f1',
20 | 'c1': {'f2': 'c1.f2', 'f1': 'c1.f1'},
21 | 'c2': {'f2': 'c2.f2',
22 | 'f3': 'c2.f3', 'c2a': {'f4': 'c2a.f4'}}}
23 |
24 | output = Template(text).render(Context(context))
25 | lines = output.split("\n")
26 | self.assertEqual("1. f1", lines[0])
27 | self.assertEqual("2. c1.f1c1.f2", lines[2])
28 | self.assertEqual("3. c1.f1c2.f2c2.f3", lines[4])
29 | self.assertEqual("4. c2a.f4", lines[6])
30 | self.assertEqual("5. f1", lines[8])
31 |
32 | def test_in_context_cascade(self):
33 | """Make sure fields that are not dicts get passed along"""
34 | text = "{% load in_context %}{% begincontext c1 f2 %}"
35 | text += "{{ f1 }}{{ f2 }}\n"
36 | text += "{% endcontext %}"
37 | text += "{{ f1 }}{{ f2 }}"
38 |
39 | context = {'f1': 'f1', 'f2': 'f2', 'c1': {'f1': 'c1.f1'}}
40 | output = Template(text).render(Context(context))
41 | lines = output.split("\n")
42 | self.assertEqual("c1.f1f2", lines[0])
43 | self.assertEqual("f1f2", lines[1])
44 |
--------------------------------------------------------------------------------
/regulations/uitests/base_test.py:
--------------------------------------------------------------------------------
1 | import os
2 | from selenium import webdriver
3 | from testconfig import config
4 |
5 | class BaseTest():
6 |
7 | def config_map(self, browser):
8 | browser_configs = {
9 | 'chrome': {
10 | 'driver': webdriver.DesiredCapabilities.CHROME,
11 | 'platform': 'LINUX',
12 | 'version': ''
13 | },
14 | 'ie10': {
15 | 'driver': webdriver.DesiredCapabilities.INTERNETEXPLORER,
16 | 'platform': 'Windows 8',
17 | 'version': '10'
18 | }
19 | }
20 | return browser_configs[browser]
21 |
22 | def setUp(self):
23 | selenium_config = self.config_map(config['webdriver']['browser'])
24 | self.test_url = config['testUrl']
25 | self.capabilities = selenium_config['driver']
26 | if os.environ.get('TRAVIS') and os.environ.get('TRAVIS_SECURE_ENV_VARS'):
27 | self.capabilities['tunnel-identifier'] = os.environ['TRAVIS_JOB_NUMBER']
28 | self.capabilities['build'] = os.environ['TRAVIS_BUILD_NUMBER']
29 |
30 | self.username = os.environ['SAUCE_USERNAME']
31 | self.key = os.environ['SAUCE_ACCESS_KEY']
32 | self.capabilities['name'] = self.job_name()
33 | self.capabilities['platform'] = selenium_config['platform']
34 | self.capabilities['version'] = selenium_config['version']
35 | hub_url = "%s:%s" % (self.username, self.key)
36 | self.driver = webdriver.Remote(desired_capabilities=self.capabilities,
37 | command_executor = ("http://%s@ondemand.saucelabs.com:80/wd/hub" % hub_url))
38 | self.jobid = self.driver.session_id
39 | print("Sauce Labs job: https://saucelabs.com/jobs/%s" % self.jobid)
40 | self.driver.implicitly_wait(30)
41 |
42 | def job_name(self):
43 | return 'eRegs UI Test'
44 |
45 | def tearDown(self):
46 | self.driver.quit()
47 |
--------------------------------------------------------------------------------
/regulations/tests/generator_subterp_tests.py:
--------------------------------------------------------------------------------
1 | from unittest import TestCase
2 |
3 | from mock import patch
4 |
5 | from regulations.generator import subterp
6 |
7 |
8 | class SubterpTest(TestCase):
9 | @patch('regulations.generator.subterp.fetch_toc')
10 | def test_filter_by_subterp(self, fetch_toc):
11 | nodes = [{'label': ['1005', 'h1', 'Interp']},
12 | {'label': ['1005', '2', 'Interp']},
13 | {'label': ['1005', '3', 'Interp']},
14 | {'label': ['1005', '4', 'Interp']},
15 | {'label': ['1005', 'A', 'Interp']},
16 | {'label': ['1005', 'A_B', 'Interp']},
17 | {'label': ['1005', 'B', 'Interp']}]
18 | self.assertEqual(nodes[1:4], subterp.filter_by_subterp(
19 | nodes, ['1005', 'Subpart', 'Interp'], 'vvvv'))
20 | self.assertFalse(fetch_toc.called)
21 |
22 | self.assertEqual(nodes[4:], subterp.filter_by_subterp(
23 | nodes, ['1005', 'Appendices', 'Interp'], 'vvvv'))
24 | self.assertFalse(fetch_toc.called)
25 |
26 | fetch_toc.return_value = [
27 | {'index': ['1005', 'Subpart', 'A'],
28 | 'sub_toc': [{'index': ['1005', '1']}, {'index': ['1005', '2']}]},
29 | {'index': ['1005', 'Subpart', 'B'],
30 | 'sub_toc': [{'index': ['1005', '3']}, {'index': ['1005', '4']}]},
31 | {'index': ['1005', 'A']},
32 | {'index': ['1005', 'B']},
33 | {'index': ['1005', 'Interp'],
34 | 'sub_toc': [{'index': ['1005', 'Subpart', 'A', 'Interp']},
35 | {'index': ['1005', 'Subpart', 'B', 'Interp']},
36 | {'index': ['1005', 'Appendices', 'Interp']}]}]
37 | self.assertEqual(nodes[1:2], subterp.filter_by_subterp(
38 | nodes, ['1005', 'Subpart', 'A', 'Interp'], 'vvvv'))
39 | self.assertEqual(nodes[2:4], subterp.filter_by_subterp(
40 | nodes, ['1005', 'Subpart', 'B', 'Interp'], 'vvvv'))
41 |
--------------------------------------------------------------------------------
/regulations/templates/regulations/partial-definition.html:
--------------------------------------------------------------------------------
1 | {% comment %}
2 | Partial for definitions to be displayed inline in the sidebar
3 | {% endcomment %}
4 | ', sxs_start)
40 | sxs = response.content[sxs_start:sxs_end]
41 |
42 | self.assertTrue(bool(re.search(r'\b12\b', sxs)))
43 | self.assertTrue('12(a)' in sxs)
44 | self.assertTrue('1992-2' in sxs)
45 | self.assertTrue('876-12' in sxs)
46 | self.assertTrue('1992-1' in sxs)
47 | self.assertTrue('876-12-a' in sxs)
48 | self.assertFalse('876-12-b' in sxs)
49 |
--------------------------------------------------------------------------------
/regulations/templates/regulations/chrome-empty-sidebar.html:
--------------------------------------------------------------------------------
1 | {% extends "regulations/chrome.html" %}
2 | {% load static from staticfiles %}
3 | {% load reg_updates %}
4 |
5 | {% comment %}
6 | Search results (and perhaps other pages) need a sidebar containing only help text
7 | {% endcomment %}
8 |
9 | {% block reg_sidebar %}
10 |
11 | {% update_in_progress label_id as reg_update_in_progress %}
12 | {% if reg_update_in_progress %}
13 |
18 | {% endif %}
19 |
20 |
21 | {% include "regulations/generic_help.html" %}
22 |
23 | {% comment %}
24 | The help-subsection block is used to offer contextual content in different
25 | sections of the app
26 | {% endcomment %}
27 |
28 | {% block help-subsection %}
29 |
51 | 11 | {% if node.node_type == "appendix" %} 12 | {{node.marked_up|safe|linebreaksbr}} 13 | {% else %} 14 | {{node.marked_up|safe}} 15 | {% endif %} 16 |
17 | {% endif %} 18 | {% if node.children %} 19 |-
25 |
26 | {% for c in node.children %}
27 | {% with node=c template_name="regulations/tree-with-wrapper.html" %}
28 | {% include template_name %}
29 | {% endwith %}
30 | {% endfor %}
31 |
2 |
21 |
--------------------------------------------------------------------------------
/regulations/static/regulations/js/unittests/specs/models/definition-model-spec.js:
--------------------------------------------------------------------------------
1 | require('../../setup');
2 |
3 | describe('Definition Model:', function() {
4 | 'use strict';
5 |
6 | var $, Backbone, DefinitionModel, Resources;
7 |
8 | before(function(){
9 | Backbone = require('backbone');
10 | $ = require('jquery');
11 | Backbone.$ = $;
12 | DefinitionModel = require('../../../source/models/definition-model');
13 | Resources = require('../../../source/resources');
14 | window.APP_PREFIX = '/eregulations/';
15 | });
16 |
17 | beforeEach(function(){
18 | Resources.versionElements = {
19 | toc: $(''),
20 | };
21 | });
22 |
23 | it('getAJAXUrl returns the correct URL endpoint with /definition supplemental path', function() {
24 | expect(DefinitionModel.getAJAXUrl('1005-2')).to.equal('/eregulations/partial/definition/1005-2/2014-20681');
25 |
26 | window.APP_PREFIX = ''; // Test without a urlPrefix
27 | expect(DefinitionModel.getAJAXUrl('1005-2')).to.equal('/partial/definition/1005-2/2014-20681');
28 |
29 | window.APP_PREFIX = '/eregulations/'; //Return to normal
30 |
31 | });
32 | });
33 |
--------------------------------------------------------------------------------
/regulations/generator/layers/key_terms.py:
--------------------------------------------------------------------------------
1 | import string
2 | import utils
3 | from django.template import loader, Context
4 |
5 | class KeyTermsLayer(object):
6 | shorthand = 'keyterms'
7 |
8 | def __init__(self, layer):
9 | self.layer = layer
10 | self.template = loader.get_template('regulations/layers/key_term.html')
11 |
12 | def remove_punctuation(self, punctuated):
13 | translate_table = dict((ord(c), None) for c in string.punctuation)
14 | return punctuated.translate(translate_table)
15 |
16 | def generate_tag(self, key_term):
17 | key_term = {'key_term':key_term,
18 | 'phrase':self.remove_punctuation(key_term)}
19 | context = {'key_term':key_term}
20 | return utils.render_template(self.template, context)
21 |
22 | def apply_layer(self, text_index):
23 | elements = []
24 | if text_index in self.layer:
25 | layer_elements = self.layer[text_index]
26 |
27 | for layer_element in layer_elements:
28 | key_term = layer_element['key_term']
29 | key_term_tag = self.generate_tag(key_term)
30 | locations = layer_element['locations']
31 | elements.append((key_term, key_term_tag, locations))
32 | return elements
33 |
--------------------------------------------------------------------------------
/regulations/static/regulations/js/unittests/specs/models/search-model-spec.js:
--------------------------------------------------------------------------------
1 | require('../../setup');
2 |
3 | describe('Search Model:', function() {
4 | 'use strict';
5 |
6 | var $, Backbone, SearchModel, Resources;
7 |
8 | before(function(){
9 | Backbone = require('backbone');
10 | $ = require('jquery');
11 | Backbone.$ = $;
12 | SearchModel = require('../../../source/models/search-model');
13 | Resources = require('../../../source/resources');
14 | window.APP_PREFIX = '/eregulations/';
15 | });
16 |
17 | beforeEach(function(){
18 | Resources.versionElements = {
19 | toc: $(''),
20 | };
21 | });
22 |
23 | // A Twist on the normal getAJAXUrl test: This shouldn't return a date on the URL.
24 | it('getAJAXUrl returns the correct URL endpoint with /search supplemental path', function() {
25 | expect(SearchModel.getAJAXUrl('1005-2')).to.equal('/eregulations/partial/search/1005-2');
26 |
27 |
28 | window.APP_PREFIX = ''; // Test without a urlPrefix
29 | expect(SearchModel.getAJAXUrl('1005-2')).to.equal('/partial/search/1005-2');
30 |
31 | window.APP_PREFIX = '/eregulations/'; //Return to normal
32 |
33 | });
34 | });
35 |
--------------------------------------------------------------------------------
/regulations/templates/regulations/navigation.html:
--------------------------------------------------------------------------------
1 | {% comment %}
2 | Display the previous, next section links
3 | {% endcomment %}
4 |
5 | {% if navigation %}
6 |
31 | {% endif %}
32 |
--------------------------------------------------------------------------------
/regulations/tests/views_partial_definitions_tests.py:
--------------------------------------------------------------------------------
1 | from unittest import TestCase
2 | from django.core.urlresolvers import reverse, resolve
3 | from django.template import loader, Context
4 |
5 |
6 | class PartialDefinitionTests(TestCase):
7 | urls = 'regulation.urls'
8 |
9 | def test_partial_definition_with_children(self):
10 | t = loader.get_template('regulations/partial-definition.html')
11 |
12 | node = {
13 | 'section_id': '102-4',
14 | 'label_id': '202-2-a',
15 | 'children': [{'label_id': '202-2-a-1'}]}
16 |
17 | context_dict = {'node': node, 'version': '2012-1223'}
18 | response = t.render(Context(context_dict))
19 | best_viewed = 'This definition is best viewed in its original location'
20 | self.assertTrue(best_viewed in response)
21 |
22 | def test_partial_definition_no_children(self):
23 | t = loader.get_template('regulations/partial-definition.html')
24 |
25 | node = {
26 | 'section_id': '102-4',
27 | 'label_id': '202-2-a',
28 | 'marked_up': 'This term is defined carefully'}
29 |
30 | context_dict = {'node': node, 'version': '2012-1223'}
31 | response = t.render(Context(context_dict))
32 | carefully = 'This term is defined carefully'
33 | self.assertTrue(carefully in response)
34 |
--------------------------------------------------------------------------------
/regulations/static/regulations/js/source/app-init.js:
--------------------------------------------------------------------------------
1 | // Module called on app load, once doc.ready
2 | 'use strict';
3 |
4 | var $ = require( 'jquery' );
5 | var _ = require( 'underscore' );
6 | var Backbone = require( 'backbone' );
7 | var MainView = require( './views/main/main-view' );
8 | var Router = require( './router' );
9 | var SidebarView = require( './views/sidebar/sidebar-view' );
10 | var HeaderView = require( './views/header/header-view' );
11 | var DrawerView = require( './views/drawer/drawer-view' );
12 | var analyticsEvents = require( './events/ga-events' );
13 | Backbone.$ = $;
14 |
15 | module.exports = {
16 | // Purgatory for DOM event bindings that should happen in a View
17 | bindEvents: function() {
18 | // disable/hide an alert
19 | $( '.disable-link' ).on( 'click', function( e ) {
20 | e.preventDefault();
21 | $( this ).closest( '.displayed' ).addClass( 'disabled' );
22 | } );
23 | },
24 |
25 | init: function() {
26 | Router.start();
27 | this.bindEvents();
28 | analyticsEvents.init();
29 | var main = new MainView(),
30 | sidebar = new SidebarView(),
31 | header = new HeaderView(), // Header before Drawer as Drawer sends Header events
32 | drawer = new DrawerView();
33 | setTimeout( function() {
34 | $( 'html' ).addClass( 'selenium-start' );
35 | }, 5000 );
36 | }
37 | };
38 |
--------------------------------------------------------------------------------
/regulations/tests/layers_paragraph_markers_tests.py:
--------------------------------------------------------------------------------
1 | from unittest import TestCase
2 |
3 | from mock import patch
4 |
5 | from regulations.generator.layers.paragraph_markers import *
6 |
7 | class ParagraphMarkersLayerTest(TestCase):
8 |
9 | @patch('regulations.generator.layers.paragraph_markers.loader')
10 | def test_apply_layer(self, loader):
11 | pml = ParagraphMarkersLayer({
12 | '1001-12-a': [{'text': '(a)', 'locations': [0]}],
13 | '1001-12-q': [{'text': 'q.', 'locations': [1]}]
14 | })
15 | self.assertEqual([], pml.apply_layer('1002-01-01'))
16 |
17 | a = pml.apply_layer('1001-12-a')
18 | self.assertEqual(1, len(a))
19 | self.assertEqual('(a)', a[0][0])
20 | self.assertEqual([0], a[0][2])
21 | call_args = loader.get_template.return_value.render.call_args[0][0]
22 | self.assertEqual('(a)', call_args['paragraph'])
23 | self.assertEqual('a', call_args['paragraph_stripped'])
24 |
25 | q = pml.apply_layer('1001-12-q')
26 | self.assertEqual(1, len(q))
27 | self.assertEqual('q.', q[0][0])
28 | self.assertEqual([1], q[0][2])
29 | call_args = loader.get_template.return_value.render.call_args[0][0]
30 | self.assertEqual('q.', call_args['paragraph'])
31 | self.assertEqual('q', call_args['paragraph_stripped'])
32 |
--------------------------------------------------------------------------------
/regulations/templates/regulations/interp-tree.html:
--------------------------------------------------------------------------------
1 | {% comment %}
2 | Template for each level of the interpretation tree
3 | {% endcomment %}
4 | {{ interp.header|safe }}
7 | {% elif interp.section_header %} 8 |{{ interp.header|safe }}
9 | {% else %} 10 |{{ interp.header_markup|safe }}
11 | {% endif %} 12 | 13 | {%if interp.marked_up %} 14 |15 | {{interp.marked_up|safe}} 16 |
17 | {% endif %} 18 | 19 | {% if interp.par_children %} 20 |-
21 | {% for par_child in interp.par_children %}
22 | {% with node=par_child %}
23 | {% include "regulations/tree-with-wrapper.html" %}
24 | {% endwith %}
25 | {% endfor %}
26 |
Regulation M protects people when they use consumer leases.
6 | {% endblock %} 7 | 8 | {% block reg_main_content %} 9 |
10 |
18 |
19 |
29 |
30 | {% endblock %}
31 |
32 |
33 |
34 | {% block additional_resources %}
35 | Ask CFPB
36 |-
37 |
- Auto loans 38 |
5 | {% if top_toc %}
6 |
29 |
--------------------------------------------------------------------------------
/regulations/templatetags/in_context.py:
--------------------------------------------------------------------------------
1 | from django import template
2 |
3 | register = template.Library()
4 |
5 |
6 | class InContextNode(template.Node):
7 | def __init__(self, nodelist, subcontext_names):
8 | self.nodelist = nodelist
9 | self.subcontext_names = subcontext_names
10 |
11 | def render(self, context):
12 | new_context = {}
13 | for field in self.subcontext_names:
14 | value = context.get(field, {})
15 | if isinstance(value, dict):
16 | new_context.update(context.get(field, {}))
17 | else:
18 | new_context[field] = value
19 | new_context = context.new(new_context)
20 | return self.nodelist.render(new_context)
21 |
22 |
23 | @register.tag('begincontext')
24 | def in_context(parser, token):
25 | """
26 | Replaces the context (inside of this block) for easy (and safe) inclusion
27 | of sub-content.
28 |
29 | For example, if the context is {'name': 'Kitty', 'sub': {'size': 5}}
30 |
31 | 1: {{ name }} {{ size }}
32 | {% begincontext sub %}
33 | 2: {{ name }} {{ size }}
34 | {% endcontext %}
35 | 3: {{ name }} {{ size }}
36 |
37 | Will print
38 | 1: Kitty
39 | 2: 5
40 | 3: Kitty
41 |
42 | Arguments which are not dictionaries will 'cascade' into the inner
43 | context.
44 | """
45 | nodelist = parser.parse(('endcontext',))
46 | parser.delete_first_token()
47 | return InContextNode(nodelist, token.split_contents()[1:])
48 |
--------------------------------------------------------------------------------
/regulations/templates/regulations/specific/landing_1030.html:
--------------------------------------------------------------------------------
1 | {% extends "regulations/landing_base.html" %}
2 |
3 |
4 | {% block reg_title %}
5 |
7 |
9 | {% endif %}
10 |
28 | Table of Contents
8 |Regulation DD helps consumers comparison-shop for deposit accounts.
6 | {% endblock %} 7 | 8 | {% block reg_main_content %} 9 |
10 |
21 |
22 |
32 |
33 | {% endblock %}
34 |
35 |
36 |
37 | {% block additional_resources %}
38 | Ask CFPB
39 |-
40 |
- Bank accounts and services 41 |
' +
16 | '' +
17 | ' ' +
18 | '
';
19 |
20 | appendixSection = '' +
21 | '' +
22 | ' ' +
23 | '
';
24 |
25 |
26 | $( 'body' ).html(regSection);
27 |
28 | // create a new instance of the view
29 | view = new MainView();
30 | view.$el = $('#content-body');
31 |
32 | e = {
33 | preventDefault: function() {
34 | return true;
35 | }
36 | };
37 |
38 | });
39 |
40 | it('should construct a view', function() {
41 | expect(view).to.be.defined;
42 | expect(view.el).to.be.defined;
43 | });
44 |
45 | it('should check if the content is a reg, appendix, or supplement', function() {
46 | var check = view.isAppendixOrSupplement();
47 | expect(check).to.equal(false);
48 |
49 | $('body').html();
50 | $('body').html(appendixSection);
51 | view = new MainView();
52 | view.$el = $('#content-body');
53 | var check = view.isAppendixOrSupplement();
54 | expect(check).to.equal('appendix');
55 |
56 | });
57 |
58 | });
59 |
--------------------------------------------------------------------------------
/regulations/templates/regulations/specific/landing_1003.html:
--------------------------------------------------------------------------------
1 | {% extends "regulations/landing_base.html" %}
2 |
3 |
4 | {% block reg_title %}
5 | Regulation C requires many financial institutions to collect, report, and disclose information about their mortgage lending activity.
6 | {% endblock %} 7 | 8 | {% block reg_main_content %} 9 |
10 |
19 |
20 |
29 |
30 | {% endblock %}
31 |
32 |
33 | {% block additional_resources %}
34 | Other resources
35 | 36 |-
37 |
- HMDA Data Tools 38 |
- FFIEC HMDA Materials 39 |
- HMDA Rule Implementation 40 |
6 |
7 |
23 |
24 | {% if results.results %}
25 |
36 | {% endif %}
37 |
38 |
--------------------------------------------------------------------------------
/regulations/templates/regulations/notice.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 | Searching for “{{ q }}”
8 | {% if not skip_count %} 9 | {{ results.total_hits }} result{{ results.results|pluralize }} 10 | {% endif %} 11 | 12 |-
13 | {% for result in results.results %}
14 |
-
15 |
{{result.header}}
16 |{{result.text}}
17 |
18 | {% empty %}
19 | Sorry, there are no results in the regulation effective {{version_by_date|date}}.
20 | {% endfor %}
21 |
Meta
9 |-
10 |
- Document Number: {{ document_number }} 11 |
- CFR Part: {{ cfr_part }} 12 |
- Agency: {{ agency }} 13 |
- Action: {{ action }} 14 |
- Summary: {{ summary }} 15 |
- Contact: {{ contact }} 16 | {% if rin %}
- RIN: {{ rin }} {% endif %} 17 | {% if dates %} 18 |
- Dates:
19 |
-
20 | {% for key, values in dates.items %}
21 |
- {{ key | title }}: {{ values | join:", " }} 22 | {% endfor %} 23 |
25 | {% endif %}
26 | {% if addresses %}
27 | - Addresses:
-
28 | {% if addresses.intro %}
- {{ addresses.intro }} {% endif %} 29 | {% for k,v in addresses.methods %} 30 |
- {{ k }} : {{ v }} 31 | {% endfor %} 32 | {% if addresses.instructions %} 33 |
- Instructions:
-
34 | {% for instruction in addresses.instructions %}
- {{ instruction }} {% endfor %} 35 |
36 | {% endif %}
37 |
38 | {% endif %}
39 |
Section-by-Section Analysis
41 | {% for markup in sxs_markup %} 42 | {{ markup | safe }} 43 | {% endfor %} 44 | 45 | 46 | -------------------------------------------------------------------------------- /regulations/static/regulations/css/less/module/forms.less: -------------------------------------------------------------------------------- 1 | /* 2 | Forms.less 3 | ========================================================================== 4 | formsless contains generic form styles 5 | */ 6 | 7 | input { 8 | height: 32px; 9 | margin: 0; 10 | } 11 | 12 | input[type=text]{ 13 | vertical-align: bottom; 14 | .avenir-next; 15 | color: @black; 16 | } 17 | 18 | button { 19 | height: 32px; 20 | vertical-align: bottom; 21 | margin: 0; 22 | background-color: @pacific; 23 | color: #fff; 24 | border: none; 25 | vertical-align: bottom; 26 | text-align: center; 27 | -webkit-transition: .1s; 28 | -moz-transition: .1s; 29 | transition: .1s; 30 | } 31 | 32 | button:hover, 33 | button:active { 34 | background-color: @pacific-60; 35 | } 36 | 37 | textarea:focus, 38 | input:focus { 39 | border: 1px solid @pacific; 40 | } 41 | 42 | /* 43 | Selects 44 | -------------------------------- 45 | */ 46 | 47 | .select-content { 48 | overflow: hidden; /* this hides the select's drop button */ 49 | position: relative; 50 | background: white url('../img/select.png') no-repeat bottom right; 51 | //width: 100%; 52 | border: solid 1px @gray-20; 53 | height: 32px; 54 | } 55 | 56 | @media 57 | (-webkit-min-device-pixel-ratio: 2), 58 | (min-resolution: 192dpi) { 59 | .select-content { 60 | background: white url('../img/select@2x.png') no-repeat bottom right; 61 | background-size: 32px 32px; 62 | } 63 | } 64 | 65 | select { 66 | width: 115%; 67 | background-color: transparent; 68 | background-image: none; 69 | -webkit-appearance: none; 70 | border: none; 71 | box-shadow: none; 72 | padding: 0 10px; /* add padding to the select, not the div */ 73 | color: @gray-80; 74 | height: 32px; 75 | } 76 | 77 | .lt-ie9 { 78 | select { 79 | height: 24px; 80 | } 81 | } -------------------------------------------------------------------------------- /regulations/templates/regulations/custom-about.html: -------------------------------------------------------------------------------- 1 | {% extends "regulations/about.html" %} 2 | {% load static from staticfiles %} 3 | 4 | {% block headscripts %} 5 | 6 | {% endblock %} 7 | 8 | {% block about-timeline %} 9 |
11 |
31 | Regulation timeline
12 | 13 |
14 | 
15 |
16 |
17 |
18 |
29 |
30 | The regulation timeline shows recent revisions of the regulation organized by latest effective date. 19 | Revisions are available from the CFPB’s restatement of the regulations forward.
20 | 21 |-
22 |
- The date picker allows users to find what revision was effective on a specific date. 23 |
- Federal Register notice(s) associated with a revision are presented and organized by publication date. These links will 24 | take you to the notice on the Office of the Federal Register’s website. 25 |
- Compare any two revisions of the regulation, word for word, by selecting a date in the menu. 26 |
' +
19 | '
' +
37 | '' +
20 | '
' +
23 | '' +
36 | 'eRegulations
' + 21 | 'Pizza Standards
' + 22 | '
5 |
11 |
12 | {% comment %}
13 | Used to display scope warnings
14 | {% endcomment %}
15 |
20 |
21 |
51 |
--------------------------------------------------------------------------------
/regulations/templates/regulations/full_footer.html:
--------------------------------------------------------------------------------
1 | {% comment %}
2 | full_footer contains the larger footer used on the universal landing and about pages
3 | {% endcomment %}
4 |
5 |
--------------------------------------------------------------------------------
/regulations/views/chrome_breakaway.py:
--------------------------------------------------------------------------------
1 | from django.http import HttpResponse
2 |
3 | from regulations.generator import api_reader
4 | from regulations.generator.node_types import label_to_text
5 | from regulations.views import utils
6 | from regulations.views.chrome import ChromeView
7 | from regulations.views.partial_search import PartialSearch
8 | from regulations.views.partial_sxs import ParagraphSXSView
9 |
10 |
11 | class ChromeBreakawayView(ChromeView):
12 | """ Base class for views which wish to include chrome. """
13 | template_name = 'regulations/breakaway-chrome.html'
14 |
15 | def content(self, context):
16 | """Filled in by subclasses; content for the breakaway"""
17 | raise NotImplementedError
18 |
19 | def get_context_data(self, **kwargs):
20 | # Skip ChromeView's implementation
21 | context = super(ChromeView, self).get_context_data(**kwargs)
22 |
23 | context['reg_part'] = context['label_id'].split('-')[0]
24 | context['version'] = self.request.GET.get('from_version')
25 | meta = api_reader.ApiReader().layer('meta', context['reg_part'],
26 | context['version'])
27 | context['meta'] = meta[context['reg_part']][0]
28 | context['formatted_id'] = label_to_text(context['label_id'].split('-'))
29 |
30 | content = self.content(context)
31 | if isinstance(content, HttpResponse): # error occurred
32 | return content
33 | context['partial_content'] = content
34 |
35 | utils.add_extras(context)
36 | return context
37 |
38 |
39 | class ChromeSXSView(ChromeBreakawayView):
40 | """SXS content"""
41 | def content(self, context):
42 | partial_view = ParagraphSXSView.as_view()
43 | response = partial_view(self.request, label_id=context['label_id'],
44 | notice_id=context['notice_id'])
45 | self._assert_good(response)
46 | response.render()
47 | return response.content
48 |
--------------------------------------------------------------------------------
/regulations/generator/layers/toc_applier.py:
--------------------------------------------------------------------------------
1 | #vim: set fileencoding=utf-8
2 | from regulations.generator import title_parsing
3 | from regulations.generator.section_url import SectionUrl
4 | from regulations.generator.toc import (
5 | toc_interp, toc_sect_appendix, toc_subpart)
6 |
7 |
8 | class TableOfContentsLayer(object):
9 | shorthand = 'toc'
10 |
11 | def __init__(self, layer):
12 | self.layer = layer
13 | self.sectional = False
14 | self.version = None
15 | self.section_url = SectionUrl()
16 |
17 | def apply_layer(self, text_index):
18 | if text_index in self.layer:
19 | layer_elements = self.layer[text_index]
20 |
21 | toc_list = []
22 | for data in layer_elements:
23 | if 'Subpart' in data['index']:
24 | toc_list.append(toc_subpart(data, toc_list, self.layer))
25 | elif 'Interp' in data['index']:
26 | toc_list.append(toc_interp(data, toc_list, self.layer))
27 | else:
28 | toc_list.append(toc_sect_appendix(data, toc_list))
29 |
30 | for el in toc_list:
31 | el['url'] = self.section_url.fetch(
32 | el['index'], self.version, self.sectional)
33 | for sub in el.get('sub_toc', []):
34 | sub['url'] = self.section_url.fetch(
35 | sub['index'], self.version, self.sectional)
36 | return ('TOC', toc_list)
37 |
38 | @staticmethod
39 | def section(element, data):
40 | title_data = title_parsing.section(data)
41 | if title_data:
42 | element.update(title_data)
43 |
44 | @staticmethod
45 | def appendix_supplement(element, data, seen_appendix=False):
46 | as_data = title_parsing.appendix_supplement(data)
47 | if as_data:
48 | element.update(as_data)
49 | if element.get('is_appendix'):
50 | element['is_first_appendix'] = not seen_appendix
51 |
--------------------------------------------------------------------------------
/regulations/static/regulations/js/source/events/scroll-stop.js:
--------------------------------------------------------------------------------
1 | // this is a browserify friendly version of https://github.com/ssorallen/jquery-scrollstop
2 | 'use strict';
3 | var $ = require( 'jquery' );
4 |
5 | var dispatch = $.event.dispatch || $.event.handle;
6 |
7 | var special = $.event.special,
8 | uid1 = 'D' + Number( new Date() ),
9 | uid2 = 'D' + ( Number( new Date() ) + 1 );
10 |
11 | special.scrollstart = {
12 | setup: function( data ) {
13 | var _data = $.extend( {
14 | latency: special.scrollstop.latency
15 | }, data );
16 |
17 | var timer,
18 | handler = function( evt ) {
19 | var _self = this,
20 | _args = arguments;
21 |
22 | if ( timer ) {
23 | clearTimeout( timer );
24 | } else {
25 | evt.type = 'scrollstart';
26 | dispatch.apply( _self, _args );
27 | }
28 |
29 | timer = setTimeout( function() {
30 | timer = null;
31 | }, _data.latency );
32 | };
33 |
34 | $( this ).bind( 'scroll', handler ).data( uid1, handler );
35 | },
36 | teardown: function() {
37 | $( this ).unbind( 'scroll', $( this ).data( uid1 ) );
38 | }
39 | };
40 |
41 | special.scrollstop = {
42 | latency: 250,
43 | setup: function( data ) {
44 | var _data = $.extend( {
45 | latency: special.scrollstop.latency
46 | }, data );
47 |
48 | var timer,
49 | handler = function( evt ) {
50 | var _self = this,
51 | _args = arguments;
52 |
53 | if ( timer ) {
54 | clearTimeout( timer );
55 | }
56 |
57 | timer = setTimeout( function() {
58 | timer = null;
59 | evt.type = 'scrollstop';
60 | dispatch.apply( _self, _args );
61 | }, _data.latency );
62 | };
63 |
64 | $( this ).bind( 'scroll', handler ).data( uid2, handler );
65 | },
66 | teardown: function() {
67 | $( this ).unbind( 'scroll', $( this ).data( uid2 ) );
68 | }
69 | };
70 |
--------------------------------------------------------------------------------
/regulations/tests/views_sidebar_tests.py:
--------------------------------------------------------------------------------
1 | import re
2 | from unittest import TestCase
3 |
4 | from mock import patch
5 | from django.test.client import Client
6 |
7 | from regulations.generator import node_types
8 |
9 |
10 | class ViewsSideBarViewTest(TestCase):
11 | """Integration tests for the sidebar"""
12 |
13 | @patch('regulations.views.sidebar.api_reader')
14 | def test_get(self, api_reader):
15 | api_reader.ApiReader.return_value.layer.return_value = {
16 | '876-12': [
17 | {'reference': ['1992-1', '876-12']},
18 | {'reference': ['1992-2', '876-12']},
19 | ],
20 | '876-12-a': [{'reference': ['1992-1', '876-12-a']}]
21 | }
22 | api_reader.ApiReader.return_value.regulation.return_value = {
23 | 'label': ['876', '12'],
24 | 'node_type': node_types.REGTEXT,
25 | 'children': [
26 | {'label': ['876', '12', 'a'], 'children': [],
27 | 'node_type': node_types.REGTEXT},
28 | {'label': ['876', '12', 'b'], 'children': [],
29 | 'node_type': node_types.REGTEXT},
30 | {'label': ['876', '12', 'c'], 'node_type': node_types.REGTEXT,
31 | 'children': [
32 | {'label': ['876', '12', 'c', '1'], 'children': [],
33 | 'node_type': node_types.REGTEXT}]}
34 | ]
35 | }
36 | response = Client().get('/partial/sidebar/1111-7/verver')
37 |
38 | sxs_start = response.content.find('
22 | {% if node.children %}
23 |
49 |
50 | 24 | This definition is best viewed in its original location. 25 |
26 | {% elif node.marked_up %} 27 |28 | {{node.marked_up|safe}} 29 |
30 | {% endif %} 31 | 32 | {{formatted_label}} 35 | 36 | {% if not node.children %} 37 | {% if node.interp %} 38 | {% with interp=node.interp.interps.0 %} 39 | Official Interpretation 43 | {% endwith %} 44 | {% endif %} 45 | {% endif %} 46 | 47 | Close definition 48 |
30 |
49 | {% endblock %}
50 | Textual Help
31 | (What's this?) 32 | 33 |-
34 |
-
35 |
36 | Defined Term37 |
38 |
-
39 |
40 | Link within a regulation42 |
41 | (example: 1005.8(b))
43 | -
44 |
47 |
4 |
5 |
6 | {% block reg_title %}
7 | {% endblock %}
8 |
9 | {% update_in_progress label_id as reg_update_in_progress %}
10 | {% if new_version or reg_update_in_progress %}
11 |
40 |
41 |
42 |
43 |
44 |
54 |
--------------------------------------------------------------------------------
/regulations/static/regulations/js/source/regulations.js:
--------------------------------------------------------------------------------
1 | // Launches app
2 | 'use strict';
3 | // make jQuery globally accessible for plugins and analytics
4 | global.$ = global.jQuery = require( 'jquery' );
5 | var app = require( './app-init' );
6 |
7 | // A `bind()` polyfill
8 | if ( !Function.prototype.bind ) {
9 | Function.prototype.bind = function( oThis ) {
10 | if ( typeof this !== 'function' ) {
11 | // closest thing possible to the ECMAScript 5 internal IsCallable function
12 | throw new TypeError( 'Function.prototype.bind - what is trying to be bound is not callable' );
13 | }
14 |
15 | var aArgs = Array.prototype.slice.call( arguments, 1 ),
16 | fToBind = this,
17 | FNOP = function() {},
18 | fBound = function() {
19 | return fToBind.apply( this instanceof FNOP && oThis ? this : oThis, aArgs.concat( Array.prototype.slice.call( arguments ) ) );
20 | };
21 |
22 | FNOP.prototype = this.prototype;
23 | fBound.prototype = new FNOP();
24 |
25 | return fBound;
26 | };
27 | }
28 |
29 | // a 'window.location.origin' polyfill for IE10
30 | // http://tosbourn.com/2013/08/javascript/a-fix-for-window-location-origin-in-internet-explorer/
31 | if ( !window.location.origin ) {
32 | window.location.origin = window.location.protocol + '//' + window.location.hostname + ( window.location.port ? ':' + window.location.port : '' );
33 | }
34 |
35 | $( document ).ready( function() {
36 | app.init();
37 | } );
38 |
39 | // tests for some accessibility misses
40 | // use in browser console with AccessibilityTest()
41 | window.AccessibilityTest = function() {
42 | // I think this will keep IE from crying?
43 | var console = console || { error: function() {} };
44 |
45 | /* eslint-disable */
46 | $('img').each(function() {
47 | if (typeof this.attributes.alt === 'undefined') {
48 | console.error('Image does not have alt text', this);
49 | }
50 | });
51 |
52 | $('p, h1, h2, h3, h4, h5, h6, div, span').each(function() {
53 | if ($(this).css('font-size').indexOf('em') === -1 && $(this).css('font-size').indexOf('px') > 0) {
54 | console.error('Font size is set in px, not ems', this);
55 | }
56 | });
57 | /* eslint-enable */
58 | };
59 |
--------------------------------------------------------------------------------
/regulations/tests/views_landing_tests.py:
--------------------------------------------------------------------------------
1 | from unittest import TestCase
2 | from mock import patch
3 |
4 | from regulations.views import reg_landing
5 |
6 |
7 | class LandingViewTest(TestCase):
8 |
9 | @patch('regulations.views.reg_landing.api_reader')
10 | def test_regulation_exists_not(self, api_reader):
11 | api_reader.ApiReader.return_value.regversions.return_value = None
12 | reg_versions = reg_landing.regulation_exists('204')
13 | self.assertFalse(reg_versions)
14 |
15 | @patch('regulations.views.reg_landing.api_reader')
16 | def test_regulation_exists(self, api_reader):
17 | api_reader.ApiReader.return_value.regversions.return_value = [{'version':'exists'}]
18 | reg_versions = reg_landing.regulation_exists('204')
19 | self.assertTrue(reg_versions)
20 |
21 | @patch('regulations.views.reg_landing.fetch_grouped_history')
22 | def test_get_versions(self, fetch_grouped_history):
23 | fetch_grouped_history.return_value = [
24 | {'timeline': 'future', 'version': 'a'},
25 | {'timeline': 'current', 'version': 'b'}]
26 | current_ver, next_ver = reg_landing.get_versions('204')
27 | self.assertEqual({'timeline': 'current', 'version': 'b'}, current_ver)
28 | self.assertEqual({'timeline': 'future', 'version': 'a'}, next_ver)
29 |
30 | @patch('regulations.views.reg_landing.fetch_grouped_history')
31 | def test_get_versions_no_next(self, fetch_grouped_history):
32 | fetch_grouped_history.return_value = [
33 | {'timeline': 'current', 'version': 'b'}]
34 | current_ver, next_ver = reg_landing.get_versions('204')
35 | self.assertEqual({'timeline': 'current', 'version': 'b'}, current_ver)
36 | self.assertEqual(None, next_ver)
37 |
38 | @patch('regulations.views.reg_landing.fetch_grouped_history')
39 | def test_get_versions_no_current(self, fetch_grouped_history):
40 | fetch_grouped_history.return_value = [
41 | {'timeline': 'future', 'version': 'b'}
42 | ]
43 | current_ver, next_ver = reg_landing.get_versions('204')
44 | self.assertEqual({'timeline': 'future', 'version': 'b'}, current_ver)
45 | self.assertEqual({'timeline': 'future', 'version': 'b'}, next_ver)
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "regulations-site",
3 | "version": "0.1.0",
4 | "homepage": "http://cfpb.github.io/eRegulations/",
5 | "author": {
6 | "name": "Consumer Financial Protection Bureau",
7 | "url": "http://cfpb.github.io/"
8 | },
9 | "repository": {
10 | "type": "git",
11 | "url": "http://github.com/cfpb/regulations-site.git"
12 | },
13 | "bugs": {
14 | "url": "http://github.com/cfpb/regulations-site/issues"
15 | },
16 | "licenses": [
17 | {
18 | "type": "Public Domain",
19 | "url": "http://github.com/cfpb/regulations-site/blob/master/TERMS.md"
20 | }
21 | ],
22 | "engines": {
23 | "node": ">=0.12.0"
24 | },
25 | "scripts": {
26 | "postinstall": "grunt",
27 | "test": "npm run test:js && npm run test:snyk",
28 | "test:js": "grunt test-js",
29 | "test:snyk": "snyk test"
30 | },
31 | "devDependencies": {
32 | "browserify": "14.1.0",
33 | "browserify-shim": "3.8.3",
34 | "chai": "2.1.1",
35 | "chai-jq": "0.0.9",
36 | "coveralls": "2.11.2",
37 | "expect.js": "0.2.0",
38 | "grunt": "0.4.5",
39 | "grunt-browserify": "3.4.0",
40 | "grunt-contrib-copy": "0.8.2",
41 | "grunt-contrib-cssmin": "0.12.3",
42 | "grunt-contrib-less": "1.0.0",
43 | "grunt-contrib-uglify": "0.8.0",
44 | "grunt-contrib-watch": "0.6.1",
45 | "grunt-eslint": "20.0.0",
46 | "grunt-mocha-istanbul": "3.0.1",
47 | "grunt-shell": "0.4.0",
48 | "istanbul": "0.4.2",
49 | "jsdom": "8.0.2",
50 | "jsdom-global": "1.6.1",
51 | "load-grunt-tasks": "3.1.0",
52 | "mocha": "2.4.5",
53 | "sinon": "1.14.1",
54 | "sinon-chai": "2.7.0",
55 | "snyk": "1.13.2",
56 | "tmp": "0.0.23",
57 | "watch": "0.8.0"
58 | },
59 | "keywords": [],
60 | "browser": {
61 | "jquery": "./node_modules/jquery/dist/jquery.js"
62 | },
63 | "browserify-shim": {
64 | "jquery": {
65 | "exports": "jQuery"
66 | }
67 | },
68 | "dependencies": {
69 | "backbone": "1.0.0",
70 | "backbone-query-parameters": "0.4.0",
71 | "jquery": "1.12.3",
72 | "jquery-scrollstop": "1.2.0",
73 | "respond.js": "1.4.2",
74 | "underscore": "1.4.4",
75 | "unveilable": "0.2.0"
76 | },
77 | "config": {
78 | "travis-cov": {
79 | "threshold": 70
80 | }
81 | }
82 | }
83 |
--------------------------------------------------------------------------------
/regulations/static/regulations/js/source/views/sidebar/sxs-list-view.js:
--------------------------------------------------------------------------------
1 | 'use strict';
2 | var $ = require( 'jquery' );
3 | var _ = require( 'underscore' );
4 | var Backbone = require( 'backbone' );
5 | var SxSList = require( './sxs-list-view' );
6 | var SidebarListView = require( './sidebar-list-view' );
7 | var Router = require( '../../router' );
8 | var BreakawayEvents = require( '../../events/breakaway-events' );
9 | var GAEvents = require( '../../events/ga-events' );
10 | var Helpers = require( '../../helpers.js' );
11 |
12 | Backbone.$ = $;
13 |
14 | var SxSListView = SidebarListView.extend( {
15 | el: '#sxs-list',
16 |
17 | events: {
18 | 'click .sxs-link': 'openSxS'
19 | },
20 |
21 | initialize: function() {
22 | this.render = _.bind( this.render, this );
23 | this.modifyListDisplay();
24 |
25 | // if the browser doesn't support pushState, don't
26 | // trigger click events for links
27 | if ( Router.hasPushState === false ) {
28 | this.events = {};
29 | }
30 | },
31 |
32 | openSxS: function( e ) {
33 | e.preventDefault();
34 |
35 | var $sxsLink = $( e.target ),
36 | id = $sxsLink.data( 'sxs-paragraph-id' ),
37 | docNumber = $sxsLink.data( 'doc-number' ),
38 | version = $( 'section[data-base-version]' ).data( 'base-version' );
39 |
40 | BreakawayEvents.trigger( 'sxs:open', {
41 | regParagraph: id,
42 | docNumber: docNumber,
43 | fromVersion: version
44 | } );
45 |
46 | GAEvents.sendEvent( 'sxs:open', id );
47 | },
48 |
49 | render: function( html ) {
50 | var $html = $( html ),
51 | list = $html.find( '#sxs-list' ).html();
52 | this.$el.html( list );
53 |
54 | this.modifyListDisplay();
55 | },
56 |
57 | modifyListDisplay: function() {
58 | var $folderContent = this.$el.find( '.expand-drawer' );
59 | if ( $folderContent.children().length > 1 ) {
60 | this.highlightHeader();
61 | // toggle the SxS slider open if there is content
62 | this.toggleSxS();
63 | }
64 | },
65 |
66 | highlightHeader: function() {
67 | this.$el.find( 'header' ).addClass( 'has-content' );
68 | },
69 |
70 | toggleSxS: function() {
71 | Helpers.toggleExpandable( $( '#sxs-expandable-header' ), 0 );
72 | }
73 |
74 | } );
75 |
76 | module.exports = SxSListView;
77 |
--------------------------------------------------------------------------------
/regulations/generator/versions.py:
--------------------------------------------------------------------------------
1 | from datetime import datetime
2 |
3 | from regulations.generator import api_reader
4 | from regulations.generator.layers.utils import convert_to_python
5 |
6 |
7 | def fetch_regulations_and_future_versions():
8 | """ Returns a dict for all the regulations in the API. The dict includes
9 | lists of future versions for each regulation. """
10 | client = api_reader.ApiReader()
11 | all_versions = client.all_regulations_versions()
12 | all_versions = convert_to_python(all_versions)
13 |
14 | regulations_future = {}
15 |
16 | #We're only interested in future endpoint versions
17 | for v in all_versions['versions']:
18 | if v['regulation'] not in regulations_future:
19 | regulations_future[v['regulation']] = []
20 | if 'by_date' in v:
21 | regulations_future[v['regulation']].append(v)
22 | return regulations_future
23 |
24 |
25 | def fetch_grouped_history(part):
26 | client = api_reader.ApiReader()
27 | versions = filter(lambda v: 'by_date' in v,
28 | client.regversions(part)['versions'])
29 | for version in versions:
30 | version['notices'] = []
31 | versions = sorted(convert_to_python(versions), reverse=True,
32 | key=lambda v: v['by_date'])
33 |
34 | today = datetime.today()
35 | seen_current = False
36 |
37 | for version in versions:
38 | if version['by_date'] > today:
39 | version['timeline'] = 'future'
40 | elif not seen_current:
41 | seen_current = True
42 | version['timeline'] = 'current'
43 | else:
44 | version['timeline'] = 'past'
45 |
46 | for notice in client.notices(part)['results']:
47 | notice = convert_to_python(notice)
48 | for v in (v for v in versions
49 | if v['by_date'] == notice['effective_on']):
50 | # Continue if a notice with the same fr_url is already in the list
51 | if not any(n['fr_url'] == notice['fr_url'] for n in v['notices']):
52 | v['notices'].append(notice)
53 |
54 | for version in versions:
55 | version['notices'] = sorted(version['notices'], reverse=True,
56 | key=lambda n: n['publication_date'])
57 |
58 | return versions
59 |
--------------------------------------------------------------------------------
/regulations/generator/title_parsing.py:
--------------------------------------------------------------------------------
1 | #vim: set fileencoding=utf-8
2 | import re
3 |
4 | from regulations.generator import node_types
5 |
6 |
7 | def appendix_supplement(data):
8 | """Handle items pointing to an appendix or supplement"""
9 | node_type = node_types.type_from_label(data['index'])
10 | if len(data['index']) == 2 and node_type in (node_types.APPENDIX,
11 | node_types.INTERP):
12 | element = {}
13 | if node_type == node_types.INTERP:
14 | element['is_supplement'] = True
15 | else:
16 | element['is_appendix'] = True
17 |
18 | segments = try_split(data['title'])
19 | if segments:
20 | element['label'], element['sub_label'] = segments[:2]
21 | elif '[' in data['title']:
22 | position = data['title'].find('[')
23 | element['label'] = data['title'][:position].strip()
24 | element['sub_label'] = data['title'][position:]
25 | else:
26 | element['label'] = data['title']
27 |
28 | element['section_id'] = '-'.join(data['index'])
29 | return element
30 |
31 |
32 | def try_split(text, chars=(u'—', '-')):
33 | """Utility method for splitting a string by one of multiple chars"""
34 | for c in chars:
35 | segments = text.split(c)
36 | if len(segments) > 1:
37 | return [s.strip() for s in segments]
38 |
39 |
40 | def section(data):
41 | """ Parse out parts of a section title. """
42 | if len(data['index']) == 2 and data['index'][1].isdigit():
43 | element = {}
44 | element['is_section'] = True
45 | element['label'] = '.'.join(data['index'])
46 | element['section_id'] = '-'.join(data['index'])
47 |
48 | # Due to inconsistencies in source data we need to be able to handle
49 | # several different possible section title formats:
50 | #
51 | # 1003.2 Something
52 | # § 1003.2 Something
53 | # Something
54 | # § Something
55 | #
56 | # In all of these cases, the sublabel should be "Something".
57 | title_no_label = data['title'].split(element['label'])[-1]
58 | sublabel_regex = re.compile(r'[^\w\[]*(.*)')
59 | element['sub_label'] = sublabel_regex.search(title_no_label).group(1)
60 |
61 | return element
62 |
--------------------------------------------------------------------------------
/regulations/generator/layers/definitions.py:
--------------------------------------------------------------------------------
1 | from django.template import loader, Context
2 |
3 | from regulations.generator.section_url import SectionUrl
4 | from ..node_types import to_markup_id
5 | import utils
6 |
7 |
8 | class DefinitionsLayer(object):
9 | shorthand = 'terms'
10 |
11 | def __init__(self, layer):
12 | self.layer = layer
13 | self.template = loader.get_template(
14 | 'regulations/layers/definition_citation.html')
15 | self.sectional = False
16 | self.version = None
17 | self.rev_urls = SectionUrl()
18 | self.rendered = {}
19 | # precomputation
20 | for def_struct in self.layer['referenced'].values():
21 | def_struct['reference_split'] = def_struct['reference'].split('-')
22 |
23 | def create_definition_link(self, original_text, citation, term):
24 | """ Create the link that takes you to the definition of the term. """
25 | key = (original_text, tuple(citation))
26 | if key not in self.rendered:
27 | context = {
28 | 'citation': {
29 | 'url': self.rev_urls.fetch(citation, self.version,
30 | self.sectional),
31 | 'label': original_text,
32 | 'term': term,
33 | 'definition_reference': '-'.join(to_markup_id(citation))}}
34 | rendered = utils.render_template(self.template, context)
35 | self.rendered[key] = rendered
36 | return self.rendered[key]
37 |
38 | def apply_layer(self, text, text_index):
39 | """Catch all terms which are defined elsewhere and replace them with
40 | a link"""
41 | layer_pairs = []
42 | if text_index in self.layer:
43 | layer_elements = self.layer[text_index]
44 | for layer_element in layer_elements:
45 | ref = layer_element['ref']
46 | # term = term w/o pluralization
47 | term = self.layer['referenced'][ref]['term']
48 | ref = self.layer['referenced'][ref]['reference_split']
49 | for start, end in layer_element['offsets']:
50 | ot = text[start:end]
51 | rt = self.create_definition_link(ot, ref, term)
52 | layer_pairs.append((ot, rt, (start, end)))
53 | return layer_pairs
54 |
--------------------------------------------------------------------------------
/regulations/tests/title_parsing_tests.py:
--------------------------------------------------------------------------------
1 | from unittest import TestCase
2 | from regulations.generator import title_parsing
3 |
4 |
5 | class RegTest(TestCase):
6 | def test_try_split(self):
7 | self.assertEqual(
8 | ['a', 'xb'],
9 | title_parsing.try_split('a:xb', ('|', ':', 'x')))
10 |
11 | def test_appendix_supplement_ap(self):
12 | elements = title_parsing.appendix_supplement({
13 | 'index': ['204', 'A2'],
14 | 'title': 'Appendix A2 to 204-First Appendix'})
15 | self.assertTrue(elements['is_appendix'])
16 | elements = title_parsing.appendix_supplement({
17 | 'index': ['204', 'A'],
18 | 'title': 'Appendix A to 204-First Appendix'})
19 | self.assertTrue(elements['is_appendix'])
20 |
21 | def test_section(self):
22 | elements = title_parsing.section({
23 | 'index': ['204', '4'],
24 | 'title': '204.4 Sauce'})
25 |
26 | self.assertTrue(elements['is_section'])
27 | self.assertEquals('Sauce', elements['sub_label'])
28 |
29 | elements = title_parsing.section({
30 | 'index': ['204', '4'],
31 | 'title': '204.4 [Reserved]'})
32 |
33 | self.assertTrue(elements['is_section'])
34 | self.assertEquals('[Reserved]', elements['sub_label'])
35 |
36 | def test_section_with_leading_symbol(self):
37 | elements = title_parsing.section({
38 | 'index': ['204', '4'],
39 | 'title': '\xc2\xa7 204.4 Foo bar',
40 | })
41 | self.assertEqual(elements['sub_label'], 'Foo bar')
42 |
43 | def test_section_with_leading_section(self):
44 | elements = title_parsing.section({
45 | 'index': ['204', '4'],
46 | 'title': '204.4 Foo bar',
47 | })
48 | self.assertEqual(elements['sub_label'], 'Foo bar')
49 |
50 | def test_section_without_leading_section(self):
51 | elements = title_parsing.section({
52 | 'index': ['204', '4'],
53 | 'title': 'Foo bar',
54 | })
55 | self.assertEqual(elements['sub_label'], 'Foo bar')
56 |
57 | def test_section_with_leading_symbol_but_without_leading_section(self):
58 | elements = title_parsing.section({
59 | 'index': ['204', '4'],
60 | 'title': '\xc2\xa7 Foo bar',
61 | })
62 | self.assertEqual(elements['sub_label'], 'Foo bar')
63 |
--------------------------------------------------------------------------------
12 | {% if new_version %}
13 |
28 | {% endif %}
29 |
30 | {% block reg_main_content %}
31 | {% endblock %}
32 | {% block reg_addtl_content %}
33 | {% endblock %}
34 |
35 |
14 |
23 | {% endif %}
24 | {% if reg_update_in_progress %}
25 | {% include "regulations/update-alert.html" %}
26 | {% endif %}
27 |
15 | New amendments effective: {{new_version.by_date|date:"m/d/Y"}}
16 |
17 |
18 |
19 | View amended regulation
20 |
21 |
22 |
36 | {% block legal_disclaimer %}
37 | {% endblock %}
38 |
39 |