dm-extjs 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,20 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rcov (0.9.9)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  rcov
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Alex Gibbons
+
+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/Rakefile

@@ -0,0 +1,23 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.name = "dm-extjs"
+  gem.homepage = "http://github.com/alexgb/dm-extjs"
+  gem.license = "MIT"
+  gem.summary = %Q{DataMapper plugin for serializing resources to work with ExtJs}
+  gem.description = %Q{A DataMapper plugin that will serialize and provide meta data descriptions for resources and collections. Compatible with ExtJS and Sencha Touch}
+  gem.email = "alex.gibbons [a] gmail [dot] com"
+  gem.authors = ["Alex Gibbons"]
+  gem.add_dependency 'dm-serializer'
+end
+Jeweler::RubygemsDotOrgTasks.new

data/Readme.md

@@ -0,0 +1,61 @@
+# dm-extjs
+
+A DataMapper plugin that will serialize and provide meta data descriptions for resources and collections. Compatible with ExtJS and Sencha Touch.
+
+## Install
+
+Just vendor and require this library to use. Must also have dm-serializer installed.
+
+## Examples
+
+Describe a collection of resources:
+
+    Person.all(:name.like => "%larry%").to_extjs
+    
+Describe a resource and specific related resources:
+
+    Person.get(10).to_extjs(
+      :methods => [:pets]
+    )
+
+Describe the success of a save operation for a resource:
+
+    person = Person.new
+    person.attributes = {:name => "Larry", :phone => "238-2934-4444"}
+    person.to_extjs(:success => person.save)
+    
+## Responses
+
+The above examples will produce JSON which resembles the following. These responses should be automagically ingested by your Ext.data.JsonReader.
+
+    {
+        "metaData": {
+            "root": "results",
+            "successProperty": "success",
+            "messageProperty": "message",
+            "total": "total",
+            "start": "start",
+            "limit": "limit",
+            "fields": [{
+                "name": "id",
+                "type": "int"
+            },
+            {
+                "name": "name",
+                "type": "string"
+            },    
+            {
+                "name": "phone",
+                "type": "string"
+            }],
+            "idProperty": "id"
+        },
+        "success": true,
+        "message": "",
+        "total": 1,
+        "results": [{
+            "id": 1,
+            "name": "Larry",
+            "phone": "238-2934-4444"
+        }]
+    }

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/dm-extjs.gemspec

