matchdoc 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e83bb9ff1361427d28ea5863da452f19b0d2ecf5
+  data.tar.gz: 8148563e753ebcbf706aed7211e8fcfdd45a4c88
+SHA512:
+  metadata.gz: 5b0fcba5e9a7272229b55d51374412b217009c315197b2000de603e444bd92ee6a07402092b268378e22ff9d812e2eec5c6304daa2151c4e19f85fb0736db8b7
+  data.tar.gz: 8a1d4c6e945e43e11dafe92d462aab4da5af5b703b5de743fd2e4e43db66e78d3433d4d5d4f69b53d0639e2bdde264c2e304baf95b6d15dcbaa8038077270891

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Stephen Prater
+
+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,49 @@
+# Matchdoc
+
+Provides a template against which a string can be matched, particularly in RSpec
+
+For longer strings it's not always possible or desirable to know the exact 
+output of the string - you might know that every line in a file shoudld 
+contain a price, but not what that price will be.  This provides an RSpec 
+matcher for that exact problem.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'matchdoc'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install matchdoc
+
+## Usage
+
+To specify a template construct a string (probably with a heredoc) with
+embedded Regex where you want dynamic content.  If you are wanting to match a
+list of 3 product SKUs and prices, you might do this.
+
+```ruby
+<<-LIST
+product_sku, price
+#{/[A-Z]{13}/}, #{/\$(\d)[1,2]\.\d\d}
+#{/[A-Z]{13}/}, #{/\$(\d)[1,2]\.\d\d}
+#{/[A-Z]{13}/}, #{/\$(\d)[1,2]\.\d\d}
+LIST
+```ruby
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/matchdoc/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/lib/matchdoc.rb

@@ -0,0 +1,4 @@
+require "matchdoc/version"
+
+module Matchdoc
+end

data/lib/matchdoc/matcher.rb

