RubyGems - azebiki - Versions diffs - 0.0.1 - Mend

azebiki 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (8) hide show

data/CHANGELOG.md ADDED

File without changes

data/LICENSE ADDED

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Eric Allam
+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 ADDED

@@ -0,0 +1,75 @@
+## Overview
+Azebiki provides a simple dsl for declaring CSS and XPATH matchers against a block of HTML content.  It is built on top of Webrat matchers and nokogiri.
+## Example:
+Given this block of HTML:
+    <html>
+    <head><title>Example</title></head>
+    <body>
+    <!--
+    <a href="http://incomment.com">In Comment</a>
+    -->
+    <div id='main' class="big">
+      <p id="body">
+        <table class='short table'>
+          <thead>
+            <tr>
+              <th>First Column</th>
+            </tr>
+          </thead>
+        </table>
+      </p>
+    </div>
+Given this Azebiki::Checker definition:
+    c = Azebiki::Checker.new(HTML) do
+      div('#main.big') do
+        p('#body') do
+          table do
+            thead do
+              tr do
+                th(:content => 'First Column')
+              end
+            end
+          end
+        end
+      end
+    end
+Will result in:
+    c.success?
+    # => true
+Or given this definition:
+    c = Azebiki::Checker.new(HTML) do
+      a(:href => 'http://incomment.com', :content => 'In Comment')
+    end
+Will result in:
+    c.success?
+    # => false
+    c.errors.inspect
+    # => ['Content should have included <a href="http://incomment.com">In Comment</a>, but did not']
+Or give it a custom error message:
+    c = Azebiki::Checker.new(HTML) do
+      a(:href => 'http://incomment.com', :content => 'In Comment').failure_message('No tag :tag, SORRY!')
+    end
+    c.errors.inspect
+    # => ['No tag <a href="http://incomment.com">In Comment</a>, SORRY!']
+## Install
+gem install azebiki

data/ROADMAP.md ADDED

File without changes

data/lib/azebiki.rb ADDED

	@@ -0,0 +1 @@
1	+ require "azebiki/azebiki"

data/lib/azebiki/azebiki.rb ADDED

@@ -0,0 +1,234 @@
+require 'webrat/core/matchers/have_selector'
+require 'webrat/core/matchers/have_content'
+require 'nokogiri'
+# This class is useful for making sure an HTML text has certain tags/content
+# It supports both XML and HTML.  For example, if you want to make sure someone has included
+# a link that points to google, has no follow, with the text 'Google Sucks!':
+# c = Checker.new(html) do |v|
+#   v.matches('a', :href => "http://google.com", :rel => "nofollow", :content => "Google Sucks!")
+# end
+#
+# c.success? == true # if html does include the link to google
+# c.errors == [] # errors is a list of error messages for each match that did not succeed, which can be customized:
+#
+# c = Checker.new(html) do |v|
+#   v.matches('a', :href => "http://google.com", :rel => "nofollow", :content => "Google Sucks!").failure_message('Sorry, no google link, should have :tag')
+# end
+#
+# c.errors
+#=> ["Sorry, no google link, should have <a href='http://google.com' rel='nofollow'>Google Sucks!</a>"]
+#
+# You can also nest matches, to match against children content.  For example, if you
+# want check for an image link:
+#
+# c = Checker.new(html) do |v|
+#   v.matches('a', :href => "http://google.com", :rel => "nofollow", :content => "Google Sucks!") do |a|
+#     a.matches('img', :src => 'http://google.com/sucks.png')
+#   end
+# end
+#
+# which will succeed only if the img tag is nested below the a tag.  You can nest matchers pretty deep
+module Azebiki
+  class Checker
+    class MyHaveSelector < Webrat::Matchers::HaveSelector
+      def add_attributes_conditions_to(query)
+        attribute_conditions = []
+        @options.each do |key, value|
+          next if [:content, :count].include?(key)
+          if value.is_a?(Hash)
+            func, match = value.keys.first, value.values.first
+            attribute_conditions << "#{func}(@#{key}, #{xpath_escape(match)})"
+          else
+            attribute_conditions << "@#{key} = #{xpath_escape(value)}"
+          end
+        end
+        if attribute_conditions.any?
+          query << "[#{attribute_conditions.join(' and ')}]"
+        end
+      end
+      def matches?(stringlike, &block)
+        @block ||= block
+        matched = matches(stringlike)
+        if @options[:count]
+          matched.size == @options[:count] && (!@block || @block.call(matched))
+        else
+          matched.any? && (!@block || @block.call(matched))
+        end
+      end
+    end
+    class MatcherProxy
+      def initialize(have_matcher)
+        @have_matcher = have_matcher
+        @failure_message = "Content should have included #{content_message}, but did not"
+      end
+      def failure_message(new_failure_message)
+        @failure_message = new_failure_message.gsub(/:tag/, content_message)
+      end
+      def content_message
+        if @have_matcher.respond_to?(:tag_inspect)
+          @have_matcher.tag_inspect
+        else
+          @have_matcher.content_message
+        end
+      end
+      def matches?(content)
+        @have_matcher.matches?(content)
+      end
+      def message
+        @failure_message
+      end
+    end
+    class MatcherBuilder < BasicObject
+      attr_reader :tags, :contents, :failure_message
+      def initialize(&block)
+        @tags = []
+        @contents = []
+        instance_eval &block
+      end
+      def has_content(text)
+        @contents << text
+      end
+      def method_missing(method, *args, &block)
+        tag = {:tag_name => method.to_s}
+        if args.first.is_a?(::String)
+          id_or_class = args.first
+          if id_or_class.split('#').size == 2
+            id_and_classes = id_or_class.split('#').last
+            id_and_classes = id_and_classes.split('.')
+            tag[:id] = id_and_classes.shift
+            tag[:class] = id_and_classes
+          end
+        elsif args.first.is_a?(::Hash)
+          tag.merge!(args.first)
+        end
+        if args[1] && args[1].is_a?(::Hash)
+          if classes = args[1][:class]
+            tag[:class] ||= []
+            classes.split('.').reject {|s| s.empty? }.each do |s|
+              tag[:class] << s
+            end
+            tag[:class].uniq!
+          end
+          tag.merge!(args[1])
+        end
+        if tag[:class]
+          tag[:class] = tag[:class].join(' ')
+          tag.delete(:class) if tag[:class].strip.empty?
+        end
+        tag[:child] = block
+        @tags << tag
+        def tag.failure_message(text)
+          self[:failure_message] = text
+        end
+        return tag
+      end
+    end
+    attr_accessor :content, :have_matchers, :errors
+    def initialize(content, &block)
+      @content = content
+      @errors = []
+      @have_matchers = []
+      @self_before_instance_eval = eval "self", block.binding
+      @matcher_builder = MatcherBuilder.new(&block)
+      build_contents
+      build_matchers
+      run_matchers
+    end
+    def contains(matching_text)
+      selector = MatcherProxy.new(Webrat::Matchers::HasContent.new(matching_text))
+      @have_matchers << selector
+      selector
+    end
+    def matches(name, attributes = {}, &block)
+      if block_given?
+        have = MyHaveSelector.new(name, attributes) do |n|
+          Azebiki::Checker.new(n, &block).success?
+        end
+        selector = MatcherProxy.new(have)
+      else
+        selector = MatcherProxy.new(MyHaveSelector.new(name, attributes))
+      end
+      @have_matchers << selector
+      selector
+    end
+    def success?
+      @success
+    end
+    private
+    def build_contents
+      @matcher_builder.contents.each do |s|
+        contains s
+      end
+    end
+    def method_missing(method, *args, &block)
+      @self_before_instance_eval.send method, *args, &block
+    end
+    def build_matchers
+      @matcher_builder.tags.each do |tag|
+        name = tag.delete(:tag_name)
+        b = tag.delete(:child)
+        attributes = tag
+        selector = matches(name, attributes, &b)
+        if tag[:failure_message]
+          selector.failure_message(tag[:failure_message])
+        end
+      end
+    end
+    def run_matchers
+      return true if @have_matchers.empty?
+      @have_matchers.each do |selector|
+        if !selector.matches?(@content)
+          @errors << selector.message
+        end
+      end
+      @success = @errors.empty?
+    end
+  end
+end

data/lib/azebiki/version.rb ADDED

@@ -0,0 +1,3 @@
+module Azebiki
+  VERSION = "0.0.1"
+end

metadata ADDED

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: azebiki
+version: !ruby/object:Gem::Version
+  prerelease: false
+  segments:
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors:
+- Eric Allam
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2010-06-20 00:00:00 -04:00
+default_executable:
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: webrat
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        segments:
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: ""
+email:
+- eric@envylabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/azebiki/azebiki.rb
+- lib/azebiki/version.rb
+- lib/azebiki.rb
+- LICENSE
+- CHANGELOG.md
+- README.md
+- ROADMAP.md
+has_rdoc: true
+homepage: http://github.com/rubymaverick/azebiki
+licenses: []
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      segments:
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+rubyforge_project: azebiki
+rubygems_version: 1.3.7
+signing_key:
+specification_version: 3
+summary: A DSL for validating HTML
+test_files: []