From 36effd9fc646bb4a23b3e502a75a1c3ab6777369 Mon Sep 17 00:00:00 2001 From: Sascha Gottfried Date: Tue, 4 Feb 2014 11:32:18 +0100 Subject: [PATCH 01/27] start to pin versions for deform, requests and pyramid in setup.py, depend on SQLAlchey 0.8.0 in requirements.txt, add first Integration test, remove unused context from views.ToDoViews, apply this change in README as well --- README.md | 6 ++--- requirements.txt | 10 ++++---- setup.py | 9 +++---- todopyramid/tests.py | 57 ++++++++++++++++++++++++++++++-------------- todopyramid/views.py | 3 +-- 5 files changed, 53 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index b2320c2..e346765 100644 --- a/README.md +++ b/README.md @@ -207,9 +207,9 @@ from .layouts import Layouts class ToDoViews(Layouts): - def __init__(self, context, request): - self.context = context + def __init__(self, request): self.request = request + self.context = request.context @view_config(route_name='home', renderer='templates/home.pt') def home_view(request): @@ -220,7 +220,7 @@ class ToDoViews(Layouts): Now we can add a `todopyramid/templates/home.pt` to our app with the following ``` - +

Home

Welcome to the Pyramid version of the ToDo app.

diff --git a/requirements.txt b/requirements.txt index aaa61d9..4ce5b0d 100644 --- a/requirements.txt +++ b/requirements.txt @@ -4,18 +4,18 @@ MarkupSafe==0.15 PasteDeploy==1.5.0 PyBrowserID==0.9.1 Pygments==1.6 -SQLAlchemy==0.8.0b2 +SQLAlchemy==0.8.0 WebHelpers==1.3 WebOb==1.2.3 -bag==0.3.2 +bag==0.3.4 colander==1.0a2 deform==0.9.6 -deform-bootstrap==0.2.6 -deform-bootstrap-extra==0.2 +deform-bootstrap==0.2.8 +deform-bootstrap-extra==0.2.8 distribute==0.6.35 ipython==0.13.1 peppercorn==0.4 -pyramid==1.4 +pyramid==1.4.3 pyramid-debugtoolbar==1.0.4 pyramid-deform==0.2a5 pyramid-persona==1.3.1 diff --git a/setup.py b/setup.py index 3cb5700..2c3826d 100644 --- a/setup.py +++ b/setup.py @@ -7,18 +7,19 @@ CHANGES = open(os.path.join(here, 'CHANGES.txt')).read() requires = [ - 'pyramid', + 'pyramid==1.4.3', 'SQLAlchemy', - 'transaction', 'pyramid_tm', 'pyramid_debugtoolbar', 'zope.sqlalchemy', 'waitress', - 'deform_bootstrap', - 'deform_bootstrap_extra', + 'deform<=1.999', + 'deform_bootstrap==0.2.8', + 'deform_bootstrap_extra==0.2.8', 'pyramid_persona', 'WebHelpers', 'pytz', + 'requests==1.1.0' ] setup( diff --git a/todopyramid/tests.py b/todopyramid/tests.py index 621ff7f..1035ff9 100644 --- a/todopyramid/tests.py +++ b/todopyramid/tests.py @@ -3,31 +3,52 @@ from pyramid import testing -from .models import DBSession +from .models import ( + DBSession, + TodoUser, + Base, + ) +def _initTestingDB(): + """setup testing DB, insert sample entry and return Session + + http://docs.pylonsproject.org/projects/pyramid/en/1.5-branch/quick_tutorial/databases.html + """ + from sqlalchemy import create_engine + engine = create_engine('sqlite://') + from .models import ( + Base, + TodoUser, + ) + DBSession.configure(bind=engine) + Base.metadata.create_all(engine) + with transaction.manager: + user = TodoUser( + email=u'king.arthur@example.com', + first_name=u'Arthur', + last_name=u'Pendragon', + ) + DBSession.add(user) + + return DBSession -class TestMyView(unittest.TestCase): + +class TestHomeView(unittest.TestCase): def setUp(self): + self.session = _initTestingDB() self.config = testing.setUp() - from sqlalchemy import create_engine - engine = create_engine('sqlite://') - from .models import ( - Base, - MyModel, - ) - DBSession.configure(bind=engine) - Base.metadata.create_all(engine) - with transaction.manager: - model = MyModel(name='one', value=55) - DBSession.add(model) def tearDown(self): - DBSession.remove() + self.session.remove() testing.tearDown() def test_it(self): - from .views import my_view + from .views import ToDoViews + request = testing.DummyRequest() - info = my_view(request) - self.assertEqual(info['one'].name, 'one') - self.assertEqual(info['project'], 'todopyramid') + inst = ToDoViews(request) + response = inst.home_view() + self.assertEqual(response['user'], None) + self.assertEqual(response['count'], None) + self.assertEqual(response['section'], 'home') + diff --git a/todopyramid/views.py b/todopyramid/views.py index f14c7e3..c30c6db 100644 --- a/todopyramid/views.py +++ b/todopyramid/views.py @@ -32,10 +32,9 @@ class ToDoViews(Layouts): base class has the master template set up. """ - def __init__(self, context, request): + def __init__(self, request): """Set some common variables needed for each view. """ - self.context = context self.request = request self.user_id = authenticated_userid(request) self.todo_list = [] From 7026b525e439c3391387b391d64c2cfca1fb2f32 Mon Sep 17 00:00:00 2001 From: Sascha Gottfried Date: Tue, 4 Feb 2014 21:40:54 +0100 Subject: [PATCH 02/27] refactor Items<->Tags many-to-many relationship in order to enable testability of TodoItem, add several tests inserting TodoItems, all tests pass, update version in setup.py to 1.1, move model-related code from scripts.initializedb.main to create_dummy_content --- production.ini | 6 +- setup.py | 2 +- todopyramid/models.py | 82 ++++++++++----- todopyramid/scripts/initializedb.py | 122 ++++++++++++----------- todopyramid/tests.py | 148 ++++++++++++++++++++++++++-- todopyramid/views.py | 2 + 6 files changed, 268 insertions(+), 94 deletions(-) diff --git a/production.ini b/production.ini index 0d47e8e..e2bf07f 100644 --- a/production.ini +++ b/production.ini @@ -17,15 +17,15 @@ pyramid.includes = sqlalchemy.url = sqlite:///%(here)s/todopyramid.sqlite persona.secret = s00per s3cr3t -persona.audiences = http://demo.todo.sixfeetup.com +persona.audiences = todopyramid.localhost persona.siteName = ToDo Pyramid # Option to generate content for new users to try out -todopyramid.generate_content = true +todopyramid.generate_content = false [server:main] use = egg:waitress#main -host = 0.0.0.0 +host = 127.0.0.1 port = 6543 ### diff --git a/setup.py b/setup.py index 2c3826d..31f0e5b 100644 --- a/setup.py +++ b/setup.py @@ -24,7 +24,7 @@ setup( name='todopyramid', - version='1.0', + version='1.1', description='todopyramid', long_description=README + '\n\n' + CHANGES, classifiers=[ diff --git a/todopyramid/models.py b/todopyramid/models.py index ebbdcdf..333a362 100644 --- a/todopyramid/models.py +++ b/todopyramid/models.py @@ -18,12 +18,7 @@ DBSession = scoped_session(sessionmaker(extension=ZopeTransactionExtension())) Base = declarative_base() -todoitemtag_table = Table( - 'todoitemtag', - Base.metadata, - Column('tag_id', Integer, ForeignKey('tags.name')), - Column('todo_id', Integer, ForeignKey('todoitems.id')), -) + class RootFactory(object): @@ -36,16 +31,12 @@ class RootFactory(object): def __init__(self, request): pass - -class Tag(Base): - """The Tag model is a many to many relationship to the TodoItem. - """ - __tablename__ = 'tags' - name = Column(Text, primary_key=True) - todoitem_id = Column(Integer, ForeignKey('todoitems.id')) - - def __init__(self, name): - self.name = name +todoitemtag_table = Table( + 'todoitemtags', + Base.metadata, + Column('tag_name', Integer, ForeignKey('tags.name')), + Column('todo_id', Integer, ForeignKey('todoitems.id')), +) class TodoItem(Base): @@ -56,8 +47,10 @@ class TodoItem(Base): id = Column(Integer, primary_key=True) task = Column(Text, nullable=False) due_date = Column(DateTime) - user = Column(Integer, ForeignKey('users.email'), nullable=False) - tags = relationship(Tag, secondary=todoitemtag_table, lazy='dynamic') + user = Column(Integer, ForeignKey('users.email')) + + # # many to many TodoItem<->Tag + tags = relationship("Tag", secondary=todoitemtag_table, backref="todos") def __init__(self, user, task, tags=None, due_date=None): self.user = user @@ -71,13 +64,36 @@ def apply_tags(self, tags): creates the associated tag object. We strip off whitespace and lowercase the tags to keep a normalized list. """ + for tag_name in tags: - tag = tag_name.strip().lower() - self.tags.append(DBSession.merge(Tag(tag))) + tag_name = self.sanitize_tag(tag_name) + tag = self._find_or_create_tag(tag_name) + self.tags.append(tag) + + def sanitize_tag(self, tag_name): + """tag name input validation""" + tag = tag_name.strip().lower() + return tag + + def _find_or_create_tag(self, tag_name): + """ensure tag names are unique + + http://stackoverflow.com/questions/2310153/inserting-data-in-many-to-many-relationship-in-sqlalchemy + + why we need that - prevent multiple tags + http://stackoverflow.com/questions/13149829/many-to-many-in-sqlalchemy-preventing-sqlalchemy-from-inserting-into-a-table-if + """ + q = DBSession.query(Tag).filter_by(name=tag_name) + t = q.first() + if not(t): + t = Tag(tag_name) + return t @property def sorted_tags(self): """Return a list of sorted tags for this task. + + TODO: we can apply sorting using the relationship """ return sorted(self.tags, key=lambda x: x.name) @@ -89,6 +105,23 @@ def past_due(self): return self.due_date and self.due_date < datetime.utcnow() +class Tag(Base): + """The Tag model is a many to many relationship to the TodoItem. + + http://docs.sqlalchemy.org/en/rel_0_9/orm/tutorial.html#building-a-many-to-many-relationship + """ + __tablename__ = 'tags' + + #id = Column(Integer, primary_key=True) + #name = Column(Text, nullable=False, unique=True) + + name = Column(Text, primary_key=True) + + + def __init__(self, name): + self.name = name + + class TodoUser(Base): """When a user signs in with their persona, this model is what stores their account information. It has a one to many relationship @@ -111,11 +144,14 @@ def __init__(self, email, first_name=None, last_name=None, @property def user_tags(self): """Find all tags a user has created + + TODO: This can not be answered by the model + I could not find a concept of user created tags + Currently we create user-related todoitems linking to tags that could have been created by other users """ - qry = self.todo_list.session.query(todoitemtag_table.columns['tag_id']) + qry = self.todo_list.session.query(todoitemtag_table.columns['tag_name']) qry = qry.join(TodoItem).filter_by(user=self.email) - qry = qry.group_by('tag_id') - qry = qry.order_by('tag_id') + #qry = qry.group_by('tag_name') return qry.all() @property diff --git a/todopyramid/scripts/initializedb.py b/todopyramid/scripts/initializedb.py index e258a1e..5f18492 100644 --- a/todopyramid/scripts/initializedb.py +++ b/todopyramid/scripts/initializedb.py @@ -26,58 +26,69 @@ def usage(argv): sys.exit(1) -def create_dummy_content(user_id): +def create_dummy_content(): """Create some tasks by default to show off the site """ - task = TodoItem( - user=user_id, - task=u'Find a shrubbery', - tags=[u'quest', u'ni', u'knight'], - due_date=datetime.utcnow() + timedelta(days=60), - ) - DBSession.add(task) - task = TodoItem( - user=user_id, - task=u'Search for the holy grail', - tags=[u'quest'], - due_date=datetime.utcnow() - timedelta(days=1), - ) - DBSession.add(task) - task = TodoItem( - user=user_id, - task=u'Recruit Knights of the Round Table', - tags=[u'quest', u'knight', u'discuss'], - due_date=datetime.utcnow() + timedelta(minutes=45), - ) - DBSession.add(task) - task = TodoItem( - user=user_id, - task=u'Build a Trojan Rabbit', - tags=[u'quest', u'rabbit'], - due_date=datetime.utcnow() + timedelta(days=1), - ) - DBSession.add(task) - task = TodoItem( - user=user_id, - task=u'Talk to Tim the Enchanter', - tags=[u'quest', u'discuss'], - due_date=datetime.utcnow() + timedelta(days=90), - ) - DBSession.add(task) - task = TodoItem( - user=user_id, - task=u'Defeat the Rabbit of Caerbannog', - tags=[u'quest', u'rabbit'], - due_date=None, - ) - DBSession.add(task) - task = TodoItem( - user=user_id, - task=u'Cross the Bridge of Death', - tags=[u'quest'], - due_date=None, - ) - DBSession.add(task) + with transaction.manager: + + user = TodoUser( + email=u'king.arthur@example.com', + first_name=u'Arthur', + last_name=u'Pendragon', + ) + DBSession.add(user) + + + user_id = user.email + task = TodoItem( + user=user_id, + task=u'Find a shrubbery', + tags=[u'quest', u'ni', u'knight'], + due_date=datetime.utcnow() + timedelta(days=60), + ) + DBSession.add(task) + task = TodoItem( + user=user_id, + task=u'Search for the holy grail', + tags=[u'quest'], + due_date=datetime.utcnow() - timedelta(days=1), + ) + DBSession.add(task) + task = TodoItem( + user=user_id, + task=u'Recruit Knights of the Round Table', + tags=[u'quest', u'knight', u'discuss'], + due_date=datetime.utcnow() + timedelta(minutes=45), + ) + DBSession.add(task) + task = TodoItem( + user=user_id, + task=u'Build a Trojan Rabbit', + tags=[u'quest', u'rabbit'], + due_date=datetime.utcnow() + timedelta(days=1), + ) + DBSession.add(task) + task = TodoItem( + user=user_id, + task=u'Talk to Tim the Enchanter', + tags=[u'quest', u'discuss'], + due_date=datetime.utcnow() + timedelta(days=90), + ) + DBSession.add(task) + task = TodoItem( + user=user_id, + task=u'Defeat the Rabbit of Caerbannog', + tags=[u'quest', u'rabbit'], + due_date=None, + ) + DBSession.add(task) + task = TodoItem( + user=user_id, + task=u'Cross the Bridge of Death', + tags=[u'quest'], + due_date=None, + ) + DBSession.add(task) def main(argv=sys.argv): @@ -89,11 +100,6 @@ def main(argv=sys.argv): engine = engine_from_config(settings, 'sqlalchemy.') DBSession.configure(bind=engine) Base.metadata.create_all(engine) - with transaction.manager: - user = TodoUser( - email=u'king.arthur@example.com', - first_name=u'Arthur', - last_name=u'Pendragon', - ) - DBSession.add(user) - create_dummy_content(u'king.arthur@example.com') + create_dummy_content() + + diff --git a/todopyramid/tests.py b/todopyramid/tests.py index 1035ff9..ff176c8 100644 --- a/todopyramid/tests.py +++ b/todopyramid/tests.py @@ -22,18 +22,20 @@ def _initTestingDB(): ) DBSession.configure(bind=engine) Base.metadata.create_all(engine) - with transaction.manager: - user = TodoUser( - email=u'king.arthur@example.com', - first_name=u'Arthur', - last_name=u'Pendragon', - ) - DBSession.add(user) return DBSession +def _insert_first_user(session): + with transaction.manager: + user = TodoUser( + email=u'king.arthur@example.com', + first_name=u'Arthur', + last_name=u'Pendragon', + ) + session.add(user) -class TestHomeView(unittest.TestCase): + +class ModelTests(unittest.TestCase): def setUp(self): self.session = _initTestingDB() self.config = testing.setUp() @@ -42,7 +44,132 @@ def tearDown(self): self.session.remove() testing.tearDown() - def test_it(self): + +class UserModelTests(ModelTests): + + def _getTargetClass(self): + from .models import TodoUser + return TodoUser + + def _makeOne(self, email, first_name=None, last_name=None, time_zone=u'US/Eastern'): + return self._getTargetClass()(email, first_name, last_name, time_zone) + + def test_constructor(self): + instance = self._makeOne(u'king.arthur@example.com', + u'Arthur', + u'Pendragon') + self.assertEqual(instance.email, u'king.arthur@example.com') + self.assertEqual(instance.first_name, u'Arthur') + self.assertEqual(instance.last_name, u'Pendragon') + self.assertEqual(instance.time_zone, u'US/Eastern') + + def test_profile_is_not_complete(self): + instance = self._makeOne(u'king.arthur@example.com', + u'Arthur', + None) + self.assertFalse(instance.profile_complete) + + def test_profile_complete(self): + instance = self._makeOne(u'king.arthur@example.com', + u'Arthur', + u'Pendragon') + self.assertTrue(instance.profile_complete) + + + def test_given_a_new_user_when_I_ask_for_tags_then_I_get_an_empty_list(self): + instance = self._makeOne(u'king.arthur@example.com', + u'Arthur', + u'Pendragon') + self.session.add(instance) + tags = instance.user_tags + self.assertEqual(tags, []) + +class TodoItemModelTests(ModelTests): + + def _getTargetClass(self): + from .models import TodoItem + return TodoItem + + def _makeOne(self, user, task, tags=None, due_date=None): + return self._getTargetClass()(user, task, tags, due_date) + + def test_constructor(self): + instance = self._makeOne(1, + u'Find a shrubbery') + self.assertEqual(instance.user, 1) + self.assertEqual(instance.task, u'Find a shrubbery') + self.assertEqual(instance.due_date, None) + self.assertEqual(instance.tags, []) + + def test_given_that_I_add_a_user_and_insert_a_task_with_several_tags_I_can_access_tag_collection(self): + from .models import Tag + instance = self._makeOne(1, + u'Find a shrubbery', + [u'quest', u'ni', u'knight']) + self.assertEqual(instance.tags[0].name, u'quest') + self.assertEqual(instance.tags[1].name, u'ni') + self.assertEqual(instance.tags[2].name, u'knight') + + def test_tag_todos(self): + from .models import Tag + instance = self._makeOne(1, + u'Find a shrubbery', + [u'quest', u'ni', u'knight']) + self.session.add(instance) + tag = self.session.query(Tag).filter_by(name=u'ni').one() + self.assertEqual(tag.todos[0].task, u'Find a shrubbery') + + + def test_inserting_todoitems_without_transaction_manager_with_same_tags_keep_tags_unique(self): + from .models import Tag + from .models import TodoItem + + instance = self._makeOne(1, + u'Find a shrubbery', + [u'quest', u'ni', u'knight'] + ) + + + self.session.add(instance) + + + instance = self._makeOne(1, + u'Find another shrubbery', + [u'quest', u'ni', u'knight'] + ) + + self.session.add(instance) + + todos = self.session.query(TodoItem).count() + self.assertEqual(todos, 2) + + tag = self.session.query(Tag).filter(Tag.name == u'quest').one() + self.assertEqual(tag.name, u'quest') + + @unittest.skip('skip because it raises IntegrityError') + def test_inserting_multiple_todoitems_with_same_tags_using_addall_keep_tags_unique(self): + from .models import Tag + + first_item = self._makeOne(1, + u'Find a shrubbery', + [u'quest', u'ni', u'knight'] + ) + + second_item = self._makeOne(1, + u'Find another shrubbery', + [u'quest', u'ni', u'knight'] + ) + + self.session.add_all([first_item, second_item]) + + tag = self.session.query(Tag).filter(Tag.name == u'quest').one() + self.assertEqual(tag.name, u'quest') + + + +class TestHomeView(unittest.TestCase): + + def test_anonymous(self): from .views import ToDoViews request = testing.DummyRequest() @@ -51,4 +178,7 @@ def test_it(self): self.assertEqual(response['user'], None) self.assertEqual(response['count'], None) self.assertEqual(response['section'], 'home') + + + diff --git a/todopyramid/views.py b/todopyramid/views.py index c30c6db..3b10c66 100644 --- a/todopyramid/views.py +++ b/todopyramid/views.py @@ -275,6 +275,8 @@ def account_view(self): def tag_autocomplete(self): """Get a list of dictionaries for the given term. This gives the tag input the information it needs to do auto completion. + + TODO: improve model to support user_tags """ term = self.request.params.get('term', '') if len(term) < 2: From 51d238397fa47670d0b01e22b2a0541dc41d4be7 Mon Sep 17 00:00:00 2001 From: Sascha Gottfried Date: Wed, 5 Feb 2014 20:08:48 +0100 Subject: [PATCH 03/27] continue refactoring, move SQLAlchemy related code from views into models to hide model implementation details, better utilize model relationships to enable application features, add more tests, all tests pass --- README.md | 6 ++ todopyramid/models.py | 47 +++++++++- todopyramid/scripts/initializedb.py | 8 +- todopyramid/templates/todo_tags.pt | 4 +- todopyramid/tests.py | 128 ++++++++++++++++++++++++++-- todopyramid/views.py | 55 ++++++++---- 6 files changed, 214 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index e346765..6f10052 100644 --- a/README.md +++ b/README.md @@ -248,6 +248,12 @@ Now that we have created the shell for our app, it is time to create some models We will create a `TodoItem` and `Tag` model to start out with. This will give us the basis for our todo list. + +### Model Relationships + + + + [install]: http://pyramid.readthedocs.org/en/latest/narr/install.html [deform]: http://docs.pylonsproject.org/projects/deform/en/latest/ [deform_bootstrap]: http://pypi.python.org/pypi/deform_bootstrap diff --git a/todopyramid/models.py b/todopyramid/models.py index 333a362..8de9657 100644 --- a/todopyramid/models.py +++ b/todopyramid/models.py @@ -132,6 +132,7 @@ class TodoUser(Base): first_name = Column(Text) last_name = Column(Text) time_zone = Column(Text) + todos = relationship(TodoItem) todo_list = relationship(TodoItem, lazy='dynamic') def __init__(self, email, first_name=None, last_name=None, @@ -145,15 +146,41 @@ def __init__(self, email, first_name=None, last_name=None, def user_tags(self): """Find all tags a user has created - TODO: This can not be answered by the model - I could not find a concept of user created tags - Currently we create user-related todoitems linking to tags that could have been created by other users + returns KeyedTuples with key 'tag_name' + TODO: refactor to return collection of Tag model - consider lazy + + explore code samples - we also have user/author model and a many-to-many relationship between todo and tag + http://docs.sqlalchemy.org/en/rel_0_9/orm/tutorial.html#building-a-many-to-many-relationship """ qry = self.todo_list.session.query(todoitemtag_table.columns['tag_name']) qry = qry.join(TodoItem).filter_by(user=self.email) - #qry = qry.group_by('tag_name') + qry = qry.group_by('tag_name') + qry = qry.order_by('tag_name') return qry.all() + def user_tags_autocomplete(self, term): + """given a term return a unique collection (set) of user tags that start with it + + + In [19]: for todo in user.todos: + for tag in todo.tags: + if tag.name.startswith('ber'): + ....: print tag.name + ....: + berlin + berlin + berlin + berlin + """ + matching_tags = set() + for todo in self.todos: + for tag in todo.tags: + if tag.name.startswith(term): + matching_tags.add(tag) + + return matching_tags + + @property def profile_complete(self): """A check to see if the user has completed their profile. If @@ -161,3 +188,15 @@ def profile_complete(self): settings. """ return self.first_name and self.last_name + + def delete_todo(self, todo_id): + """given a todo ID we delete it is contained in user todos + + there is another way to remove an item from a collection + http://stackoverflow.com/questions/10378468/deleting-an-object-from-collection-in-sqlalchemy""" + todo_item = self.todo_list.filter( + TodoItem.id == todo_id) + + todo_item.delete() + + diff --git a/todopyramid/scripts/initializedb.py b/todopyramid/scripts/initializedb.py index 5f18492..1627761 100644 --- a/todopyramid/scripts/initializedb.py +++ b/todopyramid/scripts/initializedb.py @@ -36,10 +36,10 @@ def create_dummy_content(): first_name=u'Arthur', last_name=u'Pendragon', ) - DBSession.add(user) - - - user_id = user.email + DBSession.add(user) + user_id = user.email + + #this user creates several todo items task = TodoItem( user=user_id, task=u'Find a shrubbery', diff --git a/todopyramid/templates/todo_tags.pt b/todopyramid/templates/todo_tags.pt index 18d7cb2..7c7c924 100644 --- a/todopyramid/templates/todo_tags.pt +++ b/todopyramid/templates/todo_tags.pt @@ -5,9 +5,9 @@

+ tal:content="tag.tag_name"> Tag name

diff --git a/todopyramid/tests.py b/todopyramid/tests.py index ff176c8..ad8145a 100644 --- a/todopyramid/tests.py +++ b/todopyramid/tests.py @@ -76,7 +76,7 @@ def test_profile_complete(self): self.assertTrue(instance.profile_complete) - def test_given_a_new_user_when_I_ask_for_tags_then_I_get_an_empty_list(self): + def test_given_a_new_user_when_I_ask_for_user_tags_then_I_get_an_empty_list(self): instance = self._makeOne(u'king.arthur@example.com', u'Arthur', u'Pendragon') @@ -84,6 +84,73 @@ def test_given_a_new_user_when_I_ask_for_tags_then_I_get_an_empty_list(self): tags = instance.user_tags self.assertEqual(tags, []) + + def test_given_a_new_user_when_I_ask_for_todos_Then_I_get_back_an_empty_list(self): + user = self._makeOne(u'king.arthur@example.com', + u'Arthur', + u'Pendragon') + self.session.add(user) + todos = user.todos + self.assertEqual(todos, []) + + def test_given_a_user_when_I_add_a_todo_Then_I_can_access_from_user(self): + """test user model method to delete a single todo""" + from .models import Tag + from .models import TodoUser + from .models import TodoItem + + user = TodoUser( + email=u'king.arthur@example.com', + first_name=u'Arthur', + last_name=u'Pendragon', + ) + self.session.add(user) + + tags = [u'quest', u'ni', u'knight'] + + todo = TodoItem(user.email, + u'Find a shrubbery', + [u'quest', u'ni', u'knight'] + ) + self.session.add(todo) + + user_todo = user.todo_list.one() + self.assertTrue(todo is user_todo) + + + def test_given_a_user_has_a_todo_When_I_delete_it__Then_it_is_gone(self): + """test user model method to delete a single todo""" + from .models import Tag + from .models import TodoUser + from .models import TodoItem + + user = TodoUser( + email=u'king.arthur@example.com', + first_name=u'Arthur', + last_name=u'Pendragon', + ) + self.session.add(user) + + tags = [u'quest', u'ni', u'knight'] + + todo = TodoItem(user.email, + u'Find a shrubbery', + [u'quest', u'ni', u'knight'] + ) + self.session.add(todo) + + #after inserting we have 1 todo + user_todos = user.todo_list.count() + self.assertEqual(user_todos, 1) + + #after delete we have zero todos + user.delete_todo(todo.id) + user_todos = user.todo_list.count() + self.assertEqual(user_todos, 0) + + + + class TodoItemModelTests(ModelTests): def _getTargetClass(self): @@ -102,6 +169,7 @@ def test_constructor(self): self.assertEqual(instance.tags, []) def test_given_that_I_add_a_user_and_insert_a_task_with_several_tags_I_can_access_tag_collection(self): + """tests model backref todoitem.tags""" from .models import Tag instance = self._makeOne(1, u'Find a shrubbery', @@ -110,7 +178,8 @@ def test_given_that_I_add_a_user_and_insert_a_task_with_several_tags_I_can_acces self.assertEqual(instance.tags[1].name, u'ni') self.assertEqual(instance.tags[2].name, u'knight') - def test_tag_todos(self): + def test_tag_relationship_todos(self): + """test model backref tag.todos""" from .models import Tag instance = self._makeOne(1, u'Find a shrubbery', @@ -127,12 +196,9 @@ def test_inserting_todoitems_without_transaction_manager_with_same_tags_keep_tag instance = self._makeOne(1, u'Find a shrubbery', [u'quest', u'ni', u'knight'] - ) - - + ) self.session.add(instance) - instance = self._makeOne(1, u'Find another shrubbery', [u'quest', u'ni', u'knight'] @@ -143,8 +209,30 @@ def test_inserting_todoitems_without_transaction_manager_with_same_tags_keep_tag todos = self.session.query(TodoItem).count() self.assertEqual(todos, 2) - tag = self.session.query(Tag).filter(Tag.name == u'quest').one() + + + + def test_inserting_2_todoitems_with_same_tags_when_I_ask_for_tag_todos_then_I_get_2(self): + from .models import Tag + from .models import TodoItem + + instance = self._makeOne(1, + u'Find a shrubbery', + [u'quest', u'ni', u'knight'] + ) + self.session.add(instance) + + instance = self._makeOne(1, + u'Find another shrubbery', + [u'quest', u'ni', u'knight'] + ) + + self.session.add(instance) + + #tag is referenced by 2 todo items + tag = self.session.query(Tag).filter(Tag.name == u'quest').one() self.assertEqual(tag.name, u'quest') + self.assertEqual(len(tag.todos), 2) @unittest.skip('skip because it raises IntegrityError') def test_inserting_multiple_todoitems_with_same_tags_using_addall_keep_tags_unique(self): @@ -179,6 +267,32 @@ def test_anonymous(self): self.assertEqual(response['count'], None) self.assertEqual(response['section'], 'home') +class TestTagsView(ModelTests): + + def test_user_tags(self): + """user model property""" + from .models import Tag + from .models import TodoUser + from .models import TodoItem + + user = TodoUser( + email=u'king.arthur@example.com', + first_name=u'Arthur', + last_name=u'Pendragon', + ) + self.session.add(user) + + tags = [u'quest', u'ni', u'knight'] + + todo = TodoItem(user.email, + u'Find a shrubbery', + [u'quest', u'ni', u'knight'] + ) + + self.session.add(todo) + user_tags = user.user_tags + for user_tag in user_tags: + self.assertIn(user_tag.tag_name, tags, '%s should be one of these tags %s' % (user_tag, tags)) diff --git a/todopyramid/views.py b/todopyramid/views.py index 3b10c66..c17b321 100644 --- a/todopyramid/views.py +++ b/todopyramid/views.py @@ -46,6 +46,9 @@ def __init__(self, request): def form_resources(self, form): """Get a list of css and javascript resources for a given form. These are then used to place the resources in the global layout. + + TODO: may be use static_url API here + TODO: @reify is another option """ resources = form.get_widget_resources() js_resources = resources['js'] @@ -116,17 +119,21 @@ def process_task_form(self, form): # Convert back to UTC for storage due_date = universify_datetime(due_date) task_name = captured.get('name') - task = TodoItem( + todo = TodoItem( user=self.user_id, task=task_name, tags=tags, due_date=due_date, ) - task_id = captured.get('id') - if task_id is not None: + todo_id = captured.get('id') + if todo_id is not None: action = 'updated' - task.id = task_id - DBSession.merge(task) + todo = DBSession.query(TodoItem).filter_by(id=todo_id).one() + todo.task = task_name + todo.apply_tags(tags) + todo.due_date = due_date + + DBSession.add(todo) msg = "Task %s %s successfully" % (task_name, action) self.request.session.flash(msg, queue='success') # Reload the page we were on @@ -276,13 +283,13 @@ def tag_autocomplete(self): """Get a list of dictionaries for the given term. This gives the tag input the information it needs to do auto completion. - TODO: improve model to support user_tags + TODO: improve model to support user_tags - done """ term = self.request.params.get('term', '') if len(term) < 2: return [] - # XXX: This is global tags, need to hook into "user_tags" - tags = DBSession.query(Tag).filter(Tag.name.startswith(term)).all() + + tags = self.user.user_tags_autocomplete(term) return [ dict(id=tag.name, value=tag.name, label=tag.name) for tag in tags @@ -313,14 +320,11 @@ def edit_task(self): def delete_task(self): """Delete a todo list item - TODO: Add a guard here so that you can only delete your tasks + TODO: Add a guard here so that you can only delete your tasks - done """ todo_id = self.request.params.get('id', None) if todo_id is not None: - todo_item = DBSession.query(TodoItem).filter( - TodoItem.id == todo_id) - with transaction.manager: - todo_item.delete() + self.user.delete_todo(todo_id) return True @view_config(route_name='home', renderer='templates/home.pt') @@ -339,7 +343,7 @@ def home_view(self): if self.user_id is None: count = None else: - count = len(self.user.todo_list.all()) + count = self.user.todo_list.count() return {'user': self.user, 'count': count, 'section': 'home'} @view_config(route_name='list', renderer='templates/todo_list.pt', @@ -355,8 +359,8 @@ def list_view(self): form = self.generate_task_form() if 'submit' in self.request.POST: return self.process_task_form(form) - order = self.sort_order() - todo_items = self.user.todo_list.order_by(order).all() + + todo_items = self.get_ordered_todos() grid = TodoGrid( self.request, None, @@ -379,10 +383,17 @@ def list_view(self): 'js_resources': js_resources, } + def get_ordered_todos(self): + """future TodoView method""" + order = self.sort_order() + return self.user.todo_list.order_by(order).all() + @view_config(route_name='tags', renderer='templates/todo_tags.pt', permission='view') def tags_view(self): """This view simply shows all of the tags a user has created. + + TODO: use request.route_url API to generate URLs in view code """ # Special case when the db was blown away if self.user_id is not None and self.user is None: @@ -400,6 +411,10 @@ def tag_view(self): """Very similar to the list_view, this view just filters the list of tags down to the tag selected in the url based on the tag route replacement marker that ends up in the `matchdict`. + + Actually we can create tasks from this page as well. + That is why 'Add Task' form can submit to this view as well. + """ # Special case when the db was blown away if self.user_id is not None and self.user is None: @@ -407,12 +422,18 @@ def tag_view(self): form = self.generate_task_form() if 'submit' in self.request.POST: return self.process_task_form(form) + + #get params from request order = self.sort_order() - qry = self.user.todo_list.order_by(order) tag_name = self.request.matchdict['tag_name'] + + #refactor: encapsulate it somewhere + qry = self.user.todo_list.order_by(order) tag_filter = TodoItem.tags.any(Tag.name.in_([tag_name])) todo_items = qry.filter(tag_filter) count = todo_items.count() + + item_label = 'items' if count > 1 or count == 0 else 'item' grid = TodoGrid( self.request, From 59b668b2a484c2c02a397c88fb90f3dee4edb01a Mon Sep 17 00:00:00 2001 From: Sascha Gottfried Date: Wed, 5 Feb 2014 20:19:26 +0100 Subject: [PATCH 04/27] extend README with notes about using IPython to explore SQLAlchemy models --- README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/README.md b/README.md index 6f10052..70b77d4 100644 --- a/README.md +++ b/README.md @@ -253,6 +253,38 @@ We will create a `TodoItem` and `Tag` model to start out with. This will give us +### Explore model with IPython + +``` +$ bin/pshell production.ini +Adding asdict2() to Colander. +Python 2.7.2+ (default, Jul 20 2012, 22:12:53) +Type "copyright", "credits" or "license" for more information. + +IPython 0.13.1 -- An enhanced Interactive Python. +? -> Introduction and overview of IPython's features. +%quickref -> Quick reference. +help -> Python's own help system. +object? -> Details about 'object', use 'object??' for extra details. + +Environment: + app The WSGI application. + registry Active Pyramid registry. + request Active request object. + root Root of the default resource tree. + root_factory Default root factory used to create `root`. + +In [1]: from todopyramid.models import DBSession, TodoUser + +In [2]: user = DBSession.query(TodoUser).filter_by(first_name='Arthur').one() + +In [3]: user +Out[3]: + +In [4]: user.email +Out[4]: u'king.arthur@example.com' +``` + [install]: http://pyramid.readthedocs.org/en/latest/narr/install.html [deform]: http://docs.pylonsproject.org/projects/deform/en/latest/ From ed5adf3f9f35696c8a1928fcd7dd261fc88302de Mon Sep 17 00:00:00 2001 From: Sascha Gottfried Date: Mon, 10 Feb 2014 12:44:48 +0100 Subject: [PATCH 05/27] refactor code that updates user account preferences into user model, refactor code that filters todos by tag into user model, add __repr__ to model classes 'Tag' and 'TodoItem' to support working with IPython, added IPython session as docstring to next test class --- README.md | 6 +++- todopyramid/models.py | 29 +++++++++++++++- todopyramid/tests.py | 81 +++++++++++++++++++++++++++++++++++++++---- todopyramid/views.py | 37 ++++++++++---------- 4 files changed, 126 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 70b77d4..0517ea7 100644 --- a/README.md +++ b/README.md @@ -251,7 +251,7 @@ We will create a `TodoItem` and `Tag` model to start out with. This will give us ### Model Relationships - +Add notes about model relationships that support features offered by todopyramid. ### Explore model with IPython @@ -285,6 +285,10 @@ In [4]: user.email Out[4]: u'king.arthur@example.com' ``` +### Sorting + +TodoGrid can be ordered by task name & due date - ascending and descending. + [install]: http://pyramid.readthedocs.org/en/latest/narr/install.html [deform]: http://docs.pylonsproject.org/projects/deform/en/latest/ diff --git a/todopyramid/models.py b/todopyramid/models.py index 8de9657..327e8c9 100644 --- a/todopyramid/models.py +++ b/todopyramid/models.py @@ -103,6 +103,10 @@ def past_due(self): compare to `utcnow` since dates are stored in UTC. """ return self.due_date and self.due_date < datetime.utcnow() + + def __repr__(self): + """return representation - helps in IPython""" + return "TodoItem(%r, %r, %r, %r)" % (self.user, self.task, self.tags, self.due_date) class Tag(Base): @@ -120,6 +124,10 @@ class Tag(Base): def __init__(self, name): self.name = name + + def __repr__(self): + """return representation - helps in IPython""" + return "Tag(%r)" % (self.name) class TodoUser(Base): @@ -142,6 +150,18 @@ def __init__(self, email, first_name=None, last_name=None, self.last_name = last_name self.time_zone = time_zone + + def todos_by_tag(self, tag, order): + """return user todos with given tag""" + tag_filter = TodoItem.tags.any(name=tag) + qry = self.todo_list.filter(tag_filter) + + if order: + qry.order_by(order) + + return qry.all() + + @property def user_tags(self): """Find all tags a user has created @@ -192,11 +212,18 @@ def profile_complete(self): def delete_todo(self, todo_id): """given a todo ID we delete it is contained in user todos - there is another way to remove an item from a collection + delete from a collection + http://docs.sqlalchemy.org/en/latest/orm/session.html#deleting-from-collections http://stackoverflow.com/questions/10378468/deleting-an-object-from-collection-in-sqlalchemy""" todo_item = self.todo_list.filter( TodoItem.id == todo_id) todo_item.delete() + + def update_prefs(self, first_name, last_name, time_zone=u'US/Eastern'): + """update account preferences""" + self.first_name = first_name + self.last_name = last_name + self.time_zone = time_zone diff --git a/todopyramid/tests.py b/todopyramid/tests.py index ad8145a..64a9d80 100644 --- a/todopyramid/tests.py +++ b/todopyramid/tests.py @@ -93,7 +93,7 @@ def test_given_a_new_user_when_I_ask_for_todos_Then_I_get_back_an_empty_list(sel todos = user.todos self.assertEqual(todos, []) - def test_given_a_user_when_I_add_a_todo_Then_I_can_access_from_user(self): + def test_given_a_user_when_I_add_a_todo_Then_I_can_access_it_from_user_todo_collection(self): """test user model method to delete a single todo""" from .models import Tag from .models import TodoUser @@ -118,7 +118,7 @@ def test_given_a_user_when_I_add_a_todo_Then_I_can_access_from_user(self): self.assertTrue(todo is user_todo) - def test_given_a_user_has_a_todo_When_I_delete_it__Then_it_is_gone(self): + def test_given_a_user_has_a_todo_When_I_delete_it_Then_it_is_gone(self): """test user model method to delete a single todo""" from .models import Tag from .models import TodoUser @@ -210,8 +210,6 @@ def test_inserting_todoitems_without_transaction_manager_with_same_tags_keep_tag self.assertEqual(todos, 2) - - def test_inserting_2_todoitems_with_same_tags_when_I_ask_for_tag_todos_then_I_get_2(self): from .models import Tag from .models import TodoItem @@ -234,6 +232,7 @@ def test_inserting_2_todoitems_with_same_tags_when_I_ask_for_tag_todos_then_I_ge self.assertEqual(tag.name, u'quest') self.assertEqual(len(tag.todos), 2) + @unittest.skip('skip because it raises IntegrityError') def test_inserting_multiple_todoitems_with_same_tags_using_addall_keep_tags_unique(self): from .models import Tag @@ -254,7 +253,6 @@ def test_inserting_multiple_todoitems_with_same_tags_using_addall_keep_tags_uniq self.assertEqual(tag.name, u'quest') - class TestHomeView(unittest.TestCase): def test_anonymous(self): @@ -266,6 +264,7 @@ def test_anonymous(self): self.assertEqual(response['user'], None) self.assertEqual(response['count'], None) self.assertEqual(response['section'], 'home') + class TestTagsView(ModelTests): @@ -294,5 +293,75 @@ def test_user_tags(self): for user_tag in user_tags: self.assertIn(user_tag.tag_name, tags, '%s should be one of these tags %s' % (user_tag, tags)) +class TestTagView(ModelTests): + + def test_todos_by_tag(self): + """return user todos that are tagged with given tag - + saved IPython session to demonstrate SQLAlchemy API + In [1]: from todopyramid.models import * + + In [2]: user = DBSession.query(TodoUser).filter_by(first_name='Sascha').one() + + In [3]: user.todos + Out[3]: + [TodoItem(u's.gottfried@hhpberlin.de', u'find tim', [, ], None), + TodoItem(u's.gottfried@hhpberlin.de', u'find another knight', [], datetime.datetime(2014, 2, 2, 23, 0)), + TodoItem(u's.gottfried@hhpberlin.de', u'find tim', [, ], None), + TodoItem(u's.gottfried@hhpberlin.de', u'find sascha', [], None)] + + In [4]: tag_filter = TodoItem.tags.any(Tag.name.in_([u'berlin'])) + + In [5]: user.todo_list.filter(tag_filter).all() + Out[5]: + [TodoItem(u's.gottfried@hhpberlin.de', u'find tim', [, ], None), + TodoItem(u's.gottfried@hhpberlin.de', u'find tim', [, ], None), + TodoItem(u's.gottfried@hhpberlin.de', u'find sascha', [], None)] + + In [6]: user.todo_list.filter(tag_filter).order_by(Tag.name) + Out[6]: + + + In [8]: user.todo_list.filter(tag_filter).order_by(TodoItem.task).all() + Out[8]: + [TodoItem(u's.gottfried@hhpberlin.de', u'find sascha', [], None), + TodoItem(u's.gottfried@hhpberlin.de', u'find tim', [, ], None), + TodoItem(u's.gottfried@hhpberlin.de', u'find tim', [, ], None)] + + In [9]: from sqlalchemy import asc + + In [10]: from sqlalchemy import desc + + In [11]: user.todo_list.filter(tag_filter).order_by(asc(TodoItem.task)).all() + Out[11]: + [TodoItem(u's.gottfried@hhpberlin.de', u'find sascha', [], None), + TodoItem(u's.gottfried@hhpberlin.de', u'find tim', [, ], None), + TodoItem(u's.gottfried@hhpberlin.de', u'find tim', [, ], None)] + + In [12]: user.todo_list.filter(tag_filter).order_by(desc(TodoItem.task)).all() + Out[12]: + [TodoItem(u's.gottfried@hhpberlin.de', u'find tim', [, ], None), + TodoItem(u's.gottfried@hhpberlin.de', u'find tim', [, ], None), + TodoItem(u's.gottfried@hhpberlin.de', u'find sascha', [], None)] + + In [13]: user.todo_list.filter(tag_filter).order_by(desc(TodoItem.due_date)).all() + Out[13]: + [TodoItem(u's.gottfried@hhpberlin.de', u'find sascha', [], None), + TodoItem(u's.gottfried@hhpberlin.de', u'find tim', [, ], None), + TodoItem(u's.gottfried@hhpberlin.de', u'find tim', [, ], None)] + + In [14]: user.todo_list.filter(tag_filter).order_by(asc(TodoItem.due_date)).all() + Out[14]: + [TodoItem(u's.gottfried@hhpberlin.de', u'find sascha', [], None), + TodoItem(u's.gottfried@hhpberlin.de', u'find tim', [, ], None), + TodoItem(u's.gottfried@hhpberlin.de', u'find tim', [, ], None)] + + In [19]: tag_filter = TodoItem.tags.any(name=u'knight') + + In [20]: user.todo_list.filter(tag_filter).order_by(asc(TodoItem.due_date)).all() + Out[20]: + [TodoItem(u's.gottfried@hhpberlin.de', u'find tim', [, ], None), + TodoItem(u's.gottfried@hhpberlin.de', u'find tim', [, ], None), + TodoItem(u's.gottfried@hhpberlin.de', u'find another knight', [], datetime.datetime(2014, 2, 2, 23, 0))] + + """ \ No newline at end of file diff --git a/todopyramid/views.py b/todopyramid/views.py index c17b321..eb97d7d 100644 --- a/todopyramid/views.py +++ b/todopyramid/views.py @@ -60,6 +60,8 @@ def form_resources(self, form): def sort_order(self): """The list_view and tag_view both use this helper method to determine what the current sort parameters are. + + TODO: try to refactor using SQLAlchemy API or plain Python """ order = self.request.GET.get('order_col', 'due_date') order_dir = self.request.GET.get('order_dir', 'asc') @@ -240,7 +242,7 @@ def account_view(self): if 'submit' in self.request.POST: controls = self.request.POST.items() try: - form.validate(controls) + appstruct = form.validate(controls) except ValidationFailure as e: msg = 'There was an error saving your settings.' self.request.session.flash(msg, queue='error') @@ -250,13 +252,9 @@ def account_view(self): 'js_resources': js_resources, 'section': section_name, } - values = parse(self.request.params.items()) - # Update the user - with transaction.manager: - self.user.first_name = values.get('first_name', u'') - self.user.last_name = values.get('last_name', u'') - self.user.time_zone = values.get('time_zone', u'US/Eastern') - DBSession.add(self.user) + + # Update the user with values from form/schema validation + self.user.update_prefs(**appstruct) self.request.session.flash( 'Settings updated successfully', queue='success', @@ -343,7 +341,7 @@ def home_view(self): if self.user_id is None: count = None else: - count = self.user.todo_list.count() + count = len(self.user.todos) return {'user': self.user, 'count': count, 'section': 'home'} @view_config(route_name='list', renderer='templates/todo_list.pt', @@ -412,9 +410,10 @@ def tag_view(self): list of tags down to the tag selected in the url based on the tag route replacement marker that ends up in the `matchdict`. - Actually we can create tasks from this page as well. - That is why 'Add Task' form can submit to this view as well. - + Why we ask for submit here? + Actually we can create tasks from the tag page as well. + That is why 'Add Task' modal form can submit to this view as well. + """ # Special case when the db was blown away if self.user_id is not None and self.user is None: @@ -423,15 +422,15 @@ def tag_view(self): if 'submit' in self.request.POST: return self.process_task_form(form) - #get params from request - order = self.sort_order() + #get tag from request tag_name = self.request.matchdict['tag_name'] - #refactor: encapsulate it somewhere - qry = self.user.todo_list.order_by(order) - tag_filter = TodoItem.tags.any(Tag.name.in_([tag_name])) - todo_items = qry.filter(tag_filter) - count = todo_items.count() + #get todos with given tag + #TODO: fix sorting with another approach as currently done + #do sorting + order = self.sort_order() + todo_items = self.user.todos_by_tag(tag_name, order) + count = len(todo_items) item_label = 'items' if count > 1 or count == 0 else 'item' From 88c649c05387f30b6858040c64899b54364df4a8 Mon Sep 17 00:00:00 2001 From: Sascha Gottfried Date: Mon, 10 Feb 2014 13:08:02 +0100 Subject: [PATCH 06/27] pin pyramid_deform in requirements.txt to version 0.2 --- requirements.txt | 2 +- todopyramid/views.py | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index 4ce5b0d..0cffb66 100644 --- a/requirements.txt +++ b/requirements.txt @@ -17,7 +17,7 @@ ipython==0.13.1 peppercorn==0.4 pyramid==1.4.3 pyramid-debugtoolbar==1.0.4 -pyramid-deform==0.2a5 +pyramid-deform==0.2 pyramid-persona==1.3.1 pyramid-tm==0.7 pytz==2012j diff --git a/todopyramid/views.py b/todopyramid/views.py index eb97d7d..de0e344 100644 --- a/todopyramid/views.py +++ b/todopyramid/views.py @@ -296,6 +296,8 @@ def tag_autocomplete(self): @view_config(renderer='json', name='edit.task', permission='view') def edit_task(self): """Get the values to fill in the edit form + + TODO: encapsulate datetime localization into model """ todo_id = self.request.params.get('id', None) if todo_id is None: From e63fc21aeeee2a099f3e1523ed5e045974202818 Mon Sep 17 00:00:00 2001 From: Sascha Gottfried Date: Tue, 11 Feb 2014 20:09:07 +0100 Subject: [PATCH 07/27] create several FormViews based on pyramid_deform helper class to break up big large existing view that handles everything, form views use SQLAlchemy models to change application state, move todoitem.due_date timezone conversion into existing SQLAlchemy domain models - TDB in todogrid, add new XHR route for todos to support AJAX-based loading of todo into modal task form, change URL generation to use route configuration, revisited inclusion of deform JS/CSS dependencies into global template, include pyramid add-ons from paster configuration files, all tests pass --- development.ini | 6 +- production.ini | 2 + todopyramid/__init__.py | 20 +- todopyramid/grid.py | 2 +- todopyramid/models.py | 46 +- todopyramid/schema.py | 2 + todopyramid/static/todo_list.js | 3 +- todopyramid/templates/global_layout.pt | 23 +- todopyramid/templates/home.pt | 4 +- todopyramid/templates/todo_list.pt | 5 +- todopyramid/tests.py | 4 + todopyramid/views.py | 581 +++++++++++++------------ 12 files changed, 375 insertions(+), 323 deletions(-) diff --git a/development.ini b/development.ini index a58aa06..e727448 100644 --- a/development.ini +++ b/development.ini @@ -14,11 +14,13 @@ pyramid.default_locale_name = en pyramid.includes = pyramid_debugtoolbar pyramid_tm + pyramid_persona + deform_bootstrap_extra sqlalchemy.url = sqlite:///%(here)s/todopyramid.sqlite persona.secret = s00per s3cr3t -persona.audiences = http://localhost:6543 +persona.audiences = todopyramid.localhost persona.siteName = ToDo Pyramid # Option to generate content for new users to try out @@ -34,7 +36,7 @@ todopyramid.generate_content = true [server:main] use = egg:waitress#main -host = 0.0.0.0 +host = 127.0.0.1 port = 6543 ### diff --git a/production.ini b/production.ini index e2bf07f..c2bb11e 100644 --- a/production.ini +++ b/production.ini @@ -13,6 +13,8 @@ pyramid.debug_routematch = false pyramid.default_locale_name = en pyramid.includes = pyramid_tm + pyramid_persona + deform_bootstrap_extra sqlalchemy.url = sqlite:///%(here)s/todopyramid.sqlite diff --git a/todopyramid/__init__.py b/todopyramid/__init__.py index d99e9b2..9cb5f4d 100644 --- a/todopyramid/__init__.py +++ b/todopyramid/__init__.py @@ -17,29 +17,17 @@ def main(global_config, **settings): settings=settings, root_factory='todopyramid.models.RootFactory', ) - config.include('pyramid_persona') - config.include('deform_bootstrap_extra') config.add_static_view('static', 'static', cache_max_age=3600) - # Adding the static resources from Deform - config.add_static_view( - 'deform_static', 'deform:static', cache_max_age=3600 - ) - config.add_static_view( - 'deform_bootstrap_static', 'deform_bootstrap:static', - cache_max_age=3600 - ) - config.add_static_view( - 'deform_bootstrap_extra_static', 'deform_bootstrap_extra:static', - cache_max_age=3600 - ) + # Misc. views config.add_route('home', '/') config.add_route('about', '/about') # Users config.add_route('account', '/account') # Viewing todo lists - config.add_route('list', '/list') + config.add_route('todos', '/todos') config.add_route('tags', '/tags') - config.add_route('tag', '/tags/{tag_name}') + config.add_route('todo', '/todos/{todo_id}') + config.add_route('taglist', '/tags/{tag_name}') config.scan() return config.make_wsgi_app() diff --git a/todopyramid/grid.py b/todopyramid/grid.py index 858ea57..01453a0 100644 --- a/todopyramid/grid.py +++ b/todopyramid/grid.py @@ -118,7 +118,7 @@ def due_date_td(self, col_num, i, item): span_class = 'due-date badge' if item.past_due: span_class += ' badge-important' - due_date = localize_datetime(item.due_date, self.user_tz) + due_date = localize_datetime(item._due_date, self.user_tz) span = HTML.tag( "span", c=HTML.literal(due_date.strftime('%Y-%m-%d %H:%M:%S')), diff --git a/todopyramid/models.py b/todopyramid/models.py index 327e8c9..f7a17c2 100644 --- a/todopyramid/models.py +++ b/todopyramid/models.py @@ -15,6 +15,9 @@ from sqlalchemy.orm import sessionmaker from zope.sqlalchemy import ZopeTransactionExtension +from .utils import localize_datetime +from .utils import universify_datetime + DBSession = scoped_session(sessionmaker(extension=ZopeTransactionExtension())) Base = declarative_base() @@ -46,8 +49,9 @@ class TodoItem(Base): __tablename__ = 'todoitems' id = Column(Integer, primary_key=True) task = Column(Text, nullable=False) - due_date = Column(DateTime) + _due_date = Column('due_date', DateTime) user = Column(Integer, ForeignKey('users.email')) + author = relationship('TodoUser') # # many to many TodoItem<->Tag tags = relationship("Tag", secondary=todoitemtag_table, backref="todos") @@ -55,7 +59,7 @@ class TodoItem(Base): def __init__(self, user, task, tags=None, due_date=None): self.user = user self.task = task - self.due_date = due_date + self.due_date = due_date # date will be universified if tags is not None: self.apply_tags(tags) @@ -101,8 +105,25 @@ def sorted_tags(self): def past_due(self): """Determine if this task is past its due date. Notice that we compare to `utcnow` since dates are stored in UTC. + + TODO: write tests + """ + return self._due_date and self._due_date < datetime.utcnow() + + def universify_due_date(self, date): + """convert datetime to UTC for storage""" + if date is not None: + self._due_date = universify_datetime(date) + + def localize_due_date(self): + """create a timezone-aware object for a given datetime and timezone name """ - return self.due_date and self.due_date < datetime.utcnow() + if self._due_date is not None and hasattr(self.author, 'time_zone'): + due_dt = localize_datetime(self._due_date, self.author.time_zone) + return due_dt + return self._due_date + + due_date = property(localize_due_date, universify_due_date) def __repr__(self): """return representation - helps in IPython""" @@ -166,6 +187,8 @@ def todos_by_tag(self, tag, order): def user_tags(self): """Find all tags a user has created + BUG: does not find user created tags that actually have no related todos + returns KeyedTuples with key 'tag_name' TODO: refactor to return collection of Tag model - consider lazy @@ -220,6 +243,23 @@ def delete_todo(self, todo_id): todo_item.delete() + def create_todo(self, task, tags=None, due_date=None): + """may be we prefer using this method from authenticated views + this way we always create a user TodoItem instead of allowing view code to modify SQLAlchemy TodoItem collection + """ + #check common pitfall - mutable as default argument + if tags==None: + tags = [] + + todo = TodoItem(self.email, task, tags, due_date) + self.todos.append(todo) + + def edit_todo(self, todo_id, task, tags=None, due_date=None): + todo = self.todo_list.filter_by(id=todo_id).one() + todo.task = task + todo.apply_tags(tags) + todo.due_date = due_date + def update_prefs(self, first_name, last_name, time_zone=u'US/Eastern'): """update account preferences""" self.first_name = first_name diff --git a/todopyramid/schema.py b/todopyramid/schema.py index 0da654b..c2dc539 100644 --- a/todopyramid/schema.py +++ b/todopyramid/schema.py @@ -38,6 +38,8 @@ def deferred_datetime_node(node, kw): class TodoSchema(MappingSchema): """This is the form schema used for list_view and tag_view. This is the basis for the add and edit form for tasks. + + TODO: schema.TodoSchema.name != models.TodoItem.task """ id = SchemaNode( Integer(), diff --git a/todopyramid/static/todo_list.js b/todopyramid/static/todo_list.js index f0472b9..e6178e8 100644 --- a/todopyramid/static/todo_list.js +++ b/todopyramid/static/todo_list.js @@ -12,8 +12,7 @@ $(function() { e.preventDefault(); var todo_id = $(this).closest('ul').attr('id'); $.getJSON( - '/edit.task', - {'id': todo_id}, + '/todos/' + todo_id, function(json) { if (json) { edit_form = $('#task-form'); diff --git a/todopyramid/templates/global_layout.pt b/todopyramid/templates/global_layout.pt index fe61a7b..11629b2 100644 --- a/todopyramid/templates/global_layout.pt +++ b/todopyramid/templates/global_layout.pt @@ -13,7 +13,7 @@ + href="${css_path}"/> + + - + - - + @@ -50,14 +51,14 @@
- ToDo Pyramid + ToDo Pyramid
    It is good to have you back ${user.first_name}. - You have ${count} tasks to take care of. + You have ${count} tasks to take care of.

    What are you going to get done today?

     - Well done, you have ${count} tasks left to complete. + Well done, you have ${count} tasks left to complete.

    What's next?

     diff --git a/todopyramid/templates/todo_list.pt b/todopyramid/templates/todo_list.pt index 5a99110..e298733 100644 --- a/todopyramid/templates/todo_list.pt +++ b/todopyramid/templates/todo_list.pt @@ -47,10 +47,13 @@ href="${request.static_url('deform:static/css/jquery-ui-timepicker-addon.css')}" /> - + + + + diff --git a/todopyramid/tests.py b/todopyramid/tests.py index 64a9d80..fcefa2d 100644 --- a/todopyramid/tests.py +++ b/todopyramid/tests.py @@ -163,6 +163,10 @@ def _makeOne(self, user, task, tags=None, due_date=None): def test_constructor(self): instance = self._makeOne(1, u'Find a shrubbery') + #trigger model + instance.author + + #make assertions self.assertEqual(instance.user, 1) self.assertEqual(instance.task, u'Find a shrubbery') self.assertEqual(instance.due_date, None) diff --git a/todopyramid/views.py b/todopyramid/views.py index de0e344..0395f8d 100644 --- a/todopyramid/views.py +++ b/todopyramid/views.py @@ -7,10 +7,12 @@ from pyramid.view import forbidden_view_config from pyramid.view import notfound_view_config from pyramid.view import view_config +from pyramid.decorator import reify from deform import Form from deform import ValidationFailure from peppercorn import parse +from pyramid_deform import FormView from pyramid_persona.views import verify_login import transaction @@ -37,121 +39,49 @@ def __init__(self, request): """ self.request = request self.user_id = authenticated_userid(request) - self.todo_list = [] self.user = None if self.user_id is not None: query = DBSession.query(TodoUser) self.user = query.filter(TodoUser.email == self.user_id).first() - def form_resources(self, form): - """Get a list of css and javascript resources for a given form. - These are then used to place the resources in the global layout. - - TODO: may be use static_url API here - TODO: @reify is another option - """ - resources = form.get_widget_resources() - js_resources = resources['js'] - css_resources = resources['css'] - js_links = ['deform:static/%s' % r for r in js_resources] - css_links = ['deform:static/%s' % r for r in css_resources] - return (css_links, js_links) - - def sort_order(self): - """The list_view and tag_view both use this helper method to - determine what the current sort parameters are. - - TODO: try to refactor using SQLAlchemy API or plain Python - """ - order = self.request.GET.get('order_col', 'due_date') - order_dir = self.request.GET.get('order_dir', 'asc') - if order == 'due_date': - # handle sorting of NULL values so they are always at the end - order = 'CASE WHEN due_date IS NULL THEN 1 ELSE 0 END, due_date' - if order == 'task': - # Sort ignoring case - order += ' COLLATE NOCASE' - if order_dir: - order = ' '.join([order, order_dir]) - return order + @view_config(route_name='home', renderer='templates/home.pt') + def home_view(self): + """This is the first page the user will see when coming to the + application. If they are anonymous, the count is None and the + template shows some enticing welcome text. - def generate_task_form(self, formid="deform"): - """This helper code generates the form that will be used to add - and edit the tasks based on the schema of the form. + If the user is logged in, then this gets a count of the user's + tasks, and shows that number on the home page with a link to + the `list_view`. """ - schema = TodoSchema().bind(user_tz=self.user.time_zone) - options = """ - {success: - function (rText, sText, xhr, form) { - deform.processCallbacks(); - deform.focusFirstInput(); - var loc = xhr.getResponseHeader('X-Relocate'); - if (loc) { - document.location = loc; - }; - } + # Special case when the db was blown away + if self.user_id is not None and self.user is None: + return self.logout() + if self.user_id is None: + count = None + else: + count = len(self.user.todos) + return {'user': self.user, + 'count': count, + 'section': 'home', } - """ - return Form( - schema, - buttons=('submit',), - formid=formid, - use_ajax=True, - ajax_options=options, - ) - - def process_task_form(self, form): - """This helper code processes the task from that we have - generated from Colander and Deform. - This handles both the initial creation and subsequent edits for - a task. + @view_config(route_name='tags', renderer='templates/todo_tags.pt', + permission='view') + def tags_view(self): + """This view simply shows all of the tags a user has created. + + TODO: use request.route_url API to generate URLs in view code """ - try: - # try to validate the submitted values - controls = self.request.POST.items() - captured = form.validate(controls) - action = 'created' - with transaction.manager: - tags = captured.get('tags', []) - if tags: - tags = tags.split(',') - due_date = captured.get('due_date') - if due_date is not None: - # Convert back to UTC for storage - due_date = universify_datetime(due_date) - task_name = captured.get('name') - todo = TodoItem( - user=self.user_id, - task=task_name, - tags=tags, - due_date=due_date, - ) - todo_id = captured.get('id') - if todo_id is not None: - action = 'updated' - todo = DBSession.query(TodoItem).filter_by(id=todo_id).one() - todo.task = task_name - todo.apply_tags(tags) - todo.due_date = due_date - - DBSession.add(todo) - msg = "Task %s %s successfully" % (task_name, action) - self.request.session.flash(msg, queue='success') - # Reload the page we were on - location = self.request.url - return Response( - '', - headers=[ - ('X-Relocate', location), - ('Content-Type', 'text/html'), - ] - ) - html = form.render({}) - except ValidationFailure as e: - # the submitted values could not be validated - html = e.render() - return Response(html) + # Special case when the db was blown away + if self.user_id is not None and self.user is None: + return self.logout() + tags = self.user.user_tags + return { + 'section': 'tags', + 'count': len(tags), + 'tags': tags, + } @view_config(route_name='about', renderer='templates/about.pt') def about_view(self): @@ -184,7 +114,7 @@ def logout(self): """ headers = forget(self.request) # Send the user back home, everything else is protected - return HTTPFound('/', headers=headers) + return HTTPFound(self.request.route_url('home'), headers=headers) @view_config(route_name='login', check_csrf=True) def login_view(self): @@ -207,7 +137,7 @@ def login_view(self): elif user and not user.profile_complete: msg = "Before you begin, please update your profile." self.request.session.flash(msg, queue='info') - return HTTPFound('/account', headers=headers) + return HTTPFound(self.request.route_url('account'), headers=headers) # Otherwise, create an account and optionally create some content settings = self.request.registry.settings generate_content = asbool( @@ -223,99 +153,208 @@ def login_view(self): "prosperous. Before you begin, please update your profile." ) self.request.session.flash(msg) - return HTTPFound('/account', headers=headers) + return HTTPFound(self.request.route_url('account'), headers=headers) - @view_config(route_name='account', renderer='templates/account.pt', - permission='view') - def account_view(self): - """This is the settings form for the user. The first time a - user logs in, they are taken here so we can get their first and - last name. + +class BaseView(FormView): + """subclass view to return links to static CSS/JS resources""" + + def __init__(self, request): + super(BaseView, self).__init__(request) + self.request = request + self.user_id = authenticated_userid(request) + self.user = None + if self.user_id is not None: + query = DBSession.query(TodoUser) + self.user = query.filter(TodoUser.email == self.user_id).first() + + def __call__(self): + """same as base class method but customizes links to JS/CSS resources + + Prepares and render the form according to provided options. + + Upon receiving a ``POST`` request, this method will validate + the request against the form instance. After validation, + this calls a method based upon the name of the button used for + form submission and whether the validation succeeded or failed. + If the button was named ``save``, then :meth:`save_success` will be + called on successful validation or :meth:`save_failure` will + be called upon failure. An exception to this is when no such + ``save_failure`` method is present; in this case, the fallback + is :meth:`failure``. + + Returns a ``dict`` structure suitable for provision tog the given + view. By default, this is the page template specified """ - # Special case when the db was blown away - if self.user_id is not None and self.user is None: - return self.logout() - section_name = 'account' - schema = SettingsSchema() - form = Form(schema, buttons=('submit',)) - css_resources, js_resources = self.form_resources(form) - if 'submit' in self.request.POST: - controls = self.request.POST.items() - try: - appstruct = form.validate(controls) - except ValidationFailure as e: - msg = 'There was an error saving your settings.' - self.request.session.flash(msg, queue='error') - return { - 'form': e.render(), - 'css_resources': css_resources, - 'js_resources': js_resources, - 'section': section_name, - } - - # Update the user with values from form/schema validation - self.user.update_prefs(**appstruct) - self.request.session.flash( - 'Settings updated successfully', - queue='success', - ) - return HTTPFound('/list') - # Get existing values - if self.user is not None: - appstruct = dict( - first_name=self.user.first_name, - last_name=self.user.last_name, - time_zone=self.user.time_zone, - ) - else: - appstruct = {} - return { - 'form': form.render(appstruct), - 'css_resources': css_resources, - 'js_resources': js_resources, - 'section': section_name, - } + use_ajax = getattr(self, 'use_ajax', False) + ajax_options = getattr(self, 'ajax_options', '{}') + self.schema = self.schema.bind(**self.get_bind_data()) + form = self.form_class(self.schema, buttons=self.buttons, + use_ajax=use_ajax, ajax_options=ajax_options, + **dict(self.form_options)) + self.before(form) + reqts = form.get_widget_resources() + result = None - @view_config(renderer='json', name='tags.autocomplete', permission='view') - def tag_autocomplete(self): - """Get a list of dictionaries for the given term. This gives - the tag input the information it needs to do auto completion. + for button in form.buttons: + if button.name in self.request.POST: + success_method = getattr(self, '%s_success' % button.name) + try: + controls = self.request.POST.items() + validated = form.validate(controls) + result = success_method(validated) + except ValidationFailure as e: + fail = getattr(self, '%s_failure' % button.name, None) + if fail is None: + fail = self.failure + result = fail(e) + break + + if result is None: + result = self.show(form) + + if isinstance(result, dict): + result['js_resources'] = [self.request.static_url('deform:static/%s' % r) for r in reqts['js']] + result['css_resources'] = [self.request.static_url('deform:static/%s' % r) for r in reqts['css']] + + return result + + +@view_config(route_name='account', renderer='templates/account.pt', permission='view') +class AccountEditView(BaseView, Layouts): + """view class for account from + + inherits from BaseView to get customized JS/CSS resources behaviour + inherits from Layout to use global TodoPyramid template + """ + schema = SettingsSchema() + buttons = ('save', 'cancel') + + def save_success(self, appstruct): + """save button handler - called after successful validation - TODO: improve model to support user_tags - done + save validated user prefs and redirect to list view""" + self.user.update_prefs(**appstruct) + self.request.session.flash( + 'Settings updated successfully', + queue='success', + ) + return HTTPFound(self.request.route_url('home')) + + def save_failure(self, exc): + """save button failure handler - called after validation failure + + add custom message as flash message and render form + TODO: investigate exception""" + msg = 'There was an error saving your settings.' + self.request.session.flash(msg, queue='error') + + def cancel_success(self, appstruct): + """cancel button handler redirects to todo list view""" + return HTTPFound(self.request.route_url('todos')) + + + def appstruct(self): + """This allows edit forms to pre-fill form values conveniently. + + TODO: find out how to generate appstruct from model - sort of model binding API or helper""" + + user = self.user + return {'first_name': user.first_name, + 'last_name': user.last_name, + 'time_zone': user.time_zone} + + +@view_config(route_name="taglist", renderer='templates/todo_list.pt', permission='view') +@view_config(route_name='todos', renderer='templates/todo_list.pt', permission='view') +class TodoItemForm(BaseView, Layouts): + """view class to renderer all user todos or todos-by-tag - use case depends on matched route + + responsibilities + * render TaskForm + * render TodoGrid + * care about sort_order + * edit task AJAX + * delete task AJAX + * feed AutoComplete Ajax Widget + """ + schema = TodoSchema() + buttons = ('save',) + form_options = (('formid', 'deform'),) + use_ajax = True + ajax_options = """ + {success: + function (rText, sText, xhr, form) { + deform.processCallbacks(); + deform.focusFirstInput(); + var loc = xhr.getResponseHeader('X-Relocate'); + if (loc) { + document.location = loc; + }; + } + } + """ + def save_success(self, appstruct): + """save button handler + + handle create/edit action and redirect to page + + TODO: pass appstruct as **kwargs to domain method """ - term = self.request.params.get('term', '') - if len(term) < 2: - return [] + #TodoSchema colander schema and SQLAlchemy model TodoItem differ + id = appstruct['id'] #hidden with colander.missing + name = appstruct['name'] #required + tags = appstruct['tags'].split(',') #optional with colander.missing, multiple tags are seperated with commas + due_date = appstruct['due_date'] #optional with colander.missing - tags = self.user.user_tags_autocomplete(term) - return [ - dict(id=tag.name, value=tag.name, label=tag.name) - for tag in tags - ] + #encapsulate with try-except + if id: + #edit user todo + self.user.edit_todo(id, name, tags, due_date) + action = 'updated' + else: + #create new user todo + self.user.create_todo(name, tags, due_date) + action = 'created' + + msg = "Task %s %s successfully" % (name, action) + self.request.session.flash(msg, queue='success') + + #reload the current page + location = self.request.url + return Response( + '', + headers=[ + ('X-Relocate', location), + ('Content-Type', 'text/html'), + ] + ) + + def update_success(self): + """target create/edit use cases with different button handlers""" + pass - @view_config(renderer='json', name='edit.task', permission='view') - def edit_task(self): - """Get the values to fill in the edit form + @view_config(route_name='todo', renderer='json', permission='view', xhr=True) + def get_task(self): + """Get the task to fill in the edit form - TODO: encapsulate datetime localization into model + TODO: encapsulate datetime localization into model - done + TODO: make datetime string configurable """ - todo_id = self.request.params.get('id', None) + todo_id = self.request.matchdict['todo_id'] if todo_id is None: return False - task = DBSession.query(TodoItem).filter( - TodoItem.id == todo_id).first() - due_date = None - # If there is a due date, localize the time - if task.due_date is not None: - due_dt = localize_datetime(task.due_date, self.user.time_zone) - due_date = due_dt.strftime('%Y-%m-%d %H:%M:%S') + task = self.user.todo_list.filter_by(id=todo_id).one() + + due_date = task.due_date.strftime('%Y-%m-%d %H:%M:%S') if task.due_date is not None else None return dict( id=task.id, name=task.task, tags=','.join([tag.name for tag in task.sorted_tags]), due_date=due_date, ) - + + @view_config(renderer='json', name='delete.task', permission='view') def delete_task(self): """Delete a todo list item @@ -327,40 +366,71 @@ def delete_task(self): self.user.delete_todo(todo_id) return True - @view_config(route_name='home', renderer='templates/home.pt') - def home_view(self): - """This is the first page the user will see when coming to the - application. If they are anonymous, the count is None and the - template shows some enticing welcome text. - If the user is logged in, then this gets a count of the user's - tasks, and shows that number on the home page with a link to - the `list_view`. + @view_config(renderer='json', name='tags.autocomplete', permission='view') + def tag_autocomplete(self): + """Get a list of dictionaries for the given term. This gives + the tag input the information it needs to do auto completion. + + TODO: improve model to support user_tags - done """ - # Special case when the db was blown away - if self.user_id is not None and self.user is None: - return self.logout() - if self.user_id is None: - count = None - else: - count = len(self.user.todos) - return {'user': self.user, 'count': count, 'section': 'home'} + term = self.request.params.get('term', '') + if len(term) < 2: + return [] + + tags = self.user.user_tags_autocomplete(term) + return [ + dict(id=tag.name, value=tag.name, label=tag.name) + for tag in tags + ] + + def get_bind_data(self): + """deferred binding of user time zone + + TODO: do we still need it after refactoring timezone conversion into model ???""" + data = super(TodoItemForm, self).get_bind_data() + data.update({'user_tz': self.user.time_zone}) + return data + + def sort_order(self): + """The list_view and tag_view both use this helper method to + determine what the current sort parameters are. + + TODO: try to refactor using SQLAlchemy API or plain Python + """ + order = self.request.GET.get('order_col', 'due_date') + order_dir = self.request.GET.get('order_dir', 'asc') + if order == 'due_date': + # handle sorting of NULL values so they are always at the end + order = 'CASE WHEN due_date IS NULL THEN 1 ELSE 0 END, due_date' + if order == 'task': + # Sort ignoring case + order += ' COLLATE NOCASE' + if order_dir: + order = ' '.join([order, order_dir]) + return order - @view_config(route_name='list', renderer='templates/todo_list.pt', - permission='view') - def list_view(self): - """This is the main functional page of our application. It - shows a listing of the tasks that the currently logged in user - has created. + + def show(self, form): + """Override to inject TodoGrid and other stuff + + address both use cases by testing which route matched """ # Special case when the db was blown away if self.user_id is not None and self.user is None: return self.logout() - form = self.generate_task_form() - if 'submit' in self.request.POST: - return self.process_task_form(form) - todo_items = self.get_ordered_todos() + order = self.sort_order() + tag_name = self.request.matchdict.get('tag_name') + if tag_name: + #route match for todos-by-tag + todo_items = self.user.todos_by_tag(tag_name, order) + page_title = 'Tag List' + else: + #route match for todos + todo_items = self.user.todo_list.order_by(order).all() + page_title = 'ToDo List' + grid = TodoGrid( self.request, None, @@ -368,91 +438,32 @@ def list_view(self): todo_items, ['task', 'tags', 'due_date', ''], ) + count = len(todo_items) item_label = 'items' if count > 1 or count == 0 else 'item' - css_resources, js_resources = self.form_resources(form) - return { - 'page_title': 'Todo List', + + todos = { + 'page_title': page_title, 'count': count, 'item_label': item_label, 'section': 'list', 'items': todo_items, 'grid': grid, - 'form': form.render(), - 'css_resources': css_resources, - 'js_resources': js_resources, } - - def get_ordered_todos(self): - """future TodoView method""" - order = self.sort_order() - return self.user.todo_list.order_by(order).all() - - @view_config(route_name='tags', renderer='templates/todo_tags.pt', - permission='view') - def tags_view(self): - """This view simply shows all of the tags a user has created. - TODO: use request.route_url API to generate URLs in view code - """ - # Special case when the db was blown away - if self.user_id is not None and self.user is None: - return self.logout() - tags = self.user.user_tags - return { - 'section': 'tags', - 'count': len(tags), - 'tags': tags, - } - - @view_config(route_name='tag', renderer='templates/todo_list.pt', - permission='view') - def tag_view(self): - """Very similar to the list_view, this view just filters the - list of tags down to the tag selected in the url based on the - tag route replacement marker that ends up in the `matchdict`. - - Why we ask for submit here? - Actually we can create tasks from the tag page as well. - That is why 'Add Task' modal form can submit to this view as well. - - """ - # Special case when the db was blown away - if self.user_id is not None and self.user is None: - return self.logout() - form = self.generate_task_form() - if 'submit' in self.request.POST: - return self.process_task_form(form) - #get tag from request - tag_name = self.request.matchdict['tag_name'] - - #get todos with given tag - #TODO: fix sorting with another approach as currently done - #do sorting - order = self.sort_order() - todo_items = self.user.todos_by_tag(tag_name, order) - count = len(todo_items) + #copied from FormView.show + appstruct = self.appstruct() + if appstruct is None: + rendered = form.render() + else: + rendered = form.render(appstruct) + taskform = { + 'form': rendered, + } - item_label = 'items' if count > 1 or count == 0 else 'item' - grid = TodoGrid( - self.request, - tag_name, - self.user.time_zone, - todo_items, - ['task', 'tags', 'due_date', ''], - ) - css_resources, js_resources = self.form_resources(form) - return { - 'page_title': 'Tag List', - 'count': count, - 'item_label': item_label, - 'section': 'tags', - 'tag_name': tag_name, - 'items': todo_items, - 'grid': grid, - 'form': form.render({'tags': tag_name}), - 'css_resources': css_resources, - 'js_resources': js_resources, - } + #merge and return to renderer + todos.update(taskform) + return todos + \ No newline at end of file From 3b5f46ca1aa1c7856b53db0e9b42ffc740cd2fb3 Mon Sep 17 00:00:00 2001 From: Sascha Gottfried Date: Tue, 11 Feb 2014 20:13:34 +0100 Subject: [PATCH 08/27] small changes to README --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0517ea7..5cf214c 100644 --- a/README.md +++ b/README.md @@ -251,9 +251,9 @@ We will create a `TodoItem` and `Tag` model to start out with. This will give us ### Model Relationships -Add notes about model relationships that support features offered by todopyramid. +TBD - Add notes about model relationships that support features offered by todopyramid. -### Explore model with IPython +### Explore SQLAlchemy model with IPython ``` $ bin/pshell production.ini From 054aba75d61683de0ea5ca6cb9df8e904cb14a1e Mon Sep 17 00:00:00 2001 From: Sascha Gottfried Date: Thu, 3 Apr 2014 19:24:52 +0200 Subject: [PATCH 09/27] add Travis CI file - closes #23 --- .travis.yml | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 .travis.yml diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..fd015f7 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,8 @@ +language: python +python: + - "2.7" + - "2.6" +# command to install dependencies, e.g. pip install -r requirements.txt --use-mirrors +install: "pip install -r requirements.txt -e --use-mirrors ." +# command to run tests, e.g. python setup.py test +script: "python setup.py test" \ No newline at end of file From e0462cd95150e5a078f713573f60f31de061262a Mon Sep 17 00:00:00 2001 From: Sascha Gottfried Date: Thu, 3 Apr 2014 19:46:01 +0200 Subject: [PATCH 10/27] small changes for TRAVIS CI to pick up the repo --- .gitignore | 2 ++ README.md | 5 ++-- development.ini | 2 +- todopyramid/__init__.py | 5 +++- todopyramid/grid.py | 4 +++- todopyramid/models.py | 8 ++++++- todopyramid/schema.py | 2 +- todopyramid/static/todo_list.js | 7 +++--- todopyramid/templates/global_layout.pt | 22 ++++++------------ todopyramid/templates/todo_list.pt | 15 ++++++------ todopyramid/views.py | 32 ++++++++++++++++---------- 11 files changed, 57 insertions(+), 47 deletions(-) diff --git a/.gitignore b/.gitignore index 36de90c..b656579 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,3 @@ todopyramid.sqlite +*.pyc +*.egg-info diff --git a/README.md b/README.md index 5cf214c..4dbec72 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,7 @@ # ToDo Pyramid App -This is the Pyramid app for the Python Web Shootout. - -Try it out here: +This is a refactored version of the Pyramid app for the Python Web Shootout. +Though it is not deployed to public yet, you can try original version here: ## Install diff --git a/development.ini b/development.ini index e727448..75f16df 100644 --- a/development.ini +++ b/development.ini @@ -12,7 +12,7 @@ pyramid.debug_notfound = false pyramid.debug_routematch = false pyramid.default_locale_name = en pyramid.includes = - pyramid_debugtoolbar +# pyramid_debugtoolbar pyramid_tm pyramid_persona deform_bootstrap_extra diff --git a/todopyramid/__init__.py b/todopyramid/__init__.py index 9cb5f4d..9980155 100644 --- a/todopyramid/__init__.py +++ b/todopyramid/__init__.py @@ -27,7 +27,10 @@ def main(global_config, **settings): # Viewing todo lists config.add_route('todos', '/todos') config.add_route('tags', '/tags') - config.add_route('todo', '/todos/{todo_id}') config.add_route('taglist', '/tags/{tag_name}') + # AJAX + config.add_route('todo', '/todos/{todo_id}') + config.add_route('delete.task', '/delete.task/{todo_id}') + config.add_route('tags.autocomplete', '/tags.autocomplete') config.scan() return config.make_wsgi_app() diff --git a/todopyramid/grid.py b/todopyramid/grid.py index 01453a0..a0f00bd 100644 --- a/todopyramid/grid.py +++ b/todopyramid/grid.py @@ -95,11 +95,13 @@ def __html__(self): def tags_td(self, col_num, i, item): """Generate the column for the tags. + + Apply special tag CSS for currently selected tag matched route '/tags/{tag_name}' """ tag_links = [] for tag in item.sorted_tags: - tag_url = '%s/tags/%s' % (self.request.application_url, tag.name) + tag_url = self.request.route_url('taglist', tag_name=tag.name) tag_class = 'label' if self.selected_tag and tag.name == self.selected_tag: tag_class += ' label-warning' diff --git a/todopyramid/models.py b/todopyramid/models.py index f7a17c2..394485e 100644 --- a/todopyramid/models.py +++ b/todopyramid/models.py @@ -68,11 +68,14 @@ def apply_tags(self, tags): creates the associated tag object. We strip off whitespace and lowercase the tags to keep a normalized list. """ - + #tags = [] for tag_name in tags: tag_name = self.sanitize_tag(tag_name) tag = self._find_or_create_tag(tag_name) self.tags.append(tag) + + #reset collection of tags + #self.tags = tags def sanitize_tag(self, tag_name): """tag name input validation""" @@ -98,6 +101,7 @@ def sorted_tags(self): """Return a list of sorted tags for this task. TODO: we can apply sorting using the relationship + TODO: order case-insensitive ??? """ return sorted(self.tags, key=lambda x: x.name) @@ -204,6 +208,8 @@ def user_tags(self): def user_tags_autocomplete(self, term): """given a term return a unique collection (set) of user tags that start with it + BUG: returns only tags currently applied to user todos, therefore missing tags related to deleted user todos + In [19]: for todo in user.todos: for tag in todo.tags: diff --git a/todopyramid/schema.py b/todopyramid/schema.py index c2dc539..d088516 100644 --- a/todopyramid/schema.py +++ b/todopyramid/schema.py @@ -55,7 +55,7 @@ class TodoSchema(MappingSchema): description=( "Enter a comma after each tag to add it. Backspace to delete." ), - missing=[], + missing=None, ) due_date = SchemaNode( deferred_datetime_node, diff --git a/todopyramid/static/todo_list.js b/todopyramid/static/todo_list.js index e6178e8..da21ea0 100644 --- a/todopyramid/static/todo_list.js +++ b/todopyramid/static/todo_list.js @@ -15,7 +15,7 @@ $(function() { '/todos/' + todo_id, function(json) { if (json) { - edit_form = $('#task-form'); + var edit_form = $('#task-form'); // Set the title to Edit edit_form.find('h3').text('Edit Task'); $.each(json, function(k, v) { @@ -46,7 +46,7 @@ $(function() { }); }); - // Compete a todo task when the link is clicked + // Complete a todo task when the link is clicked $("a.todo-complete").click(function(e) { e.preventDefault(); var todo_id = $(this).closest('ul').attr('id'); @@ -56,8 +56,7 @@ $(function() { bootbox.confirm(confirm_text, function(complete_item) { if (complete_item) { $.getJSON( - '/delete.task', - {'id': todo_id}, + '/delete.task/'+ todo_id, function(json) { if (json) { // Delete the row diff --git a/todopyramid/templates/global_layout.pt b/todopyramid/templates/global_layout.pt index 11629b2..96c91c4 100644 --- a/todopyramid/templates/global_layout.pt +++ b/todopyramid/templates/global_layout.pt @@ -25,26 +25,17 @@ + + + + + - - - - - - - - - - - - - @@ -116,6 +107,7 @@

    Six Feet Up, Inc. logo

    Created by Six Feet Up, Inc. — Get the code on GitHub

    + diff --git a/todopyramid/templates/todo_list.pt b/todopyramid/templates/todo_list.pt index e298733..a23557a 100644 --- a/todopyramid/templates/todo_list.pt +++ b/todopyramid/templates/todo_list.pt @@ -39,23 +39,22 @@ - - - + + + + + + + - - diff --git a/todopyramid/views.py b/todopyramid/views.py index 0395f8d..8dbfdcf 100644 --- a/todopyramid/views.py +++ b/todopyramid/views.py @@ -11,7 +11,6 @@ from deform import Form from deform import ValidationFailure -from peppercorn import parse from pyramid_deform import FormView from pyramid_persona.views import verify_login import transaction @@ -229,6 +228,7 @@ class AccountEditView(BaseView, Layouts): """ schema = SettingsSchema() buttons = ('save', 'cancel') + section = 'account' # current section of navbar def save_success(self, appstruct): """save button handler - called after successful validation @@ -304,7 +304,9 @@ def save_success(self, appstruct): #TodoSchema colander schema and SQLAlchemy model TodoItem differ id = appstruct['id'] #hidden with colander.missing name = appstruct['name'] #required - tags = appstruct['tags'].split(',') #optional with colander.missing, multiple tags are seperated with commas + tags = appstruct['tags'] + if tags: + tags = tags.split(',') #optional with colander.missing, multiple tags are seperated with commas due_date = appstruct['due_date'] #optional with colander.missing #encapsulate with try-except @@ -336,17 +338,19 @@ def update_success(self): @view_config(route_name='todo', renderer='json', permission='view', xhr=True) def get_task(self): - """Get the task to fill in the edit form + """Get the task to fill in the bootbox edit form + returns multiple tags separated by comma to target deform_bootstrap_extra TagsWidget TODO: encapsulate datetime localization into model - done TODO: make datetime string configurable """ todo_id = self.request.matchdict['todo_id'] if todo_id is None: return False - task = self.user.todo_list.filter_by(id=todo_id).one() + task = self.user.todo_list.filter_by(id=todo_id).one() due_date = task.due_date.strftime('%Y-%m-%d %H:%M:%S') if task.due_date is not None else None + return dict( id=task.id, name=task.task, @@ -355,26 +359,28 @@ def get_task(self): ) - @view_config(renderer='json', name='delete.task', permission='view') + @view_config(route_name="delete.task", renderer='json', permission='view', xhr=True) def delete_task(self): """Delete a todo list item TODO: Add a guard here so that you can only delete your tasks - done """ - todo_id = self.request.params.get('id', None) - if todo_id is not None: - self.user.delete_todo(todo_id) + todo_id = self.request.matchdict['todo_id'] + if todo_id is None: + return False + + self.user.delete_todo(todo_id) return True - @view_config(renderer='json', name='tags.autocomplete', permission='view') + @view_config(route_name="tags.autocomplete", renderer='json', permission='view', xhr=True) def tag_autocomplete(self): """Get a list of dictionaries for the given term. This gives the tag input the information it needs to do auto completion. TODO: improve model to support user_tags - done """ - term = self.request.params.get('term', '') + term = self.request.GET.get('term','') if len(term) < 2: return [] @@ -415,6 +421,7 @@ def show(self, form): """Override to inject TodoGrid and other stuff address both use cases by testing which route matched + in contrast to original version I set both routes to highlight List menu item in navbar """ # Special case when the db was blown away if self.user_id is not None and self.user is None: @@ -433,7 +440,7 @@ def show(self, form): grid = TodoGrid( self.request, - None, + tag_name, self.user.time_zone, todo_items, ['task', 'tags', 'due_date', ''], @@ -446,7 +453,8 @@ def show(self, form): 'page_title': page_title, 'count': count, 'item_label': item_label, - 'section': 'list', + 'tag_name' : tag_name, + 'section' : 'list', 'items': todo_items, 'grid': grid, } From d4ab2543e42193749031a57882e2020365b667c3 Mon Sep 17 00:00:00 2001 From: Sascha Gottfried Date: Thu, 3 Apr 2014 19:51:21 +0200 Subject: [PATCH 11/27] fix travis install command --- .travis.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.travis.yml b/.travis.yml index fd015f7..a0d45be 100644 --- a/.travis.yml +++ b/.travis.yml @@ -3,6 +3,6 @@ python: - "2.7" - "2.6" # command to install dependencies, e.g. pip install -r requirements.txt --use-mirrors -install: "pip install -r requirements.txt -e --use-mirrors ." +install: "pip install -r requirements.txt -e . --use-mirrors" # command to run tests, e.g. python setup.py test script: "python setup.py test" \ No newline at end of file From e85def5fd3d1449145ea7ae6cf05e05b11cff344 Mon Sep 17 00:00:00 2001 From: Sascha Gottfried Date: Thu, 3 Apr 2014 20:03:32 +0200 Subject: [PATCH 12/27] add TRAVIS CI build status to README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 4dbec72..fddc045 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # ToDo Pyramid App +[![Build Status](https://travis-ci.org/saschagottfried/todopyramid.svg?branch=master)](https://travis-ci.org/saschagottfried/todopyramid) + This is a refactored version of the Pyramid app for the Python Web Shootout. Though it is not deployed to public yet, you can try original version here: From 8ae4f463110aa974c1bb63ca15a6952d25521f98 Mon Sep 17 00:00:00 2001 From: Sascha Gottfried Date: Thu, 3 Apr 2014 20:29:29 +0200 Subject: [PATCH 13/27] tests try to import unittest2 for python 2.6 compatibility --- setup.py | 2 +- todopyramid/tests.py | 5 ++++- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/setup.py b/setup.py index 31f0e5b..24adcaf 100644 --- a/setup.py +++ b/setup.py @@ -19,7 +19,7 @@ 'pyramid_persona', 'WebHelpers', 'pytz', - 'requests==1.1.0' + 'requests==1.1.0', ] setup( diff --git a/todopyramid/tests.py b/todopyramid/tests.py index fcefa2d..e542162 100644 --- a/todopyramid/tests.py +++ b/todopyramid/tests.py @@ -1,4 +1,7 @@ -import unittest +try: + import unittest2 as unittest +except ImportError: + import unittest import transaction from pyramid import testing From ffef465ca15c57008c65c945fb01c4206e4e9a1e Mon Sep 17 00:00:00 2001 From: Sascha Gottfried Date: Thu, 3 Apr 2014 20:31:56 +0200 Subject: [PATCH 14/27] switch to nose2 as testrunner --- .travis.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.travis.yml b/.travis.yml index a0d45be..3ea97e6 100644 --- a/.travis.yml +++ b/.travis.yml @@ -3,6 +3,8 @@ python: - "2.7" - "2.6" # command to install dependencies, e.g. pip install -r requirements.txt --use-mirrors -install: "pip install -r requirements.txt -e . --use-mirrors" +install: + - "pip install -r requirements.txt -e . --use-mirrors" + - "pip install nose2 --use-mirrors" # command to run tests, e.g. python setup.py test script: "python setup.py test" \ No newline at end of file From 9e0825b8bcf7a076135b91fccee01befde6c15e1 Mon Sep 17 00:00:00 2001 From: Sascha Gottfried Date: Thu, 3 Apr 2014 20:33:25 +0200 Subject: [PATCH 15/27] run nose2 as TRAVIS CI testrunner --- .travis.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.travis.yml b/.travis.yml index 3ea97e6..dbbd644 100644 --- a/.travis.yml +++ b/.travis.yml @@ -7,4 +7,4 @@ install: - "pip install -r requirements.txt -e . --use-mirrors" - "pip install nose2 --use-mirrors" # command to run tests, e.g. python setup.py test -script: "python setup.py test" \ No newline at end of file +script: "nose2" \ No newline at end of file From e8bc022dd0d86e01ce4b40f9d0bb53d215ba9d95 Mon Sep 17 00:00:00 2001 From: Sascha Gottfried Date: Thu, 3 Apr 2014 20:50:24 +0200 Subject: [PATCH 16/27] try pip option --allow-external and remove deprecated option --use-mirrors --- .travis.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.travis.yml b/.travis.yml index dbbd644..9df09d5 100644 --- a/.travis.yml +++ b/.travis.yml @@ -4,7 +4,7 @@ python: - "2.6" # command to install dependencies, e.g. pip install -r requirements.txt --use-mirrors install: - - "pip install -r requirements.txt -e . --use-mirrors" - - "pip install nose2 --use-mirrors" + - "pip install -r requirements.txt -e ." + - "pip install nose2 --allow-external" # command to run tests, e.g. python setup.py test script: "nose2" \ No newline at end of file From 6a7d59b3af4fc5a7f272edfacbe8456ca05275d2 Mon Sep 17 00:00:00 2001 From: Sascha Gottfried Date: Thu, 3 Apr 2014 21:01:13 +0200 Subject: [PATCH 17/27] remove pip option --allow-external --- .travis.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.travis.yml b/.travis.yml index 9df09d5..2a58cce 100644 --- a/.travis.yml +++ b/.travis.yml @@ -5,6 +5,6 @@ python: # command to install dependencies, e.g. pip install -r requirements.txt --use-mirrors install: - "pip install -r requirements.txt -e ." - - "pip install nose2 --allow-external" + - "pip install nose2" # command to run tests, e.g. python setup.py test script: "nose2" \ No newline at end of file From c817db099e0e72b122e6c2ebf5cc4653fc2c8424 Mon Sep 17 00:00:00 2001 From: Sascha Gottfried Date: Thu, 3 Apr 2014 21:23:31 +0200 Subject: [PATCH 18/27] switch back to nose, because nose2 dependency argparse==1.2.1 can not be installed inside TRAVIS CI --- .travis.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.travis.yml b/.travis.yml index 2a58cce..6de862a 100644 --- a/.travis.yml +++ b/.travis.yml @@ -5,6 +5,6 @@ python: # command to install dependencies, e.g. pip install -r requirements.txt --use-mirrors install: - "pip install -r requirements.txt -e ." - - "pip install nose2" + - "pip install nose" # command to run tests, e.g. python setup.py test -script: "nose2" \ No newline at end of file +script: "python setup.py nosetests" \ No newline at end of file From 2952afa167aaaccb2128a92c5a5ccfd7160575e5 Mon Sep 17 00:00:00 2001 From: Sascha Gottfried Date: Fri, 4 Apr 2014 15:31:46 +0200 Subject: [PATCH 19/27] make DB session and user available available from request object (closes #25), handle gracefully a connection loss to database and log out and notify user (closes #26) --- development.ini | 2 +- todopyramid/__init__.py | 15 +++++++ todopyramid/views.py | 98 +++++++++++++++++++++++------------------ 3 files changed, 72 insertions(+), 43 deletions(-) diff --git a/development.ini b/development.ini index 75f16df..e727448 100644 --- a/development.ini +++ b/development.ini @@ -12,7 +12,7 @@ pyramid.debug_notfound = false pyramid.debug_routematch = false pyramid.default_locale_name = en pyramid.includes = -# pyramid_debugtoolbar + pyramid_debugtoolbar pyramid_tm pyramid_persona deform_bootstrap_extra diff --git a/todopyramid/__init__.py b/todopyramid/__init__.py index 9980155..949ab2f 100644 --- a/todopyramid/__init__.py +++ b/todopyramid/__init__.py @@ -6,6 +6,11 @@ Base, ) +from .views import get_user + +def get_db_session(request): + """return thread-local DB session""" + return DBSession def main(global_config, **settings): """ This function returns a Pyramid WSGI application. @@ -32,5 +37,15 @@ def main(global_config, **settings): config.add_route('todo', '/todos/{todo_id}') config.add_route('delete.task', '/delete.task/{todo_id}') config.add_route('tags.autocomplete', '/tags.autocomplete') + + # make DB session a request attribute + # http://blog.safaribooksonline.com/2014/01/07/building-pyramid-applications/ + config.add_request_method(get_db_session, 'db', reify=True) + + # Making A User Object Available as a Request Attribute + # http://docs.pylonsproject.org/projects/pyramid_cookbook/en/latest/auth/user_object.html + config.add_request_method(get_user, 'user', reify=True) + + # scan modules for config descriptors config.scan() return config.make_wsgi_app() diff --git a/todopyramid/views.py b/todopyramid/views.py index 8dbfdcf..471e29a 100644 --- a/todopyramid/views.py +++ b/todopyramid/views.py @@ -1,6 +1,6 @@ from pyramid.httpexceptions import HTTPFound from pyramid.response import Response -from pyramid.security import authenticated_userid +from pyramid.security import unauthenticated_userid from pyramid.security import remember from pyramid.security import forget from pyramid.settings import asbool @@ -28,6 +28,35 @@ from .utils import universify_datetime +from sqlalchemy.exc import OperationalError as SqlAlchemyOperationalError + +@view_config(context=SqlAlchemyOperationalError) +def failed_sqlalchemy(exception, request): + """catch missing database, logout and redirect to homepage, add flash message with error + + implementation inspired by pylons group message + https://groups.google.com/d/msg/pylons-discuss/BUtbPrXizP4/0JhqB2MuoL4J + """ + msg = 'There was an error connecting to database' + request.session.flash(msg, queue='error') + headers = forget(request) + + # Send the user back home, everything else is protected + return HTTPFound(request.route_url('home'), headers=headers) + +def get_user(request): + # the below line is just an example, use your own method of + # accessing a database connection here (this could even be another + # request property such as request.db, implemented using this same + # pattern). + user_id = unauthenticated_userid(request) + if user_id is not None: + # this should return None if the user doesn't exist + # in the database + return request.db.query(TodoUser).filter(TodoUser.email == user_id).one() + + + class ToDoViews(Layouts): """This class has all the views for our application. The Layouts base class has the master template set up. @@ -37,11 +66,6 @@ def __init__(self, request): """Set some common variables needed for each view. """ self.request = request - self.user_id = authenticated_userid(request) - self.user = None - if self.user_id is not None: - query = DBSession.query(TodoUser) - self.user = query.filter(TodoUser.email == self.user_id).first() @view_config(route_name='home', renderer='templates/home.pt') def home_view(self): @@ -53,14 +77,9 @@ def home_view(self): tasks, and shows that number on the home page with a link to the `list_view`. """ - # Special case when the db was blown away - if self.user_id is not None and self.user is None: - return self.logout() - if self.user_id is None: - count = None - else: - count = len(self.user.todos) - return {'user': self.user, + count = len(self.request.user.todos) if self.request.user else None + + return {'user': self.request.user, 'count': count, 'section': 'home', } @@ -73,9 +92,10 @@ def tags_view(self): TODO: use request.route_url API to generate URLs in view code """ # Special case when the db was blown away - if self.user_id is not None and self.user is None: - return self.logout() - tags = self.user.user_tags + #if self.user_id is not None and self.user is None: + # return self.logout() + + tags = self.request.user.user_tags return { 'section': 'tags', 'count': len(tags), @@ -156,16 +176,7 @@ def login_view(self): class BaseView(FormView): - """subclass view to return links to static CSS/JS resources""" - - def __init__(self, request): - super(BaseView, self).__init__(request) - self.request = request - self.user_id = authenticated_userid(request) - self.user = None - if self.user_id is not None: - query = DBSession.query(TodoUser) - self.user = query.filter(TodoUser.email == self.user_id).first() + """subclass view to return links to static CSS/JS resources""" def __call__(self): """same as base class method but customizes links to JS/CSS resources @@ -234,7 +245,7 @@ def save_success(self, appstruct): """save button handler - called after successful validation save validated user prefs and redirect to list view""" - self.user.update_prefs(**appstruct) + self.request.user.update_prefs(**appstruct) self.request.session.flash( 'Settings updated successfully', queue='success', @@ -250,8 +261,11 @@ def save_failure(self, exc): self.request.session.flash(msg, queue='error') def cancel_success(self, appstruct): - """cancel button handler redirects to todo list view""" - return HTTPFound(self.request.route_url('todos')) + """cancel button handler redirects to todo list view""" + previous_page = self.request.referer + todos_page = self.request.route_url('todos') + + return HTTPFound(todos_page) def appstruct(self): @@ -259,7 +273,7 @@ def appstruct(self): TODO: find out how to generate appstruct from model - sort of model binding API or helper""" - user = self.user + user = self.request.user return {'first_name': user.first_name, 'last_name': user.last_name, 'time_zone': user.time_zone} @@ -312,11 +326,11 @@ def save_success(self, appstruct): #encapsulate with try-except if id: #edit user todo - self.user.edit_todo(id, name, tags, due_date) + self.request.user.edit_todo(id, name, tags, due_date) action = 'updated' else: #create new user todo - self.user.create_todo(name, tags, due_date) + self.request.user.create_todo(name, tags, due_date) action = 'created' msg = "Task %s %s successfully" % (name, action) @@ -348,7 +362,7 @@ def get_task(self): if todo_id is None: return False - task = self.user.todo_list.filter_by(id=todo_id).one() + task = self.request.user.todo_list.filter_by(id=todo_id).one() due_date = task.due_date.strftime('%Y-%m-%d %H:%M:%S') if task.due_date is not None else None return dict( @@ -369,7 +383,7 @@ def delete_task(self): if todo_id is None: return False - self.user.delete_todo(todo_id) + self.request.user.delete_todo(todo_id) return True @@ -384,7 +398,7 @@ def tag_autocomplete(self): if len(term) < 2: return [] - tags = self.user.user_tags_autocomplete(term) + tags = self.request.user.user_tags_autocomplete(term) return [ dict(id=tag.name, value=tag.name, label=tag.name) for tag in tags @@ -395,7 +409,7 @@ def get_bind_data(self): TODO: do we still need it after refactoring timezone conversion into model ???""" data = super(TodoItemForm, self).get_bind_data() - data.update({'user_tz': self.user.time_zone}) + data.update({'user_tz': self.request.user.time_zone}) return data def sort_order(self): @@ -424,24 +438,24 @@ def show(self, form): in contrast to original version I set both routes to highlight List menu item in navbar """ # Special case when the db was blown away - if self.user_id is not None and self.user is None: - return self.logout() + #if self.user_id is not None and self.user is None: + # return self.logout() order = self.sort_order() tag_name = self.request.matchdict.get('tag_name') if tag_name: #route match for todos-by-tag - todo_items = self.user.todos_by_tag(tag_name, order) + todo_items = self.request.user.todos_by_tag(tag_name, order) page_title = 'Tag List' else: #route match for todos - todo_items = self.user.todo_list.order_by(order).all() + todo_items = self.request.user.todo_list.order_by(order).all() page_title = 'ToDo List' grid = TodoGrid( self.request, tag_name, - self.user.time_zone, + self.request.user.time_zone, todo_items, ['task', 'tags', 'due_date', ''], ) From b9c0ca55123667d4272614d8864f05d90432ddc6 Mon Sep 17 00:00:00 2001 From: Sascha Gottfried Date: Fri, 4 Apr 2014 18:15:37 +0200 Subject: [PATCH 20/27] closes #7 --- todopyramid/grid.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/todopyramid/grid.py b/todopyramid/grid.py index a0f00bd..9d13734 100644 --- a/todopyramid/grid.py +++ b/todopyramid/grid.py @@ -114,13 +114,15 @@ def tags_td(self, col_num, i, item): def due_date_td(self, col_num, i, item): """Generate the column for the due date. + + Time-Zone Localization is done in the model """ if item.due_date is None: return HTML.td('') span_class = 'due-date badge' if item.past_due: span_class += ' badge-important' - due_date = localize_datetime(item._due_date, self.user_tz) + due_date = item.due_date span = HTML.tag( "span", c=HTML.literal(due_date.strftime('%Y-%m-%d %H:%M:%S')), From ee94eeb5e91985e387564a56df8932f00290984e Mon Sep 17 00:00:00 2001 From: Sascha Gottfried Date: Fri, 4 Apr 2014 18:17:41 +0200 Subject: [PATCH 21/27] revert to handling transaction outside of content creation function, because it fits to the existing two use-cases. --- todopyramid/scripts/initializedb.py | 139 ++++++++++++++++------------ 1 file changed, 78 insertions(+), 61 deletions(-) diff --git a/todopyramid/scripts/initializedb.py b/todopyramid/scripts/initializedb.py index 1627761..fb242b6 100644 --- a/todopyramid/scripts/initializedb.py +++ b/todopyramid/scripts/initializedb.py @@ -18,6 +18,7 @@ Base, ) +from ..utils import localize_datetime def usage(argv): cmd = os.path.basename(argv[0]) @@ -26,69 +27,83 @@ def usage(argv): sys.exit(1) -def create_dummy_content(): - """Create some tasks by default to show off the site +def create_dummy_user(): + """create our dummy user + + we handle transaction not here - design decision """ - with transaction.manager: - user = TodoUser( - email=u'king.arthur@example.com', - first_name=u'Arthur', - last_name=u'Pendragon', - ) - DBSession.add(user) - user_id = user.email + user = TodoUser( + email=u'king.arthur@example.com', + first_name=u'Arthur', + last_name=u'Pendragon', + ) + DBSession.add(user) + user_id = user.email + return user_id + +def create_dummy_content(user_id): + """Create some tasks for this user with by default to show off the site + + either called during application startup or during content creation while a new user registers + we do not handle transaction here - design decision + + TODO: bulk adding of new content + """ - #this user creates several todo items - task = TodoItem( - user=user_id, - task=u'Find a shrubbery', - tags=[u'quest', u'ni', u'knight'], - due_date=datetime.utcnow() + timedelta(days=60), - ) - DBSession.add(task) - task = TodoItem( - user=user_id, - task=u'Search for the holy grail', - tags=[u'quest'], - due_date=datetime.utcnow() - timedelta(days=1), - ) - DBSession.add(task) - task = TodoItem( - user=user_id, - task=u'Recruit Knights of the Round Table', - tags=[u'quest', u'knight', u'discuss'], - due_date=datetime.utcnow() + timedelta(minutes=45), - ) - DBSession.add(task) - task = TodoItem( - user=user_id, - task=u'Build a Trojan Rabbit', - tags=[u'quest', u'rabbit'], - due_date=datetime.utcnow() + timedelta(days=1), - ) - DBSession.add(task) - task = TodoItem( - user=user_id, - task=u'Talk to Tim the Enchanter', - tags=[u'quest', u'discuss'], - due_date=datetime.utcnow() + timedelta(days=90), - ) - DBSession.add(task) - task = TodoItem( - user=user_id, - task=u'Defeat the Rabbit of Caerbannog', - tags=[u'quest', u'rabbit'], - due_date=None, - ) - DBSession.add(task) - task = TodoItem( - user=user_id, - task=u'Cross the Bridge of Death', - tags=[u'quest'], - due_date=None, - ) - DBSession.add(task) + user = DBSession.query(TodoUser).filter(TodoUser.email == user_id).first() + time_zone = user.time_zone + + #this user creates several todo items with localized times + task = TodoItem( + user=user_id, + task=u'Find a shrubbery', + tags=[u'quest', u'ni', u'knight'], + due_date=localize_datetime((datetime.utcnow() + timedelta(days=60)), time_zone), + ) + DBSession.add(task) + task = TodoItem( + user=user_id, + task=u'Search for the holy grail', + tags=[u'quest'], + due_date=localize_datetime((datetime.utcnow() + timedelta(days=1)), time_zone), + ) + DBSession.add(task) + task = TodoItem( + user=user_id, + task=u'Recruit Knights of the Round Table', + tags=[u'quest', u'knight', u'discuss'], + due_date=localize_datetime((datetime.utcnow() + timedelta(minutes=45)), time_zone), + ) + DBSession.add(task) + task = TodoItem( + user=user_id, + task=u'Build a Trojan Rabbit', + tags=[u'quest', u'rabbit'], + due_date=localize_datetime((datetime.utcnow() + timedelta(days=1)), time_zone), + ) + DBSession.add(task) + task = TodoItem( + user=user_id, + task=u'Talk to Tim the Enchanter', + tags=[u'quest', u'discuss'], + due_date=localize_datetime((datetime.utcnow() + timedelta(days=90)), time_zone), + ) + DBSession.add(task) + task = TodoItem( + user=user_id, + task=u'Defeat the Rabbit of Caerbannog', + tags=[u'quest', u'rabbit'], + due_date=None, + ) + DBSession.add(task) + task = TodoItem( + user=user_id, + task=u'Cross the Bridge of Death', + tags=[u'quest'], + due_date=None, + ) + DBSession.add(task) def main(argv=sys.argv): @@ -100,6 +115,8 @@ def main(argv=sys.argv): engine = engine_from_config(settings, 'sqlalchemy.') DBSession.configure(bind=engine) Base.metadata.create_all(engine) - create_dummy_content() + with transaction.manager: + user_id = create_dummy_user() + create_dummy_content(user_id) From 9d4a4621548040af92eed620c9100c2becce3214 Mon Sep 17 00:00:00 2001 From: Sascha Gottfried Date: Fri, 4 Apr 2014 18:19:53 +0200 Subject: [PATCH 22/27] skip testing a view, fix typo in utils.py --- todopyramid/tests.py | 1 + todopyramid/utils.py | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/todopyramid/tests.py b/todopyramid/tests.py index e542162..243a1de 100644 --- a/todopyramid/tests.py +++ b/todopyramid/tests.py @@ -262,6 +262,7 @@ def test_inserting_multiple_todoitems_with_same_tags_using_addall_keep_tags_uniq class TestHomeView(unittest.TestCase): + @unittest.skip('skip because view uses self.request.user provided by config.add_request_method') def test_anonymous(self): from .views import ToDoViews diff --git a/todopyramid/utils.py b/todopyramid/utils.py index 606b13e..d6d8ae6 100644 --- a/todopyramid/utils.py +++ b/todopyramid/utils.py @@ -2,7 +2,7 @@ def localize_datetime(dt, tz_name): - """Provide a timzeone-aware object for a given datetime and timezone name + """Provide a timezone-aware object for a given datetime and timezone name """ assert dt.tzinfo == None utc = pytz.timezone('UTC') From f4faa8199f1576a72f6b4c8f5fd38ce103646992 Mon Sep 17 00:00:00 2001 From: Sascha Gottfried Date: Fri, 4 Apr 2014 18:32:10 +0200 Subject: [PATCH 23/27] closes #29 --- todopyramid/views.py | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/todopyramid/views.py b/todopyramid/views.py index 471e29a..303e059 100644 --- a/todopyramid/views.py +++ b/todopyramid/views.py @@ -18,14 +18,12 @@ from .grid import TodoGrid from .scripts.initializedb import create_dummy_content from .layouts import Layouts -from .models import DBSession from .models import Tag from .models import TodoItem from .models import TodoUser from .schema import SettingsSchema from .schema import TodoSchema -from .utils import localize_datetime -from .utils import universify_datetime + from sqlalchemy.exc import OperationalError as SqlAlchemyOperationalError @@ -53,7 +51,7 @@ def get_user(request): if user_id is not None: # this should return None if the user doesn't exist # in the database - return request.db.query(TodoUser).filter(TodoUser.email == user_id).one() + return request.db.query(TodoUser).filter(TodoUser.email == user_id).first() @@ -77,6 +75,9 @@ def home_view(self): tasks, and shows that number on the home page with a link to the `list_view`. """ + + #we have a home_view test that does not attach our user to our request + #FIX with enhanced testing strategies count = len(self.request.user.todos) if self.request.user else None return {'user': self.request.user, @@ -148,7 +149,8 @@ def login_view(self): email = verify_login(self.request) headers = remember(self.request, email) # Check to see if the user exists - user = DBSession.query(TodoUser).filter( + session = self.request.db + user = session.query(TodoUser).filter( TodoUser.email == email).first() if user and user.profile_complete: self.request.session.flash('Logged in successfully') @@ -163,10 +165,9 @@ def login_view(self): settings.get('todopyramid.generate_content', None) ) # Create the skeleton user - with transaction.manager: - DBSession.add(TodoUser(email)) - if generate_content: - create_dummy_content(email) + session.add(TodoUser(email)) + if generate_content: + create_dummy_content(email) msg = ( "This is your first visit, we hope your stay proves to be " "prosperous. Before you begin, please update your profile." From abe3ccc8df4a1517c3482e4847b13fbcc65e6f37 Mon Sep 17 00:00:00 2001 From: Sascha Gottfried Date: Fri, 4 Apr 2014 18:58:49 +0200 Subject: [PATCH 24/27] Reflect recent changes in TodoPyramid at readme page --- README.md | 43 ++++++++++++++++++++----------------------- 1 file changed, 20 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index fddc045..bb45200 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ [![Build Status](https://travis-ci.org/saschagottfried/todopyramid.svg?branch=master)](https://travis-ci.org/saschagottfried/todopyramid) This is a refactored version of the Pyramid app for the Python Web Shootout. -Though it is not deployed to public yet, you can try original version here: + ## Install @@ -140,18 +140,18 @@ Then we need to pull in its dependencies (which includes Deform itself). Then up (todopyramid)$ pip freeze > requirements.txt ``` -Then add the static resources to the `__init__.py` - +Since we include deform_bootstrap_extra, it does all the static resources registration usually done manually in __init__.py ``` -# Adding the static resources from Deform -config.add_static_view('deform_static', 'deform:static', cache_max_age=3600) -config.add_static_view('deform_bootstrap_static', 'deform_bootstrap:static', cache_max_age=3600) +pyramid.includes = + pyramid_tm + pyramid_persona + deform_bootstrap_extra ``` Now we need to get our template structure in place. We'll add a `todopyramid/layouts.py` with the following (see the [Creating a Custom UX for Pyramid][customux] tutorial for more details): ``` -ifrom pyramid.renderers import get_renderer +from pyramid.renderers import get_renderer from pyramid.decorator import reify @@ -167,14 +167,18 @@ Add the `global_layout.pt` with at least the following (look at the source code ``` - + - - - + + + + + @@ -185,17 +189,10 @@ Add the `global_layout.pt` with at least the following (look at the source code
- - - - - - - - - - - + + + + ``` @@ -288,7 +285,7 @@ Out[4]: u'king.arthur@example.com' ### Sorting -TodoGrid can be ordered by task name & due date - ascending and descending. +TodoPyramids TodoGrid can order a rendered list of TodoItems by task name & due date - ascending and descending. [install]: http://pyramid.readthedocs.org/en/latest/narr/install.html From baa2c71d4468bb7036d9a33c64b21b00e344f19c Mon Sep 17 00:00:00 2001 From: Sascha Gottfried Date: Tue, 15 Apr 2014 14:13:08 +0200 Subject: [PATCH 25/27] move site-menu/navbar logic in from global_layouts.pt to layouts.py, add includeme() function for integration testing, reenable skipped test for anonymous HomePage view, all tests pass - refs #30, closes #19 --- todopyramid/__init__.py | 14 ++++- todopyramid/layouts.py | 74 +++++++++++++++++++++++++- todopyramid/templates/global_layout.pt | 6 +-- todopyramid/tests.py | 20 ++++--- todopyramid/views.py | 15 +++--- 5 files changed, 105 insertions(+), 24 deletions(-) diff --git a/todopyramid/__init__.py b/todopyramid/__init__.py index 949ab2f..e1fc2e4 100644 --- a/todopyramid/__init__.py +++ b/todopyramid/__init__.py @@ -22,6 +22,17 @@ def main(global_config, **settings): settings=settings, root_factory='todopyramid.models.RootFactory', ) + + includeme(config) + + return config.make_wsgi_app() + + +def includeme(config): + """we use this concept to include routes and configuration setup in test cases + + http://docs.pylonsproject.org/projects/pyramid/en/latest/narr/testing.html#creating-integration-tests + """ config.add_static_view('static', 'static', cache_max_age=3600) # Misc. views @@ -44,8 +55,7 @@ def main(global_config, **settings): # Making A User Object Available as a Request Attribute # http://docs.pylonsproject.org/projects/pyramid_cookbook/en/latest/auth/user_object.html - config.add_request_method(get_user, 'user', reify=True) + config.add_request_method(get_user, 'user', reify=True) # scan modules for config descriptors config.scan() - return config.make_wsgi_app() diff --git a/todopyramid/layouts.py b/todopyramid/layouts.py index 87d7162..7277ce1 100644 --- a/todopyramid/layouts.py +++ b/todopyramid/layouts.py @@ -1,14 +1,86 @@ from pyramid.renderers import get_renderer from pyramid.decorator import reify +#i18n/l10n is another topic to be handled for menu items +class SiteMenu(list): + """mutable, ordered list of navbar menu items""" + + def __init__(self, request): + """Set some common variables needed for each view. + """ + self.request = request + + def populate(self, menu_items): + for k,v in menu_items.items(): + self.add_item(k,v) + + def add_item(self, title, route): + new_item = {'title':title, 'route':route} + self.append(new_item) + + +#ToDoPyramid currently highlights navbar item 'todos' for multiple routes +#Original version implemented navbar highlighting by setting a section variable +menu_items = [ + {'route': 'home', 'title': 'Home', 'routes': ['home']}, + {'route': 'todos', 'title': 'List', 'routes': ['todos', 'taglist']}, + {'route': 'tags', 'title': 'Tags', 'routes': ['tags']}, + {'route': 'account', 'title': 'Account', 'routes': ['account']}, + {'route': 'about', 'title': 'About', 'routes': ['about']} +] class Layouts(object): """This is the main layout for our application. This currently just sets up the global layout template. See the views module and their associated templates to see how this gets used. """ + + site_menu = menu_items + + def __init__(self, request): + """Set some common variables needed for each view. + """ + self.request = request + @reify def global_template(self): - renderer = get_renderer("templates/global_layout.pt") + renderer = get_renderer("todopyramid:templates/global_layout.pt") return renderer.implementation().macros['layout'] + + + @reify + def navbar(self): + """return navbar menu items and help to find current navbar item + + site menu concept inspired by + http://docs.pylonsproject.org/projects/pyramid-tutorials/en/latest/humans/creatingux/step07/index.html + + concept can be extended by components registering routes and adding their items to navbar menu + TodoPyramid adds Home, Todos, Tags, Account, About to this registry + When another TodoPyramid add-on component is activated by configuration it could add their menu item into this registry as well + + catching the matched route name inspired by + http://stackoverflow.com/questions/13552992/get-current-route-instead-of-route-path-in-pyramid + """ + def is_active_item(request, item): + """if we have a match between menu route and matched route set a boolean variable 'current' to true, else to false""" + if not request.matched_route: + item['active'] = False + return item + activate_item = True if request.matched_route.name in item['routes'] else False + item['active'] = activate_item + return item + + def menu_url(request, item): + item['url'] = request.route_url(item['route']) + return item + + def process_item(request, item): + item = menu_url(request, item) + item = is_active_item(request, item) + return item + + return [process_item(self.request, item) for item in self.site_menu] + + diff --git a/todopyramid/templates/global_layout.pt b/todopyramid/templates/global_layout.pt index 96c91c4..b186fee 100644 --- a/todopyramid/templates/global_layout.pt +++ b/todopyramid/templates/global_layout.pt @@ -45,11 +45,7 @@ ToDo Pyramid
    Date: Tue, 15 Apr 2014 14:29:05 +0200 Subject: [PATCH 26/27] remove unused code, fix small bug regarding what is in includeme() --- todopyramid/__init__.py | 5 +++-- todopyramid/layouts.py | 17 ----------------- todopyramid/views.py | 2 +- 3 files changed, 4 insertions(+), 20 deletions(-) diff --git a/todopyramid/__init__.py b/todopyramid/__init__.py index e1fc2e4..56026c5 100644 --- a/todopyramid/__init__.py +++ b/todopyramid/__init__.py @@ -25,6 +25,8 @@ def main(global_config, **settings): includeme(config) + # scan modules for config descriptors + config.scan() return config.make_wsgi_app() @@ -57,5 +59,4 @@ def includeme(config): # http://docs.pylonsproject.org/projects/pyramid_cookbook/en/latest/auth/user_object.html config.add_request_method(get_user, 'user', reify=True) - # scan modules for config descriptors - config.scan() + diff --git a/todopyramid/layouts.py b/todopyramid/layouts.py index 7277ce1..519b800 100644 --- a/todopyramid/layouts.py +++ b/todopyramid/layouts.py @@ -1,23 +1,6 @@ from pyramid.renderers import get_renderer from pyramid.decorator import reify -#i18n/l10n is another topic to be handled for menu items -class SiteMenu(list): - """mutable, ordered list of navbar menu items""" - - def __init__(self, request): - """Set some common variables needed for each view. - """ - self.request = request - - def populate(self, menu_items): - for k,v in menu_items.items(): - self.add_item(k,v) - - def add_item(self, title, route): - new_item = {'title':title, 'route':route} - self.append(new_item) - #ToDoPyramid currently highlights navbar item 'todos' for multiple routes #Original version implemented navbar highlighting by setting a section variable diff --git a/todopyramid/views.py b/todopyramid/views.py index 182e38b..e8593fa 100644 --- a/todopyramid/views.py +++ b/todopyramid/views.py @@ -17,7 +17,7 @@ from .grid import TodoGrid from .scripts.initializedb import create_dummy_content -from .layouts import Layouts, menu_items +from .layouts import Layouts from .models import Tag from .models import TodoItem from .models import TodoUser From 10af11f5a1c8cc1c4112430841d46bce1fad1260 Mon Sep 17 00:00:00 2001 From: Sascha Gottfried Date: Thu, 12 Jun 2014 13:49:11 +0200 Subject: [PATCH 27/27] add link to OpenShift deployment ToDoPyramid is now running on OpenShift using a Free Plan --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index bb45200..68c38d5 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,9 @@ [![Build Status](https://travis-ci.org/saschagottfried/todopyramid.svg?branch=master)](https://travis-ci.org/saschagottfried/todopyramid) -This is a refactored version of the Pyramid app for the Python Web Shootout. +This is a refactored version of the Pyramid app for the Python Web Shootout originally crafted by SixFeetUp. + +Try it out here: ## Install