rufus-doric 0.1.0

data/lib/rufus/doric/model.rb

@@ -0,0 +1,300 @@
+#--
+# Copyright (c) 2010, John Mettraux, jmettraux@gmail.com
+#
+# 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.
+#
+# Made in Japan.
+#++
+
+#require 'cgi'
+
+
+module Rufus
+module Doric
+
+  DORIC_DESIGN_DOC = {
+    '_id' => '_design/doric',
+    'views' => {
+      'by_doric_type' => {
+        'map' => %{
+          function(doc) {
+            if (doc.doric_type) emit(doc.doric_type, null);
+          }
+        }
+      }
+    }
+  }
+
+  #
+  # Classes extending that class have 1 Couch document per instance
+  #
+  class Model
+
+    #extend ActiveModel::Naming
+    include ActiveModel::Validations
+
+    #
+    # class 'helpers'
+
+    def self.doric_type (rt=nil)
+
+      @doric_type = rt.to_s if rt
+      @doric_type
+    end
+
+    def self._id_field (field_name=nil, &block)
+
+      @_id_field = field_name.to_s if field_name
+      @_id_field = block if block
+
+      @_id_field
+    end
+
+    def self.view_by (key)
+
+      @keys ||= []
+      @keys << key.to_s
+
+      instance_eval %{
+        def by_#{key} (val, opts={})
+          by('#{key}', val, opts)
+        end
+      }
+    end
+
+    include WithH
+    include WithDb
+
+    #--
+    # constructor and instance methods
+    #++
+
+    attr_reader :h
+
+    def initialize (doc={})
+
+      @h = doc.inject({}) { |h, (k, v)| h[k.to_s] = v; h }
+      @h['doric_type'] = self.class.doric_type
+    end
+
+    def _id
+      @h['_id']
+    end
+
+    def _rev
+      @h['_rev']
+    end
+
+    def id
+      @h['_id']
+    end
+
+    def attachments
+      (@h['_attachments'] || {}).keys.sort
+    end
+
+    def copy
+
+      h = Rufus::Json.dup(@h)
+      h.delete('_id')
+      h.delete('_rev')
+
+      self.class.new(h)
+    end
+
+    def save!
+
+      raise ActiveRecord::RecordInvalid.new(self) unless valid?
+
+      if @h['_id'].nil? && self.class._id_field
+
+        i = if self.class._id_field.is_a?(String)
+          self.send(self.class._id_field)
+        else
+          self.instance_eval &self.class._id_field
+        end
+
+        @h['_id'] = Rufus::Doric.neutralize_id(i)
+      end
+
+      raise ActiveRecord::RecordInvalid.new(self) if @h['_id'].nil?
+
+      r = db.put(@h)
+
+      raise(SaveFailed.new(self.class.doric_type, _id)) unless r.nil?
+    end
+
+    #--
+    # methods required by ActiveModel (see test/unit/lint_mdmodel_test.rb
+    #++
+
+    def to_model
+
+      self
+    end
+
+    def destroyed?
+
+      @h['_destroyed'] == true
+    end
+
+    def new_record?
+
+      @h['_id'].nil?
+    end
+
+    # Is used by <resource>_path and <resource>_url
+    #
+    def to_param
+
+      @h['_id']
+    end
+
+    def delete
+
+      @h['_destroyed'] = true
+      db.delete(@h)
+
+      # TODO : raise when the delete fails
+    end
+
+    def destroy
+
+      delete
+    end
+
+    #--
+    # class methods
+    #++
+
+    def self.destroy_all
+
+      get_all({}).each { |d| db.delete(d) }
+    end
+
+    def self.all (opts={})
+
+      get_all(opts).collect { |d| self.new(d) }
+    end
+
+    def self.find (_id)
+
+      doc = db.get(_id)
+
+      raise Rufus::Doric::NotFound.new(@doric_type, _id) unless doc
+
+      self.new(doc)
+    end
+
+    def self.design_path
+
+      name = self.to_s.downcase
+      name = name.gsub(/::/, '__')
+
+      "_design/doric_#{name}"
+    end
+
+    protected
+
+    def self.put_design_doc (key=nil)
+
+      # the 'all' view
+
+      unless key
+        db.put(DORIC_DESIGN_DOC)
+        return
+      end
+
+      # by_{key} views
+
+      x = {
+        '_id' => '_design/doric',
+        'views' => {
+          'by_doric_type' => {
+            'map' => %{
+              function(doc) {
+                if (doc.doric_type) emit(doc.doric_type, null);
+              }
+            }
+          }
+        }
+      }
+
+      ddoc = db.get(design_path) || {
+        '_id' => design_path,
+        'views' => {}
+      }
+
+      ddoc['views']["by_#{key}"] = {
+        'map' => %{
+          function(doc) {
+            if (doc.doric_type == '#{@doric_type}') {
+              emit(doc['#{key}'], null);
+            }
+          }
+        }
+      }
+
+      db.put(ddoc)
+    end
+
+    def self.get_all (opts)
+
+      # TODO : limit, skip (opts)
+
+      path =
+        "_design/doric/_view/by_doric_type?key=%22#{@doric_type}%22" +
+        "&include_docs=true"
+
+      result = db.get(path)
+
+      unless result
+
+        # insert design doc
+
+        put_design_doc
+        return get_all(opts)
+      end
+
+      result['rows'].collect { |r| r['doc'] }
+    end
+
+    def self.by (key, val, opts)
+
+      # TODO : limit, skip (opts)
+
+      #v = Rufus::Json.encode(val)
+      #v = CGI.escape(v)
+      v = "%22#{val}%22"
+
+      path = "#{design_path}/_view/by_#{key}?key=#{v}&include_docs=true"
+
+      result = db.get(path)
+
+      unless result
+        put_design_doc(key)
+        return by(key, val, opts)
+      end
+
+      result['rows'].collect { |r| r['doc'] }
+    end
+  end
+end
+end
+

