set_builder 2.0.0.beta1 → 2.0.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 33054edba058a15627aaf11cbdd32f2a3bdb5c7e
-  data.tar.gz: 2ab79d3204faa01c6acd43515f453d8c3a883990
+  metadata.gz: ae95d6f2f3cfb324b760144d8cab1e61fc4b41b5
+  data.tar.gz: a5f02d71b73862a3251ff48b167a07d3cf1a8b14
 SHA512:
-  metadata.gz: f5af7ed922c28414483e4cf8c14704a94d527733a27ce8d07b95a3c687df7533594661c0d1099085d6326308602dd619dae2a143c09960aa69bdebdc41417b7e
-  data.tar.gz: 47f857f3f679dec0cb5f0c701bd45a890a8cdd968d9eb8a544d76c8e866bc8ddfb9c2747c7437b7dba845dd17c32ebed93f9f0ff759b8e0324564f00d16e4b45
+  metadata.gz: f61aa92460102dd67880c0bc3d670f0c5ae5938ab0f83b2bf4f074597ececa1cf6933f9fcf15217d8e06d4913bd4b83192683fd5205d5b57c34aedacacca1932
+  data.tar.gz: 2803e8640beddb5fb8bbc880a2187af33da4534b98577df9dcde5ef29c7df432b45b886d1f654468d85adb925bb8f7ca5e483051275505ffa9dd385f49585e23

data/lib/assets/javascripts/set_builder.js

@@ -135,7 +135,7 @@ SetBuilder.Constraint = function(_trait, args) {
         case 'direct_object_type':
           return SetBuilder.getValue(text, _direct_object);
         case 'modifier':
-          return _modifiers[i++].toString();
+          return _modifiers[i++].toString().replace('_', ' ');
         default:
           if(console && console.log) console.log('[SetBuilder.Constraint] unknown type: "' + type + '" (text: "' + text + '")');
           return false;
@@ -273,11 +273,14 @@ SetBuilder.Modifiers = function(_modifiers) {
 
 SetBuilder.Set = function(_raw_data) {
   if(!_raw_data) _raw_data = [];
+  if(_raw_data.constructor !== Array) _raw_data = convertObjectSetToArray(_raw_data);
   
   var _constraints = [];
+  
   _raw_data.__each(function(line) {
     var trait_name = line[0];
     var negative = false;
+  
     if(trait_name[0] == '!') {
       negative = true;
       trait_name = trait_name.slice(1);
@@ -290,8 +293,27 @@ SetBuilder.Set = function(_raw_data) {
       window.console.log('trait not found with name "' + line[0] + '"');
     }
   });
-  
-  
+   
+  function convertObjectSetToArray(data) {
+    var set = [];
+    
+    Object.keys(data).__each(function(key) {
+      var convertedTrait = [];
+      var trait = data[key];
+      convertedTrait.push(trait.negative ? "!" + trait.trait : trait.trait)
+      if(trait.direct_object) convertedTrait.push(trait.direct_object);
+      if(trait.modifiers) {
+        Object.keys(trait.modifiers).__each(function(key) {
+          var modifier = trait.modifiers[key];
+          var convertedModifier = {};
+          convertedModifier[modifier.operator] = modifier.values ? Object.values(modifier.values) : [];
+          convertedTrait.push(convertedModifier);
+        });
+      }
+      set.push(convertedTrait);
+    });
+    return set;
+  }
   
   // Public methods
   
@@ -309,6 +331,10 @@ SetBuilder.Set = function(_raw_data) {
     return this.constraints().toSentence();
   }
   
+  this.isEqualTo = function(other) {
+    return this.toString() == other.toString();
+  }
+  
 };
 
 
@@ -430,6 +456,16 @@ if(!Object.keys) {
   }
 }
 
+if(!Object.values) {
+  Object.values = function(o) {
+    var values = [];
+    Object.keys(o).__each(function(key) {
+      values.push(o[key]);
+    });
+    return values;
+  }
+}
+
 
 
 //

data/lib/set_builder.rb

@@ -8,31 +8,4 @@ require 'set_builder/engine'
 
 
 module SetBuilder
-    
-  def self.extended(base)
-    base.instance_variable_set("@traits", SetBuilder::Traits.new)
-    base.send(:include, SetBuilder::Modifiers)
-  end
-  
-  
-  attr_reader :traits
-  
-  def modifiers
-    traits.modifiers
-  end
-  
-  def that_belong_to(set)
-    SetBuilder::Set.new(self, to_scope, set)
-  end
-  
-  def to_scope
-    scoped
-  end
-
-protected
-
-  def trait(trait_expression, &block)
-    traits << Trait.new(trait_expression, &block)
-  end
-  
 end

data/lib/set_builder/set.rb

@@ -1,71 +1,71 @@
 module SetBuilder
   class Set
-    
-    
-    
-    def initialize(model, scope, raw_data)
-      @model = model
+
+
+
+    def initialize(traits, scope, raw_data)
+      @traits = traits
       @scope = scope
       @set = raw_data
     end
-    
-    
-    
-    attr_reader :model, :scope
-    
-    
-    
+
+
+
+    attr_reader :traits, :scope
+
+
+
     def constraints
       @constraints ||= get_constraints
     end
-    
-    
-    
+
+
+
     #
     # Returns true if all of the constraints in this set are valid
     #
     def valid?
       constraints.all?(&:valid?)
     end
-    
-    
-    
+
+
+
     #
     # Describes this set in natural language
     #
     def to_s
       constraints.to_sentence
     end
-    
-    
-    
+
+
+
     #
     # Returns an instance of ActiveRecord::NamedScope::Scope
     # which can fetch the objects which belong to this set
-    #    
+    #
     def perform
       constraints.inject(scope) { |scope, constraint| constraint.perform(scope) }
     end
-    
-    
-    
+
+
+
   private
-    
-    
-    
+
+
+
     attr_reader :set
-    
+
     def get_constraints
       set.inject([]) do |constraints, line|
         negate, trait_name, args = false, line.first.to_s, line[1..-1]
         trait_name, negate = trait_name[1..-1], true if (trait_name[0..0] == "!")
-        trait = model.traits[trait_name]
-        raise("\"#{trait_name}\" is not a trait for #{model}") unless trait
+        trait = traits[trait_name]
+        raise("\"#{trait_name}\" is not a trait in `traits`") unless trait
         constraints << trait.apply(*args).negate(negate)
       end
     end
-    
-    
-    
+
+
+
   end
 end

data/lib/set_builder/trait_builder.rb

@@ -0,0 +1,14 @@
+module SetBuilder
+  class TraitBuilder
+    attr_reader :traits
+
+    def initialize(traits)
+      @traits = traits
+    end
+
+    def trait(trait_expression, &block)
+      traits << Trait.new(trait_expression, &block)
+    end
+
+  end
+end

data/lib/set_builder/traits.rb

@@ -1,12 +1,28 @@
 require 'set_builder/trait'
+require 'set_builder/trait_builder'
 require 'set_builder/modifier_collection'
+require 'delegate'
 
 
 module SetBuilder
-  class Traits < Array
-    
-    
-    
+  class Traits < SimpleDelegator
+
+
+
+    def initialize(array=[], &block)
+      super array
+
+      if block_given?
+        if block.arity.zero?
+          TraitBuilder.new(self).instance_eval(&block)
+        else
+          yield TraitBuilder.new(self)
+        end
+      end
+    end
+
+
+
     def [](index)
       case index
       when Symbol, String
@@ -16,15 +32,27 @@ module SetBuilder
         super
       end
     end
-    
-    
-    
+
+
+
     def to_json
       "[#{collect(&:to_json).join(",")}]"
     end
-    
-    
-    
+
+
+
+    def +(other_traits)
+      return super unless other_traits.is_a?(self.class)
+      self.class.new(self.__getobj__ + other_traits.__getobj__)
+    end
+
+    def concat(other_traits)
+      return super unless other_traits.is_a?(self.class)
+      self.class.new(self.__getobj__.concat other_traits.__getobj__)
+    end
+
+
+
     def modifiers
       # !nb: not sure why inject was failing but it was modifying trait.modifiers!
       @modifiers = ModifierCollection.new
@@ -35,8 +63,8 @@ module SetBuilder
       end
       @modifiers
     end
-    
-    
-    
+
+
+
   end
-end
+end

data/lib/set_builder/value_map.rb

@@ -26,7 +26,7 @@ module SetBuilder
       end 
       
       name = name.to_sym
-      map = @registered_value_maps[name]     
+      map = @registered_value_maps[name]
       if map
         pair = map.find { |pair| pair[0] == value || pair[0] == value.to_s }
         pair ? pair[1].to_s : "(unknown)"
@@ -59,6 +59,10 @@ module SetBuilder
     
     
     
+    def self.as_json(options={})
+      @registered_value_maps.dup
+    end
+    
     def self.to_json
       @registered_value_maps.to_json
     end

data/lib/set_builder/version.rb

@@ -1,3 +1,3 @@
 module SetBuilder
-  VERSION = "2.0.0.beta1"
+  VERSION = "2.0.0.beta2"
 end

data/set_builder.gemspec

@@ -24,4 +24,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "jspec"
   spec.add_development_dependency "pry"
+  spec.add_development_dependency "minitest-reporters"
 end

data/spec/unit/set_builder.spec.js

@@ -40,6 +40,30 @@ describe 'SetBuilder'
       ['died'],
       ['name', {'is': "Jerome"}]
     ];
+    
+    set_data_hash = {
+      '0': {
+        trait: 'awesome'
+      },
+      '1': {
+        trait: 'attended',
+        direct_object: 2
+      },
+      '2': {
+        trait: 'died'
+      },
+      '3': {
+        trait: 'name',
+        modifiers: {
+          '0': {
+            operator: 'is',
+            values: {
+              '0': 'Jerome'
+            }
+          }
+        }
+      }
+    };
   end
   
   
@@ -145,6 +169,18 @@ describe 'SetBuilder'
         var set = new SetBuilder.Set(set_data);
         expect(set.constraints().length).to(be, 4);
       end
+        
+      it 'should parse hash-style objects as well as arrays'
+        var set = new SetBuilder.Set(set_data_hash);
+        expect(set.constraints().length).to(be, 4);
+      end
+        
+      it 'should consider two sets with identical constraints equal'
+        var set1 = new SetBuilder.Set(set_data);
+        var set2 = new SetBuilder.Set(set_data_hash);
+        expect(set1.isEqualTo(set2)).to(be, true);
+        expect(set2.isEqualTo(set1)).to(be, true);
+      end
     end
   
     describe '.toString'

data/test/modifier_test.rb

@@ -7,7 +7,7 @@ class ModifierTest < ActiveSupport::TestCase
   test "get type with string" do
     assert_equal StringPreposition, SetBuilder::Modifier["StringPreposition"]
   end
-  
+
   test "get type with symbol" do
     assert_equal StringPreposition, SetBuilder::Modifier[:string]
   end
@@ -21,13 +21,13 @@ class ModifierTest < ActiveSupport::TestCase
       SetBuilder::Modifier.for(:hash)
     end
   end
-  
+
   test "registering an invalid modifier" do
     assert_raises ArgumentError do
       SetBuilder::Modifier.register(:hash, InvalidHashModifier)
     end
   end
-  
+
   test "converting modifier to json" do
     expected_results = {
       "contains"            => ["string"],
@@ -71,7 +71,7 @@ class ModifierTest < ActiveSupport::TestCase
         "is_not"              => ["string"]
       }
     }
