cisco_acl_intp 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 60c56206a4b40ecdfc1b4cae9ddb3fa11da7e07e
-  data.tar.gz: 25b304576447f136c1da714cf0205531318bac33
+  metadata.gz: e5041a1b8d078394186621c71ed182b1257b33c8
+  data.tar.gz: f2fc4398b666c6badaa73abce0169b9a624720c0
 SHA512:
-  metadata.gz: 42749dd6747920756f5a5f2c0a87e0ecbbed20d59db964244446d6bfa136c3c714edd9f6371b86fd8f2b5c57254aed782ffb6e1080ef4b58d4f4ea1b4c7f8457
-  data.tar.gz: 7cdd4c8d508a3bb271eef640636fc1f98bc7658d07f3ce718f1684719e5b943f5c5acf05c5ec2e44927bd3cb88b1f6c5f2e49a233dbd22f16d565b567a941b1d
+  metadata.gz: 789fc6c612a09c44ac2f81eaa13ba1d54196ac0ea5a44db071f9cc8c78db185d31405bb733effc58061541a94f80f9b6e2b336361c456e16200ab6d68b408aac
+  data.tar.gz: dc1964628b26a866671093a3a593a035f60e5852a2268b5a564da717a7afd8166d5ea50964dae122ec9c15c41737ed387e6e066defb703400100c421193c688f

data/.gitignore

@@ -3,6 +3,8 @@
 .bundle
 .config
 .yardoc
+.output
+.idea/
 Gemfile.lock
 InstalledFiles
 _yardoc
@@ -12,6 +14,7 @@ lib/bundler/man
 pkg
 rdoc
 spec/reports
+spec/data
 test/tmp
 test/version_tmp
 tmp

data/.rubocop.yml

@@ -1,12 +1,12 @@
 AllCops:
-  Includes:
+  Include:
     - lib/**/*.rb
     - tool/*.rb
     - spec/**/*.rb
     - Rakefile
     - Gemfile
     - cisco_acl_intp.gemspec
