Permalink
Browse files

Yard documentation updates.

  • Loading branch information...
1 parent 9c02870 commit 69fd4f1f5ee8a5fd9f78e9d7add7b66e77fde848 @gkellogg committed Dec 1, 2012
View
@@ -16,7 +16,7 @@ Gem::Specification.new do |gem|
gem.email = 'public-linked-json@w3.org'
gem.platform = Gem::Platform::RUBY
- gem.files = %w(AUTHORS README.markdown History.markdown UNLICENSE VERSION) + Dir.glob('lib/**/*.rb')
+ gem.files = %w(AUTHORS README.markdown UNLICENSE VERSION) + Dir.glob('lib/**/*.rb')
gem.bindir = %q(bin)
gem.executables = %w(jsonld)
gem.default_executable = gem.executables.first
@@ -27,18 +27,18 @@ Gem::Specification.new do |gem|
gem.required_ruby_version = '>= 1.8.1'
gem.requirements = []
- gem.add_runtime_dependency 'rdf', '>= 0.3.5'
- gem.add_runtime_dependency 'json', '>= 1.6.5'
+ gem.add_runtime_dependency 'rdf', '>= 0.3.11'
+ gem.add_runtime_dependency 'json', '>= 1.7.5'
gem.add_development_dependency 'equivalent-xml' , '>= 0.2.8'
gem.add_development_dependency 'open-uri-cached', '>= 0.0.5'
- gem.add_development_dependency 'yard' , '>= 0.7.4'
+ gem.add_development_dependency 'yard' , '>= 0.8.3'
gem.add_development_dependency 'spira', '>= 0.0.12'
- gem.add_development_dependency 'rspec', '>= 2.8.0'
- gem.add_development_dependency 'rdf-spec', '>= 0.3.5'
- gem.add_development_dependency 'rdf-turtle', '>= 0.1.1'
- gem.add_development_dependency 'rdf-trig', '>= 0.1.1'
+ gem.add_development_dependency 'rspec', '>= 2.12.0'
+ gem.add_development_dependency 'rdf-spec', '>= 0.3.11'
+ gem.add_development_dependency 'rdf-turtle', '>= 0.3.2'
+ gem.add_development_dependency 'rdf-trig', '>= 0.1.4'
gem.add_development_dependency 'rdf-isomorphic', '>= 0.3.4'
- gem.add_development_dependency 'rdf-xsd', '>= 0.3.7'
+ gem.add_development_dependency 'rdf-xsd', '>= 0.3.8'
gem.add_runtime_dependency 'backports'
gem.post_install_message = nil
end
View
@@ -6,7 +6,6 @@
--markup markdown
--readme README.markdown
-
-History.markdown
AUTHORS
VERSION
UNLICENSE
View
@@ -1,25 +1,25 @@
GIT
remote: git://github.com/ruby-rdf/rdf.git
- revision: 0696b96aac0d6969102afcd7af611340b79e8301
+ revision: 512c267a996aa77e3ab2184132c0ab9693c7339b
specs:
- rdf (0.3.8)
+ rdf (0.3.11)
addressable (>= 2.2.6)
PATH
remote: .
specs:
- json-ld (0.3.0)
+ json-ld (0.3.1)
backports
- json (>= 1.6.5)
- rdf (>= 0.3.5)
+ json (>= 1.7.5)
+ rdf (>= 0.3.11)
GEM
remote: http://rubygems.org/
specs:
addressable (2.3.2)
- backports (2.6.4)
+ backports (2.6.5)
diff-lcs (1.1.3)
- equivalent-xml (0.2.9)
+ equivalent-xml (0.3.0)
nokogiri (>= 1.4.3)
haml (3.1.7)
htmlentities (4.3.1)
@@ -54,33 +54,33 @@ GEM
rdf-xsd (>= 0.3.4)
rdf-n3 (0.3.7)
rdf (>= 0.3.4)
- rdf-rdfa (0.3.15)
- haml (>= 3.1.6)
- htmlentities (>= 4.3.0)
- rdf (>= 0.3.5)
- rdf-xsd (>= 0.3.7)
- rdf-rdfxml (0.3.8)
- rdf (>= 0.3.4)
- rdf-xsd (>= 0.3.5)
- rdf-spec (0.3.8)
- rspec (>= 2.8.0)
- rdf-trig (0.1.3)
- rdf (>= 0.3.4)
- rdf-turtle (>= 0.1.1)
+ rdf-rdfa (0.3.16)
+ haml (>= 3.1.7)
+ htmlentities (>= 4.3.1)
+ rdf (>= 0.3.11)
+ rdf-xsd (>= 0.3.8)
+ rdf-rdfxml (0.3.9)
+ rdf (>= 0.3.11)
+ rdf-xsd (>= 0.3.8)
+ rdf-spec (0.3.11)
+ rspec (>= 2.12.0)
+ rdf-trig (0.1.4)
+ rdf (>= 0.3.9)
+ rdf-turtle (>= 0.3.0)
rdf-trix (0.3.0)
rdf (~> 0.3.0)
- rdf-turtle (0.1.2)
- rdf (>= 0.3.4)
+ rdf-turtle (0.3.2)
+ rdf (>= 0.3.11)
rdf-xsd (0.3.8)
rdf (>= 0.3.4)
- rspec (2.11.0)
- rspec-core (~> 2.11.0)
- rspec-expectations (~> 2.11.0)
- rspec-mocks (~> 2.11.0)
- rspec-core (2.11.1)
- rspec-expectations (2.11.3)
+ rspec (2.12.0)
+ rspec-core (~> 2.12.0)
+ rspec-expectations (~> 2.12.0)
+ rspec-mocks (~> 2.12.0)
+ rspec-core (2.12.0)
+ rspec-expectations (2.12.0)
diff-lcs (~> 1.1.3)
- rspec-mocks (2.11.3)
+ rspec-mocks (2.12.0)
spira (0.0.12)
promise (>= 0.3.0)
rdf (>= 0.2.3)
@@ -100,11 +100,11 @@ DEPENDENCIES
open-uri-cached (>= 0.0.5)
rdf!
rdf-isomorphic (>= 0.3.4)
- rdf-spec (>= 0.3.5)
- rdf-trig (>= 0.1.1)
- rdf-turtle (>= 0.1.1)
- rdf-xsd (>= 0.3.7)
- rspec (>= 2.8.0)
+ rdf-spec (>= 0.3.11)
+ rdf-trig (>= 0.1.4)
+ rdf-turtle (>= 0.3.2)
+ rdf-xsd (>= 0.3.8)
+ rspec (>= 2.12.0)
spira (>= 0.0.12)
wirble
- yard (>= 0.7.4)
+ yard (>= 0.8.3)
View
@@ -1,74 +0,0 @@
-=== 0.3.0
-* Fix regression on opening self-relative contexts.
-* When generating RDF, allow @type to be a BNode. This fixes issue #2
-* Add {JSON::LD::Resource} class for simple ruby-like management of JSON-LD nodes.
-* Term Rank and IRI compaction updates.
-
-=== 0.1.6
-* Added flattening API, and updated algorithm.
-* Fixed framing issues using updated flattening.
-
-=== 0.1.5
-* Added support for @vocab.
-
-=== 0.1.4.1
-* Include rdf-xsd for some specs.
-* Refactor #expand_value to deal with previous matching on RDF::Literal::Integer for sub-types.
-
-=== 0.1.4
-* Added bin/jsonld for command-line manipulation of JSON-LD files and to perform RDF transformations.
-
-=== 0.1.3
-* Progress release syncing with the spec. Most expansion and compaction tests pass. RDF is okay, framing has many issues.
-
-=== 0.1.1
-* Changed @literal to @value.
-* Change expanded double format to %1.6e
-* Only recognize application/ld+json and :jsonld.
-
-=== 0.1.0
-* New @context processing rules.
-* @iri and @subject changed to @id.
-* @datatype changed to @type.
-* @coerce keys can be CURIEs or IRIs (not spec'd).
-* @language in @context.
-* Implemented JSON::LD::API for .compact and .expand.
-* Support relative IRI expansion based on document location.
-* Make sure that keyword aliases are fully considered on both input and output and used when compacting.
-
-=== 0.0.8
-* RDF.rb 0.3.4 compatibility.
-* Format detection.
-* Use new @list syntax for parsing ordered collections.
-* Separate normalize from canonicalize
-
-
-=== 0.0.7
-* Change MIME Type and extension from application/json, .json to application/ld+json, .jsonld.
- * Also added application/x-ld+json
-* Process a remote @context
-* Updated to current state of spec, including support for aliased keywords
-* Update Writer to output consistent with current spec.
-
-=== 0.0.6
-* Another order problem (in literals)
-
-=== 0.0.5
-* Fix @literal, @language, @datatype, and @iri serialization
-* Use InsertOrderPreservingHash for Ruby 1.8
-
-=== 0.0.4
-* Fixed ruby 1.8 hash-order problem when parsing @context.
-* Add .jsonld file extention and format
-* JSON-LD Writer
-* Use test suite from json.org
-* Use '@type' instead of 'a' and '@subject' instead of '@'
-
-=== 0.0.3
-* Downgrade RDF.rb requirement from 0.4.0 to 0.3.3.
-
-=== 0.0.2
-* Functional Reader with reasonable test coverage.
-
-=== 0.0.1
-* First release of project scaffold.
View
@@ -213,9 +213,9 @@ Full documentation available on [RubyDoc](http://rubydoc.info/gems/json-ld/file/
* {JSON::LD::EvaluationContext}
* {JSON::LD::Format}
* {JSON::LD::Frame}
- * {JSON::LD::FromTriples}
+ * {JSON::LD::FromRDF}
* {JSON::LD::Reader}
- * {JSON::LD::Triples}
+ * {JSON::LD::ToRDF}
* {JSON::LD::Writer}
## Dependencies
View
@@ -19,9 +19,9 @@ module JSON::LD
class API
include Expand
include Compact
- include Triples
+ include ToRDF
include Flatten
- include FromTriples
+ include FromRDF
include Frame
attr_accessor :value
@@ -86,7 +86,7 @@ def initialize(input, context, options = {}, &block)
# @param [Proc] callback (&block)
# Alternative to using block, with same parameters.
# @param [Hash{Symbol => Object}] options
- # See options in {#initialize}
+ # See options in {JSON::LD::API#initialize}
# @raise [InvalidContext]
# @yield jsonld
# @yieldparam [Array<Hash>] jsonld
@@ -128,8 +128,8 @@ def self.expand(input, context = nil, callback = nil, options = {})
# @param [Proc] callback (&block)
# Alternative to using block, with same parameters.
# @param [Hash{Symbol => Object}] options
- # See options in {#initialize}
- # Other options passed to {#expand}
+ # See options in {JSON::LD::API#initialize}
+ # Other options passed to {JSON::LD::API.expand}
# @yield jsonld
# @yieldparam [Hash] jsonld
# The compacted JSON-LD document
@@ -180,8 +180,8 @@ def self.compact(input, context, callback = nil, options = {})
# @param [Proc] callback (&block)
# Alternative to using block, with same parameters.
# @param [Hash{Symbol => Object}] options
- # See options in {#initialize}
- # Other options passed to {#expand}
+ # See options in {JSON::LD::API#initialize}
+ # Other options passed to {JSON::LD::API.expand}
# @yield jsonld
# @yieldparam [Hash] jsonld
# The framed JSON-LD document
@@ -243,8 +243,8 @@ def self.flatten(input, graph, context, callback = nil, options = {})
# @param [Proc] callback (&block)
# Alternative to using block, with same parameters.
# @param [Hash{Symbol => Object}] options
- # See options in {#initialize}
- # Other options passed to {#expand}
+ # See options in {JSON::LD::API#initialize}
+ # Other options passed to {JSON::LD::API.expand}
# @option options [Boolean] :embed (true)
# a flag specifying that objects should be directly embedded in the output,
# instead of being referred to by their IRI.
@@ -342,8 +342,8 @@ def self.frame(input, frame, callback = nil, options = {})
# @param [Proc] callback (&block)
# Alternative to using block, with same parameteres.
# @param [{Symbol,String => Object}] options
- # See options in {#initialize}
- # Options passed to {#expand}
+ # See options in {JSON::LD::API#initialize}
+ # Options passed to {JSON::LD::API.expand}
# @raise [InvalidContext]
# @yield statement
# @yieldparam [RDF::Statement] statement
@@ -373,7 +373,7 @@ def self.toRDF(input, context = nil, callback = nil, options = {})
# @param [Proc] callback (&block)
# Alternative to using block, with same parameteres.
# @param [Hash{Symbol => Object}] options
- # See options in {#initialize}
+ # See options in {JSON::LD::API#initialize}
# @yield jsonld
# @yieldparam [Hash] jsonld
# The JSON-LD document in expanded form
Oops, something went wrong.

0 comments on commit 69fd4f1

Please sign in to comment.