regexp-examples 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f72e32a8b9c2934cb90f1d32d3e50c8f735b0dac
+  data.tar.gz: fa76e5281143d5d14a9b7b3207ea2ea28915ea47
+SHA512:
+  metadata.gz: 72348eafa1f3257eca9761c088293057eef0018825541f773993c04f1d579279431b06389a3185f4f8e5bb98e7ce0f331ae89aa53750f20b6fccee0cac3b6187
+  data.tar.gz: d4e3ac8e6951a3707eed765ed2373d25949bc7ea32281a75c173da11df03db4962d71e0a2ca339f5fc74370b97b596331bd93d65632557c82081a2d2728db933

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 regexp-examples.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 TODO: Write your name
+
+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,31 @@
+# Regexp::Examples
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'regexp-examples'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install regexp-examples
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/regexp-examples/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/regexp-examples.rb

@@ -0,0 +1,15 @@
+Dir[File.dirname(__FILE__) + '/regexp-examples/*.rb'].each {|file| require file }
+
+# TODO: DEBUG. DELETE THIS.
+#require 'pry'
+#RegexpExamples::show(/a*/)
+#RegexpExamples::show(/a+/)
+#RegexpExamples::show(/a?/)
+#RegexpExamples::show(/a{1,2}/)
+#RegexpExamples::show(/a{1,}/)
+#RegexpExamples::show(/https?:\/\/(www\.)?google\.com/) # AWWW YEEEAHH!
+#RegexpExamples::show(/a|b/)
+#RegexpExamples::show(/(a)/)
+#RegexpExamples::show(/((a))\1\2/)
+#
+#binding.pry

data/lib/regexp-examples/backreferences.rb

@@ -0,0 +1,22 @@
+module RegexpExamples
+  class BackReferenceTracker
+    @filled_groups = {}
+    class << self
+      attr_accessor :filled_groups
+
+      def add_filled_group(num, group)
+        @filled_groups[num] = group
+      end
+    end
+  end
+
+  class BackReferenceReplacer
+    def substitute_backreferences(full_example)
+      # TODO: Update this for named capture groups
+      # TODO: Define this magic __X__ pattern as a constant? Maybe?
+      full_example.gsub!(/__(\d+)__/) do |_|
+        BackReferenceTracker.filled_groups[$1.to_i]
+      end
+    end
+  end
+end

data/lib/regexp-examples/constants.rb

@@ -0,0 +1,11 @@
+module RegexpExamples
+  # Number of times to repeat for Star and Plus repeaters
+  TIMES = 2
+
+  # Set of chars for Dot and negated [^] char groups
+  #CHARS = [("a".."z").to_a, ("A".."Z").to_a, ".", ",", ";"].flatten
+  #TODO: Make these character sets more complete
+  #e.g. Sets for \d, \w, \h, \s
+  CHARS = %w{a b c d e}
+end
+

data/lib/regexp-examples/groups.rb

@@ -0,0 +1,98 @@
+module RegexpExamples
+  class SingleCharGroup
+    def initialize(char)
+      @char = char
+    end
+    def result
+      [@char]
+    end
+  end
+
+  class CharGroup
+    def initialize(chars)
+      @chars = chars
+      if chars[0] == "^"
+        @negative = true
+        @chars = @chars[1..-1]
+      else
+        @negative = false
+      end
+
+      # TODO: Can I make this more legible?
+      # Ranges a-b
+      # save first and last "-" if present
+      first = nil
+      last = nil
+      first = @chars.shift if @chars.first == "-"
+      last = @chars.pop if @chars.last == "-"
+      while i = @chars.index("-")
+        @chars[i-1..i+1] = (@chars[i-1]..@chars[i+1]).to_a
+      end
+      # restore them back
+      @chars.unshift(first) if first
+      @chars.push(last) if last
+    end
+    def result
+      if @negative
+        CHARS - @chars
+      else
+        @chars
+      end
+    end
+  end
+
+  class DotGroup
+    def result
+      CHARS
+    end
+  end
+
+  class MultiGroup
+    attr_reader :group_num
+    def initialize(groups, group_num)
+      @groups = groups
+      @group_num = group_num
+    end
+
+    # Generates the result of each contained group
+    # and adds the filled group of each result to
+    # itself
+    def result
+      strings = @groups.map {|x| x.result}
+      result = RegexpExamples::permutations_of_strings(strings)
+      result.each {|x| BackReferenceTracker.add_filled_group(@group_num, x)}
+      result
+    end
+  end
+
+  class MultiGroupEnd
+    def result
+      ['']
+    end
+  end
+
+  class OrGroup
+    def initialize(repeaters)
+      @repeaters = repeaters
+    end
+
+    def result
+      repeaters_results = @repeaters.map do |repeater|
+        repeater.result
+      end
+      RegexpExamples::permutations_of_strings(repeaters_results)
+    end
+  end
+
+  class BackReferenceGroup
+    attr_reader :num
+    def initialize(num)
+      @num = num
+    end
+
+    def result
+      ["__#{@num}__"]
+    end
+  end
+
+end

data/lib/regexp-examples/helpers.rb

@@ -0,0 +1,29 @@
+module RegexpExamples
+  # Given an array of arrays of strings,
+  # returns all possible perutations,
+  # for strings created by joining one
+  # element from each array
+  #
+  # For example:
+  # permutations_of_strings [ ['a'], ['b'], ['c', 'd', 'e'] ] #=> ['acb', 'abd', 'abe']
+  # permutations_of_strings [ ['a', 'b'], ['c', 'd'] ] #=> [ 'ac', 'ad', 'bc', 'bd' ]
+  def self.permutations_of_strings(arrays_of_strings)
+    return arrays_of_strings[0] if arrays_of_strings.size == 1
+    first = arrays_of_strings.shift
+    first.product( permutations_of_strings(arrays_of_strings) ).map {|x| x.flatten.join}
+  end
+
+  # TODO: For debugging only!! Delete this before v1.0
+  def self.show(regexp)
+    s = regexp.examples
+    puts "#{regexp.inspect} --> #{s.inspect}"
+    puts "Checking..."
+    errors = s.reject {|string| string =~ regexp}
+    if errors.size == 0
+      puts "All strings match"
+    else
+      puts "These don't match: #{errors.inspect}"
+    end
+  end
+end
+

data/lib/regexp-examples/parser.rb

@@ -0,0 +1,147 @@
+module RegexpExamples
+  class Parser
+    attr_reader :regexp_string
+    def initialize(regexp_string)
+      @regexp_string = regexp_string
+      @num_groups = 0
+      @current_position = 0
+    end
+
+    def parse
+      repeaters = []
+      while @current_position < regexp_string.length
+        group = parse_group
+        break if group.is_a? MultiGroupEnd
+        @current_position += 1
+        repeaters << parse_repeater(group)
+      end
+      repeaters
+    end
+
+    private
+
+    def parse_group
+      char = regexp_string[@current_position]
+      case char
+      when '('
+        group = parse_multi_group
+      when ')'
+        group = parse_multi_end_group
+      when '['
+        group = parse_char_group
+      when '.'
+        group = parse_dot_group
+      when '|'
+        group = parse_or_group
+      when '\\'
+        group = parse_after_backslash_group
+      else
+        group = parse_single_char_group(char)
+      end
+      group
+    end
+
+    def parse_after_backslash_group
+      @current_position += 1
+      case regexp_string[@current_position..-1]
+      when /^(\d+)/
+        group = parse_backreference_group($&)
+      else
+        group = parse_single_char_group( regexp_string[@current_position] )
+        # TODO: What about cases like \n, \(, \^, etc?
+        # SpecialCharsAfterBackslash ?
+      end
+      group
+    end
+
+    def parse_repeater(group)
+      char = regexp_string[@current_position]
+      case char
+      when '*'
+        repeater = parse_star_repeater(group)
+      when '+'
+        repeater = parse_plus_repeater(group)
+      when '?'
+        repeater = parse_question_mark_repeater(group)
+      when '{'
+        repeater = parse_range_repeater(group)
+      else
+        repeater = parse_one_time_repeater(group)
+      end
+      repeater
+    end
+
+    def parse_multi_group
+      @current_position += 1
+      @num_groups += 1
+      this_group_num = @num_groups
+      groups = parse
+      # TODO: Non-capture groups, i.e. /...(?:foo).../
+      # TODO: Named capture groups, i.e. /...(?<name>foo).../
+      MultiGroup.new(groups, this_group_num)
+    end
+
+    def parse_multi_end_group
+      MultiGroupEnd.new
+    end
+
+    def parse_char_group
+      chars = []
+      @current_position += 1
+      # TODO: What about the sneaky edge case of /...[]a-z].../ ?
+      until regexp_string[@current_position].chr == ']'
+        chars << regexp_string[@current_position].chr
+        @current_position += 1
+      end
+      CharGroup.new(chars)
+    end
+
+    def parse_dot_group
+      DotGroup.new
+    end
+
+    def parse_or_group
+      @current_position += 1
+      repeaters = parse
+      OrGroup.new(repeaters)
+    end
+
+
+    def parse_single_char_group(char)
+      SingleCharGroup.new(char)
+    end
+
+    def parse_backreference_group(match)
+      BackReferenceGroup.new(match.to_i)
+    end
+
+    def parse_star_repeater(group)
+      @current_position += 1
+      StarRepeater.new(group)
+    end
+
+    def parse_plus_repeater(group)
+      @current_position += 1
+      PlusRepeater.new(group)
+    end
+
+    def parse_question_mark_repeater(group)
+      @current_position += 1
+      QuestionMarkRepeater.new(group)
+    end
+
+    def parse_range_repeater(group)
+      match = regexp_string[@current_position..-1].match(/^\{(\d+)(,)?(\d+)?\}/)
+      @current_position += match[0].size
+      min = match[1].to_i if match[1]
+      has_comma = !match[2].nil?
+      max = match[3].to_i if match[3]
+      RangeRepeater.new(group, min, has_comma, max)
+    end
+
+    def parse_one_time_repeater(group)
+      OneTimeRepeater.new(group)
+    end
+  end
+end
+

data/lib/regexp-examples/regexp_extensions.rb

@@ -0,0 +1,16 @@
+class Regexp
+module Examples
+  def examples
+    regexp_string = self.inspect[1..-2]
+    partial_examples =
+      RegexpExamples::Parser.new(regexp_string)
+        .parse
+        .map {|repeater| repeater.result}
+    full_examples = RegexpExamples::permutations_of_strings(partial_examples)
+    full_examples.map{ |full_example| RegexpExamples::BackReferenceReplacer.new.substitute_backreferences(full_example)}
+    full_examples
+  end
+end
+  include Examples
+end
+

data/lib/regexp-examples/repeaters.rb

@@ -0,0 +1,77 @@
+module RegexpExamples
+  class BaseRepeater
+    def initialize(group)
+      @group = group
+    end
+
+    def result(min_repeats, max_repeats)
+      group_result = @group.result
+      results = []
+      min_repeats.upto(max_repeats) do |repeats|
+        group_result.each do |result|
+          results << result * repeats
+        end
+      end
+      results.uniq
+    end
+  end
+
+  class OneTimeRepeater < BaseRepeater
+    def initialize(group)
+      super
+    end
+
+    def result
+      super(1, 1)
+    end
+  end
+
+  class StarRepeater < BaseRepeater
+    def initialize(group)
+      super
+    end
+
+    def result
+      super(0, TIMES)
+    end
+  end
+
+  class PlusRepeater < BaseRepeater
+    def initialize(group)
+      super
+    end
+
+    def result
+      super(1, TIMES)
+    end
+  end
+
+  class QuestionMarkRepeater < BaseRepeater
+    def initialize(group)
+      super
+    end
+
+    def result
+      super(0, 1)
+    end
+  end
+
+  class RangeRepeater < BaseRepeater
+    def initialize(group, min, has_comma, max)
+      super(group)
+      @min = min
+      if max
+        @max = max
+      elsif has_comma
+        @max = min + TIMES
+      else
+        @max = min
+      end
+    end
+
+    def result
+      super(@min, @max)
+    end
+  end
+end
+

data/lib/regexp-examples/version.rb

@@ -0,0 +1,3 @@
+module RegexpExamples
+  VERSION = '0.0.0'
+end

data/regexp-examples.gemspec

@@ -0,0 +1,21 @@
+require File.expand_path("../lib/regexp-examples/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name             = 'regexp-examples'
+  s.version          = RegexpExamples::VERSION
+  s.date             = '2014-11-04'
+  s.summary          = "Extends the Regexp class with '#examples'"
+  s.description      =
+    'Regexp#examples returns a list of strings what are matched by the regex'
+  s.authors          = ['Tom Lord']
+  s.email            = 'lord.thom@gmail.com'
+  s.files            = `git ls-files -z`.split("\x0")
+  s.executables      = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files       = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths    = ["lib"]
+  s.homepage         =
+    'http://rubygems.org/gems/regexp-examples'
+  s.add_development_dependency "bundler", "~> 1.7"
+  s.add_development_dependency "rake", "~> 10.0"
+  s.license          = 'MIT'
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: regexp-examples
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Tom Lord
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-04 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'
+description: Regexp#examples returns a list of strings what are matched by the regex
+email: lord.thom@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/regexp-examples.rb
+- lib/regexp-examples/backreferences.rb
+- lib/regexp-examples/constants.rb
+- lib/regexp-examples/groups.rb
+- lib/regexp-examples/helpers.rb
+- lib/regexp-examples/parser.rb
+- lib/regexp-examples/regexp_extensions.rb
+- lib/regexp-examples/repeaters.rb
+- lib/regexp-examples/version.rb
+- regexp-examples.gemspec
+homepage: http://rubygems.org/gems/regexp-examples
+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 the Regexp class with '#examples'
+test_files: []