mustermann-shell 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 70b7a9e2e10df85b4f20be29bf3ef41935a2a73b
+  data.tar.gz: 047921a376ba9ae7317abee42b1044203b3acc6e
+SHA512:
+  metadata.gz: 5f62850ed4adfa6e90b205c249a7790e2ef0fa4bdf43fe7e0bca7c8d88e4a1f8ad3180fd350866ddcbc2c951ed1e5149d098d1e01435867b5ba7fbadc412ddf3
+  data.tar.gz: 1ec90f73ab2938ea02a07b7eb5dc047e20b474e1392a3aa1f1228dc2a42b8d659a7409fcee116a46624291a87791f282d07b60e62ee04803c5f4c31181ba46dc

data/README.md

@@ -0,0 +1,63 @@
+# Shell Syntax for Mustermann
+
+This gem implements the `rails` pattern type for Mustermann. It is compatible with common Unix shells (like bash or zsh).
+
+## Overview
+
+**Supported options:** `uri_decode` and `ignore_unknown_options`.
+
+**External documentation:** [Ruby's fnmatch](http://www.ruby-doc.org/core-2.1.4/File.html#method-c-fnmatch), [Wikipedia: Glob (programming)](http://en.wikipedia.org/wiki/Glob_(programming))
+
+``` ruby
+require 'mustermann'
+
+pattern = Mustermann.new('/*', type: :shell)
+pattern === "/foo.bar" # => true
+pattern === "/foo/bar" # => false
+
+pattern = Mustermann.new('/**/*', type: :shell)
+pattern === "/foo.bar" # => true
+pattern === "/foo/bar" # => true
+
+pattern = Mustermann.new('/{foo,bar}', type: :shell)
+pattern === "/foo"     # => true
+pattern === "/bar"     # => true
+pattern === "/baz"     # => false
+```
+
+## Syntax
+
+<table>
+  <thead>
+    <tr>
+      <th>Syntax Element</th>
+      <th>Description</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td><b>*</b></td>
+      <td>Matches anything but a slash.</td>
+    </tr>
+    <tr>
+      <td><b>**</b></td>
+      <td>Matches anything.</td>
+    </tr>
+    <tr>
+      <td><b>[</b><i>set</i><b>]</b></td>
+      <td>Matches one character in <i>set</i>.</td>
+    </tr>
+    <tr>
+      <td><b>&#123;</b><i>a</i>,<i>b</i><b>&#125;</b></td>
+      <td>Matches <i>a</i> or <i>b</i>.</td>
+    </tr>
+    <tr>
+      <td><b>\</b><i>x</i></td>
+      <td>Matches <i>x</i> or URI encoded version of <i>x</i>. For instance <tt>\*</tt> matches <tt>*</tt>.</td>
+    </tr>
+    <tr>
+      <td><i>any other character</i></td>
+      <td>Matches exactly that character or a URI encoded version of it.</td>
+    </tr>
+  </tbody>
+</table>

data/lib/mustermann/shell.rb

@@ -0,0 +1,55 @@
+require 'mustermann'
+require 'mustermann/pattern'
+require 'mustermann/simple_match'
+
+module Mustermann
+  # Matches strings that are identical to the pattern.
+  #
+  # @example
+  #   Mustermann.new('/*.*', type: :shell) === '/bar' # => false
+  #
+  # @see Mustermann::Pattern
+  # @see file:README.md#shell Syntax description in the README
+  class Shell < Pattern
+    register :shell
+
+    # @!visibility private
+    # @return [#highlight, nil]
+    #   highlighing logic for mustermann-visualizer,
+    #   nil if mustermann-visualizer hasn't been loaded
+    def highlighter
+      return unless defined? Mustermann::Visualizer::Highlighter
+      @@highlighter ||= Mustermann::Visualizer::Highlighter.create do
+        on('\\') { |matched| escaped(matched, scanner.getch) }
+        on(/[\*\[\]]/, :special)
+        on("{") { nested(:union, ?{, ?}, ?,) }
+      end
+    end
+
+    # @param (see Mustermann::Pattern#initialize)
+    # @return (see Mustermann::Pattern#initialize)
+    # @see (see Mustermann::Pattern#initialize)
+    def initialize(string, **options)
+      @flags = File::FNM_PATHNAME | File::FNM_DOTMATCH | File::FNM_EXTGLOB
+      super(string, **options)
+    end
+
+    # @param (see Mustermann::Pattern#===)
+    # @return (see Mustermann::Pattern#===)
+    # @see (see Mustermann::Pattern#===)
+    def ===(string)
+      File.fnmatch? @string, unescape(string), @flags
+    end
+
+    # @param (see Mustermann::Pattern#peek_size)
+    # @return (see Mustermann::Pattern#peek_size)
+    # @see (see Mustermann::Pattern#peek_size)
+    def peek_size(string)
+      @peek_string ||= @string + "{**,/**,/**/*}"
+      super if File.fnmatch? @peek_string, unescape(string), @flags
+    end
+
+    # Used by {Mustermann::FileUtils} to not use a generic glob pattern.
+    alias_method :to_glob, :to_s
+  end
+end

data/mustermann-shell.gemspec

@@ -0,0 +1,18 @@
+$:.unshift File.expand_path("../../mustermann/lib", __FILE__)
+require "mustermann/version"
+
+Gem::Specification.new do |s|
+  s.name                  = "mustermann-shell"
+  s.version               = Mustermann::VERSION
+  s.author                = "Konstantin Haase"
+  s.email                 = "konstantin.mailinglists@googlemail.com"
+  s.homepage              = "https://github.com/rkh/mustermann"
+  s.summary               = %q{Shell syntax for Mustermann}
+  s.description           = %q{Adds Shell style patterns to Mustermman}
+  s.license               = 'MIT'
+  s.required_ruby_version = '>= 2.1.0'
+  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.add_dependency 'mustermann', Mustermann::VERSION
+end

data/spec/shell_spec.rb

@@ -0,0 +1,147 @@
+require 'support'
+require 'mustermann/shell'
+
+describe Mustermann::Shell do
+  extend Support::Pattern
+
+  pattern '' do
+    it { should     match('')  }
+    it { should_not match('/') }
+
+    it { should_not respond_to(:expand)       }
+    it { should_not respond_to(:to_templates) }
+  end
+
+  pattern '/' do
+    it { should     match('/')    }
+    it { should_not match('/foo') }
+
+    example { pattern.params('/').should be == {} }
+    example { pattern.params('').should be_nil }
+  end
+
+  pattern '/foo' do
+    it { should     match('/foo')     }
+    it { should_not match('/bar')     }
+    it { should_not match('/foo.bar') }
+  end
+
+  pattern '/foo/bar' do
+    it { should match('/foo/bar')   }
+    it { should match('/foo%2Fbar') }
+    it { should match('/foo%2fbar') }
+  end
+
+  pattern '/*/bar' do
+    it { should     match('/foo/bar')     }
+    it { should     match('/bar/bar')     }
+    it { should     match('/foo%2Fbar')   }
+    it { should     match('/foo%2fbar')   }
+    it { should_not match('/foo/foo/bar') }
+    it { should_not match('/bar/foo')     }
+  end
+
+  pattern '/**/foo' do
+    it { should match('/a/b/c/foo')   }
+    it { should match('/a/b/c/foo')   }
+    it { should match('/a/.b/c/foo')  }
+    it { should match('/a/.b/c/foo')  }
+  end
+
+  pattern '/:foo' do
+    it { should     match('/:foo')    }
+    it { should     match('/%3Afoo')  }
+    it { should_not match('/foo')     }
+    it { should_not match('/foo?')    }
+    it { should_not match('/foo/bar') }
+    it { should_not match('/')        }
+    it { should_not match('/foo/')    }
+  end
+
+  pattern '/föö' do
+    it { should match("/f%C3%B6%C3%B6") }
+  end
+
+  pattern '/test$/' do
+    it { should match('/test$/') }
+  end
+
+  pattern '/te+st/' do
+    it { should     match('/te+st/') }
+    it { should_not match('/test/')  }
+    it { should_not match('/teest/') }
+  end
+
+  pattern "/path with spaces" do
+    it { should     match('/path%20with%20spaces') }
+    it { should_not match('/path%2Bwith%2Bspaces') }
+    it { should_not match('/path+with+spaces')     }
+  end
+
+  pattern '/foo&bar' do
+    it { should match('/foo&bar') }
+  end
+
+  pattern '/test.bar' do
+    it { should     match('/test.bar') }
+    it { should_not match('/test0bar') }
+  end
+
+  pattern '/{foo,bar}' do
+    it { should     match('/foo')    }
+    it { should     match('/bar')    }
+    it { should_not match('/foobar') }
+  end
+
+  pattern '/foo/bar', uri_decode: false do
+    it { should     match('/foo/bar')   }
+    it { should_not match('/foo%2Fbar') }
+    it { should_not match('/foo%2fbar') }
+  end
+
+  pattern "/path with spaces", uri_decode: false do
+    it { should_not match('/path%20with%20spaces') }
+    it { should_not match('/path%2Bwith%2Bspaces') }
+    it { should_not match('/path+with+spaces')     }
+  end
+
+  describe :=~ do
+    example { '/foo'.should be =~ Mustermann::Shell.new('/foo') }
+  end
+
+  context "peeking" do
+    subject(:pattern) { Mustermann::Shell.new("foo*/") }
+
+    describe :peek_size do
+      example { pattern.peek_size("foo bar/blah")   .should be == "foo bar/".size }
+      example { pattern.peek_size("foo%20bar/blah") .should be == "foo%20bar/".size }
+      example { pattern.peek_size("/foo bar")       .should be_nil }
+
+      context 'with just * as pattern' do
+        subject(:pattern) { Mustermann::Shell.new('*') }
+        example { pattern.peek_size('foo')              .should be == 3 }
+        example { pattern.peek_size('foo/bar')          .should be == 3 }
+        example { pattern.peek_size('foo/bar/baz')      .should be == 3 }
+        example { pattern.peek_size('foo/bar/baz/blah') .should be == 3 }
+      end
+    end
+
+    describe :peek_match do
+      example { pattern.peek_match("foo bar/blah")   .to_s .should be == "foo bar/" }
+      example { pattern.peek_match("foo%20bar/blah") .to_s .should be == "foo%20bar/" }
+      example { pattern.peek_match("/foo bar")             .should be_nil }
+    end
+
+    describe :peek_params do
+      example { pattern.peek_params("foo bar/blah")   .should be == [{}, "foo bar/".size] }
+      example { pattern.peek_params("foo%20bar/blah") .should be == [{}, "foo%20bar/".size] }
+      example { pattern.peek_params("/foo bar")       .should be_nil }
+    end
+  end
+
+  context "highlighting" do
+    let(:pattern) { Mustermann::Shell.new("/**,*/\\*/{a,b}") }
+    subject(:sexp) { Mustermann::Visualizer.highlight(pattern).to_sexp }
+    it { should be == '(root (separator /) (special *) (special *) (char ,) (special *) (separator /) (escaped "\\\\" (escaped_char *)) (separator /) (union { (root (char a)) ,(root (char b)) }))' }
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: mustermann-shell
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Konstantin Haase
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mustermann
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+description: Adds Shell style patterns to Mustermman
+email: konstantin.mailinglists@googlemail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/mustermann/shell.rb
+- mustermann-shell.gemspec
+- spec/shell_spec.rb
+homepage: https://github.com/rkh/mustermann
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Shell syntax for Mustermann
+test_files:
+- spec/shell_spec.rb
+has_rdoc: