dmichael-set-notation-helper 0.2

data/MIT-LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Matt Darby
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,36 @@
+SetNotationHelper
+=================
+
+A library providing set notation support for ActiveRecord models. Include this module in the models you want to support set notation finders and you are all set.
+
+To use:
+  
+    sound = Sound.in_set("{1,2,3}")
+    
+
+Installation
+------------
+
+    sudo gem install set-notation-helper -s http://gems.github.com
+    
+Add the gem to your environment.rb file
+    
+    config.gem "set-notation-helper", :lib => 'set_notation_helper'
+    
+
+Matching for sets in your routes
+---------------------------
+    
+If you are interested in matching for sets in the routes you can do something like this
+
+    regexes = [
+      /%7B\s*([\d\-,(%20)*]*)\s*%7D/, 
+      /\{\s*([\d\-,\s*]*)\s*\}/
+    ]
+  	
+  	set_regexes.each do |regex|
+      map.with_options( :controller => 'sounds', :action => 'index', :id => regex, :conditions => { :method => :get }) do |r|
+        r.connect "/#{resource}/:id.:format"
+        r.connect "/#{resource}/:id"
+      end
+    end

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/rails/init"

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/set_notation_helper.rb

@@ -0,0 +1,91 @@
+module SetNotationHelper
+  
+  def self.included(base)
+    base.class_eval do
+      extend SetNotationHelper::ClassMethods    
+      
+      # This scope accepts either a String in the form "{1,2,3}" **OR** an Integer
+      named_scope :in_set, lambda { |*args|
+        value = args.first
+
+        # A string input is either a set or an integer in disguise
+        unless value.is_a?(String) || value.is_a?(Integer)
+          logger.error "[SetNotationHelper] You have given the helper something it cant use: #{value.class}. No filter applied!"
+          return {} 
+        end
+
+        if is_set?(value)
+          { :conditions => "#{table_name}.id IN (#{ parse_set(value).to_a.join(',') })" }
+        else
+          { :conditions => "#{table_name}.id = #{ value.to_i }" }
+        end
+      }
+         
+    end 
+  end
+  
+  def set_limit
+    100000
+  end
+  
+  module ClassMethods
+        
+    def is_set_or_range?(input)
+      if is_set?(input) or is_range?(input)
+        return true
+      end
+      return false
+    end
+    
+    def is_range?(range)
+      if range && range.is_a?(String) && range.split('-').size > 1 && !match_set(range)
+        return true
+      end
+      return false
+    end
+    
+    def match_set(set)
+      return if set.blank? || !set.is_a?(String)
+      set.match( /\{\s*(.*)\s*\}/ )
+    end
+    
+    def is_set?(set)
+      if match_set(set)
+        return true
+      end
+      return false
+    end
+    
+    def parse_set(set)
+      match = match_set(set)
+      if !match then return Set.new(set) end
+
+      set = match[1].split(',')
+      set.each_with_index{|element, i|
+        if is_range?(element)
+          set[i] = element.to_range.collect
+          set.flatten!
+        end
+      }
+      if set.size > set_limit
+        @messages[:info] = "Your resultset has been truncated to #{set_limit} results"
+      end
+      set = Set.new(set[0..set_limit-1])
+      return set
+    end
+     
+    
+    def convert_range_to_limits(input)        
+      if !is_range?(input) then return false end
+    
+      # turn this String into a Range
+      range  = input.to_range
+      limit  = range.collect.size
+      offset = range.first - 1
+
+      return limit, offset
+    end
+  
+  end # ClassMethods
+
+end

data/rails/init.rb

@@ -0,0 +1,5 @@
+require 'set_notation_helper'
+ 
+ActiveRecord::Base.send :include, SetNotationHelper
+ 
+RAILS_DEFAULT_LOGGER.debug "** [SetNotationHelper] loaded. Let's say that our universe contains the numbers 1, 2, 3, and 4. Let A be the set containing the numbers 1 and 2; that is, A = {1, 2}"

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification 
+name: dmichael-set-notation-helper
+version: !ruby/object:Gem::Version 
+  version: "0.2"
+platform: ruby
+authors: 
+- David Michael
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-26 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: A library providing set notation support for ActiveRecord models
+email: david.michael@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- MIT-LICENSE.txt
+- README.markdown
+- init.rb
+- install.rb
+- lib/set_notation_helper.rb
+- rails/init.rb
+- uninstall.rb
+has_rdoc: false
+homepage: http://github.com/dmichael/set-notation-helper
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Find by set notation in Active Record
+test_files: []
+