-    assert_equal expected_results, Friend.modifiers.to_hash
+    assert_equal expected_results, $friend_traits.modifiers.to_hash
   end
 
 
@@ -82,9 +82,9 @@ class InvalidHashModifier
 end
 
 class HashModifier < SetBuilder::Modifier::Verb
-  
+
   def self.operators
     [:has_key]
   end
-  
+
 end

data/test/set_test.rb

@@ -1,75 +1,66 @@
 require 'test_helper'
 
 class SetTest < ActiveSupport::TestCase
-  
-  
-  
+
+
+
   test "set data struture" do
-    data = [
+    set = to_set [
       [:awesome],
       [:attended, 2],
       [:died],
       [:name, {:is => "Jerome"}]]
-    set = Friend.that_belong_to(data)
     assert set.valid?
     assert_equal "who are awesome, who have attended McKendree, who died, and whose name is Jerome", set.to_s
   end
 
   test "sets with invalid modifiers should be invalid" do
-    data = [[:born, {:after => ["wrong"]}]]
-    set = Friend.that_belong_to(data)
+    set = to_set [[:born, {:after => ["wrong"]}]]
     assert_equal false, set.valid?
   end
 
   test "sets should not allow non-numbers in a number modifiers" do
-    data = [[:age, {:is => ["12a"]}]]
-    set = Friend.that_belong_to(data)
+    set = to_set [[:age, {:is => ["12a"]}]]
     refute set.valid?
   end
 
   test "sets should not allow empty string in a number modifiers" do
-    data = [[:age, {:is => [""]}]]
-    set = Friend.that_belong_to(data)
+    set = to_set [[:age, {:is => [""]}]]
     refute set.valid?
   end
-  
+
   test "sets lacking expected modifiers should be invalid" do
-    data = [[:born, {:ever => []}]]
-    set = Friend.that_belong_to(data)
+    set = to_set [[:born, {:ever => []}]]
     assert_equal true, set.valid?
-    
-    data = [[:born]]
-    set = Friend.that_belong_to(data)
+
+    set = to_set [[:born]]
     assert_equal false, set.valid?
-  end  
-  
+  end
+
   test "set structure with negations (nouns are ignored)" do
-    data = [
+    set = to_set [
       ["!awesome"],
       ["!attended", 2],
       ["!died"],
       ["!name", {:is => "Jerome"}]]
-    set = Friend.that_belong_to(data)
     assert set.valid?
     assert_equal "who are not awesome, who have not attended McKendree, who have not died, and whose name is Jerome", set.to_s
   end
-  
+
   test "simple perform" do
-    data = [[:awesome]]
-    set = Friend.that_belong_to(data)
-    
+    set = to_set [[:awesome]]
+
     expected_results = [{:conditions => {:awesome => true}}]
     assert_equal expected_results, set.perform
   end
-  
+
   test "complex perform" do
-    data = [
+    set = to_set [
       [:awesome],
       [:attended, 1],
       [:died],
       [:name, {:begins_with => "Jerome"}]]
-    set = Friend.that_belong_to(data)
-    
+
     expected_results = [
       {:conditions => {:awesome => true}},
       {:joins => "INNER JOIN schools ON friends.school_id=schools.id", :conditions => {"schools.id" => 1}},
@@ -78,13 +69,19 @@ class SetTest < ActiveSupport::TestCase
     ]
     assert_equal expected_results, set.perform
   end
-  
+
   test "invalid set" do
-    data = [[:name, {:starts_with => "Jerome"}]]  # starts_with is not a valid operator
-    set = Friend.that_belong_to(data)
-    
+    set = to_set [[:name, {:starts_with => "Jerome"}]]  # starts_with is not a valid operator
+
     # !todo: what to do?
+    skip "TODO: test invalid sets"
   end
 
 
+private
+
+  def to_set(data)
+    SetBuilder::Set.new($friend_traits, Friend.all, data)
+  end
+
 end

data/test/test_helper.rb

@@ -6,14 +6,14 @@ require "set_builder"
 require "pry"
 require "support/fake_connection"
 
-
+require "minitest/reporters"
+Minitest::Reporters.use! Minitest::Reporters::SpecReporter.new
 
 # Sample class used by tests
 
 SetBuilder::ValueMap.register(:school, [[1, "Concordia"], [2, "McKendree"]])
 
-class Friend
-  extend SetBuilder
+$friend_traits = SetBuilder::Traits.new do
 
   trait('who are [not] "awesome"') do |query, scope|
     scope << {:conditions => {:awesome => true}}
@@ -41,28 +41,29 @@ class Friend
   trait('whose "name" <string>') do |query, scope|
     scope << {:conditions => query.modifiers[0].build_conditions_for("friends.name")}
   end
-  
-  # by stubbing out scoped, we can unit test the `performed` features
-  def self.to_scope
+end
+
+
+class Friend
+
+  # by stubbing out `all`, we can unit test `Set#perform`
+  def self.all
     []
   end
-  
-  
-  
+
+
   # Stubs so that Arel can SQL
-  
+
   attr_accessor :connection_pool
-  
+
   def initialize
     @connection_pool = Fake::ConnectionPool.new
   end
-  
+
   def connection
     connection_pool.connection
   end
-  
-  
-  
+
 end
 
 Arel::Table.engine = Arel::Sql::Engine.new(Friend.new)

data/test/trait_test.rb

@@ -5,16 +5,16 @@ class TraitTest < ActiveSupport::TestCase
 
 
   test "constraints find correct modifiers" do
-    trait = Friend.traits[:name]
+    trait = $friend_traits[:name]
     assert_equal 1, trait.modifiers.length
 
     constraint = trait.apply({:is => "Jerome"})
     assert_equal 1, constraint.modifiers.length
     assert_kind_of StringPreposition, constraint.modifiers.first
   end
-  
+
   test "modifiers should find correct values" do
-    trait = Friend.traits[:name]
+    trait = $friend_traits[:name]
     modifier = trait.apply({:is => "Jerome"}).modifiers.first
     assert_equal :is, modifier.operator
     assert_equal ["Jerome"], modifier.values
@@ -29,18 +29,12 @@ class TraitTest < ActiveSupport::TestCase
       :name => false
     }
     trait_requires_direct_object.each do |trait, expected_value|
-      assert_equal expected_value, Friend.traits[trait].requires_direct_object?
+      assert_equal expected_value, $friend_traits[trait].requires_direct_object?
     end
   end
 
-  # test "traits whose direct objects support value mapping should be able to enumerate their values" do
-  #   trait = Friend.traits[:attended]
-  #   expected_map = {1 => "Concordia", 2 => "McKendree"}
-  #   actual_map = trait.
-  # end
-  
   test "constraint should be valid" do
-    trait = Friend.traits[:name]
+    trait = $friend_traits[:name]
     constraint = trait.apply({:is => "Jerome"})
     assert constraint.valid?
   end

data/test/traits_test.rb

@@ -6,27 +6,55 @@ class TraitsTest < ActiveSupport::TestCase
 
   test "traits" do
     expected_traits = %w{age attended awesome born died name}
-    assert_equal expected_traits, Friend.traits.collect(&:name).sort
+    assert_equal expected_traits, $friend_traits.collect(&:name).sort
   end
-  
+
   test "traits' accessor" do
-    traits = Friend.traits
+    traits = $friend_traits
     assert_kind_of SetBuilder::Traits, traits
     assert_equal "awesome", traits[0].name, "Array getter should still work like normal"
     assert_kind_of SetBuilder::Trait, traits[:born], "If you pass a string or symbol Traits should lookup a trait by name"
   end
-  
+
   test "trait method is protected" do
     assert_raises NoMethodError, "this method is for use within class definition" do
       Friend.trait
     end
   end
-  
+
   test "collection of modifiers" do
     expected_modifiers = %w{DatePreposition NumberPreposition StringPreposition}.collect {|name| "SetBuilder::Modifiers::#{name}"}
-    assert_equal expected_modifiers, Friend.traits.modifiers.collect(&:name).sort
+    assert_equal expected_modifiers, $friend_traits.modifiers.collect(&:name).sort
+  end
+
+  test "two collections of traits can be concatenated with `+`" do
+    traits1 = SetBuilder::Traits.new do
+      trait('who are [not] "awesome"') { |query, scope| }
+    end
+
+    traits2 = SetBuilder::Traits.new do
+      trait('who are [not] "living"') { |query, scope| }
+    end
+
+    combined_traits = traits1 + traits2
+    assert_kind_of SetBuilder::Traits, combined_traits
+    assert_equal %w{awesome living}, combined_traits.map(&:name)
+  end
+
+  test "two collections of traits can be concatenated with `concat`" do
+    traits1 = SetBuilder::Traits.new do
+      trait('who are [not] "awesome"') { |query, scope| }
+    end
+
+    traits2 = SetBuilder::Traits.new do
+      trait('who are [not] "living"') { |query, scope| }
+    end
+
+    combined_traits = traits1.concat traits2
+    assert_kind_of SetBuilder::Traits, combined_traits
+    assert_equal %w{awesome living}, combined_traits.map(&:name)
   end
-  
+
   test "to_json" do
     expected_json = [[["string","who are"],
       ["negative","not"],
@@ -47,7 +75,7 @@ class TraitsTest < ActiveSupport::TestCase
      [["string","whose"],
       ["name","name"],
       ["modifier","string"]]].to_json
-    assert_equal expected_json, Friend.traits.to_json
+    assert_equal expected_json, $friend_traits.to_json
   end
 
 

data/test/value_map_test.rb

@@ -7,20 +7,20 @@ class ValueMapTest < ActiveSupport::TestCase
     expected_map = [[1, "Concordia"], [2, "McKendree"]]
     assert_equal expected_map, SetBuilder::ValueMap.for(:school)
   end
-  
-  
-  test "value map should fetch the correct value" do 
+
+
+  test "value map should fetch the correct value" do
     expected_school = "Concordia"
     assert_equal expected_school, SetBuilder::ValueMap.to_s(:school, 1)
   end
 
 
-  test "value map should fetch the correct value when passed as a string" do 
+  test "value map should fetch the correct value when passed as a string" do
     expected_school = "Concordia"
     assert_equal expected_school, SetBuilder::ValueMap.to_s("school", 1)
   end
-  
-  
+
+
   test "value map should generate json that can be handed to the client-side SetBuilder" do
     expected_json = "{\"school\":[[1,\"Concordia\"],[2,\"McKendree\"]]}"
     assert_equal expected_json, SetBuilder::ValueMap.to_json

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: set_builder
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta1
+  version: 2.0.0.beta2
 platform: ruby
 authors:
 - Bob Lail
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-10 00:00:00.000000000 Z
+date: 2015-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -100,6 +100,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A gem for describing constraints on data sets
 email:
 - bob.lailfamily@gmail.com
@@ -131,6 +145,7 @@ files:
 - lib/set_builder/query_builders/string.rb
 - lib/set_builder/set.rb
 - lib/set_builder/trait.rb
+- lib/set_builder/trait_builder.rb
 - lib/set_builder/traits.rb
 - lib/set_builder/value_map.rb
 - lib/set_builder/version.rb