tiny_css 0.0.2

data/README

@@ -0,0 +1,62 @@
+TinyCss
+=======
+
+a ruby module to read and write .css stylesheets
+
+
+Usage
+=====
+
+# In your .css file
+H1 { color: blue }
+H2 { color: red; font-family: Arial }
+.this, .that { color: yellow }
+
+# In your program
+require 'tiny_css'
+
+# Create a CSS stylesheet
+css = TinyCss.new
+
+# Open a CSS stylesheet
+css = css.read('style.css')
+
+# Reading properties
+# (key is coverted to string, so you can access same value by symbol)
+header_color = css.style['h1']['color']
+css.style['h2'].each { |property, value| p "#{ property }: #{ value }" }
+this_color = css.style[:this][:color]
+that_color = css.style[:that][:color]
+
+# Changing styles and properties
+css.style['.newstyle']['color'] = '#FFFFFF'  # Add a style
+css.style['h1']['color'] = 'black'           # Change a property
+css.style['h2'].delete                       # Delete a style
+
+# Save a CSS stylesheet
+css.write 'style.css'         # Sort selectors and properties
+css.write 'style.css', false  # Don't sort
+
+
+Install
+=======
+
+git clone git://github.com/milk1000cc/tiny_css.git
+
+or
+
+sudo gem install tiny_css
+
+
+Caution
+=======
+
+TinyCss#style doesn't return Hash object but TinyCss::OrderedHash, and TinyCss::OrderedHash class doesn't inherit Hash object.
+
+I'm Japanese, and I'm not goot at English and Ruby, so please see the source code and edit them.
+
+
+Author
+======
+
+milk1000cc <info@milk1000.cc>

data/lib/tiny_css.rb

@@ -0,0 +1,10 @@
+Dir.glob(File.join(File.dirname(__FILE__), 'tiny_css/**/*.rb')).sort.
+  each { |lib| require lib }
+
+module TinyCss
+  class Error < StandardError; end
+
+  def self.new
+    TinyCss::Base.new
+  end
+end

data/lib/tiny_css/base.rb

@@ -0,0 +1,75 @@
+module TinyCss
+  class Base
+    attr_accessor :style
+
+    def initialize
+      @style = OrderedHash.new
+    end
+
+    def read(file)
+      read_string open(file).read
+    end
+
+    def read_string(string)
+      string = string.tr("\n\t", '  ').gsub(%r!/\*.*?\*/!, '')
+
+      split_by_closing_brace(string).reject { |v| v !~ /\S/ }.each do |v|
+        unless match = v.match(/^\s*([^{]+?)\s*\{(.*)\}\s*$/)
+          raise Error, "Invalid or unexpected style data '#{ v }'"
+        end
+
+        style = match.captures.first
+        styles = style.gsub(/\s+/, ' ').split(/\s*,\s*/).
+          reject { |v| v !~ /\S/ }
+
+        match.captures.last.split(/\;/).reject { |v| v !~ /\S/ }.each do |v|
+          unless match = v.match(/^\s*([\w._-]+)\s*:\s*(.*?)\s*$/)
+            raise Error, "unexpected property '#{ v }' in style '#{ style }'"
+          end
+          styles.each do |v|
+            @style[v][match.captures.first.downcase] = match.captures.last
+          end
+        end
+      end
+
+      self
+    end
+
+    def write(file, sort = true)
+      open(file, 'w').write write_string(sort)
+    end
+
+    def write_string(sort = true)
+      style = @style.dup
+      contents = ''
+      selectors = style.keys
+      selectors.sort!.reverse! if sort
+      selectors.each do |selector|
+        contents += "#{ selector } {\n"
+        keys = style[selector].keys
+        keys.sort! if sort
+        keys.each { |k| contents += "\t#{ k }: #{ @style[selector][k] };\n" }
+        contents += "}\n"
+      end
+
+      contents
+    end
+
+    private
+    def split_by_closing_brace(string)
+      pattern = /(.+?\})/
+      ary = []
+
+      if string =~ pattern
+        string.gsub(pattern) { |matched| ary << matched }
+        if match = string.match(/.+\}(.+)$/)
+          ary << match.captures.first
+        end
+      else
+        ary << string
+      end
+
+      ary
+    end
+  end
+end

data/lib/tiny_css/ordered_hash.rb

@@ -0,0 +1,48 @@
+module TinyCss
+  class OrderedHash
+    include Enumerable
+
+    attr_accessor :keys
+
+    def initialize
+      self.keys = []
+      @hash = Hash.new { |h, k|
+        self.keys << k.to_s
+        h[k] = OrderedHash.new
+      }
+    end
+
+    def [](key)
+      @hash[key.to_s]
+    end
+
+    def []=(key, value)
+      key = key.to_s
+      @hash[key] = value
+      self.keys << key unless self.keys.include?(key)
+    end
+
+    def delete(key, &block)
+      key = key.to_s
+      self.keys.delete key
+      @hash.delete key, &block
+    end
+
+    def dup
+      dup = super
+      dup.keys = self.keys.dup
+      dup
+    end
+
+    def each(&block)
+      self.keys.each { |k| yield [k, self[k]] }
+      self
+    end
+
+    def inspect
+      ary = []
+      each { |k, v| ary << "#{ k.inspect }=>#{ v.inspect }" }
+      "{#{ ary.join(', ') }}"
+    end
+  end
+end

data/spec/base_spec.rb

@@ -0,0 +1,220 @@
+require File.dirname(__FILE__) + '/../lib/tiny_css'
+include TinyCss
+
+describe Base, '削除に関して' do
+  before do
+    @css = TinyCss.new.read_string('h1, p { color: red; background: blue; }')
+  end
+
+  it 'セレクタを削除したら、style.keys にそのセレクタが含まれていないこと' do
+    @css.style.keys.should include('h1')
+    @css.style.delete 'h1'
+    @css.style.keys.should_not include('h1')
+  end
+
+  it 'セレクタを削除したら、write_string の結果にもそのセレクタが含まれていないこと' do
+    @css.style.delete 'h1'
+    @css.write_string.should == "p {\n\tbackground: blue;\n\tcolor: red;\n}\n"
+  end
+
+  it 'プロパティを削除したら、style[セレクタ].keys にそのプロパティが' +
+    '含まれていないこと' do
+    @css.style['h1'].keys.should include('color')
+    @css.style['h1'].delete 'color'
+    @css.style['h1'].keys.should_not include('color')
+  end
+
+  it 'プロパティを削除したら、write_string の結果にも反映されていること' do
+    @css.style['h1'].delete 'color'
+    @css.write_string.should == "p {\n\tbackground: blue;\n\tcolor: red;\n}\n" +
+      "h1 {\n\tbackground: blue;\n}\n"
+  end
+end
+
+describe Base, 'CSS 文字列を指定してパースするとき' do
+  before do
+    @css1 = TinyCss.new.read_string('h3 { color: red; }')
+    @css2 = TinyCss.new.read_string('h1, p { color: red }')
+    @css3 = TinyCss.new.read_string("h3 { color: red; \n /*z-index: 4;*/\n" +
+                                    "background: blue }")
+    @css4 = TinyCss.new.read_string('h3,   div   .foo { color: red; ' +
+                                    'background: blue },div{color:red;}')
+    @selectors2 = ['h1', 'p']
+  end
+
+  it 'は、self を返すこと' do
+    @css1.should be_instance_of(Base)
+    @css2.should be_instance_of(Base)
+    @css3.should be_instance_of(Base)
+    @css4.should be_instance_of(Base)
+  end
+
+  it 'は、style[セレクタ][プロパティ] で値が取り出せること' do
+    @css1.style['h3']['color'].should == 'red'
+    @css2.style['h1']['color'].should == 'red'
+    @css2.style['p']['color'].should == 'red'
+    @css3.style['h3']['color'].should == 'red'
+    @css3.style['h3']['background'].should == 'blue'
+    @css4.style['h3']['color'].should == 'red'
+    @css4.style['h3']['background'].should == 'blue'
+    @css4.style['div']['color'].should == 'red'
+  end
+
+  it 'は、セレクタ文字列中のホワイトスペースが半角 1 スペースに変換されていること' do
+    @css4.style['div .foo']['color'].should == 'red'
+    @css4.style['div .foo']['background'].should == 'blue'
+  end
+
+  it 'は、コメント内のスタイルが反映されていないこと' do
+    @css3.style['h3']['z-index'].should_not == '4'
+  end
+
+  it 'は、style.keys で順番にセレクタが得られること' do
+    @css2.style.keys.should == @selectors2
+  end
+
+  it 'は、style[セレクタ].keys で順番にプロパティが得られること' do
+    @css4.style['div .foo'].keys.should == ['color', 'background']
+  end
+end
+
+describe Base, '} で終わらない CSS 文字列を指定してパースするとき' do
+  before do
+    @proc1 = Proc.new { TinyCss.new.read_string('h3 { color: red;') }
+    @proc2 = Proc.new {
+      TinyCss.new.read_string('h1, p { color: red }, f')
+    }
+    @proc3 = Proc.new {
+      TinyCss.new.read_string('h1, p { color: red }, div { margin: 0')
+    }
+  end
+
+  it 'は、例外 TinyCss::Error が発生すること' do
+    msg = "Invalid or unexpected style data 'h3 { color: red;'"
+    @proc1.should raise_error(Error, msg)
+    msg = "Invalid or unexpected style data ', f'"
+    @proc2.should raise_error(Error, msg)
+    msg = "Invalid or unexpected style data ', div { margin: 0'"
+    @proc3.should raise_error(Error, msg)
+  end
+end
+
+describe Base, 'セレクタの後 { で始まらない CSS 文字列を指定してパースするとき' do
+  before do
+    @proc1 = Proc.new { TinyCss.new.read_string('h3 color: red; }') }
+    @proc2 = Proc.new {
+      TinyCss.new.read_string('h1, p { color: red }, div }')
+    }
+  end
+
+  it 'は、例外 TinyCss::Error が発生すること' do
+    msg = "Invalid or unexpected style data 'h3 color: red; }'"
+    @proc1.should raise_error(Error, msg)
+
+    msg = "Invalid or unexpected style data ', div }'"
+    @proc2.should raise_error(Error, msg)
+  end
+end
+
+describe Base, 'プロパティと値が : で区切られていないとき' do
+  before do
+    @proc = Proc.new { TinyCss.new.read_string('h3 { color }') }
+  end
+
+  it 'は、例外 TinyCss::Error が発生すること' do
+    msg = "unexpected property ' color ' in style 'h3'"
+    @proc.should raise_error(Error, msg)
+  end
+end
+
+describe Base do
+  before do
+    @css = TinyCss.new.read(File.join(File.dirname(__FILE__), 'style.css'))
+    @selectors = ['div', 'h1', 'h2', 'div#test', 'div.foo ul', 'p#hoge',
+                  '.bar div']
+  end
+
+  describe Base, 'CSS ファイルを指定してパースするとき' do
+    it 'は、self を返すこと' do
+      @css.should be_instance_of(Base)
+    end
+
+    it 'は、style[セレクタ][プロパティ] で値が取り出せること' do
+      @css.style['div']['padding'].should == '0'
+      @css.style['div']['margin'].should == '0'
+      @css.style['h1']['padding'].should == '0'
+      @css.style['h1']['margin'].should == '0'
+      @css.style['h2']['padding'].should == '0'
+      @css.style['h2']['margin'].should == '0'
+      @css.style['div#test']['border'].should == '1px solid black'
+      @css.style['div#test']['padding'].should == '1px'
+      @css.style['div#test']['padding-left'].should == '3px'
+      @css.style['p#hoge']['color'].should == 'red'
+      @css.style['p#hoge']['background'].should == '#ff0000'
+    end
+
+    it 'は、セレクタ文字列中のホワイトスペースが半角 1 スペースに変換されていること' do
+      @css.style['div.foo ul']['list-style-type'].should == 'circle'
+      @css.style['div.foo ul']['text-decoration'].should == 'underline'
+    end
+
+    it 'は、コメント内のスタイルが反映されていないこと' do
+      @css.style['p#hoge']['font-size'].should_not == 'big'
+    end
+
+    it 'は、style.keys で順番にセレクタが得られること' do
+      @css.style.keys.should == @selectors
+    end
+
+    it 'は、style[セレクタ].keys で順番にプロパティが得られること' do
+      @css.style['.bar div'].keys.should == ['color', 'z-index', 'background']
+    end
+
+    it 'は、style.each で順番にセレクタとスタイルが得られること' do
+      selectors, styles = [], []
+      @css.style.each do |selector, style|
+        selectors << selector
+        styles << style
+      end
+      selectors.should == @selectors
+
+      properties, values = [], []
+      styles[3].each do |property, value|
+        properties << property
+        values << value
+      end
+      properties.should == ['border', 'padding', 'padding-left']
+      values.should == ['1px solid black', '1px', '3px']
+    end
+  end
+
+  describe Base, 'CSS 文字列を取得するとき' do
+    before do
+      @css.style['p#added']['background'] = 'yellow'
+      @result = @css.write_string
+    end
+
+    it 'は、ソート(セレクタは逆ソート)されて整形されていること' do
+      @result.should == "p#hoge {\n\tbackground: #ff0000;\n\tcolor: red;\n" +
+        "\tz-index: 3;\n}\np#added {\n\tbackground: yellow;\n}\nh2 {\n\t" +
+        "margin: 0;\n\tpadding: 0;\n}\nh1 {\n\tmargin: 0;\n\tpadding: 0;\n" +
+        "}\ndiv.foo ul {\n\tlist-style-type: circle;\n\ttext-decoration: " +
+        "underline;\n}\ndiv#test {\n\tborder: 1px solid black;\n\tpadding: " +
+        "1px;\n\tpadding-left: 3px;\n}\ndiv {\n\tmargin: 0;\n\tpadding: 0;\n" +
+        "}\n.bar div {\n\tbackground: #ff0000;\n\tcolor: red;\n\tz-index: " +
+        "3;\n}\n"
+    end
+
+    it 'は、write_string で 第 1 引数に false を指定するとソートされないこと' do
+      result = @css.write_string(false)
+      result.should == "div {\n\tmargin: 0;\n\tpadding: 0;\n}\nh1 {\n\t" +
+        "margin: 0;\n\tpadding: 0;\n}\nh2 {\n\tmargin: 0;\n\tpadding: 0;\n}" +
+        "\ndiv#test {\n\tborder: 1px solid black;\n\tpadding: 1px;\n\t" +
+        "padding-left: 3px;\n}\ndiv.foo ul {\n\tlist-style-type: circle;\n" +
+        "\ttext-decoration: underline;\n}\np#hoge {\n\tbackground: #ff0000;\n" +
+        "\tcolor: red;\n\tz-index: 3;\n}\n.bar div {\n\tbackground: #ff0000;" +
+        "\n\tcolor: red;\n\tz-index: 3;\n}\np#added {\n\tbackground: yellow;" +
+        "\n}\n"
+    end
+  end
+end

data/spec/ordered_hash_spec.rb

@@ -0,0 +1,187 @@
+require File.dirname(__FILE__) + '/../lib/tiny_css'
+include TinyCss
+
+describe OrderedHash, '未定義のキーが指定されたとき' do
+  before do
+    @oh = OrderedHash.new
+  end
+
+  it 'は、OrderedHash のインスタンスが得られること' do
+    @oh[:a].should be_instance_of(OrderedHash)
+
+  end
+
+  it 'は、keys に そのキーが文字列で追加されること' do
+    @oh[:a][:b] = 3
+    @oh.keys.last.should == 'a'
+  end
+end
+
+describe OrderedHash, '代入・参照操作について' do
+  before do
+    @oh1, @oh2 = OrderedHash.new, OrderedHash.new
+    @oh1[:a] = 3
+    @oh2['b'] = 4
+  end
+
+  it 'は、キーから値が取り出せること' do
+    @oh1[:a].should == 3
+    @oh2['b'].should == 4
+  end
+
+  it 'は、キーがシンボルでも文字列でも同じ値を指すこと' do
+    @oh1[:a.to_s].should == @oh1[:a]
+    @oh2['b'.to_sym].should == @oh2['b']
+  end
+
+  it 'は、キーが文字列に変換されていること' do
+    @oh1.keys.should_not include(:a)
+    @oh1.keys.should include('a')
+    @oh2.keys.should_not include(:b)
+    @oh2.keys.should include('b')
+  end
+
+  it 'は、きちんと上書き処理がされること' do
+    @oh1['a'] = 4
+    @oh1['a'].should == 4
+  end
+end
+
+describe OrderedHash, '#dup について' do
+  before do
+    @oh = OrderedHash.new
+    @dup = @oh.dup
+  end
+
+  it 'は、self と 戻り値 の object_id が相違なること' do
+    @oh.object_id.should_not == @dup.object_id
+  end
+
+  it 'は、self.keys と 戻り値.keys の object_id が相違なること' do
+    @oh.keys.object_id.should_not == @dup.keys.object_id
+  end
+end
+
+describe OrderedHash, '#delete について' do
+  before(:each) do
+    @oh = OrderedHash.new
+    @oh['foo'] = 3
+  end
+
+  it '存在するキーに対する関連を取り除いた場合は、取り除かれた値を返すこと' do
+    result = @oh.delete('foo')
+    result.should == 3
+  end
+
+  it '存在するキーに対する関連を取り除いた場合は、取り除かれた値を返すこと' +
+    '(シンボルでキーを指定した場合も)' do
+    result = @oh.delete(:foo)
+    result.should == 3
+  end
+
+  it '存在するキーに対する関連を取り除いた場合は、keys からそのキーがなくなっていること' do
+    @oh.keys.should include('foo')
+    @oh.delete 'foo'
+    @oh.keys.should_not include('foo')
+  end
+
+  it '存在するキーに対する関連を取り除いた場合は、keys からそのキーがなくなっていること' +
+    '(シンボルでキーを指定した場合も)' do
+    @oh.keys.should include('foo')
+    @oh.delete :foo
+    @oh.keys.should_not include('foo')
+  end
+
+  it '存在しないキーを指定された場合は、nil が返ること' do
+    result = @oh.delete('none')
+    result.should == nil
+
+    result = @oh.delete(:none)
+    result.should be_nil
+  end
+
+  it 'ブロックが与えられたときは、key にマッチするものがなかった時に評価して、' +
+    'その結果を返すこと' do
+    result = @oh.delete('foo') { |key| key + 'no' }
+    result.should == 3
+
+    result = @oh.delete('none') { |key| key + 'no' }
+    result.should == 'noneno'
+  end
+
+  it 'ブロックが与えられて、シンボルの key が与えられたときは' +
+    'key にマッチするものがなかった時にブロックを評価して、その結果を返すこと ' +
+    '(ブロックには文字列のキーが渡される)' do
+    result = @oh.delete(:foo) { |key| key + 'no' }
+    result.should == 3
+
+    result = @oh.delete(:none) { |key| key + 'no' }
+    result.should == 'noneno'
+  end
+end
+
+describe OrderedHash, '#each について' do
+  before do
+    @oh1, @oh2 = OrderedHash.new, OrderedHash.new
+    @keys1, @keys2 = [], []
+    @values1, @values2 = [], []
+
+    @oh1['1'] = 'one'
+    @oh1['2'] = 'two'
+    @oh1['3'] = 'three'
+    @oh2['2'] = 'two'
+    @oh2['1'] = 'one'
+    @oh2['3'] = 'three'
+
+    @result1 = @oh1.each { |k, v|
+      @keys1 << k
+      @values1 << v
+    }
+
+    @result2 = @oh2.each { |k, v|
+      @keys2 << k
+      @values2 << v
+    }
+  end
+
+  it 'は、代入順に要素が処理されること' do
+    @keys1.should == ['1', '2', '3']
+    @keys2.should == ['2', '1', '3']
+    @values1.should == ['one', 'two', 'three']
+    @values2.should == ['two', 'one', 'three']
+  end
+
+  it 'は、self を返すこと' do
+    @result1.should == @oh1
+    @result2.should == @oh2
+  end
+end
+
+describe OrderedHash, '#inspect について' do
+  before do
+    oh1, oh2 = OrderedHash.new, OrderedHash.new
+    oh1['1'] = 'one'
+    oh1['2'] = 'two'
+    oh1['3'] = 'three'
+    oh2['2'] = 'two'
+    oh2['1'] = 'one'
+    oh2['3'] = 'three'
+    @inspect1, @inspect2 = oh1.inspect, oh2.inspect
+  end
+
+  it 'は、{#{k.inspect}=>#{v.inspect}, ...} を返すこと' do
+    @inspect1.should ==
+      '{' +
+      "#{ '1'.inspect }=>#{ 'one'.inspect }, " +
+      "#{ '2'.inspect }=>#{ 'two'.inspect }, " +
+      "#{ '3'.inspect }=>#{ 'three'.inspect }" +
+      '}'
+    @inspect2.should ==
+      '{' +
+      "#{ '2'.inspect }=>#{ 'two'.inspect }, " +
+      "#{ '1'.inspect }=>#{ 'one'.inspect }, " +
+      "#{ '3'.inspect }=>#{ 'three'.inspect }" +
+      '}'
+  end
+end
+

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format progress
+--loadby mtime
+--reverse

data/spec/style.css

@@ -0,0 +1,19 @@
+div, h1, h2 {
+    padding: 0; margin: 0;
+}
+div#test {
+    border: 1px solid black;
+      padding: 1px;
+    padding-left: 3px;
+}
+div.foo         ul   {
+       list-style-type: circle;
+    text-decoration: underline;
+    }
+p#hoge,    .bar  div
+{
+    color: red;
+       /* font-size: big; */
+    z-index: 3      ;
+  background: #ff0000;
+}

data/tiny_css.gemspec

@@ -0,0 +1,12 @@
+Gem::Specification.new do |s|
+  s.name = "tiny_css"
+  s.version = "0.0.2"
+  s.date = "2008-07-10"
+  s.summary = ""
+  s.email = "info@milk1000.cc"
+  s.homepage = "http://github.com/milk1000cc/tiny_css"
+  s.description = ""
+  s.has_rdoc = false
+  s.authors = ["milk1000cc"]
+  s.files = ["README", "lib/tiny_css.rb", "lib/tiny_css/base.rb", "lib/tiny_css/ordered_hash.rb", "spec/base_spec.rb", "spec/ordered_hash_spec.rb", "spec/spec.opts", "spec/style.css", "tiny_css.gemspec"]
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: tiny_css
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- milk1000cc
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-07-10 00:00:00 +09:00
+default_executable: 
+dependencies: []
+
+description: ""
+email: info@milk1000.cc
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- lib/tiny_css.rb
+- lib/tiny_css/base.rb
+- lib/tiny_css/ordered_hash.rb
+- spec/base_spec.rb
+- spec/ordered_hash_spec.rb
+- spec/spec.opts
+- spec/style.css
+- tiny_css.gemspec
+has_rdoc: true
+homepage: http://github.com/milk1000cc/tiny_css
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: ""
+test_files: []
+