ios_parser 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c6d921da652a8428e281ceb4e6f9d5e944de3290
-  data.tar.gz: 4abaa4c7a384ecb7bbd26aa7d3a3408d46936d3a
+  metadata.gz: b9c3428424b6fff808e5dcd94412c3d1e0d17ada
+  data.tar.gz: a5cda3521efcc1c2f7f2826fb9985b9be384a8f1
 SHA512:
-  metadata.gz: d282b754f31317249da935221806a5371053a139a717a1185018ea4dbe8025cce184195c4142f273cb2b1d31be06e82a80f529201092605c6f90e288b1425a2b
-  data.tar.gz: 79587649306262d302e0b4301259479db48f86d68e1f096187189351a99f3e81ae419101753d3c8d26965c3cfd0705b2cf9f1ee0be24d311f396560249267b78
+  metadata.gz: aaeda92fb563f4416c18fc26e2118e30c90f9dc45e7e9da9559c7f84a6adf46e9c57ac3e0b9ffe0adfca38cef089d20bcb20cd0e6e4bebdf5afa63d3f939d598
+  data.tar.gz: 881b58760c2426e08c49e5cad4db0db21e1fb95f14ddeb31ea465853cd81aa14fca33c5a1d04ec0ee2396b9fec99e27022156b693998eeb666bc664bc54b55af

data/CHANGELOG.md

