sexpr 0.6.0 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 67f9fda1b0281f22e49fc267f432c1bed5ba6f270911b0470786662533d257d0
+  data.tar.gz: 97b7fc7fce491b594f4fb52a06daa5837407a5d5db59ab6bb6ae56e517e38492
+SHA512:
+  metadata.gz: 808fbbb1bd28d417addfd740a85c441e022208ed87111a713bd4cd1920254b606181c3c8a2bbabd2c4fcaa707543b11d3baa1db6e661378fa7f7b350256599f7
+  data.tar.gz: 2c3795497e39ededc4cec8897fd178a34911fa3647a40561d8218da19bc9b72671de4b6d86bbd5854beb1d9ebc2907d86536d33531fe7c8b38074338c8824263

data/CHANGELOG.md

@@ -1,4 +1,10 @@
-# 0.6.0 / 2013-09-26
+# 1.0.0 / 2021-12-11
+
+* Upgrade project structure to modern Enspirit practices
+
+* Citrus dependency upgraded to 3.x and code fixed accordingly
+
+# 0.6.0 / 2012-09-13
 
 * Major enhancements (possibly breaking changes)
 

data/Gemfile

@@ -1,9 +1,2 @@
 source 'http://rubygems.org'
-
-group :development do
-  gem "path", "~> 1.3"
-  gem "citrus", "~> 2.4"
-  gem "rake", "~> 10.0"
-  gem "rspec", "~> 2.10"
-  gem "wlang", "~> 0.10.2"
-end
+gemspec

data/README.md

@@ -1,8 +1,5 @@
 # Sexpr
 
