skozlov-netzke_basepack 0.1.0

data/CHANGELOG

@@ -0,0 +1 @@
+v0.1.0 Initial release

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Sergei Kozlov
+
+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/Manifest

@@ -0,0 +1,64 @@
+CHANGELOG
+generators/netzke_basepack/netzke_basepack_generator.rb
+generators/netzke_basepack/netzke_grid_generator.rb
+generators/netzke_basepack/templates/create_netzke_grid_columns.rb
+generators/netzke_basepack/USAGE
+init.rb
+install.rb
+javascripts/basepack.js
+lib/app/models/netzke_grid_column.rb
+lib/netzke/accordion.rb
+lib/netzke/ar_ext.rb
+lib/netzke/column.rb
+lib/netzke/container.rb
+lib/netzke/grid.rb
+lib/netzke/grid_interface.rb
+lib/netzke/grid_js_builder.rb
+lib/netzke/preference_grid.rb
+lib/netzke/properties_tool.rb
+lib/netzke/property_grid.rb
+lib/netzke_basepack.rb
+LICENSE
+Manifest
+netzke_basepack.gemspec
+Rakefile
+README.mdown
+tasks/netzke_basepack_tasks.rake
+test/app_root/app/controllers/application.rb
+test/app_root/app/models/book.rb
+test/app_root/app/models/category.rb
+test/app_root/app/models/city.rb
+test/app_root/app/models/continent.rb
+test/app_root/app/models/country.rb
+test/app_root/app/models/genre.rb
+test/app_root/config/boot.rb
+test/app_root/config/database.yml
+test/app_root/config/environment.rb
+test/app_root/config/environments/in_memory.rb
+test/app_root/config/environments/mysql.rb
+test/app_root/config/environments/postgresql.rb
+test/app_root/config/environments/sqlite.rb
+test/app_root/config/environments/sqlite3.rb
+test/app_root/config/routes.rb
+test/app_root/db/migrate/20081222033343_create_books.rb
+test/app_root/db/migrate/20081222033440_create_genres.rb
+test/app_root/db/migrate/20081222035855_create_netzke_preferences.rb
+test/app_root/db/migrate/20081223024935_create_categories.rb
+test/app_root/db/migrate/20081223025635_create_countries.rb
+test/app_root/db/migrate/20081223025653_create_continents.rb
+test/app_root/db/migrate/20081223025732_create_cities.rb
+test/app_root/script/console
+test/ar_ext_test.rb
+test/column_test.rb
+test/console_with_fixtures.rb
+test/fixtures/books.yml
+test/fixtures/categories.yml
+test/fixtures/cities.yml
+test/fixtures/continents.yml
+test/fixtures/countries.yml
+test/fixtures/genres.yml
+test/grid_test.rb
+test/netzke_basepack_test.rb
+test/schema.rb
+test/test_helper.rb
+uninstall.rb

data/README.mdown

@@ -0,0 +1,18 @@
+NetzkeBasepack
+==============
+
+Introduction goes here.
+
+
+Example
+=======
+
+Example goes here.
+
+
+Credentials
+===========
+
+Testing with the help of http://github.com/pluginaweek/plugin_test_helper
+
+Copyright (c) 2008 Sergei Kozlov, released under the MIT license

data/Rakefile

@@ -0,0 +1,11 @@
+require 'echoe'
+
+Echoe.new("netzke_basepack") do |p|
+  p.author = "Sergei Kozlov"
+  p.email = "sergei@writelesscode.com"
+  p.summary = "Base Netzke widgets - grid, form, tree, and more"
+  p.url = "http://writelesscode.com"
+  p.runtime_dependencies = ["searchlogic >=1.6.2", "netzke_core >= 0.1.0"]
+  p.development_dependencies = []
+  p.test_pattern = 'test/**/*_test.rb'
+end

data/generators/netzke_basepack/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    ./script/generate netzke_basepack Thing
+
+    This will create:
+        what/will/it/create

data/generators/netzke_basepack/netzke_basepack_generator.rb

@@ -0,0 +1,8 @@
+class NetzkeBasepackGenerator < Rails::Generator::NamedBase
+  def manifest
+    record do |m|
+      # m.directory "lib"
+      # m.template 'README', "README"
+    end
+  end
+end

data/generators/netzke_basepack/netzke_grid_generator.rb

@@ -0,0 +1,7 @@
+class NetzkeGridGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      m.migration_template 'create_netzke_grid_columns.rb', "db/migrate", {:migration_file_name => "create_netzke_grid_columns"}
+    end
+  end
+end

data/generators/netzke_basepack/templates/create_netzke_grid_columns.rb

@@ -0,0 +1,21 @@
+class CreateNetzkeGridColumns < ActiveRecord::Migration
+  def self.up
+    create_table :netzke_grid_columns do |t|
+      t.string    :name
+      t.string    :label
+      t.boolean   :read_only
+      t.integer   :position
+      t.boolean   :hidden
+      t.integer   :width
+      t.string    :shows_as, :limit => 32
+
+      t.integer   :layout_id
+      
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :netzke_grid_columns
+  end
+end

