logicality 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb4ac0da245089c4fb24cff9a9bd3538789fa657
-  data.tar.gz: 3c036d3c1e19b16da5b5ac3b4e0b2dba44b48885
+  metadata.gz: 7edc9358a6d67553428d41c02f336e25dd7a9763
+  data.tar.gz: 1e66c111450fba24d0b0fb3d2e680c6d8ca63cdf
 SHA512:
-  metadata.gz: 224ab93b859472eacdb9bf044d3d1b2e0a4cbb96b1a61e233b0b7b639744b5c1adbea4120740949081825e416f3325758b58021ed654f03b8fb689b35332f6aa
-  data.tar.gz: a88bccf33b604a31042e14fcb09c8229af5480c181fda6dba306d0b9e6d24d9e09013dfec2135b2263f01694e41a0be3f9bbb7201d1c8b7bc4e60c638d8799ed
+  metadata.gz: 402fab8bc9d1889cf311f2d9455f558f7fe2a4b6e4d4b9735277f2fe228350cb4aee5a593f8445c18ca8ef4a6884ab4481c1237f690f7521cf097fb616ccc8b5
+  data.tar.gz: bd27b379426d0cda3db948eeb01e458a9867f9dade37c1e8c80941806f891ca935b8b3a3ca8fb0a6605e214bda995896f41491e2499ffa85418965ce6a00293a

data/.rubocop.yml

@@ -0,0 +1,4 @@
+inherit_from: .rubocop_todo.yml
+
+Metrics/LineLength:
+  Max: 100

data/.rubocop_todo.yml

@@ -0,0 +1,34 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2018-09-28 09:05:21 -0500 using RuboCop version 0.59.2.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 4
+Metrics/AbcSize:
+  Max: 23
+
+# Offense count: 2
+# Configuration parameters: CountComments, ExcludedMethods.
+# ExcludedMethods: refine
+Metrics/BlockLength:
+  Max: 51
+
+# Offense count: 3
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/MethodLength:
+  Max: 16
+
+# Offense count: 3
+Style/DoubleNegation:
+  Exclude:
+    - 'lib/logicality/interpreter/simple_interpreter.rb'
+    - 'lib/logicality/logic.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/OrAssignment:
+  Exclude:
+    - 'lib/logicality/logic.rb'

data/.travis.yml

@@ -4,4 +4,5 @@ rvm:
   - 2.3.7
 cache: bundler
 script:
+  - bundle exec rubocop
   - bundle exec rspec

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec

data/Gemfile.lock

@@ -1,12 +1,19 @@
 PATH
   remote: .
   specs:
-    logicality (1.0.4)
+    logicality (1.0.5)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.0)
     diff-lcs (1.3)
+    jaro_winkler (1.5.1)
+    parallel (1.12.1)
+    parser (2.5.1.2)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    rainbow (3.0.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -20,6 +27,16 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
+    rubocop (0.59.2)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.10.0)
+    unicode-display_width (1.4.0)
 
 PLATFORMS
   ruby
@@ -27,6 +44,7 @@ PLATFORMS
 DEPENDENCIES
   logicality!
   rspec
+  rubocop (~> 0.59.2)
 
 BUNDLED WITH
    1.16.3

data/lib/logicality/interpreter/interpreter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Copyright (c) 2018-present, Blue Marble Payroll, LLC
 #

data/lib/logicality/interpreter/node_visitor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Copyright (c) 2018-present, Blue Marble Payroll, LLC
 #
@@ -7,8 +9,8 @@
 
 module Logicality
   module Interpreter
+    # This is a base class for traversing a node.
     class NodeVisitor
-
       def visit(node)
         return nil unless node
 
@@ -30,7 +32,6 @@ module Logicality
       def method_name(node)
         "visit_#{node.name}"
       end
-
     end
   end
 end

data/lib/logicality/interpreter/simple_interpreter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Copyright (c) 2018-present, Blue Marble Payroll, LLC
 #
