extjsizable 1.0.0.alpha

data/.document

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

data/Gemfile

@@ -0,0 +1,18 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+gem "activesupport", ">= 3.0"
+gem "activerecord", ">= 3.0"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.3"
+  gem "rcov", ">= 0"
+end
+
+group :test do
+  gem "sqlite3"
+end

data/Gemfile.lock

@@ -0,0 +1,46 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.5)
+      activesupport (= 3.0.5)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activerecord (3.0.5)
+      activemodel (= 3.0.5)
+      activesupport (= 3.0.5)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activesupport (3.0.5)
+    arel (2.0.9)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    i18n (0.5.0)
+    jeweler (1.6.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.9.2)
+    rcov (0.9.9)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    sqlite3 (1.3.3)
+    tzinfo (0.3.25)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (>= 3.0)
+  activesupport (>= 3.0)
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.3)
+  rcov
+  rspec (~> 2.3.0)
+  sqlite3

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Ungue
+
+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,62 @@
+= extjsizable
+
+This gem insert the method to_extjs into ActiveRecord and Array.
+Messages generated are valid to be used against <b>Ext JS 4</b> (http://www.sencha.com/products/extjs/).
+It requires Rails 3.0 or latter to work properly.
+
+== ActiveRecord
+
+To load a form, the data extjs expect to meet is like so:
+ 
+ {
+   "data": { 
+     "id": 1, 
+     "title": "First Post",
+     "body": "This is my first post.",
+     "published": true, ...
+    }, 
+    "success": true
+ }
+ 
+<tt>* Previous versions of extjs needed attributes wrapped with the model name. Now this gem doesn't allow this.</tt>
+
+If <em>ActiveRecord::Base.include_root_in_json</em> is true then, the model name is used instead of data key:
+ {
+   "post": { 
+     "id": 1, 
+     "title": "First Post",
+     "body": "This is my first post.",
+     "published": true, ...
+    }, 
+    "success": true
+ }
+
+So that it is as easy as do:
+
+ @post.to_extjs
+
+In case the model has some failures, the sentence above will return:
+ {
+   "errors": { "title": ["Title can't be blank"] },
+   "success": false 
+ }
+
+Parameters accepted are the same as <b>as_json</b> from ActiveModel.
+
+== Array
+
+When to_extjs is called from ActiveRecord (or hashes) collections, Ext JS expect to receive a structure like that:
+
+ { 'total' : 2,
+   'data' : [
+      { 'id' : 1, :title : 'First Post'  },
+      { 'id' : 2, :title : 'Second Post' }
+    ]
+ }
+
+It is generated executing
+ Post.all.to_extjs
+
+== TODO
+ 
+* Tests, tests, tests....

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+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 is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "extjsizable"
+  gem.homepage = "http://github.com/ungue/extjsizable"
+  gem.license = "MIT"
+  gem.summary = %Q{Allow your models and collections to generate the JSON structure accepted by Ext JS 4}
+  gem.description = %Q{You can create REST services to be used for Ext JS 4 in a easy manner by calling to_extjs in your models or arrays.}
+  gem.email = "ungue79@yahoo.es"
+  gem.authors = ["Ungue"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "extjsizable #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0.alpha

data/extjsizable.gemspec

@@ -0,0 +1,67 @@
+# 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{extjsizable}
+  s.version = "1.0.0.alpha"
+
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ungue"]
+  s.date = %q{2011-08-03}
+  s.description = %q{You can create REST services to be used for Ext JS 4 in a easy manner by calling to_extjs in your models or arrays.}
+  s.email = %q{ungue79@yahoo.es}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "extjsizable.gemspec",
+    "lib/extjsizable.rb",
+    "lib/extjsizable/active_record/extjs.rb",
+    "lib/extjsizable/core_ext/array/extjs.rb",
+    "spec/extjsizable_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/ungue/extjsizable}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{Allow your models and collections to generate the JSON structure accepted by Ext JS 4}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 3.0"])
+      s.add_runtime_dependency(%q<activerecord>, [">= 3.0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.3"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 3.0"])
+      s.add_dependency(%q<activerecord>, [">= 3.0"])
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.3"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 3.0"])
+    s.add_dependency(%q<activerecord>, [">= 3.0"])
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.3"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/lib/extjsizable/active_record/extjs.rb

