sexpistol 0.0.7 → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b217eeb6f0ed5af77c53a0a192ff94c6fc7a4d46486431e7745eac08760bfdc1
+  data.tar.gz: 73dc1ddefb3af80b10f3556bc284a16fdfef1fff8807f39b4cd219dff5d8c4ce
+SHA512:
+  metadata.gz: d2972b16e20179addf61a4190a00e40acbf974e70b54c49839cf220400600c70c57835e7190024d4019ee52d8233cbe78f28435b87e4988caf758e355ce4f208
+  data.tar.gz: 7d812ca13d3785640dd06d8e84cb77fe41d2a6dc94fbdd14f6b54ef1c8f4fe36620ddc4eaa7d7bcdf772f98e875d67bc565ba86d31eab144754d8be99b9d03f9

data/.github/workflows/ruby.yml

@@ -0,0 +1,30 @@
+name: build
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v1
+
+    - name: Install Ruby (2.6)
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+
+    - name: Setup Code Climate test-reporter
+      run: |
+        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
+    - name: Build and test with RSpec
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec rspec
+    - name: Publish code coverage
+      run: |
+        export GIT_BRANCH="${GITHUB_REF/refs\/heads\//}"
+        ./cc-test-reporter after-build --id ${{secrets.CC_TEST_REPORTER_ID}} --coverage-input-type simplecov

data/.gitignore

@@ -1 +1,3 @@
-*.gem
+*.gem
+.DS_Store
+coverage

data/.rspec

@@ -0,0 +1,2 @@
+--format progress
+--color

data/.rubocop.yml