-  Excludes:
+  Exclude:
     - lib/**/parser.rb
     - spec/data/*.rb
 MethodLength:

data/.travis.yml

@@ -1,5 +1,7 @@
 language: ruby
 script: 'rake travis'
+before_install:
+  - gem install bundler
 rvm:
-  - 1.9.3
-  - 2.0.0
+  - 2.1
+  - 2.2

data/Gemfile

@@ -7,12 +7,13 @@ gemspec
 
 group :development, :test do
   gem 'coveralls', require: false
-  gem 'racc', '~> 1.4.11'
-  gem 'rake', '~> 10.1.1'
-  gem 'reek', '~> 1.3.6'
-  gem 'rspec', '~> 2.14.1'
-  gem 'rubocop', '~> 0.19.1' if RUBY_VERSION >= '1.9.0'
-  gem 'simplecov', '~> 0.8.2' if RUBY_VERSION >= '1.9.0'
+  gem 'racc', '~> 1.4.14'
+  gem 'rake', '~> 11.1.2'
+  gem 'reek', '~> 4.0.0'
+  gem 'rspec', '~> 3.4.0'
+  gem 'rspec-core', '~> 3.4.4'
+  gem 'rubocop', '~> 0.39.0' if RUBY_VERSION >= '1.9.0'
+  gem 'simplecov', '~> 0.11.2' if RUBY_VERSION >= '1.9.0'
   gem 'yard', '~> 0.8.7'
 end
 

data/README.md

@@ -13,7 +13,7 @@ CiscoAclIntp can...
 * parse ACL types of below
   * Numbered ACL (standard/extended)
   * Named ACL (standard/extended)
-* parse almost ACL syntaxes.
+* parse almost ACL syntax.
   * basic IPv4 acl (protocol `ip`/`tcp`/`udp`)
 
 CiscoAclIntp *CANNOT*...
@@ -25,8 +25,8 @@ CiscoAclIntp *CANNOT*...
 
 Supports
 
-* Ruby/1.9 or later. (Development and testing is being conducted in
-  Ruby/2.0.0 and *NOT* supported Ruby/1.8.x)
+* Ruby/2.0.0 or later. (Development and testing is being conducted in
+  Ruby/2.0.0 and 2.1.1. It does *NOT* support Ruby/1.8.x and 1.9.x)
 * Racc/1.4.9 or later.
 
 ## Installation
@@ -211,21 +211,26 @@ See `NetAddr::CIDR#matches?` for CIDR subnet operation and
 
 ### Port Operation
 
-| User       | any  | eq X   | neq X  | lt X   | gt X   | range X1 X2   |
-|------------|------|--------|--------|--------|--------|---------------|
-| any        | true | true   | true   | true   | true   | true          |
-| strict_any | true | false  | false  | false  | false  | false         |
-| eq P       | true | P = X  | P != X | P < X  | X < P  | X1 <= P <= X2 |
-| neq P      | true | false  | P = X  | P = X = 65535 | P = X = 0 | (P=X1=0 and X2=65535) or (X1=0 and P=X2=65535) |
-| lt P       | true | false  | P <= X | P <= X | false   | X1 = 0 and P < X2 |
-| gt P       | true | false  | X <= P | false  | X <= P  | X1 < P and X2 = 65535 |
-| range P1 P2| true | false  | P2 < X or X < P1 | P2 < X | X < P1 | X1 <= P1 and P2 <= X2 |
-
-In above table, “User” column is the argment of `contains?`, and,
-operators at table header are receiver of `contains?`. For example,
-`[gt X].contains?([eq P])` will be `true` if port `X < P`. It means
-the ACL `[gt X]` permit (or deny) the flow `[eq P]`. You can search
-ACEs which matches a flows specified by search conditions.
+In below table, "P" column is the argument of `#contains?`,
+and operators at table header are receiver of `#contains?`.
+The table shows case patterns with `port_X.contains?(port_P)`.
+(`port_X` is a instance of `AceUnaryOpBase`
+and it has port match operator and port number information.)
+
+| P          | strict_any | any  | eq X   | neq X  | lt X   | gt X   | range X1 X2   |
+|------------|------------|------|--------|--------|--------|--------|---------------|
+| strict_any | true       | true | false  | false  | false  | false  | false         |
+| any        | true       | true | false  | false  | false  | false  | X1=0 and X2=65535 |
+| eq P       | false      | true | P = X  | P != X | P < X  | X < P  | X1 <= P <= X2 |
+| neq P      | false      | true | false  | P = X  | P = X = 65535 | P = X = 0 | (P=X1=0 and X2=65535) or (X1=0 and P=X2=65535) |
+| lt P       | false      | true | false  | P <= X | P <= X | false   | X1 = 0 and P < X2 |
+| gt P       | false      | true | false  | X <= P | false  | X <= P  | X1 < P and X2 = 65535 |
+| range P1 P2| false      | true | false  | P2 < X or X < P1 | P2 < X | X < P1 | X1 <= P1 and P2 <= X2 |
+
+
+For example,`[gt X].contains?([eq P])` will be `true` if port `X < P`.
+It means the ACL `[gt X]` permit (or deny) the flow `[eq P]`.
+You can search ACEs which matches a flows specified by search conditions.
 
 `:strict_any` is a special operator to search acl, the operator is
 matches only `:any` operator.

data/Rakefile

@@ -7,16 +7,16 @@ require 'yard'
 require 'yard/rake/yardoc_task'
 require 'reek/rake/task'
 
-LIB_DIR = './lib'
-PACKAGE_NAME = 'cisco_acl_intp'
-SPEC_ORIG_DIR = 'spec'
-SPEC_DIR = "#{SPEC_ORIG_DIR}/#{PACKAGE_NAME}/"
-SPEC_DATA_DIR = "#{SPEC_ORIG_DIR}/data"
-CLASS_DIR = "#{LIB_DIR}/#{PACKAGE_NAME}"
-CLASS_GRAPH_DOT = "doc/#{PACKAGE_NAME}.dot"
-CLASS_GRAPH_PNG = "doc/#{PACKAGE_NAME}.png"
-PARSER_RACC = "#{CLASS_DIR}/parser.ry"
-PARSER_RUBY = "#{CLASS_DIR}/parser.rb"
+LIB_DIR = './lib'.freeze
+PACKAGE_NAME = 'cisco_acl_intp'.freeze
+SPEC_ORIG_DIR = 'spec'.freeze
+SPEC_DIR = "#{SPEC_ORIG_DIR}/#{PACKAGE_NAME}/".freeze
+SPEC_DATA_DIR = "#{SPEC_ORIG_DIR}/data".freeze
+CLASS_DIR = "#{LIB_DIR}/#{PACKAGE_NAME}".freeze
+CLASS_GRAPH_DOT = "doc/#{PACKAGE_NAME}.dot".freeze
+CLASS_GRAPH_PNG = "doc/#{PACKAGE_NAME}.png".freeze
+PARSER_RACC = "#{CLASS_DIR}/parser.ry".freeze
+PARSER_RUBY = "#{CLASS_DIR}/parser.rb".freeze
 
 CLEAN.include(
   "#{SPEC_DATA_DIR}/*.*",
@@ -67,8 +67,6 @@ end
 Reek::Rake::Task.new do |t|
   t.fail_on_error = false
   t.verbose = false
-  t.ruby_opts = ['-rubygems']
-  t.reek_opts = '--quiet'
   t.source_files = FileList["#{LIB_DIR}/**/*.rb"].delete_if do |f|
     f =~ /parser.rb/
   end
