ios_parser 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3fa46ea53424609c1cc2bd44edfcebd86cedec95
-  data.tar.gz: 632d1c06c880ca9d7ba17285c825ae4885fc4f08
+  metadata.gz: 181d9adcdc7d222fe6ef05a91624aa1277274371
+  data.tar.gz: f9a1920092018240b8e67f972e453f5e104b8bd9
 SHA512:
-  metadata.gz: 052fe0ba301f4c002237b35134f4a97d7bf0ac175fd3d7217ee6634e5bc685939a84e0ec7eb44ffa05950c95c27d687010e3998162814db1f01c7d108951ff81
-  data.tar.gz: c96e847e9af333cfa441588c57c1711c60323ae7d3cac08177a684fa26aa6d0fcd8da816926ffc815d64f50513f2d99c84676cb156eb11698a5cf7a7675c30db
+  metadata.gz: 4d4cf9efd75f3c563ffa92034dccbc265a5fd70778afb2f970df71641b1a94edc371befcd99e6d7bf989817b8fd1744a4d60b7340415ac7ec4fa4d2e8afd6586
+  data.tar.gz: 5fa9ebc0c746698ce75afd045d272826e9e48d54c86d4c20ab244e790b10f9255a36795a85331b1675d756fde9ac6b5d221bf0506391cb73a032e246e6ab41f7

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 0.5.0 (2017-04-26)
+
+Enhancements:
+
+- handle EOS-style banners
+
+
 ## 0.4.0 (2016-06-08)
 
 Enhancements:

data/Guardfile

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

data/ext/ios_parser/c_lexer/lexer.c

@@ -81,7 +81,7 @@ int is_certificate(LexInfo *lex) {
     return 1;
 }
 
-int is_banner(LexInfo *lex) {
+int is_banner_begin(LexInfo *lex) {
     VALUE banner_ary, banner;
     int token_count = RARRAY_LEN(lex->tokens);
     int banner_pos = token_count - 2;
@@ -178,9 +178,20 @@ static VALUE initialize(VALUE self, VALUE input_text) {
 
 static void process_root(LexInfo * lex);
 static void process_start_of_line(LexInfo * lex);
+static void start_banner(LexInfo * lex);
 
 static void process_newline(LexInfo *lex) {
     delimit(lex);
+
+    if (is_banner_begin(lex)) {
+      lex->token_state = LEX_STATE_BANNER;
+      start_banner(lex);
+      lex->pos = lex->pos + 1;
+      lex->token_start = lex->pos;
+      lex->token_length = 0;
+      return;
+    }
+
     lex->token_start = lex->pos;
     ADD_TOKEN(lex, ID2SYM(rb_intern("EOL")));
     lex->token_state = LEX_STATE_INDENT;
@@ -203,7 +214,7 @@ static void process_comment(LexInfo *lex) {
 
 static void process_quoted_string(LexInfo *lex) {
     char c = CURRENT_CHAR(lex);
-    
+
     lex->token_length++;
     if (!lex->string_terminator) {
         lex->string_terminator = c;
@@ -301,24 +312,40 @@ static void start_certificate(LexInfo *lex) {
     process_certificate(lex);
 }
 
-static void process_banner(LexInfo *lex) {
-    char c = CURRENT_CHAR(lex);
-
-    if (c == lex->banner_delimiter &&
+int is_banner_end_char(LexInfo *lex) {
+    return CURRENT_CHAR(lex) == lex->banner_delimiter &&
         (0 < lex->pos && '\n' == lex->text[lex->pos - 1] ||
-         '\n' == lex->text[lex->pos + 1])) {
+         '\n' == lex->text[lex->pos + 1]);
+}
+
+int is_banner_end_string(LexInfo *lex) {
+    /* onlys accept the banner-ending string "EOF" */
+    return (CURRENT_CHAR(lex) == 'F' &&
+            lex->text[lex->pos - 1] == 'O' &&
+            lex->text[lex->pos - 2] == 'E' &&
+            lex->text[lex->pos - 3] == '\n');
+}
+
+static void process_banner(LexInfo *lex) {
+    if (lex->banner_delimiter && is_banner_end_char(lex)) {
         lex->token_length++;
         delimit(lex);
         lex->token_start = lex->pos;
         ADD_TOKEN(lex, ID2SYM(rb_intern("BANNER_END")));
         if (lex->text[lex->pos + 1] == 'C') { lex->pos++; }
+    } else if (!lex->banner_delimiter && is_banner_end_string(lex)) {
+        lex->token_length -= 1;
+        delimit(lex);
+        lex->token_start = lex->pos;
+        ADD_TOKEN(lex, ID2SYM(rb_intern("BANNER_END")));
     } else {
         lex->token_length++;
     }
 }
 
 static void start_banner(LexInfo *lex) {
-    lex->banner_delimiter = CURRENT_CHAR(lex);
+    char c = CURRENT_CHAR(lex);
+    lex->banner_delimiter = (c == '\n') ? 0 : c;
     ADD_TOKEN(lex, ID2SYM(rb_intern("BANNER_BEGIN")));
     if ('\n' == lex->text[lex->pos + 2]) lex->pos++;
 }
@@ -359,7 +386,7 @@ static void process_root(LexInfo *lex) {
     if (IS_SPACE(c)) {
         delimit(lex);
 
-    } else if (is_banner(lex)) {
+    } else if (is_banner_begin(lex)) {
         lex->token_state = LEX_STATE_BANNER;
         start_banner(lex);
         lex->pos = lex->pos + 2;
@@ -433,7 +460,7 @@ static VALUE call(VALUE self, VALUE input_text) {
         case (LEX_STATE_QUOTED_STRING):
             process_quoted_string(lex);
             break;
-            
+
         case (LEX_STATE_WORD):
             process_word(lex);
             break;

data/lib/ios_parser/lexer.rb

@@ -81,7 +81,7 @@ module IOSParser
       self.state = :banner
       tokens << make_token(:BANNER_BEGIN)
       @token_start = @this_char + 2
-      @banner_delimiter = char
+      @banner_delimiter = char == "\n" ? 'EOF' : char
     end
 
     def banner_begin?
@@ -89,21 +89,38 @@ module IOSParser
     end
 
     def banner
-      if char == @banner_delimiter && (@text[@this_char - 1] == "\n" ||
-                                       @text[@this_char + 1] == "\n")
-        banner_end
+      if banner_end_char?
+        banner_end_char
+      elsif banner_end_string?
+        banner_end_string
       else
         token << char
       end
     end
 
-    def banner_end
+    def banner_end_string
+      self.state = :root
+      token.chomp!(@banner_delimiter[0..-2])
+      tokens << make_token(token) << make_token(:BANNER_END)
+      self.token = ''
+    end
+
+    def banner_end_string?
+      @banner_delimiter.size > 1 && (token + char).end_with?(@banner_delimiter)
+    end
+
+    def banner_end_char
       self.state = :root
       banner_end_clean_token
       tokens << make_token(token) << make_token(:BANNER_END)
       self.token = ''
     end
 
+    def banner_end_char?
+      char == @banner_delimiter && (@text[@this_char - 1] == "\n" ||
+                                    @text[@this_char + 1] == "\n")
+    end
+
     def banner_end_clean_token
       token.slice!(0) if token[0] == 'C'
       token.slice!(0) if ["\n", ' '].include?(token[0])
@@ -157,10 +174,9 @@ module IOSParser
 
     def integer
       self.state = :integer
-      case
-      when dot?   then decimal
-      when digit? then token << char
-      when word?  then word
+      if dot?   then decimal
+      elsif digit? then token << char
+      elsif word?  then word
       else root
       end
     end
@@ -180,10 +196,9 @@ module IOSParser
 
     def decimal
       self.state = :decimal
-      case
-      when digit? then token << char
-      when dot?   then token << char
-      when word?  then word
+      if digit? then token << char
+      elsif dot?   then token << char
+      elsif word?  then word
       else root
       end
     end
@@ -247,6 +262,7 @@ module IOSParser
 
     def newline
       delimit
+      return banner_begin if banner_begin?
       self.state = :line_start
       self.indent = 0
       tokens << make_token(:EOL)
@@ -267,6 +283,13 @@ module IOSParser
 
     def delimit
       return if token.empty?
+
+      unless respond_to?(:"#{state}_token")
+        pos = @token_start || @this_char
+        raise LexError, "Unterminated #{state} starting at #{pos}: "\
+                        "#{@text[pos..pos + 20].inspect}"
+      end
+
       tokens << send(:"#{state}_token")
       self.state = :root
       self.token = ''

data/lib/ios_parser/version.rb

@@ -1,7 +1,7 @@
 module IOSParser
   class << self
     def version
-      '0.4.1'
+      '0.5.0'
     end
   end
 end

data/lib/ios_parser.rb

@@ -31,7 +31,7 @@ module IOSParser
     end
 
     def json_to_ios(text)
-      hash_to_ios JSON.load(text)
+      hash_to_ios JSON.parse(text)
     end
   end
 end

data/spec/lib/ios_parser/ios/queryable_spec.rb

@@ -63,9 +63,9 @@ END
           end
 
           describe Array do
-            let(:matcher) {
+            let(:matcher) do
               { contains: ['dscp'.freeze, 'cs1'.freeze].freeze }.freeze
-            }
+            end
             it { should == expectation }
           end
         end # context 'matcher: contains' do

data/spec/lib/ios_parser/ios_spec.rb

@@ -27,10 +27,8 @@ END
                                         'policed-dscp-transmit'],
                                  commands: [{ args: %w(set dscp cs1),
                                               commands: [], pos: 114 }],
-                                 pos: 50
-                               }],
-                    pos: 24
-                  },
+                                 pos: 50 }],
+                    pos: 24 },
 
                   { args: %w(class other_service),
                     commands: [{ args: ['police', 600_000_000, 1_000_000,
@@ -40,12 +38,9 @@ END
                                               commands: [], pos: 214 },
                                             { args: ['command_with_no_args'],
                                               commands: [], pos: 230 }],
-                                 pos: 150
-                               }],
-                    pos: 128
-                  }],
-               pos: 0
-             }]
+                                 pos: 150 }],
+                    pos: 128 }],
+               pos: 0 }]
         }
       end
 
