edn2023 1.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b6536c5d243ceaf4962408fcdf528d7bf983b13223284562de5377ab692a7f2e
+  data.tar.gz: 8b186c8112be6fbf2194562b20a538780cfc118bb819ec0098a4a89a77b856fa
+SHA512:
+  metadata.gz: 7ae3d3d1b5ee8449e977644c11fc0f6aa546d13556bbc687a6526658e162f7190608ff68f42763f79fbe8d34a85353d741d716ded46f1017fe2fb0e881b8c9f0
+  data.tar.gz: aae587f32dca3595f9a3a4526175ed6af9488e9c3a1be5c706bab3ec6d3ccb8568cf70638e63ffc3e6fc426c4b21c2379b4672f688e9b0abcee795b150c20b9a

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.rspec
+README.html
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - "1.9.2"
+  - "2.1.0"
+  - "3.2.0"
+  - jruby-head
+script: bundle exec rspec spec

data/CHANGELOG.md

@@ -0,0 +1,29 @@
+# 1.1.4 (March 9, 2023)
+
+* Forked to support Ruby 3.2. <https://github.com/edn2023/edn2023> New RubyGem `edn2023`. (@edn2023)
+
+
+# 1.1.2 (January 13, 2020)
+
+* BigDecimal.new() -> BigDecimal() for Ruby 2.7 (BigDecimal 2). (@caleb)
+
+
+# 1.0.2
+* Handle numbers with M precision
+
+# 1.0.1
+* EDN.register defaults to the identity function when no handler is given
+
+# 0.9.4 (18 Sep 2012)
+
+* Require `set`
+
+# 0.9.3 (17 Sep 2012)
+
+* Updated to latest EDN spec
+** Added new symbol characters
+** Added ability to have a + before a number
+
+# 0.9.2 (13 Sep 2012)
+
+* EDN spec fully implemented

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in edn.gemspec
+gemspec
+
+

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Relevance Inc & Clinton N. Dreisbach
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,268 @@
+# edn2023
+
+© 2012 Relevance Inc
+
+**edn2023** is a Ruby library to read and write EDN (extensible data notation), a subset of Clojure used for transferring data between applications, much like JSON, YAML, or XML.
+
+## Installation
+
+If the `edn` gem is installed it should be uninstalled:
+
+    $ gem uninstall edn
+
+Add this line to your application's Gemfile:
+
+    gem 'edn2023'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install edn2023
+
+
+Note that you might also want to look at [edn_turbo](https://github.com/edporras/edn_turbo)
+which provides a much faster EDN parser (It's written in C) with an interface that is largely compatible
+with ths gem.
+
+## Usage
+
+To read a string of EDN:
+
+```ruby
+require 'edn'
+EDN.read('[1 2 {:foo "bar"}]')
+```
+
+Alternatively you can pass in an IO instance, for
+example an open file:
+
+```ruby
+File.open("data.edn") do |f|
+  data = EDN.read(f)
+  # Do something with data
+end
+```
+
+By default EDN.read will throw an execption
+if you try to read past the end of the data:
+
+```ruby
+EDN.read("")   # Boom!
+```
+
+Alternatively, the `EDN.read` method takes an optional
+parameter, which is the value to return
+when it hits the end of data:
+
+```ruby
+EDN.read("", :nomore)
+
+#=> :nomore
+```
+
+There is no problem using `nil` as an eof value.
+
+### EDN::Reader
+
+You can also do things in a more object oriented way by
+creating instances of `EDN::Reader`:
+
+```ruby
+r = EDN::Reader.new('[1 2 3] {:a 1 :b 2}')
+
+r.read #=> [1, 2, 3]
+r.read #=> {:a => 1, :b => 2}
+r.read #=> RuntimeError: Unexpected end of file
+```
+
+`EDN:Reader` will also take an IO instance:
+
+```ruby
+r = EDN::Reader.new(open("data.edn"))
+
+r.read  # Read the first form from the file.
+r.read  # Read the second form from the file.
+r.read  # Read the third from from the file.
+```
+
+You can also iterate through the forms with `each`:
+
+```ruby
+r = EDN::Reader.new('[1 2 3] {:a 1 :b 2}')
+
+r.each do |form|
+  p form
+end
+
+#=> [1, 2, 3]
+#=> {:a => 1, :b => 2}
+```
+
+Note that in contrast to earlier versions of this gem,
+EDN::Reader is no longer `Enumerable`.
+
+Like `EDN.read`, `Reader.read` also takes an optional
+parameter, which is returned when there is no more data:
+
+```ruby
+r = EDN::Reader.new('1 2 3')
+r.read(:eof)  # returns 1
+r.read(:eof)  # returns 2
+r.read(:eof)  # returns 3
+r.read(:eof)  # returns :eof
+```
+
+### Converting Ruby data to EDN
+
+To convert a data structure to an EDN string:
+
+```ruby
+data.to_edn
+```
+
+By default, this will work for strings, symbols, numbers, arrays, hashes, sets, nil, Time, and boolean values.
+
+### Value Translations
+
+Note that EDN uses its own terminology for the types of objects it represents
+and in some cases those types not map cleanly to Ruby.
+
+In EDN, you have _keywords_, which look like Ruby symbols and have the same meaning and
+purpose. These are converted to Ruby symbols.
+
+You also have EDN _symbols_, which generally reflect variable names, but have
+several purposes. We parse these and return `EDN::Type::Symbol` values for them,
+as they don't map to anything built into Ruby. To create an EDN symbol in Ruby,
+call `EDN::Type::Symbol.new` or `EDN.symbol` with a string argument, or use the
+convenience unary operator `~` like so: `~"elf/rings"`.
+
+EDN also has _vectors_, which map to Ruby arrays, and _lists_, which are linked lists
+in Clojure. We map EDN lists to `EDN::Type::List` values, which are type-compatible with
+arrays. To create an EDN list in Ruby, call `EDN::Type::List.new` or `EDN.list`
+with all arguments to go in the list. If you have an array, you will use the splat
+operator, like so: `EDN.list(*[1, 2, 3])`. You can also use the `~` unary
+operator like so: `~[1, 2, 3]`.
+
+EDN also has character types, but Ruby does not. These are converted into one-character strings.
+
+### Tagged Values
+
+The interesting part of EDN is the _extensible_ part.
+Data can be be _tagged_ to coerce interpretation of
+it to a particular data type. An example of a tagged data element:
+
+```
+#wolf/pack {:alpha "Greybeard" :betas ["Frostpaw" "Blackwind" "Bloodjaw"]}
+```
+
+The tag (`#wolf/pack`) will tell any consumers of this data
+to use a data type registered to handle `wolf/pack` to represent this data.
+
+The rules for tags from the [EDN README][README] should be followed. In short, custom tags should have a prefix (the part before the `/`) designating the user that created them or context they are used in. Non-prefixed tags are reserved for built-in tags.
+
+There are two tags built in by default: `#uuid`, used for UUIDs, and `#inst`, used for an instant in time. In `edn-ruby`, `#inst` is converted to a Time, and Time values are tagged as `#inst`. There is not a UUID data type built into Ruby, so `#uuid` is converted to an instance of `EDN::Type::UUID`.
+
+Tags that are not registered generate a struct of the type `EDN::Type::Unknown` with the methods `tag` and `value`.
+
+### Registering a New Tag For Reading
+
+To register a tag for reading, call the method `EDN.register` with a tag and one of the following:
+
+- A block that accepts data and returns a value.
+- A lambda that accepts data and returns a value.
+- A class that has an `initialize` method that accepts data.
+
+Examples:
+
+```ruby
+EDN.register("clinton/uri") do |uri|
+  URI(uri)
+end
+
+EDN.register("clinton/date", lambda { |date_array| Date.new(*date_array) })
+
+class Dog
+  def initialize(name)
+    @name = name
+  end
+end
+
+EDN.register("clinton/dog", Dog)
+```
+
+### Writing Tags
+
+Writing tags should be done as part of the class's `.to_edn` method, like so:
+
+```ruby
+class Dog
+  def to_edn
+    ["#clinton/dog", @name.to_edn].join(" ")
+  end
+end
+```
+
+`EDN` provides a helper method, `EDN.tagout`:
+
+```ruby
+class Dog
+  def to_edn
+    EDN.tagout("clinton/dog", @name)
+  end
+end
+```
+
+This method calls `.to_edn` on the second argument and joins the arguments appropriately.
+
+Other examples are:
+```
+EDN.tagout("wolf/pack", {:alpha=>"Greybeard", :betas=>["Frostpaw", "Blackwind", "Bloodjaw"]})
+ => "#wolf/pack {:alpha \"Greybeard\", :betas [\"Frostpaw\" \"Blackwind\" \"Bloodjaw\"]}"
+
+class Range
+  def to_edn
+    EDN.tagout("ruby/range", [self.begin, self.end, self.exclude_end?])
+  end
+end
+
+(0..9).to_edn
+=> "#ruby/range [0 9 false]"
+```
+
+
+## Metadata
+
+Certain elements of EDN can have *metadata*. Metadata is a map of values about the element, which must follow specific rules.
+
+* Only symbols, lists, vectors, maps, and sets can have metadata. Tagged elements *cannot* have metadata.
+* Metadata keys must be symbols, keywords, or strings.
+
+Metadata can be expressed in one of the following three ways:
+
+* Via a map. The element is prefixed with a map which has a caret (`^`) prefixed to it, like so: `^{:doc "This is my vector" :rel :temps} [98.6 99.7]`.
+* Via a keyword. The element is prefixed with a keyword, also prefixed by a caret: `^:awesome #{1 2 \c}`. This results in the key `:awesome` being set to `true`, as if the metadata was: `^{:awesome true} #{1 2 \c}`.
+* Via a symbol. The element is prefixed with a symbol, also prefixed by a caret: `^Boolean "true"`. This results in the key `:tag` being set to the symbol, as if the metadata was: `^{:tag Boolean} "true"`. This is used in Clojure to indicate the Java type of the element. In other EDN implementations, it may be ignored or used differently.
+
+More than one piece of metadata can be applied to an element. Metadata is applied to the next element appearing after it, so in the case of `^:foo ^{:bar false} [1 2]`, the metadata would be, in total, `^{:foo true, :bar false}`. Note that `^:foo` is applied to the element `[1 2]` with the metadata `^{:bar false}` applied to it. Because of this, key collisions are resolved *right-to-left*.
+
+## Contributors
+
+* Clinton N. Dreisbach (@crnixon)
+* Michael Ficarra (@michaelficarra)
+* Andrew Forward (@aforward)
+* Gabriel Horner (@cldwalker)
+* Russ Olsen (@russolsen)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+[edn]: https://github.com/edn-format/edn
+[README]: https://github.com/edn-format/edn/blob/master/README.md

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+task :irb do
+  sh "irb -I lib -r edn"
+  sh "reset"
+end

data/edn2023.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/edn/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Clinton N. Dreisbach & Russ Olsen"]
+  gem.description   = %q{edn implements a reader for Extensible Data Notation by Rich Hickey.}
+  gem.summary       = gem.description
+  gem.homepage      = "https://github.com/edn2023/edn2023"
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "edn2023"
+  gem.require_paths = ["lib"]
+  gem.version       = EDN::VERSION
+
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rantly'
+  gem.add_development_dependency 'rake'
+end

data/lib/edn/char_stream.rb

@@ -0,0 +1,84 @@
+require 'stringio'
+require 'set'
+
+module EDN
+  class CharStream
+    def initialize(io=$stdin)
+      @io = io
+      @current = nil
+    end
+
+    def current
+      return @current if @current
+      advance
+    end
+
+    def advance
+      return @current if @current == :eof
+      @current = @io.getc || :eof
+    end
+
+    def digit?(c=current)
+      /[0-9]/ =~ c
+    end
+
+    def alpha?(c=current)
+      /[a-zA-Z]/ =~ c
+    end
+
+    def eof?(c=current)
+      c == :eof
+    end
+
+    def ws?(c=current)
+      /[ \t\r\n,]/ =~ c
+    end
+
+    def newline?(c=current)
+      /[\n\r]/ =~ c
+    end
+
+    def repeat(pattern, &block)
+      result = nil
+      while current =~ pattern
+        result ||= ''
+        result = block.call(result, current)
+      end
+      result
+    end
+
+    def gather(pattern)
+      repeat(pattern) do |result, ch|
+        result << ch
+      end
+    end
+
+    def skip_past(expected, error_message=nil)
+      if current == expected
+        advance
+        return expected
+      elsif error_message
+        raise error_message
+      end
+      nil
+    end
+
+    def skip_to_eol
+      until current == :eof || newline?
+        advance
+      end
+    end
+
+    def skip_ws
+      while current != :eof
+        if ws?(current)
+          advance
+        elsif current == ';'
+          skip_to_eol
+        else
+          break
+        end
+      end
+    end
+  end
+end

data/lib/edn/core_ext.rb

@@ -0,0 +1,112 @@
+require 'time'
+require 'bigdecimal'
+require 'set'
+
+module EDN
+  module CoreExt
+    module Unquoted
+      def to_edn
+        self.to_s
+      end
+    end
+
+    module AllowsMetadata
+      def allows_metadata?
+        true
+      end
+    end
+
+    module Integer
+      def to_edn
+        self.to_s + 'N'
+      end
+    end
+
+    module BigDecimal
+      def to_edn
+        self.to_s('F') + 'M'
+      end
+    end
+
+    module String
+      def ~@
+        EDN::Type::Symbol.new(self)
+      end
+
+      def to_edn
+        array = chars.map do |ch|
+          if %w{" \\}.include?(ch)
+            '\\' + ch
+          else
+            ch
+          end
+        end
+        '"' + array.join + '"'
+      end
+    end
+
+    module Symbol
+      def to_edn
+        ":#{self.to_s}"
+      end
+    end
+
+    module Array
+      def ~@
+        EDN::Type::List.new(*self)
+      end
+
+      def to_edn
+        '[' + self.map(&:to_edn).join(" ") + ']'
+      end
+    end
+
+    module Hash
+      def to_edn
+        '{' + self.map { |k, v| [k, v].map(&:to_edn).join(" ") }.join(", ") + '}'
+      end
+    end
+
+    module Set
+      def to_edn
+        '#{' + self.to_a.map(&:to_edn).join(" ") + '}'
+      end
+    end
+
+    module NilClass
+      def to_edn
+        "nil"
+      end
+    end
+
+    module DateTime
+      def to_edn
+        EDN.tagout("inst", self.rfc3339)
+      end
+    end
+
+    module Time
+      def to_edn
+        EDN.tagout("inst", self.xmlschema)
+      end
+    end
+  end
+end
+
+Numeric.send(:include, EDN::CoreExt::Unquoted)
+Integer.send(:include, EDN::CoreExt::Integer)
+BigDecimal.send(:include, EDN::CoreExt::BigDecimal)
+TrueClass.send(:include, EDN::CoreExt::Unquoted)
+FalseClass.send(:include, EDN::CoreExt::Unquoted)
+NilClass.send(:include, EDN::CoreExt::NilClass)
+String.send(:include, EDN::CoreExt::String)
+Symbol.send(:include, EDN::CoreExt::Symbol)
+Array.send(:include, EDN::CoreExt::Array)
+Hash.send(:include, EDN::CoreExt::Hash)
+Set.send(:include, EDN::CoreExt::Set)
+DateTime.send(:include, EDN::CoreExt::DateTime)
+Time.send(:include, EDN::CoreExt::Time)
+
+[Array, Hash, Set].each do |klass|
+  klass.send(:include, EDN::CoreExt::AllowsMetadata)
+end

data/lib/edn/metadata.rb

@@ -0,0 +1,27 @@
+module EDN
+  module Metadata
+    def self.extended(base)
+      base.instance_eval do
+        alias :to_edn_without_metadata :to_edn
+        alias :to_edn :to_edn_with_metadata
+      end
+    end
+
+    attr_accessor :metadata
+
+    def has_metadata?
+      respond_to?(:allows_metadata?) and
+        allows_metadata? and
+        !metadata.nil? and
+        !metadata.empty?
+    end
+
+    def to_edn_with_metadata
+      if has_metadata?
+        '^' + metadata.to_edn + ' ' + to_edn_without_metadata
+      else
+        to_edn_without_metadata
+      end
+    end
+  end
+end