dm-json-search 0.0.1

data/.gitignore

@@ -0,0 +1 @@
+pkg/*

data/README

@@ -0,0 +1,75 @@
+Search your models with JSON!
+=============================
+
+How to use
+----------
+
+gem install gemcutter          # unless you already have
+gem tumble                     # unless you already have
+gem install dm-json-search
+
+Then, in your model:
+
+class Book
+  include JsonSearch::Searchable
+end
+
+Wala:
+
+Book.search('[{"eql":{"title":"Psycho"}}]')
+# Should this be mixed in automagically to every model?
+
+
+Another example query and it's json
+-----------------------------------
+
+puts Ticket.select { |t| 
+  t.title == "foo" || (t.user_id == 6 && t.account_id == 9) 
+}.query.to_json
+
+Becomes:
+
+{
+    "model": "Ticket",
+    "repository": "default",
+    "conditions": {
+        "and": [{
+            "or": [{
+                "eql": { "Ticket.title": "foo" }
+            },
+            {
+                "and": [{
+                    "eql": { "Ticket.user_id": 6 }
+                },
+                {
+                    "eql": { "Ticket.account_id": 9 }
+                }]
+            }]
+        }]
+    },
+    "reload": false,
+    "order": ["Ticket.id.asc"],
+    "fields": [...],
+    "links": [], // these don't work yet
+    "unique": false,
+    "limit": null,
+    "offset": 0
+}
+
+
+Explanation
+-----------
+
+Operations are objects with a key for the Operation#slug and an array of operands. Comparisons are object with a key for the Comparison#slug and an object with a property key and a value for the comparison.
+
+So, you can send in a huge json string like the above, or you can just send in the conditions part: { "and": [...] }. Or, if you just send in an array, it will wrap that array in an "and" hash.
+
+All DM Operations and Conditions are permitted on any Property of any Model. This probably needs to be changed to only search some fields.
+
+
+TODO
+----
+
+* Spec it out and make sure there are no vectors for destructive actions
+* Make links work
+* Make it better?

data/Rakefile

@@ -0,0 +1,14 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "dm-json-search"
+    gemspec.summary = "Search your models with JSON!"
+    gemspec.description = "Use JSON and Hashes to create complex queries on your DM models."
+    gemspec.email = "nathan@myobie.com"
+    gemspec.homepage = "http://github.com/myobie/dm-json-search"
+    gemspec.authors = ["Nathan Herald"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/dm-json-search.gemspec

@@ -0,0 +1,44 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{dm-json-search}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Nathan Herald"]
+  s.date = %q{2009-10-22}
+  s.description = %q{Use JSON and Hashes to create complex queries on your DM models.}
+  s.email = %q{nathan@myobie.com}
+  s.extra_rdoc_files = [
+    "README"
+  ]
+  s.files = [
+    ".gitignore",
+     "README",
+     "Rakefile",
+     "VERSION",
+     "dm-json-search.gemspec",
+     "lib/dm-json-search.rb",
+     "lib/dm-json-search/query_ext.rb",
+     "lib/dm-json-search/searchable.rb"
+  ]
+  s.homepage = %q{http://github.com/myobie/dm-json-search}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Search your models with JSON!}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/lib/dm-json-search.rb

@@ -0,0 +1,3 @@
+require 'dm-core'
+require File.dirname(__FILE__) + '/dm-json-search/query_ext'
+require File.dirname(__FILE__) + '/dm-json-search/searchable'

data/lib/dm-json-search/query_ext.rb

@@ -0,0 +1,161 @@
+class DataMapper::Query
+  
+  def to_hash
+    {
+      "repository" => self.repository.name,
+      "model" => self.model.name,
+      "fields" => self.fields.collect { |p| "#{p.model}.#{p.name}" },
+      "links" => [], # I need to see an example of this,
+      "order" => self.order.collect { |o| "#{o.target.model}.#{o.target.name}.#{o.operator}" },
+      "limit" => self.limit,
+      "offset" => self.offset,
+      "reload" => @reload,
+      "unique" => @unique,
+      "conditions" => operation_to_hash(self.conditions)
+    }
+  end
+  
+  def to_json
+    to_hash.to_json
+  end
+  
+  def all
+    repository.scope { model.all(self) }
+  end
+  
+  class << self
+    
+    def from_json(json)
+      from_hash(JSON.parse(json))
+    end
+    
+    def from_hash(hash)
+      
+      respository = hash["repository"].to_sym
+      model = string_to_model(hash["model"])
+      options = {}
+      
+      # fields
+      unless hash["fields"].blank? || !hash["fields"].is_a?(Array)
+        options[:fields] = hash["fields"].collect { |f| string_to_property(f) }
+      end
+      
+      # links, again, I don't know enough about, I've never used them
+      
+      # order
+      unless hash["order"].blank? || !hash["order"].is_a?(Array)
+        options[:order] = hash["order"].collect { |p| string_to_order(p) }
+      end
+      
+      options[:limit] = hash["limit"] unless hash["limit"].blank?
+      options[:offset] = hash["offset"] unless hash["offset"].blank?
+      
+      unless hash["conditions"].blank?
+        options[:conditions] = string_to_conditions(hash["conditions"])
+      end
+      
+      new(repository, model, options)
+      
+    end#from_hash
+    
+  private
+    def string_to_model(string)
+      DataMapper::Model.descendants.find { |m| m.name == string }
+    end
+
+    def string_to_property(string)
+      strings = string.split(".")
+
+      if model = string_to_model(strings[0])
+        model.properties[strings[1]]
+      else
+        nil
+      end
+    end
+
+    def string_to_relationship(string)
+      strings = string.split(".")
+
+      if model = string_to_model(strings[0])
+        model.relationships[strings[1]]
+      else
+        nil
+      end
+    end
+
+    def string_to_order(string)
+      property = string_to_property(string)
+      direction = string.split(".")[2] || :asc
+      DataMapper::Query::Direction.new(property, direction.to_sym)
+    end
+
+    def string_to_conditions(conditions)
+      if DataMapper::Query::Conditions::Operation.slugs.include?(conditions.keys.first.to_sym)
+        string_to_operation(conditions)
+      elsif DataMapper::Query::Conditions::Comparison.slugs.include?(conditions.keys.first.to_sym)
+        string_to_comparison(conditions)
+      else
+        nil
+      end
+    end
+
+    def string_to_operation(operation)
+      slug = operation.keys.first.to_sym
+      operands = operation.values.first.collect { |o| string_to_conditions(o) }
+      DataMapper::Query::Conditions::Operation.new(slug, *operands)
+    end
+
+    def string_to_comparison(comparison)
+      slug = comparison.keys.first.to_sym
+      compare = comparison.values.first
+      subject = string_to_subject(compare.keys.first)
+      value = compare.values.first
+      DataMapper::Query::Conditions::Comparison.new(slug, subject, value)
+    end
+
+    def string_to_subject(subject)
+      if property = string_to_property(subject)
+        property
+      else
+        string_to_relationship(subject)
+      end
+    end
+    
+  end#class << self
+  
+private
+  def operation_to_hash(operation)
+    {
+      operation.slug => operation.operands.collect { |o| operand_to_hash(o) }
+    }
+  end
+  
+  def operand_to_hash(operand)
+    # TODO: figure out a better way to detect what type of object it is
+    
+    if operand.respond_to?(:subject) # it's a comparison
+      comparison_to_hash(operand)
+    elsif operand.respond_to?(:operands) # it's an operation
+      operation_to_hash(operand)
+    else # it must be some other kind of object
+      operand
+    end
+  end
+  
+  def comparison_to_hash(comparison)
+    {
+      comparison.slug => {
+        subject_to_hash(comparison.subject) => comparison.value
+      }
+    }
+  end
+  
+  def subject_to_hash(subject)
+    if subject.respond_to?(:parent_model)
+      "#{subject.source_model}.#{subject.name}"
+    else
+      "#{subject.model}.#{subject.name}"
+    end
+  end
+  
+end

data/lib/dm-json-search/searchable.rb

@@ -0,0 +1,29 @@
+module JsonSearch
+  module Searchable
+  
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+  
+    module ClassMethods
+      def search(json = {})
+        json = JSON.parse(json) if json.is_a?(String)
+    
+        if json.is_a?(Array)
+          json = { "conditions" => { "and" => json } }
+        end
+    
+        if json["conditions"].blank? && !json["and"].blank?
+          json = { "conditions" => json }
+        end
+    
+        json["model"] = name
+        json["repository"] = default_repository_name
+    
+        DataMapper::Query.from_hash(json).all
+      end
+    end
+  
+  end
+end
+JSONSearch = JsonSearch

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+name: dm-json-search
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Nathan Herald
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-22 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: Use JSON and Hashes to create complex queries on your DM models.
+email: nathan@myobie.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- .gitignore
+- README
+- Rakefile
+- VERSION
+- dm-json-search.gemspec
+- lib/dm-json-search.rb
+- lib/dm-json-search/query_ext.rb
+- lib/dm-json-search/searchable.rb
+has_rdoc: true
+homepage: http://github.com/myobie/dm-json-search
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.3.5
+signing_key: 
+specification_version: 3
+summary: Search your models with JSON!
+test_files: []
+