cssensible 0.2.0

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+## 0.2 (July 8th, 2010)
+
+* command line interface actually usable
+
+
+## 0.1 (July 7th, 2010)
+
+* initial release

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2010 Dominik Habersack
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,53 @@
+# CSSensible
+
+CSSensible finds sensible default values for `font-size` and `line-height` by identifying available vertical grids.
+
+
+## Usage
+
+You can find sensible vertical grids for one or several font-sizes.
+
+    $ ruby bin/cssensible [options] font-size [font-size font-size ...]
+
+Options:
+
+        --line-height-ratio [EM]    Minimum em-value all line-heights should have
+    -h, --help                      Shop help
+        --version                   Show version
+
+
+## Examples
+
+    # finds sensible grids including a font-size of 12px
+    $ ruby bin/cssensible 12
+
+    # finds sensible grids including both 12px and 16px
+    $ ruby bin/cssensible 12 16
+
+    # finds sensible grids including both 12px and 16px where the resulting
+    # line-height for every font-size is at least 1.3em
+    $ ruby bin/cssensible --line-height-ratio 1.3 12 16
+
+
+## Documentation
+
+View the HTML document:
+    $ open doc/index.html
+
+## Problems?
+
+Please open [an issue][issues].
+
+
+## Author
+
+* Dominik Habersack / <dhabersack@gmail.com>
+
+
+## License
+
+CSSensible is released under the [MIT License][license].
+
+
+[issues]: http://github.com/dhabersack/cssensible/issues
+[license]: http://github.com/dhabersack/cssensible/blob/master/LICENSE

data/Rakefile

@@ -0,0 +1,3 @@
+require 'rake'
+
+

data/bin/cssensible

@@ -0,0 +1,5 @@
+# require 'cssensible/runner'
+require_relative '../lib/cssensible/runner'
+
+runner = CSSensible::Runner.new(ARGV)
+runner.run

data/lib/cssensible.rb

@@ -0,0 +1,7 @@
+require 'cssensible/em_value'
+require 'cssensible/finder'
+require 'cssensible/options'
+require 'cssensible/ruby_extensions'
+require 'cssensible/runner'
+require 'cssensible/version'
+require 'cssensible/vertical_grid'

data/lib/cssensible/em_value.rb

@@ -0,0 +1,36 @@
+require_relative 'ruby_extensions'
+
+# Implements em-values used in Cascading Style Sheets.
+module CSSensible
+  class EmValue < Numeric
+    include Comparable
+
+    # The maximum number of decimal places allowed in an em-value.
+    MAX_DECIMAL_PLACES = 3
+
+    attr_reader :value
+
+    def <=>(other)
+      @value <=> other.value
+    end
+
+    # Returns a new em-value based on the value passed to new.
+    def initialize(value)
+      @value = value.to_f
+    end
+
+    # :call-seq:
+    #   usable? -> true or false
+    #
+    # Returns true if the em-value has no more decimal places than specified in
+    # MAX_DECIMAL_PLACES.
+    def usable?
+      # shift decimal point and check if no decimal places remain
+      @value.shift_decimal_point(MAX_DECIMAL_PLACES).decimal_places.zero?
+    end
+
+    def to_s
+      @value.to_s
+    end
+  end
+end

data/lib/cssensible/finder.rb

@@ -0,0 +1,68 @@
+require_relative 'em_value'
+require_relative 'vertical_grid'
+
+# Finds sensible vertical grids to use in Cascading Style Sheets.
+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)
+
+    # Size in pixel a font should at least be to be readable
+    MIN_FONT_SIZE_PX = 10
+
+    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)
+      @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
+    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
+
+        # 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)
+
+          unless line_height_em.usable?
+            line_height_usable = false
+            break
+          end
+        end
+
+        line_heights << line_height if line_height_usable
+      end
+
+      line_heights.each do |line_height|
+        font_sizes_to_line_height = {}
+
+        (MIN_FONT_SIZE_PX .. line_height).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
+        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?
+        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/options.rb

@@ -0,0 +1,62 @@
+require 'optparse'
+require_relative 'em_value'
+require_relative 'version'
+
+# Option parser.
+module CSSensible
+  class Options
+    # Default line-height.
+    DEFAULT_LINE_HEIGHT = EmValue.new(1.0)
+
+    attr_reader :font_sizes_to_include
+    attr_reader :line_height
+
+    def initialize(argv)
+      @font_sizes_to_include = []
+      @line_height = DEFAULT_LINE_HEIGHT
+      parse(argv)
+      argv.each { |arg| @font_sizes_to_include << arg.to_i }
+    end
+
+  private
+
+    def parse(argv)
+      OptionParser.new do |opts|
+        opts.banner = 'Usage: cssensible [options] font-size [font-size font-size ...]'
+
+        opts.separator ''
+        opts.separator 'Specific options:'
+
+        opts.on('-l', '--line-height [EM]', Float, 'Minimum em-value a all line-heights should have') do |l|
+          @line_height = l
+        end
+
+        # TODO implement this
+        # opts.on('-v', '--verbose', 'Run verbosely') do |v|
+        #   @verbose = v
+        # end
+
+        opts.separator ''
+        opts.separator 'Common options:'
+
+        opts.on_tail('-h', '--help', 'Show this message') do
+          puts opts
+          exit
+        end
+
+        opts.on_tail('--version', 'Show version') do
+          puts CSSensible::VERSION
+          exit
+        end
+
+        begin
+          argv = ['-h'] if argv.empty?
+          opts.parse!(argv)
+        rescue OptionParser::ParseError => e
+          STDERR.puts e.message, "\n", opts
+          exit(-1)
+        end
+      end
+    end
+  end
+end

data/lib/cssensible/ruby_extensions.rb

@@ -0,0 +1,44 @@
+# Extensions to built-in Ruby classes.
+class Array
+  # :call-seq:
+  #   include_all?(array) -> true or false
+  #
+  # Returns true if all elements of the given array is present in self, false
+  # otherwise.
+  #
+  #   a = ["a", "b", "c"]
+  #   a.include_all?(["a", "c"])            # => true
+  #   a.include_all?(["a", "b", "c", "d"])  # => false
+  def include_all?(array)
+    array.each do |element|
+      return false unless self.include?(element)
+    end
+    return true
+  end
+end
+
+# Extensions to built-in Ruby classes.
+class Float
+  # :call-seq:
+  #   decimal_places -> int or nil
+  #
+  # Returns all decimal places.
+  #
+  #   0.125.decimal_places  # => 125
+  #   0.0.decimal_places    # => 0
+  def decimal_places
+    self.to_s.split(".")[1].to_f
+  end
+
+  # :call-seq:
+  #   shift_decimal_point(decimal_places) -> a_float
+  #
+  # Returns a copy of self with the decimal point shifted _decimal_places_
+  # places to the right (left for negative numbers).
+  #
+  #   0.125.shift_decimal_point(3)    # => 125.0
+  #   0.125.shift_decimal_point(-3)   # => 0.000125
+  def shift_decimal_point(decimal_places)
+    self * (10 ** decimal_places)
+  end
+end

data/lib/cssensible/runner.rb

@@ -0,0 +1,21 @@
+require_relative 'finder'
+require_relative 'options'
+
+module CSSensible
+  class Runner
+    def initialize(argv)
+      @options = Options.new(argv)
+    end
+
+    def run
+      finder = Finder.new(@options.font_sizes_to_include, @options.line_height)
+      vertical_grids = finder.find
+
+      if vertical_grids
+        vertical_grids.each { |vertical_grid| puts "#{vertical_grid}\n" }
+      else
+        puts "No grids found."
+      end
+    end
+  end
+end

data/lib/cssensible/version.rb

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

data/lib/cssensible/vertical_grid.rb

@@ -0,0 +1,28 @@
+# Implements a vertical grid to use in Cascading Style Sheets.
+module CSSensible
+  class VerticalGrid
+    # Returns a new vertical grid.
+    def initialize(base_font_sizes, line_height, font_sizes_to_line_height)
+      @base_font_sizes = base_font_sizes
+      @line_height = line_height
+      @font_sizes_to_line_height = font_sizes_to_line_height
+    end
+
+    # Returns em-value to calculate 10px based on font_size or nil if the value
+    # is not usable (see EmValue.usable?)
+    def ten_pixel
+      ten_pixel.usable? ? ten_pixel : nil
+    end
+
+    def to_s
+      vertical_grid = "line-height: #{@line_height}px\n"
+      vertical_grid += "#{@font_sizes_to_line_height.size} font-size(s):\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"
+      end
+
+      vertical_grid
+    end
+  end
+end

data/test/test_em_value.rb

@@ -0,0 +1,32 @@
+require 'test/unit'
+require_relative '../lib/cssensible/em_value'
+
+class TestEmValue < Test::Unit::TestCase
+  # Test inclusion of 'Comparable'
+  def test_compare_values
+    assert 1, CSSensible::EmValue.new(1.5) > CSSensible::EmValue.new(1.0)
+  end
+
+  # Tests if em-values with up to three decimal places are considered _usable_.
+  def test_values_with_no_more_than_three_decimal_places_are_usable
+    assert CSSensible::EmValue.new(1).usable?
+    assert CSSensible::EmValue.new(1.5).usable?
+    assert CSSensible::EmValue.new(1.25).usable?
+    assert CSSensible::EmValue.new(1.025).usable?
+  end
+
+  # Tests if em-values with more than three decimal places are considered
+  # _unusable_.
+  def test_values_with_more_than_three_decimal_places_are_not_usable
+    assert !CSSensible::EmValue.new(1.0125).usable?
+    assert !CSSensible::EmValue.new(1.125675).usable?
+  end
+
+  # Tests if trailing zeros in decimal places impact if an em-value is
+  # considered _usable_.
+  def test_trailing_zeros_do_not_impact_usability
+    assert CSSensible::EmValue.new(1.0000).usable?
+    assert CSSensible::EmValue.new(1.1250000).usable?
+  end
+
+end

data/test/test_finder.rb

@@ -0,0 +1,17 @@
+require 'test/unit'
+require_relative '../lib/cssensible/finder'
+
+class TestFinder < Test::Unit::TestCase
+
+  # Test optional initialization parameter line_height.
+  # def test_initialize_optional_line_height_parameter
+  #   assert_nil VerticalGridFinder.new(12).line_height, 'initialize without line_height'
+  #   assert_equal 18, VerticalGridFinder.new(12, 18).line_height, 'initialize with line_height'
+  # end
+
+  # TODO test find-method
+  # def test_find_vertical_grids
+  #   vertical_grids = VerticalGridFinder.new(16).find
+  # end
+
+end

data/test/test_options.rb

@@ -0,0 +1,17 @@
+require 'optparse'
+require 'test/unit'
+require_relative '../lib/cssensible/options'
+
+class TestOptions < Test::Unit::TestCase
+
+  def test_specifying_a_line_height
+    opts = CSSensible::Options.new(['-l', "1.3"])
+    assert_equal 1.3, opts.line_height
+  end
+
+  def test_return_line_heights
+    opts = CSSensible::Options.new(["15", "16"])
+    assert_equal [15, 16], opts.font_sizes_to_include
+  end
+
+end

data/test/test_ruby_extensions.rb

@@ -0,0 +1,27 @@
+require 'test/unit'
+require_relative '../lib/cssensible/ruby_extensions'
+
+class TestRubyExtensions < Test::Unit::TestCase
+
+  # Tests the include_all? method.
+  # Seriously, what else am I supposed to write here?
+  def test_array_include_all
+    a = ["a", "b", "c"]
+    assert a.include_all?(["a", "b"])
+    assert !a.include_all?(["a", "b", "c", "d"])
+  end
+
+  # Tests extraction of decimal places from Floats.
+  def test_float_get_decimal_places
+    assert_equal 125, 0.125.decimal_places
+    assert_equal 0, 0.0.decimal_places
+    assert_equal 0, 1.0000.decimal_places
+  end
+
+  # Tests shifting the decimal point arount in Floats.
+  def test_float_shift_decimal_point_in_floats
+    assert_equal 125.0, 0.125.shift_decimal_point(3)
+    assert_equal 0.125, 125.0.shift_decimal_point(-3)
+  end
+
+end

data/test/test_vertical_grid.rb

@@ -0,0 +1,6 @@
+require 'test/unit'
+require_relative '../lib/cssensible/vertical_grid'
+
+class TestVerticalGrid < Test::Unit::TestCase
+
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: cssensible
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Dominik Habersack
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-13 00:00:00 +12:00
+default_executable: 
+dependencies: []
+
+description: CSSensible finds sensible CSS default values for font-size and line-height by identifying available vertical grids.
+email: dhabersack@gmail.com
+executables: 
+- cssensible
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/cssensible/em_value.rb
+- lib/cssensible/finder.rb
+- lib/cssensible/options.rb
+- lib/cssensible/ruby_extensions.rb
+- lib/cssensible/runner.rb
+- lib/cssensible/version.rb
+- lib/cssensible/vertical_grid.rb
+- lib/cssensible.rb
+- bin/cssensible
+- LICENSE
+- README.md
+- Rakefile
+- CHANGELOG.md
+- test/test_em_value.rb
+- test/test_finder.rb
+- test/test_options.rb
+- test/test_ruby_extensions.rb
+- test/test_vertical_grid.rb
+has_rdoc: true
+homepage: http://github.com/dhabersack/cssensible
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 29
+      segments: 
+      - 1
+      - 9
+      version: "1.9"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 21
+      segments: 
+      - 1
+      - 3
+      - 7
+      version: 1.3.7
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Find sensible CSS defaults.
+test_files: 
+- test/test_em_value.rb
+- test/test_finder.rb
+- test/test_options.rb
+- test/test_ruby_extensions.rb
+- test/test_vertical_grid.rb