hairaito 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4e3cd6878a89daabfb2fdf0d3a9ca661fc238566
+  data.tar.gz: 237ee8e16ee95f4e20ac67bd301500a3eb7deb81
+SHA512:
+  metadata.gz: 762a12095a72d152e6b07d80c48ec8294f4077c4e769222d0e770bb3eaa2b7a4c0c4f5176502ddd57a5c6727c6aaaa073d70384623ed808afdcccd3ccc500e6a
+  data.tar.gz: 69e4d996242c807cd4fbd42e445809b6af8d64fbc3bf6d84bb519b787a7bd1a27887137177bd4f2e4295b3e06ace6967cfc7dd9c2edf7456093506f7231c241f

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea/*

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hairaito.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Denis Mazilov
+
+MIT License
+
+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,25 @@
+# Hairaito
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hairaito'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hairaito
+
+## Usage
+
+## Contributing
+
+1. Fork it ( https://github.com/dmazilov/hairaito/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+

data/hairaito.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hairaito/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'hairaito'
+  spec.version       = Hairaito::VERSION
+  spec.authors       = ['Denis Mazilov']
+  spec.email         = ['denis.mazilov@gmail.com']
+  spec.summary       = %q{Extends Nokogiri with text snippets highlighting.}
+  spec.description   = %q{}
+  spec.homepage      = 'https://github.com/dmazilov/hairaito'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+
+  spec.add_dependency 'nokogiri'
+end

data/lib/hairaito/nokogiri/xml/document.rb

@@ -0,0 +1,86 @@
+module Hairaito
+  module Nokogiri
+    module XML
+      module Document
+
+        def highlight(snippets, options = {})
+          highlighting_default_options(options)
+          snippets.each do |snippet|
+            highlighting_base.traverse_by_text(snippet).each do |snippet_container|
+              to_wrap = []
+              start_index = snippet_container.text().index(snippet)
+
+              start_node, start_inner_index = snippet_container.text_node_by_position(start_index)
+              start_range = start_node.text_range_by_index(start_inner_index, snippet.length)
+              to_wrap << [start_node, start_range]
+
+              # If start node contains only part of snippet
+              if snippet.length > start_range.size
+                end_node, end_inner_index = snippet_container.text_node_by_position(start_index + snippet.length - 1)
+                end_range = end_node.text_range_by_index(end_inner_index)
+                to_wrap += snippet_container.text_nodes_between(start_node, end_node).map do |node|
+                  [node, 0..(node.text.length - 1)]
+                end
+                to_wrap << [end_node, end_range]
+              end
+
+              to_wrap.each do |node_data|
+                node_data.first.highlight_by_range(node_data.last)
+              end
+
+              snippet_container['class'] = "#{snippet_container['class']} #{@hl_opts[:snippet_container_class]}"
+            end
+          end
+          numerate_highlighted_snippets if @hl_opts[:numerate]
+          to_html
+        end
+
+        def highlight_snippet_part(text)
+          if @hl_opts[:snippet_part_wrapper].blank?
+            raise ArgumentError.new('Snippet part wrapper tag is not specified!')
+          end
+          wrapper = create_element("#{@hl_opts[:snippet_part_wrapper]}", class: "#{@hl_opts[:snippet_part_wrapper_class]}")
+          wrapper.content = text
+          wrapper
+        end
+
+        private
+
+        def highlighting_default_options(options)
+          @hl_opts = {
+              base_selector: 'body',
+              base_content_wrapper: '',
+              base_content_wrapper_class: 'highlighting-base',
+              snippet_container_class: 'highlighted-snippet',
+              snippet_part_wrapper: 'span',
+              snippet_part_wrapper_class: 'highlighted-snippet-part',
+              numerate: true,
+              numeration_attr: 'data-snippet-id',
+              numeration_prefix: '',
+              numeration_suffix: '',
+          }.merge(options)
+        end
+
+        def highlighting_base
+          base = at(@hl_opts[:base_selector])
+          raise ArgumentError.new('Document does not contain highlighting base element!') if base.blank?
+          if @hl_opts[:base_content_wrapper].present?
+            wrapper = create_element("#{@hl_opts[:base_content_wrapper]}", class: "#{@hl_opts[:base_content_wrapper_class]}")
+            base.children.each{|child| child.parent = wrapper}
+            wrapper.parent = base
+            return wrapper
+          end
+          base
+        end
+
+        def numerate_highlighted_snippets
+          css(".#{@hl_opts[:snippet_container_class]}").each_with_index do |snippet_container, index|
+            snippet_container[@hl_opts[:numeration_attr]] =
+                "#{@hl_opts[:numeration_prefix]}#{index}#{@hl_opts[:numeration_prefix]}"
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/hairaito/nokogiri/xml/node.rb

@@ -0,0 +1,66 @@
+module Hairaito
+  module Nokogiri
+    module XML
+      module Node
+
+        def text_nodes
+          result_nodes = []
+          traverse do |node|
+            result_nodes << node if node.text?
+          end
+          result_nodes
+          ::Nokogiri::XML::NodeSet.new(document, result_nodes)
+        end
+
+        def text_nodes_between(start_node, end_node)
+          nodes = text_nodes
+          indexes = [nodes.index(start_node), nodes.index(end_node)]
+          raise ArgumentError.new('Node must contain both start and end nodes!') if indexes.compact.count < 2
+          # Start and end nodes are equals or are neighbours
+          return [] if indexes.last - indexes.first < 2
+          result_nodes = nodes.slice((indexes.first + 1)..(indexes.last - 1))
+          ::Nokogiri::XML::NodeSet.new(document, result_nodes)
+        end
+
+        def traverse_by_text(text, exclude_ancestors = true)
+          excluded = []
+          result_nodes = []
+          traverse do |node|
+            next if node.is_a?(::Nokogiri::XML::Text)
+            next if node.in?(excluded)
+            if node.text.include?(text)
+              result_nodes << node
+              excluded += node.ancestors if exclude_ancestors
+            end
+          end
+          result_nodes
+        end
+
+        def text_node_by_position(in_text_position)
+          text_nodes.each do |node|
+            # Node does not contain parent_index
+            if node.text.length - 1 < in_text_position
+              in_text_position -= node.text.length
+              next
+            end
+            return node, in_text_position
+          end
+          raise ArgumentError.new('Inner index is out of range!')
+        end
+
+        def highlight_by_range(range)
+          prefix = range.first > 0 ? text[0..(range.first - 1)]: ''
+          suffix = range.last < text.length - 1 ? text[(range.last + 1)..(text.length - 1)]: ''
+          for_wrapping = text[range]
+          new_contents = "#{prefix}#{document.highlight_snippet_part(for_wrapping)}#{suffix}"
+          replace(new_contents)
+        end
+
+        def text_range_by_index(index, demand_length = nil)
+          demand_length.present? ? index..[text.length - 1, index + demand_length - 1].min : 0..index
+        end
+
+      end
+    end
+  end
+end

data/lib/hairaito/nokogiri/xml.rb

@@ -0,0 +1,6 @@
+module Hairaito
+  module Nokogiri
+    module XML
+    end
+  end
+end

data/lib/hairaito/nokogiri.rb

@@ -0,0 +1,4 @@
+module Hairaito
+  module Nokogiri
+  end
+end

data/lib/hairaito/version.rb

@@ -0,0 +1,3 @@
+module Hairaito
+  VERSION = '0.0.2'
+end

data/lib/hairaito.rb

@@ -0,0 +1,13 @@
+require 'nokogiri'
+require 'hairaito/version'
+
+module Hairaito
+end
+
+directory = Pathname.new(File.dirname(__FILE__))
+Dir.glob(directory.join('hairaito', '*.rb')) { |file| require file }
+Dir.glob(directory.join('hairaito', '**/*.rb')) { |file| require file }
+
+Nokogiri::XML::Document.send(:include, Hairaito::Nokogiri::XML::Document)
+Nokogiri::XML::Node.send(:include, Hairaito::Nokogiri::XML::Node)
+

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: hairaito
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Denis Mazilov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- denis.mazilov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- hairaito.gemspec
+- lib/hairaito.rb
+- lib/hairaito/nokogiri.rb
+- lib/hairaito/nokogiri/xml.rb
+- lib/hairaito/nokogiri/xml/document.rb
+- lib/hairaito/nokogiri/xml/node.rb
+- lib/hairaito/version.rb
+homepage: https://github.com/dmazilov/hairaito
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Extends Nokogiri with text snippets highlighting.
+test_files: []