set_builder 2.0.0.beta2 → 2.0.0.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae95d6f2f3cfb324b760144d8cab1e61fc4b41b5
-  data.tar.gz: a5f02d71b73862a3251ff48b167a07d3cf1a8b14
+  metadata.gz: acd34d467c6aca8cc3c42db795261de035c72c58
+  data.tar.gz: 2c08cc3a703c5cc84230cbaa0e047004d4e7f430
 SHA512:
-  metadata.gz: f61aa92460102dd67880c0bc3d670f0c5ae5938ab0f83b2bf4f074597ececa1cf6933f9fcf15217d8e06d4913bd4b83192683fd5205d5b57c34aedacacca1932
-  data.tar.gz: 2803e8640beddb5fb8bbc880a2187af33da4534b98577df9dcde5ef29c7df432b45b886d1f654468d85adb925bb8f7ca5e483051275505ffa9dd385f49585e23
+  metadata.gz: d79aec9ff59f398bc844de87cbc9a7946fb43166017d1231c36fc8a1ff267a296a98e88e524d3b01b2c726bd91ed75d4e63833246e32cc6fa25114e038809cb1
+  data.tar.gz: d4ba5f0e2dfff5ad5245abd758adcac891c93fe2e0bba30c830e52b7dd63e7749962ed6843dc4f3c4b33b1e7b3a3b33dcb58ceef97312a417cce6abbf8be8962

data/README.md

@@ -15,16 +15,16 @@ SetBuilder is a library for:
 
 The following Set describes a group of people:
 
-     [[:awesome],
-      [:attended, "school"],
-      [:died, :not],
-      [:name, {:is => "Jerome"}]]
+     [{ trait: :awesome, choices: ["are"] },
+      { trait: :attended, choices: ["have"], school: "school" },
+      { trait: :died, choices: ["have not"] },
+      { trait: :name, modifiers: [{ operator: :is, values: ["Jerome"] }] }]
 
 SetBuilder can render this Set in plain English:
 
-    [Everyone] who is awesome, who attended school, who has not died, and whose name is Jerome.
+    [Those] who are awesome, who have attended school, who have not died, and whose name is Jerome.
 
-It can also generate a NamedScope on an ActiveRecord model to fetch the people who fit in this set.
+It can also generate an `ActiveRecord::Relation` on an ActiveRecord model to fetch the people who fit in this set.
 
 
 ### Running the tests

data/Rakefile

@@ -1,5 +1,5 @@
-require 'rake'
-require 'rake/testtask'
+require "rake"
+require "rake/testtask"
 
 desc 'Run tests.'
 task :default => :test

data/init.rb

@@ -1 +1 @@
-require 'set_builder'
+require "set_builder"

data/lib/assets/javascripts/set_builder.js

