set_builder 1.1.0 → 1.2.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a4ee4be1ca6fe188bd97be3b9799e760f0323964
-  data.tar.gz: 7511cc628d027af339b9b1bc16030ad7ee1f370d
+  metadata.gz: 7bf1d04e0fd591ff37671dbd2dc1ce2cede2a540
+  data.tar.gz: eef6f337c4eb113547e4ff748756bb5df09d8aaa
 SHA512:
-  metadata.gz: 3ff3004bdd8f7200e87daeb8c9d7b3cafb3856e112f967666210dac89f91bbb570ce510bae2e8be6cfe0fbf3524990f249e3be7e6e0bb239b2c72460b4e88bc3
-  data.tar.gz: 2f7e8c30215b01bffa2a2d8753fab4e9e0943302f4944aa90ebeb3d414827ae68fae4c67d3acf0104e90ed14bcad36c265b8a6a77ec07a145f87c29a83495886
+  metadata.gz: 792157510a3bf947bf29af2666c5fd7f25d931a42d7d81742975b7eb85efdf7335c774342dc4bb9e2f38674bf34aac4ecaeaa981d8ecfd301c44957b39944964
+  data.tar.gz: b143d8b08ea3115b14135fefff0bb3ca0c4210b6843317aacbe7385fba1adc775f7c403dcb0a6fae884ac47422189b750f0e72adc8d7a16ddd93c03a53eec229

data/.travis.yml

@@ -0,0 +1,6 @@
+# .travis.yml
+language: ruby
+rvm:
+  - 2.0.0
+script:
+  - bundle exec rake test

data/README.md

@@ -1,35 +1,31 @@
-SetBuilder
-==========
+# SetBuilder
 
-SetBuilder's purpose is to transform _described_ data sets into queries or natural language.
+[![Build Status](https://travis-ci.org/boblail/set_builder.png?branch=master)](https://travis-ci.org/boblail/set_builder)
+[![Code Climate](https://codeclimate.com/github/boblail/set_builder.png)](https://codeclimate.com/github/boblail/set_builder)
 
+SetBuilder is a library for:
 
-Example
-=======
+ * Describing a set of constraints in a simple data structure that can easily be serialized
+ * Presenting that data structure in natural language
+ * Performing the set of constraints as a SQL query
 
-The following set describes a group of people using simple data structures (Arrays, Strings, Symbols, and Hashes):
+
+
+### Example
+
+The following Set describes a group of people:
 
      [[:awesome],
       [:attended, "school"],
       [:died, :not],
       [:name, {:is => "Jerome"}]]
 
-SetBuilder can render this set in plain English:
+SetBuilder can render this Set in plain English:
 
     [Everyone] who is awesome, who attended school, who has 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.
 
 
-Usage
-=====
-
-
-
-Roadmap
-=======
-
-Right now SetBuilder uses ActiveRecord::NamedScope::Scope internally, but it shouldn't be hard to refactor it to use DataMapper's composable queries instead.
-
 
 Copyright (c) 2010 Bob Lail, released under the MIT license

data/lib/set_builder/constraint.rb

@@ -22,6 +22,7 @@ module SetBuilder
     
     
     attr_reader :trait, :direct_object, :modifiers, :negative
+    alias :negative? :negative
     
     
     
@@ -58,7 +59,7 @@ module SetBuilder
     
     
     def perform(scope)
-      scope.scoped(@block.call(self, scope))
+      @block.call(self, scope)
     end
     
     

data/lib/set_builder/set.rb

@@ -3,14 +3,15 @@ module SetBuilder
     
     
     
-    def initialize(model_or_scope, raw_data)
-      @model, @scope = get_model_and_scope(model_or_scope)
+    def initialize(model, scope, raw_data)
+      @model = model
+      @scope = scope
       @set = raw_data
     end
     
     
     
-    attr_reader :model
+    attr_reader :model, :scope
     
     
     
@@ -43,7 +44,7 @@ module SetBuilder
     # which can fetch the objects which belong to this set
     #    
     def perform
-      constraints.inject(@scope) {|scope, constraint| constraint.perform(scope)}
+      constraints.inject(scope) { |scope, constraint| constraint.perform(scope) }
     end
     
     
@@ -52,8 +53,10 @@ module SetBuilder
     
     
     
+    attr_reader :set
+    
     def get_constraints
-      @set.inject([]) do |constraints, line|
+      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]
@@ -64,18 +67,5 @@ module SetBuilder
     
     
     
-    # !todo: this can be overriden or factored out to allow SetBuilder 
-    #   to be used with other ORMs like DataMapper
-    def get_model_and_scope(model_or_scope)
-      if defined?(ActiveRecord::NamedScope::Scope) && model_or_scope.is_a?(ActiveRecord::NamedScope::Scope)
-        [model_or_scope.proxy_scope, model_or_scope]
-      else
-        # [model_or_scope, model_or_scope.scoped({})]
-        [model_or_scope, model_or_scope.scoped]
-      end
-    end
-    
-    
-    
   end
-end
+end

data/lib/set_builder/version.rb

@@ -1,3 +1,3 @@
 module SetBuilder
-  VERSION = "1.1.0"
+  VERSION = "1.2.0.beta1"
 end

data/lib/set_builder.rb

@@ -25,7 +25,12 @@ module SetBuilder
   
   
   def that_belong_to(set)
-    SetBuilder::Set.new(self, set)
+    SetBuilder::Set.new(self, to_scope, set)
+  end
+  
+  
+  def to_scope
+    scoped
   end
   
   

data/set_builder.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "rails", "< 4.0"
+  spec.add_dependency "rails"
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "turn"

data/test/set_test.rb

@@ -4,10 +4,6 @@ class SetTest < ActiveSupport::TestCase
   
   
   
-  test "FakeScope" do
-    assert_equal [5, 4, 3, 2], FakeScope.new(5).scoped(4).scoped(3).scoped(2).composed_scope
-  end
-  
   test "set data struture" do
     data = [
       [:awesome],
@@ -63,8 +59,7 @@ class SetTest < ActiveSupport::TestCase
     set = Friend.that_belong_to(data)
     
     expected_results = [{:conditions => {:awesome => true}}]
-    # Friend.reset_composed_scope
-    assert_equal expected_results, set.perform.composed_scope
+    assert_equal expected_results, set.perform
   end
   
   test "complex perform" do
@@ -81,8 +76,7 @@ class SetTest < ActiveSupport::TestCase
       {:conditions => {:alive => false}},
       {:conditions => ["friends.name LIKE ?", "Jerome%"]}
     ]
-    # Friend.reset_composed_scope
-    assert_equal expected_results, set.perform.composed_scope
+    assert_equal expected_results, set.perform
   end
   
   test "invalid set" do

data/test/test_helper.rb

@@ -7,27 +7,6 @@ require 'set_builder'
 
 
 
-# Mocks NamedScope so that composed scoping can be tested
-
-class FakeScope
-  
-  def initialize(args)
-    args = [args] unless args.is_a?(Array)
-    @composed_scope = args
-  end
-  
-  def scoped(args)
-    FakeScope.new(@composed_scope + [args])
-  end
-  
-  def composed_scope
-    @composed_scope
-  end
-  
-end
-
-
-
 # Sample class used by tests
 
 SetBuilder::ValueMap.register(:school, [[1, "Concordia"], [2, "McKendree"]])
@@ -36,26 +15,26 @@ class Friend
   extend SetBuilder
 
 
-  trait(:is, "awesome") do |query|
-    {:conditions => {:awesome => true}}
+  trait(:is, "awesome") do |query, scope|
+    scope << {:conditions => {:awesome => true}}
   end
 
-  trait(nil, "died") do |query|
-    {:conditions => {:alive => false}}
+  trait(nil, "died") do |query, scope|
+    scope << {:conditions => {:alive => false}}
   end
 
   # this trait accepts modifiers --- an adverbial clause
-  trait(:was, "born", :date) do |query|
-    {:conditions => query.modifiers[0].build_conditions_for("friends.birthday")}
+  trait(:was, "born", :date) do |query, scope|
+    scope << {:conditions => query.modifiers[0].build_conditions_for("friends.birthday")}
   end
 
-  trait(:whose, "age", :number) do |query|
-    {:conditions => query.modifiers[0].build_conditions_for("friends.age")}
+  trait(:whose, "age", :number) do |query, scope|
+    scope << {:conditions => query.modifiers[0].build_conditions_for("friends.age")}
   end
 
   # this trait has a direct object
-  trait(:has, {"attended" => :school}) do |query|
-    {
+  trait(:has, {"attended" => :school}) do |query, scope|
+    scope << {
       :joins => "INNER JOIN schools ON friends.school_id=schools.id",
       :conditions => {"schools.id" => query.direct_object}
     }
@@ -63,15 +42,15 @@ class Friend
 
   # this trait is a noun
   # also modifiers can be classes
-  trait(:whose, "name", StringModifier) do |query|
-    {:conditions => query.modifiers[0].build_conditions_for("friends.name")}
+  trait(:whose, "name", StringModifier) 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.scoped(*args)
-    FakeScope.new(args)
+  def self.to_scope
+    []
   end
   
   

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: set_builder
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0.beta1
 platform: ruby
 authors:
 - Bob Lail
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-17 00:00:00.000000000 Z
+date: 2014-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - <
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - <
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -74,6 +74,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - MIT-LICENSE
 - README.md
@@ -147,12 +148,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.2
+rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
 summary: Define traits on a model, create sets that constrain those traits, and generate