winston 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b136df3119babb39b3950a0cc96b393d3344453e
-  data.tar.gz: c10c1db2ceda4d4a553b209e7fceb433375eeabd
+  metadata.gz: 86cee2ee3ce5ed70188c907b9889a640f7ea6458
+  data.tar.gz: 6b9601b07bdf710141e1b9894c6b8e7b8389b694
 SHA512:
-  metadata.gz: d47e3a5f91c608f5c5ad49a649bc9aabf9fd29a243ce0efffa89610a2ba1ad37c68ea026cefbf0b42a1fd0574887af20a50820bd357a0c85f5bd8fe5670ea0a9
-  data.tar.gz: f4a9e5f2c31ef671a50618eb0236d15f59861cf39c2659c980dc34e2e7123f4a84eff5c7c4602220ef0da16ca82eb4541050ffbdeadde0b623601e147b848469
+  metadata.gz: 24362a9745841f0f85b255309412ee32a815ff8da790f5028c74285381908203ed11fc1231b4f1eca5185fce2f3d3d8d7aeeffbe428c0f927aabc5b68a661cf8
+  data.tar.gz: 90f64cc3d08170211a819d379162f029874010cf7a660d21b21f8fb6113be8dbccadb6b77f9231704328c5c149b24aa115b4f9bf6000731e3a88903b0506b158

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.0

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+Winston
+===============
+
+http://github.com/dmnelson/winston
+
+CHANGELOG
+---------
+
+### 0.0.2
+* Added NotInList constraint.
+* Added Sudoku example spec.
+* Added 'allow_nil' option for constraints, so not all variables are necessarily required.
+* Changed AllDifferent constraint to be restricted to given variables when not global

data/README.md

