fluentxpath 0.1.0

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2010-04-04
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,11 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+lib/fluentxpath.rb
+script/console
+script/destroy
+script/generate
+test/test_fluentxpath.rb
+test/test_helper.rb

data/PostInstall.txt

@@ -0,0 +1,7 @@
+
+For more information on fluentxpath, see http://fluentxpath.rubyforge.org
+
+NOTE: Change this information in PostInstall.txt 
+You can also delete it if you don't want it.
+
+

data/README.rdoc

@@ -0,0 +1,63 @@
+= fluentxpath
+
+* http://github.com/douglassquirrel/fluentxpath
+
+== DESCRIPTION:
+
+With the fluentxpath Ruby gem, you build your xpath query in a language that is nearly English and very readable.
+
+== FEATURES/PROBLEMS:
+
+* Navigate to root element or arbitrary element
+* Navigate to children and descendants
+* Specify tag name and attribute values
+* Everything else is missing!
+
+== SYNOPSIS:
+
+  require 'fluentxpath'
+  xpath = Fluentxpath::XPath
+  xpath.that_navigates { to_root_element.with_name("library") }     # "/library"
+  xpath.that_navigates { to_any_element.with_name("book") }         # "//book"
+  xpath.that_navigates { to_root_element.with_name "library"
+                         and_then.to_children.with_name "subject" 
+                         and_then.to_children.with_name "shelf" }   # "/library/subject/shelf"
+  xpath.that_navigates { to_root_element.with_name "library"
+                         and_then.to_descendants.with_name "book" } # "/library//book"
+  xpath.that_navigates { to_any_element.with_name("book")
+                                        and_attributes("title"  => "The Conquest of Bread", 
+                                                       "author" => "Kropotkin") }  # "//book[@author='Kropotkin' and @title='The Conquest of Bread']"
+  # See /test for many more
+
+== REQUIREMENTS:
+
+* None, though you will want something that can use your xpath expression (like Nokogiri)
+
+== INSTALL:
+
+* sudo gem install fluentxpath
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010 Douglas Squirrel
+
+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/Rakefile

@@ -0,0 +1,16 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/fluentxpath'
+
+Hoe.plugin :newgem
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'fluentxpath' do
+  self.developer 'Douglas Squirrel', 'ds@douglassquirrel.com'
+  self.rubyforge_name       = self.name 
+end
+
+require 'newgem/tasks'

data/lib/fluentxpath.rb

@@ -0,0 +1,76 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module Fluentxpath
+  VERSION = '0.1.0'
+
+  class XPath
+    attr_accessor :expression
+
+    def self.that_navigates(&block)
+      xpath = self.new
+      xpath.instance_eval(&block)
+      return xpath.expression
+    end
+
+    def initialize
+      @expression = ""
+    end
+
+    def to_root_node
+      add "/"
+    end
+
+    def to_root_element
+      add "/"
+    end
+
+    def to_any_element
+      add "//"
+    end
+
+    def with_name(name)
+      add name
+    end
+
+    def and_name(name)
+      with_name(name)
+    end
+
+    def and_then
+      return self
+    end
+
+    def to_children
+      add "/"
+    end
+
+    def to_descendants
+      add "//"
+    end
+
+    def with_attributes(attributes)
+      predicates = []
+      attributes.each_pair { |attribute, value| predicates << "@#{attribute}='#{value}'" }
+      add "[#{predicates.sort.join(" and ")}]"
+    end
+
+    def and_attributes(attributes)
+      with_attributes(attributes)
+    end
+
+    def and_attribute(attributes)
+      with_attributes(attributes)
+    end
+
+    def with_attribute(attributes)
+      with_attributes(attributes)
+    end
+
+    private
+    def add(text)
+      @expression += text
+      return self
+    end
+  end
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/fluentxpath.rb'}"
+puts "Loading fluentxpath gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/test_fluentxpath.rb

@@ -0,0 +1,52 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestFluentxpath < Test::Unit::TestCase
+  def setup
+    @xpath = Fluentxpath::XPath
+  end
+   
+  def test_single_expressions
+    assert_equal "/", @xpath.that_navigates { to_root_node }
+
+    assert_equal "/library", @xpath.that_navigates { to_root_element.with_name "library" }
+    assert_equal "/html",    @xpath.that_navigates { to_root_element.with_name "html"    }
+
+    assert_equal "//book",   @xpath.that_navigates { to_any_element.with_name "book"    }
+  end
+
+  def test_navigation
+    assert_equal "/library/subject",            @xpath.that_navigates { to_root_element.with_name "library"
+                                                                        and_then.to_children.with_name "subject" }
+    assert_equal "/library/subject/shelf",      @xpath.that_navigates { to_root_element.with_name "library"
+                                                                        and_then.to_children.with_name "subject" 
+                                                                        and_then.to_children.with_name "shelf" }
+    assert_equal "/library/subject/shelf/book", @xpath.that_navigates { to_root_element.with_name "library"
+                                                                        and_then.to_children.with_name "subject" 
+                                                                        and_then.to_children.with_name "shelf"  
+                                                                        and_then.to_children.with_name "book" }
+    assert_equal "/library//book",              @xpath.that_navigates { to_root_element.with_name "library"
+                                                                        and_then.to_descendants.with_name "book" }
+    assert_equal "/library//shelf/book",        @xpath.that_navigates { to_root_element.with_name "library"
+                                                                        and_then.to_descendants.with_name "shelf"
+                                                                        and_then.to_children.with_name "book" }
+  end
+
+  def test_attributes
+    assert_equal "//book[@title='The Conquest of Bread']", 
+                 @xpath.that_navigates { to_any_element.with_name("book")
+                                                        and_attribute("title" => "The Conquest of Bread") }
+    assert_equal "//book[@author='Kropotkin' and @title='The Conquest of Bread']", 
+                 @xpath.that_navigates { to_any_element.with_name("book")
+                                                         and_attributes("title" => "The Conquest of Bread", "author" => "Kropotkin") }
+  end
+
+  def test_real_world_examples
+   assert_equal "//div[@id='homeMedals']//tr", @xpath.that_navigates { to_any_element.with_name("div").and_attribute("id" => "homeMedals")
+                                                                       and_then.to_descendants.with_name("tr") }
+   assert_equal "//ul[@id='nav']/li/ul/li/a",  @xpath.that_navigates { to_any_element.with_name("ul").and_attribute("id" => "nav")
+                                                                       and_then.to_children.with_name("li")
+                                                                       and_then.to_children.with_name("ul")
+                                                                       and_then.to_children.with_name("li")
+                                                                       and_then.to_children.with_name("a") }
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/fluentxpath'

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification 
+name: fluentxpath
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Douglas Squirrel
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-17 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rubyforge
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 4
+        version: 2.0.4
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 6
+        - 0
+        version: 2.6.0
+  type: :development
+  version_requirements: *id002
+description: With the fluentxpath Ruby gem, you build your xpath query in a language that is nearly English and very readable.
+email: 
+- ds@douglassquirrel.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- lib/fluentxpath.rb
+- script/console
+- script/destroy
+- script/generate
+- test/test_fluentxpath.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/douglassquirrel/fluentxpath
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: fluentxpath
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: With the fluentxpath Ruby gem, you build your xpath query in a language that is nearly English and very readable.
+test_files: 
+- test/test_fluentxpath.rb
+- test/test_helper.rb