edn 0.0.0

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Clinton R. Nixon
+
+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,111 @@
+# edn-ruby
+
+**edn-ruby** is a Ruby library to read and write [edn][edn] (extensible data notation), a subset of Clojure used for transferring data between applications, much like JSON, YAML, or XML.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'edn'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install edn
+
+## Usage
+
+To read a string of **edn**:
+
+```ruby
+EDN.read("[1 2 {:foo \"bar\"}]")
+```
+
+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.
+
+### 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 a string, but if you require `edn/uuid`, `#uuid` values are converted to an instance of `EDN::UUID`.
+
+Tags that are not registered are converted as their base data type and a warning will be shown.
+
+### 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.
+
+## 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/richhickey/edn
+[README]: https://github.com/richhickey/edn/blob/master/README.md

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/edn.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/edn/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Clinton N. Dreisbach"]
+  gem.email         = ["clinton@thinkrelevance.com"]
+  gem.description   = %q{'edn implements a reader for Extensible Data Notation by Rich Hickey.'}
+  gem.summary       = gem.description
+  gem.homepage      = ""
+
+  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          = "edn"
+  gem.require_paths = ["lib"]
+  gem.version       = EDN::VERSION
+end

data/lib/edn.rb

@@ -0,0 +1,5 @@
+require "edn/version"
+
+module EDN
+  # Your code goes here...
+end

data/lib/edn/version.rb

@@ -0,0 +1,3 @@
+module EDN
+  VERSION = "0.0.0"
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: edn
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Clinton N. Dreisbach
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-07 00:00:00.000000000 Z
+dependencies: []
+description: ! '''edn implements a reader for Extensible Data Notation by Rich Hickey.'''
+email:
+- clinton@thinkrelevance.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- edn.gemspec
+- lib/edn.rb
+- lib/edn/version.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: ! '''edn implements a reader for Extensible Data Notation by Rich Hickey.'''
+test_files: []