data/init.rb

@@ -0,0 +1,2 @@
+# Include hook code here
+require 'netzke_basepack'

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/javascripts/basepack.js

@@ -0,0 +1,41 @@
+// Editors for grid cells and form fields
+Ext.netzke.editors = {
+	combo_box: function(c, config){
+		var row = Ext.data.Record.create([{name:'id'}])
+    var store = new Ext.data.Store({
+      proxy: new Ext.data.HttpProxy({url:config.interface.getCbChoices, jsonData:{column:c.name}}),
+      reader: new Ext.data.ArrayReader({root:'data', id:0}, row)
+    })
+    return new Ext.form.ComboBox({
+      mode: 'remote',
+      displayField:'id',
+			valueField:'id',
+			triggerAction:'all',
+      store: store
+    })
+	},
+
+	text_field: function(c, config){
+		return new Ext.form.TextField({
+			selectOnFocus:true
+		})
+	},
+	
+	checkbox: function(c, config){
+		return new Ext.form.TextField({
+			selectOnFocus:true
+		})
+	},
+	
+	number_field: function(c, config){
+		return new Ext.form.NumberField({
+			selectOnFocus:true
+		})
+	},
+	
+	datetime: function(c, config){
+		return new Ext.form.TextField({
+			selectOnFocus:true
+		})
+	}
+}

data/lib/app/models/netzke_grid_column.rb

@@ -0,0 +1,23 @@
+class NetzkeGridColumn < ActiveRecord::Base
+  belongs_to :layout, :class_name => "NetzkeLayout"
+  
+  acts_as_list :scope => :layout
+
+  # old?
+  # def self.create_with_defaults(column_config, klass)
+  #   create(klass.default_column_config(column_config).stringify_values!)
+  # end
+  
+  def self.create_layout_for_widget(widget)
+    layout = NetzkeLayout.create(:widget_name => widget.id_name, :items_class => self.name, :user_id => NetzkeLayout.user_id)
+
+    columns = Netzke::Column.default_columns_for_widget(widget)
+
+    for c in columns
+      config_for_create = c.merge(:layout_id => layout.id).stringify_values!
+      create(config_for_create)
+    end
+    
+    layout
+  end
+end

data/lib/netzke/accordion.rb

@@ -0,0 +1,11 @@
+module Netzke
+  class Accordion < Container
+
+    def js_default_config
+      super.merge({
+        :layout => 'accordion'
+      })
+    end
+    
+  end
+end

data/lib/netzke/ar_ext.rb

@@ -0,0 +1,163 @@
+module Netzke
+  module ActiveRecordExtensions
+    def self.included(base)
+      base.extend ActiveRecordClassMethods
+    end
+
+    #
+    # Allow nested association acces (assocs separated by "." or "__"), e.g.: proxy_service.send('asset__gui_folder__name')
+    # Example:
+    # b = Book.first
+    # b.genre__name = 'Fantasy' => b.genre = Genre.find_by_name('Fantasy')
+    # NOT IMPLEMENTED: ANY USE? b.genre__catalog__name = 'Best sellers' => b.genre_id = b.genre.find_by_catalog_id(Catalog.find_by_name('Best sellers')).id
+    #
+    
+    def method_missing(method, *args, &block)
+      # if refering to a column, just pass it to the originar method_missing
+      return super if self.class.column_names.include?(method.to_s)
+      
+      split = method.to_s.split(/\.|__/)
+      if split.size > 1
+        if split.last =~ /=$/ 
+          if split.size == 2
+            # search for association and assign it to self
+            assoc = self.class.reflect_on_association(split.first.to_sym)
+            assoc_method = split.last.chop
+            if assoc
+              assoc_instance = assoc.klass.send("find_by_#{assoc_method}", *args)
+              raise ArgumentError, "Couldn't find association #{split.first} by #{assoc_method} '#{args.first}'" unless assoc_instance
+              self.send("#{split.first}=", assoc_instance)
+            else
+              super
+            end
+          else
+            super
+          end
+        else
+          res = self
+          split.each do |m|
+            if res.respond_to?(m)
+              res = res.send(m) unless res.nil?
+            else
+              res.nil? ? nil : super
+            end
+          end
+          res
+        end
+      else
+        super
+      end
+    end
+    
+    
+    module ActiveRecordClassMethods
+      def choices_for(column, query = nil)
+        if respond_to?("#{column}_choices", query)
+          # AR class provides the choices itself
+          send("#{column}_choices")
+        else
+          if (assoc_name, *assoc_method = column.split('__')).size > 1
+            # column is an association column
+            assoc_method = assoc_method.join('__') # in case we get something like country__continent__name
+            association = reflect_on_association(assoc_name.to_sym) || raise(NameError, "Association #{assoc_name} not known for class #{name}")
+            association.klass.choices_for(assoc_method, query)
+          else
+            column = assoc_name
+            if self.column_names.include?(column)
+              # it's just a column
+              records = query.nil? ? find_by_sql("select distinct #{column} from #{table_name}") : find_by_sql("select distinct #{column} from #{table_name} where #{column} like '#{query}%'")
+              records.map{|r| r.send(column)}
+            else
+              # it's a "virtual" column - the least effective search
+              records = self.find(:all).map{|r| r.send(column)}.uniq
+              query.nil? ? records : records.select{|r| r.send(column).index(/^#{query}/)}
+            end
+          end
+        end
+      end
+      
+      # which columns are to be picked up by grids and forms
+      def expose_columns(columns, *args)
+        if columns == :all
+          write_inheritable_attribute(:exposed_columns, self.column_names.map(&:to_sym))
+        else
+          write_inheritable_attribute(:exposed_columns, columns)
+        end
+      end
+      
+      def exposed_columns
+        read_inheritable_attribute(:exposed_columns) || write_inheritable_attribute(:exposed_columns, expose_columns(:all) + virtual_columns)
+      end
+      
+      # virtual "columns" that simply correspond to instance methods of an ActiveRecord class
+      def virtual_column(config)
+        if config.is_a?(Symbol) 
+          config = {:name => config}
+        else
+          config = {:name => config.keys.first}.merge(config.values.first)
+        end
+        write_inheritable_attribute(:virtual_columns, (read_inheritable_attribute(:virtual_columns) || []) << config)
+      end
+      
+      def virtual_columns
+        read_inheritable_attribute(:virtual_columns) || []
+      end
+      
+      def is_virtual_column?(column)
+        read_inheritable_attribute(:virtual_columns).keys.include?(column)
+      end
+      
+      #
+      # Used by Netzke::Grid
+      #
+      
+      DEFAULT_COLUMN_WIDTH = 100
+      
+      def default_column_config(config)
+        config = {:name => config} if config.is_a?(Symbol) # optionally we may get only a column name (as Symbol)
+        type = (columns_hash[config[:name].to_s] && columns_hash[config[:name].to_s].type) || :virtual
+
+        # general config
+        res = {
+          :name => config[:name].to_s || "unnamed",
+          :label => config[:label] || config[:name].to_s.humanize,
+          :read_only => config[:name] == :id, # make "id" column read-only by default
+          :hidden => config[:name] == :id, # hide "id" column by default
+          :width => DEFAULT_COLUMN_WIDTH,
+          :shows_as => :text_field
+        }
+
+        case type
+          when :integer
+            res[:shows_as] = :number_field
+          when :boolean
+            res[:shows_as] = :checkbox
+            res[:width] = 50
+          when :date
+            res[:shows_as] = :date_field
+          when :datetime
+            res[:shows_as] = :datetime
+          when :string
+            res[:shows_as] = :text_field
+        end
+
+        res.merge(config) # merge with custom confg (it has the priority)
+      end
+      
+      #
+      # Used by Netzke::Form
+      #
+      
+      DEFAULT_FIELD_WIDTH = 100
+      DEFAULT_FIELD_HEIGHT = 50
+      def default_field_config(config)
+        # TODO
+      end
+      
+    end
+  end
+end
+
+ActiveRecord::Base.class_eval do
+  include Netzke::ActiveRecordExtensions
+end

data/lib/netzke/column.rb

@@ -0,0 +1,43 @@
+module Netzke
+  class Column
+    def self.default_columns_for_widget(widget)
+      raise ArgumentError, "No data_class_name specified for widget #{widget.config[:name]}" if widget.config[:data_class_name].nil?
+
+      # layout = NetzkeLayout.create(:widget_name => widget.id_name, :items_class => self.name, :user_id => NetzkeLayout.user_id)
+
+      data_class = widget.config[:data_class_name].constantize
+
+      exposed_columns = normalize_columns(data_class.exposed_columns) # columns exposed from the data class
+
+      columns_from_config = widget.config[:columns] && normalize_columns(widget.config[:columns]) # columns specified in widget's config
+
+      if columns_from_config
+        # reverse-merge each column hash from config with each column hash from exposed_columns (columns from config have higher priority)
+        for c in columns_from_config
+          corresponding_exposed_column = exposed_columns.find{ |k| k[:name] == c[:name] }
+          c.reverse_merge!(corresponding_exposed_column) if corresponding_exposed_column
+        end
+        columns_for_create = columns_from_config
+      else
+        # we didn't have columns configured in widget's config, so, use the columns from the data class
+        columns_for_create = exposed_columns
+      end
+
+      res = []
+      for c in columns_for_create
+        # finally reverse-merge them with the defaults from the data_class
+        res << data_class.default_column_config(c)
+      end
+      
+      res
+    end
+    
+    protected
+
+    # like this: [:col1, {:name => :col2}, :col3] => [{:name => :col1}, {:name => :col2}, {:name => :col3}]
+    def self.normalize_columns(items)
+      items.map{|c| c.is_a?(Symbol) ? {:name => c} : c}
+    end
+    
+  end
+end