The newLISP on Rockets blog

 RSS Feed for this blog

MVC code patterns, templates, and complexity


Post #: 65
Post type: Blog post
Date: 2012-11-08 15:15:49.000
Author: Rocket Man

Today I implemented an entirely different way to view posts and comments, the forum view. When you view a blog post, the same post also exists in the forums. In fact, you can click on the "View post in forums" button to toggle the views.

A lot of people would tell you to write this kind of thing using the MVC (model-view-controller) model, or at least use a framework that has a templating system so that you can view the same data differently.

This is a completely valid perspective and I'm not going to argue otherwise. MVC is a well-established design methodology and it works pretty well for a lot of different applications. Templates seem like they could be really useful.

I didn't implement the forum view this way, however. I just had a toggle variable called (forum-view-post) and checked to see if it was true. If it was, then I executed a different code block. The real danger here is code duplication, which is something we always want to avoid.

The thing is, implementing this very different view took only ten lines of code.


(displayln "<h3>" (list-post-data 3) "</h3>")
(set 'header-list '("Author" "Message"))
(set 'post-data (list (string "<img src='images/avatars/" (author-avatar (list-post-data 1)) "'><br>" (author-name (list-post-data 1))) (format-for-web (list-post-data 4))))
(set 'PostId (int (list-post-data 0)))
(set 'post-data (list post-data)) ; okay these two lines of code are duplicated... I can live with it for now
(set 'post-comments (get-record "Comments" PostId))
(if post-comments (begin
(dolist (p post-comments)
(push (list (string "<img src='images/avatars/" (author-avatar (p 2)) "'><br>"(author-name (p 2))) (format-for-web (p 5))) post-data -1)) ; add each comment to the thread
))
(display-table header-list post-data "striped")


Okay, so two lines of code are duplicated in the alternate (blog) view, which I had already written. If it was much more than this, maybe I'd write a function and move it outside the block so that I didn't have duplicate code. Obviously I don't want to have to change things multiple times every time I change the view. But these two lines only extract the comment data from the database, so I wouldn't be changing these anyway.

Now, let's say I wrote this using a template system, or with MVC, or both. It would be a lot more than ten lines of code. I would have to learn another language (the templating language) and I would have to write a bunch of classes and methods and make sure they all work properly together, maybe writing a bunch of unit tests to ensure I don't break anything if I change the contracts between the model, view, and controller. More code equals more opportunities for bugs. In fact, the number of lines of code is the only aspect of development that has a strong correlation with the number of bugs. Everything else is too hard to measure. Fewer lines of code also take less time to write, in general. So all else being equal, wouldn't you want to have fewer lines of code to do the same thing?

As far as templates go, they make a lot of sense in a big company where there is a whole department doing user interface design and another department doing coding. The designers can learn the templating language and HTML, and not have to learn anything else. For my personal development, I am both the interface designer and the developer.

The newLISP code is my templating language. I don't want to have to learn another language if I can just keep everything together. Overall, the arguments for using MVC and templating work better for larger projects with lots of people. newLISP on Rockets is optimized for very small development teams, including projects where the team is only one person. In these cases, simplicity almost always wins out over complexity.

Comments (9)

Views: 4974


Linking a blog to a forum...


Post #: 59
Post type: Blog post
Date: 2012-11-06 15:17:32.000
Author: Rocket Man

Blogs and forums are two different things, but they don't have to be.

I'm adding a forum to the Rockets blog, where any registered user will be able to post on any topic. Each new blog post will appear on the forum, and any comments added in the forum will be reflected in the blog itself. But the inverse is not true-- any new forum post will not appear on the blog. This allows other users to start discussions and interact with each other without interrupting the blog itself.

The way I do this is to add a new column called "PostType" that can be either "Blog post" or "Forum post". The former will be retrieved by the main page, while the latter is retrieved by the forum page.

I'm also using my new (display-table) function to display the forum posts.

Comments (10)

Views: 4172


Tables and Avatars...


Post #: 53
Post type: Blog post
Date: 2012-11-02 23:27:05.000
Author: Rocket Man

A couple of additions today...

First, a Table function that prints some nicely-formatted HTML tables.


(display-table list-of-headers nested-list-of-data "optional form styling")

striped - alternates rows in grey
bordered - adds borders and rounded corners to the table
hover - enables hover state on table rows when mousing over
condensed - more condensed style of table


This is a neat way of displaying tabular data in a pretty way, just by passing in lists.

The other thing is that I've changed the formatting of comments to include user avatars to the left of each comment. Unfortunately I didn't have time to get avatar uploading working. That will have to wait for next week!

Comments (4)

Views: 4226


I've got a Rocket!


Post #: 52
Post type: Blog post
Date: 2012-11-01 21:42:04.000
Author: Rocket Man

Some sites have a mascot. Okay, we have a rocket, let's call him Rocketty. Done.

Now all we need is a theme song.



This is another UBB code enabling the user to embed YouTube videos. Just use the tags [ youtube ] and [ /youtube ] (without the spaces) and in between, put the alphanumeric string of that video (eg: rJppnG1tflU)

Comments (1)

Views: 4791


Editing!


Post #: 51
Post type: Blog post
Date: 2012-11-01 17:17:39.000
Author: Rocket Man

So, now we have the final U in CRUD done, and I can finally edit posts. YOU can't edit comments yet, but that's coming soon, probably tomorrow.

That's fun. EDITING ROCKS! It's also a really neat macro that makes it pretty easy to do SQL update statements.

Here's another neat thing: Basically, I use the exact same statement to create and update a post:

(update-record "Posts" Id PosterId PostDate PostSubject PostContent) ; It's the U in CRUD!

(create-record "Posts" Id PosterId PostDate PostSubject PostContent) ; It's the C in CRUD!

There's a lot of stuff going on behind the scenes to translate the above into two very different SQL statements. Basically the Id in the first is to CHECK for Id's value, and in the second statement it is to SET Id to that value. I like the symmetry,

Comments (19)

Views: 4993


Parameterizing SQL queries


Post #: 50
Post type: Blog post
Date: 2012-10-31 00:37:48.000
Author: Rocket Man

Sometimes SQL injection comes in tricky forms. Often attackers will add on extra junk in the URL to try and confuse SQL into doing something it wasn't intended to do. For example, if the URL for page 2 is:
http://newlisponrockets.com/rockets-main.lsp?p=2

an attacker might try something like
http://newlisponrockets.com/rockets-main.lsp?p=2 OR 1=1

to try and break the code or inject some other SQL into the query by adding these commands with spaces.

I've added a function called (force-parameters) that makes it easy to prevent this. For example, to get the page number from the URL, I used to call ($GET "p"), which in this case would return "2 OR 1=1".

Now, I use the code:

(set 'current-page (force-parameters 1 ($GET "p"))) ; we only need the first part, ignore anything else

which takes only the first parameter from the URL. You can add as much extra junk after it, but it will only take the "2".



Views: 3814


Testing UBB code


Post #: 49
Post type: Blog post
Date: 2012-10-29 23:21:47.000
Author: Rocket Man

Just a little bold and italics and underlines

and some code samples:

(format-for-web str-input-text)

The above code now translates these UBB codes into HTML. Actual HTML is converted to its literal equivalent to avoid cross-site scripting issues.

Comments (3)

Views: 4626


Welcome emails for new users!


Post #: 48
Post type: Blog post
Date: 2012-10-29 21:41:28.000
Author: Rocket Man

When I started this little thing a month and a half ago, I didn't expect anyone to notice it right away. The Internet is a big place and Rockets is, for now, quite small.

But a few people have found their way here (welcome guys!) and so I now need a way to send some welcome emails for new users.

I've added a function called (send-mail), which sends an email to a given address. Behind the scenes it uses the Unix command sendmail, so you will need to have that installed on your server (simply type "sudo apt-get install sendmail" on Ubuntu or Debian).

To avoid emails falling into spam traps, you need to be sending from a valid email address that has the same domain as the server that is sending it. The (send-mail) function will take care of all the headers and things automatically.

For example, for new users, I simply use:

(send-mail UserEmail "newlisponrockets@newlisponrockets.com" "Rocket Man" "Welcome to the newLISP on Rockets blog!" welcome-email)

where welcome-email is the string of the body of the email.



Views: 4147


Documentation!


Post #: 46
Post type: Blog post
Date: 2012-10-23 00:02:56.000
Author: Rocket Man

Documentation is something I have a particular fondness for. I actually got my start in the software industry as a technical writer, so I appreciate it when things are well-documented. Of course now that I am a developer I find writing documentation to be a chore!

The way I've done documentation in Rockets is to automatically generate it from the comments in the core file that contains all of Rockets' functions. However in order for this to work I had to go back and clean up and standardize all the comments, something that I had been putting off. Oh well, sometimes chores need to be done!

One thing I always disliked about most programming documentation is the requirement to understand and translate some weird meta-language or syntax for the usage of each statement. Usually it was easier to just look at the example and figure out what the author meant. So for Rockets, all my usage statements are in fact examples, albeit using names and strings that describe their actual function. So for example (open-database "database name") is both the usage and the example of opening a database.

Comments (1)

Views: 4173


How to make a custom 404 Not Found page


Post #: 45
Post type: Blog post
Date: 2012-10-22 21:33:43.000
Author: Rocket Man

This is something really simple, the perfect assignment for a Monday morning.

Go to your site's root directory (usually /var/www) and edit the .htaccess file (type sudo nano .htaccess)

Add the following line to the end of the file:

ErrorDocument 404 /rockets-404.lsp

Now any 404 (page not found) errors will redirect to this page instead of displaying the generic Apache error.



Views: 3885


Topics


Rockets
Test