@@ -0,0 +1,54 @@
+require 'strscan'
+require 'yaml'
+
+module Matchdoc
+  class Matcher
+    class FailedChunk < StandardError
+      def initialize(scanner, chunk)
+        failed_chunk = YAML.load(%Q(---\n"#{chunk.source}"\n))
+        super("Expected `#{scanner.rest[0..failed_chunk.size-1]}` to match `#{failed_chunk}`")
+      end
+    end
+
+    attr_reader :failed_chunk
+
+    def initialize(subject)
+      scanner = StringScanner.new(subject)
+      @match_chunks = []
+      until scanner.eos?
+        break unless scanner.scan_until(/\(\?[-mix]{4}:/) #regex prefix
+        @match_chunks << Regexp.new(Regexp.escape(scanner.pre_match))
+        regex_sub = /\((?>[^()]|(\g<0>))*\)/.match(scanner.matched+scanner.post_match).to_s
+        @match_chunks << Regexp.new(regex_sub)
+        scanner.pos = scanner.pos + (regex_sub.length - 7)
+        scanner.string = scanner.rest
+      end
+    end
+
+    def match!(subject)
+      scanner = StringScanner.new(subject)
+      scanned_chunks = []
+      @match_chunks.each.with_index do |chunk, i|
+        unless scanned_chunks[i] = scanner.scan(chunk)
+          raise FailedChunk.new(scanner, chunk)
+        end
+      end
+
+      scanned_chunks
+    end
+
+    def =~(subject)
+      begin
+        match!(subject)
+      rescue FailedChunk
+        false
+      else
+        true
+      end
+    end
+
+    def to_s
+      @match_chunks.map { |i| '/' + YAML.load(%Q(---\n"#{i.source}"\n)) + '/' }.join
+    end
+  end
+end

data/lib/matchdoc/rspec.rb

@@ -0,0 +1,15 @@
+require 'matchdoc/matcher'
+
+RSpec::Matchers.define :match_template do |expected|
+  match_unless_raises Matchdoc::Matcher::FailedChunk do |actual|
+    Matchdoc::Matcher.new(expected).match!(actual)
+  end
+
+  def diffable?
+    true
+  end
+
+  failure_message do
+    @rescued_exception.message
+  end
+end

data/lib/matchdoc/version.rb

@@ -0,0 +1,3 @@
+module Matchdoc
+  VERSION = "0.0.1"
+end

data/matchdoc.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'matchdoc/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "matchdoc"
+  spec.version       = Matchdoc::VERSION
+  spec.authors       = ["Stephen Prater"]
+  spec.email         = ["me@stephenprater.com"]
+  spec.summary       = %q{Match long strings against templates with dynamic areas.}
+  spec.description   = %q{For longer strings it's not always possible or desirable to know 
+                          the exact output of the string - you might know that every line in
+                          a file shoudld contain a price, but not what that price will be.
+                          This provides an RSpec matcher for that exact problem.}
+  spec.homepage      = ""
+  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.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
+end

data/spec/matchdoc_spec.rb

@@ -0,0 +1,78 @@
+require 'rspec'
+require 'matchdoc/rspec'
+
+describe Matchdoc::Matcher do
+ 
+  let(:matchdocument) { <<-TEMPLATE
+    title, name, #{/[a-z]+/}
+    Title, #{/(.{0,10}?,)/} #{/[0-9]/}
+  TEMPLATE
+  }
+
+  let(:successful_doc) { <<-TEMPLATE
+    title, name, something
+    Title, something, 2
+  TEMPLATE
+  }
+
+  let(:failing_doc_on_first_chunk) { <<-TEMPLATE
+    title, name, Something
+    Title, something, 2
+  TEMPLATE
+  }
+
+  let(:failing_doc_on_second_chunk) { <<-TEMPLATE
+    title, name, something
+    Title, somethingentirelytolong, 2
+  TEMPLATE
+  }
+
+  let(:failing_doc_on_third_chunk) { <<-TEMPLATE
+    title, name, something
+    Title, something, Q
+  TEMPLATE
+  }
+
+  subject { Matchdoc::Matcher.new(matchdocument) }
+
+  it 'matches a document template' do
+    expect(subject.match!(successful_doc)).to be_truthy
+  end
+
+  context 'when it fails on the first chunk' do
+    it 'fails to match a document template' do
+      expect { subject.match!(failing_doc_on_first_chunk) }
+      .to raise_error(Matchdoc::Matcher::FailedChunk, "Expected `Something\n    ` to match `(?-mix:[a-z]+)`")
+    end
+  end
+
+  context 'when it fails on the second chunk' do
+    it 'fails to match a document template' do
+      expect { subject.match!(failing_doc_on_second_chunk) }
+      .to raise_error(Matchdoc::Matcher::FailedChunk, "Expected `somethingentirelyto` to match `(?-mix:(.{0,10}?,))`")
+    end
+  end
+
+  context 'when it fails on the third chunk' do
+    it 'fails to match a document template' do
+      expect { subject.match!(failing_doc_on_third_chunk) }
+      .to raise_error(Matchdoc::Matcher::FailedChunk, "Expected `Q\n` to match `(?-mix:[0-9])`")
+    end
+  end
+
+  context 'it can use the matchy operator' do
+    it 'returns true' do
+      expect(subject =~ successful_doc).to be true
+    end
+
+    it 'returns false' do
+      expect(subject =~ failing_doc_on_first_chunk).to be false
+    end
+  end
+
+  describe 'to_s' do
+    it 'returns a string rep of the match template' do
+      expect(subject.to_s).to eq "/    title, name, //(?-mix:[a-z]+)//\n    Title, //(?-mix:(.{0,10}?,))// //(?-mix:[0-9])/" 
+    end
+  end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: matchdoc
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Stephen Prater
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: "For longer strings it's not always possible or desirable to know \n
+  \                         the exact output of the string - you might know that every
+  line in\n                          a file shoudld contain a price, but not what
+  that price will be.\n                          This provides an RSpec matcher for
+  that exact problem."
+email:
+- me@stephenprater.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/matchdoc.rb
+- lib/matchdoc/matcher.rb
+- lib/matchdoc/rspec.rb
+- lib/matchdoc/version.rb
+- matchdoc.gemspec
+- spec/matchdoc_spec.rb
+homepage: ''
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Match long strings against templates with dynamic areas.
+test_files:
+- spec/matchdoc_spec.rb
+has_rdoc: