mind_reader 0.0.1 → 0.1.0

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Rodrigo Manhães
+
+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.rdoc

@@ -0,0 +1,106 @@
+= MindReader: Easy searching for ActiveRecord applications
+
+Given the following objects:
+
+    @robin = Customer.create! :name => 'Damian Wayne',
+                              :address => 'Wayne Manor, Gotham City',
+                              :age => 14
+    @batman = Customer.create! :name => 'Dick Grayson',
+                               :address => 'Wayne Manor, Gotham City',
+                               :sidekick_id => @robin.id,
+                               :age => 26
+    @superman = Customer.create! :name => 'Kal-El',
+                                 :address => 'Kandor, New Krypton',
+                                 :age => 36
+
+
+Find by one field:
+
+    reader = MindReader.new(Customer)
+    result = reader.execute(:address => 'Wayne Manor, Gotham City')
+    result.should have(2).bat_heroes
+    result.should include(@batman, @robin)
+
+
+Find by multiple fields:
+
+    reader = MindReader.new(Customer)
+    reader.execute(:address => 'Wayne Manor, Gotham City',
+      :name => 'Dick Grayson').should == [@batman]
+
+
+String fields are evaluated partially:
+
+    result = reader.execute(:name => 'ay')
+    result.should have(2).super_heroes
+    result.should include(@batman, @robin)
+
+
+Find with lookup:
+
+    reader = MindReader.new(Customer) do |r|
+      r.sidekick_id(:lookup => :sidekick_name) {|name| Customer.find_by_name(name).id }
+    end
+    reader.execute(:sidekick_name => 'Damian Wayne').should == [@batman]
+
+
+Find given a range:
+
+    reader = MindReader.new(Customer) do |r|
+      r.age :range => :start_age..:end_age
+    end
+    reader.execute('start_age' => 25, 'end_age' => 36).should == [@batman, @superman]
+
+
+Blank fields are ignored:
+
+    reader = MindReader.new(Customer)
+    reader.execute(:name => 'Kal-El', :address => '').should == [@superman]
+
+
+If all fields are blank, returns nil:
+
+    reader = MindReader.new(Customer)
+    reader.execute(:name => '', :address => '').should be_nil
+
+
+unless you say you want all objects:
+
+    reader = MindReader.new(Customer)
+    reader.retrieve_all_when_no_value_is_given = true
+    result = reader.execute(:name => '', :address => '')
+    result.should have(3).super_heroes
+    result.should include(@batman, @robin, @superman)
+
+
+mind_reader supports converters for incoming data. For sake of example, imagine
+you have to enter a date in a different format (here, dd/mm/yyyy), and you want
+to convert it to default yyyy-mm-dd::
+
+      def convert_to_default(br_date)
+        br_date =~ /(\d+)\/(\d+)\/(\d+)/
+        "%s-%s-%s" % [$3, $2, $1]
+      end
+
+      reader = MindReader.new(SuperHero) do |r|
+        r.date_of_heroic_birth :range => :from_date..:to_date, :converter => lambda {|d| convert_to_default(d) }
+      end
+      reader.execute('from_date' => '01/04/2010', 'to_date' => '30/04/2010').should == [@batman]
+
+
+== How to install
+
+
+    $ gem install mind_reader
+
+
+== How to run specs
+
+
+    $ rake spec
+
+
+== Copyright
+
+Copyright (c) 2011 Rodrigo Manhães. See LICENSE.txt for further details.
+

data/lib/mind_reader.rb

@@ -29,6 +29,7 @@ class MindReader
 
   def process
     remove_blanks
+    run_converters
     handle_lookup
     handle_range
     handle_partials
@@ -38,6 +39,25 @@ class MindReader
     @pairs.reject! {|k, v| v.blank?}
   end
 
+  def run_converters
+    configs.each do |c|
+      if c[:args].has_key?(:converter)
+        if c[:args].has_key?(:range)
+          apply_converter(c, c[:args][:range].begin.to_s)
+          apply_converter(c, c[:args][:range].end.to_s)
+        else
+          apply_converter(c, c[:field])
+        end
+      end
+    end
+  end
+
+  def apply_converter(config, field)
+    callable = config[:args][:converter]
+    value = @pairs[field]
+    @pairs[field] = callable.call(value)
+  end
+
   def handle_partials
     string_keys = @pairs.map {|field, value|
       field if string_field?(field) && value.present?
@@ -63,13 +83,15 @@ class MindReader
         range = c[:args][:range]
         start_field, end_field = range.begin.to_s, range.end.to_s
         start_value, end_value = @pairs.delete(start_field), @pairs.delete(end_field)
-        @pairs.merge! c[:field] => start_value..end_value
+        if start_value.present? && end_value.present?
+          @pairs.merge! c[:field] => start_value..end_value
+        end
       end
     end
   end
 
   def string_field?(field)
-    @klass.columns_hash[field.to_s].try(:type) == :string
+    [:string, :text].include? @klass.columns_hash[field.to_s].try(:type)
   end
 
   class ConfigurableObject

metadata

@@ -1,80 +1,105 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: mind_reader
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 1
-  version: 0.0.1
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
 platform: ruby
-authors: 
-- "Rodrigo Manh\xC3\xA3es"
+authors:
+- Rodrigo Manhães
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-07-08 00:00:00 -03:00
+date: 2011-06-01 00:00:00.000000000 -03:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+dependencies:
+- !ruby/object:Gem::Dependency
   name: activerecord
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &13369940 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 3
-        - 0
-        - 0
+      - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
-  version_requirements: *id001
+  prerelease: false
+  version_requirements: *13369940
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &13369400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *13369400
+- !ruby/object:Gem::Dependency
+  name: steak
+  requirement: &13368940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *13368940
+- !ruby/object:Gem::Dependency
+  name: sqlite3-ruby
+  requirement: &13367240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *13367240
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: &13366760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *13366760
 description: Easy searching for ActiveRecord applications
-email: 
-- rmanhaes@gmail.com
+email: rmanhaes@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- mind_reader.gemspec
+files:
 - lib/mind_reader.rb
+- README.rdoc
+- LICENSE.txt
 has_rdoc: true
 homepage: http://github.com/rodrigomanhaes/mind_reader
 licenses: []
-
 post_install_message: 
-rdoc_options: []
-
-require_paths: 
+rdoc_options:
+- --charset=UTF-8
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: mind_reader
-rubygems_version: 1.3.7
+rubyforge_project: 
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Easy searching for ActiveRecord applications
 test_files: []
-

data/mind_reader.gemspec

@@ -1,20 +0,0 @@
-# encoding: utf-8
-
-Gem::Specification.new do |s|
-  s.name = %q{mind_reader}
-  s.version = '0.0.1'
-
-  s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to? :required_rubygems_version=
-  s.authors = ['Rodrigo Manhães']
-  s.date = %{2010-07-08}
-  s.description = %{Easy searching for ActiveRecord applications}
-  s.email = ['rmanhaes@gmail.com']
-  s.files = ['mind_reader.gemspec', 'lib/mind_reader.rb']
-  s.require_paths = ['lib']
-  s.rubyforge_project = %q{mind_reader}
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{Easy searching for ActiveRecord applications}
-  s.add_dependency 'activerecord', '~>3.0.0'
-  s.homepage = 'http://github.com/rodrigomanhaes/mind_reader'
-end
-