gearbox 0.1.10 → 0.1.17

data/README.md

@@ -5,7 +5,7 @@ The purpose of this project is to make it easier for me to curate semantic graph
 
 To get to wherever I am now, I've been playing with semantic models for a while.  I started by demonstrating working code from various corners of my imagination.  After a while, I thought I had enough to create a useful gem.  In the past, I've worked with [Spira](https://github.com/bhuga/spira) and examples given by [Gregg Kellogg](http://greggkellogg.net/).  These have been very useful in forming ideas.
 
-As I worked on this code, I decided to go to [Spira](https://github.com/bhuga/spira) to see how similar the two gems are.  I was surprised how similar they actually are.  The similarities are:
+As I worked on this code, I decided to go to [Spira](https://github.com/bhuga/spira) to see how similar the two gems are.  I've read Ben's code a dozen times before, but this time I was surprised how similar they actually are.  The similarities are:
 
 * both are ORMs for semantic data, written in Ruby
 * support for properties/attributes
@@ -13,43 +13,25 @@ As I worked on this code, I decided to go to [Spira](https://github.com/bhuga/sp
 * data validations
 * value types
 
-However, Gearbox is quite a bit different.  It came from a different place.  I've been trying to embrace the nature of semantic models.  This, juxtaposed against relational models or other types of models.  The major differences, I imagine are:
+However, Gearbox is quite a bit different.  It came from a different place.  I've been trying to embrace the nature of semantic models (or find a way to express my imagination with semantic tools).  The major differences, I imagine are:
 
 * support for SPARQL-based scopes and finder methods
 * better support for working with various SPARQL end points
 * creating and maintaining full-text indices
 * object factory from triples
 
-Development Workflow for Semantic Data
-======================================
-
-For a typical domain, I test-drive some models to define the nature of the data.  These are custom-built to support the user scenarios and behavior an application is built to serve.  For semantic models, I'm going for something different.  The relationships between resources are much more dynamic.  It's tough to build an application on dynamic domain models.  
-
-To work with this, I'd rather optimize for different things.  Instead of trying to canonize the data, concretize the interaction.  Given a head/buffer/file full of data, what's the easiest way to save it?  Which values have to be recorded?  Which values can be inferred or classified offline?  
-
-I think that there's going to be an evolution of the data graph.  I'm looking to start with the mundane, and hope to be able to create a broad view from the details collected.  Possibly, I will have alternative broad views, such as a full view of the topic or a chronological account of the topic as it transpires.  From here, I want to look for insightful information: inferences that show the nature of our subject.  
-
-That's the goal.
-
-Practically, the work changes over time.  We start with defining the attributes and associations that are needed.  This is the mundane.  We then start to qualify the data by writing validations.  Probably, there will be overlapping models to reflect the interaction.  For example, browsing email might have a cursory recording of the people involved.  Looking up Twitter information might have a more-specific user model.  Facebook, the same.  We're building a summary of the users, or whatever we're studying.  From here, we might be able to use various analytical methods to classify and enhance the models, to clarify the story we are able to gather.
-
-As you can see, this is a very different process than something we might do with typical relational data.  I don't think there is much that we do with semantic data that can't be done with relational data, it's just that the technologies are optimized for different purposes.
-
 Practical Example
 =================
 
-It would be good to offer a practical example.  I'll get to these in a bit.  I don't need to have the documentation get ahead of the released code.
+It would be good to offer a practical example.  I'll get to these in a bit.  Probably these will start appearing around version 0.2 or 0.3.  They probably won't be very exciting until around version 0.4.
 
-TODO
-====
+Road Ahead
+==========
 
-* bring in the association and combination code
-* implement mutability
-* implement persistence
-* implement queryable
-* implement named scopes
-* implement some sort of repository access
-* use Gearbox in the examples (were written to concretize an example in my head)
+* bring in the associations and type system (related, believe it or not)
+* implement mutability (version 0.2)
+* workflows with SPIN and full-text indexing (version 0.3)
+* exploration utilities (version 0.4)
 
 Contributing to Gearbox
 =======================

data/VERSION

@@ -1 +1 @@
-0.1.10
+0.1.17

data/gearbox.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "gearbox"
-  s.version = "0.1.10"
+  s.version = "0.1.17"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["David Richards"]
-  s.date = "2012-04-03"
+  s.date = "2012-04-05"
   s.description = "A SPARQL-driven modeling toolset for semantic models."
   s.email = "davidlamontrichards@gmail.com"
   s.executables = ["gearbox"]
@@ -34,6 +34,7 @@ Gem::Specification.new do |s|
     "lib/gearbox/attribute_collection.rb",
     "lib/gearbox/mixins/active_model_implementation.rb",
     "lib/gearbox/mixins/ad_hoc_properties.rb",
+    "lib/gearbox/mixins/queryable_implementation.rb",
     "lib/gearbox/mixins/resource.rb",
     "lib/gearbox/mixins/semantic_accessors.rb",
     "lib/gearbox/mixins/subject_methods.rb",
@@ -64,6 +65,7 @@ Gem::Specification.new do |s|
     "spec/gearbox/attribute_spec.rb",
     "spec/gearbox/mixins/active_model_implementation_spec.rb",
     "spec/gearbox/mixins/ad_hoc_properties_spec.rb",
+    "spec/gearbox/mixins/queryable_implementation_spec.rb",
     "spec/gearbox/mixins/resource_spec.rb",
     "spec/gearbox/mixins/semantic_accessors_spec.rb",
     "spec/gearbox/mixins/subject_methods_spec.rb",

data/lib/gearbox.rb

@@ -129,6 +129,7 @@ module Gearbox
   autoload :AdHocProperties, path('mixins/ad_hoc_properties')
   autoload :ActiveModelImplementation, path('mixins/active_model_implementation')
   autoload :AttributeMethods, path('mixins/attribute_methods')
+  autoload :QueryableImplementation, path('mixins/queryable_implementation')
   autoload :Resource, path('mixins/resource')
   autoload :SemanticAccessors, path('mixins/semantic_accessors')
   autoload :SubjectMethods, path('mixins/subject_methods')

data/lib/gearbox/mixins/active_model_implementation.rb

@@ -16,6 +16,7 @@ module Gearbox
       base.send :include, ActiveModel::Serializers::Xml
       
       base.send :extend, ActiveModel::Naming
+      base.send :include, ActiveModel::Dirty
     end
     
     # TODO Temporary!!! Remove after finishing the Mutable changes.

data/lib/gearbox/mixins/queryable_implementation.rb

@@ -0,0 +1,14 @@
+module Gearbox
+  module QueryableImplementation
+    def self.included(base)
+      base.send :include, RDF::Queryable
+    end
+    
+    # Depends on RDF::Queryable, SemanticAccessors and SubjectMethods
+    def each(opts={}, &block)
+      attribute_definitions.map{|name, attribute| attribute.to_rdf(self, opts)}.each(&block)
+    end
+    alias :each_statement :each
+    
+  end
+end

data/lib/gearbox/mixins/resource.rb

@@ -13,16 +13,12 @@ module Gearbox
       # This is more for knowledge base discovery or throw-away models
       # So there's a new approach on the horizon of my imagination.
       # base.send :include, AdHocProperties
+
+      base.send :include, ActiveModelImplementation
       base.send :include, SubjectMethods
       base.send :include, SemanticAccessors
-      base.send :include, ActiveModelImplementation
+      base.send :include, QueryableImplementation
       base.send :include, RDF::Mutable
-      base.send :include, RDF::Queryable
-    end
-    
-    # Depends on RDF::Queryable, SemanticAccessors and SubjectMethods
-    def each(opts={}, &block)
-      attribute_definitions.map{|name, attribute| attribute.to_rdf(self, opts)}.each(&block)
     end
     
     def inspect

data/lib/gearbox/mixins/semantic_accessors.rb

@@ -23,11 +23,15 @@ module Gearbox
         end
         
         define_method("#{name}=") do |value|
+          @previously_changed = changes
           attribute_definitions[name] ||= Attribute.new(opts)
-          attribute_definitions[name].set(value)
+          old_value = attribute_definitions[name].get
+          new_value = attribute_definitions[name].set(value)
+          name_will_change! unless new_value == old_value
         end
 
         attributes[name] = opts
+        define_attribute_method(name)
       end
     end
     
@@ -37,6 +41,7 @@ module Gearbox
         super
         assert_defaults
         assert_options(opts)
+        @changed_attributes.clear if @changed_attributes
       end
       
       def attributes

data/lib/pry_utilities.rb

@@ -1,6 +1,7 @@
 # Useful for a Pry session.
 
 require 'forwardable'
+require 'fileutils'
 
 include Gearbox
 
@@ -17,17 +18,49 @@ class Utilities
   alias :update_model :write_model
   alias :build_model :write_model
   
+  def edit_models
+    raise "Directory does not exist" unless File.exist?(model_directory)
+    raise "ENV['EDITOR'] not set" unless ENV['EDITOR']
+    `#{ENV['EDITOR']} #{model_directory}`
+    puts "The models are open in your editor, but you will need to load them again after completing your work."
+    true
+  end
+  
   def load_model(name)
     raise "Directory does not exist" unless File.exist?(model_directory)
     filename = File.join(model_directory, "#{name}.rb")
     load filename
   end
+  
+  def load_models
+    Dir.glob("#{model_directory}/*.rb").map { |filename| load filename}
+  end
 
+  def user_directory
+    File.expand_path("~/.gearbox")
+  end
+  
+  def user_model_directory
+    @user_model_directory ||= File.join(user_directory, "models")
+  end
+  
   def model_directory
-    @model_directory ||= "/tmp"
+    return @model_directory if @model_directory
+    if File.exists?(user_directory)
+      FileUtils.mkdir(user_model_directory) unless File.exists?(user_model_directory)
+      @model_directory = user_model_directory
+    elsif File.exists?("/tmp")
+      @model_directory = File.expand_path("/tmp") if File.exists?("/tmp")
+    end
+    @model_directory
   end
   attr_writer :model_directory
   
+  def list_models
+    Dir.glob("#{model_directory}/*.rb").map { |file| File.basename(file).split('.')[0..-2].join('.').to_sym}
+    true
+  end
+  
   def tmp_directory
     @tmp_directory ||= "/tmp"
   end
@@ -59,13 +92,16 @@ end
 @utilities = Utilities.new
 extend Forwardable
 def_delegators :@utilities, 
-  :write_model, 
-  :update_model,
   :build_model, 
+  :edit_models,
+  :get_note,
+  :list_models,
+  :load_model,
+  :load_models,
   :model_directory, 
   :model_directory=, 
   :tmp_directory,
   :tmp_directory=,
-  :get_note,
-  :load_model
+  :update_model,
+  :write_model
   

data/spec/gearbox/mixins/queryable_implementation_spec.rb

@@ -0,0 +1,36 @@
+require_relative '../../spec_helper'
+
+include Gearbox
+
+describe QueryableImplementation do
+  
+  before do
+    @class = Class.new do
+      include Gearbox::Resource
+    end
+  end
+  
+  subject { @class.new }
+
+  it "uses RDF::Queryable" do
+    @class = Class.new {include Gearbox::QueryableImplementation}
+    @class.included_modules.must_include RDF::Queryable
+  end
+
+  it "has each defined on the model" do
+    subject.respond_to?(:each).must_equal true
+  end
+  
+  it "produces RDF statements from the enumeration" do
+    @class.attribute :name, :predicate => RDF::FOAF.name
+    subject = @class.new(:name => "George")
+    subject.to_a.must_equal([RDF::Statement.new(subject.subject, RDF::FOAF.name, RDF::Literal.new("George"))])
+  end
+  
+  it "aliases each_statement to each" do
+    @class.attribute :name, :predicate => RDF::FOAF.name
+    subject = @class.new(:name => "George")
+    subject.each_statement.to_a.must_equal([RDF::Statement.new(subject.subject, RDF::FOAF.name, RDF::Literal.new("George"))])
+  end
+
+end

data/spec/gearbox/mixins/resource_spec.rb

@@ -35,23 +35,6 @@ describe Resource do
     @class.included_modules.must_include RDF::Mutable
   end
   
-  it "uses RDF::Queryable" do
-    @class.included_modules.must_include RDF::Queryable
-  end
-  
-  describe "Enumerable integration" do
-    it "has each defined on the model" do
-      subject.respond_to?(:each).must_equal true
-    end
-    
-    it "produces RDF statements from the enumeration" do
-      @class.attribute :name, :predicate => RDF::FOAF.name
-      subject = @class.new(:name => "George")
-      subject.to_a.must_equal([RDF::Statement.new(subject.subject, RDF::FOAF.name, RDF::Literal.new("George"))])
-    end
-    
-  end
-  
   describe "Load order" do
     # Unfortunately, the load order is important here.
     # There is only one example right now: id.

data/spec/gearbox/mixins/semantic_accessors_spec.rb

@@ -10,6 +10,7 @@ describe SemanticAccessors do
       @class = Class.new do
         def self.name; 'demo_class'; end
         include SemanticAccessors
+        include ActiveModelImplementation
       end
     end
 
@@ -33,6 +34,18 @@ describe SemanticAccessors do
         @class.attribute(:name, :predicate => RDF::FOAF.name)
         @class.attributes[:name].must_equal({:name => :name, :predicate => RDF::FOAF.name})
       end
+      
+      it "uses define_attribute_method to tell ActiveModel about the attribute" do
+        def @class.define_attribute_method(name)
+          @attribute_methods_defined ||= []
+          @attribute_methods_defined << name
+        end
+        def @class.attribute_methods_defined
+          @attribute_methods_defined
+        end
+        @class.attribute(:name, :predicate => RDF::FOAF.name)
+        @class.attribute_methods_defined.must_equal([:name])
+      end
     end
   end # "Class methods"
   
@@ -40,6 +53,7 @@ describe SemanticAccessors do
     before do
       @class = Class.new do
         include SemanticAccessors
+        include ActiveModelImplementation
         attribute :name, :predicate => RDF::FOAF.name
       end
     end
@@ -51,6 +65,16 @@ describe SemanticAccessors do
       subject.name.must_equal "George"
     end
     
+    it "marks the attribute as dirty when changed" do
+      subject.name = "George"
+      subject.changed_attributes.must_equal({"name" => "George"})
+    end
+    
+    it "does not mark the attributes as dirty after initialization" do
+      subject = @class.new(:name => "George")
+      subject.changed?.must_equal false
+    end
+    
     it "supports the attribute data types" do
       # In fact, it supports the full attribute system, this is just a quick check.
       @class.attribute :birthday, :predicate => RDF::FOAF.birthday, :datatype => RDF::XSD.date

data/spec/spec_helper.rb

@@ -10,6 +10,7 @@ rescue Bundler::BundlerError => e
   exit e.status_code
 end
 require 'minitest/spec'
+require 'minitest/mock'
 require 'minitest/autorun'
 
 $LOAD_PATH.unshift(File.dirname(__FILE__))

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gearbox
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.1.17
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-03 00:00:00.000000000Z
+date: 2012-04-05 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: linkeddata
@@ -276,6 +276,7 @@ files:
 - lib/gearbox/attribute_collection.rb
 - lib/gearbox/mixins/active_model_implementation.rb
 - lib/gearbox/mixins/ad_hoc_properties.rb
+- lib/gearbox/mixins/queryable_implementation.rb
 - lib/gearbox/mixins/resource.rb
 - lib/gearbox/mixins/semantic_accessors.rb
 - lib/gearbox/mixins/subject_methods.rb
@@ -306,6 +307,7 @@ files:
 - spec/gearbox/attribute_spec.rb
 - spec/gearbox/mixins/active_model_implementation_spec.rb
 - spec/gearbox/mixins/ad_hoc_properties_spec.rb
+- spec/gearbox/mixins/queryable_implementation_spec.rb
 - spec/gearbox/mixins/resource_spec.rb
 - spec/gearbox/mixins/semantic_accessors_spec.rb
 - spec/gearbox/mixins/subject_methods_spec.rb
@@ -327,7 +329,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -845810536138016079
+      hash: 1172307424994719689
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: