ldap-relations 0.1.0 → 0.1.1

data/README.md

@@ -2,6 +2,8 @@
 
 [![Build Status](https://travis-ci.org/felixclack/ldap-relations.png)](https://travis-ci.org/felixclack/ldap-relations)
 
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/felixclack/ldap-relations)
+
 An Arel inspired library to provide a relational algebra for LDAP filters.
 I'm using it in conjunction with the jruby-ldap library because the 
 ruby ldap libraries just don't cut it in Ruby 1.9.

data/Rakefile

@@ -1 +1,9 @@
 require "bundler/gem_tasks"
+
+task :travis do
+  puts "Starting to run rspec spec"
+  system "bundle exec rspec spec"
+  raise "rspec spec failed!" unless $?.exitstatus == 0
+end
+
+task :default => :travis

data/ldap-relations.gemspec

@@ -18,4 +18,5 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
   gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rake'
 end

data/lib/ldap-relations.rb

@@ -1,6 +1,8 @@
 require "ldap-relations/version"
 require 'ldap-relations/relation_manager'
 require 'ldap-relations/relation'
+require 'ldap-relations/and'
+require 'ldap-relations/or'
 
 module Ldap
   module Relations

data/lib/ldap-relations/relation.rb

@@ -3,14 +3,13 @@ module Ldap::Relations
   # to be passed to an LDAP server as part of a search.
   class Relation
     def initialize params={}
-      @operator = params.fetch :operator, :and
       @params = params
     end
 
-    attr_accessor :operator, :params
+    attr_accessor :params
 
     def to_filter
-      @params.map {|key, value| "#{key}=#{value}" }.join
+      "()".insert 1, @params.map {|key, value| "#{key}=#{value}" }.join
     end
   end
 end

data/lib/ldap-relations/relation_manager.rb

@@ -3,30 +3,23 @@ module Ldap
     # Store a list of relations and provide methods
     # to output the list as an LDAP filter string.
     class RelationManager
-      RELATION_OPERATOR_MAPPINGS = {
-        or: '|',
-        and: '&',
-        not: '!'
-      }
-
       def initialize *args
-        @relations = []
+        self.relations = RelationGrouping.new
       end
 
       attr_accessor :relations
 
-      # Public: convert the relations to a LDAP-style filter string.
+      # Public: convert the relations to an LDAP-style filter string.
       #
       # Returns String
       def to_filter
-        relation = @relations.shift
-        case @relations.size
-        when 0
-          "(#{relation.to_filter})"
-        when 1
-          "(" << RELATION_OPERATOR_MAPPINGS[@relations.first.operator] <<
-            "(#{relation.to_filter})(#{@relations.first.to_filter}))"
-        end
+        relations.to_filter
+      end
+    end
+
+    class RelationGrouping < Array
+      def to_filter
+        map(&:to_filter).join
       end
     end
   end

data/lib/ldap-relations/version.rb

@@ -1,5 +1,5 @@
 module Ldap
   module Relations
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/spec/ldap-relations/integration_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+require 'ldap-relations'
+
+# Example ActiveRecord style usage for LRel
+#
+# eg. Directory.where(sAMAccountName: 'test').all
+class Directory
+  def self.where params
+    new.where(params)
+  end
+
+  def initialize params={}
+    self.manager = LRel::RelationManager.new
+  end
+
+  attr_accessor :manager
+
+  def where params
+    query = params.shift
+    manager.relations << LRel::Relation.new(query.first.to_s => query.last)
+    if !params.empty?
+      self.and(params)
+    end
+    self
+  end
+
+  def and params
+    query = params.shift
+    relation = LRel::Relation.new(query.first.to_s => query.last)
+    if params.any?
+      LRel::And.new(relation, self.and(params))
+    else
+      relation
+    end
+  end
+
+  def or params
+    manager.relations = LRel::Or.new(manager.relations, LRel::Relation.new(params))
+    self
+  end
+
+  def default_relation
+    LRel::Relation.new(objectCategory: 'person')
+  end
+
+  def to_filter
+    manager.relations = LRel::And.new(default_relation, manager.relations)
+    manager.to_filter
+  end
+
+  alias :all :to_filter
+end
+
+describe "integration" do
+  let(:directory) { Directory.where givenname: 'test' }
+
+  it 'combines the provided the filter with the default' do
+    directory.to_filter.should == "(&(objectCategory=person)(givenname=test))"
+  end
+
+  context 'chaining multiple or filters' do
+    it 'nests the filters in pairs' do
+      directory.or(sn: 'test').or(mail: 'test').to_filter.
+        should == "(&(objectCategory=person)(|(|(givenname=test)(sn=test))(mail=test)))"
+    end
+  end
+end

data/spec/ldap-relations/relation_manager_spec.rb

@@ -4,8 +4,8 @@ require 'ldap-relations/relation_manager'
 module Ldap::Relations
   describe RelationManager do
     let(:relation_manager) { RelationManager.new }
-    let(:relation) { stub 'Relation', to_filter: 'objectCategory=person', operator: :and }
-    let(:or_relation) { stub 'Relation', to_filter: 'sAMAccountName=test', operator: :or }
+    let(:relation) { stub 'Relation', to_filter: '(objectCategory=person)' }
+    let(:or_relation) { stub 'Or', to_filter: '(|(sAMAccountName=test)(mail=test))' }
 
     describe '#relations' do
       it 'stores a list of relations' do
@@ -23,16 +23,10 @@ module Ldap::Relations
         it { should == "(objectCategory=person)" }
       end
 
-      context 'with 2 relations' do
-        before { relation_manager.relations << relation << relation }
+      context 'with a Relation grouping' do
+        before { relation_manager.relations << or_relation }
 
-        it { should == "(&(objectCategory=person)(objectCategory=person))" }
-      end
-
-      context 'with an AND relation and an OR relation' do
-        before { relation_manager.relations << relation << or_relation }
-
-        it { should == "(|(objectCategory=person)(sAMAccountName=test))"}
+        it { should == "(|(sAMAccountName=test)(mail=test))" }
       end
     end
   end

data/spec/ldap-relations/relation_spec.rb

@@ -12,23 +12,7 @@ module Ldap::Relations
     describe '#to_filter' do
       subject { relation.to_filter }
 
-      it { should == 'sAMAccountName=test' }
-    end
-
-    describe '#operator' do
-      context 'by default' do
-        subject { relation.operator }
-
-        it { should == :and }
-      end
-
-      context 'when set to :or' do
-        let(:or_relation) { Relation.new sAMAccountName: 'test', operator: :or }
-
-        subject { or_relation.operator }
-
-        it { should == :or }
-      end
+      it { should == '(sAMAccountName=test)' }
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ldap-relations
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-07 00:00:00.000000000 Z
+date: 2012-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -27,6 +27,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ''
 email:
 - felixclack@gmail.com
@@ -46,6 +62,7 @@ files:
 - lib/ldap-relations/relation_manager.rb
 - lib/ldap-relations/version.rb
 - spec/.rspec
+- spec/ldap-relations/integration_spec.rb
 - spec/ldap-relations/relation_manager_spec.rb
 - spec/ldap-relations/relation_spec.rb
 - spec/spec_helper.rb
@@ -75,6 +92,7 @@ specification_version: 3
 summary: Abstraction of filters to use with an LDAP library.
 test_files:
 - spec/.rspec
+- spec/ldap-relations/integration_spec.rb
 - spec/ldap-relations/relation_manager_spec.rb
 - spec/ldap-relations/relation_spec.rb
 - spec/spec_helper.rb