data/lib/rufus/doric/models.rb

@@ -0,0 +1,122 @@
+#--
+# Copyright (c) 2010, John Mettraux, jmettraux@gmail.com
+#
+# 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.
+#
+# Made in Japan.
+#++
+
+require 'active_model'
+require 'active_record'
+
+# there are more 'require' at the end of this file
+
+
+module Rufus
+module Doric
+
+  def self.neutralize_id (s)
+
+    s.to_s.strip.gsub(/[\s\/:;\*\\\+\?]/, '_')
+  end
+
+  #
+  # The including classes get two new class methods : h_reader and h_accessor
+  #
+  module WithH
+
+    def self.included (target)
+
+      def target.known_fields
+        @known_fields
+      end
+
+      def target.h_reader (*names)
+        names.each do |name|
+          name = name.to_s
+          (@known_fields ||= []) << name
+          define_method(name) do
+            @h[name]
+          end
+        end
+      end
+      def target.h_accessor (*names)
+        h_reader(*names)
+        names.each do |name|
+          define_method("#{name}=") do |v|
+            @h[name.to_s] = v
+          end
+        end
+      end
+    end
+  end
+
+  #
+  # The .db 'xyz' and #db methods
+  #
+  module WithDb
+
+    def self.included (target)
+
+      def target.db (dbname=nil, opts=nil)
+
+        if dbname
+          @db = dbname.to_s
+          @db_opts = opts || {}
+          return @db
+        end
+
+        Rufus::Doric::Couch.db(@db, @db_opts)
+      end
+    end
+
+    def db
+
+      self.class.db
+    end
+  end
+
+  #--
+  # ERRORS
+  #++
+
+  # A common error class
+  #
+  class ModelError < StandardError
+
+    attr_accessor :model_class, :_id
+
+    def initialize (model_class, _id)
+      @model_class = model_class
+      @_id = _id
+    end
+
+    def to_s
+      "#{@model_class}/#{@_id}"
+    end
+  end
+
+  class NotFound < ModelError; end
+  class SaveFailed < ModelError; end
+end
+end
+
+require 'rufus/doric/model'
+require 'rufus/doric/one_doc_model'
+

data/lib/rufus/doric/one_doc_model.rb

@@ -0,0 +1,136 @@
+#--
+# Copyright (c) 2010, John Mettraux, jmettraux@gmail.com
+#
+# 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.
+#
+# Made in Japan.
+#++
+
+
+module Rufus
+module Doric
+
+  #
+  # The models built on top of this class store all their instances
+  # in one Couch document.
+  #
+  class OneDocModel
+
+    include ActiveModel::Validations
+
+    #
+    # class 'helpers'
+
+    def self.doc_id (_id=nil)
+
+      @doc_id = _id.to_s if _id
+      @doc_id
+    end
+
+    include WithH
+    include WithDb
+
+    #
+    # constructor and instance methods
+
+    attr_reader :h
+    attr_reader :attachment
+
+    def initialize (h, doc=nil)
+
+      @h = h.inject({}) { |hh, (k, v)| hh[k.to_s] = v; hh }
+
+      if doc && atts = doc['_attachments']
+
+        @attachment, details = atts.find { |k, v|
+          File.basename(k, File.extname(k)) == @h['_id']
+        }
+      end
+    end
+
+    def _id
+
+      @h['_id']
+    end
+
+    def save!
+
+      raise ActiveRecord::RecordInvalid.new(self) unless valid?
+
+      doc = self.class.do_get(self.class.doc_id)
+      doc[self.class.doc_id][@h['_id']] = @h
+
+      db.put(doc)
+    end
+
+    def delete
+
+      doc = self.class.do_get(self.class.doc_id)
+      doc[self.class.doc_id].delete(@h['_id'])
+
+      # TODO : raise when the put fails
+
+      db.put(doc)
+    end
+
+    def destroy
+
+      delete
+    end
+
+    #--
+    # class methods
+    #++
+
+    def self.create! (h)
+
+      self.new(h).save!
+    end
+
+    def self.all
+
+      doc = do_get(@doc_id)
+
+      doc[@doc_id].values.collect { |h| self.new(h, doc) }
+    end
+
+    def self.destroy_all
+
+      doc = db.get(@doc_id)
+      db.delete(doc) if doc
+    end
+
+    def self.find (_id)
+
+      doc = do_get(@doc_id)
+
+      h = doc[@doc_id][_id]
+      h ? self.new(h, doc) : nil
+    end
+
+    protected
+
+    def self.do_get (doc_id)
+
+      db.get(doc_id) ||  { '_id' => doc_id, doc_id => {} }
+    end
+  end
+end
+end
+