@@ -98,8 +93,7 @@ END
                         'policed-dscp-transmit'],
                  commands: [{ args: %w(set dscp cs1),
                               commands: [], pos: 114 }],
-                 pos: 50
-               }]
+                 pos: 50 }]
             end
 
             context 'integer query' do

data/spec/lib/ios_parser/lexer_spec.rb

@@ -37,8 +37,7 @@ END
            'police', 600_000_000, 1_000_000, 'exceed-action',
            'policed-dscp-transmit', :EOL,
            :INDENT,
-           'set', 'dscp', 'cs2', :EOL, :DEDENT, :DEDENT, :DEDENT
-          ]
+           'set', 'dscp', 'cs2', :EOL, :DEDENT, :DEDENT, :DEDENT]
         end
 
         subject { klass.new.call(input).map(&:last) }
@@ -71,8 +70,7 @@ END
              :DEDENT, :DEDENT, :DEDENT,
              'router', 'ospf', 12_345, :EOL,
              :INDENT, 'nsr', :EOL,
-             :DEDENT
-            ]
+             :DEDENT]
           end
 
           it 'pure' do
@@ -125,6 +123,18 @@ END
         it { expect(subject_pure.map(&:last)).to eq output }
       end
 
+      context 'complex eos banner' do
+        let(:input) { "banner motd\n'''\nEOF\n" }
+
+        let(:output) do
+          content = input.lines[1..-2].join
+          ['banner', 'motd', :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] }
@@ -164,8 +174,7 @@ END
             'DDDDDDDD DDDDDDDD DDDDDDDD AAAA'],
            [323, :CERTIFICATE_END],
            [323, :EOL],
-           [323, :DEDENT]
-          ]
+           [323, :DEDENT]]
         end
 
         subject { klass.new.call(input) }

data/spec/lib/ios_parser_spec.rb

@@ -26,10 +26,8 @@ END
                                         'policed-dscp-transmit'],
                                  commands: [{ args: %w(set dscp cs1),
                                               commands: [], pos: 114 }],
-                                 pos: 50
-                               }],
-                    pos: 24
-                  },
+                                 pos: 50 }],
+                    pos: 24 },
 
                   { args: %w(class other_service),
                     commands: [{ args: ['police', 600_000_000, 1_000_000,
@@ -39,12 +37,9 @@ END
                                               commands: [], pos: 214 },
                                             { args: ['command_with_no_args'],
                                               commands: [], pos: 230 }],
-                                 pos: 150
-                               }],
-                    pos: 128
-                  }],
-               pos: 0
-             }]
+                                 pos: 150 }],
+                    pos: 128 }],
+               pos: 0 }]
         }
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ios_parser
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Ben Miller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-02 00:00:00.000000000 Z
+date: 2017-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -110,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: convert network switch and router config files to structured data
@@ -120,4 +120,3 @@ test_files:
 - spec/lib/ios_parser/lexer_spec.rb
 - spec/lib/ios_parser_spec.rb
 - spec/spec_helper.rb
-has_rdoc: