simple_selector 0.0.1

data/Changelog

@@ -0,0 +1,2 @@
+0.0.1 (February 26, 2012)
+  Initial release.

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Jacek Mikrut
+
+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,87 @@
+SimpleSelector
+==============
+
+SimpleSelector is a Ruby gem that **represents a CSS-like selector**, calculates its **specificity** and tells if it **matches** given HTML-like tags.
+
+Content
+-------
+
+The selector content can consist of **tag names**, **IDs** and **class names**. An example:
+
+```ruby
+  SimpleSelector.new("tag_a#id_a.class_a #id_b .class_c.class_d")
+```
+
+Specificity
+-----------
+
+#### Calculation rules
+
+The specificity of a selector is calculated according to rules similar to the standard CSS rules.
+
+The specificity is four numbers: **a,b,c,d**.
+
+**The rules respected by this gem are**:
+
+* **a** is always 0;
+* **b** is the number of ID attributes in the selector;
+* **c** is the number of class names in the selector;
+* **d** is the number of tag names in the selector.
+
+For example, a selector `tag#id1.class1 #id2.class2.class3` has specificity equal to `0,2,3,1`.
+
+```ruby
+  SimpleSelector.new("tag#id1.class1 #id2.class2.class3").specificity
+   => #<SimpleSelector::Specificity "0,2,3,1">
+```
+
+#### Comparison
+
+Specificity allows selector comparison.
+
+Two selector specificities are compared by succesively comparing their corresponding numbers, from left to right.
+
+Tag matching
+------------
+
+A SimpleSelector object tells if it matches given HTML-like tags.
+
+The tag is expected to be represented by an object which responds to :name, :id, :class_names and :parent messages. An example:
+
+```ruby
+  Tag = Struct.new(:name, :id, :class_names, :parent)
+
+  # Tag objects corresponding to the structure:
+  # <section id="content"><message class="success">...</message></section>
+  content_tag = Tag.new("section", "content", [], nil)
+  message_tag = Tag.new("message", nil, ["success"], content_tag)
+```
+
+And now:
+
+```ruby
+  SimpleSelector.new("section#content message.success").match?(message_tag)
+   => true
+```
+
+Installation
+------------
+
+As a Ruby gem, SimpleSelector can be installed either by running
+
+```bash
+  gem install simple_selector
+```
+
+or adding
+
+```ruby
+  gem "simple_selector"
+```
+
+to the Gemfile and then invoking `bundle install`.
+
+License
+-------
+
+License is included in the LICENSE file.

data/lib/simple_selector.rb

@@ -0,0 +1,66 @@
+require "simple_selector/version"
+
+require "simple_selector/specificity"
+require "simple_selector/segment"
+
+class SimpleSelector
+
+  def initialize(string=nil)
+    @segments = []
+    @specificity = Specificity.new
+    concat(string) unless string.nil?
+  end
+
+  attr_reader :specificity
+
+  def concat(string)
+    string.scan(/[\w.#]+/).map { |s| Segment.new(s) }.each do |segment|
+      @segments << segment
+      @specificity += segment.specificity
+    end
+    self
+  end
+
+  def +(string)
+    duplicate.concat(string)
+  end
+
+  def match?(tag)
+    return true  if @segments.none?
+    return false unless @segments.last.match?(tag)
+
+    index = @segments.size - 2
+    current_tag = tag
+
+    while index >= 0 && current_tag = current_tag.parent
+      if @segments[index].match?(current_tag)
+        index -= 1
+        next
+      end
+    end
+    index == -1
+  end
+
+  def empty?
+    @segments.none?
+  end
+
+  def to_s
+    @segments.map { |segment| segment.to_s }.join(" ")
+  end
+
+  def inspect
+    "#<#{self.class} #{to_s.inspect}>"
+  end
+
+  def ==(other)
+    to_s == other.to_s
+  end
+
+  def duplicate
+    d = dup
+    d.instance_variable_set(   "@segments",    @segments.dup)
+    d.instance_variable_set("@specificity", @specificity.dup)
+    d
+  end
+end

data/lib/simple_selector/segment.rb

@@ -0,0 +1,38 @@
+class SimpleSelector
+  class Segment
+
+    def initialize(string)
+      @tag_name    = string.lstrip.slice(/^\w+/)
+      @id          = string.slice(/(?<=\#)\w+/)
+      @class_names = string.scan(/(?<=\.)\w+/)
+    end
+
+    attr_reader :tag_name, :id, :class_names
+
+    def specificity
+      @specificity ||= Specificity.new(
+        0,
+        id ? 1 : 0,
+        class_names.count,
+        tag_name ? 1 : 0
+      )
+    end
+
+    def match?(tag)
+      return false if tag_name && tag_name != tag.name
+      return false if id       && id       != tag.id
+      return false if (class_names - tag.class_names).any?
+      true
+    end
+
+    def to_s
+      "#{tag_name}" +
+      (id ? "##{id}" : "") +
+      class_names.map { |class_name| ".#{class_name}" }.join
+    end
+
+    def inspect
+      "#<#{self.class} #{to_s.inspect}>"
+    end
+  end
+end

data/lib/simple_selector/specificity.rb

@@ -0,0 +1,32 @@
+class SimpleSelector
+  class Specificity
+
+    include Comparable
+
+    def initialize(a=0, b=0, c=0, d=0)
+      @a, @b, @c, @d = a, b, c, d
+    end
+
+    attr_accessor :a, :b, :c, :d
+
+    def <=>(other)
+      [:a, :b, :c, :d].each do |name|
+        result = send(name) <=> other.send(name)
+        return result unless result == 0
+      end
+      0
+    end
+
+    def +(other)
+      self.class.new(a + other.a, b + other.b, c + other.c, d + other.d)
+    end
+
+    def to_s
+      "#{a},#{b},#{c},#{d}"
+    end
+
+    def inspect
+      "#<#{self.class} #{to_s.inspect}>"
+    end
+  end
+end

data/lib/simple_selector/version.rb

@@ -0,0 +1,3 @@
+class SimpleSelector
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: simple_selector
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jacek Mikrut
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-26 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &76532010 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: *76532010
+description: Represents a CSS-like selector, calculates its specificity and tells
+  if it matches given HTML-like tags.
+email: jacekmikrut.software@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/simple_selector.rb
+- lib/simple_selector/specificity.rb
+- lib/simple_selector/version.rb
+- lib/simple_selector/segment.rb
+- README.md
+- LICENSE
+- Changelog
+homepage: http://github.com/jacekmikrut/simple_selector
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.12
+signing_key: 
+specification_version: 3
+summary: Represents a CSS-like selector, calculates its specificity and tells if it
+  matches given HTML-like tags.
+test_files: []