cssensible 0.2.2 → 0.3.0

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## 0.3.0 (July 27th, 2010)
+
+* improved returned grids (multiple line-heights within one result that still make up the same grid)
+* cleaner output
+
+
+## 0.2.2 (July 19th, 2010)
+
+* fixed bug that made everything explode once --line-height was NOT used
+
+
 ## 0.2.1 (July 17th, 2010)
 
 * fixed bug that made everything explode once --line-height was used

data/README.md

@@ -28,18 +28,31 @@ Options:
     # finds sensible grids including a font-size of 12px
     $ cssensible 12
 
+
     # finds sensible grids including both 12px and 16px
     $ cssensible 12 16
 
-    # finds sensible grids including both 12px and 16px where the resulting
+
+    # finds sensible grids including 12px, 15px and 16px where the resulting
     # line-height for every font-size is at least 1.3em
-    $ cssensible --line-height 1.3 12 16
+    $ cssensible --line-height 1.3 12 15 16
+
+		line-height: 12px (9 font-sizes)
+
+		  font-size (px)  |  line-height (px)  |  line-height (em)  
+		------------------+--------------------+--------------------
+		  10              |  18                |  1.8               
+		  12*             |  18                |  1.5               
+		  15*             |  24                |  1.6               
+		  16*             |  24                |  1.5               
+		  20              |  30                |  1.5               
+		  24              |  36                |  1.5               
+		  25              |  36                |  1.44              
+		  28              |  42                |  1.5               
+		  30              |  42                |  1.4               
 
 
-## Documentation
 
-View the HTML document:
-    $ open doc/index.html
 
 ## Problems?
 

data/lib/cssensible/finder.rb

@@ -5,7 +5,7 @@ require_relative 'vertical_grid'
 module CSSensible
   class Finder
     # A line-height should be at least this em-value to improve readability.
-    # MIN_LINE_HEIGHT_EM_VALUE = EmValue.new(1.3)
+    MIN_LINE_HEIGHT_EM_VALUE = EmValue.new(1.3)
 
     # Size in pixel a font should at least be to be readable
     MIN_FONT_SIZE_PX = 10
@@ -13,56 +13,78 @@ module CSSensible
     attr_reader :font_size
 
     # Returns a new Vertical Grid Finder based on the font size passed to new.
-    def initialize(font_sizes, min_line_height_em)
+    def initialize(font_sizes, min_line_height_em = MIN_LINE_HEIGHT_EM_VALUE)
       @font_sizes = font_sizes.sort
-      # set minimum line-height to value passed OR 1.0 IF NIL
-      # TODO this is probably wrong
-      @min_line_height_em = min_line_height_em || 1.0
+      @min_line_height_em = min_line_height_em
     end
 
     # Finds sensible vertical grids based on the parameters given in new.
     def find
       vertical_grids = []
-      line_heights = []
 
-      # go through all line-heights that could possibly include all font-sizes
-      (@font_sizes.last .. @font_sizes.last * 2).each do |line_height|
-        line_height_usable = true
+      # for the first iteration, all line-heights from the smallest font-size
+      # to two times the largest font-size are potentially possible
+      line_heights = (@font_sizes.first .. @font_sizes.last * 2).to_a
 
-        # go through all of the required font-sizes
-        @font_sizes.each do |font_size|
-          # check if line-height for this font-size can be expressed in 'em'
-          line_height_em = EmValue.new(line_height / font_size.to_f)
+      # go through required font-sizes and identify all line-heights that work
+      # with all of them
+      @font_sizes.each do |font_size|
+        possible_line_heights = []
 
-          unless line_height_em.usable?
-            line_height_usable = false
-            break
+        # keep line-height if it can be expressed in valid 'em' for this
+        # font-size
+        line_heights.each do |line_height|
+          if EmValue.new(line_height / font_size.to_f).usable?
+            possible_line_heights << line_height
           end
         end
 
-        line_heights << line_height if line_height_usable
+        # for next iteration, only check line-heights that work with this
+        # font-size
+        line_heights = possible_line_heights
       end
 
       line_heights.each do |line_height|