@@ -0,0 +1,50 @@
+module Extjsizable
+  module ActiveRecord
+    module ExtJs
+      extend ActiveSupport::Concern
+
+      module InstanceMethods
+
+        def to_extjs(options = {})
+          success = options.delete(:success)
+
+          if success || (success.nil? && valid?)
+            # returns success/data to load a form:
+            # {
+            #   "data": { 
+            #     "id": 1, 
+            #     "title": "First Post",
+            #     "body": "This is my first post.",
+            #     "published": true, ...
+            #    }, 
+            #    "success": true
+            # }
+            # 
+            # If ActiveRecord::Base.include_root_in_json is true then, the model name is used instead of data key:
+            # {
+            #   "post": { 
+            #     "id": 1, 
+            #     "title": "First Post",
+            #     "body": "This is my first post.",
+            #     "published": true, ...
+            #    }, 
+            #    "success": true
+            # }
+          
+            h_json_data = ::ActiveRecord::Base.include_root_in_json? ? as_json(options) : { :data => as_json(options) }
+            { :success => true }.merge(h_json_data)
+          else
+            # retrieves no-success/errors to the form:
+            # {
+            #   "errors": { "title": "Title can't be blank", ... },
+            #   "success": false 
+            # }
+            { :success => false, :errors => errors.as_json(options).with_indifferent_access }
+          end.with_indifferent_access 
+
+        end        
+      end
+    end
+  end
+end
+

data/lib/extjsizable/core_ext/array/extjs.rb

@@ -0,0 +1,78 @@
+module Extjsizable
+  module CoreExt
+    module Array
+      module ExtJs
+        extend ActiveSupport::Concern
+
+        module InstanceMethods
+
+          # Creates a JSON object by specifying which attributes we want to be shown.
+          # Ej:
+          # { 'total' : 2,
+          #   'data' : [
+          #      { 'id' : 1, :nombre : 'Juan'  },
+          #      { 'id' : 2, :nombre : 'Pedro' }
+          #    ]
+          # }
+          
+          def to_extjs(options = {})
+            options.reverse_merge!(
+              :methods  => [],
+              :total    => self.length,
+              :only     => [],
+              :except   => [],
+              :include  => {}
+            ) 
+
+            result = self.map do |r|
+              case r
+              when Hash
+                record_from_hash(r, options)
+              when ::ActiveRecord::Base
+                record_from_model(r, options)
+              else
+                r 
+              end
+            end
+
+            { :total => options[:total], :data => result }
+          end
+
+          private
+    
+
+          def record_from_model(reg, options)
+            options.reverse_merge!(
+              :methods  => [],
+              :only     => [],
+              :except   => [],
+              :include  => {}
+            )
+            
+            data  = []
+
+            attrs = options[:only].empty? ? reg.attributes.symbolize_keys.keys - options[:except] : options[:only]
+            attrs.each do |attr|
+              data << ["#{attr}", reg.send(attr)] if reg.respond_to? attr
+            end
+    
+            options[:methods].each do |method|
+              data << ["#{method}", reg.send(method)] if reg.respond_to? method
+            end
+
+            options[:include].each do |(k, v)|
+              data.concat record_from_model(reg.send(k), v).map { |l| ["#{k}_#{l.first}", l.last] } if reg.respond_to?(k) && reg.send(k)
+            end
+
+            Hash[*data.flatten(1)]
+          end
+
+          def record_from_hash(reg, options)
+            attrs = options[:only] || reg.keys - options[:except]
+            reg.delete_if { |k,v| attrs.member? k}
+          end
+        end
+      end
+    end
+  end
+end

data/lib/extjsizable.rb

@@ -0,0 +1,8 @@
+require 'active_record'
+require 'active_support/core_ext'
+require 'active_support/concern'
+require 'extjsizable/active_record/extjs'
+require 'extjsizable/core_ext/array/extjs'
+
+ActiveRecord::Base.send :include, Extjsizable::ActiveRecord::ExtJs
+Array.send              :include, Extjsizable::CoreExt::Array::ExtJs

data/spec/extjsizable_spec.rb

