string_diff 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 711634734d27fd21de01628616434c4ca01b404a
+  data.tar.gz: be5d5d2d48887e22e8c638b98ab583e7cea17cc7
+SHA512:
+  metadata.gz: b3929b85ba0fd944eaeaa605315b2c3b8510e455ea0ba0d047899abb7c48ba9c699cd8abc35cb6e6c50d7bf7d8d0d267c5acb475db46517d3a02d3a24654b6f4
+  data.tar.gz: 76474e574c92897507a0d4992979d113eed485eef00c0999c9559a3deb188534238342d55d26fab532c06ba7863eaa3b0f55db300287351d7e19f4da399e2f3b

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.2.3

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.4
+before_install: gem install bundler -v 1.12.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+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, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at natanio@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Nate Hill
+
+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,62 @@
+# StringDiff
+
+[![Gem Version](https://badge.fury.io/rb/string_diff.svg)](https://badge.fury.io/rb/string_diff) [![Build Status](https://travis-ci.org/natanio/string_diff.png)](https://travis-ci.org/natanio/string_diff) [![License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat)](https://github.com/natanio/string_diff/blob/master/LICENSE.txt)
+
+StringDiff is a gem that compares one string to another. If insertions or deletions are made, a corresponding style is added to that difference.
+
+## Installation
+
+*Ruby*
+**Supports Ruby 2.1.5 and above.**
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'string_diff'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install string_diff
+
+## Dependencies
+
+Uses the gem [pragmatic_tokenizer](https://github.com/diasks2/pragmatic_tokenizer) for tokenizing strings.
+
+## Usage
+
+
+```ruby
+string_1 = "hello world"
+string_2 ="hello beautiful world"
+StringDiff::Diff.new(string_1, string_2).diff
+# => "hello <span class='insertion'>beautiful</span> world"
+
+-------------------------------
+
+string_1 = "hello world"
+string_2 = "hello"
+StringDiff::Diff.new(string_1, string_2).diff
+# => "hello <span class='deletion'>world</span>"
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/string_diff. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "string_diff"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/string_diff/version.rb

@@ -0,0 +1,3 @@
+module StringDiff
+  VERSION = "0.1.0"
+end

data/lib/string_diff.rb

@@ -0,0 +1,107 @@
+require "string_diff/version"
+require "pragmatic_tokenizer"
+
+module StringDiff
+  class Diff
+    attr_reader :string1, :string2
+
+    def initialize(string1, string2)
+      @string1 = string1
+      @string2 = string2
+    end
+
+    def diff
+      a1 = PragmaticTokenizer::Tokenizer.new(downcase: false).tokenize(string1)
+      a2 = PragmaticTokenizer::Tokenizer.new(downcase: false).tokenize(string2)
+
+      construct_string(compare(a1, a2))
+    end
+
+    def compare(array1, array2)
+      deletions = array1 - array2
+      insertions = array2 - array1
+
+      process_duplicates(array1, array2)
+      annotate_deletions(deletions, array1)
+      annotate_insertions(insertions, array1, array2)
+    end
+
+    def annotate_deletions(deletions, array1)
+      deletions.each do |v|
+        index = array1.find_index(v)
+        array1[index] = "<span class='deletion'>#{v}</span>"
+      end
+      #array1.join(" ")
+    end
+
+    def annotate_insertions(insertions, array1, array2)
+      insertions.each_with_index do |v, i|
+        if array2.find_index(v) == 0
+          index = 0
+        else
+          insertion_position = array2.find_index(v) + i - 1
+          index = array1.find_index(array2[insertion_position])
+        end
+
+        if index.nil?
+          array1.insert(-1, "<span class='insertion'>#{v}</span>")
+        else
+          array1.insert(index + 1, "<span class='insertion'>#{v}</span>")
+        end
+      end
+
+      array1
+    end
+
+    def process_duplicates(array1, array2)
+      dup1 = array1.find_all { |e| array1.count(e) > 1 }
+      dup2 = array2.find_all { |e| array2.count(e) > 1 }
+
+      missing_words = (dup1 - dup2).uniq
+
+      duplicate_indexs_of_array1 = []
+      duplicate_indexs_of_array2 = []
+
+      missing_words.each do |word|
+        array1.each_with_index do |v, i|
+          duplicate_indexs_of_array1 << i if word == v
+        end
+
+        array2.each_with_index do |v, i|
+          duplicate_indexs_of_array2 << i if word == v
+        end
+
+        missing_index = duplicate_indexs_of_array1 - duplicate_indexs_of_array2
+
+        array1[missing_index[0]] = "<span class='deletion'>#{word}</span>"
+      end
+      #array1.join(" ")
+    end
+
+    def construct_string(array1)
+      string = ""
+
+      array1.each_with_index do |token, i|
+        if i == 0
+          string += token
+        else
+          if token.include?("<span")
+            if token.scan(/(?<='>).*(?=<\/)/)[0] !~ /[[:punct:]]/ || string1.include?(" #{token.scan(/(?<='>).*(?=<\/)/)[0]}")
+              string += " #{token}"
+            else
+              string += token
+            end
+          else
+            if token !~ /[[:punct:]]/ || string1.include?(" #{token.scan(/(?<='>).*(?=<\/)/)[0]}")
+              string += " #{token}"
+            else
+              string += token
+            end
+          end
+        end
+      end
+      string
+    end
+
+  end
+end

data/string_diff.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'string_diff/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "string_diff"
+  spec.version       = StringDiff::VERSION
+  spec.authors       = ["natanio"]
+  spec.email         = ["natanio@gmail.com"]
+
+  spec.summary       = %q{Adds annotations to differences found in strings.}
+  spec.description   = %q{StringDiff compares one string to another for the purpose of finding insertions or deletions. Ideal for seeing what is different between a newer, edited string of the original.}
+  spec.homepage      = "https://github.com/natanio/string_diff"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_runtime_dependency "pragmatic_tokenizer", "~> 3.0.4"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: string_diff
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- natanio
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pragmatic_tokenizer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.4
+description: StringDiff compares one string to another for the purpose of finding
+  insertions or deletions. Ideal for seeing what is different between a newer, edited
+  string of the original.
+email:
+- natanio@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/string_diff.rb
+- lib/string_diff/version.rb
+- string_diff.gemspec
+homepage: https://github.com/natanio/string_diff
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Adds annotations to differences found in strings.
+test_files: []