parsey 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,23 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+.yardoc/
+doc/

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Joshua Hawxwell
+
+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.markdown

@@ -0,0 +1,25 @@
+# parsey
+
+Parsey is a very simple class to match a string with a pattern and retrieve data from it.
+It takes a string, a pattern, and a hash of regexes. The pattern is filled with the regexes
+and then that is matched to the string given.
+
+The pattern uses {} to surround the name of the regex it should be replaced with. You can
+also use <> to surround parts of the pattern that are optional, though these obviously
+must be nested properly.
+
+## Example
+
+    partials = {'folder'    => '([a-zA-Z0-9-]+)', 
+               'file-name' => '([a-zA-Z0-9_ -]+)', 
+               'ext'       => '(txt|jpg|png)'}
+    
+    Parsey.parse('my-folder/my file.txt', '{folder}/{file-name}.{ext}', partials)
+     #=> {"folder"=>"my-folder", "file-name"=>"my file", "ext"=>"txt"}
+    
+    Parsey.parse('my file.txt', '<{folder}/>{file-name}.{ext}', partials)
+     #=> {"folder"=>nil, "file-name"=>"my file", "ext"=>"txt"}
+
+## Copyright
+
+Copyright (c) 2010 Joshua Hawxwell. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "parsey"
+    gem.summary = %Q{Parsey matches strings to patterns}
+    gem.description = %Q{Parsey matches a string with a pattern to retrieve data from it.}
+    gem.email = "m@hawx.me"
+    gem.homepage = "http://github.com/hawx/parsey"
+    gem.authors = ["Joshua Hawxwell"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    gem.add_development_dependency "yard", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/parsey.rb

@@ -0,0 +1,130 @@
+# Parsey is a very simple class to match a string with a pattern and retrieve data from it.
+# It takes a string, a pattern, and a hash of regexes. The pattern is filled with the regexes
+# and then that is matched to the string given.
+#
+# The pattern uses {} to surround the name of the regex it should be replaced with. You can
+# also use <> to surround parts of the pattern that are optional, though these obviously
+# must be nested properly.
+#
+# @example
+#
+#   partials = {'folder'    => '([a-zA-Z0-9-]+)', 
+#               'file-name' => '([a-zA-Z0-9_ -]+)', 
+#               'ext'       => '(txt|jpg|png)'}
+#
+#   Parsey.parse('my-folder/my file.txt', '{folder}/{file-name}.{ext}', partials)
+#     #=> {"folder"=>"my-folder", "file-name"=>"my file", "ext"=>"txt"}
+#
+#   Parsey.parse('my file.txt', '<{folder}/>{file-name}.{ext}', partials)
+#     #=> {"folder"=>nil, "file-name"=>"my file", "ext"=>"txt"}
+#
+class Parsey
+
+  attr_accessor :to_parse, :pattern, :partials, :data
+  
+  # Creates a new Parsey instance.
+  #
+  # @param [String] to_parse 
+  #   the string which is to be parsed
+  # @param [String] pattern 
+  #   for the string to match
+  # @param [Hash{String => String}] partials
+  #   the regex patterns (as strings) to use when matching
+  #
+  def initialize(to_parse, pattern, partials)
+    @to_parse = to_parse
+    @pattern  = pattern
+    @partials = partials
+
+    @data = {}
+  end
+  
+  # Runs through +pattern+ and replaces each of the keywords with the
+  # correct regex from +partials+. It then adds '()?' round any parts of
+  # the pattern marked optional. And turns the final string into a regex.
+  #
+  # @return [Regex] 
+  #   the regular expression to match against when parsing
+  #
+  def regex
+    m = @pattern.gsub(/\{([a-z-]+)\}/) do
+      @partials[$1]
+    end
+    
+    # replace optional '<stuff>'
+    m.gsub!(/<(.+)>/) do
+      "(#{$1})?"
+    end
+    
+    Regexp.new(m)
+  end
+  
+  # Gets the order of the different tags within the pattern. It inserts nil
+  # when it encounters an optional section so that it can easily be skipped
+  # during parsing.
+  #
+  # @return [Array]
+  #   the order in which the tags appear in the +pattern+
+  #
+  def order
+    if @pattern =~ /<(.+)>/
+      parts = @pattern.dup.split('<')
+      parts.insert(1, nil)
+      parts.collect! {|i| 
+        i.split('>') unless i.nil?
+      }.flatten!
+      
+      parts.collect! {|i| 
+        i.split('}') unless i.nil?
+      }.flatten!
+      
+      parts.collect! {|i|
+        i.gsub!(/[^a-zA-Z0-9]/, '') unless i.nil?
+      }
+      
+      parts.delete_if {|i| i == ''}
+      
+      return parts
+    else
+      parts = []
+      @pattern.gsub(/\{([a-z-]+)\}/) do
+        parts << $1
+      end
+      return parts
+    end
+  end
+  
+  # This does the parsing of +to_parse+ using +regex+. It fills the hash
+  # +data+ using +order+ to match the data up with the correct name.
+  #
+  # @return [Hash{String => String}] 
+  #   the data retrieved from +to_parse+
+  #
+  def parse
+    @to_parse.match( self.regex ).captures.each_with_index do |item, i|
+      unless self.order[i].nil?
+        @data[ self.order[i] ] = item
+      end
+    end
+    @data
+  end
+  
+  # This is a convenience method to allow you to easily parse something
+  # in just one go!
+  #
+  # @param [String] to_parse 
+  #   the string which is to be parsed
+  # @param [String] pattern 
+  #   for the string to match
+  # @param [Hash{String => String}] partials
+  #   the regex patterns (as strings) to use when matching
+  #
+  # @return [Hash{String => String}]
+  #   the data retrieved from +to_parse+
+  #
+  def self.parse(to_parse, pattern, partials)
+    a = Parsey.new(to_parse, pattern, partials)
+    a.parse
+  end
+  
+end

data/parsey.gemspec

@@ -0,0 +1,57 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{parsey}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Joshua Hawxwell"]
+  s.date = %q{2010-07-15}
+  s.description = %q{Parsey matches a string with a pattern to retrieve data from it.}
+  s.email = %q{m@hawx.me}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "lib/parsey.rb",
+     "parsey.gemspec",
+     "test/helper.rb",
+     "test/test_parsey.rb"
+  ]
+  s.homepage = %q{http://github.com/hawx/parsey}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Parsey matches strings to patterns}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_parsey.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_dependency(%q<yard>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    s.add_dependency(%q<yard>, [">= 0"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'parsey'
+
+class Test::Unit::TestCase
+end

data/test/test_parsey.rb

@@ -0,0 +1,36 @@
+require 'helper'
+
+class TestParsey < Test::Unit::TestCase
+
+  should "construct correct regular expression" do
+    partials = {'test' => 'hello', 'something' => 'world'}
+    t = Parsey.new('', '{test}|{something}', partials) 
+    assert_equal %r{hello|world}, t.regex 
+  end
+  
+  should "allow optional part of pattern" do
+    partials = {'folder' => 'f', 'name' => 'n', 'ext' => 'e'}
+    t = Parsey.new('', '<{folder}>/{name}.{ext}', partials)
+    assert_equal Regexp.new("(f)?\/n.e"), t.regex
+  end
+  
+  should "create correct order" do
+    partials = {'folder' => 'f', 'name' => 'n', 'ext' => 'e'}
+    t = Parsey.new('', '<{folder}/>{name}.{ext}', partials)
+    assert_equal [nil, 'folder', 'name', 'ext'], t.order
+  end
+  
+  should "create correct order when optional is in the middle" do
+    partials = {'folder' => 'folder', 'name' => 'name', 'ext' => 'ext'}
+    t = Parsey.new('', '{folder}/<{name}>.{ext}', partials)
+    assert_equal ['folder', nil, 'name', 'ext'], t.order
+  end
+  
+  should "parse properly" do
+    partials = {'test' => '([a-z]+)', 'something' => '([a-z]+)'}
+    t = Parsey.new('something:what', '{test}:{something}', partials)
+    hash = {'test' => 'something', 'something' => 'what'}
+    assert_equal hash, t.parse
+  end
+  
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification 
+name: parsey
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Joshua Hawxwell
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-15 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Parsey matches a string with a pattern to retrieve data from it.
+email: m@hawx.me
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- lib/parsey.rb
+- parsey.gemspec
+- test/helper.rb
+- test/test_parsey.rb
+has_rdoc: true
+homepage: http://github.com/hawx/parsey
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.3.7
+signing_key: 
+specification_version: 3
+summary: Parsey matches strings to patterns
+test_files: 
+- test/helper.rb
+- test/test_parsey.rb