rbnf 0.0.2 → 0.0.3

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2012 Feivel Jellyfish
+
+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,41 @@
+RBNF
+----
+RBNF is an Extended Backus-Naur Form implementation for Ruby.
+
+Installation
+============
+```shell
+  gem install rbnf
+```
+
+Usage
+=====
+```ruby
+  form  = RBNF[?a] / ?b / ?c         #=> '"a" | "b" | "c"'
+  form2 = RBNF[?a].cat('b').alt('c') #=> '( "a" , "b" ) | "c"'
+```
+RBNF objects can be used to perform regex-like matches on strings. The first form will match the same strings as /[abc]/ :
+```ruby
+  form =~ 'a'  #=> true
+  form =~ 'b'  #=> true
+  form =~ 'd'  #=> false
+  form =~ 'ab' #=> false
+```
+RBNFs can also accomplish matches that regexes can't:
+
+```ruby
+  RBNF.define :parens do
+    RBNF[?(] + RBNF.parens.opt + ?)
+  end
+
+  RBNF.parens =~ '()'    #=> true
+  RBNF.parens =~ '(())'  #=> true
+  RBNF.parens =~ '(()))' #=> false
+
+```
+RBNF objects memoize matches, but otherwise make no attempt at optimizing for performance.
+
+License
+=======
+X11. See LICENSE for details.
+

data/Rakefile

@@ -1,7 +1,8 @@
 $LOAD_PATH << File.expand_path('../lib', __FILE__)
 require 'rake'
-require 'graham/rake_task'
+require 'lax'
+require 'rbnf'
 
-Graham::RakeTask.new
+Lax::RakeTask.new
 task default: :test
 

data/lib/rbnf.rb

@@ -1,36 +1,45 @@
 require 'rbnf/version'
 require 'rbnf/nodes'
 module RBNF
+  # Namespace for defined forms.
   DEFS = {}
 
+  # [ "a" ]
   def opt
     Opt.new self
   end
 
+  # "a" , "b"
   def cat(f)
     Cat.new self, ebnify(f)
   end
 
+  # "a" | "b"
   def alt(f)
     Alt.new self, ebnify(f)
   end
 
+  # a - "b"
   def except(f)
     Except.new self, ebnify(f)
   end
 
+  # { "a" }
   def rep
     Rep.new self
   end
 
+  # b * "a"
   def rep_n(n)
     RepN.new self, n
   end
 
+  # ( "a" )
   def group
     Group.new self
   end
 
+  # String match with memoization.
   def =~(s)
     @memo.has_key?(s) ? @memo[s] : (@memo[s] = match s)
   end
@@ -66,7 +75,7 @@ module RBNF
     # the contents of the block. Note that this method can't handle recursive
     # form definition; use ::define for that instead.
     def def(name)
-      DEFS[name] = Def.new(name, yield)
+      DEFS[name] = Def.new name, yield
     end
 
     # Takes a symbol <name> and a block and defines a new form <name> to be

data/lib/rbnf/nodes.rb

@@ -1,5 +1,6 @@
 module RBNF
   
+  # Unary AST node
   class Unary
     include RBNF
     attr_reader :a
@@ -8,6 +9,7 @@ module RBNF
     end
   end
 
+  # Binary AST node
   class Binary
     include RBNF
     attr_reader :a,:b
@@ -16,6 +18,7 @@ module RBNF
     end
   end
 
+  # Alternation node
   class Alt < Binary
     def to_s
       "#{a} | #{b}"
@@ -29,6 +32,7 @@ module RBNF
     end
   end
 
+  # Node that encapsulates a defined (with RBNF::def or ::define) form.
   class Def < Binary
     def to_s
       "#{a}"
@@ -38,6 +42,7 @@ module RBNF
     end
   end
 
+  # Catenation node
   class Cat < Binary
     def to_s
       "#{a} , #{b}"
@@ -47,6 +52,7 @@ module RBNF
     end
   end
 
+  # Optation node
   class Opt < Unary
     def to_s
       "[ #{a} ]"
@@ -56,6 +62,8 @@ module RBNF
     end
   end
 
+  # Grouping node. Semantically identical to its child, but greatly simplifies
+  # stringification.
   class Group < Unary
     def to_s
       "( #{a} )"
@@ -65,6 +73,7 @@ module RBNF
     end
   end
 
+  # Exception node
   class Except < Binary
     def to_s
       "( #{a} - #{b} )"
@@ -74,6 +83,7 @@ module RBNF
     end
   end
 
+  # Repetition (0 or more times) node
   class Rep < Unary
     def to_s
       "{ #{a} }"
@@ -83,6 +93,7 @@ module RBNF
     end
   end
 
+  # Repetition (n times) node
   class RepN < Binary
     def to_s
       "#{b} * #{a}"
@@ -98,6 +109,7 @@ module RBNF
     end
   end
 
+  # Terminal node
   class Term < Unary
     def to_s
       "\"#{a}\""

data/lib/rbnf/version.rb

@@ -1,3 +1,3 @@
 module RBNF
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/rbnf.gemspec

@@ -7,11 +7,12 @@ Gem::Specification.new do |spec|
   spec.version     = RBNF::VERSION
   spec.author      = 'feivel jellyfish'
   spec.email       = 'feivel@sdf.org'
-  spec.files       = FileList['rbnf.gemspec','lib/**/*.rb']
+  spec.files       = FileList['rbnf.gemspec','lib/**/*.rb','README.md','LICENSE']
   spec.test_files  = FileList['Rakefile','test/**/*.rb']
-  spec.homepage    = 'http://github.com/gwentacle/ebnf'
+  spec.homepage    = 'http://github.com/gwentacle/rbnf'
   spec.summary     = 'Extended Backus-Naur Form implementation for Ruby'
   spec.description = 'Extended Backus-Naur Form implementation for Ruby'
-  spec.add_development_dependency 'graham', '>=0.0.3'
+  spec.license     = 'MIT/X11'
+  spec.add_development_dependency 'lax', '>=0.0.1'
 end
 

data/test/case/defs.rb

@@ -1,5 +1,3 @@
-require 'rbnf'
-
 class DefTests
   def simple_definition
     RBNF.def :abc do
@@ -14,18 +12,20 @@ class DefTests
     RBNF.parens
   end
 end
