cabalist 0.0.1 → 0.0.2

data/spec/cabalist/frontend_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+describe Cabalist::Frontend do
+  
+  with_model :Cat do
+    
+    table do |t|
+      t.string    :color
+      t.boolean   :evil
+      t.timestamp :autoclassified_at
+    end
+
+    model do
+      extend Cabalist::ModelAdditions
+
+      def self.test_cats
+        result = []
+        100.times { result << Cat::create(:color => 'white', :evil => false) }
+        100.times { result << Cat::create(:color => 'black', :evil => true) }
+        return result
+      end
+    
+      acts_as_cabalist :class_variable => :evil,
+                       :features       => [:color],
+                       :collection     => :test_cats
+    end
+
+  end
+  
+  before(:each) do
+    Cat::test_cats
+    Cabalist::Configuration.instance.frontend_classes = [Cat]
+  end
+  
+  it "should respond to GET at /" do
+    get '/'
+    last_response.should be_ok
+    last_response.body.should match /Cats/
+  end
+  
+  it "should list all records for Cat" do
+    get "/cat/all/1"
+    last_response.should be_ok
+  end
+  
+  it "should list non-classified records for Cat" do
+    get "/cat/none/1"
+    last_response.should be_ok
+  end
+  
+  it "should list manually classified records for Cat" do
+    get "/cat/manual/1"
+    last_response.should be_ok
+  end
+  
+  it "should list automatically classified records for Cat" do
+    get "/cat/auto/1"
+    last_response.should be_ok
+  end
+  
+  it "should set the value of class variable for a Cat with a given ID" do
+    cat = Cat.first
+    post "/cat/teach/#{cat.id}", { :classification => true, :classification_freeform => '' },
+                                 { :referer => '/cat/all/1' }
+    last_response.should be_redirect
+  end
+  
+  it "should automatically classify the Cat with a given ID" do
+    cat = Cat.first
+    post "/cat/autoclassify/#{cat.id}", {}, { :referer => '/cat/manual/1' }
+    last_response.should be_redirect
+  end
+  
+  it "should retrain the Cat classification model" do
+    post "/cat/retrain", {}, { :referer => '/cat/manual/1' }
+    last_response.should be_redirect
+  end
+  
+end

data/spec/cabalist/model_additions_spec.rb

@@ -0,0 +1,104 @@
+require 'spec_helper'
+
+describe Cabalist::ModelAdditions do
+  
+  with_model :Cat do
+    
+    table do |t|
+      t.string    :color
+      t.boolean   :evil
+      t.timestamp :autoclassified_at
+    end
+
+    model do
+      extend Cabalist::ModelAdditions
+
+      def self.test_cats
+        result = []
+        10.times { result << Cat::create(:color => 'white', :evil => false) }
+        10.times { result << Cat::create(:color => 'black', :evil => true) }
+        return result
+      end
+    
+      acts_as_cabalist :class_variable => :evil,
+                       :features       => [:color],
+                       :collection     => :test_cats
+    end
+
+  end
+  
+  before(:each) do
+    @new_cat   = Cat::new(:color => 'white', :evil => false)
+    @white_cat = Cat::new(:color => 'white')
+    @black_cat = Cat::new(:color => 'black')
+  end
+  
+  # == Test class (static) methods =================================== #
+  it "Should return feature names" do
+    Cat::get_feature_names.should eq [:color]
+  end
+  
+  it "Shoud return class variable name" do
+    Cat::get_class_variable_name.should eq :evil
+  end
+  
+  it "Should be able to build a classifier" do
+    Cat::build_model.should be_an_instance_of Ai4r::Classifiers::ID3
+  end
+  
+  it "Should be able to train a classifier" do
+    Cat::train_model.should be_an_instance_of Ai4r::Classifiers::ID3
+  end
+  
+  it "Should be able to return a classifier" do
+    Cat::classifier.should be_an_instance_of Ai4r::Classifiers::ID3
+  end
+  
+  it "Should return class variable value domain" do
+    Cat::class_variable_domain.should eq [false, true]
+  end
+  # == END =========================================================== #
+  
+  # == Test instance methods ========================================= #
+  it "Should return feature values" do
+    @new_cat.get_features.should eq ['white']
+  end
+  
+  it "Should return class variable value" do
+    @new_cat.get_class_variable.should eq false
+  end
+  
+  it "Should be able to set class variable accordingly" do
+    @new_cat.set_class_variable(true)
+    @new_cat.evil?.should eq true
+  end
+  
+  it "Should be able to predict the value of class variable" do
+    @white_cat.classify.should eq false
+    @black_cat.classify.should eq true
+  end
+  
+  it "Should not timestamp an object when calling \#classify" do
+    @white_cat.classify
+    @white_cat.autoclassified_at.should eq nil
+  end
+  
+  it "Should autoclassify an object when calling \#classify!" do
+    @white_cat.classify!
+    @white_cat.autoclassified_at.should be_an_instance_of DateTime
+    @white_cat.evil?.should eq false
+    
+    @black_cat.classify!
+    @black_cat.autoclassified_at.should be_an_instance_of DateTime
+    @black_cat.evil?.should eq true
+  end
+  
+  it "Should remove an autoclassification timestamp when calling \#teach" do
+    @black_cat.classify!
+    @black_cat.teach(false)
+    @black_cat.autoclassified_at.should eq nil
+    @black_cat.evil?.should eq false
+  end
+  # == END =========================================================== #
+  
+end

