logicality 1.0.5 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7edc9358a6d67553428d41c02f336e25dd7a9763
-  data.tar.gz: 1e66c111450fba24d0b0fb3d2e680c6d8ca63cdf
+SHA256:
+  metadata.gz: 9c095a928ca7ca83e2ac40bdbbe85569bf66475d78deea2aa48e3b78400aa71a
+  data.tar.gz: 131023ffc29713d3f48a57c9ba8422066872289c646cc06d7ce494ecebbc68aa
 SHA512:
-  metadata.gz: 402fab8bc9d1889cf311f2d9455f558f7fe2a4b6e4d4b9735277f2fe228350cb4aee5a593f8445c18ca8ef4a6884ab4481c1237f690f7521cf097fb616ccc8b5
-  data.tar.gz: bd27b379426d0cda3db948eeb01e458a9867f9dade37c1e8c80941806f891ca935b8b3a3ca8fb0a6605e214bda995896f41491e2499ffa85418965ce6a00293a
+  metadata.gz: 1230714c64c4756c0eb2e312502b322cb0466b97ee293a09306a2f5d43347857c69a27d2d19fa1b3abf40f4a86dc9099d022af498eced1f3aa1d99853a5cd98f
+  data.tar.gz: f4c7b55eb37bbcf67a4415f327bafc91802ead3ad4a07a39be1c1682b41e685b64f98a2d3983d6eb8145ab96097e7b1ac7edb77c62807392e8b34694d51f3619

data/.gitignore

@@ -1,2 +1,4 @@
 .DS_Store
 *.gem
+/tmp
+/coverage

data/.rubocop.yml

@@ -2,3 +2,9 @@ inherit_from: .rubocop_todo.yml
 
 Metrics/LineLength:
   Max: 100
+
+Metrics/BlockLength:
+  ExcludedMethods: ['it', 'describe', 'context', 'let', 'specify']
+
+AllCops:
+  TargetRubyVersion: 2.3

data/.rubocop_todo.yml

@@ -25,10 +25,10 @@ Metrics/MethodLength:
 Style/DoubleNegation:
   Exclude:
     - 'lib/logicality/interpreter/simple_interpreter.rb'
-    - 'lib/logicality/logic.rb'
+    - 'lib/logicality/logicality.rb'
 
 # Offense count: 1
 # Cop supports --auto-correct.
 Style/OrAssignment:
   Exclude:
-    - 'lib/logicality/logic.rb'
+    - 'lib/logicality/logicality.rb'

data/.ruby-version

@@ -1 +1 @@
-2.3.7
+2.6.0

data/.travis.yml

@@ -1,8 +1,20 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=20e69ab96711ba4fbc9e0ddce90bc3fc33cd5b110194aa778ed1ec227b597f09
 language: ruby
 rvm:
-  - 2.3.1
-  - 2.3.7
+  # Build on the latest stable of all supported Rubies (https://www.ruby-lang.org/en/downloads/):
+  - 2.3.8
+  - 2.4.5
+  - 2.5.3
+  - 2.6.0
 cache: bundler
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
 script:
   - bundle exec rubocop
   - bundle exec rspec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# 2.0.0 (January 30th, 2019)
+
+Maintenance Release + Top-Level API Change
+
+* Added bin/console script
+* Added CHANGELOG
+* Updated README with publication steps, additional testing steps
+* Bumped minimum Ruby to 2.3.8
+* Added Guard
+* Changed Logicality::Logic#evaluate to Logicality#evaluate (breaking change)

data/Gemfile.lock

@@ -1,19 +1,56 @@
 PATH
   remote: .
   specs:
-    logicality (1.0.5)
+    logicality (2.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ansi (1.5.0)
     ast (2.4.0)
+    coderay (1.1.2)
     diff-lcs (1.3)
-    jaro_winkler (1.5.1)
-    parallel (1.12.1)
-    parser (2.5.1.2)
+    docile (1.3.1)
+    ffi (1.10.0)
+    formatador (0.2.5)
+    guard (2.15.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    hirb (0.7.3)
+    jaro_winkler (1.5.2)
+    json (2.1.0)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    lumberjack (1.0.13)
+    method_source (0.9.2)
+    nenv (0.3.0)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parallel (1.13.0)
+    parser (2.6.0.0)
       ast (~> 2.4.0)
     powerpack (0.1.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
     rainbow (3.0.0)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.10.0)
+      ffi (~> 1.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -27,24 +64,39 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
-    rubocop (0.59.2)
+    rubocop (0.63.1)
       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)
+      unicode-display_width (~> 1.4.0)
     ruby-progressbar (1.10.0)
-    unicode-display_width (1.4.0)
+    ruby_dep (1.5.0)
+    shellany (0.0.1)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-console (0.4.2)
+      ansi
+      hirb
+      simplecov
+    simplecov-html (0.10.2)
+    thor (0.20.3)
+    unicode-display_width (1.4.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  guard-rspec (~> 4.7)
   logicality!
   rspec
-  rubocop (~> 0.59.2)
+  rubocop (~> 0.63.1)
+  simplecov (~> 0.16.1)
+  simplecov-console (~> 0.4.2)
 
 BUNDLED WITH
-   1.16.3
+   1.17.2

data/Guardfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/README.md

@@ -2,7 +2,7 @@
 
 # Logicality
 
-[![Build Status](https://travis-ci.org/bluemarblepayroll/logicality-rb.svg?branch=master)](https://travis-ci.org/bluemarblepayroll/logicality-rb)
+[![Gem Version](https://badge.fury.io/rb/logicality.svg)](https://badge.fury.io/rb/logicality) [![Build Status](https://travis-ci.org/bluemarblepayroll/logicality-rb.svg?branch=master)](https://travis-ci.org/bluemarblepayroll/logicality-rb) [![Maintainability](https://api.codeclimate.com/v1/badges/c5ed72e2a272ca34b3ce/maintainability)](https://codeclimate.com/github/bluemarblepayroll/logicality-rb/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/c5ed72e2a272ca34b3ce/test_coverage)](https://codeclimate.com/github/bluemarblepayroll/logicality-rb/test_coverage) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 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
@@ -19,7 +19,7 @@ resolving boolean values such as:
 
 ## Credit
 
-Deep inspiration was taken from [this set of articles](https://ruslanspivak.com/lsbasi-part7/).  
+Deep inspiration was taken from [this set of articles](https://ruslanspivak.com/lsbasi-part7/).
 Here, the author gives details around the theory and practical implementation of creating a basic
 language processor and compiler.
 
@@ -51,7 +51,7 @@ Now you can bind and evaluate this expression against passed in objects:
 
 ````
 record = { 'visible' => false, 'admin' => true }
-visible = Logicality::Logic.evaluate('visible || admin', record) # resolves to true.
+visible = Logicality.evaluate('visible || admin', record) # resolves to true.
 ````
 
 ### Plugging in a Custom Resolver
@@ -65,7 +65,7 @@ resolver = lambda do |value, input|
 end
 
 record = { visible: false, admin: true }
-visible = Logicality::Logic.evaluate('visible || admin', record) # resolves to true.
+visible = Logicality.evaluate('visible || admin', record, resolver) # resolves to true.
 ````
 
 ## Contributing
@@ -85,9 +85,37 @@ Basic steps to take to get this repository compiling:
 To execute the test suite run:
 
 ````
-rspec
+bundle exec rspec spec --format documentation
 ````
 
+Alternatively, you can have Guard watch for changes:
+
+````
+bundle exec guard
+````
+
+Also, do not forget to run Rubocop:
+
+````
+bundle exec rubocop
+````
+
+### Publishing
+
+Note: ensure you have proper authorization before trying to publish new versions.
+
+After code changes have successfully gone through the Pull Request review process then the following steps should be followed for publishing new versions:
+
+1. Merge Pull Request into master
+2. Update ```lib/logicality/version.rb``` using [semantic versioning](https://semver.org/)
+3. Install dependencies: ```bundle```
+4. Update ```CHANGELOG.md``` with release notes
+5. Commit & push master to remote and ensure CI builds master successfully
+6. Build the project locally: `gem build logicality`
+7. Publish package to RubyGems: `gem push logicality-X.gem` where X is the version to push
+8. Tag master with new version: `git tag <version>`
+9. Push tags remotely: `git push origin --tags`
+
 ## License
 
 This project is MIT Licensed.

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'logicality'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/lib/logicality/lexer/grammar.rb

@@ -11,12 +11,12 @@ module Logicality
   module Lexer
     # Define the main regular expression matchers used by the lexer.
     module Grammar
-      VALUE       = /([a-zA-Z0-9_$@?\.]+)/
-      AND_OP      = /(&&)/
-      OR_OP       = /(\|\|)/
-      NOT_OP      = /(\!)/
-      LEFT_PAREN  = /(\()/
-      RIGHT_PAREN = /(\))/
+      VALUE       = /([a-zA-Z0-9_$@?\.]+)/.freeze
+      AND_OP      = /(&&)/.freeze
+      OR_OP       = /(\|\|)/.freeze
+      NOT_OP      = /(\!)/.freeze
+      LEFT_PAREN  = /(\()/.freeze
+      RIGHT_PAREN = /(\))/.freeze
     end
   end
 end

data/lib/logicality/logicality.rb

@@ -10,4 +10,57 @@
 require_relative 'lexer/lexer'
 require_relative 'parser/parser'
 require_relative 'interpreter/interpreter'
-require_relative 'logic'
+
+# Module that defines the main class-level API for this library.
+module Logicality
+  class << self
+    def evaluate(expression, input = nil, resolver = nil)
+      node        = get(expression)
+      wrapper     = resolver_wrapper(input, resolver)
+      interpreter = Interpreter::SimpleInterpreter.new(wrapper)
+
+      interpreter.visit(node)
+    end
+
+    private
+
+    def resolver_wrapper(input, resolver)
+      if resolver
+        ->(value) { resolver.call(value, input) }
+      else
+        ->(value) { object_resolver.call(value, input) }
+      end
+    end
+
+    def object_resolver
+      lambda do |value, input|
+        return false unless input
+
+        if input.respond_to?(value)
+          !!input.send(value)
+        elsif input.respond_to?(:[])
+          !!input[value]
+        else
+          false
+        end
+      end
+    end
+
+    def cache
+      @cache ||= {}
+    end
+
+    def set(expression, node)
+      cache[expression] ||= node
+    end
+
+    def get(expression)
+      return cache[expression] if cache[expression]
+
+      lexer   = Lexer::RegexpLexer.new(expression)
+      parser  = Parser::SimpleParser.new(lexer)
+
+      set(expression, parser.parse)
+    end
+  end
+end

data/lib/logicality/version.rb

@@ -8,5 +8,5 @@
 #
 
 module Logicality
-  VERSION = '1.0.5'
+  VERSION = '2.0.0'
 end

data/logicality.gemspec

@@ -22,8 +22,11 @@ Gem::Specification.new do |s|
   s.homepage    = 'https://github.com/bluemarblepayroll/logicality-rb'
   s.license     = 'MIT'
 
-  s.required_ruby_version = '>= 2.3.1'
+  s.required_ruby_version = '>= 2.3.8'
 
+  s.add_development_dependency('guard-rspec', '~>4.7')
   s.add_development_dependency('rspec')
-  s.add_development_dependency('rubocop', '~> 0.59.2')
+  s.add_development_dependency('rubocop', '~>0.63.1')
+  s.add_development_dependency('simplecov', '~>0.16.1')
+  s.add_development_dependency('simplecov-console', '~>0.4.2')
 end

data/spec/{logic_spec.rb → logicality_spec.rb}

@@ -7,13 +7,13 @@
 # LICENSE file in the root directory of this source tree.
 #
 
-require './lib/logicality'
+require './spec/spec_helper'
 
 def run(tests)
   tests.each do |x|
     input = x[1] ? x[1].map { |k, v| [k.to_s, v] }.to_h : nil
 
-    result = Logicality::Logic.evaluate(x[0], input)
+    result = Logicality.evaluate(x[0], input)
 
     expect(result).to eq(x[2]), "Failed: #{x[0]} (input: #{input}): expected #{x[2]} got: #{result}"
   end
@@ -21,7 +21,7 @@ def run(tests)
   nil
 end
 
-describe Logicality::Logic do
+describe Logicality do
   context 'when evaluating' do
     it 'should evaluate boolean-only expressions' do
       tests = [

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2018-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require 'simplecov'
+require 'simplecov-console'
+
+SimpleCov.formatter = SimpleCov::Formatter::Console
+SimpleCov.start
+
+require './lib/logicality'

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: logicality
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 2.0.0
 platform: ruby
 authors:
 - Matthew Ruggio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-28 00:00:00.000000000 Z
+date: 2019-02-05 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -30,14 +44,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.59.2
+        version: 0.63.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.63.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.59.2
+        version: 0.4.2
 description: |2
       A common problem that many frameworks have is the ability to give developers
       an expressive intermediary scripting language or DSL.
@@ -45,7 +87,8 @@ description: |2
       expression evaluator.
 email:
 - mruggio@bluemarblepayroll.com
-executables: []
+executables:
+- console
 extensions: []
 extra_rdoc_files: []
 files:
@@ -55,10 +98,13 @@ files:
 - ".rubocop_todo.yml"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
+- Guardfile
 - LICENSE
 - README.md
+- bin/console
 - lib/logicality.rb
 - lib/logicality/interpreter/interpreter.rb
 - lib/logicality/interpreter/node_visitor.rb
@@ -67,7 +113,6 @@ files:
 - lib/logicality/lexer/lexer.rb
 - lib/logicality/lexer/regexp_lexer.rb
 - lib/logicality/lexer/token.rb
-- lib/logicality/logic.rb
 - lib/logicality/logicality.rb
 - lib/logicality/parser/ast/ast.rb
 - lib/logicality/parser/ast/binary_operator_node.rb
@@ -78,7 +123,8 @@ files:
 - lib/logicality/parser/simple_parser.rb
 - lib/logicality/version.rb
 - logicality.gemspec
-- spec/logic_spec.rb
+- spec/logicality_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/bluemarblepayroll/logicality-rb
 licenses:
 - MIT
@@ -91,17 +137,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.1
+      version: 2.3.8
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: String-based boolean expression evaluator
 test_files:
-- spec/logic_spec.rb
+- spec/logicality_spec.rb
+- spec/spec_helper.rb

data/lib/logicality/logic.rb

@@ -1,66 +0,0 @@
-# frozen_string_literal: true
-
-#
-# Copyright (c) 2018-present, Blue Marble Payroll, LLC
-#
-# This source code is licensed under the MIT license found in the
-# LICENSE file in the root directory of this source tree.
-#
-
-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)
-        interpreter = Interpreter::SimpleInterpreter.new(wrapper)
-
-        interpreter.visit(node)
-      end
-
-      private
-
-      def resolver_wrapper(input, resolver)
-        if resolver
-          ->(value) { resolver.call(value, input) }
-        else
-          ->(value) { object_resolver.call(value, input) }
-        end
-      end
-
-      def object_resolver
-        lambda do |value, input|
-          return false unless input
-
-          if input.respond_to?(value)
-            !!input.send(value)
-          elsif input.respond_to?(:[])
-            !!input[value]
-          else
-            false
-          end
-        end
-      end
-
-      def cache
-        @cache || {}
-      end
-
-      def set(expression, node)
-        @cache = {} unless @cache
-
-        @cache[expression] = node
-      end
-
-      def get(expression)
-        return cache[expression] if cache[expression]
-
-        lexer   = Lexer::RegexpLexer.new(expression)
-        parser  = Parser::SimpleParser.new(lexer)
-
-        set(expression, parser.parse)
-      end
-    end
-  end
-end