-Graham.pp(DefTests.new) do |that|
-  that.recursive_definition.is_such_that {
-    %w{() (())}.all?  {|s| match s} and
-    %w{( ) (()}.none? {|s| match s}}
 
-  that.simple_definition.is_such_that {
+Lax.test(DefTests.new) {|assert|
+  assert.calling(:recursive_definition).satisfies {|defn|
+    %w{() (())}.all?  {|s| defn=~s} and
+    %w{( ) (()}.none? {|s| defn=~s}
+  }
+  assert.calling(:simple_definition).satisfies {|defn|
     (0..5).all? do |n|
       %w{a b c}.permutation(n).all? do |p|
         s = p.join
-        !!(s=~/[abc]*/) == match(s)
+        !!(s=~/[abc]*/) == defn.match(s)
       end
     end
   }
-end
+
+}
 

data/test/case/matches.rb

@@ -1,9 +1,3 @@
-class MatchTests
-  def a_long_match
-    +(RBNF[?a]*3)+?g =~ 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaag'
-  end
-end
-
-Graham.pp(MatchTests.new) do |that|
-  that.a_long_match.is true
-end
+Lax.test(+(RBNF[?a]*3)+?g =~ 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaag') {|that|
+  that.it.returns true
+}

data/test/case/repetition.rb

@@ -1,4 +1,3 @@
-require 'rbnf'
 class Repetition
   def a_binary_repetition
     RBNF[?A]*3+?G
@@ -17,19 +16,17 @@ class Repetition
   end
 end
 
-Graham.pp(Repetition.new) do |that|
-  that.a_binary_repetition.is_such_that {
-    match('AAAG') and
-    [?g,'AG','AAAAAAG'].none?  {|s| match s}}
+Lax.test(Repetition.new) {|that|
+  that.calling(:a_binary_repetition).satisfies {|rep|
+    rep =~ 'AAAG' and 
+    [?g,'AG','AAAAAAG'].none?  {|s| rep=~s}
+  }
+  that.calling(:a_unary_repetition).satisfies {|rep|
+    ['','xyz','xyzxyz'].all? {|s| rep.match s} and
+    [?x,?y,?z,'zyx'].none? {|s| rep.match s}
+  }
+  that.calling(:binary_repetition_zero_times).satisfies {|rep|
+    rep=~'' and !rep.match('q')
+  }
+}
 
-  that.a_unary_repetition.is_such_that {
-    ['','xyz','xyzxyz'].all? {|s| match s} and
-    [?x,?y,?z,'zyx'].none? {|s| match s}}
-
-  that.binary_repetition_one_time.is_such_that {
-    match('q') and !match('') and !match('qq')}
-
-  that.binary_repetition_zero_times.is_such_that {
-    match('') and !match('q') }
-
-end

data/test/case/stringification.rb

@@ -54,17 +54,18 @@ class StringTests
 
 end
 
-Graham.pp(StringTests.new) do |that|
-  that.a_definition.returns 'symbol'
-  that.terminal_string.is '"string"'
-  that.optation.returns '[ "string" ]'
-  that.unary_repetition.returns '{ "string" }'
-  that.binary_repetition.returns '3 * "string"'
-  that.nested_repetition.returns '3 * { "string" }'
-  that.alternation_and_catenation.returns '"string" | "opt" , "string" | "cat"'
-  that.multiple_catenation.returns '"string" , "char" , "list"'
-  that.multiple_alternation.returns '"string" | "char" | "list"'
-  that.exception.returns '( "string" | "integer" - "float" )'
-  that.grouping.returns '( "string" | "string" )'
-  that.implicit_grouping.returns '( "string" , "string" ) | "string"'
-end
+Lax.test(StringTests.new) {|_|
+  _.calling(:a_definition).returns 'symbol'
+  _.calling(:terminal_string).returns '"string"'
+  _.calling(:optation).returns '[ "string" ]'
+  _.calling(:unary_repetition).returns '{ "string" }'
+  _.calling(:binary_repetition).returns '3 * "string"'
+  _.calling(:nested_repetition).returns '3 * { "string" }'
+  _.calling(:alternation_and_catenation).returns '"string" | "opt" , "string" | "cat"'
+  _.calling(:multiple_catenation).returns '"string" , "char" , "list"'
+  _.calling(:multiple_alternation).returns '"string" | "char" | "list"'
+  _.calling(:exception).returns '( "string" | "integer" - "float" )'
+  _.calling(:grouping).returns '( "string" | "string" )'
+  _.calling(:implicit_grouping).returns '( "string" , "string" ) | "string"'
+}
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rbnf
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,16 +9,16 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-29 00:00:00.000000000 Z
+date: 2012-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: graham
+  name: lax
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.0.3
+        version: 0.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.0.3
+        version: 0.0.1
 description: Extended Backus-Naur Form implementation for Ruby
 email: feivel@sdf.org
 executables: []
@@ -37,13 +37,16 @@ files:
 - lib/rbnf.rb
 - lib/rbnf/version.rb
 - lib/rbnf/nodes.rb
+- README.md
+- LICENSE
 - Rakefile
 - test/case/defs.rb
 - test/case/matches.rb
 - test/case/repetition.rb
 - test/case/stringification.rb
-homepage: http://github.com/gwentacle/ebnf
-licenses: []
+homepage: http://github.com/gwentacle/rbnf
+licenses:
+- MIT/X11
 post_install_message: 
 rdoc_options: []
 require_paths: