Picturesque Bo-Kaap was for decades the home of Muslim residents. Now, as some cash in on soaring house prices, others want to hold on to their history