@@ -1,14 +1,10 @@
-## 0.1.1 (2015-03-05)
-Bugfixes:
-
-- Parser throws `ArgumentError` when input is not a string - [PR#1](https://github.rackspace.com/backbone/ios_parser/pull/1)
-
-## 0.1.0 (2015-02-17)
+## 0.3.1 (2016-03-07)
 
 Bugfixes:
 
-- `Document#each` and `Command#each` will visit all nodes
+- allow banners to contain the terminating character under some circumstances
+- process `#` as a comment-leader only if no non-whitespace character precedes it
 
-Features:
+## 0.3.0 (2016-03-04)
 
-- `Command#path` provides nested context
+- Initial public release

data/Guardfile

@@ -1,7 +1,12 @@
+guard :rake, task: 'compile' do
+  watch(%r{^ext/(.+)\.[ch]$})
+end
+
 guard :rspec, cmd: 'bundle exec rspec --color --fail-fast' do
   watch(%r{^spec/.+_spec\.rb$}) { |m| m }
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')  { 'spec' }
+  watch(%r{^ext/(.+)\.[ch]$})   { 'spec' }
 end
 
 guard :rubocop, cli: '-D -a' do

data/ext/ios_parser/c_lexer/lexer.c

@@ -32,15 +32,16 @@ typedef struct LexInfo LexInfo;
 
 #define IS_SPACE(C)     C == ' ' || C == '\t' || C == '\r'
 #define IS_NEWLINE(C)   C == '\n'
-#define IS_COMMENT(C)   C == '#' || C == '!'
+#define IS_COMMENT(C)   C == '!'
 #define IS_DIGIT(C)     '0' <= C && C <= '9'
 #define IS_DOT(C)       C == '.'
 #define IS_DECIMAL(C)   IS_DIGIT(C) || IS_DOT(C)
 #define IS_LETTER(C)    'a' <= C && C <= 'z' || 'A' <= C && C <= 'Z'
-#define IS_PUNCT(C)     strchr("-+$:/,()|*#=<>!\"\\&@;%~{}'\"?[]_^", C)
+#define IS_PUNCT(C)     strchr("-+$:/,()|*#=<>!\"\\&@;%~{}'\"?[]_^`", C)
 #define IS_WORD(C)      IS_DECIMAL(C) || IS_LETTER(C) || IS_PUNCT(C)
 #define IS_LEAD_ZERO(C) C == '0'
 #define IS_QUOTE(C)     C == '"' || C == '\''
+#define IS_LEAD_COMMENT(C) C == '#' || C == '!'
 
 #define CURRENT_CHAR(LEX) LEX->text[LEX->pos]
 #define TOKEN_EMPTY(LEX) LEX->token_length <= 0
@@ -302,7 +303,9 @@ static void start_certificate(LexInfo *lex) {
 static void process_banner(LexInfo *lex) {
     char c = CURRENT_CHAR(lex);
 
-    if (c == lex->banner_delimiter) {
+    if (c == lex->banner_delimiter &&
+        (0 < lex->pos && '\n' == lex->text[lex->pos - 1] ||
+         '\n' == lex->text[lex->pos + 1])) {
         lex->token_length++;
         delimit(lex);
         lex->token_start = lex->pos;
@@ -316,6 +319,7 @@ static void process_banner(LexInfo *lex) {
 static void start_banner(LexInfo *lex) {
     lex->banner_delimiter = CURRENT_CHAR(lex);
     ADD_TOKEN(lex, ID2SYM(rb_intern("BANNER_BEGIN")));
+    if ('\n' == lex->text[lex->pos + 2]) lex->pos++;
 }
 
 static void process_start_of_line(LexInfo *lex) {
@@ -339,7 +343,11 @@ static void process_start_of_line(LexInfo *lex) {
         }
     }
 
-    process_root(lex);
+    if (IS_LEAD_COMMENT(c)) {
+        lex->token_state = LEX_STATE_COMMENT;
+    } else {
+        process_root(lex);
+    }
 }
 
 static void process_root(LexInfo *lex) {

data/fixtures/complex_banner.txt

@@ -0,0 +1,24 @@
+banner exec ^C
+
+             / / 
+          (\/_//`)
+           /   '/
+          0  0   \ 
+         /        \
+        /    __/   \
+       /,  _/ \     \_               
+       `-./ )  |     ~^~^~^~^~^~^~^~\~.
+           (   /                     \_}
+              |               /      |
+              ;     |         \      /
+               \/ ,/           \    |
+               / /~~|~|~~~~~~|~|\   |
+              / /   | |      | | `\ \
+             / /    | |      | |   \ \
+            / (     | |      | |    \ \
+     jgs   /,_)    /__)     /__)   /,_/
+    '''''"""""'''""""""'''""""""''"""""'''''
+
+Welcome to the Goat Rodeo!! 
+
+^C

data/ios_parser.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rspec', '~>3.2'
   s.add_development_dependency 'rubocop', '~>0.37'
   s.add_development_dependency 'guard', '~>2.0'
+  s.add_development_dependency 'guard-rake', '~>1.0'
   s.add_development_dependency 'guard-rspec', '~>4.5'
   s.add_development_dependency 'guard-rubocop', '~>1.2'
   s.add_development_dependency 'rake-compiler', '~>0.9'

data/lib/ios_parser/lexer.rb

@@ -15,7 +15,7 @@ module IOSParser
     end
 
     def call(input_text)
-      initialize
+      @text = input_text
 
       input_text.each_char.with_index do |c, i|
         @this_char = i
@@ -50,6 +50,14 @@ module IOSParser
       raise LexError, "Unknown character #{char.inspect}"
     end
 
+    def root_line_start
+      if lead_comment?
+        comment
+      else
+        root
+      end
+    end
+
     def make_token(value, pos: nil)
       pos ||= @token_start || @this_char
       @token_start = nil
@@ -63,6 +71,10 @@ module IOSParser
     end
 
     def comment?
+      char == '!'
+    end
+
+    def lead_comment?
       char == '#' || char == '!'
     end
 
@@ -78,7 +90,12 @@ module IOSParser
     end
 
     def banner
-      char == @banner_delimiter ? banner_end : token << char
+      if char == @banner_delimiter && (@text[@this_char - 1] == "\n" ||
+                                       @text[@this_char + 1] == "\n")
+        banner_end
+      else
+        token << char
+      end
     end
 
     def banner_end
@@ -91,7 +108,6 @@ module IOSParser
     def banner_end_clean_token
       token.slice!(0) if token[0] == 'C'
       token.slice!(0) if ["\n", ' '].include?(token[0])
-      token.chomp!("\n")
     end
 
     def scrub_banner_garbage
@@ -200,7 +216,7 @@ module IOSParser
         ('A'..'Z').cover?(char) ||
         ['-', '+', '$', ':', '/', ',', '(', ')', '|', '*', '#', '=', '<', '>',
          '!', '"', '&', '@', ';', '%', '~', '{', '}', "'", '?', '[', ']', '_',
-         '^', '\\'].include?(char)
+         '^', '\\', '`'].include?(char)
     end
 
     def space
@@ -246,7 +262,7 @@ module IOSParser
         self.indent += 1
       else
         update_indentation
-        root
+        root_line_start
       end
     end
 

data/lib/ios_parser/version.rb

@@ -1,7 +1,7 @@
 module IOSParser
   class << self
     def version
-      '0.3.0'
+      '0.3.1'
     end
   end
 end

data/spec/lib/ios_parser/ios_spec.rb

@@ -190,10 +190,14 @@ sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
 
 
 END
-          banner_command = "banner exec ^C#{banner_text}^C\n"
+          banner_command = "banner exec ^C\n#{banner_text}^C\n"
 
           result = klass.new.call(banner_command)
           expect(result[0].args[2]).to eq banner_text
+
+          pure_result = klass.new(lexer: IOSParser::PureLexer.new)
+                             .call(banner_command)
+          expect(pure_result[0].args[2]).to eq banner_text
         end
 
         it('parses a crypto trustpoint section') do

data/spec/lib/ios_parser/lexer_spec.rb

@@ -111,6 +111,20 @@ END
         end
       end
 
+      context 'complex banner' do
+        let(:input) do
+          text_fixture('complex_banner')
+        end
+
+        let(:output) do
+          content = text_fixture('complex_banner').lines[1..-2].join
+          ['banner', 'exec', :BANNER_BEGIN, content, :BANNER_END, :EOL]
+        end
+
+        it { expect(subject.map(&:last)).to eq output }
+        it { expect(subject_pure.map(&:last)).to eq output }
+      end
+
       context 'decimal number' do
         let(:input) { 'boson levels at 93.2' }
         let(:output) { ['boson', 'levels', 'at', 93.2] }
@@ -226,6 +240,30 @@ END
 
         it { expect(subject_pure.map(&:last)).to eq output }
       end
+
+      context '# in the middle of a line is not a comment' do
+        let(:input) { "vlan 1\n name #31337" }
+        let(:output) { ['vlan', 1, :EOL, :INDENT, 'name', '#31337', :DEDENT] }
+
+        it { expect(subject_pure.map(&:last)).to eq output }
+        it { expect(subject.map(&:last)).to eq output }
+      end
+
+      context '# at the start of a line is a comment' do
+        let(:input) { "vlan 1\n# comment\nvlan 2" }
+        let(:output) { ['vlan', 1, :EOL, 'vlan', 2] }
+
+        it { expect(subject_pure.map(&:last)).to eq output }
+        it { expect(subject.map(&:last)).to eq output }
+      end
+
+      context '# after indentation is a comment' do
+        let(:input) { "vlan 1\n # comment\nvlan 2" }
+        let(:output) { ['vlan', 1, :EOL, :INDENT, :DEDENT, 'vlan', 2] }
+
+        it { expect(subject_pure.map(&:last)).to eq output }
+        it { expect(subject.map(&:last)).to eq output }
+      end
     end
   end
 end

data/spec/spec_helper.rb

@@ -3,3 +3,7 @@ $LOAD_PATH << File.dirname(__FILE__) + '/../lib'
 def klass
   described_class
 end
+
+def text_fixture(name)
+  File.read(File.expand_path(__dir__ + "/../fixtures/#{name}.txt"))
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ios_parser
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Ben Miller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-05 00:00:00.000000000 Z
+date: 2016-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: guard-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -117,6 +131,7 @@ files:
 - doc/state_machine.png
 - ext/ios_parser/c_lexer/extconf.rb
 - ext/ios_parser/c_lexer/lexer.c
+- fixtures/complex_banner.txt
 - ios_parser.gemspec
 - lib/ios_parser.rb
 - lib/ios_parser/ios.rb
@@ -161,4 +176,3 @@ test_files:
 - spec/lib/ios_parser/lexer_spec.rb
 - spec/lib/ios_parser_spec.rb
 - spec/spec_helper.rb
-has_rdoc: