compass-jquery-plugin 0.3.0.0 → 0.3.1.beta.2

data/gem_tasks/mobile.rake

@@ -0,0 +1,156 @@
+require 'fileutils'
+require 'lib/handle_js_files'
+require 'lib/jquery_mobile_theme'
+
+MOBILE_SRC = File.join(GEM_ROOT, 'src', 'mobile')
+MOBILE_SRC_IMAGES = File.join(MOBILE_SRC, 'images')
+MOBILE_SRC_THEMES = File.join(MOBILE_SRC, 'themes')
+
+MOBILE_DEST_TEMPLATES = File.join(GEM_ROOT, 'templates', 'mobile')
+MOBILE_DEST_THEMES = File.join(MOBILE_DEST_TEMPLATES, 'jquery', 'mobile')
+MOBILE_DEST_IMAGES = File.join(MOBILE_DEST_THEMES)
+
+all_scripts = [
+  'js/jquery.ui.widget.js',
+  'js/jquery.mobile.widget.js',
+  'js/jquery.mobile.media.js',
+  'js/jquery.mobile.support.js',
+  'js/jquery.mobile.event.js',
+  'js/jquery.mobile.hashchange.js',
+  'js/jquery.mobile.core.js',
+  'js/jquery.mobile.navigation.js',
+  'js/jquery.mobile.page.js',
+  'js/jquery.ui.position.js',
+  'js/jquery.mobile.fixHeaderFooter.js',
+  'js/jquery.mobile.forms.checkboxradio.js',
+  'js/jquery.mobile.forms.textinput.js',
+  'js/jquery.mobile.forms.select.js',
+  'js/jquery.mobile.buttonMarkup.js',
+  'js/jquery.mobile.forms.button.js',
+  'js/jquery.mobile.forms.slider.js',
+  'js/jquery.mobile.collapsible.js',
+  'js/jquery.mobile.controlGroup.js',
+  'js/jquery.mobile.fieldContain.js',
+  'js/jquery.mobile.listview.js',
+  'js/jquery.mobile.listview.filter.js',
+  'js/jquery.mobile.dialog.js',
+  'js/jquery.mobile.navbar.js',
+  'js/jquery.mobile.grid.js',
+  'js/jquery.mobile.themeswitcher.js'
+].collect {|filename| File.read(File.join(MOBILE_SRC, filename))}.join "\n\n"
+
+namespace :build do
+  desc 'Build the stylesheets and templates for jquery.mobile.'
+  task :mobile do
+
+    FileUtils.remove_dir MOBILE_DEST_TEMPLATES if File.exists? MOBILE_DEST_TEMPLATES
+    FileUtils.mkdir_p(File.join(MOBILE_DEST_TEMPLATES, 'config', 'initializers'))
+    FileUtils.mkdir_p(File.join(MOBILE_DEST_TEMPLATES, 'lib', 'tasks'))
+
+    open File.join(MOBILE_DEST_TEMPLATES, 'manifest.rb'), 'w' do |manifest|
+      manifest.print MOBILE_MESSAGE1
+
+      open File.join(MOBILE_DEST_TEMPLATES, 'config', 'initializers', 'mobile.rb'), 'w' do |f|
+        f.print(File.read(File.join(MOBILE_SRC, 'config', 'initializers', 'mobile.rb')))
+      end
+      manifest.print "file 'config/initializers/mobile.rb'\n"
+      
+      open File.join(MOBILE_DEST_TEMPLATES, 'lib', 'tasks', 'jquery.mobile.rake'), 'w' do |f|
+        f.print(File.read(File.join(MOBILE_SRC, 'lib', 'tasks', 'jquery.mobile.rake')))
+      end
+      manifest.print "file 'lib/tasks/jquery.mobile.rake'\n"
+
+      #JavaScripts
+
+      open File.join(MOBILE_DEST_TEMPLATES, 'jquery.mobile.js'), 'w' do |f|
+        f.print concat_files(all_scripts)
+      end
+      manifest.print "javascript 'jquery.mobile.js'\n"
+
+      open File.join(MOBILE_DEST_TEMPLATES, 'jquery.mobile.min.js'), 'w' do |f|
+        f.print compress_js(all_scripts, "yui")
+      end
+      manifest.print "javascript 'jquery.mobile.min.js'\n"
+
+      # jQuery Mobile Themes      
+      mobile = JqueryMobileTheme.new(File.join(MOBILE_SRC_THEMES, 'default')) 
+
+      base_stylesheets = [
+        'jquery.mobile.core.css',
+        'jquery.mobile.button.css',
+        'jquery.mobile.collapsible.css',
+        'jquery.mobile.controlgroup.css',
+        'jquery.mobile.dialog.css',
+        'jquery.mobile.forms.checkboxradio.css',
+        'jquery.mobile.forms.fieldcontain.css',
+        'jquery.mobile.forms.select.css',
+        'jquery.mobile.forms.slider.css',
+        'jquery.mobile.forms.textinput.css',
+        'jquery.mobile.grids.css',
+        'jquery.mobile.headerfooter.css',
+        'jquery.mobile.listview.css',
+        'jquery.mobile.navbar.css',
+        'jquery.mobile.transitions.css'
+        ].collect {|filename| File.read(File.join(MOBILE_SRC_THEMES, 'default', filename))}.join "\n\n"
+
+      FileUtils.mkdir_p(MOBILE_DEST_THEMES)
+      open File.join(MOBILE_DEST_THEMES, '_base.scss'), 'w' do |f|
+        sass = MOBILE_MESSAGE2
+        IO.popen("sass-convert -F css -T scss", 'r+') { |ff| ff.print(base_stylesheets); ff.close_write; sass += ff.read }
+        f.print sass
+      end
+      manifest.print "stylesheet 'jquery/mobile/_base.scss'\n"
+
+      Dir.foreach MOBILE_SRC_THEMES do |theme|
+        next if /^\./ =~ theme
+        mobile.convert_theme(theme, File.join(MOBILE_SRC_THEMES, theme), File.join(MOBILE_DEST_THEMES))
+        manifest.print "stylesheet 'jquery/mobile/#{theme}.scss'\n"
+        
+        # Copy the theme images directory
+        src_dir = File.join(MOBILE_SRC_THEMES, theme, 'images')
+        dest_dir = File.join(MOBILE_DEST_IMAGES, theme)
+        FileUtils.mkdir_p dest_dir
+
+        Dir.foreach(src_dir) do |image|
+          next if /^\./ =~ image
+          FileUtils.cp(File.join(src_dir, image), dest_dir)
+          manifest.print "image 'jquery/mobile/#{theme}/#{image}'\n"
+        end
+      end
+      
+      # glyphish Images
+      FileUtils.mkdir_p(File.join(MOBILE_DEST_TEMPLATES, 'glyphish', 'icons-black'))
+      src_dir = File.join(MOBILE_SRC_IMAGES, 'glyphish', 'icons-black')
+      dest_dir = File.join(MOBILE_DEST_TEMPLATES, 'glyphish', 'icons-black')
+      Dir.foreach(src_dir) do |image|
+        next if /^\./ =~ image
+        FileUtils.cp(File.join(src_dir, image), dest_dir)
+        manifest.print "image 'glyphish/icons-black/#{image}'\n"
+      end
+      
+      FileUtils.mkdir_p(File.join(MOBILE_DEST_TEMPLATES, 'glyphish', 'icons-white'))
+      src_dir = File.join(MOBILE_SRC_IMAGES, 'glyphish', 'icons-white')
+      dest_dir = File.join(MOBILE_DEST_TEMPLATES, 'glyphish', 'icons-white')
+      Dir.foreach(src_dir) do |image|
+        next if /^\./ =~ image
+        FileUtils.cp(File.join(src_dir, image), dest_dir)
+        manifest.print "image 'glyphish/icons-white/#{image}'\n"
+      end
+      
+      FileUtils.mkdir_p(File.join(MOBILE_DEST_TEMPLATES, 'glyphish', 'mini-icons-black'))
+      src_dir = File.join(MOBILE_SRC_IMAGES, 'glyphish', 'mini-icons-black')
+      dest_dir = File.join(MOBILE_DEST_TEMPLATES, 'glyphish', 'mini-icons-black')
+      Dir.foreach(src_dir) do |image|
+        next if /^\./ =~ image
+        FileUtils.cp(File.join(src_dir, image), dest_dir)
+        manifest.print "image 'glyphish/mini-icons-black/#{image}'\n"
+      end 
+      
+      open File.join(MOBILE_DEST_TEMPLATES, 'glyphish', 'Read me first - license.txt'), 'w' do |f|
+        f.print(File.read(File.join(MOBILE_SRC_IMAGES, 'glyphish', 'Read me first - license.txt')))
+      end
+      manifest.print "image 'glyphish/Read me first - license.txt'\n"
+
+    end
+  end
+end

data/gem_tasks/rubygems.rake

@@ -6,9 +6,13 @@ namespace :build do
     "build:tools",
     "build:dynatree",
     "build:jstree",
+    "build:jqgrid",
+    "build:secret_sauce",
     "build:ribbon",
     "build:ical",
     "build:jqtouch",
-    "build:emulators"] do
+    "build:mobile",
+    "build:emulators"
+  ] do
   end
 end

data/gem_tasks/secret_sauce.rake

@@ -0,0 +1,64 @@
+require 'fileutils'
+require 'lib/handle_js_files'
+
+# Compass generator for jqGrid 3.5+
+SECRET_SAUCE_SRC         = File.join(GEM_ROOT, 'src', 'secret_sauce')
+SECRET_SAUCE_SRC_SCRIPTS = SECRET_SAUCE_SRC + "/*.js"
+
+SECRET_SAUCE_DEST_TEMPLATES   = File.join(GEM_ROOT, 'templates', 'secret_sauce')
+SECRET_SAUCE_DEST_STYLESHEETS = File.join(SECRET_SAUCE_DEST_TEMPLATES, 'jquery')
+SECRET_SAUCE_DEST_CONFIG      = File.join(SECRET_SAUCE_DEST_TEMPLATES, 'config', 'initializers') 
+SECRET_SAUCE_DEST_VIEWS       = File.join(SECRET_SAUCE_DEST_TEMPLATES, 'app', 'views', 'shared')
+
+SECRET_SAUCE_MESSAGE1 = "# Generated by compass-jquery-plugin/gem-tasks/secret_sauce.rake\n# Install with: compass install jquery/secret_sauce\n\n"
+SECRET_SAUCE_MESSAGE2 = "// Generated by compass-jquery-pluginy/gem-tasks/secret_sauce.rake\n\n"
+
+namespace :build do
+  desc 'Build the stylesheets and templates for jqGrid.'
+  task :secret_sauce do
+    
+    FileUtils.remove_dir(SECRET_SAUCE_DEST_TEMPLATES) if File.exists? SECRET_SAUCE_DEST_TEMPLATES 
+    FileUtils.mkdir_p(SECRET_SAUCE_DEST_CONFIG)
+    FileUtils.mkdir_p(SECRET_SAUCE_DEST_VIEWS)
+    
+    open File.join(SECRET_SAUCE_DEST_TEMPLATES, 'manifest.rb'), 'w' do |manifest|
+      manifest.print SECRET_SAUCE_MESSAGE1
+    
+      Dir.foreach File.join(SECRET_SAUCE_SRC, 'app', 'views', 'shared') do |file|
+        next unless /\.haml$/ =~ file
+        html = File.read File.join(SECRET_SAUCE_SRC, 'app', 'views', 'shared', file)
+        open File.join(SECRET_SAUCE_DEST_VIEWS, file), 'w' do |f|
+          f.print(html)
+        end
+        manifest.print "file 'app/views/shared/#{file}'\n"
+      end      
+    
+      open File.join(SECRET_SAUCE_DEST_TEMPLATES, 'config', 'initializers', 'secret_sauce.rb'), 'w' do |f|
+        f.print(File.read(File.join(SECRET_SAUCE_SRC, 'config', 'initializers', 'secret_sauce.rb')))
+      end
+      manifest.print "file 'config/initializers/secret_sauce.rb'\n"  
+    
+      open File.join(SECRET_SAUCE_DEST_TEMPLATES, 'secret_sauce.js'), 'w' do |f|
+        f.print concat_files(all_files(SECRET_SAUCE_SRC_SCRIPTS))
+      end
+      manifest.print "javascript 'secret_sauce.js'\n"
+    
+      open File.join(SECRET_SAUCE_DEST_TEMPLATES, 'secret_sauce.min.js'), 'w' do |f|
+        f.print compress_js(all_files(SECRET_SAUCE_SRC_SCRIPTS), "google")
+      end
+      manifest.print "javascript 'secret_sauce.min.js'\n"
+    
+      FileUtils.mkdir_p(SECRET_SAUCE_DEST_STYLESHEETS)
+      Dir.foreach File.join(SECRET_SAUCE_SRC, 'css') do |file|
+        next unless /\.css$/ =~ file
+        css = File.read File.join(SECRET_SAUCE_SRC, 'css', file)
+        sass = ''
+        IO.popen("sass-convert -F css -T scss", 'r+') { |f| f.print(css); f.close_write; sass = f.read }
+        open(File.join(SECRET_SAUCE_DEST_STYLESHEETS, file.gsub(/\.css$/,'.scss')), 'w') do |f|
+          f.write SECRET_SAUCE_MESSAGE2 + sass
+        end
+        manifest.print "stylesheet 'jquery/#{file.gsub(/\.css$/,'.scss')}'\n"
+      end      
+    end
+  end
+end

data/lib/jquery/gridify.rb

@@ -0,0 +1,42 @@
+require 'jquery/gridify/grid'
+
+module Gridify
+
+	def self.included(base)
+		base.extend(ClassMethods)
+	end
+
+	module ClassMethods
+		attr_accessor :grids
+
+		def gridify(*args, &block)
+			# debugger
+			grid = Gridify::Grid.new( self, *args, &block)
+			@grids ||= {}
+			@grids[grid.name.to_sym] = grid
+
+			unless self.respond_to?(:find_for_grid)
+				class_eval <<-EOV
+						named_scope :find_for_grid, lambda {|name, params|
+							grid = grids[name]
+							grid.update_from_params( params )
+							grid.current_scope
+						}
+				EOV
+			end
+		end
+
+		def grids
+			@grids || {}
+		end
+
+		def grid(name=nil)
+			name ? grids[name] : grids[:grid]
+		end
+	end
+end
+
+class ActiveRecord::Base
+	include Gridify
+end
+

data/lib/jquery/gridify/assertions.rb

@@ -0,0 +1,37 @@
+# lifted from state_machine plugin
+module Gridify
+  # Provides a set of helper methods for making assertions about the content
+  # of various objects
+  module Assertions
+    # Validates that the given hash *only* includes the specified valid keys.
+    # If any invalid keys are found, an ArgumentError will be raised.
+    #
+    # == Examples
+    # 
+    #   options = {:name => 'John Smith', :age => 30}
+    #   
+    #   assert_valid_keys(options, :name)           # => ArgumentError: Invalid key(s): age
+    #   assert_valid_keys(options, 'name', 'age')   # => ArgumentError: Invalid key(s): age, name
+    #   assert_valid_keys(options, :name, :age)     # => nil
+    def assert_valid_keys(hash, *valid_keys)
+      invalid_keys = hash.keys - valid_keys
+      raise ArgumentError, "Invalid key(s): #{invalid_keys.join(', ')}" unless invalid_keys.empty?
+    end
+    
+    # Validates that the given hash only includes at *most* one of a set of
+    # exclusive keys.  If more than one key is found, an ArgumentError will be
+    # raised.
+    # 
+    # == Examples
+    # 
+    #   options = {:only => :on, :except => :off}
+    #   assert_exclusive_keys(options, :only)                   # => nil
+    #   assert_exclusive_keys(options, :except)                 # => nil
+    #   assert_exclusive_keys(options, :only, :except)          # => ArgumentError: Conflicting keys: only, except
+    #   assert_exclusive_keys(options, :only, :except, :with)   # => ArgumentError: Conflicting keys: only, except
+    def assert_exclusive_keys(hash, *exclusive_keys)
+      conflicting_keys = exclusive_keys & hash.keys
+      raise ArgumentError, "Conflicting keys: #{conflicting_keys.join(', ')}" unless conflicting_keys.length <= 1
+    end
+  end
+end

data/lib/jquery/gridify/grid.rb

@@ -0,0 +1,210 @@
+require 'jquery/gridify/assertions'
+require 'jquery/gridify/grid_options'
+require 'jquery/gridify/grid_view'
+require 'jquery/gridify/grid_column'
+require 'jquery/gridify/grid_finder'
+
+# NOTE: for readablity/clarity, native jqGrid options should be string; Ruby ones as syms
+
+module Gridify
+  class Grid
+    include Assertions
+
+    # todo: change this so klass is optional, decouple from active record
+    def initialize( klass, *args, &block )
+      #debugger
+      options = args.extract_options! # => args.last.is_a?(Hash) ? args.pop : {}
+      assert_exclusive_keys( options, :only, :except)
+      
+      @resource = klass.to_s.tableize.pluralize
+      @name = args.first || :grid
+      
+      # non-persistent options
+      # generate model unless explicitly say no
+      build_model = options.delete(:build_model) == false ? false : true
+      only = options.delete(:only)
+      except = options.delete(:except)
+      col_presets = options.delete(:colModel)
+      col_include = options[:colInclude]
+      
+      # assign options
+      update options
+      
+      # build columns from ActiveRecord model (klass)
+      if klass.present? && build_model
+        @model = build_columns(klass, only, except, col_presets, col_include)
+      end
+      
+      instance_eval(&block) if block
+      #(note instance_eval cannot access things outside its scope; otherwise do this:
+      #yield self if block_given?
+    end
+    
+    def update( options )
+      options.each {|atr, val| send( "#{atr}=", val )}
+      # exception "invalid option..."
+    end
+
+    def column( name, options={} )
+      name = name.to_s
+      klass = resource.classify.constantize
+      # TODO: set edit options based on ar_column 
+      # TODO: edit
+      # TODO: handle file input types
+      # TODO: custom input types 
+      if col = columns_hash[name]
+        # update an existing column
+        col.update options
+        
+      elsif ar = klass.columns.detect {|c| c.name==name}
+        #debugger
+        # create column from database schema
+        edit = editable && 
+          # only edit accessible attributes
+          (klass.accessible_attributes.nil? || klass.accessible_attributes.include?(ar.name))
+        args = {
+          :ar_column => ar,
+          :name => ar.name,
+          :value_type => ar.type,
+          :searchable => searchable,
+          :sortable => sortable,
+          :editable => edit
+        }.merge(options)
+        colModel << GridColumn.new( args)
+        
+      else
+        # create column from scratch
+        args = {
+          :name => name,
+          :value_type => :string,
+          :searchable => searchable,
+          :sortable => sortable,
+          :editable => edit
+        }.merge(options)
+        colModel << GridColumn.new( args)
+      end
+    end
+  
+    def column_names
+      colModel.collect {|col| col.name.titleize }
+    end
+    
+    def column_model
+      colModel.collect {|col| col.properties }
+    end
+    
+    # normally we need to keep columns an ordered array, sometimes its convenient to have a hash
+    def columns_hash
+      colModel.inject({}) {|h, col| h[col.name] = col; h }
+    end
+    
+    protected
+    
+    # # isnt there something in rails to do this already?
+    # def parse_options( keys, options )
+    #   ops = keys.inject({}) do |h, k| 
+    #     val = options.delete(k) 
+    #     h[k] = val unless val.nil?
+    #     h
+    #   end
+    #   ops || {}
+    # end
+
+    # generate list of columns based on AR model
+    # option:  :only or :except
+    #          :col_options  hash of hash of preset values for columns (eg from cookie) { :title => {:width => 98}}
+    def build_columns( klass, only, except, presets, col_include )
+      #debugger
+      # stringify
+      only = Array(only).map {|s| s.to_s }
+      except = Array(except).map {|s| s.to_s }
+      presets ||= []
+      
+      if presets.length > 0
+        hashed_defs = {}
+        
+        klass.columns.collect do |ar|
+          #debugger
+          next if only.present? && !only.include?(ar.name)
+          next if except.present? && except.include?(ar.name)
+          hashed_defs[ar.name] = strct2args(klass, ar)
+        end.compact
+        
+        if col_include
+            col_include.each do |sub_model|
+            my_model = sub_model.to_s
+            if klass.inheritable_attributes[:reflections][sub_model].options[:class_name]
+              my_class = klass.inheritable_attributes[:reflections][sub_model].options[:class_name].to_s
+              model = klass.inheritable_attributes[:reflections][sub_model].options[:class_name].to_s
+            else
+              my_class = my_model
+            end
+            Object.const_get(my_class.capitalize).columns.collect do |ar|
+              #debugger
+              next if only.present? && !only.include?("#{my_model}.#{ar.name}")
+              next if except.present? && except.include?("#{my_model}.#{ar.name}")
+              hashed_defs["#{my_model}.#{ar.name}"] = strct2args(klass, ar)
+            end
+          end
+        end
+
+        # Take sequence from colModel
+        self.colModel = []
+        presets.each do |col|
+          # create column with default args merged with options given for this column
+          willi = hashed_defs[col[:name]]
+          self.colModel << GridColumn.new(hashed_defs[col[:name]].merge(col))
+        end
+      else
+        # Take sequence from database definition
+        self.colModel = klass.columns.collect do |ar|
+          #debugger
+          next if only.present? && !only.include?(ar.name)
+          next if except.present? && except.include?(ar.name)
+          args = strct2args(klass, ar)
+          # create column with default args merged with options given for this column
+          GridColumn.new(args)
+        end.compact
+        
+        if col_include
+          col_include.each do |sub_model|
+            my_model = sub_model.to_s
+            if klass.inheritable_attributes[:reflections][sub_model].options[:class_name]
+              my_class = klass.inheritable_attributes[:reflections][sub_model].options[:class_name].to_s
+              model = klass.inheritable_attributes[:reflections][sub_model].options[:class_name].to_s
+            else
+              my_class = my_model
+            end
+            Object.const_get(my_class.capitalize).columns.collect do |ar|
+              #debugger
+              next if only.present? && !only.include?("#{my_model}.#{ar.name}")
+              next if except.present? && except.include?("#{my_model}.#{ar.name}")
+              args = strct2args(klass, ar, "#{my_model}.")
+              # create column with default args merged with options given for this column
+              self.colModel << GridColumn.new(args)
+            end
+          end
+        end
+      end
+    end
+    
+    private
+  
+      def strct2args(my_class, record, prefix="")
+        is_key = (record.name=='id')
+        edit = editable && !is_key && 
+          # only edit accessible attributes
+          (my_class.accessible_attributes.nil? || my_class.accessible_attributes.include?(record.name))
+        args = {
+          :ar_column => record,
+          :name => "#{prefix}#{record.name}",
+          :value_type => record.type,
+          :key => is_key,
+          #:hidden => is_key,
+          :searchable => searchable,
+          :sortable => sortable,
+          :editable => edit
+        }
+      end
+  end
+end