regex_sieve 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b611b4d789b0afe15cc5b2fc78129cc9189ea71f
+  data.tar.gz: 6b2c88dfcabed49ea2d67f3edbb1166b0d282e21
+SHA512:
+  metadata.gz: e1b3abb05b7de18ac325a98ca9f2c6804f2ddbb400ea2744108888e376b3a6a6583b21a5835900d4dfbe235112e5b648e57ba2ec0668e8597ddf47de42375ffd
+  data.tar.gz: 18af4b19c0597ba93024f7e6a03b20c4534143db79364ece99bedc1a1c6d7f77f747f305b12b20da2d873d3554376e78d31cb1470f74c7a958f98fe6290fa6f9

data/.gitignore

@@ -0,0 +1,2 @@
+/.bundle
+/vendor/bundle

data/.rspec

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

data/Gemfile

@@ -0,0 +1,4 @@
+# -*- mode: ruby -*-
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    regex_sieve (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.2)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  regex_sieve!
+  rspec (~> 3.3)
+
+BUNDLED WITH
+   1.10.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Sterling Paramore
+
+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 @@
+# RegexSeive
+
+The RegexSieve functions in a manner similar a hash.  The regex sieve
+is initialized with a hash where the keys are regular expressions and
+the values can be any valid Ruby object.  The order of the keys
+matters.  When the regex sieve is accessed using the array accessor
+[], it returns the first matching record.
+
+````ruby
+sieve = RegexSieve.new({
+  /(Invincible|Born & Raised) IPA/ => 'Craft IPA',
+  /(Fresh Squeezed) IPA/           => 'Microbrew IPA',
+  /IPA/                            => 'Other IPA'
+})
+
+sieve['Invincible IPA'] # => 'Craft IPA'
+sieve['Awesome IPA']    # => 'Other IPA'
+sieve['Kinda Pale Ale'] # => nil
+````
+
+By default, only the values are returned, but the key and all matching
+capture groups can optionally be returned.
+
+````ruby
+result_and_match = sieve['Invincible IPA', :match]   # => {:value=>"Craft IPA", :match=>#<MatchData "Invincible IPA" 1:"Invincible">}
+result_and_match[:match][1]                          # => 'Invincible'
+
+result_and_key = sieve['Invincible IPA', :regex]     # => {:value=>"Craft IPA", :regex=>/(Invincible|Born & Raised) IPA/}
+
+result_all = sieve['Invincible IPA', :regex, :match] # => {:value=>"Craft IPA", :regex=>/(Invincible|Born & Raised) IPA/, :match=>#<MatchData "Invincible IPA" 1:"Invincible">}
+````

data/lib/regex_sieve.rb

@@ -0,0 +1,53 @@
+# Public: RegexSieve class.  The RegexSieve functions in a manner similar
+# a hash.  The regex sieve is initialized with a hash where the keys are
+# regular expressions and the values can be any valid Ruby object.  The order
+# of the keys matters.  When the regex sieve is accessed using the array
+# accessor [], it returns the first matching record.  By default, only
+# the values are returned, but the key and all matching capture groups
+# can optionally be returned.
+#
+# Examples:
+#
+#   r = RegexSieve.new({
+#     /something/ => 'Something',
+#     /something else/ => 'This will never get matched because the one above will match first',
+#     /cool$/ => 'Cool',
+#     /cool beans/ => 'Really Cool'
+#   })
+#
+#   r['something else'] # => 'Something'
+#   r['cool beans'] # => 'Really Cool'
+class RegexSieve
+  def initialize(sieve)
+    @sieve = sieve
+  end
+
+  # Public: Array accessor for Regex Sieve.
+  #
+  # key - The string that will be matched to the keys in the sieve.
+  # opt - By default, only the values in the hash used to initialize the sieve
+  #       will be returned.  However, if you want to return the keys or the
+  #       capture groups then use :regex, :match, or both, respectively.
+  #
+  # Example:
+  #   r['something'] # => 'Something
+  #   r['something', :regex] # => { value: 'Something', regex: /something/ }
+  #   r['sometinng', :match, :regex] # => { value: 'Something', regex: /something/, match: #<MatchData "something"> }
+  def [](key, *opt)
+    opt = opt | [:value]
+
+    regex_match = nil
+    found = @sieve.find do |regex, v|
+      regex_match = regex.match(key)
+    end
+
+    full_result = if found.nil?
+      { value: nil, regex: nil, match: nil }
+    else
+      { value: found[1], regex: found[0], match: regex_match }
+    end
+
+    full_result.select! { |k, v| opt.include?(k) }
+    full_result.size > 1 ? full_result : full_result.values.first
+  end
+end

data/lib/regex_sieve/version.rb

@@ -0,0 +1,3 @@
+class RegexSieve
+  VERSION = '0.1.0'
+end

data/regex_sieve.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 mode: ruby -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "regex_sieve/version"
+
+Gem::Specification.new do |s|
+  s.name        = "regex_sieve"
+  s.version     = RegexSieve::VERSION
+  s.authors     = ["Sterling Paramore"]
+  s.email       = ["gnilrets@gmail.com"]
+  s.homepage    = "https://github.com/gnilrets/regex_sieve"
+  s.license     = "MIT"
+  s.summary     = "Regex Sieve"
+  s.description = "A simple lookup sieve using regular expressions"
+
+  s.rubyforge_project = "RegexSieve"
+
+  s.add_development_dependency "rspec", ["~> 3.3"]
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/spec/regex_sieve_spec.rb

@@ -0,0 +1,40 @@
+$LOAD_PATH << '../lib'
+require 'regex_sieve'
+
+describe RegexSieve do
+    before do
+      @sieve = RegexSieve.new({
+        /(Invincible|Born & Raised) IPA/ => 'Craft IPA',
+        /(Fresh Squeezed) IPA/           => 'Microbrew IPA',
+        /IPA/                            => 'Other IPA'
+      })
+    end
+
+  describe 'looking up a value' do
+    it 'returns the value of the first match' do
+      expect(@sieve['Invincible IPA']).to eq 'Craft IPA'
+    end
+
+    it 'is not just a hash lookup' do
+      expect(@sieve['Random IPA']).to eq 'Other IPA'
+    end
+
+    it 'returns nil if no match is found' do
+      expect(@sieve['Does not match']).to be nil
+    end
+  end
+
+  describe 'using matching groups' do
+    it 'returns the match groups when specified' do
+      match = @sieve['Invincible IPA', :match][:match][1]
+      expect(match).to eq 'Invincible'
+    end
+  end
+
+  describe 'using regex and matching groups' do
+    it 'returns the matched regex when specified' do
+      regex = @sieve['Invincible IPA', :regex, :match][:regex]
+      expect(regex).to eq /(Invincible|Born & Raised) IPA/
+    end
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: regex_sieve
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sterling Paramore
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: A simple lookup sieve using regular expressions
+email:
+- gnilrets@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- lib/regex_sieve.rb
+- lib/regex_sieve/version.rb
+- regex_sieve.gemspec
+- spec/regex_sieve_spec.rb
+homepage: https://github.com/gnilrets/regex_sieve
+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: RegexSieve
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Regex Sieve
+test_files:
+- spec/regex_sieve_spec.rb