Download all button and markdown problem statement

[brentvatne]

As per the discussion in issue #55

Summary of new features proposed

• A downloadable markdown version of the problem statement for each puzzle
• A download all button that serves the user a zip of all puzzle attachments and the problem statement

Code not yet ready to be merged, missing zip functionality.

Pending for discussion

• What should the route be for a zip file? And the name?
• Related to issue #58, if the slug of the puzzle name becomes the identifier in the show route, then it seems ideal that we use the same naming convention for the zip and problem statement files. Eg: /puzzles/six-degrees-of-separation.markdown

[jordanbyron]

I started writing a response, but thought it would be much better to get ticket #58 complete before we wrap up this feature. Then both the zip and markdown files can use the Puzzle slug as their names. That is much more desirable then '2.zip' and '2.markdown'.

@brentvatne Would you mind taking a stab at that ticket? If not I'll see if I can find someone to get that done so we can use the stub data here.

[brentvatne]

@jordanbyron: Sure, I'm busy for the next couple of days at work but I will get that one done asap.

[jordanbyron]

@brentvatne Great. Once you are done with that we can resume work on this. Let me know if you get stuck or are too busy to finish it.

[brentvatne]

@jordanbyron 985c7d0 represents a nearly complete patch I believe. This turned out to take longer than expected, oh well :satisfied:

Some notes and questions:

• I hope rebasing was the right thing to do to catch up with the updates, I'm beginning to think that maybe not :P
• Need to create a rake task to generate the markdown file and zip files. Alternatively, perhaps we could generate them automatically if they are missing by checking for existence in a controller before streaming the file (currently I'm bypassing the stack by just accessing them through the public folder)
• Need to clean up Puzzle tests side effects - they end up saving a bunch of puzzle files.
• For the file functionality itself, I separated it into separate classes: PuzzleFile::Description, PuzzleFile::Zipped
• A benefit of separating them out this way was that I was able to write some isolated tests. Check out /test/bare_test_runner.rb (should probably change this so it loads the tests in random order using some built in runner, just requiring for now). Since this was pretty test driven to be sure everything was working properly every step along the way, I was getting tired of loading the Rails environment. It might be nice to do this with more of our unit tests.
• My before_save callback does not seem to be working as I expected: I wanted it to call delete_related_files any time I update a Puzzle, so I can delete the old files and re-create them. Am I using the right callback and doing something else wrong, or should I be using a different callback? Silly me at 2:30am - I now realize the problem: the delete method uses the current slug name to delete the file, so if you change the slug, the file will not be found. Any ideas for an elegant way to solve this? Okay I found a good way to solve this, using the amazing ActiveRecord dirty model features. See commit 181c4e9. The core of the solution:

  def delete_old_files
    old_puzzle = dup.reinitialize_files
    old_puzzle.slug = slug_was || slug
    old_puzzle.delete_related_files
  end

[jordanbyron]

This patch will not die in vain