@@ -77,7 +75,7 @@ end
 if RUBY_VERSION >= '1.9.0'
   task quality: :rubocop
   require 'rubocop/rake_task'
-  Rubocop::RakeTask.new do |task|
+  RuboCop::RakeTask.new do |task|
     # file patterns in ".rubocop.yml"
     task.fail_on_error = false
   end

data/cisco_acl_intp.gemspec

@@ -9,19 +9,19 @@ Gem::Specification.new do |spec|
   spec.version       = CiscoAclIntp::VERSION
   spec.authors       = ['stereocat']
   spec.email         = ['stereocat@gmail.com']
-  spec.description   = %q(Cisco ACL Interpreter)
-  spec.summary       = %q(Cisco IOS Access Control List Interpreter)
+  spec.description   = 'Cisco ACL Interpreter'
+  spec.summary       = 'Cisco IOS Access Control List Interpreter'
   spec.homepage      = 'https://github.com/stereocat/cisco_acl_intp'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split("\n")
-  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.executables   = spec.files.grep(%r{^bin\/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)\/})
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'netaddr', '~> 1.5.0'
-  spec.add_runtime_dependency 'term-ansicolor', '~> 1.3.0'
-  spec.add_development_dependency 'bundler', '~> 1.5.3'
+  spec.add_runtime_dependency 'netaddr', '~> 1.5.1'
+  spec.add_runtime_dependency 'term-ansicolor', '~> 1.3.2'
+  spec.add_development_dependency 'bundler', '~> 1.1l.2'
 end
 
 ### Local variables:

data/lib/cisco_acl_intp/acc.rb

@@ -0,0 +1,111 @@
+# -*- coding: utf-8 -*-
+
+require 'term/ansicolor'
+
+module CiscoAclIntp
+  # Standard Error Handler of CiscoAclParser
+  class AclError < StandardError; end
+
+  # Argument Error Handler of CiscoAclParser
+  class AclArgumentError < AclError; end
+
+  # AccessControlContainer: abstract class of whole elements of ACL.
+  # It contains utility functions to stringify element and management status.
+  class AccessControlContainer
+    class << self
+      # Color mode: defined as a class instance variable
+      attr_accessor :color_mode
+    end
+
+    # Disables coloring
+    def self.disable_color
+      @color_mode = :none
+    end
+
+    # Generate string for Cisco IOS access list
+    # @abstract
+    # @return [String]
+    def to_s
+      raise AclError, 'Not overridden AclContainerBase::to_s'
+    end
+
+    private
+
+    # Table of ACL Tag color codes for terminal
+    TERM_COLOR_TABLE = {
+      header: Term::ANSIColor.on_blue,
+      type: Term::ANSIColor.underline,
+      action: Term::ANSIColor.intense_magenta,
+      name: Term::ANSIColor.bold,
+      remark: Term::ANSIColor.blink,
+      ip: [Term::ANSIColor.green, Term::ANSIColor.underline].join,
+      mask: Term::ANSIColor.yellow,
+      protocol: Term::ANSIColor.cyan,
+      port: Term::ANSIColor.cyan,
+      other_qualifier: Term::ANSIColor.green,
+      error: [Term::ANSIColor.red, Term::ANSIColor.bold].join
+    }.freeze
+
+    # Generate header of ACL tag
+    # @param [Symbol] tag Tag symbol.
+    # @return [String] Tagged string.
+    def generate_tag_header(tag)
+      case AccessControlContainer.color_mode
+      when :term
+        TERM_COLOR_TABLE[tag]
+      when :html
+        %(<span class="acltag_#{tag}">)
+      else
+        ''
+      end
+    end
+
+    # Generate footer of ACL tag
+    # @return [String] Tagged string.
+    def generate_tag_footer
+      case AccessControlContainer.color_mode
+      when :term
+        Term::ANSIColor.clear
+      when :html
+        '</span>'
+      else
+        ''
+      end
+    end
+
+    # Generate tagged ACL string.
+    # @param [Symbol] tag Tag symbol.
+    # @param [Array] args Array of argments.
+    # @return [String] Tagged string.
+    def generate_tagged_str(tag, *args)
+      tag_head = generate_tag_header(tag)
+      tag_body = args.join
+      tag_foot = generate_tag_footer
+      [tag_head, tag_body, tag_foot].join
+    end
+
+    # acl string clean-up
+    # @param [String] str ACL string.
+    # @return [String]
+    def clean_acl_string(str)
+      str.strip.gsub(/\s+/, ' ')
+    end
+
+    # Generate tagging method dynamically.
+    # @raise [NoMethodError]
+    def method_missing(name, *args)
+      name.to_s =~ /^tag_(.+)$/ && tag = Regexp.last_match(1).intern
+      if TERM_COLOR_TABLE.key?(tag)
+        generate_tagged_str(tag, *args)
+      else
+        super
+      end
+    end
+  end
+end
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/lib/cisco_acl_intp/{ace.rb → ace_base.rb}

@@ -1,9 +1,10 @@
 # -*- coding: utf-8 -*-
-require 'cisco_acl_intp/ace_srcdst'
+require 'cisco_acl_intp/acespec_srcdst'
 
 module CiscoAclIntp
-  # Access control entry base model
-  class AceBase < AclContainerBase
+  # AceBase: Base class of ACE(Access Control Entry).
+  # ACE is composed of each types of AceSpecs.
+  class AceBase < AccessControlContainer
     include Comparable
 
     # @param [Integer] value ACL sequence number
@@ -87,9 +88,9 @@ module CiscoAclIntp
     end
 
     # Search matched ACE
-    # @param [Hash] opts Options
+    # @param [Hash] _opts Options
     # return [Boolean] false, Remark does not match anithyng.
-    def contains?(opts = nil)
+    def contains?(_opts = nil)
       false
     end
   end
@@ -119,7 +120,7 @@ module CiscoAclIntp
       if @options.key?(:recursive_name)
         @options[:recursive_name]
       else
-        fail AclArgumentError, 'name not specified'
+        raise AclArgumentError, 'name not specified'
       end
     end
 
@@ -136,10 +137,10 @@ module CiscoAclIntp
     end
 
     # Search matched ACE
-    # @param [Hash] opts Options
+    # @param [Hash] _opts Options
     # return [Boolean]
     # @todo for Recursive name matching is not implemented yet
-    def contains?(opts = nil)
+    def contains?(_opts = nil)
       false
     end
   end

data/lib/cisco_acl_intp/{extended_ace.rb → ace_extended.rb}

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-require 'cisco_acl_intp/standard_ace'
+require 'cisco_acl_intp/ace_standard'
 
 module CiscoAclIntp
   # ACE for extended access list
@@ -79,7 +79,7 @@ module CiscoAclIntp
         @dst_spec,
         @tcp_flags,
         @tcp_other_qualifiers
-     )
+      )
     end
 
     # Search matched ACE
@@ -107,7 +107,7 @@ module CiscoAclIntp
           AceIpProtoSpec.new(protocol)
         end
       else
-        fail AclArgumentError, 'Not specified IP protocol'
+        raise AclArgumentError, 'Not specified IP protocol'
       end
     end
 
@@ -123,21 +123,19 @@ module CiscoAclIntp
         when AceSrcDstSpec
           dst
         else
-          fail AclArgumentError, 'Dst spec: unknown class'
+          raise AclArgumentError, 'Dst spec: unknown class'
         end
       else
-        fail AclArgumentError, 'Not specified dst spec'
+        raise AclArgumentError, 'Not specified dst spec'
       end
     end
 
     # Set instance variables
     # @return [AceOtherQualifierList]
     def define_tcp_flags
-      if @protocol.name == 'tcp' && @options.key?(:tcp_flags_qualifier)
-        @options[:tcp_flags_qualifier]
-      else
-        nil
-      end
+      return unless @protocol.name == 'tcp' &&
+                    @options.key?(:tcp_flags_qualifier)
+      @options[:tcp_flags_qualifier]
     end
   end
 end # module

data/lib/cisco_acl_intp/{standard_ace.rb → ace_standard.rb}

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-require 'cisco_acl_intp/ace'
+require 'cisco_acl_intp/ace_base'
 
 module CiscoAclIntp
   # ACE for standard access list
@@ -53,7 +53,7 @@ module CiscoAclIntp
     # @param [StandardAce] other Target ACE
     # @return [Boolean] Matched or not
     def contains?(other)
-      other.kind_of?(StandardAce) &&
+      other.is_a?(StandardAce) &&
         @src_spec.contains?(other.src_spec)
     end
 
@@ -66,7 +66,7 @@ module CiscoAclIntp
       if @options.key?(:action)
         @options[:action]
       else
-        fail AclArgumentError, 'Not specified action'
+        raise AclArgumentError, 'Not specified action'
       end
     end
 
@@ -82,10 +82,10 @@ module CiscoAclIntp
         when AceSrcDstSpec
           src
         else
-          fail AclArgumentError, 'src spec: unknown class'
+          raise AclArgumentError, 'src spec: unknown class'
         end
       else
-        fail AclArgumentError, 'Not specified src spec'
+        raise AclArgumentError, 'Not specified src spec'
       end
     end