@@ -5,6 +5,8 @@ It provides a useful way to solve problems like resource allocation or planning
 
 The most common example of usage for CSPs is probably the game [Sudoku](http://en.wikipedia.org/wiki/Sudoku).
 
+[![Gem Version](https://badge.fury.io/rb/winston.svg)](http://badge.fury.io/rb/winston) [![Build Status](https://travis-ci.org/dmnelson/winston.svg)](https://travis-ci.org/dmnelson/winston) [![Code Climate](https://codeclimate.com/github/dmnelson/winston/badges/gpa.svg)](https://codeclimate.com/github/dmnelson/winston)
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/Rakefile

@@ -1 +1,7 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+task :default do
+  RSpec::Core::RakeTask.new(:spec)
+  Rake::Task["spec"].execute
+end

data/lib/winston.rb

@@ -5,3 +5,4 @@ require 'winston/backtrack'
 require 'winston/csp'
 
 require 'winston/constraints/all_different'
+require 'winston/constraints/not_in_list'

data/lib/winston/backtrack.rb

@@ -34,7 +34,7 @@ module Winston
     end
 
     def domain_values(var)
-      csp.variables[var.name].domain.values
+      csp.domain_for(var.name)
     end
   end
 end

data/lib/winston/constraint.rb

@@ -1,19 +1,32 @@
 module Winston
   class Constraint
 
-    def initialize(variables = nil, predicate = nil)
-      @variables = variables || []
+    attr_reader :variables, :predicate, :allow_nil, :global
+
+    def initialize(variables: nil, predicate: nil, allow_nil: false)
+      @variables = [variables].flatten.compact
       @predicate = predicate
+      @allow_nil = allow_nil
       @global = @variables.empty?
     end
 
     def elegible_for?(changed_var, assignments)
-      @global || (@variables.include?(changed_var) && @variables.all? { |v| assignments.key? v })
+      global || (variables.include?(changed_var) && has_required_values?(assignments))
     end
 
     def validate(assignments)
-      return false unless @predicate
-      @predicate.call(*assignments.values_at(*@variables), assignments)
+      return false unless predicate
+      predicate.call(*values_at(assignments), assignments)
+    end
+
+    protected
+
+    def values_at(assignments)
+      assignments.values_at(*variables)
+    end
+
+    def has_required_values?(assignments)
+      allow_nil || variables.all? { |v| assignments.key?(v) }
     end
   end
 end

data/lib/winston/constraints/all_different.rb

@@ -2,7 +2,8 @@ module Winston
   module Constraints
     class AllDifferent < Winston::Constraint
       def validate(assignments)
-        assignments.values.uniq.size == assignments.size
+        values = global ? assignments.values : values_at(assignments).compact
+        values.uniq.size == values.size
       end
     end
   end

data/lib/winston/constraints/not_in_list.rb

@@ -0,0 +1,18 @@
+module Winston
+  module Constraints
+    class NotInList < Winston::Constraint
+
+      attr_reader :list
+
+      def initialize(variables: nil, allow_nil: false, list: [])
+        super(variables: variables, allow_nil: allow_nil)
+        @list = list
+      end
+
+      def validate(assignments)
+        values = global ? assignments.values : values_at(assignments)
+        !values.any? { |v| list.include?(v) }
+      end
+    end
+  end
+end

data/lib/winston/csp.rb

@@ -17,8 +17,8 @@ module Winston
       variables[name] = Variable.new(name, value: value, domain: domain)
     end
 
-    def add_constraint(*variables, constraint: nil, &block)
-      constraint ||= Constraint.new(variables, block)
+    def add_constraint(*variables, constraint: nil, allow_nil: false, &block)
+      constraint ||= Constraint.new(variables: variables, allow_nil: allow_nil, predicate: block)
       constraints << constraint
     end
 
@@ -29,6 +29,13 @@ module Winston
       true
     end
 
+    def domain_for(variable_name)
+      variable = variables[variable_name]
+      return [] if variable.nil? || variable.domain.nil?
+
+      variable.domain.values
+    end
+
     private
 
     def var_assignments

data/spec/examples/sudoku_spec.rb

@@ -0,0 +1,120 @@
+require "winston"
+
+describe "Sudoku Example" do
+  let(:csp) { Winston::CSP.new }
+
+  describe "Unique values for every row, column and quadrant" do
+    before do
+      domain = [1, 2, 3, 4, 5, 6, 7, 8, 9]
+
+      # Adding variables
+      1.upto(9).each do |x|
+        1.upto(9).each do |j|
+          csp.add_variable({ x: x, y: j }, domain: domain)
+        end
+      end
+
+      variables = csp.variables.keys
+
+      # add columns and rows constraints
+      1.upto(9).each do |i|
+        column = variables.select { |name| name[:x] == i }
+        row = variables.select { |name| name[:y] == i }
+
+        csp.add_constraint constraint: Winston::Constraints::AllDifferent.new(variables: row, allow_nil: true)
+        csp.add_constraint constraint: Winston::Constraints::AllDifferent.new(variables: column, allow_nil: true)
+      end
+
+      # blocks
+      variables.each_slice(3).group_by { |i| (i[0][:y] -1)  % 9 }.values.flatten.each_slice(9).each do |vars|
+        csp.add_constraint constraint: Winston::Constraints::AllDifferent.new(variables: vars, allow_nil: true)
+      end
+    end
+
+    it "should return a valid solution" do
+      expect(csp.solve).to eq({
+        {:x=>1, :y=>1}=>1,
+        {:x=>1, :y=>2}=>2,
+        {:x=>1, :y=>3}=>3,
+        {:x=>1, :y=>4}=>4,
+        {:x=>1, :y=>5}=>5,
+        {:x=>1, :y=>6}=>6,
+        {:x=>1, :y=>7}=>7,
+        {:x=>1, :y=>8}=>8,
+        {:x=>1, :y=>9}=>9,
+        {:x=>2, :y=>1}=>4,
+        {:x=>2, :y=>2}=>5,
+        {:x=>2, :y=>3}=>6,
+        {:x=>2, :y=>4}=>7,
+        {:x=>2, :y=>5}=>8,
+        {:x=>2, :y=>6}=>9,
+        {:x=>2, :y=>7}=>1,
+        {:x=>2, :y=>8}=>2,
+        {:x=>2, :y=>9}=>3,
+        {:x=>3, :y=>1}=>7,
+        {:x=>3, :y=>2}=>8,
+        {:x=>3, :y=>3}=>9,
+        {:x=>3, :y=>4}=>1,
+        {:x=>3, :y=>5}=>2,
+        {:x=>3, :y=>6}=>3,
+        {:x=>3, :y=>7}=>4,
+        {:x=>3, :y=>8}=>5,
+        {:x=>3, :y=>9}=>6,
+        {:x=>4, :y=>1}=>2,
+        {:x=>4, :y=>2}=>1,
+        {:x=>4, :y=>3}=>4,
+        {:x=>4, :y=>4}=>3,
+        {:x=>4, :y=>5}=>6,
+        {:x=>4, :y=>6}=>5,
+        {:x=>4, :y=>7}=>8,
+        {:x=>4, :y=>8}=>9,
+        {:x=>4, :y=>9}=>7,
+        {:x=>5, :y=>1}=>3,
+        {:x=>5, :y=>2}=>6,
+        {:x=>5, :y=>3}=>5,
+        {:x=>5, :y=>4}=>8,
+        {:x=>5, :y=>5}=>9,
+        {:x=>5, :y=>6}=>7,
+        {:x=>5, :y=>7}=>2,
+        {:x=>5, :y=>8}=>1,
+        {:x=>5, :y=>9}=>4,
+        {:x=>6, :y=>1}=>8,
+        {:x=>6, :y=>2}=>9,
+        {:x=>6, :y=>3}=>7,
+        {:x=>6, :y=>4}=>2,
+        {:x=>6, :y=>5}=>1,
+        {:x=>6, :y=>6}=>4,
+        {:x=>6, :y=>7}=>3,
+        {:x=>6, :y=>8}=>6,
+        {:x=>6, :y=>9}=>5,
+        {:x=>7, :y=>1}=>5,
+        {:x=>7, :y=>2}=>3,
+        {:x=>7, :y=>3}=>1,
+        {:x=>7, :y=>4}=>6,
+        {:x=>7, :y=>5}=>4,
+        {:x=>7, :y=>6}=>2,
+        {:x=>7, :y=>7}=>9,
+        {:x=>7, :y=>8}=>7,
+        {:x=>7, :y=>9}=>8,
+        {:x=>8, :y=>1}=>6,
+        {:x=>8, :y=>2}=>4,
+        {:x=>8, :y=>3}=>2,
+        {:x=>8, :y=>4}=>9,
+        {:x=>8, :y=>5}=>7,
+        {:x=>8, :y=>6}=>8,
+        {:x=>8, :y=>7}=>5,
+        {:x=>8, :y=>8}=>3,
+        {:x=>8, :y=>9}=>1,
+        {:x=>9, :y=>1}=>9,
+        {:x=>9, :y=>2}=>7,
+        {:x=>9, :y=>3}=>8,
+        {:x=>9, :y=>4}=>5,
+        {:x=>9, :y=>5}=>3,
+        {:x=>9, :y=>6}=>1,
+        {:x=>9, :y=>7}=>6,
+        {:x=>9, :y=>8}=>4,
+        {:x=>9, :y=>9}=>2
+      })
+    end
+  end
+end

data/spec/winston/constraint_spec.rb

@@ -4,7 +4,8 @@ describe Winston::Constraint do
 
   let(:variables) { nil }
   let(:predicate) { nil }
-  subject { described_class.new(variables, predicate) }
+  let(:allow_nil) { false }
+  subject { described_class.new(variables: variables, predicate: predicate, allow_nil: allow_nil) }
 
   describe "#elegible_for?" do
     context "global" do
@@ -49,6 +50,50 @@ describe Winston::Constraint do
         expect(subject.elegible_for?(:a, { b: 2 })).to be(false)
       end
     end
+
+    context "allowing nil" do
+      let(:allow_nil) { true }
+
+      context "for specific variable" do
+        let(:variables) { [:a] }
+
+        it "should return true when that variable is changed" do
+          expect(subject.elegible_for?(:a, { a: nil })).to be(true)
+        end
+
+        it "should return false when that variable isn't the one changed" do
+          expect(subject.elegible_for?(:b, { a: 1, b: 2 })).to be(false)
+        end
+
+        it "should return true when that variable is changed but doesn't have a value" do
+          expect(subject.elegible_for?(:a, { b: 2 })).to be(true)
+        end
+      end
+
+      context "for multiple variables" do
+        let(:variables) { [:a, :b] }
+
+        it "should return true when one of those variables is changed" do
+          expect(subject.elegible_for?(:a, { a: 1, b: nil })).to be(true)
+        end
+
+        it "should return false when one of those variables isn't the one changed" do
+          expect(subject.elegible_for?(:c, { a: 1, b: 2 })).to be(false)
+        end
+
+        it "should return true when one of those variables is changed but doesn't have a value for every one of them" do
+          expect(subject.elegible_for?(:b, { b: 2 })).to be(true)
+        end
+
+        it "should return true when one of those variables is changed but doesn't have a value for every one of them" do
+          expect(subject.elegible_for?(:a, { b: 2 })).to be(true)
+        end
+
+        it "should return true when one of those variables is changed but doesn't have a value for any of them" do
+          expect(subject.elegible_for?(:a, {})).to be(true)
+        end
+      end
+    end
   end
 
   describe "#validate" do

data/spec/winston/constraints/all_different_spec.rb

@@ -3,13 +3,6 @@ require "winston"
 describe Winston::Constraints::AllDifferent do
   subject { described_class.new }
 
-  describe "#elegible_for?" do
-    it "should be elegible for everything" do
-      expect(subject.elegible_for?(:a, {})).to be(true)
-      expect(subject.elegible_for?(:b, { a: 1 })).to be(true)
-    end
-  end
-
   describe "#validate" do
     it "should return 'true' when all values are unique" do
       expect(subject.validate(a: 1, b: 2, c: 3, d: 4)).to be(true)
@@ -18,5 +11,17 @@ describe Winston::Constraints::AllDifferent do
     it "should return 'false' when not all values are unique" do
       expect(subject.validate(a: 1, b: 2, c: 2, d: 4)).to be(false)
     end
+
+    context "for specific variables" do
+      subject { described_class.new(variables: [:a, :b, :c]) }
+
+      it "should return 'true' when all values are unique" do
+        expect(subject.validate(a: 1, b: 2, c: 3, d: 3)).to be(true)
+      end
+
+      it "should return 'false' when not all values are unique" do
+        expect(subject.validate(a: 1, b: 2, c: 2, d: 4)).to be(false)
+      end
+    end
   end
 end

data/spec/winston/constraints/not_in_list_spec.rb

@@ -0,0 +1,35 @@
+require "winston"
+
+describe Winston::Constraints::NotInList do
+  subject { described_class.new(list: [ 4, 5, 6 ]) }
+
+  describe "#validate" do
+    it "should return 'true' none of the values are on the list" do
+      expect(subject.validate(a: 1, b: 2, c: 3, d: 3)).to be(true)
+    end
+
+    it "should return 'false' when any of the values are on the list" do
+      expect(subject.validate(a: 1, b: 2, c: 2, d: 4)).to be(false)
+    end
+
+    it "should return 'false' when all the values are on the list" do
+      expect(subject.validate(a: 4, b: 6, c: 5, d: 4)).to be(false)
+    end
+
+    context "for specific variables" do
+      subject { described_class.new(variables: [:a, :b, :c], list: [ 4, 5, 6 ]) }
+
+      it "should return 'true' when none of the values are on the list" do
+        expect(subject.validate(a: 1, b: 2, c: 3, d: 6)).to be(true)
+      end
+
+      it "should return 'false' when any of the values are on the list" do
+        expect(subject.validate(a: 1, b: 2, c: 5, d: 3)).to be(false)
+      end
+
+      it "should return 'false' when all the values are on the list" do
+        expect(subject.validate(a: 4, b: 6, c: 5, d: 3)).to be(false)
+      end
+    end
+  end
+end

data/spec/winston/csp_spec.rb

@@ -28,7 +28,7 @@ describe Winston::CSP do
   describe "#add_constraint" do
     let(:constraint) { double("Constraint") }
     it "should build a constraint for the given block" do
-      expect(Winston::Constraint).to receive(:new).with([:a, :b], an_instance_of(Proc)).once.and_return(constraint)
+      expect(Winston::Constraint).to receive(:new).with(variables: [:a, :b], allow_nil: false, predicate: an_instance_of(Proc)).once.and_return(constraint)
       subject.add_constraint(:a, :b) { true }
       expect(subject.constraints).to include(constraint)
     end
@@ -60,6 +60,25 @@ describe Winston::CSP do
     end
   end
 
+  describe "#domain_for" do
+    before do
+      subject.add_variable :a, value: 1
+      subject.add_variable :b, domain: [1, 2]
+    end
+
+    it "returns domain values for a given variable" do
+      expect(subject.domain_for(:b)).to eq([1, 2])
+    end
+
+    it "returns an empty list when a variable doesn't exist in the problem" do
+      expect(subject.domain_for(:c)).to be_empty
+    end
+
+    it "return an empty list when a variable doesn't have a domain" do
+      expect(subject.domain_for(:a)).to be_empty
+    end
+  end
+
   describe "#solve" do
     let(:solver) { double("Solver") }
     before do

data/winston.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name        = 'winston'
-  gem.version     = '0.0.1'
+  gem.version     = '0.0.2'
   gem.authors     = ['David Michael Nelson']
   gem.homepage    = 'http://github.com/dmnelson/winston'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: winston
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - David Michael Nelson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-02 00:00:00.000000000 Z
+date: 2015-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -59,6 +59,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -67,13 +69,16 @@ files:
 - lib/winston/backtrack.rb
 - lib/winston/constraint.rb
 - lib/winston/constraints/all_different.rb
+- lib/winston/constraints/not_in_list.rb
 - lib/winston/csp.rb
 - lib/winston/domain.rb
 - lib/winston/variable.rb
 - spec/examples/numbers_spec.rb
+- spec/examples/sudoku_spec.rb
 - spec/winston/backtrack_spec.rb
 - spec/winston/constraint_spec.rb
 - spec/winston/constraints/all_different_spec.rb
+- spec/winston/constraints/not_in_list_spec.rb
 - spec/winston/csp_spec.rb
 - spec/winston/domain_spec.rb
 - spec/winston/variable_spec.rb
@@ -104,9 +109,11 @@ specification_version: 4
 summary: Constraint Satisfaction Problem (CSP) implementation for Ruby
 test_files:
 - spec/examples/numbers_spec.rb
+- spec/examples/sudoku_spec.rb
 - spec/winston/backtrack_spec.rb
 - spec/winston/constraint_spec.rb
 - spec/winston/constraints/all_different_spec.rb
+- spec/winston/constraints/not_in_list_spec.rb
 - spec/winston/csp_spec.rb
 - spec/winston/domain_spec.rb
 - spec/winston/variable_spec.rb