@@ -7,12 +9,13 @@
 
 module Logicality
   module Interpreter
+    # This class implements NodeVisitor and gives each type of node the proper type of visitor
+    # implementation.
     class SimpleInterpreter < NodeVisitor
-
       attr_reader :resolver
 
       def initialize(resolver)
-        raise ArgumentError, "Resolver is required" unless resolver
+        raise ArgumentError, 'Resolver is required' unless resolver
 
         @resolver = resolver
       end
@@ -52,13 +55,10 @@ module Logicality
       private
 
       def resolve_value(value)
-        if resolver.nil?
-          raise ArgumentError, "No resolver function but trying to resolve: #{value}"
-        end
+        raise ArgumentError, "No resolver function: #{value}" if resolver.nil?
 
         !!resolver.call(value)
       end
-
     end
   end
 end

data/lib/logicality/lexer/grammar.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Copyright (c) 2018-present, Blue Marble Payroll, LLC
 #
@@ -7,6 +9,7 @@
 
 module Logicality
   module Lexer
+    # Define the main regular expression matchers used by the lexer.
     module Grammar
       VALUE       = /([a-zA-Z0-9_$@?\.]+)/
       AND_OP      = /(&&)/

data/lib/logicality/lexer/lexer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Copyright (c) 2018-present, Blue Marble Payroll, LLC
 #

data/lib/logicality/lexer/regexp_lexer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Copyright (c) 2018-present, Blue Marble Payroll, LLC
 #
@@ -7,11 +9,11 @@
 
 module Logicality
   module Lexer
+    # This class is a simple lexical token analyzer based on regular expression grammer matchers.
     class RegexpLexer
       include Grammar
 
       class << self
-
         def invalid_pattern
           "#{pattern}|(\\s*)"
         end
@@ -21,24 +23,25 @@ module Logicality
         end
 
         def pattern
-          Grammar.constants.map { |c| Grammar.const_get(c).source }
-                           .join('|')
+          Grammar.constants
+                 .map { |c| Grammar.const_get(c).source }
+                 .join('|')
         end
 
         def regexp
           Regexp.new(pattern)
         end
-
       end
 
       attr_reader :expression
 
       def initialize(expression)
-        raise ArgumentError, 'Expression is required' unless expression && expression.to_s.length > 0
+        raise ArgumentError, 'Expression is required' unless expression &&
+                                                             expression.to_s.length.positive?
 
         @expression = expression.to_s
 
-        if invalid_matches.length > 0
+        if invalid_matches.length.positive?
           raise ArgumentError, "Invalid syntax: #{invalid_matches}"
         end
 
@@ -59,11 +62,9 @@ module Logicality
           value ? Token.new(const, value) : nil
         end.compact
 
-        if tokens.length > 1
-          raise ArgumentError, "Too many tokens found for: #{scan_array}"
-        elsif tokens.length == 0
-          raise ArgumentError, "Cannot tokenize: #{scan_array}"
-        end
+        raise ArgumentError, "Too many tokens found for: #{scan_array}" if tokens.length > 1
+
+        raise ArgumentError, "Cannot tokenize: #{scan_array}" if tokens.length.zero?
 
         tokens.first
       end
@@ -91,7 +92,6 @@ module Logicality
       def matches
         @matches ||= expression.scan(self.class.regexp)
       end
-
     end
   end
 end

data/lib/logicality/lexer/token.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Copyright (c) 2018-present, Blue Marble Payroll, LLC
 #
@@ -7,8 +9,9 @@
 
 module Logicality
   module Lexer
+    # Class that defines the main structure of a Token.  A token is a parsed set of
+    # characters.
     class Token
-
       module Type
         VALUE       = :value
         AND_OP      = :and_op
@@ -21,8 +24,8 @@ module Logicality
       attr_reader :type, :value
 
       def initialize(type, value)
-        raise ArgumentError, 'type is required'   unless type   && type.to_s.length > 0
-        raise ArgumentError, 'value is required'  unless value  && value.to_s.length > 0
+        raise ArgumentError, 'type is required'   unless type   && type.to_s.length.positive?
+        raise ArgumentError, 'value is required'  unless value  && value.to_s.length.positive?
 
         @type   = Type.const_get(type.to_s.upcase.to_sym)
         @value  = value.to_s
@@ -31,7 +34,6 @@ module Logicality
       def to_s
         "#{type}::#{value}"
       end
-
     end
   end
 end

data/lib/logicality/logic.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Copyright (c) 2018-present, Blue Marble Payroll, LLC
 #
@@ -6,9 +8,9 @@
 #
 
 module Logicality
+  # Class that defines the main class-level API for this library.
   class Logic
     class << self
-
       def evaluate(expression, input = nil, resolver = nil)
         node        = get(expression)
         wrapper     = resolver_wrapper(input, resolver)
@@ -21,9 +23,9 @@ module Logicality
 
       def resolver_wrapper(input, resolver)
         if resolver
-          lambda { |value| resolver.call(value, input) }
+          ->(value) { resolver.call(value, input) }
         else
-          lambda { |value| object_resolver.call(value, input) }
+          ->(value) { object_resolver.call(value, input) }
         end
       end
 
@@ -59,7 +61,6 @@ module Logicality
 
         set(expression, parser.parse)
       end
-
     end
   end
 end

data/lib/logicality/logicality.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Copyright (c) 2018-present, Blue Marble Payroll, LLC
 #

data/lib/logicality/parser/ast/ast.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Copyright (c) 2018-present, Blue Marble Payroll, LLC
 #

data/lib/logicality/parser/ast/binary_operator_node.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Copyright (c) 2018-present, Blue Marble Payroll, LLC
 #
@@ -8,8 +10,8 @@
 module Logicality
   module Parser
     module Ast
+      # A binary operator contains two children (left and right) nodes.
       class BinaryOperatorNode < Node
-
         attr_reader :left, :right
 
         def initialize(left, token, right)
@@ -19,7 +21,6 @@ module Logicality
           @left  = left
           @right = right
         end
-
       end
     end
   end

data/lib/logicality/parser/ast/node.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Copyright (c) 2018-present, Blue Marble Payroll, LLC
 #
@@ -8,8 +10,8 @@
 module Logicality
   module Parser
     module Ast
+      # Base construct defining all nodes.
       class Node
-
         attr_reader :token, :name
 
         def initialize(token)
@@ -20,7 +22,6 @@ module Logicality
         def to_s
           "AstNode: #{self.class.name}::#{token}"
         end
-
       end
     end
   end

data/lib/logicality/parser/ast/unary_operator_node.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Copyright (c) 2018-present, Blue Marble Payroll, LLC
 #
@@ -8,8 +10,8 @@
 module Logicality
   module Parser
     module Ast
+      # A unary operator node has just one child node.
       class UnaryOperatorNode < Node
-
         attr_reader :child
 
         def initialize(child, token)
@@ -18,7 +20,6 @@ module Logicality
           @name   = 'unary_operator_node'
           @child  = child
         end
-
       end
     end
   end

data/lib/logicality/parser/ast/value_operand_node.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Copyright (c) 2018-present, Blue Marble Payroll, LLC
 #
@@ -8,8 +10,8 @@
 module Logicality
   module Parser
     module Ast
+      # A value operand node is a node with no children but holds a value instead.
       class ValueOperandNode < Node
-
         attr_reader :value
 
         def initialize(token)
@@ -18,7 +20,6 @@ module Logicality
           @name  = 'value_operand_node'
           @value = token.value
         end
-
       end
     end
   end

data/lib/logicality/parser/parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Copyright (c) 2018-present, Blue Marble Payroll, LLC
 #

data/lib/logicality/parser/simple_parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Copyright (c) 2018-present, Blue Marble Payroll, LLC
 #
@@ -7,8 +9,9 @@
 
 module Logicality
   module Parser
+    # Parser that takes in a lexer and can take its parsed grammar and turn it into an
+    # abstract syntax tree.
     class SimpleParser
-
       attr_reader :lexer
 
       def initialize(lexer)
@@ -16,10 +19,7 @@ module Logicality
 
         @current_token = lexer.next_token
 
-        if @current_token.nil?
-          raise ArgumentError, 'Lexer must contain at least one token'
-        end
-
+        raise ArgumentError, 'Lexer must contain at least one token' if @current_token.nil?
       end
 
       def parse
@@ -30,7 +30,7 @@ module Logicality
 
       BINARY_TYPES = [
         Lexer::Token::Type::AND_OP,
-        Lexer::Token::Type::OR_OP,
+        Lexer::Token::Type::OR_OP
       ].freeze
 
       attr_reader :current_token
@@ -91,7 +91,6 @@ module Logicality
 
         node
       end
-
     end
   end
 end

data/lib/logicality/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Copyright (c) 2018-present, Blue Marble Payroll, LLC
 #
@@ -6,5 +8,5 @@
 #
 
 module Logicality
-  VERSION = "1.0.4"
+  VERSION = '1.0.5'
 end

data/lib/logicality.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Copyright (c) 2018-present, Blue Marble Payroll, LLC
 #

data/logicality.gemspec

@@ -1,28 +1,29 @@
-require "./lib/logicality/version"
+# frozen_string_literal: true
 
-Gem::Specification.new do |s|
+require './lib/logicality/version'
 
+Gem::Specification.new do |s|
   s.name        = 'logicality'
   s.version     = Logicality::VERSION
-  s.summary     = "String-based boolean expression evaluator"
+  s.summary     = 'String-based boolean expression evaluator'
 
-  s.description = <<-EOS
+  s.description = <<-DESCRIPTION
     A common problem that many frameworks have is the ability to give developers
     an expressive intermediary scripting language or DSL.
     Logicality helps solve this problem by providing a simple boolean
     expression evaluator.
-  EOS
+  DESCRIPTION
 
-  s.authors     = [ 'Matthew Ruggio' ]
-  s.email       = [ 'mruggio@bluemarblepayroll.com' ]
+  s.authors     = ['Matthew Ruggio']
+  s.email       = ['mruggio@bluemarblepayroll.com']
   s.files       = `git ls-files`.split("\n")
   s.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.homepage    = 'https://github.com/bluemarblepayroll/logicality-rb'
   s.license     = 'MIT'
 
   s.required_ruby_version = '>= 2.3.1'
 
   s.add_development_dependency('rspec')
-
+  s.add_development_dependency('rubocop', '~> 0.59.2')
 end

data/spec/logic_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Copyright (c) 2018-present, Blue Marble Payroll, LLC
 #
@@ -9,26 +11,24 @@ require './lib/logicality'
 
 def run(tests)
   tests.each do |x|
-    input = x[1] ? x[1].map { |k,v| [ k.to_s, v] }.to_h : nil
+    input = x[1] ? x[1].map { |k, v| [k.to_s, v] }.to_h : nil
 
     result = Logicality::Logic.evaluate(x[0], input)
 
-    expect(result).to eq(x[2]), "Failed on #{x[0]} (input: #{input}): expected #{x[2]} but got: #{result}"
+    expect(result).to eq(x[2]), "Failed: #{x[0]} (input: #{input}): expected #{x[2]} got: #{result}"
   end
 
   nil
 end
 
 describe Logicality::Logic do
-
   context 'when evaluating' do
