netica 0.0.5-java → 0.0.6-java

data/CONTRIBUTING.md

@@ -0,0 +1,8 @@
+# Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Make your changes, including any tests.
+4. Once your tests pass, commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/README.md

@@ -65,14 +65,13 @@ Then, re-read the value of the Belief node.
     0.09241089224815369
     => 0.09241089224815369
 
+## Release Notes
 
-## Contributing
+### Version 0.0.6
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+* Changed BayesNetwork#getNode to BayesNetwork#node
+* Find a location for the NeticaJ.jar file using `rake netica:java_library_path`
+* Expand documentation
 
 ## Legal
 

data/Rakefile

@@ -1,6 +1,7 @@
 require "bundler/gem_tasks"
 require 'rspec'
 require 'rspec/core/rake_task'
+
 RSpec::Core::RakeTask.new do |t|
   t.rspec_opts = %w(--format progress --colour)
 end

data/lib/netica.rb

@@ -8,7 +8,9 @@ require "netica/node"
 require "netica/node_list"
 require "netica/bayes_network"
 require "netica/active_network"
+require "netica/java_library_path"
 
 module Netica
   include_package "norsys.netica"
+  require "netica/railtie" if defined?(Rails)
 end

data/lib/netica/active_network.rb

@@ -1,6 +1,7 @@
 module Netica
   require 'json'
 
+  # provides a persistable object container for a Netica Bayes net.
   class ActiveNetwork
     attr_accessor :network, :token
 
@@ -18,10 +19,18 @@ module Netica
       token
     end
 
+    # Increment a specified network node
+    #
+    # @param nodeName [String] name of the node to be incremented
+    # @return [true,false,nil] outcome of the incr() attempt
     def incr_node(nodeName)
-      network.getNode(nodeName).incr() if network
+      network.node(nodeName).incr() if network
     end
 
+    # Export the state of the ActiveNetwork as a Hash
+    #
+    # @param nodeName [String] name of the node to be incremented
+    # @return [Hash] network state and object class name
     def state
       {
         :network => network.state,
@@ -29,12 +38,20 @@ module Netica
       }
     end
 
+    # Save ActiveNetwork to an associated redis store, if one is defined.
+    #
+    # @return [true,false,nil] outcome of redis.set, or nil if redis is not found
     def save
       if Netica::Environment.instance.redis
-        Netica::Environment.instance.redis.set(token, JSON.dump(state))
+        return Netica::Environment.instance.redis.set(token, JSON.dump(state))
       end
     end
 
+    # Retrieve ActiveNetwork from current Netica Environment instance
+    # or an associated redis store, if one is defined.
+    #
+    # @param token [String] identifying token for ActiveNetwork sought
+    # @return [ActiveNetwork] ActiveNetwork object found
     def self.find(token)
       Netica::Environment.instance.active_networks.each do |an|
         return an if an.token == token
@@ -51,6 +68,10 @@ module Netica
       return nil
     end
 
+    # Export the state of the ActiveNetwork as a Hash
+    #
+    # @param hash [Hash] network state to be restored
+    # @return [Hash] network state and object class name
     def load_from_saved_state(hash)
       self.network = BayesNetwork.new(hash["network"]["dne_file_path"])
       network.load_from_state(hash["network"])

data/lib/netica/bayes_network.rb

@@ -9,9 +9,11 @@ module Netica
       end
     end
 
-    # retrieve a node from the associated network
-    # @param String nodeName
-    # @return Node
+    # retrieve the node from the associated network whose name matches
+    # the "nodeName" supplied.
+    #
+    # @param nodeName [String] Name of the node to find
+    # @return [Node]
     def node(nodeName)
       nodes.select{ |n| n if n.name == nodeName }[0]
     end
@@ -31,7 +33,7 @@ module Netica
     def load_from_state(network_hash)
       NeticaLogger.info "network_hash => #{network_hash}"
       network_hash["decision_nodes"].each do |node_name, node_value|
-        getNode(node_name).value = node_value
+        node(node_name).value = node_value
       end
     end
 

data/lib/netica/environment.rb

@@ -11,6 +11,10 @@ module Netica
     @@redis = nil
     @@logfile = nil
 
+    # Initializes logging, a Netica Environ object and a connection to
+    # redis, if defined.
+    #
+    # @param settings [Hash] Settings for initialization
     def self.engage(settings = {})
       if settings[:logfile]
         @@logfile = settings[:logfile]

data/lib/netica/java_library_path.rb

@@ -0,0 +1,14 @@
+include Java
+java_import java.lang.System
+
+module Netica
+  class Tools
+    def self.library_path
+      str = "Place NeticaJ.jar in one of the following locations:\n"
+      System.getProperties["java.library.path"].split(':').each do |pth|
+        str << "  => #{pth}\n" unless pth == '.'
+      end
+      str
+    end
+  end
+end

data/lib/netica/railtie.rb

@@ -0,0 +1,9 @@
+require 'netica'
+require 'rails'
+module Netica
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      require "#{File.dirname(__FILE__)}/../tasks/netica.rake"
+    end
+  end
+end

data/lib/netica/version.rb

@@ -1,3 +1,3 @@
 module Netica
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/lib/tasks/netica.rake

@@ -0,0 +1,8 @@
+require "#{File.dirname(__FILE__)}/../netica/java_library_path"
+
+namespace :netica do
+  desc "Output java.library.path"
+  task :java_library_path do
+    puts Netica::Tools.library_path
+  end
+end

data/spec/netica/active_network_spec.rb

@@ -22,7 +22,7 @@ describe Netica::ActiveNetwork do
         @active_network.network.nodes.length.should == 8
       end
 
-      it "should export it state as a hash" do
+      it "should export its state as a hash" do
         @active_network.network.state.should be_an_instance_of(Hash)
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: netica
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease:
 platform: java
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-04-14 00:00:00.000000000 Z
+date: 2013-04-23 00:00:00.000000000 Z
 dependencies: []
 description: Netica Bayes Network Management
 email:
@@ -20,6 +20,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -30,11 +31,14 @@ files:
 - lib/netica/active_network.rb
 - lib/netica/bayes_network.rb
 - lib/netica/environment.rb
+- lib/netica/java_library_path.rb
 - lib/netica/netica_logger.rb
 - lib/netica/node.rb
 - lib/netica/node_list.rb
+- lib/netica/railtie.rb
 - lib/netica/state.rb
 - lib/netica/version.rb
+- lib/tasks/netica.rake
 - netica.gemspec
 - spec/netica/active_network_spec.rb
 - spec/netica/environment_spec.rb