pushpickup / pushpickup

Find people to play pickup sports with
http://pushpickup.com
MIT License
19 stars 4 forks source link

Refactor: Split up HTML Templates #143

Closed sgup closed 10 years ago

sgup commented 10 years ago

Split up and group HTML templates by functionality.

(This will be done by tonight.)

sgup commented 10 years ago

Pulled in just the HTML changes I'd made on the tidy-up-codebase branch, into a new branch called split-up-html. When split-up-html is done, @stewartmccoy can merge it into the main branch.

On a side note, the changes to the html files were across many commits with js edits mixed in. Cherry pick or regular merge wouldn't work, and I learned something new: http://jasonrudolph.com/blog/2009/02/25/git-tip-how-to-merge-specific-files-from-another-branch/

sgup commented 10 years ago

@stewartmccoy @nickytonline

Whew! I'm done splitting up the templates and grouping them according to functionality. To navigate the code, either use the directory structure, or filename search in sublime text (Cmd+T), or a full text search in case you can't find what you need.

Please look over the tree and see if the organization makes sense. Check if things need shifting before merging with devel.

There are a number of templates which I could not find being used. These are the left-over templates which were replaced with 'devTemplates'. They are marked with a <!-- #unused --> comment on the line before the template. Some are used, but their parents are not. These are marked with <!-- #unused parent -->. The JS code needs to be pruned before these templates can be deleted. For now, they are in their original files (devel.html and pushpickup.html), which have been renamed to devel-unused.html and pushpickup-unused.html

views $ tree
.
├── admin
│   └── admin-view.html
├── application
│   ├── body.html
│   ├── cover-photo.html
│   └── layout.html
├── feedback
│   └── help-and-feedback.html
├── forms
│   ├── radio-form.html
│   └── select-form.html
├── games
│   ├── common
│   │   ├── add-players.html
│   │   ├── add-self-and-friends.html
│   │   ├── game-type-indicator.html
│   │   ├── game-when.html
│   │   ├── invite-friends-input.html
│   │   ├── invite-friends.html
│   │   └── who-is-playing.html
│   ├── creategame
│   │   ├── editable-game-map.html
│   │   ├── editable-game.html
│   │   ├── select-location.html
│   │   ├── select-when.html
│   │   ├── submit-and-wait.html
│   │   └── whos-playing-editable.html
│   ├── detailview
│   │   ├── comments
│   │   │   ├── add-comment.html
│   │   │   ├── authenticate-and-comment.html
│   │   │   ├── comments.html
│   │   │   └── game-comment.html
│   │   ├── detail-body.html
│   │   ├── detail.html
│   │   ├── join-or-leave.html
│   │   ├── nav
│   │   │   ├── back-to-list.html
│   │   │   ├── copy-game-link.html
│   │   │   ├── detail-nav.html
│   │   │   ├── edit-game-link.html
│   │   │   └── share-game-link.html
│   │   ├── organizers-note.html
│   │   ├── solo-game-map.html
│   │   ├── solo-game-summary.html
│   │   └── whos-playing-summary.html
│   └── listview
│       ├── add-friends-link.html
│       ├── list-header.html
│       ├── list-header.js
│       ├── list-of-games.html
│       ├── listed-game-summary.html
│       ├── listed-game.html
│       └── load-more-games.html
├── includes
│   ├── back.html
│   ├── footer.html
│   ├── loading.html
│   ├── spinner-if-waiting.html
│   └── tiny-spinner.html
├── location
│   ├── get-current-location.html
│   ├── set-location.html
│   └── set-location.js
├── navigation
│   ├── add-game-link.html
│   ├── nav.html
│   ├── options-extended.html
│   └── options-main.html
├── search
│   ├── exit-search.html
│   ├── findings-map.html
│   ├── run-search.html
│   ├── search-backtrack.html
│   ├── search-extended.html
│   ├── search-input.html
│   ├── search-query.html
│   ├── select-game-types.html
│   └── start-search.html
├── settings
│   ├── change-location.html
│   ├── change-location.js
│   ├── settings-cog.html
│   ├── settings-item.html
│   └── settings.html
└── user-account
    ├── add-info-or-sign-in.html
    ├── change-email-address.html
    ├── change-password.html
    ├── forgot-password.html
    ├── set-password.html
    ├── sign-in.html
    └── sign-up.html
majornorth commented 10 years ago

@sgup this makes sense at first peak. I'll try and pull this later this afternoon and take a look.

majornorth commented 10 years ago

@sgup yeah dude, this makes sense to me—I like it. @nickytonline @soulcorrea do you have any thoughts? I'm going to go ahead and merge into devel later this afternoon unless anybody sees any red flags. @dwinston your feedback is welcome to if you've any :)

nickytonline commented 10 years ago

@sgup, looks good. Just a few minor changes. Call the includes folder shared and pop body.html and cover-photo.html (assuming cover-photo.html is a common template) in it and pop layout.html in a folder called layouts. Sound good to you @soulcorrea ?

sgup commented 10 years ago

Sounds good, though cover-photo.html is only used on the front page

soulcorrea commented 10 years ago

@nickytonline, sounds good! Nice work, @sgup!

sgup commented 10 years ago

thanks!

dwinston commented 10 years ago

@sgup looks good -- thanks. :) When the structure/functionality of the app was in a "discovery" phase, it made sense to me to keep all the components together for flexible (re)ordering; with a gelled structure, having folder naming/hierarchy indicative of said structure is great self-documentation for the codebase.

Another (embarrassing) reason I stayed with a few big files was that I was mainly using incremental search within files for navigating code. Recently, however, I discovered and have been using vc-git-grep in Emacs almost exclusively; it works independently of folder structure and allows one to view at a glance a key-word-in-context index of a regular expression in the codebase and to easily navigate to/step through all results (can't do the latter with git grep on the command line). Hooray for better tools and lifelong learning. :)

majornorth commented 10 years ago

holla! I'll work on merging into devel later this morning! I'm gonna hold off on merging to master until tidy up codebase is done. Make sense?

sgup commented 10 years ago

@stewartmccoy yes, that works

majornorth commented 10 years ago

@sgup merged and pushed to devel

majornorth commented 10 years ago

@sgup close this issue if you're done :)