data/lib/rufus/doric/version.rb

@@ -0,0 +1,7 @@
+
+module Rufus
+module Doric
+  VERSION = '0.1.0'
+end
+end
+

data/lib/rufus/doric.rb

@@ -0,0 +1,4 @@
+
+require 'rufus/doric/couch'
+require 'rufus/doric/models'
+

data/lib/rufus-doric.rb

@@ -0,0 +1,3 @@
+
+require 'rufus/doric'
+

data/rufus-doric.gemspec

@@ -0,0 +1,90 @@
+# 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{rufus-doric}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["John Mettraux"]
+  s.date = %q{2010-03-17}
+  s.description = %q{
+something at the intersection of Rails3, CouchDB and rufus-jig
+  }
+  s.email = %q{jmettraux@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+     "README.rdoc"
+  ]
+  s.files = [
+    "CHANGELOG.txt",
+     "LICENSE.txt",
+     "README.rdoc",
+     "Rakefile",
+     "TODO.txt",
+     "lib/rufus-doric.rb",
+     "lib/rufus/doric.rb",
+     "lib/rufus/doric/couch.rb",
+     "lib/rufus/doric/fixtures.rb",
+     "lib/rufus/doric/model.rb",
+     "lib/rufus/doric/models.rb",
+     "lib/rufus/doric/one_doc_model.rb",
+     "lib/rufus/doric/version.rb",
+     "rufus-doric.gemspec",
+     "test/base.rb",
+     "test/fixtures/test/doric/69247b__picture.jpg",
+     "test/fixtures/test/doric/69249__picture.jpg",
+     "test/fixtures/test/doric/product0.json",
+     "test/fixtures/test/doric/product1.json",
+     "test/fixtures/test/doric/users.json",
+     "test/fixtures/test/doric/users__jami.png",
+     "test/fixtures/test/doric/users__john.jpg",
+     "test/fixtures/test/doric_ENV_workitems/workitem0.json",
+     "test/test.rb",
+     "test/ut_0_fixtures.rb",
+     "test/ut_1_model.rb",
+     "test/ut_2_model_view.rb",
+     "test/ut_3_model_lint.rb",
+     "test/ut_4_one_doc_model.rb"
+  ]
+  s.homepage = %q{http://github.com/jmettraux/rufus-doric/}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{rufus}
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{something at the intersection of Rails3, CouchDB and rufus-jig}
+  s.test_files = [
+    "test/test.rb"
+  ]
+
+  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
+      s.add_runtime_dependency(%q<activerecord>, ["~> 3.0.0.beta"])
+      s.add_runtime_dependency(%q<rufus-jig>, [">= 0.1.16"])
+      s.add_runtime_dependency(%q<mime-types>, [">= 1.16"])
+      s.add_development_dependency(%q<rake>, [">= 0"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+    else
+      s.add_dependency(%q<activerecord>, ["~> 3.0.0.beta"])
+      s.add_dependency(%q<rufus-jig>, [">= 0.1.16"])
+      s.add_dependency(%q<mime-types>, [">= 1.16"])
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<yard>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, ["~> 3.0.0.beta"])
+    s.add_dependency(%q<rufus-jig>, [">= 0.1.16"])
+    s.add_dependency(%q<mime-types>, [">= 1.16"])
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<yard>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+  end
+end
+

data/test/base.rb

@@ -0,0 +1,16 @@
+
+lib = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+$:.unshift(lib) unless $:.include?(lib)
+
+require 'test/unit'
+
+require 'rubygems'
+require 'yajl'
+require 'patron'
+
+require 'rufus/jig'
+
+ENV['RAILS_ENV'] = 'test'
+require 'active_support'
+require 'rufus/doric'
+

data/test/fixtures/test/doric/product0.json

@@ -0,0 +1,8 @@
+{
+  "_id": "69249",
+  "serial_number": "69249",
+  "type": "AH0305 MAC Board",
+  "sub_type": "ATM",
+  "barcode": "76076P05936",
+  "roma_type": "products"
+}

data/test/fixtures/test/doric/product1.json

@@ -0,0 +1,8 @@
+{
+  "_id": "69247b",
+  "serial_number": "69247b",
+  "type": "AH0305 Shaun Smith SnowBoard",
+  "sub_type": "STM",
+  "barcode": "7607SF6P05936",
+  "roma_type": "products"
+}