sub_diff 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 21eca8a2613f2283e8b2ef108dd26fcc8fff6b97
-  data.tar.gz: 28b9f6a0700801ddcdc7968dad2c881554216697
+  metadata.gz: 6a95327c2f9868be0c23e279dbc32c577a4c45c2
+  data.tar.gz: 17c3721197874d746bc1d0377469d5971694195f
 SHA512:
-  metadata.gz: 3dcd408aae1f8d2feee698eaf84cd0e447d7fc8fd11a91e10147dcf96714fff538eca8dfe8b397e7c916722fe78dd6b8c3813b9b574f0be2bdb66b550b4f0e7f
-  data.tar.gz: 18145f531b6e8e73fec399c49db871ac410b5b5e1b648da6c0fa80cb061e5013663899eb72e572069269830201b4f53a2947997e5bf367403898ea8751295674
+  metadata.gz: dbf615e3a719b9508cff821a11c30ba6ad82adfa7d5cf9fac082b2d48975b9c6e0f630000063c0e9fe31939bce2d0ce0eac6ce9560c5e5a33ac69edf3ad86292
+  data.tar.gz: 35005311dee8874633c3d6e497177d316474eebc86eacf80d0ed296a90d1d5dbf78adea076ec5867f3f7fa8cdbca2028e5f296c3cdf23f779747715878f3bc6b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sub_diff (1.1.0)
+    sub_diff (1.1.1)
 
 GEM
   remote: https://www.rubygems.org/

data/lib/sub_diff.rb

@@ -1,5 +1,6 @@
 require 'delegate'
 require 'forwardable'
+require 'sub_diff/buildable'
 require 'sub_diff/adapter'
 require 'sub_diff/builder'
 require 'sub_diff/collection'

data/lib/sub_diff/adapter.rb

@@ -1,21 +1,19 @@
 module SubDiff
+  # Constructs an instance of {Sub} or {Gsub} to be
+  # used as a receiver for delegated calls to `diff`.
+  #
+  # Used internally by {Builder}.
+  #
+  # @api private
   class Adapter
-    extend Forwardable
+    include Buildable
 
-    def_delegators :differ, :builder
-    def_delegators :builder, :diff_method
-    def_delegators :instance, :diff
-
-    attr_reader :differ
-
-    def initialize(differ)
-      @differ = differ
-    end
+    def_delegators :adapter, :diff
 
     private
 
-    def instance
-      adapter_class.new(differ)
+    def adapter
+      adapter_class.new(builder)
     end
 
     def adapter_class

data/lib/sub_diff/buildable.rb

@@ -0,0 +1,22 @@
+module SubDiff
+  # This module allows classes to accept a {Builder} object as
+  # an initializer argument and defines an `attr_reader` for it.
+  #
+  # It also delegates commonly used methods to the {Builder} instance.
+  #
+  # Used internally by {Adapter}, {Differ}, and {Sub}.
+  #
+  # @api private
+  module Buildable
+    attr_reader :builder
+
+    def initialize(builder)
+      @builder = builder
+    end
+
+    def self.included(base)
+      base.extend(Forwardable)
+      base.def_delegators(:builder, :diff_method, :differ, :string)
+    end
+  end
+end

data/lib/sub_diff/builder.rb

@@ -1,4 +1,10 @@
 module SubDiff
+  # Performs a {Sub} or {Gsub} replacement and returns
+  # the resulting {Collection} of {Diff} objects.
+  #
+  # Used internally by {CoreExt::String#sub_diff} and {CoreExt::String#gsub_diff}.
+  #
+  # @api private
   class Builder
     attr_reader :string, :diff_method
 
@@ -32,7 +38,7 @@ module SubDiff
     end
 
     def adapter
-      @adapter ||= Adapter.new(differ)
+      @adapter ||= Adapter.new(self)
     end
 
     def differ

data/lib/sub_diff/collection.rb

@@ -1,4 +1,14 @@
 module SubDiff
+  # Stores a collection of {Diff} objects for all matches from
+  # a {String#sub_diff} or {String#gsub_diff} replacement.
+  #
+  # It behaves like a {String} that represents the entire
+  # replacement result from {String#sub} or {String#gsub}.
+  #
+  # It also behaves like an {Enumerable} by delegating to
+  # {Collection#diffs} - an {Array} containing each {Diff}.
+  #
+  # @api public
   class Collection < SimpleDelegator
     extend Forwardable
     include Enumerable

data/lib/sub_diff/core_ext/string.rb

@@ -1,10 +1,18 @@
 module SubDiff
   module CoreExt
     module String
+      # Behaves just like {String#sub} but wraps the returned replacement
+      # string in an enumerable {Collection} of {Diff} objects.
+      #
+      # See http://ruby-doc.org/core-2.2.0/String.html#method-i-sub
       def sub_diff(*args, &block)
         Builder.new(self, :sub).diff(*args, &block)
       end
 
+      # Behaves just like {String#gsub} but wraps the returned replacement
+      # string in an enumerable {Collection} of {Diff} objects.
+      #
+      # See http://ruby-doc.org/core-2.2.0/String.html#method-i-gsub
       def gsub_diff(*args, &block)
         Builder.new(self, :gsub).diff(*args, &block)
       end

data/lib/sub_diff/diff.rb

@@ -1,4 +1,16 @@
 module SubDiff
+  # Stores a single match (and optional replacement)
+  # from a {String#sub} or {String#gsub} replacement.
+  #
+  # It behaves just like a {String} and represents the
+  # newly replaced string if a replacement was made, or
+  # the matched string itself if no changes occurred.
+  #
+  # It also has additional methods that provide access
+  # to the old string, the newly replaced string, and a
+  # boolean to determine if a replacement was actually made.
+  #
+  # @api public
   class Diff < SimpleDelegator
     attr_reader :value_was
 

data/lib/sub_diff/differ.rb

@@ -1,20 +1,28 @@
 module SubDiff
+  # Performs a {String#sub} or {String#gsub} replacement
+  # while yielding each match "diff payload" to a block.
+  #
+  # The payload contains:
+  #
+  #   match       - the string matching the search.
+  #   prefix      - the string preceding the match.
+  #   suffix      - the string trailing the match.
+  #   replacement - the string replacing the match.
+  #
+  # This class uses some special global variables: $` and $'.
+  # See http://ruby-doc.org/core-2.2.0/doc/globals_rdoc.html
+  #
+  # Used internally by {Sub}.
+  #
+  # @api private
   class Differ
-    extend Forwardable
+    include Buildable
 
