netzke-basepack 0.1.2

data/CHANGELOG

@@ -0,0 +1,18 @@
+v0.1.2
+Updated README with an example of stand-alone widget usage
+Meta: updated netzke-core version (dependency)
+
+v0.1.1.2
+Meta: updated netzke-core version (dependency)
+
+v0.1.1.1
+Meta: github gem naming convention
+
+v0.1.1
+Cleaner exception handling while loading data to grid
+Column resize & move functionality enabled by default
+Column filters added
+
+v0.1.0.1 Meta work: replacing underscore with dash in the name
+
+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
+javascripts/filters.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
+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,74 @@
+# netzke-basepack
+A pack of basic Rails/ExtJS widgets, as a part of Netzke framework.
+
+# Prerequisites
+1. Rails >= 2.2
+2. ExtJS >= 2.0: its root *must* be accessible as RAILS_ROOT/public/extjs (you may symlink your ExtJS library here)
+
+# Installation
+gem install skozlov-netzke-basepack --source http://gems.github.com
+
+
+
+# Usage
+First, run the generators to have the necessary migrations (if not done so already):
+
+`./script/generate netzke_core`
+
+`./script/generate netzke_grid`
+
+Do the migrations:
+
+`rake db:migrate`
+
+This example will provide you with a grid-based scaffold for ActiveRecord-model called `Book`. If you don't have it already, you may generate it like this:
+
+`./script/generate model Book title:string amount:integer`
+(don't forget to do the migrations after this)
+
+In the controller declare the widget:
+
+`class WelcomeController < ApplicationController
+  netzke_widget :books, :widget_class_name => 'Grid', :data_class_name => 'Book'
+end`
+
+After a widget is declared in the controller, it can be accessed in 3 different ways: 1) loaded by means of an automatically created controller action which will produce a basic HTML-page with the widget (handy for testing), 2) embedded directly into a view (by means of helpers), 3) dynamically loaded by other widgets (usually by the widget of class 'Application', if you want a desktop-like, AJAX-driven web-app).
+
+## Using automatically created controller action
+Without writing any more code, you can access the widget by `http://yourhost/welcome/book_test`. That is to say, you append `_test` to your widget's name (as declared in the controller) to get the action name.
+
+## Embedding a widget into a view
+Declaring a widget in the controller provides you with a couple of helpers that can be used in the view:
+
+1. `books_class_definition` will contain the javascript code defining the code for the JS class.
+2. `books_widget_instance` will declare a local javascript variable called `book`.
+
+Use these helpers inside of the `<script>`-tag like the following (in the view):
+	
+`<script type="text/javascript" charset="utf-8">
+<%= books_class_definition %>
+Ext.onReady(function(){
+	<%= books_widget_instance %>
+	books.render("books");
+})
+</script>
+<div id="books">the widget will be rendered in this div</div>`
+
+If your layout already calls `yield :javascripts` wrapped in the `<script>`-tag, you can have all javascript-code in one place on the page:
+
+`<% content_for :javascripts do %>
+<%= books_class_definition %>
+Ext.onReady(function(){
+	<%= books_widget_instance %>
+	books.render("books");
+})
+<% end %>
+<div id="books">the widget will be rendered in this div</div>`
+
+## Dynamic loading of widgets
+TODO: will be covered later
+
+# Credentials
+Testing done 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,14 @@
+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.1.1"]
+  p.development_dependencies = []
+  p.test_pattern = 'test/**/*_test.rb'
+
+  # fixing the problem with lib/*-* files being removed while doing manifest
+  p.clean_pattern = ["pkg", "doc", 'build/*', '**/coverage', '**/*.o', '**/*.so', '**/*.a', '**/*.log', "{ext,lib}/*.{bundle,so,obj,pdb,lib,def,exp}", "ext/Makefile", "{ext,lib}/**/*.{bundle,so,obj,pdb,lib,def,exp}", "ext/**/Makefile", "pkg", "*.gem", ".config"]
+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 @@
+# require 'netzke-basepack'

data/install.rb

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

data/javascripts/basepack.js

@@ -0,0 +1,52 @@
+// 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
+		})
+	},
+	
+	// TODO: it's simply a text field for now
+	datetime: function(c, config){
+		return new Ext.form.TextField({
+			selectOnFocus:true
+		})
+	}
+};
+
+// Mapping of showsAs field to grid filters
+Ext.netzke.filterMap = {
+	number_field:'Numeric',
+	text_field:'String',
+	datetime:'String',
+	checkbox:'Boolean',
+	combo_box:'String',
+	date:'Date'
+}

data/javascripts/filters.js

@@ -0,0 +1,7 @@
+Ext.menu.RangeMenu.prototype.icons = {
+  gt: '/extjs/examples/grid-filtering/img/greater_then.png', 
+  lt: '/extjs/examples/grid-filtering/img/less_then.png',
+  eq: '/extjs/examples/grid-filtering/img/equals.png'
+};
+
+Ext.grid.filter.StringFilter.prototype.icon = '/extjs/examples/grid-filtering/img/find.png';

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-basepack.rb

@@ -0,0 +1,28 @@
+# External dependencies
+require 'netzke-core'
+require 'searchlogic'
+
+require 'netzke/ar_ext'
+
+%w{ models }.each do |dir|
+  path = File.join(File.dirname(__FILE__), 'app', dir)
+  $LOAD_PATH << path
+  ActiveSupport::Dependencies.load_paths << path
+  ActiveSupport::Dependencies.load_once_paths.delete(path)
+end
+
+# Include the javascript
+Netzke::Base.config[:javascripts] << "#{File.dirname(__FILE__)}/../javascripts/basepack.js"
+
+# TODO: implement configurable loading of JS, to spare the traffic at the initial loading
+extjs_dir = "#{File.dirname(RAILS_ROOT)}/netzke_tutorial/public/extjs"
+Netzke::Base.config[:javascripts] << "#{extjs_dir}/examples/grid-filtering/menu/EditableItem.js"
+Netzke::Base.config[:javascripts] << "#{extjs_dir}/examples/grid-filtering/menu/RangeMenu.js"
+Netzke::Base.config[:javascripts] << "#{extjs_dir}/examples/grid-filtering/grid/GridFilters.js"
+%w{Boolean Date List Numeric String}.unshift("").each do |f|
+  Netzke::Base.config[:javascripts] << "#{extjs_dir}/examples/grid-filtering/grid/filter/#{f}Filter.js"
+end
+Netzke::Base.config[:javascripts] << "#{File.dirname(__FILE__)}/../javascripts/filters.js"
+
+# Make this plugin reloadable for easier development
+ActiveSupport::Dependencies.load_once_paths.delete(File.join(File.dirname(__FILE__)))

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