@@ -0,0 +1,27 @@
+Metrics/BlockLength:
+  IgnoredMethods: ['describe', 'context']
+
+Style/SymbolProc:
+  IgnoredMethods: ['configure']
+
+AllCops:
+  SuggestExtensions: false
+  NewCops: enable
+
+Lint/BooleanSymbol:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/MethodLength:
+  Max: 15
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+  
+Gemspec/RequireMFA:
+  Enabled: false

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,61 @@
+PATH
+  remote: .
+  specs:
+    sexpistol (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    docile (1.3.5)
+    json (2.6.1)
+    parallel (1.21.0)
+    parser (3.1.0.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    regexp_parser (2.2.0)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    rubocop (1.24.1)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.15.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.15.1)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    simplecov (0.17.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec (~> 3.2)
+  rubocop
+  sexpistol!
+  simplecov (~> 0.17.1)
+
+BUNDLED WITH
+   2.3.4

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010 Aaron Gough (http://thingsaaronmade.com/)
+Copyright (c) 2022 Aaron Gough (http://thingsaaronmade.com/)
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -0,0 +1,135 @@
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop/rubocop)
+![Actions Status](https://github.com/aarongough/sexpistol/actions/workflows/ruby.yml/badge.svg)
+[![Maintainability](https://api.codeclimate.com/v1/badges/a5ce9269a7b23614103c/maintainability)](https://codeclimate.com/github/aarongough/sexpistol/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/a5ce9269a7b23614103c/test_coverage)](https://codeclimate.com/github/aarongough/sexpistol/test_coverage)
+[![Gem Version](https://badge.fury.io/rb/sexpistol.svg)](https://badge.fury.io/rb/sexpistol)
+
+# Sexpistol
+
+Sexpistol is a very fast and easy-to-use library for parsing S-Expressions in Ruby. Sexpistol takes an S-Expression in string form and turns it into a native Ruby data structure made up of nested sets of arrays.
+
+### Example:
+
+```scheme
+(define test (lambda () (
+  (print "Hello world!\n")
+  (print 1)
+  (print 9.01)
+  (print 2.0e10)
+  (print (+ 10 12 13))
+)))
+```
+  
+would be parsed by Sexpistol like so:
+
+```ruby
+[:define, :test, [:lambda, [], [
+  [:print, "Hello world!\n"],
+  [:print, 1],
+  [:print, 9.01],
+  [:print, 2.0e10],
+  [:print, [:+, 10, 12, 13]]
+]]]
+```
+
+### Usage:
+
+```ruby
+# Parse an s-expression
+ast = Sexpistol.parse("(string (to (parse)))")
+#=> [:string, [:to, [:parse]]]
+
+# Change the representation
+ast[1][0] = :is
+ast[1][1][0] = :parsed
+#=> [:string, [:is, [:parsed]]]
+
+# Turn the array structure back into an S-Expression
+Sexpistol.to_sexp(ast)
+#=> "(string (is (parsed)))"
+```
+
+### API:
+```ruby
+Sexpistol.parse(string, parse_ruby_keyword_literals: false)
+# Parse an s-expression given as a string. Optionally convert 
+# ruby keyword literals to their native Ruby equivalents.
+
+Sexpistol.to_sexp(structure, scheme_compatability: false)
+# Output a nested set of arrays as an s-expression. Optionally 
+# output `true, false, nil` as their Scheme literal equivalents.
+
+Sexpistol.convert_ruby_keyword_literals(data)
+# Recursively maps over a nested array structure and converts 
+# any instances of :nil, :true, :false to their native Ruby equivalents.
+
+Sexpistol.convert_scheme_literals(data)
+# Converts Ruby literals to their equivalent Scheme literals
+
+Sexpistol.recursive_map(data, &block)
+# Recursively map over a nested set of arrays, applying the block 
+# to each item and returning the result.
+```
+  
+### Type mappings:
+
+Sexpistol supports all of the standard datatypes and converts them directly to their Ruby equivalents:
+
+- Lists (a b c) -> `[:a, :b, :c]`
+- Integers (1 2 3) -> `[1, 2, 3]`
+- Floats (1.0 42.9 3e6 1.2e2) -> `[1.0, 42.9, 3e6, 1.2e2]`
+- Strings ("\t\"Hello world!\"\n") -> `["\t\"Hello world!\"\n"]`
+- Symbols (symbol symbol? + - a+ e$, etc...) -> `[:symbol, :symbol?, :+, :-, :a+, :'e$', :'etc...']`
+
+Sexpistol also supports mapping the Ruby keyword literals (`nil`, `true`, `false`) to their native Ruby types, although this is disabled by default for compatibility. To enable it use `parse_ruby_keyword_literals: true`, eg:
+ 
+```ruby 
+Sexpistol.parse("(nil false true)")
+#=> [:nil, :false, :true]
+
+Sexpistol.parse("(nil false true)", parse_ruby_keyword_literals: true)
+#=> [nil, false, true]
+```
+  
+### Scheme compatibility:
+
+Sexpistol strives to be compatible with Scheme-style S-Expressions. Sexpistol can generate Scheme compatible external representations when the 'scheme_compatability' option is set to true:
+
+```ruby
+Sexpistol.to_sexp([true, false, nil])
+#=> "(true false nil)"
+
+Sexpistol.to_sexp([true, false, nil], scheme_compatability: true)
+#=> "(#t #f ())"
+```
+  
+### Installation:
+
+Add Sexpistol to your gemfile:
+
+```ruby
+gem 'sexpistol', '~>0.10.0'
+```
+
+And then execute:
+
+```
+bundle install
+```
+
+Or install it manually by entering the following at your command line:
+
+```
+gem install sexpistol
+```
+
+### Contributing:
+
+Contributions are always welcome! Please create a pull request that clearly outlines the work you've done. Make sure your changes include updating or adding relevant tests, and use [Rubocop](https://github.com/rubocop/rubocop) to make sure your additions adhere to the same style as the rest of the project!
+
+### Author & Credits:
+
+Author: [Aaron Gough](mailto:aaron@aarongough.com)
+Contributors: [Shane Hanna](http://github.com/shanna)
+
+Copyright © 2022 [Aaron Gough](http://thingsaaronmade.com/), released under the MIT license

data/lib/sexpistol/parser.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'strscan'
+
+class Sexpistol
+  class Parser < StringScanner
+    PARANTHESES = /[()]/.freeze
+    STRING =      /"([^"\\]|\\.)*"/.freeze
+    FLOAT =       /[\-+]? [0-9]+ ((e[0-9]+) | (\.[0-9]+(e[0-9]+)?)) [\s()]/x.freeze
+    INTEGER =     /[\-+]?[0-9]+[\s()]/.freeze
+    SYMBOL =      /[^0-9()\s]+[^()\s]*/.freeze
+
+    def initialize(string)
+      raise 'String given is not an s-expression' if string.strip[0] != '('
+      raise 'Invalid s-expression' if string.count('(') != string.count(')')
+
+      super(string.strip)
+    end
+
+    def parse(level = 0, exp = [])
+      until eos?
+        case token = fetch_token
+        when ')' then break
+        when '(' then exp << parse(level + 1)
+        when String, Integer, Float, Symbol then exp << token
+        end
+      end
+
+      if level.zero?
+        exp = exp.first if exp.first.is_a?(Array) && exp.length == 1
+        exp = Sexpistol::SExpressionArray.new(exp) if exp.all? { |item| item.is_a?(Array) }
+      end
+
+      exp
+    end
+
+    def fetch_token
+      skip(/\s+/)
+
+      return matched        if scan(PARANTHESES)
+      return matched.undump if scan(STRING)
+      return matched.to_f   if scan(FLOAT)
+      return matched.to_i   if scan(INTEGER)
+      return matched.to_sym if scan(SYMBOL)
+
+      raise "Invalid token at position #{pos} near '#{scan(/.{0,20}/)}'."
+    end
+  end
+end

data/lib/sexpistol/s_expression_array.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+class Sexpistol
+  class SExpressionArray < Array
+  end
+end

data/lib/sexpistol/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Sexpistol
+  VERSION = '0.1.0'
+end

data/lib/sexpistol.rb

@@ -1,2 +1,53 @@
-require File.expand_path(File.join(File.dirname(__FILE__), 'sexpistol', 'sexpistol_parser.rb'))
-require File.expand_path(File.join(File.dirname(__FILE__), 'sexpistol', 'sexpistol.rb'))
+# frozen_string_literal: true
+
+require 'sexpistol/parser'
+require 'sexpistol/version'
+require 'sexpistol/s_expression_array'
+
+class Sexpistol
+  def self.parse(string, parse_ruby_keyword_literals: false)
+    tree = Sexpistol::Parser.new(string).parse
+    return convert_ruby_keyword_literals(tree) if parse_ruby_keyword_literals
+
+    tree
+  end
+
+  def self.to_sexp(data, scheme_compatability: false)
+    data = convert_scheme_literals(data) if scheme_compatability
+
+    return "\"#{data}\"" if data.is_a?(String)
+    return data.to_s unless data.is_a?(Array)
+
+    if data.is_a?(SExpressionArray)
+      data.map { |x| to_sexp(x, scheme_compatability: scheme_compatability) }.join(' ')
+    else
+      "(#{data.map { |x| to_sexp(x, scheme_compatability: scheme_compatability) }.join(' ')})"
+    end
+  end
+
+  def self.convert_ruby_keyword_literals(expression)
+    recursive_map(expression) do |x|
+      case x
+      when :nil then nil
+      when :true then true
+      when :false then false
+      else x
+      end
+    end
+  end
+
+  def self.convert_scheme_literals(data)
+    case data
+    when nil then []
+    when true then :'#t'
+    when false then :'#f'
+    else data
+    end
+  end
+
+  def self.recursive_map(data, &block)
+    return data.map { |x| recursive_map(x, &block) } if data.is_a?(Array)
+
+    block.call(data)
+  end
+end

data/sexpistol.gemspec

@@ -1,70 +1,31 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
-# -*- encoding: utf-8 -*-
+# frozen_string_literal: true
 
-Gem::Specification.new do |s|
-  s.name = %q{sexpistol}
-  s.version = "0.0.7"
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sexpistol/version'
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Aaron Gough"]
-  s.date = %q{2010-10-15}
-  s.description = %q{Sexpistol is an easy-to-use S-Expression parser for Ruby. It is fast and has no dependencies.}
-  s.email = %q{aaron@aarongough.com}
-  s.extra_rdoc_files = [
-    "MIT-LICENSE",
-     "README.rdoc"
-  ]
-  s.files = [
-    ".gitignore",
-     "MIT-LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "lib/sexpistol.rb",
-     "lib/sexpistol/sexpistol.rb",
-     "lib/sexpistol/sexpistol_parser.rb",
-     "sexpistol.gemspec",
-     "test/performance/benchmark_test.rb",
-     "test/setup/test_unit_extensions.rb",
-     "test/test_helper.rb",
-     "test/unit/float_literal_test.rb",
-     "test/unit/integer_literal_test.rb",
-     "test/unit/ruby_keyword_literals_test.rb",
-     "test/unit/scheme_compatability_test.rb",
-     "test/unit/string_literal_test.rb",
-     "test/unit/structure_test.rb",
-     "test/unit/symbol_test.rb",
-     "test/unit/to_sexp_test.rb"
-  ]
-  s.homepage = %q{http://github.com/aarongough/sexpistol}
-  s.rdoc_options = ["--charset=UTF-8", "--line-numbers", "--inline-source"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{An S-Expression Parser Library for Ruby}
-  s.test_files = [
-    "test/performance/benchmark_test.rb",
-     "test/setup/test_unit_extensions.rb",
-     "test/test_helper.rb",
-     "test/unit/float_literal_test.rb",
-     "test/unit/integer_literal_test.rb",
-     "test/unit/ruby_keyword_literals_test.rb",
-     "test/unit/scheme_compatability_test.rb",
-     "test/unit/string_literal_test.rb",
-     "test/unit/structure_test.rb",
-     "test/unit/symbol_test.rb",
-     "test/unit/to_sexp_test.rb"
-  ]
+Gem::Specification.new do |spec|
+  spec.name          = 'sexpistol'
+  spec.version       = Sexpistol::VERSION
+  spec.authors       = ['Aaron Gough']
+  spec.email         = ['aaron@aarongough.com']
 
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
+  spec.summary       = 'Sexpistol is an easy-to-use S-Expression parser for Ruby. It is fast and has no dependencies.'
+  spec.description   = 'Sexpistol is an easy-to-use S-Expression parser for Ruby. It is fast and has no dependencies.'
+  spec.homepage      = 'https://github.com/aarongough/sexpistol'
+  spec.license       = 'MIT'
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-    else
-    end
-  else
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
   end
-end
 
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.5.0'
+
+  spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'simplecov', '~> 0.17.1'
+end

metadata

@@ -1,96 +1,100 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: sexpistol
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 7
-  version: 0.0.7
+version: !ruby/object:Gem::Version
+  version: 0.1.0
 platform: ruby
-authors: 
+authors:
 - Aaron Gough
-autorequire: 
-bindir: bin
+autorequire:
+bindir: exe
 cert_chain: []
-
-date: 2010-10-15 00:00:00 -04:00
-default_executable: 
-dependencies: []
-
-description: Sexpistol is an easy-to-use S-Expression parser for Ruby. It is fast and has no dependencies.
-email: aaron@aarongough.com
+date: 2022-01-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+description: Sexpistol is an easy-to-use S-Expression parser for Ruby. It is fast
+  and has no dependencies.
+email:
+- aaron@aarongough.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- MIT-LICENSE
-- README.rdoc
-files: 
-- .gitignore
+extra_rdoc_files: []
+files:
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
 - MIT-LICENSE
-- README.rdoc
-- Rakefile
-- VERSION
+- README.md
 - lib/sexpistol.rb
-- lib/sexpistol/sexpistol.rb
-- lib/sexpistol/sexpistol_parser.rb
+- lib/sexpistol/parser.rb
+- lib/sexpistol/s_expression_array.rb
+- lib/sexpistol/version.rb
 - sexpistol.gemspec
-- test/performance/benchmark_test.rb
-- test/setup/test_unit_extensions.rb
-- test/test_helper.rb
-- test/unit/float_literal_test.rb
-- test/unit/integer_literal_test.rb
-- test/unit/ruby_keyword_literals_test.rb
-- test/unit/scheme_compatability_test.rb
-- test/unit/string_literal_test.rb
-- test/unit/structure_test.rb
-- test/unit/symbol_test.rb
-- test/unit/to_sexp_test.rb
-has_rdoc: true
-homepage: http://github.com/aarongough/sexpistol
-licenses: []
-
-post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
-- --line-numbers
-- --inline-source
-require_paths: 
+homepage: https://github.com/aarongough/sexpistol
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: 
-rubygems_version: 1.3.7
-signing_key: 
-specification_version: 3
-summary: An S-Expression Parser Library for Ruby
-test_files: 
-- test/performance/benchmark_test.rb
-- test/setup/test_unit_extensions.rb
-- test/test_helper.rb
-- test/unit/float_literal_test.rb
-- test/unit/integer_literal_test.rb
-- test/unit/ruby_keyword_literals_test.rb
-- test/unit/scheme_compatability_test.rb
-- test/unit/string_literal_test.rb
-- test/unit/structure_test.rb
-- test/unit/symbol_test.rb
-- test/unit/to_sexp_test.rb
+rubygems_version: 3.0.8
+signing_key:
+specification_version: 4
+summary: Sexpistol is an easy-to-use S-Expression parser for Ruby. It is fast and
+  has no dependencies.
+test_files: []