ruby-ext-js 0.0.1

data/.document

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 CrowdFlower
+
+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.markdown

@@ -0,0 +1,65 @@
+# ruby-ext-js
+
+Provides ultra-basic classes for translating Ext.js GET params to Postgres (via Datamapper) and MongoDB (via Mongood) query opts with sensible default limits.
+
+Examples:
+
+## Postgres
+
+    module ExtJs
+      class PullRequests < Postgres
+        # Converts Ext.js' wacky params structure into a Postgres db query opts
+        # hash. Supports filtering by PullRequests.state only
+        def self.db_opts(params, opts = {})
+          params[:dir] ||= "DESC" # Default to descending order
+          
+          db_opts = self.pagination_opts( params, {
+            :max_offset => 5000, # Optional, prevent Postgres from shitting its pants
+            :max_limit => 100
+          }.merge( opts ))
+          
+          # Filters (the Ext filters hash is not pretty)
+          filters = {}
+          if params[:filter] && params[:filter]["0"] && params[:filter]["0"][:data]
+            filters = case params[:filter]["0"][:data][:value]
+              when "Rejected":   { :rejected => true }
+              when "Approved":   { :rejected => false }
+              when "Unreviewed": { :reviewed => nil }
+            end
+          end
+          
+          db_opts.merge filters
+        end
+      end
+    end
+
+## MongoDB
+
+Mongo's a lot easier to work with:
+
+    module ExtJs
+      class PullRequests < Mongo
+        def self.allowed_filters
+          ["state"]
+        end
+      end
+    end
+
+# Specs
+
+`ExtJs` was extracted from private code. Existing specs rely on private models, so there are no specs here yet. Specs will require DataMapper.
+
+# Contributing
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+# Copyright
+
+Copyright (c) 2011 CrowdFlower. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,35 @@
+require 'rubygems'
+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 = "ruby-ext-js"
+  gem.homepage = "http://github.com/help/ruby-ext-js"
+  gem.license = "MIT"
+  gem.summary = %Q{Ultra-basic classes for working with Ext.js requests and translating them to DataMapper / Mongood query opts.}
+  gem.description = %Q{Ultra-basic classes for working with Ext.js requests and translating them to DataMapper / Mongood query opts.}
+  gem.email = "tyson@doloreslabs.com"
+  gem.authors = ["Tyson Tate"]
+  gem.add_development_dependency "rspec", "~> 1.3.1"
+  gem.add_development_dependency "jeweler", "~> 1.5.2"
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'spec'
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+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 = "ruby-ext-js #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/lib/ruby-ext-js.rb

@@ -0,0 +1,132 @@
+module ExtJs
+  class Postgres
+    def self.db_opts(params, opts = {}); raise NotImplementedError; end
+    
+    protected
+    
+    # Converts Ext.js' wacky params structure into a Postgres db query
+    # opts hash for pagination.
+    def self.pagination_opts(params, opts = {})
+      opts = {
+        :max_offset => 10000,
+        :max_limit => 100
+      }.merge opts
+      
+      # Pagination
+      offset = offset_param( params, opts[:max_offset] )
+      limit = limit_param( params, opts[:max_limit] )
+      
+      # Sort order
+      order = order_param( params )
+      
+      {
+        :order => [order],
+        :offset => offset,
+        :limit => limit
+      }
+    end
+    
+    # Given Ext.js params hash, returns a Datamapper sort param
+    def self.order_param( params )
+      sort = case params["sort"]
+        when "created_at"
+          :id
+        else
+          params["sort"] ? params["sort"].to_sym : :id
+      end
+      params["dir"] =~ /desc/i ? sort.desc : sort.asc
+    end
+    
+    # Given Ext.js params hash, returns a Datamapper offset param
+    def self.offset_param( params, max_offset )
+      [( params["start"] && params["start"].to_i ) || 0, max_offset].min
+    end
+    
+    # Given Ext.js params hash, returns a Datamapper limit param
+    def self.limit_param( params, max_limit )
+      [( params["limit"] && params["limit"].to_i ) || 25, max_limit].min
+    end
+    
+    # Filtering
+    
+    def self.allowed_filters
+      []
+    end
+    
+    def self.get_filter_data( params )
+      return unless params["filter"] && params["filter"]["0"]
+      if allowed_filters.include?( params["filter"]["0"]["field"] )
+        {
+          :field => params["filter"]["0"]["field"],
+          :values => Array( params["filter"]["0"]["data"]["value"] )
+        }
+      end
+    end
+  end
+  
+  class Mongo
+    MAX_PER_PAGE = 1000
+    DEFAULT_PAGE = 1
+    DEFAULT_PER_PAGE = 30
+    
+    def self.db_opts( params )
+      opts = {}
+      
+      opts.merge! page_param( params )
+      opts.merge! per_page_param( params )
+      opts.merge! sort_param( params )
+      opts.merge! search_param( params )
+      
+      opts
+    end
+    
+    protected
+    
+    def self.allowed_filters
+      []
+    end
+    
+    def self.page_param( params )
+      return { :page => DEFAULT_PAGE } unless params.key?( "start" ) && params.key?( "limit" )
+      
+      start = params["start"].to_i
+      limit = per_page_param( params )[:per_page]
+      
+      { :page => ( start / limit ) + 1 }
+    end
+    
+    def self.per_page_param( params )
+      unless params.key?( "limit" ) && params["limit"].to_i > 0
+        return { :per_page => DEFAULT_PER_PAGE }
+      end
+      { :per_page => [params["limit"].to_i, MAX_PER_PAGE].min }
+    end
+    
+    def self.sort_param( params )
+      return {} unless params.key?( "sort" )
+      
+      sort = params["sort"] ? params["sort"].to_sym : :id
+      sort = params["dir"] =~ /desc/i ? sort.desc : sort.asc
+      
+      { :sort => sort }
+    end
+    
+    def self.search_param( params )
+      if params["filter"] && params["filter"]["0"]
+        field = params["filter"]["0"]["field"].gsub(/[^\.\w\d_-]/, "").strip
+        values = Array( params["filter"]["0"]["data"]["value"] )
+        
+        if values.size == 1
+          values = values[0]
+        else
+          values = { "$in" => values }
+        end
+        
+        unless field.blank? || !allowed_filters.include?( field ) || values.blank?
+          return { field => values }
+        end
+      end
+      {}
+    end
+  end
+end