data/spec/cabalist/performance_benchmark_spec.rb

@@ -0,0 +1,76 @@
+require 'benchmark'
+require 'spec_helper'
+
+RSpec::Matchers.define :take_less_than do |n|
+  chain :seconds do; end
+
+  match do |block|
+    @elapsed = Benchmark.realtime do
+      block.call
+    end
+    @elapsed <= n
+  end
+
+end
+
+describe Cabalist::ModelAdditions do
+  
+  with_model :Cat do
+    
+    table do |t|
+      t.string    :color
+      t.string    :gender
+      t.boolean   :evil
+      t.timestamp :autoclassified_at
+    end
+
+    model do
+      extend Cabalist::ModelAdditions
+
+      # Overall, the model will cover 8,000 cats. The idea is:
+      # - all white cats are good
+      # - all black cats are evil
+      # - all grey female cats are good
+      # - all grey make cats are evil
+      # - all ginger female cats are evil
+      # - all ginger male cats are good
+      def self.create_test_cats
+        result = []
+        1000.times { result << Cat::create(:color => 'white',  :gender => 'female', :evil => false) }
+        1000.times { result << Cat::create(:color => 'white',  :gender => 'male',   :evil => false) }
+        1000.times { result << Cat::create(:color => 'black',  :gender => 'female', :evil => true) }
+        1000.times { result << Cat::create(:color => 'black',  :gender => 'male',   :evil => true) }
+        1000.times { result << Cat::create(:color => 'grey',   :gender => 'female', :evil => false) }
+        1000.times { result << Cat::create(:color => 'grey',   :gender => 'male',   :evil => true) }
+        1000.times { result << Cat::create(:color => 'ginger', :gender => 'female', :evil => true) }
+        1000.times { result << Cat::create(:color => 'ginger', :gender => 'male',   :evil => false) }
+        return result
+      end
+    
+      acts_as_cabalist :class_variable => :evil,
+                       :features       => [:color, :gender],
+                       :collection     => :all
+    end
+
+  end
+  
+  it "Creates a model within less than 5 seconds" do
+    Cat::create_test_cats
+    Cat::count.should eq 8000
+    expect do
+      Cat::classifier
+    end.to take_less_than(5).seconds
+  end
+  
+  it "Classifies a new cat correctly and in less than 0.1 seconds" do
+    Cat::create_test_cats
+    Cat::count.should eq 8000
+    Cat::train_model
+    c = Cat::new(:color => 'white', :gender => 'male')
+    c.classify.should eq false
+    expect do
+      c.classify
+    end.to take_less_than(0.1).seconds
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+require 'active_record'
+require 'cabalist'
+require 'rack/test'
+require 'sinatra'
+require 'sqlite3'
+require 'with_model'
+
+ActiveRecord::Base.establish_connection(
+  :adapter  => "sqlite3",
+  :database => "/tmp/cabalist.sqlite3"
+)
+
+Cabalist.config do |c|
+  c.db_path = '/tmp/cabalist_level.db'
+end
+
+RSpec.configure do |config|
+  config.include Rack::Test::Methods
+  config.extend  WithModel
+end
+
+# setup test environment
+set :environment, :test
+set :run, false
+set :raise_errors, true
+set :logging, false
+
+def app
+  Cabalist::Frontend
+end

