ruby-query 0.1.0

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Francis Chong
+
+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,102 @@
+# Ruby-Query
+
+ jQuery for command line and ruby. It make extract simple data fun and easy. 
+
+ It use Nokogiri for CSS extraction. Inspired by node [Query](https://github.com/visionmedia/query)
+
+## Installation
+
+    $ gem install ruby-query
+
+
+## Ruby Examples
+
+  Extract an attribute from a webpage:
+
+	  require 'open-uri'
+	  require 'ruby-query'
+
+	  RQuery::Query.query(open("http://twitter.com"), "a#logo img", "attr", "alt")
+	  => "Twitter"
+
+  Extract a form input value :
+
+	  require 'ruby-query'
+
+	  RQuery::Query.query('<input type="text" value="tj@vision-media.ca"/>', "input", "val")
+	  => "tj@vision-media.ca"
+		
+## Command Line Examples
+
+  Twitter logo alt text:
+  
+    $ curl http://twitter.com | query 'a#logo img' attr alt
+    Twitter
+
+  Alternately, since the output is simply more html, we can achieve this same result via pipes:
+  
+    $ curl http://twitter.com | query 'a#logo' | query img attr alt
+    Twitter
+
+  Check if a class is present:
+  
+    $ curl http://twitter.com | query .article '#timeline' hasClass statuses
+    true
+    
+    $ echo $?
+    0
+
+  Exit status for bools:
+  
+    $ echo '<div class="foo bar"></div>' | ./index.js div hasClass baz
+    false
+    
+    $ echo $?
+    1
+
+  Grab width or height attributes:
+  
+    $ echo '<div class="user" width="300"></div>' | query div.user width
+    300
+
+  Output element text:
+  
+    $ echo '<p>very <em>slick</em></p>' | query p text
+    very slick
+
+  Values:
+  
+    $ echo '<input type="text" value="tj@vision-media.ca"/>' | query input val
+    tj@vision-media.ca
+  
+  Get second li's text:
+  
+    $ echo $list | query ul li get 1 text
+    two
+  
+  Get third li's text using `next`:
+  
+    $ echo $list | query ul li get 1 next text
+    three
+
+  Get length:
+  
+    $ echo '<ul><li></li><li></li></ul>' | query li length
+    2
+
+
+## Contributing to RQuery
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2011 Francis Chong. See LICENSE.txt for
+further details.
+

data/bin/rquery

@@ -0,0 +1,5 @@
+require 'ruby_query'
+
+html = STDIN.read
+puts RubyQuery::Query.query(html, *ARGV)
+

data/lib/ruby_query.rb

@@ -0,0 +1,138 @@
+require 'nokogiri'
+
+module RubyQuery
+  class QueryError < StandardError
+    attr_accessor :context, :command_name, :command_type, :param, :message
+    def initialize(context, name, type, param, msg)
+      @context = context
+      @command_name = name
+      @command_type = type
+      @param = param
+      @message = msg
+    end
+    
+    def to_s
+      "#{command_type}:#{command_name} param=#{param}, message=#{message}"
+    end
+  end
+
+  class Query  
+    # supported commands
+    COMMANDS = {
+      :to_html => {:type => 'method'},
+      :inner_html => {:type => 'method'},
+      :text => {:type => 'method'},
+      :size => {:type => 'method'},
+      
+      :width => {:type => 'attribute'},
+      :height => {:type => 'attribute'},
+      :value => {:type => 'attribute'},
+      :class => {:type => 'attribute'},
+
+      :first => {:type => 'traverse'},
+      :last => {:type => 'traverse'},
+      :parent => {:type => 'traverse'},
+      :next_sibling => {:type => 'traverse'},
+      :previous_sibling => {:type => 'traverse'},
+      :at => {:type => 'traverse', :arity => 1},
+      
+      :attr => {:type => 'proc', 
+        :arity => 1, 
+        :proc => Proc.new {|context, param, query| 
+            context.attr(param).to_s rescue ""
+        }
+      },
+      :hasClass => {:type => 'proc', 
+        :arity => 1, 
+        :proc => Proc.new {|context, param, query| 
+            if context.is_a?(Nokogiri::XML::Element)
+              !!context["class"].split(" ").find{|x| x == param} rescue false
+            elsif context.is_a?(Nokogiri::XML::NodeSet)
+              !!context.first["class"].split(" ").find{|x| x == param} rescue false
+            else
+              raise QueryError.new(context, name, type, param, "Cannot get hasClass from #{context.class}")
+            end
+        } 
+      }
+    }
+    
+    ALIAS = {
+      :html => :to_html,
+      :len => :length,
+      :count => :size,
+      :get => :at,
+      :"has-class" => :hasClass,
+      :val => :value
+    }
+
+    def self.query(html, *query)
+      doc = Nokogiri::HTML(html)
+      ctx = doc.search(query.shift)
+
+      while method = query.shift
+        command = COMMANDS[method.to_sym] || COMMANDS[ALIAS[method.to_sym]] || COMMANDS[:to_html]
+        param = query.length > 0 ? (command[:arity] ? query.shift : nil) : nil
+        ctx = handle_command(ctx, ALIAS[method.to_sym] || method.to_sym, command[:type], param, query)
+      end
+
+      if ctx.is_a?(Nokogiri::XML::Element) || ctx.is_a?(Nokogiri::XML::NodeSet)
+        ctx = ctx.to_html
+      else
+        ctx
+      end
+    end
+    
+    private
+    def self.handle_command(context, name, type, param=nil, query=nil)
+      case type
+      when 'method'
+        if context.is_a?(Nokogiri::XML::Element) || context.is_a?(Nokogiri::XML::NodeSet)
+          if param
+            context.send(name, param)
+          else
+            context.send(name)
+          end
+
+        elsif context.nil?
+          nil
+
+        else
+          raise QueryError.new(context, name, type, param, "Cannot apply #{name} to #{context.class}")
+        end
+
+      when 'attribute'
+        if context.is_a?(Nokogiri::XML::Element)
+          context[name]
+        elsif context.is_a?(Nokogiri::XML::NodeSet)
+          context.first[name]
+        else
+          raise QueryError.new(context, name, type, param, "Cannot get attr #{name} from #{context.class}")
+        end
+      
+      when 'traverse'
+        if name == :at
+          if param.nil?
+            raise QueryError.new(context, name, type, param, "missing at parameter")
+          end
+          context[param.to_i]
+        else
+          if context.is_a?(Nokogiri::XML::Element) || context.is_a?(Nokogiri::XML::NodeSet)
+            if param
+              context.send(name, param)
+            else
+              context.send(name)
+            end
+          else
+            raise QueryError.new(context, name, type, param, "Cannot tranverse #{context.class}")
+          end
+        end
+
+      when 'proc'
+        COMMANDS[name][:proc].call(context, param, query)
+
+      else
+        raise QueryError.new(context, name, type, param, 'Unexpected type: #{type}')
+      end
+    end
+  end
+end

data/spec/rquery/rquery_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+describe RubyQuery do
+  HTML_SIMPLE = "<html><body><a href='test' id='logo'><img src='1.gif' alt='Test'/></a><ul class='list'><li>point a</li><li>point b</li></ul></body></html>"
+  HTML_LIST = "<ul><li>Apple</li><li>Orange</li><li>Cat</li></ul>"
+
+  it "extract using class" do
+    RubyQuery::Query.query(HTML_SIMPLE, ".list li", "first", "text").should == "point a"
+  end
+
+  it "extract using id" do
+    RubyQuery::Query.query(HTML_SIMPLE, "a#logo img", "attr", "alt").should == "Test"
+  end  
+  
+  it "should return empty if a match is not found" do
+    RubyQuery::Query.query(HTML_SIMPLE, "a#logo #qk").should be_empty
+    RubyQuery::Query.query(HTML_SIMPLE, "a#logo #qk", "attr", "alt").should be_empty
+  end
+  
+  it "nested extraction" do
+    logo = RubyQuery::Query.query(HTML_SIMPLE, "a#logo")
+    RubyQuery::Query.query(logo, "img", "attr", "alt").should == "Test"
+  end  
+
+  it "check if a class is present" do
+    logo = RubyQuery::Query.query(HTML_SIMPLE, "a")
+    RubyQuery::Query.query(logo.to_s, "img", "attr", "alt").should be_true
+  end
+  
+  it "grab width or height attributes" do
+    RubyQuery::Query.query('<div class="user" width="300"></div>', "div.user", "width").should == "300"
+    RubyQuery::Query.query('<div class="user" width="300" height="150"></div>', "div.user", "height").should == "150"
+  end
+
+  it "output element text and inner html" do
+    RubyQuery::Query.query('<p>very <em>slick</em></p>', "p", "text").should == "very slick"
+    RubyQuery::Query.query('<p>very <em>slick</em></p>', "p", "inner_html").should == "very <em>slick</em>"
+  end
+  
+  it "get value" do
+    RubyQuery::Query.query('<input type="text" value="tj@vision-media.ca"/>', "input", "val").should == "tj@vision-media.ca"
+    RubyQuery::Query.query('<input type="text" value="tj@vision-media.ca"/>', "input", "value").should == "tj@vision-media.ca"
+  end
+
+  it "get second li's text" do
+    RubyQuery::Query.query(HTML_LIST, "ul li", "get", "1", "text").should == "Orange"
+    RubyQuery::Query.query(HTML_LIST, "ul li", "get", "10", "text").should be_nil
+  end
+
+  it "get third li's text using next" do
+    RubyQuery::Query.query(HTML_LIST, "ul li", "get", "1", "next", "text").should == "Cat"
+  end
+
+  it "get length" do
+    RubyQuery::Query.query(HTML_LIST, "li", "len").should == 3
+    RubyQuery::Query.query(HTML_LIST, "li", "length").should == 3
+  end
+  
+  it "should handl html or text" do
+    RubyQuery::Query.query(HTML_LIST, "li", "first", "text").should == "Apple"
+    RubyQuery::Query.query(HTML_LIST, "li", "first", "html").should == "<li>Apple</li>\n"
+    RubyQuery::Query.query(HTML_LIST, "li", "html").should == "<li>Apple</li>\n<li>Orange</li>\n<li>Cat</li>"
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'json'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'ruby_query'
+require 'rspec'
+require 'rspec/autorun'
+
+RSpec.configure do |config|
+
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification 
+name: ruby-query
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Francis Chong
+autorequire: ruby-query
+bindir: bin
+cert_chain: []
+
+date: 2011-02-12 00:00:00 +08:00
+default_executable: rquery
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  name: nokogiri
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  name: rake
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  name: json
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  name: jeweler
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 4
+        - 0
+        version: 1.4.0
+  type: :runtime
+  name: nokogiri
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 1
+        - 2
+        - 3
+        version: 1.2.3
+  type: :development
+  name: rspec
+  prerelease: false
+  version_requirements: *id006
+description: RQuery is a simple jQuery style method to extract HTML
+email: francis@ignition.hk
+executables: 
+- rquery
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- bin/rquery
+- lib/ruby_query.rb
+- LICENSE.txt
+- README.md
+- spec/rquery/rquery_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/siuying/rquery
+licenses: 
+- MIT
+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: Simple jQuery style method to extract HTML
+test_files: 
+- spec/rquery/rquery_spec.rb
+- spec/spec_helper.rb