+        base_line_height = line_height
         font_sizes_to_line_height = {}
 
-        (MIN_FONT_SIZE_PX .. line_height).each do |font_size|
+        # we will increment the line-height as soon as a resulting em-value
+        # falls underneath @min_line_height_em; to prevent large differences, we
+        # add half of our base line-height if possible
+        if line_height.even?
+          line_height_increment = line_height / 2
+        else
+          line_height_increment = line_height
+        end
+
+        # to offer a larger range of available font-sizes, we start from the
+        # smallest possible font-size and end at don't just end at the biggest
+        # supplied font-size
+        (MIN_FONT_SIZE_PX .. @font_sizes.last * 2).each do |font_size|
           line_height_em = EmValue.new(line_height / font_size.to_f)
-          font_sizes_to_line_height[font_size] = line_height_em if line_height_em.usable? && line_height_em >= @min_line_height_em
+
+          # increment line-height if we fall below the minimum value
+          if line_height_em < @min_line_height_em
+            line_height += line_height_increment
+            redo
+          end
+
+          # map font-size and line-height for this grid
+          if line_height_em.usable? && line_height_em >= @min_line_height_em
+            font_sizes_to_line_height[font_size] = line_height_em
+          end
         end
 
-        if font_sizes_to_line_height.keys.include_all?(@font_sizes)
-          vertical_grids << VerticalGrid.new(@font_sizes, line_height, font_sizes_to_line_height) unless font_sizes_to_line_height.empty?
+        # add grid to results
+        # TODO can font_sizes_to_line_height ever really be empty?
+        unless font_sizes_to_line_height.empty?
+          vertical_grid = VerticalGrid.new(@font_sizes, base_line_height,
+              font_sizes_to_line_height)
+          vertical_grids << vertical_grid
         end
       end
 
       vertical_grids
-
-      # line_heights = {}
-      # (fontsize .. fontsize * 2).each do |lineheight|
-      #   lineheight_ratio = EmValue.new(lineheight / fontsize.to_f)
-      #   line_heights[lineheight] = lineheight_ratio if lineheight_ratio.usable?
-      # end
     end
   end
 end

data/lib/cssensible/version.rb

@@ -1,4 +1,4 @@
 module CSSensible
   # The current version of CSSensible.
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

data/lib/cssensible/vertical_grid.rb

@@ -15,11 +15,26 @@ module CSSensible
     end
 
     def to_s
-      vertical_grid = "line-height: #{@line_height}px\n"
-      vertical_grid += "#{@font_sizes_to_line_height.size} font-size(s):\n"
+      vertical_grid = "line-height: #{@line_height}px"
+      vertical_grid += " (#{@font_sizes_to_line_height.size} font-sizes)\n"
+
+      vertical_grid += "\n"
+
+      vertical_grid += "font-size (px)".center(18)
+      vertical_grid += "|"
+      vertical_grid += "line-height (px)".center(20)
+      vertical_grid += "|"
+      vertical_grid += "line-height (em)".center(20)
+      vertical_grid += "\n"
+      vertical_grid += "------------------+--------------------+--------------------\n"
 
       @font_sizes_to_line_height.each do |font_size, line_height_em|
-        vertical_grid += "  font-size: #{font_size}px#{'*' if @base_font_sizes.include?(font_size)}\tline-height: #{line_height_em}em\n"
+        vertical_grid += "  #{font_size}#{'*' if @base_font_sizes.include?(font_size)}".ljust(18)
+        vertical_grid += "|"
+        vertical_grid += "  #{(font_size * line_height_em).to_i}".ljust(20)
+        vertical_grid += "|"
+        vertical_grid += "  #{line_height_em}".ljust(20)
+        vertical_grid += "\n"
       end
 
       vertical_grid

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 2
-  version: 0.2.2
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Dominik Habersack
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-20 00:00:00 +12:00
+date: 2010-07-27 00:00:00 +12:00
 default_executable: 
 dependencies: []