-    def_delegators :builder, :diff_method, :string
-
-    attr_reader :builder
-
-    def initialize(builder)
-      @builder = builder
-    end
-
-    def each_diff(search, *args, block)
+    def match(search, *args, replacement)
       string.send(diff_method, search) do |match|
         diff = { match: match, prefix: $`, suffix: $' }
-        diff[:replacement] = match.sub(search, *args, &block)
-        yield(builder, diff)
+        diff[:replacement] = match.sub(search, *args, &replacement)
+        yield(diff)
       end
     end
   end

data/lib/sub_diff/gsub.rb

@@ -1,8 +1,14 @@
 module SubDiff
+  # Processes matches for {String#gsub} replacements
+  # by pushing diffs into a {Builder} instance.
+  #
+  # Used internally by {Adapter}.
+  #
+  # @api private
   class Gsub < Sub
     private
 
-    def process(_builder, diff, _search)
+    def append_diff_to_builder(diff, _search)
       super
       last_prefix << prefix(diff) << diff[:match]
     end
@@ -17,13 +23,8 @@ module SubDiff
 
     def suffix(_diff, search)
       suffix = super
-      matcher = suffix_matcher(search)
-      skip_suffix = suffix.send(matcher, search)
-      suffix unless skip_suffix
-    end
-
-    def suffix_matcher(search)
-      search.is_a?(Regexp) ? :match : :include?
+      regex = Regexp.new(search)
+      suffix unless suffix.match(regex)
     end
   end
 end

data/lib/sub_diff/sub.rb

@@ -1,20 +1,22 @@
 module SubDiff
+  # Processes matches for {String#gsub} replacements
+  # by pushing diffs into a {Builder} instance.
+  #
+  # Used internally by {Adapter}.
+  #
+  # @api private
   class Sub
-    attr_reader :differ
-
-    def initialize(differ)
-      @differ = differ
-    end
+    include Buildable
 
     def diff(search, *args, &block)
-      differ.each_diff(search, *args, block) do |builder, diff|
-        process(builder, diff, search)
+      differ.match(search, *args, block) do |diff|
+        append_diff_to_builder(diff, search)
       end
     end
 
     private
 
-    def process(builder, diff, search)
+    def append_diff_to_builder(diff, search)
       builder << prefix(diff)
       builder.push(diff[:replacement], diff[:match])
       builder << suffix(diff, search)

data/lib/sub_diff/version.rb

@@ -1,3 +1,3 @@
 module SubDiff
-  VERSION = '1.1.0'
+  VERSION = '1.1.1'
 end

data/spec/spec_helper.rb

@@ -1,13 +1,9 @@
-begin
-  if ENV['CODECLIMATE_REPO_TOKEN']
-    require 'codeclimate-test-reporter'
-    CodeClimate::TestReporter.start
-  else
-    require 'simplecov'
-    SimpleCov.start { add_filter('/vendor/bundle/') }
-  end
-rescue LoadError
-  # Ignore when testing with Ruby 1.8.7
+if ENV['CODECLIMATE_REPO_TOKEN']
+  require 'codeclimate-test-reporter'
+  CodeClimate::TestReporter.start
+else
+  require 'simplecov'
+  SimpleCov.start { add_filter('/vendor/bundle/') }
 end
 
 require File.expand_path('../../lib/sub_diff', __FILE__)
@@ -17,64 +13,3 @@ RSpec.configure do |config|
   config.raise_errors_for_deprecations!
   config.run_all_when_everything_filtered = true
 end
-
-# RSpec matcher to spec delegations.
-# Forked from https://gist.github.com/ssimeonov/5942729 with fixes
-# for arity + custom prefix.
-#
-# Usage:
-#
-#     describe Post do
-#       it { should delegate(:name).to(:author).with_prefix } # post.author_name
-#       it { should delegate(:name).to(:author).with_prefix(:any) } # post.any_name
-#       it { should delegate(:month).to(:created_at) }
-#       it { should delegate(:year).to(:created_at) }
-#       it { should delegate(:something).to(:'@instance_var') }
-#     end
-RSpec::Matchers.define :delegate do |method|
-  match do |delegator|
-    @prefix ||= nil
-    @method = @prefix ? :"#{@prefix}_#{method}" : method
-    @delegator = delegator
-
-    if @to.to_s[0] == '@'
-      # Delegation to an instance variable
-      old_value = @delegator.instance_variable_get(@to)
-      begin
-        @delegator.instance_variable_set(@to, receiver_double(method))
-        @delegator.send(@method) == :called
-      ensure
-        @delegator.instance_variable_set(@to, old_value)
-      end
-    elsif @delegator.respond_to?(@to, true)
-      unless [0,-1].include?(@delegator.method(@to).arity)
-        raise "#{@delegator}'s' #{@to} method does not have zero or -1 arity (it expects parameters)"
-      end
-      allow(@delegator).to receive(@to).and_return(receiver_double(method))
-      @delegator.send(@method) == :called
-    else
-      raise "#{@delegator} does not respond to #{@to}"
-    end
-  end
-
-  description do
-    "delegate :#{@method} to its #{@to}#{@prefix ? ' with prefix' : ''}"
-  end
-
-  failure_message do |text|
-    "expected #{@delegator} to delegate :#{@method} to its #{@to}#{@prefix ? ' with prefix' : ''}"
-  end
-
-  failure_message_when_negated do |text|
-    "expected #{@delegator} not to delegate :#{@method} to its #{@to}#{@prefix ? ' with prefix' : ''}"
-  end
-
-  chain(:to) { |receiver| @to = receiver }
-  chain(:with_prefix) { |prefix| @prefix = prefix || @to }
-
-  def receiver_double(method)
-    double('receiver').tap do |receiver|
-      allow(receiver).to receive(method).and_return(:called)
-    end
-  end
-end

data/spec/sub_diff/collection_spec.rb

@@ -43,7 +43,6 @@ RSpec.describe SubDiff::Collection do
 
   describe '#each' do
     it { is_expected.to be_an(Enumerable) }
-    it { is_expected.to delegate(:each).to(:diffs) }
   end
 
   describe '#push' do
@@ -88,7 +87,9 @@ RSpec.describe SubDiff::Collection do
   end
 
   describe '#size' do
-    it { is_expected.to delegate(:size).to(:diffs) }
+    it 'should use the diffs size' do
+      expect(subject.size).to eq(subject.diffs.size)
+    end
 
     it 'should not use the string size' do
       expect(subject.size).not_to eq(subject.to_s.size)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sub_diff
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Sean Huber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-12 00:00:00.000000000 Z
+date: 2015-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -40,6 +40,7 @@ files:
 - README.md
 - lib/sub_diff.rb
 - lib/sub_diff/adapter.rb
+- lib/sub_diff/buildable.rb
 - lib/sub_diff/builder.rb
 - lib/sub_diff/collection.rb
 - lib/sub_diff/core_ext/string.rb