sub_diff 0.0.0

data/Gemfile

@@ -0,0 +1,8 @@
+source 'http://www.rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'rake'
+  gem 'rdoc', '>= 2.4.2'
+end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Sean Huber - shuber@huberry.com
+
+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.rdoc

@@ -0,0 +1,32 @@
+= sub_diff
+
+Allows you to apply regular expression replacements to strings while presenting the result in a "diff" like format
+
+== Installation
+
+  gem install sub_diff
+
+
+== Usage
+
+<tt>String#gsub_diff</tt> or <tt>String#sub_diff</tt> accept the same arguments as the standard <tt>gsub</tt> and <tt>sub</tt> methods, however the returned object is enumerable and allows you to iterate thru each replacement
+
+  replacement = 'this is a test'.gsub_diff(/(\S*is)/, 'x(\1)')
+  
+  puts replacement
+  # => x(this) x(is) a test
+  
+  replacement.each { |diff| puts [diff.changed?, diff.value_was.inspect, diff.value.inspect].join(' - ') }
+  # => true - "this" - "x(this)"
+  # => false - " " - " "
+  # => true - "is" - "x(is)"
+  # => false - " a test" - " a test"
+
+
+== Patches and pull requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with Rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rdoc/task'
+
+desc 'Default: run unit tests'
+task :default => :test
+
+desc 'Test the sub_diff gem'
+Rake::TestTask.new(:test) do |t|
+  t.libs += ['lib', 'test']
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the sub_diff gem'
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'sub_diff'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/sub_diff/diff.rb

@@ -0,0 +1,22 @@
+module SubDiff
+  class Diff
+    attr_reader :value, :value_was
+    alias_method :to_s, :value
+
+    def initialize(value, value_was = nil)
+      @value, @value_was = value, value_was || value
+    end
+
+    def changed?
+      @changed ||= value != value_was
+    end
+
+    def method_missing(*args, &block)
+      to_s.send(*args, &block)
+    end
+
+    def respond_to_missing?(method, include_private)
+      to_s.respond_to?(method, include_private)
+    end
+  end
+end

data/lib/sub_diff/diff_collection.rb

@@ -0,0 +1,38 @@
+module SubDiff
+  class DiffCollection
+    include Enumerable
+
+    def initialize(diffs = [])
+      @diffs = []
+      diffs.each { |diff| self << diff }
+    end
+
+    def <<(diff)
+      if diff.changed? || !diff.empty?
+        @diffs << diff
+        @to_s = nil
+      end
+      self
+    end
+
+    def each(&block)
+      @diffs.each(&block)
+    end
+
+    def method_missing(*args, &block)
+      to_s.send(*args, &block)
+    end
+
+    def respond_to_missing?(method, include_private)
+      to_s.respond_to?(method, include_private)
+    end
+
+    def size
+      @diffs.size
+    end
+
+    def to_s
+      @to_s ||= @diffs.join
+    end
+  end
+end

data/lib/sub_diff/version.rb

@@ -0,0 +1,17 @@
+module SubDiff
+  # Contains information about this gem's version
+  module Version
+    MAJOR = 0
+    MINOR = 0
+    PATCH = 0
+
+    # Returns a version string by joining <tt>MAJOR</tt>, <tt>MINOR</tt>, and <tt>PATCH</tt> with <tt>'.'</tt>
+    #
+    # Example
+    #
+    #   puts Version # '1.0.2'
+    def self.to_s
+      [MAJOR, MINOR, PATCH].join('.')
+    end
+  end
+end

data/lib/sub_diff.rb

@@ -0,0 +1,39 @@
+require 'respond_to_missing'
+
+module SubDiff
+  autoload :Diff,           'sub_diff/diff'
+  autoload :DiffCollection, 'sub_diff/diff_collection'
+  autoload :Version,        'sub_diff/version'
+
+  def gsub_diff(*args, &block)
+    with_diff_collection do |diff_collection|
+      match_prefix, suffix_matcher = '', args.first.is_a?(Regexp) ? :match : :include?
+      gsub(args.first) do |match|
+        suffix, prefix, replacement = Diff.new($'), Diff.new($`.sub(match_prefix, '')), Diff.new(match.sub(*args, &block), match)
+        diff_collection << prefix << replacement
+        diff_collection << suffix unless suffix.send(suffix_matcher, args.first)
+        match_prefix << prefix + match
+      end
+    end
+  end
+
+  def sub_diff(*args, &block)
+    with_diff_collection do |diff_collection|
+      sub(args.first) do |match|
+        suffix, prefix, replacement = Diff.new($'), Diff.new($`), Diff.new(match.sub(*args, &block), match)
+        diff_collection << prefix << replacement << suffix
+      end
+    end
+  end
+
+  protected
+
+    def with_diff_collection
+      diff_collection = DiffCollection.new
+      yield diff_collection
+      diff_collection << Diff.new(self) if diff_collection.empty?
+      diff_collection
+    end
+end
+
+String.send(:include, SubDiff)

data/test/diff_collection_test.rb

@@ -0,0 +1,42 @@
+require File.expand_path('../test_helper', __FILE__)
+
+module SubDiff
+  class DiffCollectionTest < Test::Unit::TestCase
+    def setup
+      @diffs = [Diff.new('one '), Diff.new('two', '2'), Diff.new(' three ')]
+      @diff_collection = DiffCollection.new(@diffs)
+    end
+
+    def test_append
+      size, value = @diff_collection.size, @diff_collection.to_s
+      @diff_collection << Diff.new('four', '4')
+      @diff_collection << Diff.new('', 'test')
+      @diff_collection << Diff.new('') # should skip this since it's empty
+      assert_equal size + 2, @diff_collection.size
+      assert_not_equal value, @diff_collection.to_s
+    end
+
+    def test_enumerable
+      assert @diff_collection.is_a?(Enumerable)
+      assert_equal @diffs, @diff_collection.collect { |diff| diff }
+    end
+
+    def test_method_missing
+      assert_equal @diffs.to_s.upcase, @diff_collection.upcase
+      assert_raises(NoMethodError) { @diff_collection.invalid_method }
+    end
+
+    def test_respond_to_missing?
+      assert @diff_collection.respond_to?(:upcase)
+      assert !@diff_collection.respond_to?(:invalid_method)
+    end
+
+    def test_size
+      assert_equal @diffs.size, @diff_collection.size
+    end
+
+    def to_s
+      assert_equal @diffs.join, @diff_collection.to_s
+    end
+  end
+end

data/test/diff_test.rb

@@ -0,0 +1,42 @@
+require File.expand_path('../test_helper', __FILE__)
+
+module SubDiff
+  class DiffTest < Test::Unit::TestCase
+    def setup
+      @diff_value = 'test'
+      @diff_value_was = 'testing'
+      @diff = Diff.new(@diff_value, @diff_value_was)
+      @diff_without_value_was = Diff.new(@diff_value)
+    end
+
+    def test_initialize_with_value_was
+      assert_equal @diff_value, @diff.value
+      assert_equal @diff_value_was, @diff.value_was
+    end
+
+    def test_initialize_without_value_was
+      assert_equal @diff_value, @diff_without_value_was.value
+      assert_equal @diff_without_value_was.value, @diff_without_value_was.value_was
+    end
+
+    def test_changed?
+      assert @diff.changed?
+      assert !@diff_without_value_was.changed?
+      assert !Diff.new('test', 'test').changed?
+    end
+
+    def test_method_missing
+      assert_equal @diff_value.upcase, @diff.upcase
+      assert_raises(NoMethodError) { @diff.invalid_method }
+    end
+
+    def test_respond_to_missing?
+      assert @diff.respond_to?(:upcase)
+      assert !@diff.respond_to?(:invalid_method)
+    end
+
+    def test_to_s
+      assert_equal @diff.value, @diff.to_s
+    end
+  end
+end

data/test/sub_diff_test.rb

@@ -0,0 +1,85 @@
+require File.expand_path('../test_helper', __FILE__)
+
+module SubDiff
+  class SubDiffTest < Test::Unit::TestCase
+    def setup
+      @string = 'this is a simple test'
+    end
+
+    def test_gsub_diff_with_block
+      diff_collection = @string.gsub_diff('i') { |match| 'x' }
+      assert_equal 'thxs xs a sxmple test', diff_collection.to_s
+      assert_equal 7, diff_collection.size
+    end
+
+    def test_gsub_diff_with_hash
+      diff_collection = @string.gsub_diff(/(\S*is)/, 'is' => 'IS', 'this' => 'THIS')
+      assert_equal 'THIS IS a harder test', diff_collection.to_s
+      assert_equal 4, diff_collection.size
+    rescue TypeError => error # Hash arguments only work in ruby 1.9+
+      assert_equal "can't convert Hash into String", error.message
+    end
+
+    def test_gsub_diff_with_regex
+      diff_collection = @string.gsub_diff(/(\S*is)/, 'X')
+      assert_equal 'X X a simple test', diff_collection.to_s
+      assert_equal 4, diff_collection.size
+    end
+
+    def test_gsub_diff_with_regex_captures
+      diff_collection = @string.gsub_diff(/(\S*is)/, 'X(\1)')
+      assert_equal 'X(this) X(is) a simple test', diff_collection.to_s
+      assert_equal 4, diff_collection.size
+    end
+
+    def test_gsub_diff_with_string
+      diff_collection = @string.gsub_diff('i', 'x')
+      assert_equal 'thxs xs a sxmple test', diff_collection.to_s
+      assert_equal 7, diff_collection.size
+    end
+
+    def test_gsub_diff_without_matches
+      diff_collection = @string.gsub_diff('no-match', 'test')
+      assert_equal @string, diff_collection.to_s
+      assert_equal 1, diff_collection.size
+    end
+
+    def test_sub_diff_with_block
+      diff_collection = @string.sub_diff('simple') { |match| 'block' }
+      assert_equal 'this is a block test', diff_collection.to_s
+      assert_equal 3, diff_collection.size
+    end
+
+    def test_sub_diff_with_hash
+      diff_collection = @string.sub_diff(/simple/, 'simple' => 'harder')
+      assert_equal 'this is a harder test', diff_collection.to_s
+      assert_equal 3, diff_collection.size
+    rescue TypeError => error # Hash arguments only work in ruby 1.9+
+      assert_equal "can't convert Hash into String", error.message
+    end
+
+    def test_sub_diff_with_regex
+      diff_collection = @string.sub_diff(/a \S+/, 'an easy')
+      assert_equal 'this is an easy test', diff_collection.to_s
+      assert_equal 3, diff_collection.size
+    end
+
+    def test_sub_diff_with_regex_captures
+      diff_collection = @string.sub_diff(/a (\S+)/, 'a very \1')
+      assert_equal 'this is a very simple test', diff_collection.to_s
+      assert_equal 3, diff_collection.size
+    end
+
+    def test_sub_diff_with_string
+      diff_collection = @string.sub_diff('simple', 'very simple')
+      assert_equal 'this is a very simple test', diff_collection.to_s
+      assert_equal 3, diff_collection.size
+    end
+
+    def test_sub_diff_without_matches
+      diff_collection = @string.sub_diff('no-match', 'test')
+      assert_equal @string, diff_collection.to_s
+      assert_equal 1, diff_collection.size
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'test/unit'
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$:.unshift(File.dirname(__FILE__))
+require 'sub_diff'

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: sub_diff
+version: !ruby/object:Gem::Version 
+  hash: 31
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 0
+  version: 0.0.0
+platform: ruby
+authors: 
+- Sean Huber
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-16 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: respond_to_missing
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: Allows you to apply regular expression replacements to strings while presenting the result in a "diff" like format
+email: shuber@huberry.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/sub_diff/diff.rb
+- lib/sub_diff/diff_collection.rb
+- lib/sub_diff/version.rb
+- lib/sub_diff.rb
+- Gemfile
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+- test/diff_collection_test.rb
+- test/diff_test.rb
+- test/sub_diff_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/shuber/sub_diff
+licenses: []
+
+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.6.2
+signing_key: 
+specification_version: 3
+summary: Apply regular expression replacements to strings while presenting the result in a "diff" like format
+test_files: 
+- test/diff_collection_test.rb
+- test/diff_test.rb
+- test/sub_diff_test.rb
+- test/test_helper.rb