@@ -0,0 +1,69 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{dm-extjs}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Alex Gibbons"]
+  s.date = %q{2011-03-29}
+  s.description = %q{A DataMapper plugin that will serialize and provide meta data descriptions for resources and collections. Compatible with ExtJS and Sencha Touch}
+  s.email = %q{alex.gibbons [a] gmail [dot] com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "Rakefile",
+    "Readme.md",
+    "VERSION",
+    "dm-extjs.gemspec",
+    "lib/dm-extjs.rb",
+    "lib/dm-extjs/collection.rb",
+    "lib/dm-extjs/model.rb",
+    "lib/dm-extjs/resource.rb",
+    "test/helper.rb",
+    "test/test_dm-extjs.rb"
+  ]
+  s.homepage = %q{http://github.com/alexgb/dm-extjs}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{DataMapper plugin for serializing resources to work with ExtJs}
+  s.test_files = [
+    "test/helper.rb",
+    "test/test_dm-extjs.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_runtime_dependency(%q<dm-serializer>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<dm-serializer>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<dm-serializer>, [">= 0"])
+  end
+end
+

data/lib/dm-extjs/collection.rb

@@ -0,0 +1,17 @@
+module DataMapper
+  module ExtJS
+    module Collection
+  
+      def to_extjs (options={})
+        {
+          :metaData => model.ext_meta(options[:methods]),
+          :success => options.has_key?(:success) ? options[:success] : true,
+          :message => options.has_key?(:message) ? options[:message] : '',
+          :total => count,
+          :results => self.to_json(options.merge(:to_json => false))
+        }.to_json
+      end
+    
+    end
+  end
+end

data/lib/dm-extjs/model.rb

@@ -0,0 +1,72 @@
+module DataMapper
+  module ExtJS
+    module Model
+      
+      # generates the meta description of a resource
+      # TODO: idProperty is set to the first primary key, in instances
+      # where you have multiple keys this would be wrong
+      # 
+      # pass array of relationships (as in to_json(:methods => RELATIONSHIPS))
+      # so as to squash provide meta mapping for these related models, this will
+      # squash those properties on top of the base model
+      
+      def ext_meta (relationships=nil)
+        relationships ||= []
+        ret = {
+          :fields => properties.collect {|p| property_description(p)},
+          :idProperty => properties.key.first.name
+        }
+        
+        # map related properties to meta description
+        # TODO: cleanup needed
+        # because "relationships" are actually all declared :methods, this will
+        # try to build meta descriptions for both methods on a model, and
+        # relationships on a resource, here we attempt to treat the method as a
+        # relationship, then assume it's a model level method with a return type
+        # of string 
+        relationships.each do |r|
+          begin
+            __send__(r.to_sym).model.properties.each do |p|
+              prop = self.property_description(p)
+              prop[:mapping] = "#{r}.#{prop[:name]}"
+              prop[:name] = "#{r}__#{prop[:name]}"
+              ret[:fields].push(prop)
+            end
+          rescue
+            ret[:fields].push({
+              :name => r,
+              :type => 'string'
+            })
+          end
+          
+          
+        end
+        
+        EXT_META.merge(ret)
+      end
+
+      protected
+    
+      # provides property descriptions needed by ext
+      def property_description (property) 
+        ret = {:name => property.name}
+        
+        if property.respond_to?(:custom?) && property.custom?
+          if property.respond_to? :flag_map
+            ret[:type] = EXT_TYPE_TRANSLATIONS["String"][:type]
+          else
+            ret[:type] = property.class.name.split('::').last.downcase
+          end
+        elsif type = EXT_TYPE_TRANSLATIONS[property.primitive.to_s][:type]
+          ret[:type] = type
+        end
+
+        if dateFormat = EXT_TYPE_TRANSLATIONS[property.primitive.to_s][:dateFormat]
+          ret[:dateFormat] = dateFormat
+        end
+        ret
+      end
+      
+    end
+  end
+end

data/lib/dm-extjs/resource.rb

@@ -0,0 +1,20 @@
+module DataMapper
+  module ExtJS
+    module Resource
+    
+      def to_extjs (options={})
+        ret = {
+          :metaData => self.class.ext_meta(options[:methods]),
+          :success => options.has_key?(:success) ? options[:success] : (saved? && clean?),
+          :message => (ext_errors << (options[:message] || '')).join("\n"),
+          :results => self.to_json(options.merge(:to_json => false))
+        }.to_json
+      end
+    
+      def ext_errors
+        errors.to_a unless !respond_to?(:errors)
+      end
+    
+    end
+  end
+end

data/lib/dm-extjs.rb

@@ -0,0 +1,50 @@
+require 'dm-serializer'
+
+require File.join(File.dirname(__FILE__), 'dm-extjs', 'collection')
+require File.join(File.dirname(__FILE__), 'dm-extjs', 'resource')
+require File.join(File.dirname(__FILE__), 'dm-extjs', 'model')
+
+module DataMapper
+  module ExtJS
+    EXT_SORT_PARAM =        'order'
+    EXT_LIMIT_PARAM =       'limit'
+    EXT_OFFSET_PARAM =      'start'
+    EXT_DIRECTION_PARAM =   '_dir'
+    
+    EXT_META = {
+      :root =>              'results',
+      :successProperty =>   'success',
+      :messageProperty =>   'message',
+      :total =>             'total',
+      :start =>             EXT_OFFSET_PARAM,
+      :limit =>             EXT_LIMIT_PARAM
+    }
+    
+    DM_PARAM_TRANSLATIONS = {
+      EXT_SORT_PARAM =>   :order,
+      EXT_LIMIT_PARAM =>  :limit,
+      EXT_OFFSET_PARAM => :offset
+    }
+
+    EXT_TYPE_TRANSLATIONS = {
+      'String' =>     {:type => 'string'},
+      'Integer' =>    {:type => 'int'},
+      'Fixnum' =>     {:type => 'int'},
+      'Float' =>      {:type => 'float'},
+      'TrueClass' =>  {:type => 'boolean'},
+      'FalseClass' => {:type => 'boolean'},
+      'Date' =>       {:type => 'date', :dateFormat => 'Y-m-d'},
+      'DateTime' =>   {:type => 'date', :dateFormat => 'c'}
+    }
+  end
+end
+
+# include in DM
+module DataMapper
+  Model.append_inclusions(ExtJS::Resource)
+  Model.append_extensions(ExtJS::Model)
+  
+  class Collection
+    include ExtJS::Collection
+  end
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'dm-extjs'
+
+class Test::Unit::TestCase
+end

data/test/test_dm-extjs.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestDmExtjs < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification 
+name: dm-extjs
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Alex Gibbons
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-29 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: shoulda
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: bundler
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: jeweler
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: rcov
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: dm-serializer
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id005
+description: A DataMapper plugin that will serialize and provide meta data descriptions for resources and collections. Compatible with ExtJS and Sencha Touch
+email: alex.gibbons [a] gmail [dot] com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- Rakefile
+- Readme.md
+- VERSION
+- dm-extjs.gemspec
+- lib/dm-extjs.rb
+- lib/dm-extjs/collection.rb
+- lib/dm-extjs/model.rb
+- lib/dm-extjs/resource.rb
+- test/helper.rb
+- test/test_dm-extjs.rb
+has_rdoc: true
+homepage: http://github.com/alexgb/dm-extjs
+licenses: 
+- MIT
+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.3.7
+signing_key: 
+specification_version: 3
+summary: DataMapper plugin for serializing resources to work with ExtJs
+test_files: 
+- test/helper.rb
+- test/test_dm-extjs.rb