-[![Build Status](https://secure.travis-ci.org/blambeau/sexpr.png)](http://travis-ci.org/blambeau/sexpr)
-[![Dependency Status](https://gemnasium.com/blambeau/sexpr.png)](https://gemnasium.com/blambeau/sexpr)
-
 A ruby compilation framework around s-expressions.
 
 ## Links
@@ -87,4 +84,29 @@ https://github.com/blambeau/sexpr
 
 ### Where to read next?
 
-Have a look at the examples directory.
+Have a look at the examples directory.
+
+## Public API
+
+`sexpr` uses Semver and reached 1.0. The public API is as follows:
+
+* The structure of YAML grammar files
+* The `Sexpr` module and its public methods
+* The behavior of the `Grammar` class through its public methods
+* The behavior of the `Node` class (public methods)
+* The behavior of the `Processor` and `Rewriter` classes (public & protected methods)
+* The list of error classes and when they are raised
+
+## Contribute
+
+Please use github issues and pull requests for all questions, bug reports,
+and contributions. Don't hesitate to get in touch with us with an early code
+spike if you plan to add non trivial features.
+
+## Licence
+
+This software is distributed by Enspirit SRL under a MIT Licence. Please
+contact Bernard Lambeau (blambeau@gmail.com) with any question.
+
+Enspirit (https://enspirit.be) and Klaro App (https://klaro.cards) are both
+actively using and contributing to the library.

data/lib/sexpr/version.rb

@@ -1,8 +1,8 @@
 module Sexpr
   module Version
 
-    MAJOR = 0
-    MINOR = 6
+    MAJOR = 1
+    MINOR = 0
     TINY  = 0
 
     def self.to_s

data/lib/sexpr.rb

@@ -1,6 +1,5 @@
 require 'yaml'
 require_relative "sexpr/version"
-require_relative "sexpr/loader"
 require_relative "sexpr/errors"
 require_relative "sexpr/node"
 require_relative "sexpr/grammar"
@@ -14,6 +13,8 @@ require_relative "sexpr/rewriter"
 module Sexpr
   extend Grammar::Tagging
 
+  YAML_OPTIONS = { :permitted_classes => %w[Regexp], :aliases => true }
+
   PathLike = lambda{|x|
     x.respond_to?(:to_path) or (x.is_a?(String) and File.exists?(x))
   }
@@ -30,11 +31,11 @@ module Sexpr
 
   def self.load_file(input, options = {})
     path = input.to_path rescue input.to_s
-    load_hash YAML.load_file(path), options.merge(:path => input)
+    load_hash load_yaml(File.read(path)), options.merge(:path => input)
   end
 
   def self.load_string(input, options = {})
-    load_hash YAML.load(input), options
+    load_hash load_yaml(input), options
   end
 
   def self.load_hash(input, options = {})
@@ -42,4 +43,11 @@ module Sexpr
     Grammar.new input, options
   end
 
+  def self.load_yaml(source)
+    if YAML.name == 'Psych' && Psych::VERSION >= '3.1'
+      YAML.safe_load(source, **YAML_OPTIONS)
+    else
+      YAML.load(source)
+    end
+  end
 end # module Sexpr

data/spec/integration/bool_expr/test_validation.rb

@@ -3,13 +3,13 @@ describe BoolExpr, 'the validation feature' do
   subject{ BoolExpr }
 
   it 'validates s-expressions' do
-    subject.match?([:bool_lit, true]).should be_true
-    subject.match?([:bool_lit, "x"]).should be_false
+    subject.match?([:bool_lit, true]).should be_truthy
+    subject.match?([:bool_lit, "x"]).should be_falsey
   end
 
   it 'validates s-expressions against specific rules' do
-    subject[:bool_lit].match?([:bool_lit, true]).should be_true
-    subject[:bool_and].match?([:bool_lit, true]).should be_false
+    subject[:bool_lit].match?([:bool_lit, true]).should be_truthy
+    subject[:bool_and].match?([:bool_lit, true]).should be_falsey
   end
 
 end

data/spec/integration/test_readme_examples.rb

@@ -35,15 +35,15 @@ describe "the README examples" do
 
     # the grammar can be used to verify the structure of s-expressions
     f = (grammar === [:bool_and, [:bool_not, [:var_ref, "x"]], [:bool_lit, true]])
-    f.should be_true
+    f.should be_truthy
 
     f = (grammar === [:bool_and, [:bool_lit, "true"]])
-    f.should be_false
+    f.should be_falsey
 
     # the grammar can also be used to automatically have support on top of
     # such s-expressions
     expr = grammar.sexpr([:bool_lit, true])
-    (Sexpr===expr).should be_true
+    (Sexpr===expr).should be_truthy
 
     (expr.sexpr_type).should eq(:bool_lit)
     # => :bool_lit
@@ -58,7 +58,7 @@ describe "the README examples" do
     copy.should eq([:bool_lit, [:bool_lit, false]])
     # => [:bool_lit, [:bool_lit, false]]
 
-    (Sexpr===copy).should be_true
+    (Sexpr===copy).should be_truthy
 
   end
 

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 require 'path'
 root = Path.backfind('.[lib]')
 
+require 'rspec'
 require 'citrus'
 
 $LOAD_PATH.unshift (root/"lib").to_s

data/spec/unit/grammar/matching/test_compile_rule_defn.rb

@@ -72,7 +72,7 @@ module Sexpr
         end
         it 'compiles its elements' do
           subject.terms.size.should eq(3)
-          subject.terms.all?{|x| x.is_a?(Matcher::Terminal)}.should be_true
+          subject.terms.all?{|x| x.is_a?(Matcher::Terminal)}.should be_truthy
         end
       end
 
@@ -83,7 +83,7 @@ module Sexpr
         end
         it 'compiles its elements' do
           subject.terms.size.should eq(3)
-          subject.terms.all?{|x| x.is_a?(Matcher::Terminal)}.should be_true
+          subject.terms.all?{|x| x.is_a?(Matcher::Terminal)}.should be_truthy
         end
       end
 

data/spec/unit/grammar/matching/test_compile_rules.rb

@@ -17,7 +17,7 @@ module Sexpr
       }
 
       let(:rules){
-        YAML.load(yaml)
+        Sexpr.load_yaml(yaml)
       }
 
       subject{ compile_rules(rules) }

data/spec/unit/grammar/tagging/test_looks_a_sexpr.rb

@@ -4,16 +4,16 @@ module Sexpr::Grammar
     include Tagging
 
     it 'recognizes s-expressions' do
-      looks_a_sexpr?([:lit]).should be_true
+      looks_a_sexpr?([:lit]).should be_truthy
     end
 
     it 'does not recognize empty arrays' do
-      looks_a_sexpr?([]).should be_false
+      looks_a_sexpr?([]).should be_falsey
     end
 
     it 'does not recognize others' do
-      looks_a_sexpr?(nil).should be_false
-      looks_a_sexpr?(:lit).should be_false
+      looks_a_sexpr?(nil).should be_falsey
+      looks_a_sexpr?(:lit).should be_falsey
     end
 
   end

data/spec/unit/matcher/non_terminal/test_match_q.rb

@@ -10,7 +10,7 @@ module Sexpr::Matcher
     context 'when match' do
       let(:sexpr){ [:hello, "world"] }
 
-      it{ should be_true }
+      it{ should be_truthy }
     end
 
     [
@@ -24,7 +24,7 @@ module Sexpr::Matcher
       context "when no match, e.g. #{example.inspect}" do
         let(:sexpr){ example }
 
-        it{ should be_false }
+        it{ should be_falsey }
       end
     end
 

data/spec/unit/matcher/reference/test_match_q.rb

@@ -7,7 +7,7 @@ module Sexpr::Matcher
 
     it 'returns true on match' do
       rule.should be_match("hello")
-      (rule === "hello").should be_true
+      (rule === "hello").should be_truthy
     end
 
     it 'returns false on no match' do

data/spec/unit/matcher/terminal/test_match_q.rb

@@ -9,7 +9,7 @@ module Sexpr::Matcher
 
       it 'returns true on match' do
         rule.should be_match(true)
-        (rule === true).should be_true
+        (rule === true).should be_truthy
       end
 
       it 'returns false on no match' do
@@ -25,7 +25,7 @@ module Sexpr::Matcher
 
       it 'returns true on match' do
         rule.should be_match(false)
-        (rule === false).should be_true
+        (rule === false).should be_truthy
       end
 
       it 'returns false on no match' do
@@ -41,7 +41,7 @@ module Sexpr::Matcher
 
       it 'returns true on match' do
         rule.should be_match(nil)
-        (rule === nil).should be_true
+        (rule === nil).should be_truthy
       end
 
       it 'returns false on no match' do

data/spec/unit/matcher/terminal/test_terminal_match.rb

@@ -12,19 +12,19 @@ module Sexpr::Matcher
       let(:arg){ /^[a-z]+$/ }
 
       it 'matches a matching string' do
-        terminal.terminal_match?("hello").should be_true
+        terminal.terminal_match?("hello").should be_truthy
       end
 
       it 'matches a non matching string' do
-        terminal.terminal_match?("12").should be_false
+        terminal.terminal_match?("12").should be_falsey
       end
 
       it 'does not match a sexp' do
-        terminal.terminal_match?([:sexp, "Hello World"]).should be_false
+        terminal.terminal_match?([:sexp, "Hello World"]).should be_falsey
       end
 
       it 'does not match nil' do
-        terminal.terminal_match?(nil).should be_false
+        terminal.terminal_match?(nil).should be_falsey
       end
     end
 
@@ -32,18 +32,18 @@ module Sexpr::Matcher
       let(:arg){ true }
 
       it 'matches true' do
-        terminal.terminal_match?(true).should be_true
+        terminal.terminal_match?(true).should be_truthy
       end
 
       it 'does not match false/nil' do
-        terminal.terminal_match?(false).should be_false
-        terminal.terminal_match?(nil).should be_false
+        terminal.terminal_match?(false).should be_falsey
+        terminal.terminal_match?(nil).should be_falsey
       end
 
       it 'does not match anything else' do
-        terminal.terminal_match?([]).should be_false
-        terminal.terminal_match?([:sexp]).should be_false
-        terminal.terminal_match?("true").should be_false
+        terminal.terminal_match?([]).should be_falsey
+        terminal.terminal_match?([:sexp]).should be_falsey
+        terminal.terminal_match?("true").should be_falsey
       end
     end
 
@@ -51,18 +51,18 @@ module Sexpr::Matcher
       let(:arg){ false }
 
       it 'matches false' do
-        terminal.terminal_match?(false).should be_true
+        terminal.terminal_match?(false).should be_truthy
       end
 
       it 'does not match true/nil' do
-        terminal.terminal_match?(true).should be_false
-        terminal.terminal_match?(nil).should be_false
+        terminal.terminal_match?(true).should be_falsey
+        terminal.terminal_match?(nil).should be_falsey
       end
 
       it 'does not match anything else' do
-        terminal.terminal_match?([]).should be_false
-        terminal.terminal_match?([:sexp]).should be_false
-        terminal.terminal_match?("false").should be_false
+        terminal.terminal_match?([]).should be_falsey
+        terminal.terminal_match?([:sexp]).should be_falsey
+        terminal.terminal_match?("false").should be_falsey
       end
     end
 
@@ -70,18 +70,18 @@ module Sexpr::Matcher
       let(:arg){ nil }
 
       it 'matches nil' do
-        terminal.terminal_match?(nil).should be_true
+        terminal.terminal_match?(nil).should be_truthy
       end
 
       it 'does not match true/false' do
-        terminal.terminal_match?(true).should be_false
-        terminal.terminal_match?(false).should be_false
+        terminal.terminal_match?(true).should be_falsey
+        terminal.terminal_match?(false).should be_falsey
       end
 
       it 'does not match anything else' do
-        terminal.terminal_match?([]).should be_false
-        terminal.terminal_match?([:sexp]).should be_false
-        terminal.terminal_match?("nil").should be_false
+        terminal.terminal_match?([]).should be_falsey
+        terminal.terminal_match?([:sexp]).should be_falsey
+        terminal.terminal_match?("nil").should be_falsey
       end
     end
 
@@ -89,18 +89,18 @@ module Sexpr::Matcher
       let(:arg){ Symbol }
 
       it 'matches a symbol' do
-        terminal.terminal_match?(:hello).should be_true
+        terminal.terminal_match?(:hello).should be_truthy
       end
 
       it 'does not match a string' do
-        terminal.terminal_match?("hello").should be_false
+        terminal.terminal_match?("hello").should be_falsey
       end
 
       it 'does not match anything else' do
-        terminal.terminal_match?(nil).should be_false
-        terminal.terminal_match?([]).should be_false
-        terminal.terminal_match?([:sexp]).should be_false
-        terminal.terminal_match?("nil").should be_false
+        terminal.terminal_match?(nil).should be_falsey
+        terminal.terminal_match?([]).should be_falsey
+        terminal.terminal_match?([:sexp]).should be_falsey
+        terminal.terminal_match?("nil").should be_falsey
       end
     end
 

data/spec/unit/parser/citrus/test_recognize.rb

@@ -11,7 +11,7 @@ module Sexpr::Parser
     end
 
     it 'returns false when not recognized' do
-      (Citrus.recognizes?(self)).should be_false
+      (Citrus.recognizes?(self)).should be_falsey
     end
 
   end

data/spec/unit/test_sexpr.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 describe Sexpr do
 
   it "should have a version number" do
-    Sexpr.const_defined?(:VERSION).should be_true
+    Sexpr.const_defined?(:VERSION).should be_truthy
   end
 
 end

data/tasks/test.rake

@@ -1,26 +1,11 @@
-require "rspec/core/rake_task"
 namespace :test do
+  require 'rspec/core/rake_task'
 
-  desc "Run unit tests"
+  desc %q{Run all RSpec tests}
   RSpec::Core::RakeTask.new(:unit) do |t|
-    t.pattern = "spec/unit/**/test_*.rb"
-    t.fail_on_error = true
-    t.failure_message = nil
-    t.verbose = true
-    t.rspec_path = "rspec"
-    t.rspec_opts = ["--color", "--backtrace"]
+    t.rspec_opts = %w[-I. -Ilib -Ispec --pattern=spec/**/test_*.rb --color .]
   end
 
-  desc "Run unit tests"
-  RSpec::Core::RakeTask.new(:integration) do |t|
-    t.pattern = "spec/integration/**/test_*.rb"
-    t.fail_on_error = true
-    t.failure_message = nil
-    t.verbose = true
-    t.rspec_path = "rspec"
-    t.rspec_opts = ["--color", "--backtrace"]
-  end
-
-  task :all => [ :unit, :integration ]
+  task :all => :"unit"
 end
-task :test => [ :"test:all" ]
+task :test => :"test:all"