wriggler 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 5d35c4b6d7c7da4483e293b47fdbcc06a9348172
4
+ data.tar.gz: 9a7372283313d57c7ab1d3d39320c544422d5b2c
5
+ SHA512:
6
+ metadata.gz: 0cb56c3f6062e77532fe7676acb7b68140a8b2fe4b9d3b21015b77b159fbc259b295aee19082210444804c632bdc647247f7314fdb82908ea604582b82908790
7
+ data.tar.gz: f8c9cbd5a96acbb701a9ecd0e5fc50c34e5a0b6ad88f56464ea6c969a2d0fa314f8ffc34dece4f71df8598571cce1db1423c1fa7b4b109f6283f71c93a522a0e
data/.gitignore ADDED
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/.travis.yml ADDED
@@ -0,0 +1,4 @@
1
+ language: ruby
2
+ rvm:
3
+ - 2.0.0
4
+ before_install: gem install bundler -v 1.10.2
@@ -0,0 +1,13 @@
1
+ # Contributor Code of Conduct
2
+
3
+ As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
4
+
5
+ We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
6
+
7
+ Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
8
+
9
+ Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
10
+
11
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
12
+
13
+ This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in wriggler.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2015 Elliott Young
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,41 @@
1
+ # Wriggler
2
+
3
+ Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/wriggler`. To experiment with that code, run `bin/console` for an interactive prompt.
4
+
5
+ Wriggler was created to serve and the crawler for a search engine, moving its way through HTML files and grabbing data based on pre determined tags then making/storing the data in a number of specifically created CSV files.
6
+
7
+ ## Installation
8
+
9
+ Add this line to your application's Gemfile:
10
+
11
+ ```ruby
12
+ gem 'wriggler'
13
+ ```
14
+
15
+ And then execute:
16
+
17
+ $ bundle
18
+
19
+ Or install it yourself as:
20
+
21
+ $ gem install wriggler
22
+
23
+ ## Usage
24
+
25
+ TODO: Write usage instructions here
26
+
27
+ ## Development
28
+
29
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
30
+
31
+ To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
32
+
33
+ ## Contributing
34
+
35
+ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/wriggler. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
36
+
37
+
38
+ ## License
39
+
40
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
41
+
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "wriggler"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start
data/bin/setup ADDED
@@ -0,0 +1,7 @@
1
+ #!/bin/bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+
5
+ bundle install
6
+
7
+ # Do any other automated setup that you need to do here
data/dirtest/test1.xml ADDED
@@ -0,0 +1,30 @@
1
+ <root>
2
+ <sitcoms>
3
+ <sitcom>
4
+ <name>Married with Children</name>
5
+ <characters>
6
+ <character>Al Bundy</character>
7
+ <character>Bud Bundy</character>
8
+ <character>Marcy Darcy</character>
9
+ </characters>
10
+ </sitcom>
11
+ <sitcom>
12
+ <name>Perfect Strangers</name>
13
+ <characters>
14
+ <character>Larry Appleton</character>
15
+ <character>Balki Bartokomous</character>
16
+ </characters>
17
+ </sitcom>
18
+ </sitcoms>
19
+ <dramas>
20
+ <drama>
21
+ <name>The A-Team</name>
22
+ <characters>
23
+ <character>John "Hannibal" Smith</character>
24
+ <character>Templeton "Face" Peck</character>
25
+ <character>"B.A." Baracus</character>
26
+ <character>"Howling Mad" Murdock</character>
27
+ </characters>
28
+ </drama>
29
+ </dramas>
30
+ </root>
data/dirtest/test2.xml ADDED
@@ -0,0 +1,30 @@
1
+ <root>
2
+ <sitcoms>
3
+ <sitcom>
4
+ <name>Married with Children</name>
5
+ <characters>
6
+ <character>Al Bundy</character>
7
+ <character>Bud Bundy</character>
8
+ <character>Marcy Darcy</character>
9
+ </characters>
10
+ </sitcom>
11
+ <sitcom>
12
+ <name>Perfect Strangers</name>
13
+ <characters>
14
+ <character>Larry Appleton</character>
15
+ <character>Balki Bartokomous</character>
16
+ </characters>
17
+ </sitcom>
18
+ </sitcoms>
19
+ <dramas>
20
+ <drama>
21
+ <name>The A-Team</name>
22
+ <characters>
23
+ <character>John "Hannibal" Smith</character>
24
+ <character>Templeton "Face" Peck</character>
25
+ <character>"B.A." Baracus</character>
26
+ <character>"Howling Mad" Murdock</character>
27
+ </characters>
28
+ </drama>
29
+ </dramas>
30
+ </root>
data/dirtest/test3.xml ADDED
@@ -0,0 +1,30 @@
1
+ <root>
2
+ <sitcoms>
3
+ <sitcom>
4
+ <name>Married with Children</name>
5
+ <characters>
6
+ <character>Al Bundy</character>
7
+ <character>Bud Bundy</character>
8
+ <character>Marcy Darcy</character>
9
+ </characters>
10
+ </sitcom>
11
+ <sitcom>
12
+ <name>Perfect Strangers</name>
13
+ <characters>
14
+ <character>Larry Appleton</character>
15
+ <character>Balki Bartokomous</character>
16
+ </characters>
17
+ </sitcom>
18
+ </sitcoms>
19
+ <dramas>
20
+ <drama>
21
+ <name>The A-Team</name>
22
+ <characters>
23
+ <character>John "Hannibal" Smith</character>
24
+ <character>Templeton "Face" Peck</character>
25
+ <character>"B.A." Baracus</character>
26
+ <character>"Howling Mad" Murdock</character>
27
+ </characters>
28
+ </drama>
29
+ </dramas>
30
+ </root>
@@ -0,0 +1,3 @@
1
+ module Wriggler
2
+ VERSION = "0.1.0"
3
+ end
data/lib/wriggler.rb ADDED
@@ -0,0 +1,80 @@
1
+ require "wriggler/version"
2
+ require "nokogiri"
3
+
4
+ module Wriggler
5
+ attr_reader :content, :directory
6
+
7
+ def crawl(tags=[], directory="", subdirectories=true)
8
+ @content = Hash[tags.map {|k| [k, []]}] #Hash with content
9
+ @subdirectories = subdirectories #Default true for the existence of subdirs
10
+ @directory = directory #Directory to grab files from
11
+
12
+ navigate_directory
13
+ Writer.write_to_csv(@content)
14
+ end
15
+
16
+ private
17
+
18
+ def navigate_directory
19
+ #Set the cwd to the given dir send to gather all nested files from there
20
+ Dir.chdir(@directory)
21
+ gather_files
22
+ end
23
+
24
+ def gather_files
25
+ #Gathers all of the HTML or XML files from this and all subdirectories
26
+
27
+ end
28
+
29
+ def open_next_file(file)
30
+ #Opens the next file on the list, depending on the extension passes it to HTML or XML
31
+ f = File.open(file)
32
+
33
+ if is_HTML?(file)
34
+ set_HTML(f)
35
+ elsif is_XML?(file)
36
+ set_XML(f)
37
+ end
38
+ end
39
+
40
+ def is_HTML?(file)
41
+ #Determines, using a regex check, if it is an HTML file
42
+ file =~ /.html/
43
+ end
44
+
45
+ def is_XML?(file)
46
+ #Determines, using a regex check, if it is an XML file
47
+ file =~ /.xml/
48
+ end
49
+
50
+ def set_HTML(file)
51
+ #Set the HTML file into Nokogiri for crawling
52
+ doc = Nokogiri::HTML(file)
53
+ crawl_file(doc)
54
+ end
55
+
56
+ def set_XML(file)
57
+ #Set the XML file into Nokogiri for crawling
58
+ doc = Nokogiri::XML(file)
59
+ crawl_file(doc)
60
+ end
61
+
62
+ def crawl_file(doc)
63
+ #Crawl the Nokogiri Object for the file
64
+ @content.each_key do |key|
65
+ if !doc.xpath("//#{key}").empty? #Returns an empty array if tag is not present
66
+ doc.xpath("//#{key}").map{ |tag| @content.fetch(key) << sanitize(tag.text) }
67
+ end
68
+ end
69
+ end
70
+
71
+ def sanitize(text)
72
+ #Removes any escaped quotes, replaces them
73
+ text.gsub(/"/, "'")
74
+ end
75
+ end
76
+
77
+ module Writer
78
+ def write_to_csv(content)
79
+ end
80
+ end
data/test.rb ADDED
@@ -0,0 +1,91 @@
1
+ require "nokogiri"
2
+
3
+ class Wriggler
4
+ def initialize(tags=[], directory="", subdirectories=true)
5
+ @content = Hash[tags.map {|k| [k, []]}] #Hash with content
6
+ @subdirectories = subdirectories #Default true for the existence of subdirs
7
+ @directory = directory #Directory to grab files from
8
+
9
+ navigate_directory
10
+ # Writer.write_to_csv(@content)
11
+ end
12
+
13
+ private
14
+
15
+ def navigate_directory
16
+ #Set the cwd to the given dir send to gather all nested files from there
17
+ Dir.chdir(@directory)
18
+ gather_files
19
+ end
20
+
21
+ def gather_files
22
+ #Gathers all of the HTML or XML files from this and all subdirectories
23
+ open_next_file("test1.xml")
24
+ puts "=============="
25
+ puts "1:"
26
+ p @content
27
+ puts "=============="
28
+ puts ""
29
+ open_next_file("test2.xml")
30
+ puts "=============="
31
+ puts "2:"
32
+ p @content
33
+ puts "=============="
34
+ puts ""
35
+ open_next_file("test3.xml")
36
+ puts "=============="
37
+ puts "3:"
38
+ p @content
39
+ puts "=============="
40
+ puts ""
41
+ end
42
+
43
+ def open_next_file(file)
44
+ #Opens the next file on the list, depending on the extension passes it to HTML or XML
45
+ f = File.open(file)
46
+
47
+ if is_html?(file)
48
+ set_HTML(f)
49
+ elsif is_xml?(file)
50
+ set_XML(f)
51
+ end
52
+ end
53
+
54
+ def is_html?(file)
55
+ #Determines, using a regex check, if it is an HTML file
56
+ file =~ /.html/
57
+ end
58
+
59
+ def is_xml?(file)
60
+ #Determines, using a regex check, if it is an XML file
61
+ file =~ /.xml/
62
+ end
63
+
64
+ def set_HTML(file)
65
+ #Set the HTML file into Nokogiri for crawling
66
+ doc = Nokogiri::HTML(file)
67
+ crawl_file(doc)
68
+ end
69
+
70
+ def set_XML(file)
71
+ #Set the XML file into Nokogiri for crawling
72
+ doc = Nokogiri::XML(file)
73
+ crawl_file(doc)
74
+ end
75
+
76
+ def crawl_file(doc)
77
+ #Crawl the Nokogiri Object for the file
78
+ @content.each_key do |key|
79
+ if !doc.xpath("//#{key}").empty? #Returns an empty array if tag is not present
80
+ doc.xpath("//#{key}").map{ |tag| @content.fetch(key) << sanitize(tag.text) }
81
+ end
82
+ end
83
+ end
84
+
85
+ def sanitize(text)
86
+ #Removes any escaped quotes, replaces them
87
+ text.gsub(/"/, "'")
88
+ end
89
+ end
90
+
91
+ test = Wriggler.new(["character", "content", "name", "title"], "/Users/47900/Desktop/Ruby/wriggler/dirtest", false)
data/wriggler.gemspec ADDED
@@ -0,0 +1,34 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'wriggler/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "wriggler"
8
+ spec.version = Wriggler::VERSION
9
+ spec.authors = ["Elliott Young"]
10
+ spec.email = ["elliott.a.young@gmail.com"]
11
+
12
+ spec.summary = "A Gem designed to crawl through a local directory of HTML/XML files and pull out content based on pre-specified tag"
13
+ spec.description = "A Gem designed to crawl through a local directory of HTML/XML files and pull out content based on pre-specified tag, which will then be saved to a CSV file and exported. Originally designed to feed an indexer."
14
+ spec.homepage = "https://github.com/ElliottAYoung/wriggler"
15
+ spec.license = "MIT"
16
+
17
+ # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
18
+ # delete this section to allow pushing this gem to any host.
19
+ if spec.respond_to?(:metadata)
20
+ spec.metadata['allowed_push_host'] = "https://rubygems.org"
21
+ else
22
+ raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
23
+ end
24
+
25
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
26
+ spec.bindir = "exe"
27
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
28
+ spec.require_paths = ["lib"]
29
+
30
+ spec.add_development_dependency "bundler", "~> 1.10"
31
+ spec.add_development_dependency "rake", "~> 10.0"
32
+ spec.add_development_dependency "rspec"
33
+ spec.add_development_dependency "nokogiri"
34
+ end
metadata ADDED
@@ -0,0 +1,122 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: wriggler
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Elliott Young
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2015-06-07 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ~>
18
+ - !ruby/object:Gem::Version
19
+ version: '1.10'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ~>
25
+ - !ruby/object:Gem::Version
26
+ version: '1.10'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ~>
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ~>
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - '>='
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - '>='
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: nokogiri
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - '>='
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - '>='
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ description: A Gem designed to crawl through a local directory of HTML/XML files and
70
+ pull out content based on pre-specified tag, which will then be saved to a CSV file
71
+ and exported. Originally designed to feed an indexer.
72
+ email:
73
+ - elliott.a.young@gmail.com
74
+ executables: []
75
+ extensions: []
76
+ extra_rdoc_files: []
77
+ files:
78
+ - .gitignore
79
+ - .rspec
80
+ - .travis.yml
81
+ - CODE_OF_CONDUCT.md
82
+ - Gemfile
83
+ - LICENSE.txt
84
+ - README.md
85
+ - Rakefile
86
+ - bin/console
87
+ - bin/setup
88
+ - dirtest/test1.xml
89
+ - dirtest/test2.xml
90
+ - dirtest/test3.xml
91
+ - lib/wriggler.rb
92
+ - lib/wriggler/version.rb
93
+ - test.rb
94
+ - wriggler.gemspec
95
+ homepage: https://github.com/ElliottAYoung/wriggler
96
+ licenses:
97
+ - MIT
98
+ metadata:
99
+ allowed_push_host: https://rubygems.org
100
+ post_install_message:
101
+ rdoc_options: []
102
+ require_paths:
103
+ - lib
104
+ required_ruby_version: !ruby/object:Gem::Requirement
105
+ requirements:
106
+ - - '>='
107
+ - !ruby/object:Gem::Version
108
+ version: '0'
109
+ required_rubygems_version: !ruby/object:Gem::Requirement
110
+ requirements:
111
+ - - '>='
112
+ - !ruby/object:Gem::Version
113
+ version: '0'
114
+ requirements: []
115
+ rubyforge_project:
116
+ rubygems_version: 2.4.7
117
+ signing_key:
118
+ specification_version: 4
119
+ summary: A Gem designed to crawl through a local directory of HTML/XML files and pull
120
+ out content based on pre-specified tag
121
+ test_files: []
122
+ has_rdoc: