ruby-framenet 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c88c1ca1204059a078b33a7b0426869d0a868965
-  data.tar.gz: f72db66b5f6d19ddc308f2a79ac557b4c11853a4
+  metadata.gz: 47b197dcde86a3220d55e93261bb5d685e7f39dd
+  data.tar.gz: 30fb45106a85f3d553e21470df98331d4023a252
 SHA512:
-  metadata.gz: 742517a87853ff4bfb88d0669b67670f77ee04b3b4bbda2ed40f2b1d9ff042390f9fbb4f5c8f999abe42c5bd9c330ace1e2950aeecbcea4585979850a2a5395b
-  data.tar.gz: d4767491967d59cad4148af31f90f7828242f77524ddb452ab7f7fb4535c3d3a2840d4aea7ebb00aad2f0e1f85828f90af9b8c615b34876068a1741d9ef50d5e
+  metadata.gz: d92518f10cc59a6bdc93685a3214d8a5c169f4f507b43f195f81628943c386389fa07959d39b35fa093e09bc55bd560860fa7e003a77b19cd75fb849253d93bb
+  data.tar.gz: 17f117eca8bcda0f1bb3a847a9130f2c9cea425f466563691b054b821dceedc752666eac6ebccd2f0853149468e560916b21c3d261db6dd1c1b6417066dd42b1

data/ChangeLog

@@ -1,8 +1,43 @@
+2017-03-09  Michael Granger  <ged@FaerieMUD.org>
+
+	* .hgtags:
+	Added tag v0.0.2 for changeset 88e23983e25b
+	[d009ab23eff8] [tip]
+
+	* .hgsigs:
+	Added signature for changeset a275939b201e
+	[88e23983e25b] [v0.0.2]
+
+	* Rakefile, ruby-framenet.gemspec:
+	Fix gemspec Rake dependency, update gemspec.
+	[a275939b201e]
+
+	* History.md, lib/frame_net.rb:
+	Bump the patch version, update history.
+	[ecb01eee279b]
+
+	* Manifest.txt, lib/frame_net/frame.rb,
+	spec/frame_net/frame/relation_spec.rb, spec/frame_net/frame_spec.rb:
+	Add Frame convenience methods
+
+	- Add Frame#==
+	- Add Frame#elements_by_id and #elements_by_core_type
+	- Add convenience methods for looking up related frames
+	[a185289295b0] [github/master]
+
+	* README.md, Rakefile, ruby-framenet.gemspec:
+	Fix documentation build and a few README issues.
+	[4bcb2a9ed913]
+
 2017-03-08  Michael Granger  <ged@FaerieMUD.org>
 
+	* .hgignore, Rakefile:
+	Allow publication in the Rakefile, ignore the doc/ directory
+	[47438d76ee9d]
+
 	* .hgtags:
 	Added tag v0.0.1 for changeset 4445b83a4072
-	[4d9c19148c6f] [github/master, tip]
+	[4d9c19148c6f]
 
 	* .hgsigs:
 	Added signature for changeset 546079d302b4

data/History.md

@@ -1,3 +1,12 @@
+##  v0.0.2 [2017-03-09] Michael Granger <ged@FaerieMUD.org>
+
+Enhancements:
+
+- Add Frame#==
+- Add Frame#elements_by_id and #elements_by_core_type
+- Add convenience methods for looking up related frames
+
+
 ## v0.0.1 [2017-03-08] Michael Granger <ged@FaerieMUD.org>
 
 Initial release.

data/Manifest.txt

@@ -14831,6 +14831,7 @@ lib/libxml/monkeypatches.rb
 spec/frame_net/definition_spec.rb
 spec/frame_net/frame/element_spec.rb
 spec/frame_net/frame/lexical_unit_spec.rb
+spec/frame_net/frame/relation_spec.rb
 spec/frame_net/frame_spec.rb
 spec/frame_net/semantic_type_spec.rb
 spec/frame_net_spec.rb

data/README.md

@@ -15,7 +15,8 @@ docs
 
 ## Description
 
-This is a Ruby interface to FrameNet, a lexical database of English word usage.
+This is a Ruby interface to FrameNet, a lexical database of English word usage. It
+includes version 1.7 of the FrameNet data, and Ruby classes for querying them.
 
 ### Usage
 
@@ -46,8 +47,8 @@ You can look up frames either by name or by numeric ID:
 ## Contributing
 
 You can check out the current development source with Mercurial via its
-{project page}[http://bitbucket.org/ged/framenet]. Or if you prefer Git, via
-{its Github mirror}[https://github.com/ged/framenet].
+[project page](http://bitbucket.org/ged/framenet). Or if you prefer Git, via
+[its Github mirror](https://github.com/ged/framenet).
 
 After checking out the source, run:
 
@@ -61,12 +62,12 @@ and generate the API documentation.
 
 This library includes data from the FrameNet project:
 
-  https://framenet.icsi.berkeley.edu/
+> https://framenet.icsi.berkeley.edu/
 
-It is distributed under the terms of the Creative Commons Attribution
+which is distributed under the terms of the Creative Commons Attribution
 license:
 
-  https://creativecommons.org/licenses/by/4.0/
+> https://creativecommons.org/licenses/by/4.0/
 
 Everything else:
 

data/Rakefile

@@ -14,13 +14,12 @@ Hoe.plugin :signing
 Hoe.plugin :deveiate
 
 Hoe.plugins.delete :rubyforge
-Hoe.plugins.delete :gemcutter # Remove for public gems
 
 hoespec = Hoe.spec 'ruby-framenet' do |spec|
-	self.readme_file = 'README.md'
-	self.history_file = 'History.md'
-	self.extra_rdoc_files = FileList[ '*.md' ]
-	self.urls = {
+	spec.readme_file = 'README.md'
+	spec.history_file = 'History.md'
+	spec.extra_rdoc_files = FileList[ '*.md' ]
+	spec.urls = {
 		home:   'http://deveiate.org/projects/ruby-framenet',
 		code:   'http://bitbucket.org/ged/ruby-framenet',
 		docs:   'http://deveiate.org/code/ruby-framenet',
@@ -42,7 +41,7 @@ hoespec = Hoe.spec 'ruby-framenet' do |spec|
 	spec.hg_sign_tags = true if spec.respond_to?( :hg_sign_tags= )
 	spec.check_history_on_release = true if spec.respond_to?( :check_history_on_release= )
 
-	self.rdoc_locations << "deveiate:/usr/local/www/public/code/#{remote_rdoc_dir}"
+	spec.rdoc_locations << "deveiate:/usr/local/www/public/code/#{remote_rdoc_dir}"
 end
 
 
@@ -71,9 +70,9 @@ if File.directory?( '.hg' )
 
 	Rake::Task[ 'docs' ].clear
 	RDoc::Task.new( 'docs' ) do |rdoc|
-	    rdoc.main = "README.rdoc"
+	    rdoc.main = "README.md"
 		rdoc.markup = 'markdown'
-	    rdoc.rdoc_files.include( "*.rdoc", "ChangeLog", "lib/**/*.rb" )
+	    rdoc.rdoc_files.include( "*.md", "ChangeLog", "lib/**/*.rb" )
 	    rdoc.generator = :fivefish
 		rdoc.title = 'FrameNet'
 	    rdoc.rdoc_dir = 'doc'
@@ -81,7 +80,7 @@ if File.directory?( '.hg' )
 end
 
 task :gemspec => GEMSPEC
-file GEMSPEC => __FILE__
+file GEMSPEC => [ __FILE__, 'lib/frame_net.rb' ]
 task GEMSPEC do |task|
 	spec = $hoespec.spec
 	spec.files.delete( '.gemtest' )

data/lib/frame_net.rb

@@ -16,10 +16,10 @@ module FrameNet
 	extend Loggability
 
 	# Package version
-	VERSION = '0.0.1'
+	VERSION = '0.0.2'
 
 	# Version control revision
-	REVISION = %q$Revision: 767b08e54e6a $
+	REVISION = %q$Revision: ecb01eee279b $
 
 	# The Pathname for the library's data directory, taken from the
 	# FRAME_NET_DATA_DIR env variable first, then the datadir for the ruby-framenet

data/lib/frame_net/frame.rb

@@ -34,6 +34,7 @@ class FrameNet::Frame
 			raise ArgumentError, "don't know how to load a frame from a %p" % [ name_or_id.class ]
 		end
 	end
+	class << self; alias_method :[], :load; end
 
 
 	### Return a LibXML::XML::Document for the data for the frame named +name+.
@@ -120,6 +121,14 @@ class FrameNet::Frame
 	attr_accessor :lexical_units
 
 
+	### Object equality -- returns +true+ if the receiver repressents the same
+	### FrameNet frame as +other_frame+.
+	def ==( other_frame )
+		return other_frame.is_a?( self.class ) && self.id == other_frame.id
+	end
+	alias_method :eql?, :==
+
+
 	### Return the Frame as a human-readable string suitable for debugging.
 	def inspect
 		return %{#<%p:%#016x "%s" [%d] %d elements, %d relations, %d lexical units>} % [
@@ -134,6 +143,28 @@ class FrameNet::Frame
 	end
 
 
+	#
+	# Elements
+	#
+
+	### Return the Hash of this Frame's FEs keyed by numeric ID.
+	def elements_by_id
+		return self.elements.each_with_object( {} ) do |el, hash|
+			hash[ el.id ] = el
+		end
+	end
+
+
+	### Return a Hash of this Frame's FEs grouped by core type.
+	def elements_by_core_type
+		return self.elements.group_by( &:core_type )
+	end
+
+
+	#
+	# Relations
+	#
+
 	### Return the FrameNet::Frame::Relations this Frame has as a Hash keyed by the
 	### Relation's type as a String.
 	def relations_hash
@@ -149,10 +180,93 @@ class FrameNet::Frame
 	end
 
 
+	### Return Frames the receiver is inherited by.
+	def is_inherited_by
+		return self.relations_hash[ "Is Inherited by" ].frames
+	end
+
+
+	### Return Frames in which the receiver is one of several perspectives.
+	def perspective_on
+		return self.relations_hash[ "Perspective on" ].frames
+	end
+
+
+	### Return Frames which represent different states of affairs of the receiving
+	### Frame.
+	def is_perspectivized_in
+		return self.relations_hash[ "Is Perspectivized in" ].frames
+	end
+
+
+	### Return Frames the receiver uses in some capacity.
+	def uses
+		return self.relations_hash[ "Uses" ].frames
+	end
+
+
+	### Return Frames the receiver is used by.
+	def is_used_by
+		return self.relations_hash[ "Is Used by" ].frames
+	end
+
+
+	### Return Frames the receiver is a subframe of.
+	def subframe_of
+		return self.relations_hash[ "Subframe of" ].frames
+	end
+
+
+	### Return Frames which are a subframe of the receiver.
+	def has_subframes
+		return self.relations_hash[ "Has Subframe(s)" ].frames
+	end
+	alias_method :has_subframe, :has_subframes
+
+
+	### Return Frames the receiver comes before in a series of subframes of another
+	### Frame.
+	def precedes
+		return self.relations_hash[ "Precedes" ].frames
+	end
+
+
+	### Return Frames the receiver comes after in a series of subframes of another
+	### Frame.
+	def is_preceded_by
+		return self.relations_hash[ "Is Preceded by" ].frames
+	end
+
+
+	### Return Frames in which the receiving frame is an inchoative subframe.
+	def is_inchoative_of
+		return self.relations_hash[ "Is Inchoative of" ].frames
+	end
+
+
+	### Return Frames in which the receiving frame is a causative subframe.
+	def is_causative_of
+		return self.relations_hash[ "Is Causative of" ].frames
+	end
+
+
+	### Return the other members of a group of Frames which should be compared to
+	### the receiving Frame.
+	def see_also
+		return self.relations_hash[ "See also" ].frames
+	end
+
+
+
+	#
+	# Utilities/Testing
+	#
+
 	### Return the XML document that contains the data for the frame (if one exists). Returns
 	### +nil+ if the document doesn't exist.
 	def document
 		return self.class.document_for( self.name )
 	end
 
+
 end # class FrameNet::Frame

data/spec/frame_net/frame/relation_spec.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/env rspec -cfd
+
+require_relative '../../spec_helper'
+
+require 'frame_net/frame/relation'
+
+
+describe FrameNet::Frame::Relation do
+
+	let( :frame_name ) { :Transition_to_a_situation }
+	let( :frame_doc ) { FrameNet.load_document("frame/#{frame_name}.xml") }
+
+
+	it "can be created from a frame XML document" do
+		results = described_class.from_frame_data( frame_doc )
+
+		expect( results ).to be_an( Array ).and( all be_a(described_class) )
+		expect( results.length ).to eq( frame_doc.find('/fn:frame/fn:frameRelation').length )
+	end
+
+
+	it "can look up its frames" do
+		relations = described_class.from_frame_data( frame_doc )
+		inherits_from = relations.find {|rel| rel.type == 'Inherits from' }
+		expect( inherits_from.frames ).to eq([ FrameNet[:Transition_to_state] ])
+	end
+
+end
+

data/spec/frame_net/frame_spec.rb

@@ -39,5 +39,188 @@ describe FrameNet::Frame do
 		expect( result.id ).to eq( 218 )
 	end
 
+
+	describe "elements (FEs)" do
+
+		let( :frame ) { described_class.load(:Becoming_aware) }
+
+
+		it "can return its frame elements keyed by ID" do
+			result = frame.elements_by_id
+
+			expect( result ).to be_a( Hash )
+			expect( result.keys ).to all( be_a Integer )
+			expect( result.values ).to all( be_a FrameNet::Frame::Element )
+		end
+
+
+		it "can return its frame elements grouped by their core type" do
+			result = frame.elements_by_core_type
+
+			expect( result ).to be_a( Hash )
+			expect( result.keys ).to all( be_a String )
+			expect( result.values ).to all( be_a(Array) )
+		end
+
+	end
+
+
+	describe "relations" do
+
+		it "can return its relations as a Hash keyed by type" do
+			frame = described_class.load( :Statement )
+			result = frame.relations_hash
+
+			expect( result ).to be_a( Hash )
+			expect( result.keys ).to all( be_a String )
+			expect( result.values ).to all( be_a FrameNet::Frame::Relation )
+		end
+
+
+		it "provides a convenience method for fetching 'Inherits from' frames" do
+			frame = described_class.load( :Cause_to_experience )
+			results = frame.inherits_from
+
+			expect( results ).to eq([ described_class.load(:Intentionally_affect) ])
+		end
+
+
+		it "provides a convenience method for fetching 'Is inherited by' frames" do
+			frame = described_class.load( :Intentionally_affect )
+			results = frame.is_inherited_by
+
+			expect( results ).to be_an( Array )
+			expect( results.length ).to eq( 47 )
+			expect( results ).to include(
+				described_class.load( :Attack ),
+				described_class.load( :Cause_to_perceive ),
+				described_class.load( :Detaching ),
+				described_class.load( :Rescuing )
+			)
+		end
+
+
+		it "provides a convenience method for fetching 'Perspective on' frames" do
+			frame = described_class.load( :Growing_food )
+			results = frame.perspective_on
+
+			expect( results ).to be_an( Array )
+			expect( results.length ).to eq( 1 )
+			expect( results ).to include( described_class.load(:Agriculture) )
+		end
+
+
+		it "provides a convenience method for fetching 'Is Perspectivized in' frames" do
+			frame = described_class.load( :Simultaneity )
+			results = frame.is_perspectivized_in
+
+			expect( results ).to be_an( Array )
+			expect( results.length ).to eq( 2 )
+			expect( results ).to include(
+				described_class.load(:Temporal_collocation),
+				described_class.load(:Location_in_time)
+			)
+		end
+
+
+		it "provides a convenience method for fetching 'Uses' frames" do
+			frame = described_class.load( :Legal_rulings )
+			results = frame.uses
+
+			expect( results ).to be_an( Array )
+			expect( results.length ).to eq( 1 )
+			expect( results ).to include( described_class.load(:Communication) )
+		end
+
+
+		it "provides a convenience method for fetching 'Is Used by' frames" do
+			frame = described_class.load( :Intentionally_affect )
+			results = frame.is_used_by
+
+			expect( results ).to be_an( Array )
+			expect( results.length ).to eq( 3 )
+			expect( results ).to include(
+				described_class.load(:Arson),
+				described_class.load(:Import_export_scenario),
+				described_class.load(:Bungling)
+			)
+		end
+
+
+		it "provides a convenience method for fetching 'Subframe of' frames" do
+			frame = described_class.load( :Planting )
+			results = frame.subframe_of
+
+			expect( results ).to be_an( Array )
+			expect( results.length ).to eq( 1 )
+			expect( results ).to include( described_class.load(:Agriculture) )
+		end
+
+
+		it "provides a convenience method for fetching 'Has Subframe(s)' frames" do
+			frame = described_class.load( :Travel )
+			results = frame.has_subframe
+
+			expect( results ).to be_an( Array )
+			expect( results.length ).to eq( 1 )
+			expect( results ).to include( described_class.load(:Setting_out) )
+		end
+
+
+
+		it "provides a convenience method for fetching 'Precedes' frames" do
+			frame = described_class.load( :Aiming )
+			results = frame.precedes
+
+			expect( results ).to be_an( Array )
+			expect( results.length ).to eq( 1 )
+			expect( results ).to include( described_class.load(:Hit_or_miss) )
+		end
+
+
+
+		it "provides a convenience method for fetching 'Is Preceded by' frames" do
+			frame = described_class.load( :Sleep )
+			results = frame.is_preceded_by
+
+			expect( results ).to be_an( Array )
+			expect( results.length ).to eq( 1 )
+			expect( results ).to include( described_class.load(:Fall_asleep) )
+		end
+
+
+		it "provides a convenience method for fetching 'Is Inchoative of' frames" do
+			frame = described_class.load( :Forming_relationships )
+			results = frame.is_inchoative_of
+
+			expect( results ).to be_an( Array )
+			expect( results.length ).to eq( 1 )
+			expect( results ).to include( described_class.load(:Personal_relationship) )
+		end
+
+
+		it "provides a convenience method for fetching 'Is Causative of' frames" do
+			frame = described_class.load( :Cause_change_of_consistency )
+			results = frame.is_causative_of
+
+			expect( results ).to be_an( Array )
+			expect( results.length ).to eq( 1 )
+			expect( results ).to include( described_class.load(:Change_of_consistency) )
+		end
+
+
+
+		it "provides a convenience method for fetching 'See also' frames" do
+			frame = described_class.load( :Cure )
+			results = frame.see_also
+
+			expect( results ).to be_an( Array )
+			expect( results.length ).to eq( 1 )
+			expect( results ).to include( described_class.load(:Medical_intervention) )
+		end
+
+
+	end
+
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-framenet
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Michael Granger
@@ -35,7 +35,7 @@ cert_chain:
   w8aNA5re5+Rt/Vvjxj5AcEnZnZiz5x959NaddQocX32Z1unHw44pzRNUur1GInfW
   p4vpx2kUSFSAGjtCbDGTNV2AH8w9OU4xEmNz8c5lyoA=
   -----END CERTIFICATE-----
-date: 2017-03-09 00:00:00.000000000 Z
+date: 2017-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: loggability
@@ -163,8 +163,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.15'
-description: This is a Ruby interface to FrameNet, a lexical database of English word
-  usage.
+description: |-
+  This is a Ruby interface to FrameNet, a lexical database of English word usage. It
+  includes version 1.7 of the FrameNet data, and Ruby classes for querying them.
 email:
 - ged@FaerieMUD.org
 executables: []
@@ -15008,6 +15009,7 @@ files:
 - spec/frame_net/definition_spec.rb
 - spec/frame_net/frame/element_spec.rb
 - spec/frame_net/frame/lexical_unit_spec.rb
+- spec/frame_net/frame/relation_spec.rb
 - spec/frame_net/frame_spec.rb
 - spec/frame_net/semantic_type_spec.rb
 - spec/frame_net_spec.rb
@@ -15038,5 +15040,5 @@ rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: This is a Ruby interface to FrameNet, a lexical database of English word
-  usage.
+  usage
 test_files: []