Too many modern flats are samey and soulless. A new book celebrates the architects coming up with creative solutions for our overcrowded cities