ooor-finders 0.1.6

data/.gitignore

@@ -0,0 +1,2 @@
+*.swp
+pkg

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+gemspec
+

data/Gemfile.lock

@@ -0,0 +1,31 @@
+PATH
+  remote: .
+  specs:
+    ooor-finders (0.1.6)
+      ooor (>= 1.6.5)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.2.2)
+      activesupport (= 3.2.2)
+      builder (~> 3.0.0)
+    activeresource (3.2.2)
+      activemodel (= 3.2.2)
+      activesupport (= 3.2.2)
+    activesupport (3.2.2)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    builder (3.0.0)
+    i18n (0.6.0)
+    multi_json (1.1.0)
+    ooor (1.6.5)
+      activeresource (>= 2.3.5)
+    rake (0.9.2.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ooor-finders!
+  rake

data/README.md

@@ -0,0 +1,53 @@
+============
+OOOR Finders
+============
+
+Following behaviors are added
+
+* find_by_XX
+* find_first_by_XX
+* find_all_by_XX
+* find_last_by_XX
+* find_or_create_by
+* find_or_initialize_by
+* find_by_xml_id or alias find_by_oid
+
+So we can do:
+
+```ruby
+require "ooor/finders"
+
+ResUsers.find_by_xml_id('module.xml_id').id
+ResUsers.find_by_id(23).id
+ResUsers.find_by_name('Administrator').id
+ResUsers.find_by_name!('Administrator').id # Will throw an exception if you put a ! at the end and nothing is found
+```
+
+We can also use all or last:
+
+```ruby
+ResUsers.find_all_by_name('Administrator')
+ResUsers.find_last_by_name('Administrator')
+ResUsers.find_last_by_name_and_login('Administrator', 'admin')
+ResUsers.find_by_name_and_login('Administrator', 'admin')
+```
+
+Plus the create mode:
+ 
+```ruby
+ResUsers.find_or_create_by_login_and_name_and_oid 'toto', 'toto', 'base.toto'
+ResUsers.find_or_create_by_login_and_name'toto', 'toto'
+```
+
+Other options are supported:
+
+```ruby
+ResUsers.find_all_by_name('Administrator', :fields=>['id'], :limit=>20)
+```
+
+*************
+Installation
+*************
+```
+gem install ooor-finders
+```

data/Rakefile

@@ -0,0 +1,3 @@
+require 'bundler/setup'
+
+Bundler::GemHelper.install_tasks

data/lib/ooor/finders.rb

@@ -0,0 +1 @@
+require 'ooor/finders/open_object_resource'

data/lib/ooor/finders/dynamic_finder_match.rb

@@ -0,0 +1,53 @@
+# Active Record Dynamic Finder Match
+#
+# Taken from active record source code
+#
+class DynamicFinderMatch
+  def self.match(method)
+    finder       = :first
+    bang         = false
+    instantiator = nil
+
+    case method.to_s
+    when /^find_(all_|last_)?by_([_a-zA-Z]\w*)$/
+      finder = :last if $1 == 'last_'
+      finder = :all if $1 == 'all_'
+      names = $2
+    when /^find_by_([_a-zA-Z]\w*)\!$/
+      bang = true
+      names = $1
+    when /^find_or_(initialize|create)_by_([_a-zA-Z]\w*)$/
+      instantiator = $1 == 'initialize' ? :new : :create
+      names = $2
+    else
+      return nil
+    end
+
+    new(finder, instantiator, bang, names.split('_and_'))
+  end
+
+  def initialize(finder, instantiator, bang, attribute_names)
+    @finder          = finder
+    @instantiator    = instantiator
+    @bang            = bang
+    @attribute_names = attribute_names
+  end
+
+  attr_reader :finder, :attribute_names, :instantiator
+
+  def finder?
+    @finder && !@instantiator
+  end
+
+  def instantiator?
+    @finder == :first && @instantiator
+  end
+
+  def creator?
+    @finder == :first && @instantiator == :create
+  end
+
+  def bang?
+    @bang
+  end
+end

data/lib/ooor/finders/open_object_resource.rb

@@ -0,0 +1,69 @@
+require 'ooor'
+require 'ooor/finders/dynamic_finder_match'
+module Ooor
+  class OpenObjectResource
+    class << self
+      alias_method :method_missing_original, :method_missing
+
+      def _instanciate_by_attributes(match, arguments)
+        # TODO check relation and send a warning
+        res = self.new
+        attributes = match.attribute_names
+        xml_id = nil
+        attributes.length.times do |index|
+          if ['xml_id', 'oid'].include? attributes[index]
+            xml_id = arguments[index]
+          elsif attributes[index] == 'id'
+            raise "find_or_create_by_id is not supported"
+          else
+            eval("res.#{attributes[index]} = arguments[index]")
+          end
+        end
+        if xml_id
+          res.ir_model_data_id = xml_id.split('.')
+        end
+        if match.instantiator == :create
+          res.save
+        end
+        return res
+      end
+
+      def _find_or_instantiator_by_attributes(match, arguments)
+        unique_keys = ['xml_id', 'id', 'oid']
+        options = {}
+        if arguments.last.is_a? Hash
+          options = arguments.last
+        end
+        attributes = match.attribute_names
+        unique_index = attributes.index{|x| unique_keys.include? x}
+        if unique_index
+          res = self.find(arguments[unique_index], options)
+        else
+          domain = []
+          attributes.length.times do | index |
+            domain.push([attributes[index] ,'=', arguments[index]])
+          end
+          options.merge!({:domain => domain})
+          res = self.find(match.finder, options)
+          if match.bang? && !match.instantiator?
+            unless res
+              raise "Could not find #{self.class} with for domain #{domain.inspect}"
+            end
+          end
+        end
+        if match.instantiator and not res
+          return _instanciate_by_attributes(match, arguments)
+        end
+        return res
+      end
+
+      def method_missing(method_symbol, *arguments)
+        match = DynamicFinderMatch.match(method_symbol.to_s)
+        if match
+          return send(:_find_or_instantiator_by_attributes, match, arguments)
+        end
+        return method_missing_original(method_symbol, *arguments)
+      end
+    end
+  end
+end

data/lib/ooor/finders/version.rb

@@ -0,0 +1,5 @@
+module Ooor
+  module Finders
+    VERSION = "0.1.6"
+  end
+end

data/lib/ooor_finders.rb

@@ -0,0 +1,3 @@
+puts "Using require 'ooor_finders' is deprecated and will be removed in subsequent versions"
+puts "Please use require 'ooor/finders'"
+require "ooor/finders"

data/ooor-finders.gemspec

@@ -0,0 +1,20 @@
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+require 'ooor/finders/version'
+
+Gem::Specification.new do |s|
+  s.name         = 'ooor-finders'
+  s.version      = Ooor::Finders::VERSION
+  s.platform     = Gem::Platform::RUBY
+  s.date         = '2012-03-06'
+  s.authors      = ["Nicolas Bessi - Camptocamp"]
+  s.summary      = %q{OOOR - OpenObject On Ruby dynamic finder extention}
+  s.description  = %q{Add Active Record like dynamic finder pattern}
+  s.files        = `git ls-files`.split("\n")
+  s.require_path = 'lib'
+  s.homepage      = "http://github.com/camptocamp/ooor_finders"
+
+  s.add_dependency('ooor', [">= 1.6.5"])
+
+  s.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification 
+name: ooor-finders
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 6
+  version: 0.1.6
+platform: ruby
+authors: 
+- Nicolas Bessi - Camptocamp
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-03-06 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ooor
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 1
+        - 6
+        - 5
+        version: 1.6.5
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Add Active Record like dynamic finder pattern
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/ooor/finders.rb
+- lib/ooor/finders/dynamic_finder_match.rb
+- lib/ooor/finders/open_object_resource.rb
+- lib/ooor/finders/version.rb
+- lib/ooor_finders.rb
+- ooor-finders.gemspec
+has_rdoc: true
+homepage: http://github.com/camptocamp/ooor_finders
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: OOOR - OpenObject On Ruby dynamic finder extention
+test_files: []
+