@@ -1,9 +1,9 @@
 var SetBuilder = (function() {
-  
+
   var _modifiers;
   var _traits;
   var _value_maps = {};
-  
+
   return {
     init: function(traits, modifiers) {
       registerTraits(traits);
@@ -22,7 +22,7 @@ var SetBuilder = (function() {
       for(key in _data) {
         _value_maps[key] = _data[key];
       }
-    },    
+    },
     traits: function() {
       return _traits;
     },
@@ -43,7 +43,7 @@ var SetBuilder = (function() {
           default: return values.slice(0, -1).join(', ') + ', or ' + values[values.length - 1];
         }
       }
-      
+
       var match = value.toString(),
           map = SetBuilder.getValueMap(key);
       if(map) {
@@ -57,7 +57,7 @@ var SetBuilder = (function() {
       return Object.keys(_value_maps);
     }
   }
-  
+
 })();
 
 
@@ -65,64 +65,65 @@ var SetBuilder = (function() {
 /*
       Constraint (c.f. /lib/set_builder/constraint.rb)
       ===========================================================
-      
+
       a constrained trait
 */
 
-SetBuilder.Constraint = function(_trait, args) {
-  
-  var _direct_object;
+SetBuilder.Constraint = function(_trait, params) {
+
   if(typeof(_trait) == 'string') {
     _trait = SetBuilder.traits().__find(_trait);
   }
 
-  args = args.dup();
-  if(_trait.requiresDirectObject()) _direct_object = args.shift();
-  var _modifiers = _trait.modifiers().collect(function(modifier_type) {
-    return SetBuilder.modifiers().apply(modifier_type, args.shift());
-  });
-  var _negative = false;
-  
-  
-  
+  var _enums = params.enums || [];
+  var _direct_object;
+  if(_trait.requiresDirectObject()) {
+    _direct_object = params[_trait.directObjectType()];
+  }
+
+  var _modifiers = [];
+  for(var i=0, ii=_trait.modifiers().length; i<ii; i++) {
+    _modifiers.push(
+      SetBuilder.modifiers().apply(
+        _trait.modifiers()[i],
+        (params.modifiers||[])[i]));
+  }
+
+
+
   // Public methods
-  
+
   this.trait = function(val) {
     if(val !== undefined) {
       _trait = val;
       _direct_object = undefined;
+      _enums = [];
       _modifiers = [];
     }
     return _trait;
   }
-  
+
   this.direct_object = function(val) {
     if(val !== undefined) {
       _direct_object = val;
     }
     return _direct_object;
   }
-  
+
+  this.enums = function() {
+    return _enums;
+  }
+
   this.modifiers = function() {
     return _modifiers;
   }
-  
-  this.negate = function(value) {
-    _negative = value;
-    if(!_trait.hasNegative()) _negative = false;
-    return this;
-  }
-  
-  this.negative = function() {
-    return _negative;
-  }
-  
+
   this.requires_direct_object = function() {
     return _trait.requires_direct_object();
   }
-  
+
   this.toString = function() {
-    var type, text, i = 0;
+    var type, text, enum_index = 0, modifier_index = 0;
     return _trait.tokens().collect(function(token) {
       type = token[0], text = token[1];
       switch(type) {
@@ -130,17 +131,17 @@ SetBuilder.Constraint = function(_trait, args) {
           return text;
         case 'name':
           return _trait.name();
-        case 'negative':
-          return _negative && text;
+        case 'enum':
+          return (_enums[enum_index++] || '').toString();
         case 'direct_object_type':
           return SetBuilder.getValue(text, _direct_object);
         case 'modifier':
-          return _modifiers[i++].toString().replace('_', ' ');
+          return (_modifiers[modifier_index++] || '').toString().replace('_', ' ');
         default:
           if(console && console.log) console.log('[SetBuilder.Constraint] unknown type: "' + type + '" (text: "' + text + '")');
           return false;
       }
-    }).compact().join(' ');
+    }).join('');
   }
 
 };
@@ -155,23 +156,23 @@ SetBuilder.Constraint = function(_trait, args) {
 */
 
 SetBuilder.Modifier = function(_name, _operator, _values, _params) {
-  
-  
-  
+
+
+
   // Public methods
-  
+
   this.name = function() {
     return _name;
   }
-  
+
   this.operator = function() {
     return _operator;
   }
-  
+
   this.values = function() {
     return _values;
   }
-  
+
   this.toString = function() {
     var words = [_operator.replace(/_/, ' ')];
     for(var i=0; i<_values.length; i++) {
@@ -187,7 +188,7 @@ SetBuilder.Modifier = function(_name, _operator, _values, _params) {
 /*
       Modifiers (c.f. /lib/set_builder/modifier.rb)
       ===========================================================
-      
+
       [
         [modifier_name, {
           operator: ['argument 1 type', 'argument 2 type'],
@@ -198,9 +199,9 @@ SetBuilder.Modifier = function(_name, _operator, _values, _params) {
 */
 
 SetBuilder.Modifiers = function(_modifiers) {
-  
+
   var keys = Object.keys(_modifiers);
-  
+
   function _operators_for(name) {
     var operators = _modifiers[name];
     if(operators) {
@@ -209,19 +210,19 @@ SetBuilder.Modifiers = function(_modifiers) {
       throw ('"' + name.toString() + '" is not a registered modifier.');
     }
   }
-  
-  
-  
+
+
+
   // Public methods
   this.length = function() {
     return keys.length;
   }
-  
+
   // Returns the names of the operators allowed for the given modifier
   this.operators_for = function(modifier_type) {
     return Object.keys(_operators_for(modifier_type));
   }
-  
+
   // Returns the names of the arguments a given operator anticipates
   this.params_for_operator = function(modifier_type, operator_name) {
     if(!operator_name) throw 'An operator name was not supplied.'
@@ -232,31 +233,29 @@ SetBuilder.Modifiers = function(_modifiers) {
       throw ('"' + operator_name.toString() + '" is not an operator for the ' + modifier_type + ' modifier.');
     }
   }
-  
+
   // Examples of Usage:
   //
   // An operator that takes one argument:
-  //   apply('date', {'before': ['2012-11-12']})
+  //   apply('date', {operator: 'before', values: ['2012-11-12']})
   //
   // An operator that takes two arguments:
-  //   apply('date', {'in_the_last': [5, 'days']})
-  //
-  //
-  // `args` is expected to be an object that has one key and one value.
+  //   apply('date', {operator: 'in_the_last', values: [5, 'days']})
   //
   this.apply = function(modifier_type, args) {
     args = args || {};
-    var operator = Object.keys(args)[0];
+    var operator = args.operator;
     if(!operator) throw 'An operator name was not supplied.'
-    
+
     var params = this.params_for_operator(modifier_type, operator);
-    var values = (args)[operator];
+    var values = args.values;
 
+    if(!values) values = [];
     if(!(values instanceof Array)) values = [values];
     if(values.length != params.length) {
       throw ('The operator "' + operator.toString() + '" expects ' + params.length + ' arguments but received ' + values.length + '.');
     }
-    
+
     return new SetBuilder.Modifier(name, operator, values, params);
   }
 
@@ -267,74 +266,67 @@ SetBuilder.Modifiers = function(_modifiers) {
 /*
       Set (c.f. /lib/set_builder/set.rb)
       ===========================================================
-      
+
       a set of constrained traits that describe a group
 */
 
 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);
-    }
+
+  _raw_data.__each(function(params) {
+    var trait_name = params.trait;
     var trait = SetBuilder.traits().__find(trait_name);
-    var args = line.slice(1);
     if(trait) {
-      _constraints.push(trait.apply(args).negate(negative));
+      _constraints.push(trait.apply(params));
     } else if(window.console && window.console.log) {
-      window.console.log('trait not found with name "' + line[0] + '"');
+      window.console.log('trait not found with name "' + trait_name + '"');
     }
   });
-   
-  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);
+
+  function convertObjectSetToArray(constraints) {
+    return convertHashToArray(constraints).__collect(function(constraint) {
+      if(constraint.modifiers) {
+        constraint.modifiers = convertHashToArray(constraint.modifiers).__collect(function(modifier) {
+          if(modifier.values) {
+            modifier.values = convertHashToArray(modifier.values);
+          }
+          return modifier;
         });
       }
-      set.push(convertedTrait);
+      return constraint;
     });
-    return set;
   }
-  
+
+  function convertHashToArray(hash) {
+    if(hash === Array) return hash;
+    return Object.values(hash);
+  }
+
+
+
   // Public methods
-  
+
   this.data = function() {
-    
+
     // TODO: write the data structure from constraints!
-    
+
   }
-  
+
   this.constraints = function() {
     return _constraints;
   }
-  
+
   this.toString = function() {
     return this.constraints().toSentence();
   }
-  
+
   this.isEqualTo = function(other) {
     return this.toString() == other.toString();
   }
-  
+
 };
 
 
@@ -342,14 +334,17 @@ SetBuilder.Set = function(_raw_data) {
 /*
       Trait (c.f. /lib/set_builder/trait/base.rb)
       ===========================================================
-      
+
       an individual trait that can be constrained
 */
 
 SetBuilder.Trait = function(_tokens) {
-  
+
   var type, text;
-  var _name, _modifiers = [], _direct_object_type, _negative;
+  var _name,
+      _modifiers = [],
+      _direct_object_type,
+      _enums = [];
   _tokens.each(function(token) {
     type = token[0], text = token[1];
     switch(type) {
@@ -362,35 +357,35 @@ SetBuilder.Trait = function(_tokens) {
       case 'direct_object_type':
         _direct_object_type = text;
         break;
-      case 'negative':
-        _negative = text;
+      case 'enums':
+        _enums.push(text);
         break;
     }
   });
-  
-  
+
+
   // Public methods
-  
+
   this.requiresDirectObject = function() {
     return !!_direct_object_type;
   }
-  
-  this.direct_object_type = function() {
+
+  this.directObjectType = function() {
     return _direct_object_type;
   }
-  
+
   this.name = function() {
     return _name;
   }
-  
-  this.hasNegative = function() {
-    return !!_negative;
+
+  this.enums = function() {
+    return _enums;
   }
-  
+
   this.modifiers = function() {
     return _modifiers;
   }
-  
+
   this.tokens = function() {
     return _tokens;
   }
@@ -411,24 +406,24 @@ SetBuilder.Trait = function(_tokens) {
 */
 
 SetBuilder.Traits = function(_raw_data) {
-  
+
   var _traits = _raw_data.collect(function(line) {
     return new SetBuilder.Trait(line);
   });
-  
-  
+
+
   // Public methods
-  
+
   this.length = function() {
     return _traits.length;
   }
-  
+
   this.names = function() {
     return _traits.collect(function(trait) {
       return trait.name();
     });
   }
-  
+
   this.__find = function(name) {
     return _traits.__find(function(trait) {
       return (trait.name() == name);
@@ -452,7 +447,7 @@ if(!Object.keys) {
     for(key in o) {
       keys.push(key);
     }
-    return keys;  
+    return keys;
   }
 }
 
@@ -568,6 +563,8 @@ Array.prototype.__find = function(fn) {
 }
 if(!Array.prototype.find) Array.prototype.find = Array.prototype.__find;
 
+
+
 //
 // .select
 //

data/lib/set_builder/constraint.rb

@@ -1,68 +1,84 @@
-require 'set_builder/modifier'
+require "set_builder/modifier"
 
 
 module SetBuilder
   class Constraint
-    
-    
+    attr_reader :trait, :params, :direct_object, :enums, :modifiers
+    delegate :direct_object_required?,
+             :direct_object_type,
+             :to => :trait
+
+
+
     #
     # Sample constraints:
-    # 
-    #     [:awesome],
-    #     [:attended, "school"],
-    #     [:died],
-    #     [:name, {:is => "Jerome"}]]
-    # 
-    def initialize(trait, *args, &block)
+    #
+    #     { trait: :awesome }
+    #     { trait: :attended, school: 2 }
+    #     { trait: :died, enums: ["have not"] }
+    #     { trait: :name, modifiers: [{ operator: :is, values: ["Jerome"] }] }
+    #
+    def initialize(trait, params, &block)
       @trait, @block = trait, block
-      @direct_object = args.shift if trait.requires_direct_object?
-      @modifiers = trait.modifiers.collect {|modifier_type| modifier_type.new(args.shift)}
+      @params = params
+
+      @direct_object = params[direct_object_type] if trait.requires_direct_object?
+      @enums = params[:enums] || []
+      modifiers = params.fetch(:modifiers, [])
+      @modifiers = trait.modifiers.each_with_index.map { |modifier, i|
+        modifier.new(modifiers[i] || {}) }
     end
-    
-    
-    
-    attr_reader :trait, :direct_object, :modifiers, :negative
-    alias :negative? :negative
-    
-    
-    
-    delegate :direct_object_required?,
-             :direct_object_type,
-             :to => :trait
-    
-    
-    
+
+
+
     def valid?
-      (!direct_object_required? or !direct_object.nil?) and modifiers.all?(&:valid?)
+      errors.none?
     end
-    
-    
-    
-    def to_s
-      # p "ValueMap.to_s(#{direct_object_type} (#{direct_object_type.class}), #{direct_object} (#{direct_object.class}))"
-      @description ||= begin
-        description = trait.to_s(@negative)
-        description << " #{ValueMap.to_s(direct_object_type, direct_object)}" if direct_object_required?
-        description << " #{modifiers.collect{|m| m.to_s(@negative)}.join(" ")}" unless modifiers.empty?
-        description
+
+    def errors
+      [].tap do |errors|
+        errors.push "#{direct_object_type} is blank" if direct_object_required? && direct_object.nil?
+        if enums.length != trait.enums.length
+          errors.push "should have values for #{trait.enums.length} enums"
+        else
+          trait.enums.each_with_index do |expected_values, i|
+            errors.push "enum ##{i + 1} should be #{expected_values.map { |value| "'#{value}'" }.to_sentence(two_words_connector: " or ", last_word_connector: ", or ")}" unless expected_values.member?(enums[i])
+          end
+        end
+        errors.concat modifiers.flat_map(&:errors)
       end
     end
-    
-    
-    
-    def negate(value)
-      @negative = value
-      @negative = false unless trait.negative?
-      self
+
+
+
+    def to_s
+      @description ||= stringify(trait.tokens)
     end
-    
-    
-    
+
+
+
     def perform(scope)
       @block.call(self, scope)
     end
-    
-    
-    
+
+
+
+  private
+
+    def stringify(tokens)
+      enum_index = 0
+      modifier_index = 0
+      tokens.map do |token, value|
+        case token
+        when :string then value
+        when :name then trait.name
+        when :enum then enums[enum_index].to_s.tap { enum_index += 1 }
+        when :direct_object_type then ValueMap.to_s(value, direct_object)
+        when :modifier then modifiers[modifier_index].to_s.tap { modifier_index += 1 }
+        else raise NotImplementedError, "Unrecognized token type #{token.inspect}"
+        end
+      end.join
+    end
+
   end
 end

data/lib/set_builder/errors/trait_not_found.rb

@@ -0,0 +1,3 @@
+module SetBuilder
+  class TraitNotFound < RuntimeError; end
+end