@@ -0,0 +1,123 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Extjsizable" do
+
+  describe Category do
+
+    describe "valid" do
+      before do
+        @category = Category.new :name => 'The category'
+      end
+
+      it "should return success : true and a data section when not ActiveRecord::Base.include_root_in_json" do 
+        ActiveRecord::Base.include_root_in_json = false
+        @category.should be_valid
+
+        json_hash = @category.to_extjs
+
+        json_hash.should_not be_empty
+        json_hash.should have_key(:success)
+        json_hash[:success].should be_true
+
+        json_hash.should have_key(:data)
+      end
+      
+      it "should return success : true and a category section when ActiveRecord::Base.include_root_in_json" do 
+        ActiveRecord::Base.include_root_in_json = true
+        @category.should be_valid
+
+        json_hash = @category.to_extjs
+
+        json_hash.should_not be_empty
+        json_hash.should have_key(:success)
+        json_hash[:success].should be_true
+        json_hash.should have_key(:category)
+      end
+
+      it "should return the attribute name of category" do
+        json_hash = @category.to_extjs
+        json_hash[:category].should have_key(:name)
+      end  
+       
+      it "should return all atributes and the result of the methods specified when called with :methods => [...]" do
+        json_hash = @category.to_extjs(:methods => :my_method)
+        json_hash[:category].should have_key(:name)
+        json_hash[:category].should have_key(:my_method)
+      end
+
+      it "should return success : false and an empty errors section when called with :success => false" do
+        json_hash = @category.to_extjs(:success => false)
+        
+        json_hash.should have_key(:success)
+        json_hash[:success].should be_false
+
+        json_hash.should_not have_key(:data)
+        json_hash.should_not have_key(:category)
+
+        json_hash.should have_key(:errors)
+        json_hash[:errors].should be_empty
+      end
+    end
+
+    describe "not valid" do
+      before do
+        @category = Category.new
+        @category.save
+      end
+
+      it "should return success : false and an errors section" do 
+        @category.should_not be_valid
+
+        json_hash = @category.to_extjs
+
+        json_hash.should_not be_empty
+        json_hash.should have_key(:success)
+        json_hash[:success].should be_false
+
+        json_hash.should have_key(:errors)
+      end
+      
+      it "should return the failed attribute name" do
+        json_hash = @category.to_extjs
+        json_hash[:errors].should have_key(:name)
+      end  
+    end
+  end
+
+  describe Array do
+    describe 'empty' do
+      before do
+        @array = []
+      end
+
+      it 'should return { total => 0, data => [] }' do
+        json_hash = @array.to_extjs
+        json_hash.should have_key(:total)
+        json_hash[:total].should == 0
+        json_hash.should have_key(:data)
+        json_hash[:data].should be_empty
+      end
+    end
+    
+    describe 'with 4 categories' do
+      before do
+        @array = Array.new(4) { |i| Category.create :name => "Category #{i}" }
+      end
+
+      it 'should return { :total => 4, :data => [{ "id" => ..., "name" => "Category ..."}, ...] }' do
+        json_hash = @array.to_extjs
+        json_hash.should have_key(:total)
+        json_hash[:total].should == 4
+
+        json_hash.should have_key(:data)
+        json_hash[:data].should have(4).categories
+        json_hash[:data].each do |h| 
+          h.should have_key('id')
+          h.should have_key('name')
+        end
+      end
+    end
+  end
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,48 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'active_record'
+require 'active_support'
+require 'rspec'
+require 'extjsizable'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+ActiveRecord::Base.establish_connection(
+    :adapter => 'sqlite3',
+    :database => ":memory:"
+)
+
+ActiveRecord::Schema.define(:version => 1) do
+  create_table "products", :force => true do |t|
+    t.integer "category_id"
+    t.string  "name"
+  end
+  
+  create_table "categories", :force => true do |t|
+    t.string "name"
+  end
+end
+
+# Testing models
+class Category < ActiveRecord::Base
+  has_many :products
+
+  validates_presence_of :name
+
+  def my_method
+    return 'the result of my method'
+  end
+end
+
+class Product < ActiveRecord::Base
+  belongs_to :category
+
+  validates_presence_of :name
+end
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification 
+name: extjsizable
+version: !ruby/object:Gem::Version 
+  prerelease: 6
+  version: 1.0.0.alpha
+platform: ruby
+authors: 
+- Ungue
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-03 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "3.0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "3.0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.6.3
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id006
+description: You can create REST services to be used for Ext JS 4 in a easy manner by calling to_extjs in your models or arrays.
+email: ungue79@yahoo.es
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- extjsizable.gemspec
+- lib/extjsizable.rb
+- lib/extjsizable/active_record/extjs.rb
+- lib/extjsizable/core_ext/array/extjs.rb
+- spec/extjsizable_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/ungue/extjsizable
+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: -676178687
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 1.3.1
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Allow your models and collections to generate the JSON structure accepted by Ext JS 4
+test_files: []
+