data/ruby-ext-js.gemspec

@@ -0,0 +1,57 @@
+# 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{ruby-ext-js}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Tyson Tate"]
+  s.date = %q{2011-01-20}
+  s.description = %q{Ultra-basic classes for working with Ext.js requests and translating them to DataMapper / Mongood query opts.}
+  s.email = %q{tyson@doloreslabs.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.markdown"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "LICENSE.txt",
+    "README.markdown",
+    "Rakefile",
+    "VERSION",
+    "lib/ruby-ext-js.rb",
+    "ruby-ext-js.gemspec",
+    "spec/ruby-ext-js_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/help/ruby-ext-js}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Ultra-basic classes for working with Ext.js requests and translating them to DataMapper / Mongood query opts.}
+  s.test_files = [
+    "spec/ruby-ext-js_spec.rb",
+    "spec/spec_helper.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<rspec>, ["~> 1.3.1"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 1.3.1"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 1.3.1"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+  end
+end
+

data/spec/ruby-ext-js_spec.rb

@@ -0,0 +1,22 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "ExtJs" do
+  describe "Postgres" do
+    it "sorts on id when you ask it to sort on created_at" do
+      ExtJs::Postgres.pagination_opts({
+        :sort => "created_at",
+        :order => "desc"
+      })[:order].should == [:id.asc]
+    end
+    
+    it "specs the rest of the class or it gets the hose" do
+      pending "The current spec suite is currently rigidly tied to private models. Someday we'll write a generic spec suite here."
+    end
+  end
+  
+  describe "Mongo" do
+    it "specs the rest of the class or it gets the hose" do
+      pending "The current spec suite is currently rigidly tied to private models. Someday we'll write a generic spec suite here."
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'spec'
+require 'ruby-ext-js'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification 
+name: ruby-ext-js
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Tyson Tate
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-20 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 1
+        - 3
+        - 1
+        version: 1.3.1
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  type: :development
+  version_requirements: *id002
+description: Ultra-basic classes for working with Ext.js requests and translating them to DataMapper / Mongood query opts.
+email: tyson@doloreslabs.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.markdown
+files: 
+- .document
+- .rspec
+- LICENSE.txt
+- README.markdown
+- Rakefile
+- VERSION
+- lib/ruby-ext-js.rb
+- ruby-ext-js.gemspec
+- spec/ruby-ext-js_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/help/ruby-ext-js
+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: Ultra-basic classes for working with Ext.js requests and translating them to DataMapper / Mongood query opts.
+test_files: 
+- spec/ruby-ext-js_spec.rb
+- spec/spec_helper.rb