yowl 0.4 → 0.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (7) hide show
  1. checksums.yaml +7 -0
  2. data/CHANGES +4 -0
  3. data/README.md +35 -40
  4. data/Rakefile +6 -57
  5. data/lib/yowl/version.rb +2 -2
  6. metadata +36 -100
  7. data/INSTALL-MACOSX.md +0 -109
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA512:
3
+ data.tar.gz: 23738f36ee9394b25bc5565b4ea4c0cdfc321a1c1ffe9753ee98bac5c1889fd9fba8ccdd2bd01c0545e95771b6600735e64113126dd807e8310cb9b7c48baf7b
4
+ metadata.gz: 743c59d56158eb0fa3560d7b29a8f71c7ad2e6aa3285492d1e04787715ad5f68347bcd69fbdb2bc4580dc820ca1207bbf5207b291e58bf679f5eec2368b4e5fa
5
+ SHA1:
6
+ data.tar.gz: 2fdfede9583613123938630b4af046c6dfd79dcf
7
+ metadata.gz: f78fbc86b4e91a602357efa863ec60b1b892cfec
data/CHANGES CHANGED
@@ -1,3 +1,7 @@
1
+ 0.4.1
2
+
3
+ - Resolve depencies using RubyGems
4
+ - Add bash script for fast source installation of libraptor1
1
5
 
2
6
  0.4
3
7
 
data/README.md CHANGED
@@ -1,6 +1,6 @@
1
- # YOWL
1
+ # YOWL: Yet another OWL documentor
2
2
 
3
- Yet another OWL documentor. YOWL is a command line utility that can read a number of
3
+ YOWL is a command line utility that can read a number of
4
4
  RDFS/OWL files, called the repository, and generate a documentation website from it,
5
5
  with visualisations like Class Diagrams (as SVG), Individuals Diagrams and Import Diagrams.
6
6
 
@@ -14,60 +14,55 @@ It also detects annotations from the following public ontologies:
14
14
 
15
15
  This is a fork of the original DOWL project at https://github.com/ldodds/dowl.
16
16
 
17
- # INSTALLATION
17
+ ## INSTALLATION
18
18
 
19
- ## Installation on Mac OS X:
19
+ ### Install WGET, GraphViz, libraptor1:
20
20
 
21
- [Installation on Mac OS X](/jgeluk/yowl/blob/master/INSTALL-MACOSX.md)
21
+ #### OS X
22
+ You can do this using [macports](http://www.macports.org/install.php) or [homebrew](http://mxcl.github.com/homebrew/).
22
23
 
23
- ## Installation on Ubuntu
24
-
25
- ```bash
26
- apt-get install ruby rake gem
24
+ Macports:
25
+ ```sh
26
+ $ sudo port install wget graphviz
27
27
  ```
28
28
 
29
- ## General
30
-
31
- Install all libraries used by YOWL:
29
+ Homebrew:
30
+ ```sh
31
+ $ sudo brew install wget graphviz
32
+ ```
32
33
 
33
- ```bash
34
- [sudo] gem install ffi rdf rdf-raptor rdf-json rdf-trix sxp sparql ruby-graphviz
34
+ Unfortunately, there is no clean way (as far as we know) to install libraptor1 via a package manager on OS X. Therefore we wrote a small shell script, `install-raptor.sh` to do it for you.
35
+ ```sh
36
+ $ sudo curl -k https://raw.github.com/jgeluk/yowl/build-sanity/install-raptor.sh | bash
35
37
  ```
36
38
 
37
- This version of YOWL is not yet available as a "gem" itself so it needs to be downloaded from Github:
39
+ #### Ubuntu
38
40
 
39
41
  ```bash
40
- mkdir ~/downloads
41
- cd ~/downloads
42
- wget http://github.com/jgeluk/yowl/tarball/master -O yowl.tar.gz
43
- tar xvf yowl.tar.gz
44
- #
45
- # Remember the name of the root directory of the unpacked tarball
46
- # which looks like jgeluk-yowl-5ba77f5
47
- #
48
- sudo rm -rf /opt/yowl
49
- sudo mv ~/downloads/jgeluk-yowl-5ba77f5 /opt/yowl
50
- cd /opt/yowl
51
- sudo rake install
42
+ $ sudo apt-get install wget graphviz libraptor1 rubygems
52
43
  ```
53
44
 
54
- Or get it with git:
45
+ ### Install via RubyGems
46
+ ```sh
47
+ $ gem install yowl
48
+ ```
55
49
 
56
- ```bash
57
- rm -rf /opt/yowl
58
- cd /opt
59
- git clone git@github.com:jgeluk/yowl.git
60
- cd /opt/yowl
61
- sudo rake install
50
+ ### Bleeding Edge/Development Builds
51
+ ```sh
52
+ $ git clone https://github.com/jgeluk/yowl.git
53
+ $ cd yowl/
54
+ $ gem build yowl.gemspec
55
+ $ gem install yowl
62
56
  ```
63
57
 
64
- # Usage
58
+ ## Usage
65
59
 
66
- Execute bin/yowl to see usage options:
60
+ Execute `yowl -h` to see usage options:
67
61
 
68
62
  ```bash
69
- user@host:/opt/yowl# /opt/yowl/bin/yowl
70
- Output will be generated in this directory: /opt/yowl
63
+ $ yowl
64
+ yowl [VERSION_WILL_APPEAR_HERE]
65
+
71
66
  Usage: YOWL [<options>]
72
67
 
73
68
  Specific options:
@@ -80,13 +75,13 @@ Common options:
80
75
  -?, -h, --help Show this message
81
76
  -V, --version Show version
82
77
  -v, --verbose Show verbose logging
78
+ -q, --quiet Suppress most logging
83
79
  ```
84
80
 
85
81
  For example, to generate a site for the PROV ontology,
86
82
  download the prov owl file and run YOWL as follows:
87
83
 
88
84
  ```bash
89
- /opt/yowl/bin/yowl -i /root/downloads/prov/*.owl -o /var/www/prov
85
+ $ yowl -i /path/to/prov/*.owl -o /var/www/prov
90
86
  ```
91
87
 
92
-
data/Rakefile CHANGED
@@ -1,58 +1,17 @@
1
1
  require 'rake'
2
- require 'rubygems'
3
- require 'rubygems/package_task'
4
2
  require 'rdoc/task'
5
3
  require 'rake/testtask'
6
4
  require 'rake/clean'
5
+ if RUBY_VERSION < "1.9.2"
6
+ require "lib/yowl/version"
7
+ else
8
+ require_relative "lib/yowl/version"
9
+ end
7
10
 
8
- NAME = "yowl"
9
- VER = "0.4.pre"
10
-
11
- RDOC_OPTS = ['--quiet', '--title', 'yowl reference', '--main', 'README.md']
12
-
13
- PKG_FILES = %w(README.md INSTALL-MACOSX.md Rakefile CHANGES) +
14
- Dir.glob("{bin,test,examples,lib}/**/*")
11
+ RDOC_OPTS = ['--quiet', '--title', '#{YOWL::NAME} reference', '--main', 'README.md']
15
12
 
16
13
  CLEAN.include ['*.gem', 'pkg']
17
14
 
18
- SPEC = Gem::Specification.new do |s|
19
- s.platform = Gem::Platform::RUBY
20
- s.summary = 'OWL visualization and documentation generator'
21
- s.description = <<-EOF
22
- Yet another OWL documentor. YOWL is a command line utility that can read a number of RDFS/OWL files,
23
- called the repository, and generate a documentation website from it, with visualisations like
24
- Class Diagrams (as SVG), Individuals Diagrams and Import Diagrams.
25
- EOF
26
- s.name = NAME
27
- s.version = VER
28
- s.required_ruby_version = ">= 1.8.7"
29
- s.has_rdoc = true
30
- s.extra_rdoc_files = ["README.md", "INSTALL-MACOSX.md", "CHANGES"]
31
- s.rdoc_options = RDOC_OPTS
32
- s.authors = ['Leigh Dodds', 'Jacobus Geluk']
33
- s.email = ['leigh.dodds@talis.com', 'jacobus.geluk@gmail.com']
34
- s.homepage = 'http://github.com/jgeluk/yowl'
35
- s.files = PKG_FILES
36
- s.require_path = "lib"
37
- s.bindir = "bin"
38
- s.executables = ["yowl"]
39
- s.test_file = "test/test_yowl.rb"
40
- s.add_dependency("rdf-raptor", ">= 0.4.0")
41
- s.add_dependency("ffi", ">= 1.1.5")
42
- s.add_dependency("rdf", ">= 0.3.8")
43
- s.add_dependency("rdf-raptor", ">= 0.4.2")
44
- s.add_dependency("rdf-json", ">= 0.3.0")
45
- s.add_dependency("rdf-trix", ">= 0.3.0")
46
- s.add_dependency("sxp", ">= 0.0.14")
47
- s.add_dependency("sparql", ">= 0.3.1")
48
- s.add_dependency("ruby-graphviz", ">= 1.0.8")
49
- s.rubyforge_project = 'nowarning'
50
- end
51
-
52
- Gem::PackageTask.new(SPEC) do |pkg|
53
- pkg.need_tar = true
54
- end
55
-
56
15
  RDoc::Task.new do |rdoc|
57
16
  rdoc.rdoc_dir = 'doc/rdoc'
58
17
  rdoc.options += RDOC_OPTS
@@ -64,13 +23,3 @@ Rake::TestTask.new do |test|
64
23
  test.verbose = true
65
24
  end
66
25
 
67
- desc "Install from a locally built copy of the gem"
68
- task :install do
69
- sh %{rake package}
70
- sh %{sudo gem install pkg/#{NAME}-#{VER}}
71
- end
72
-
73
- desc "Uninstall the gem"
74
- task :uninstall => [:clean] do
75
- sh %{sudo gem uninstall #{NAME}}
76
- end
data/lib/yowl/version.rb CHANGED
@@ -1,8 +1,8 @@
1
1
  module YOWL
2
2
 
3
3
  NAME = "yowl"
4
- VERSION = "0.4"
4
+ VERSION = "0.4.1"
5
5
 
6
6
  NAME_AND_VERSION = "#{NAME} #{VERSION}"
7
7
 
8
- end
8
+ end
metadata CHANGED
@@ -1,51 +1,35 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: yowl
3
3
  version: !ruby/object:Gem::Version
4
- hash: 3
5
- prerelease:
6
- segments:
7
- - 0
8
- - 4
9
- version: "0.4"
4
+ version: 0.4.1
10
5
  platform: ruby
11
6
  authors:
12
7
  - Leigh Dodds
13
8
  - Jacobus Geluk
9
+ - Travis Kaufman
14
10
  autorequire:
15
11
  bindir: bin
16
12
  cert_chain: []
17
13
 
18
- date: 2012-11-25 00:00:00 Z
14
+ date: 2013-02-27 00:00:00 Z
19
15
  dependencies:
20
16
  - !ruby/object:Gem::Dependency
21
17
  name: ffi
22
18
  prerelease: false
23
19
  requirement: &id001 !ruby/object:Gem::Requirement
24
- none: false
25
20
  requirements:
26
21
  - - ">="
27
22
  - !ruby/object:Gem::Version
28
- hash: 25
29
- segments:
30
- - 1
31
- - 1
32
- - 5
33
- version: 1.1.5
23
+ version: 1.2.0
34
24
  type: :runtime
35
25
  version_requirements: *id001
36
26
  - !ruby/object:Gem::Dependency
37
27
  name: json
38
28
  prerelease: false
39
29
  requirement: &id002 !ruby/object:Gem::Requirement
40
- none: false
41
30
  requirements:
42
31
  - - ">="
43
32
  - !ruby/object:Gem::Version
44
- hash: 1
45
- segments:
46
- - 1
47
- - 7
48
- - 5
49
33
  version: 1.7.5
50
34
  type: :runtime
51
35
  version_requirements: *id002
@@ -53,15 +37,9 @@ dependencies:
53
37
  name: rdf
54
38
  prerelease: false
55
39
  requirement: &id003 !ruby/object:Gem::Requirement
56
- none: false
57
40
  requirements:
58
41
  - - ">="
59
42
  - !ruby/object:Gem::Version
60
- hash: 3
61
- segments:
62
- - 0
63
- - 3
64
- - 8
65
43
  version: 0.3.8
66
44
  type: :runtime
67
45
  version_requirements: *id003
@@ -69,15 +47,9 @@ dependencies:
69
47
  name: rdf-raptor
70
48
  prerelease: false
71
49
  requirement: &id004 !ruby/object:Gem::Requirement
72
- none: false
73
50
  requirements:
74
51
  - - ">="
75
52
  - !ruby/object:Gem::Version
76
- hash: 11
77
- segments:
78
- - 0
79
- - 4
80
- - 2
81
53
  version: 0.4.2
82
54
  type: :runtime
83
55
  version_requirements: *id004
@@ -85,15 +57,9 @@ dependencies:
85
57
  name: rdf-json
86
58
  prerelease: false
87
59
  requirement: &id005 !ruby/object:Gem::Requirement
88
- none: false
89
60
  requirements:
90
- - - ">="
61
+ - - ~>
91
62
  - !ruby/object:Gem::Version
92
- hash: 19
93
- segments:
94
- - 0
95
- - 3
96
- - 0
97
63
  version: 0.3.0
98
64
  type: :runtime
99
65
  version_requirements: *id005
@@ -101,15 +67,9 @@ dependencies:
101
67
  name: rdf-trix
102
68
  prerelease: false
103
69
  requirement: &id006 !ruby/object:Gem::Requirement
104
- none: false
105
70
  requirements:
106
- - - ">="
71
+ - - ~>
107
72
  - !ruby/object:Gem::Version
108
- hash: 19
109
- segments:
110
- - 0
111
- - 3
112
- - 0
113
73
  version: 0.3.0
114
74
  type: :runtime
115
75
  version_requirements: *id006
@@ -117,15 +77,9 @@ dependencies:
117
77
  name: rdf-xsd
118
78
  prerelease: false
119
79
  requirement: &id007 !ruby/object:Gem::Requirement
120
- none: false
121
80
  requirements:
122
- - - ">="
81
+ - - ~>
123
82
  - !ruby/object:Gem::Version
124
- hash: 3
125
- segments:
126
- - 0
127
- - 3
128
- - 8
129
83
  version: 0.3.8
130
84
  type: :runtime
131
85
  version_requirements: *id007
@@ -133,65 +87,56 @@ dependencies:
133
87
  name: sxp
134
88
  prerelease: false
135
89
  requirement: &id008 !ruby/object:Gem::Requirement
136
- none: false
137
90
  requirements:
138
91
  - - ">="
139
92
  - !ruby/object:Gem::Version
140
- hash: 3
141
- segments:
142
- - 0
143
- - 0
144
- - 14
145
93
  version: 0.0.14
146
94
  type: :runtime
147
95
  version_requirements: *id008
148
96
  - !ruby/object:Gem::Dependency
149
- name: sparql
97
+ name: sparql-client
150
98
  prerelease: false
151
99
  requirement: &id009 !ruby/object:Gem::Requirement
152
- none: false
153
100
  requirements:
154
- - - ">="
101
+ - - ~>
155
102
  - !ruby/object:Gem::Version
156
- hash: 17
157
- segments:
158
- - 0
159
- - 3
160
- - 1
161
- version: 0.3.1
103
+ version: 0.3.0
162
104
  type: :runtime
163
105
  version_requirements: *id009
164
106
  - !ruby/object:Gem::Dependency
165
- name: ruby-graphviz
107
+ name: sparql
166
108
  prerelease: false
167
109
  requirement: &id010 !ruby/object:Gem::Requirement
168
- none: false
110
+ requirements:
111
+ - - ~>
112
+ - !ruby/object:Gem::Version
113
+ version: 0.3.1
114
+ type: :runtime
115
+ version_requirements: *id010
116
+ - !ruby/object:Gem::Dependency
117
+ name: ruby-graphviz
118
+ prerelease: false
119
+ requirement: &id011 !ruby/object:Gem::Requirement
169
120
  requirements:
170
121
  - - ">="
171
122
  - !ruby/object:Gem::Version
172
- hash: 7
173
- segments:
174
- - 1
175
- - 0
176
- - 8
177
123
  version: 1.0.8
178
124
  type: :runtime
179
- version_requirements: *id010
180
- description: " Yet another OWL documentor. YOWL is a command line utility that can read a number of RDFS/OWL files, \n called the repository, and generate a documentation website from it, with visualisations like\n Class Diagrams (as SVG), Individuals Diagrams and Import Diagrams.\n"
125
+ version_requirements: *id011
126
+ description: " Yet another OWL documentor. YOWL is a command line utility that can read a number of RDFS/OWL files,\n called the repository, and generate a documentation website from it, with visualisations like\n Class Diagrams (as SVG), Individuals Diagrams and Import Diagrams.\n"
181
127
  email:
182
128
  - leigh.dodds@talis.com
183
129
  - jacobus.geluk@gmail.com
130
+ - travis.kaufman@gmail.com
184
131
  executables:
185
132
  - yowl
186
133
  extensions: []
187
134
 
188
135
  extra_rdoc_files:
189
136
  - README.md
190
- - INSTALL-MACOSX.md
191
137
  - CHANGES
192
138
  files:
193
139
  - README.md
194
- - INSTALL-MACOSX.md
195
140
  - Rakefile
196
141
  - CHANGES
197
142
  - bin/yowl
@@ -297,44 +242,35 @@ files:
297
242
  - lib/yowl/util.rb
298
243
  - lib/yowl/version.rb
299
244
  - lib/yowl.rb
300
- homepage: http://github.com/jgeluk/yowl
301
- licenses: []
245
+ homepage: http://github.com/jgeluk/#{YOWL::NAME}
246
+ licenses:
247
+ - MIT
248
+ metadata: {}
302
249
 
303
250
  post_install_message:
304
251
  rdoc_options:
305
252
  - --quiet
306
253
  - --title
307
- - yowl reference
254
+ - "#{YOWL::NAME} reference"
308
255
  - --main
309
- - README.md
256
+ - " README.md"
310
257
  require_paths:
311
258
  - lib
312
259
  required_ruby_version: !ruby/object:Gem::Requirement
313
- none: false
314
260
  requirements:
315
- - - ">="
261
+ - &id012
262
+ - ">="
316
263
  - !ruby/object:Gem::Version
317
- hash: 57
318
- segments:
319
- - 1
320
- - 8
321
- - 7
322
- version: 1.8.7
264
+ version: "0"
323
265
  required_rubygems_version: !ruby/object:Gem::Requirement
324
- none: false
325
266
  requirements:
326
- - - ">="
327
- - !ruby/object:Gem::Version
328
- hash: 3
329
- segments:
330
- - 0
331
- version: "0"
267
+ - *id012
332
268
  requirements: []
333
269
 
334
270
  rubyforge_project: nowarning
335
- rubygems_version: 1.8.24
271
+ rubygems_version: 2.0.0
336
272
  signing_key:
337
- specification_version: 3
273
+ specification_version: 4
338
274
  summary: OWL visualization and documentation generator
339
275
  test_files:
340
276
  - test/test_yowl.rb
data/INSTALL-MACOSX.md DELETED
@@ -1,109 +0,0 @@
1
- # Installation on Mac OS X
2
-
3
- Unfortunately, its not trivial to get YOWL to run on Mac OS X.
4
-
5
- You can either use MacPorts or HomeBrew to install some of the components that YOWL needs (graphviz
6
- and wget) and we also need Fink (for libraptor version 1).
7
-
8
- ## MacPorts
9
-
10
- You first have to download and install MacPorts: http://www.macports.org/install.php
11
-
12
- Then use MacPorts to install GraphViz (which is used to generate the graphics) and wget:
13
-
14
- ```
15
- sudo port install graphviz wget
16
- ```
17
-
18
- ## HomeBrew
19
-
20
- As an alternative to MacPorts, you can install HomeBrew and use that to install Graphviz,
21
- for installation instructions of HomeBrew look [here](https://github.com/mxcl/homebrew/wiki/Installation)
22
- or [here](http://mxcl.github.com/homebrew/).
23
-
24
- Once Brew is installed, install Graphviz and wget as follows:
25
-
26
- ```
27
- sudo brew install graphviz wget
28
- ```
29
-
30
- ## Raptor 1
31
-
32
- YOWL depends on the Ruby package "ruby-rdf" which in turn depends on a C library called "raptor".
33
- Unfortunately, MacPorts recently dropped support for the older version of Raptor (version 1) that
34
- is used by ruby-rdf, so MacPorts can only install version 2, which is not compatible with ruby-rdf,
35
- so don't bother to install it.
36
- Another well known package manager for Mac OS X, HomeBrew, also can only install version 2
37
- of libraptor.
38
-
39
- There are two solutions available at this point (unless you have a better idea):
40
-
41
- ### Building libraptor version 1 from source
42
-
43
- ```
44
- mkdir -p ~/Work/build
45
- cd ~/Work/build
46
- wget http://download.librdf.org/source/raptor-1.4.21.tar.gz
47
- tar xvf raptor-1.4.21.tar.gz
48
- cd raptor-1.4.21
49
- ./configure "CPPFLAGS=-I/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX10.7.sdk/usr/include"
50
- make
51
- sudo make install
52
- ```
53
-
54
- As you can see in the configure line above, the build procedure assumes that you have Xcode installed, where it tries to find "curl/types.h".
55
- If you have this file installed elsewhere then change that location on the configure line.
56
- One way to find "curl/types.h" is:
57
-
58
- ```
59
- sudo locate types.h | grep curl
60
- ```
61
-
62
- Or
63
-
64
- ```
65
- sudo find /usr /opt /sw /Applications -name 'types.h' | grep curl
66
- ```
67
-
68
- ### Installing libraptor version 1 with Fink
69
-
70
- Besides MacPorts and HomeBrew, there's also Fink. Go to the Fink website, download
71
- and install Fink and then type:
72
-
73
- ```
74
- sudo fink selfupdate
75
- sudo fink install raptor-bin
76
- ```
77
-
78
- This will fail on Mac OS X Mountain Lion (10.8.x or later) because the raptor package
79
- as defined by Fink is dependent on an older version of curl, which does no longer have
80
- the "curl/types.h" file, which is needed by raptor, unless you configure it a bit
81
- differently:
82
-
83
- Open the Fink package file for raptor:
84
-
85
- ```
86
- sudo vi /sw/fink/10.7/stable/main/finkinfo/libs/libraptor1-shlibs.info
87
- ```
88
-
89
- Find the line that starts with "ConfigureParams:" and add the option --with-www=xml so
90
- that it looks as follows:
91
- ```
92
- ConfigureParams: --enable-dependency-tracking --disable-static --enable-gtk-doc --with-www=xml
93
- ```
94
-
95
- Then save the file and execute the following:
96
-
97
- ```
98
- sudo fink rebuildpackage raptor-bin
99
- sudo fink install raptor-bin
100
- sudo ln -s /sw/lib/libraptor.1.dylib /usr/lib/libraptor.dylib
101
- ```
102
-
103
- ## Gems
104
-
105
- YOWL depends on various "ruby gems" that can be installed as follows:
106
-
107
- ```
108
- sudo gem install ffi rdf rdf-raptor rdf-json rdf-trix sxp sparql ruby-graphviz
109
- ```