-
     it 'should evaluate boolean-only expressions' do
       tests = [
-        [ 'true',           nil, true ],
-        [ 'false',          nil, false ],
-        [ 'true && false',  nil, false ],
-        [ 'true && true',   nil, true ]
+        ['true',           nil, true],
+        ['false',          nil, false],
+        ['true && false',  nil, false],
+        ['true && true',   nil, true]
       ]
 
       run(tests)
@@ -36,12 +36,12 @@ describe Logicality::Logic do
 
     it 'should evaluate and expressions' do
       tests = [
-        [ 'a && b', nil,                    false ],
-        [ 'a && b', {},                     false ],
-        [ 'a && b', { a: true },            false ],
-        [ 'a && b', { a: true, b: false },  false ],
-        [ 'a && b', { a: false, b: false }, false ],
-        [ 'a && b', { a: true, b: true },   true ]
+        ['a && b', nil,                    false],
+        ['a && b', {},                     false],
+        ['a && b', { a: true },            false],
+        ['a && b', { a: true, b: false },  false],
+        ['a && b', { a: false, b: false }, false],
+        ['a && b', { a: true, b: true },   true]
       ]
 
       run(tests)
@@ -49,11 +49,11 @@ describe Logicality::Logic do
 
     it 'should evaluate and-or expressions' do
       tests = [
-        [ 'a && b || c',    { a: false, b: false, c: true },  true ],
-        [ '(a && b) || c',  { a: false, b: false, c: true },  true ],
-        [ 'a || b && c',    { a: false, b: false, c: true },  false ],
-        [ 'a || (b && c)',  { a: false, b: false, c: true },  false ],
-        [ '(a || b) && c',  { a: false, b: false, c: true },  false ]
+        ['a && b || c',    { a: false, b: false, c: true },  true],
+        ['(a && b) || c',  { a: false, b: false, c: true },  true],
+        ['a || b && c',    { a: false, b: false, c: true },  false],
+        ['a || (b && c)',  { a: false, b: false, c: true },  false],
+        ['(a || b) && c',  { a: false, b: false, c: true },  false]
       ]
 
       run(tests)
@@ -61,11 +61,11 @@ describe Logicality::Logic do
 
     it 'should evaluate not expressions' do
       tests = [
-        [ '!a',         { a: false },            true ],
-        [ '!a && !b',   { a: false, b: false },  true ],
-        [ '!a && b',    { a: false, b: false },  false ],
-        [ 'a && !b',    { a: false, b: false },  false ],
-        [ '!(a && b)',  { a: false, b: false },  true ]
+        ['!a',         { a: false },            true],
+        ['!a && !b',   { a: false, b: false },  true],
+        ['!a && b',    { a: false, b: false },  false],
+        ['a && !b',    { a: false, b: false },  false],
+        ['!(a && b)',  { a: false, b: false },  true]
       ]
 
       run(tests)
@@ -73,15 +73,13 @@ describe Logicality::Logic do
 
     it 'should treat question marks as a valid part of a value token' do
       tests = [
-        [ 'a?',       { 'a?': true },             true ],
-        [ '!a?',      { 'a?': true },             false ],
-        [ 'a? && b?', { 'a?': true, 'b?': true }, true ],
-        [ 'a && b?',  { a: true, 'b?': true },    true ]
+        ['a?',       { 'a?': true },             true],
+        ['!a?',      { 'a?': true },             false],
+        ['a? && b?', { 'a?': true, 'b?': true }, true],
+        ['a && b?',  { a: true, 'b?': true },    true]
       ]
 
       run(tests)
     end
-
   end
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logicality
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Matthew Ruggio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-27 00:00:00.000000000 Z
+date: 2018-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.59.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.59.2
 description: |2
       A common problem that many frameworks have is the ability to give developers
       an expressive intermediary scripting language or DSL.
@@ -37,6 +51,8 @@ extra_rdoc_files: []
 files:
 - ".editorconfig"
 - ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".ruby-version"
 - ".travis.yml"
 - Gemfile