So what was I unhappy about?

Configuration:

I was pretty unhappy with the way configuration was being done. I liked using Configatron to power the configuration, but I didn’t like the way I implemented the way I was using Configatron. For example, to set up one of the default settings, like the expiry time, you would configure it like such:

configatron.cachetastic_default_options.expiry_time = 30.minutes

Now you would configure that same option like this:

configatron.cachetastic.defaults.expiry_time = 30.minutes

That’s a little savings, but it really hits when you want to configure a particular cache. Let’s say we a cache called My::Super::AwesomeCache, to configure it in past versions of Cachetastic we would do this:

configatron.my_super_awesome_cache_options.expiry_time = 15.minutes

Now in Cachetastic 3.0.0 we configure like this:

configatron.cachetastic.my.super.awesome_cache.expire_time = 15.minutes.

As you can see all configuration now happens under the cachetastic namespace in Configatron. Then it’s a matter of using a Configatron namespace for each of your modules. I find it a lot easier to manage.

Another change in configuration is that in previous versions if you wanted to override one default configuration value for a particular cache,  you had to override them all. Now, you can just override the one value  you want, and the rest will be nicely inherited from the defaults.

Speed

Cachetastic has always been a very fast library, but I knew that more could be squeezed from that stone. With Cachetastic 3.0.0 you now get a hefty 25% improvement in the Memcached adapter and a whopping 99% in the LocalMemory adapter! Those are pretty awesome numbers. These numbers were easy to achieve when I stepped back and examined what it was I really wanted to do, and picked the most straightforward path to that goal.

Bloat

After more than two years Cachetastic was starting to suffer from a severe case of bloat. For example, I’ve never used the DRb adapter, have you? So why is it there? The same goes for the HtmlFile adapter. I wrote that because at my last job the operations team weren’t savvy  enough to be able to get Apache to talk to Memcached, so they wanted to serve HTML files, hence the rather awful adapter. Both of those adapters are now history.

There also used to be support for Rails Session Caching. Considering that most people are now using the Cookie store for sessions, there really is no need for this cache. It could also be argued that it should not have been bundled with Cachetastic at all. I would agree with those arguments. Cachetastic is, and should always be, a standalone caching framework, that can be plugged into Rails or any plain old Ruby project that needs caching support.

Also purged is automatic support for mixing in the Cachetastic::Cacheable module into ActiveRecord. If you want this functionality, it is very easy to include in your application. I don’t want to force it on anyone, so that is gone now.

Finally there are a handful of smaller features that I’m sure no one will miss that I’ve yanked out in the name of performance, reliability, and ease of maintenance.

Nice and Clean

When I realized what I really wanted, and what I didn’t want, it became clear that what was needed was a fresh code base. With that said, I hit delete (well, not really) and started over again. The code is now smooth, so much easier to read, and fast. In previous versions even my eyes went a bit crossed when I tried to figure out exactly what was going on. There where quite a few levels of indirection, and things just weren’t place where they probably should’ve been. That has all been fixed.

With a nice, clean code base comes a brand new set of tests. The tests are now extremely comprehensive, and while 2.x was very well tested, I know that 3.0.0, is tested to the hilt.

Because 3.0.0 is a brand new code base, I should probably stress the fact that is NOT backward compatible. So please be advised.

Installation:

$ sudo gem install cachetastic

Conclusion

I really hope everyone likes this brand new version of Cachetastic. I’m very happy with it, and I think if you give it a chance, you will be too.

If you’d like to have a peek at the RDoc, it can be found at:
http://cachetastic-api.mackframework.com/

With the help of the absolutely amazing multiruby library and an edge version of rspec from GitHub, the latest version of Configatron now supports JRuby 1.1.6 and Ruby 1.9.1rc1. There are no other functional changes to the library, so it’s a full drop in replacement for vesion 2.1.6.

I highly encourage everyone to checkout multiruby and start upgrading their libraries so we can all move to 1.9 quicker, which means more speed and more power. Once we’re all in 1.9 land we can really make use of some of the amazing features it provides.

Anyway, I’ll be working on upgrading all my libraries and applications to work on 1.8 and 1.9, and hopefully JRuby, over the next couple of months. So be on the look out for a new versions of Cachetastic, Genosaurus [update: Genosaurus already works with 1.9 and JRuby. Hoorah!], and, of course, Mack.

Configatron Support

Mack 0.8.0 replaces the old application_configuration system with the new ultra sexy and cool, Configatron system. This is a much better way of doing system configurations, and I’m sure you’ll agree once you give it a spin. We’ve tried to take the edge off the conversion of these configuration systems with a helpful little rake task:

$ rake mack:update:configuration

For most cases, that task should do just fine. There might be a few places you have to tweak, such as in your own code, but once you do that, you’ll love Configatron!

For more information about using Configatron checkout this page:

http://www.mackery.com/configuration/configatron

A New Router

That’s right, the router in Mack has been completely rewritten from the ground up, yet unlike other frameworks, we’ve managed to keep our external API the same, so you don’t have to change your routes.rb at all. That’s a bit of good news, isn’t it?

What do you get with the new router? Well, for one, it should be faster, that’s always a plus. You can also now do ‘wildcard’ parameters in routes, use procs, extended ‘resourced’ routes, define ‘host’ and ‘scheme’ parameters, use regular expressions, and a few other little nifty things. Plus, because of the rewrite, it’s going to make it easier to extending the routing system to be even more powerful! In a future release, sometime in the 0.8.x series, you’ll even be able to plugin in your own router just by implementing a few API methods.

For more information about the new router, and what you can do, check out:

http://www.mackery.com/routing/index

Asset Management

There is now a really great asset management system that easily allows you to build bundles of CSS and JavaScript files to help keep your code neat and easy to use. Bundle that with the new mack-asset_packager gem, and support for asset hosts, you get a simple, easy, and fast way to compress and deliver your assets. 

For more information, checkout these helpful pages from the user guide:

http://www.mackery.com/views/asset_mgr
http://www.mackery.com/views/asset_host 

Misc.

As always, there’s a bunch of other great stuff just lurking around in this release. A better logger, for a start, more helpers, bug fixes, better error reporting, default 404 and 500 pages, and more. Please download and enjoy the release, I’m sure you’ll find worth it. Enjoy!

Changelog:

1. [#187] Fixed: When an exception is raised, the request doesn’t get ‘logged’
2. [#185] Fixed: .html is being appended to logged requests when there’s a 404
3. [#184] Request logging should also print the message of the status code
4. [#183] Updates to asset mgr/host
5. [#181] Content-type can now be set with calling render.
6. [#179] When configatron.mack.show_exceptions is false you now either the public/404.html or public/500.html file.
7. [#178] Added a configure parameter to turn off log coloring
8. [#176] Added a Google Analytics helper.
9. [#175] Generating urls should use host or scheme if defined
10. [#171] Ability to extend resources in routes
11. [#170] Regex support in routes
12. [#169] Proc support for Routes
13. [#168] Fixed ERB errors not being reported correctly.
14. [#167] Rake task to convert app config yamls to configatron
15. [#165] Asset Packager
16. [#164] Response helper for ‘attachments’
17. [#159] Added link_unless_current and link_if helpers
18. [#156] Added ‘Wildcard’ Routes support
19. [#152] INCOMPATIBILITY NOTICE: Removed deprecated support for delivered_emails use delivered_notifiers instead.
20. [#138] Added support for ‘host’ & ‘scheme’ parameters in routes
21. [#135] Replaced log4r with logging gem.
22. [#119] Freeze gems
23. [#106] INCOMPATIBILITY NOTICE: Removed deprecated support for droute_url
24. [#93] INCOMPATIBILITY NOTICE: Removed deprecated support for ‘top’ level ApplicationHelper
25. [#23] INCOMPATIBILITY NOTICE: Removed support for application_configuration and added support for configatron
26. gem: logging 0.9.4
27. gem: thin 1.0.0
28. gem: rspec 1.1.8
29. gem: configatron 2.1.4
30. gem: cachetastic 2.0.0

Although not as sexy a release as 0.7.0, there are some very important bug fixes and some cool new little features in this release. Rack has been upgraded to v0.4.0. DataMapper to 0.9.5. Facets to 2.4.4, and a few other gems as well.

There is now a much nicer session store API that will allow developers to build their own session stores. There’s also a couple of new session stores that ship with 0.7.1. There’s a DataMapper session store, and a cookie session store, which is now the default session store. The previous Cachetastic based session store can be used by requiring the mack-caching gem in gems.rb and putting the following setting in your app_config/*.yml file:

mack::session_store: cachetastic

There is now built-in support to help prevent cross-site scripting attacks on forms. Some view helper methods have nice updates such as :disable_with and :confirm, and asset hosts.

And a whole host of other little improvements across the board. Enjoy!

Changelog:

• [#153] Emails with just a single ‘part’ are now being sent correctly.
• [#147] Added :confirm to button helpers.
• [#146] [Diogo Almeida] Added :disable_with to submit_button form helper.
• [#145] Added rake generate:<generator_name>:desc task to ‘describe’ a Genosaurus generator
• [#144] INCOMPATIBILITY NOTICE: rake server is no more. Please use mackery server instead.
• [#142] INCOMPATIBILITY NOTICE: rake console is no more. Please use mackery console instead.
• [#140] Added Mack::BootLoader
• [#139] Added ability to change the pattern for test files
• [#137] Added subdomains method on request.
• [#130] Added ability to ‘reload’ the console
• [#129] DataMapper 0.9.5 support
• [#128] Updated json_pure to 1.1.3 and removed ruby-debug dependency
• [#127] Moved mack-paths into core
• [#126] XSS Prevention
• [#125] Cookie store is now the default session store, not cachetastic
• [#124] Opened up the session store API
• [#122] Added DataMapper session store.
• [#121] Cookie session store support.
• [#120] Added PassengerGenerator to generate the necessary files to run Mack with Passenger Phusion (mod_rails)
• [#118] Mack/mack-more can be loaded from vendor/framework/mack and vendor/framework/mack-more
• [#117] Added rake task: mack:freeze:edge
• [#107] Updated to Rack 0.4.0
• [#95] Removed deprecated model_* methods
• [#94] Removed deprecated submit_tag
• [#40] Added Mack::Utils::ContentLengthHandler so response will now have ‘Content-Length’ in its header.
• [#21] Asset Hosts
• gem: rack 0.4.0
• gem: json_pure 1.1.3
• gem: data_mapper 0.9.5
• gem: genosaurus 1.2.4
• gem: ezcrypto 0.7
• gem: facets 2.4.4

 

 

As a side note, Mack will be moving away from application_configuration to configatron around version 0.8.0, but more on that later.

I highly encourage all of you out there to add this project to your ‘watch’ list on GitHub. And if you have the time, and want to help write something special, I highly encourage you to fork it and start contributing! Time to get out there and start making the Ruby world a much, much, much better place.

class Person
include Cachetastic::Cacheable
end
Person.set_into_cache(:hi, "Hello There")
Person.get_from_cache(:hi) #=> "Hello There"

Under the covers this creates a Cachetastic::Caches::Base object and proxies requests to it. This is a very simple example and belies the richness of the Cachetastic library. 

http://cachetastic-api.mackframework.com/

Features:

• Flexible configuration. All caches have can either have their own configurations, or they can inherit from a default configuration.
• Easy to use Adapter API. Included adapters include, LocalMemory, Memcache, DRb, File, and more. With the Adapter API being so simple, it’s easy to build your own custom adapter.
• Flexible logging. Each cache can have it’s own loggers, or they can use the default logger.
• JIT caching. Through Ruby’s powerful block structure, you can pass a block to a ‘get’ call and have it run if the results from the get are either ‘nil’ or ‘empty’
• Cachetastic::Cacheable module turns any Object into a cache. It allows for any instance of that Object to cache and uncache itself.
• And much more!

If you didn’t have the gem installed you would get some not very nice messages. This require was fixed in cachetastic-1.4.1. Mack 0.2.0.1 uses the new version of cachetastic. There is no new functionality in 0.2.0.1, it’s simply the require fix.

Some really cool functionality is in the works for 0.3.0 of Mack, including everyone’s favorite, distributed routes. This, unfortunately, probably won’t be out till the end of next week.

$ sudo gem install mack

Like always, please allow time for the gem to propagate throughout the RubyForge mirrors.

no such file to load -- memcache

The problem is mack-0.2.0 uses the cachetastic-1.3.1 gem, which has an errant require in the memcache adapter. There will be a patch forthcoming for Mack to use the lastest version of cachetastic which solves this issue.

Until that patch is out, the easiest thing to do is install the memcache-client gem, like such:

$ sudo gem install memcache-client

If you find a bug, please head on over to RubyForge and submit a ticket for it, and I’ll do my best to turn it around as quick as possible.

Changelog:

• gem: thin 0.7.0

• gem: cachetastic 1.3.1

• Fixed 18487: #convert_security_of_methods ignores new_level param