metadata

@@ -2,7 +2,7 @@
 name: cabalist
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Marcin Wyszynski
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-04 00:00:00 Z
+date: 2012-04-23 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: ai4r
@@ -20,11 +20,128 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "1.10"
+        version: "0"
   type: :runtime
   version_requirements: *id001
-description: 
-email: marcin.pixie@gmail.com
+- !ruby/object:Gem::Dependency 
+  name: haml
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: kaminari
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.13.0
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: leveldb-ruby
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: padrino-helpers
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id010
+- !ruby/object:Gem::Dependency 
+  name: with_model
+  prerelease: false
+  requirement: &id011 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id011
+description: |
+  Cabalist is conceived as a simple way of adding some smarts 
+  (machine learning capabilities) to your Ruby on Rails models 
+  without having to dig deep into mind-boggling AI algorithms. 
+  Using it is meant to be as straightforward as adding a few 
+  lines to your existing code and running a Rails generator or two.
+
+email: 
+- marcin.pixie@gmail.com
 executables: []
 
 extensions: []
@@ -32,10 +149,42 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- lib/cabalist/manager.rb
-- lib/cabalist/object_hooks.rb
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- cabalist.gemspec
 - lib/cabalist.rb
-homepage: https://github.com/marcinwyszynski/cabalist
+- lib/cabalist/configuration.rb
+- lib/cabalist/frontend.rb
+- lib/cabalist/model_additions.rb
+- lib/cabalist/railtie.rb
+- lib/cabalist/version.rb
+- lib/cabalist/views/classifier.haml
+- lib/cabalist/views/index.haml
+- lib/cabalist/views/layout.haml
+- lib/generators/cabalist/classifier/USAGE
+- lib/generators/cabalist/classifier/classifier_generator.rb
+- lib/generators/cabalist/classifier/templates/migrations/add_cabalist.rb.erb
+- lib/generators/cabalist/install/USAGE
+- lib/generators/cabalist/install/install_generator.rb
+- lib/generators/cabalist/install/templates/initializers/cabalist.rb
+- lib/generators/cabalist/install/templates/public/images/eye_12x9.png
+- lib/generators/cabalist/install/templates/public/images/logo.png
+- lib/generators/cabalist/install/templates/public/images/ncirl.png
+- lib/generators/cabalist/install/templates/public/images/pen_12x12.png
+- lib/generators/cabalist/install/templates/public/images/symbol.png
+- lib/generators/cabalist/install/templates/public/images/target_12x12.png
+- lib/generators/cabalist/install/templates/public/images/x_14x14.png
+- lib/generators/cabalist/install/templates/public/javascripts/cabalist.js
+- lib/generators/cabalist/install/templates/public/stylesheets/cabalist.css
+- spec/cabalist/frontend_spec.rb
+- spec/cabalist/model_additions_spec.rb
+- spec/cabalist/performance_benchmark_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/marcinwyszynski/cabalist
 licenses: []
 
 post_install_message: 
@@ -58,9 +207,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: cabalist
-rubygems_version: 1.8.5
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
-summary: Cabalist adds some precognition to your models using machine learning algorithms. It is more or less a  simple, easy to use wrapper around Ai4r - Ruby implementation of AI algorithms.
-test_files: []
-
+summary: Minimum setup machine learning (classification) library for Ruby on Rails applications.
+test_files: 
+- spec/cabalist/frontend_spec.rb
+- spec/cabalist/model_additions_spec.rb
+- spec/cabalist/performance_benchmark_spec.rb
+- spec/spec_helper.rb