swissparser 0.9.0 → 0.10.0

data/.gitignore

@@ -4,5 +4,6 @@
 *.gemspec
 announcement.txt
 
+coverage/
 doc/
 pkg/

data/CHANGELOG.rdoc

@@ -1,3 +1,14 @@
+== 0.10.0 / 2009-11-14
+
+* 1 new feature:
+  - SwissParser can now parse an input string or whatever input responding to the +each_line+ method
+
+* 1 bug fix:
+  - +with_text_after+ and +set_separator+ can now be properly replaced when extended.
+
+* Misc:
+  - First release with tests using cucumber 
+
 == 0.9.0 / 2009-11-14
 
 * 1 new feature:

data/Rakefile

@@ -7,8 +7,16 @@ end
 ensure_in_path 'lib'
 require 'swissparser'
 
-#task :default => 'test:run'
-#task 'gem:release' => 'test:run'
+require 'cucumber/rake/task'
+
+task :default => :features
+
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "--format pretty"
+  t.rcov = true
+end
+
+CLOBBER << "coverage/"
 
 Bones {
   name  'swissparser'
@@ -16,6 +24,7 @@ Bones {
   email  'paradigmatic@streum.org'
   url  'http://github.com/paradigmatic/SwissParser'
   version  Swiss::VERSION
+  gem.development_dependencies = [["cucumber", ">= 0.4"]]
   readme_file 'README.rdoc'
   history_file 'CHANGELOG.rdoc'
   ignore_file  '.gitignore'

data/examples/tutorial_1.rb

@@ -20,7 +20,7 @@ along with SwissParser.  If not, see <http://www.gnu.org/licenses/>.
 #!/usr/bin/ruby -w
 
 require 'yaml'
-require 'swissparser.rb'
+require 'swissparser'
 
 class Protein
 

data/examples/tutorial_2.rb

@@ -0,0 +1,65 @@
+=begin
+Copyright (C) 2009 Paradigmatic
+
+This file is part of SwissParser.
+
+SwissParser is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+SwissParser is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with SwissParser.  If not, see <http://www.gnu.org/licenses/>.
+=end
+
+#!/usr/bin/ruby -w
+
+require 'swissparser'
+require 'examples/tutorial_1'
+
+class Protein
+
+  attr_accessor :id, :size, :species, :taxonomy, :sequence
+
+  def initialize
+    @taxonomy = []
+    @sequence = ""
+  end
+
+end
+
+module Uniprot
+
+  SpeciesParser = Uniprot::Parser.extend do
+
+    before do 
+      {}
+    end
+
+    finish_entry do |protein, container|
+      if container[protein.species].nil?
+        container[protein.species] = []
+      end
+      container[protein.species] << protein
+    end
+
+  end
+  
+end
+  
+if $0 == __FILE__
+    
+  filename = ARGV.shift
+
+  result = Uniprot::SpeciesParser.parse_file( filename )
+
+  result.each do |species, ary|
+    puts "#{species} => #{ary.map{ |p| p.id }.join(', ')}"
+  end
+
+end

data/features/parser_extension.feature

@@ -0,0 +1,53 @@
+Feature: Parser Extension
+  I can extend existing parser
+  And replace existing rules
+
+  Background:
+   Given input data 
+     """
+     XX a1
+     YY b1
+     c1
+     //
+     XX a1
+     YY b2
+     c2
+     //
+     """
+ 
+  Scenario: Extension without redefinition
+    Given a simple parser
+    When I extend it
+    Then the extended parser should parse it as the original one
+
+  Scenario: With replacing separator
+    Given a simple parser
+    When I extend it
+      And I replace with("XX") to return always 'foo'
+      And I replace with("YY") to do nothing
+    Then the parser should return "[{ 'XX' => 'foo'}, { 'XX' => 'foo'}]"   
+ 
+  Scenario: Text after replacing
+    Given a simple parser
+    When I extend it
+      And I replace with("XX") to do nothing
+      And I replace with("YY") to return always 'bar'
+      And I replace with_text_after("YY") to return always 'foo'
+    Then the parser should return "[{ 'YY' => 'bar', 'txt-YY' => 'foo'}, { 'YY' => 'bar', 'txt-YY' => 'foo'}]" 
+
+  Scenario: 
+    Given a simple parser
+      And input data 
+        """
+        XX a1
+        YY b1
+        c1
+        %
+        XX a1
+        YY b2
+        c2
+        %
+        """
+     When I extend it
+       And I set the separator to '%'
+     Then the parser should return '2' entries

data/features/step_definitions/steps.rb

@@ -0,0 +1,103 @@
+require 'lib/swissparser'
+require 'spec/expectations'
+
+
+Given /^a simple parser$/ do
+  @simple_parser = Swiss::Parser.define do
+    rules do
+      with("XX") {|c,e| e["XX"] = c}
+      with("YY") {|c,e| e["YY"] = c}
+    end
+  end
+end
+
+Given /^input data$/ do |string|
+  @data = string
+end
+
+When /^I extend it$/ do
+  @ext_parser = @simple_parser.extend {}
+end
+
+When /^I replace with\("([^\"]*)"\) to return always '([^\']*)'$/ do |key,out|
+  @ext_parser = @ext_parser.extend do
+    rules do
+      with( key ) {|c,e| e[key] = out }
+    end
+  end
+end
+
+When /^I replace with\("([^\"]*)"\) to do nothing$/ do |key|
+  @ext_parser = @ext_parser.extend do 
+    rules do
+      with( key ) {|c,e| }
+    end
+  end
+end
+
+When /^I replace with_text_after\("([^\"]*)"\) to return always '([^\']*)'$/ do |key,out|
+  text_key = "txt-#{key}"
+  @ext_parser = @ext_parser.extend do 
+    rules do
+      with_text_after( key ) {|c,e| e[text_key] = out }
+    end
+  end
+end
+
+When /^I set the separator to '([^\']*)'$/ do |sep|
+  @ext_parser = @ext_parser.extend do 
+    rules do
+      set_separator( sep )
+    end
+  end
+end
+
+When /^I define '([^\']*)' helper$/ do |name|
+  @ext_parser = @ext_parser.extend do 
+    helper(name.to_sym) do
+      name
+    end
+  end
+end
+
+When /^I call '([^\']*)' helper in after action$/ do |name|
+  l = eval("lambda { |x| #{name} }")
+  @ext_parser = @ext_parser.extend do 
+    after(&l)
+  end
+end
+
+When /^I return param "([^\"]*)" in after action$/ do |name|
+  l = eval("lambda { |x| param(#{name}) }")
+  @ext_parser = @ext_parser.extend do 
+    after(&l)
+  end
+
+end
+
+When /^I call parse with param "([^\"]*)" equal to "([^\"]*)"$/ do |key, val|
+  @result = @ext_parser.parse(@data, key => val)
+end
+
+Then /^the result should be "([^\"]*)"$/ do |val|
+  @result.should == val
+end
+
+
+Then /^the parser should return '([^\']*)'$/ do |val|
+  @ext_parser.parse( @data ).should == val
+end
+
+Then /^the parser should return '(\d*)' entries$/ do |num|
+  @ext_parser.parse( @data  ).size.should == num.to_i
+end
+
+Then /^the extended parser should parse it as the original one$/ do
+  @simple_parser.parse( @data ).should == @ext_parser.parse( @data )
+end
+
+
+Then /^the parser should return "([^\"]*)"$/ do |ruby_exp|
+  result = eval(ruby_exp)
+  @ext_parser.parse( @data ).should == result
+end

data/features/user_friendly.feature

@@ -0,0 +1,29 @@
+Feature: User Friendly
+  SwissParser is nice to use.
+
+  Background:
+   Given input data 
+     """
+     XX a1
+     YY b1
+     c1
+     //
+     XX a1
+     YY b2
+     c2
+     //
+     """
+ 
+  Scenario: Helper Method
+    Given a simple parser
+    When I extend it
+      And I define 'foo' helper
+      And I call 'foo' helper in after action
+    Then the parser should return 'foo'
+
+  Scenario: Helper Method
+    Given a simple parser
+    When I extend it
+      And I return param "foo" in after action
+      And I call parse with param "foo" equal to "bar"
+    Then the result should be "bar"

data/lib/swissparser.rb

@@ -21,7 +21,7 @@ require 'open-uri'
 
 module Swiss
 
-  VERSION = "0.9.0"
+  VERSION = "0.10.0"
 
   # This class defines parsing rules. Its methods
   # are accessible within the +rules+ section of
@@ -186,14 +186,15 @@ module Swiss
           next
         end
         @actions[k] = v
-        r.actions[:text].each do |k,v|
-          @actions[:text][k] = v
-        end
-        if r.separator
-          @separator = r.separator
-        end
+      end
+      r.actions[:text].each do |k,v|
+        @actions[:text][k] = v
+      end
+      if r.separator
+        @separator = r.separator
       end
     end
+    
 
 
 
@@ -234,10 +235,14 @@ module Swiss
         parse( file, params )
       end
     end
-
-    private
     
-    def parse( file, params )
+    # Parses any input that accepts the +each_line+ method.  Works for
+    # string, open files, etc. An optional hash of arbitrary arguments
+    # (+params+) can be specified. It is passed to the workflow
+    # methods blocks (+before+, +new_entry+, ...)  It returns the
+    # value specified in the +after+ block. By default, it returns an
+    # array containing _entry_ objects.
+    def parse( data, params={} )
       @ctx = ParsingContext.new( params )
       helperModule = Module.new
       @helpers.each do |name, proc|
@@ -246,7 +251,7 @@ module Swiss
       @ctx.extend( helperModule )
       container = @ctx.instance_exec( &@before )
       entry = @ctx.instance_exec( &@begin )
-      file.each_line do |line|
+      data.each_line do |line|
         state = parse_line( line, entry )
         if state == :end
           @ctx.instance_exec( entry, container, &@end )
@@ -256,6 +261,8 @@ module Swiss
       @ctx.instance_exec( container, &@after )
     end
 
+    private
+
     PROTOTYPE = Parser.new
     PROTOTYPE.instance_eval do
       before { || [] }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: swissparser
 version: !ruby/object:Gem::Version 
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors: 
 - paradigmatic
@@ -9,9 +9,19 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-14 00:00:00 +01:00
+date: 2009-11-15 00:00:00 +01:00
 default_executable: 
 dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0.4"
+    version: 
 - !ruby/object:Gem::Dependency 
   name: bones
   type: :development
@@ -44,7 +54,11 @@ files:
 - examples/parse_from_uri.rb
 - examples/signal_demo.rb
 - examples/tutorial_1.rb
+- examples/tutorial_2.rb
 - examples/uniprot_param_demo.rb
+- features/parser_extension.feature
+- features/step_definitions/steps.rb
+- features/user_friendly.feature
 - lib/swiss_parser.rb
 - lib/swissparser.rb
 has_rdoc: true