padrino-admin 0.2.2 → 0.2.5

data/VERSION

@@ -1 +1 @@
-0.2.2
+0.2.5

data/lib/padrino-admin.rb

@@ -0,0 +1 @@
+Dir[File.dirname(__FILE__) + '/padrino-admin/**/*.rb'].each {|file| require file }

data/lib/padrino-admin/ext_js/config.rb

@@ -0,0 +1,170 @@
+require 'rubygems'
+require 'yaml'
+require 'erb'
+require 'json/pure'
+
+module ExtJs
+
+  class ConfigError < RuntimeError; end
+
+  # This class it's used for JSON variables.
+  # Normally if we convert this { :function => "alert('Test')" } will be:
+  # 
+  #   { "function": "alert('Test')" }
+  # 
+  # But if in our javascript need to "eval" this function is not possible because
+  # it's a string.
+  # 
+  # Using ExtJs::Variable the result will be:
+  # 
+  #   { "function" : alert('Test') }
+  # 
+  # Normally an ExtJs Variable can be handled with ExtJs Config like:
+  # 
+  #   function: !js alert('Test')
+  # 
+  class Variable < String
+    yaml_as "tag:yaml.org,2002:js"
+
+    def to_json(*a) #:nodoc:
+      self
+    end
+  end
+
+  # This class it's used for write in a new and simple way json.
+  # 
+  # In ExtJs framework generally each component have a configuration written in json.
+  # 
+  # Write this config in ruby it's not the best choice think this example:
+  # 
+  #   # A Generic grid config in JavaScript:
+  #   var gridPanel = new Ext.grid.GridPanel({
+  #     bbar: gridPanelPagingToolbar,
+  #     clicksToEdit: 1,
+  #     cm: gridPanelColumnModel,
+  #     region: "center",
+  #     sm: gridPanelCheckboxSelectionModel,
+  #     viewConfig: {"forceFit":true},
+  #     plugins: [new Ext.grid.Search()],
+  #     border: false,
+  #     tbar: gridPanelToolbar,
+  #     id: "grid-accounts",
+  #     bodyBorder: false,
+  #     store: gridPanelGroupingStore,
+  #     view: gridPanelGroupingView
+  #   });
+  # 
+  #   # A Gneric grid config in Ruby:
+  #   { :bbar => ExtJs::Variable.new('gridPanelPagingToolbar'), :clicksToEdit => 1, 
+  #     :cm => ExtJs::Variable.new('gridPanelColumnModel'), :region => "center",
+  #     :sm => ExtJs::Variable.new('gridPanelCheckboxSelectionModel'),
+  #     :viewConfig => { :forceFit => true }, plugins => [ExtJs::Variable.new('new Ext.grid.Search()'].
+  #     :border => false ... more more code...
+  # 
+  # As you can see writing json in pure ruby (in this case with hash) require much time and is
+  # <tt>less</tt> readable.
+  # 
+  # For this reason we build an ExtJs Config, that basically it's an yaml file with
+  # some new great functions so the example above will be:
+  # 
+  #   # A Generic grid config in ExtJs Config:
+  #   gridPanel:
+  #     bbar: !js gridPanelPagingToolbar
+  #     clicksToEdit: 1,
+  #     cm: !js gridPanelColumnModel
+  #     region: center
+  #     sm: !js gridPanelCheckboxSelectionModel
+  #     viewConfig:
+  #       forceFit: true
+  #     plugins: [!js new Ext.grid.Search()]
+  #     border: false
+  #     tbar: !js gridPanelToolbar
+  #     id: grid-accounts
+  #     bodyBorder: false
+  #     store: !js gridPanelGroupingStore
+  #     view: !js gridPanelGroupingView
+  # 
+  # Now you see that it's more readable, simple and coincise!
+  # 
+  # But our ExtJs config can act also as an xml or an erb partial. See this code:
+  # 
+  #   # A template
+  #   tempate:
+  #     tbar:
+  #       here: a custom config
+  #     grid:
+  #       viewConfig:
+  #         forceFit: true
+  #       plugins: [!js new Ext.grid.Search()]
+  #       border: false  
+  # 
+  # We can "grep" this config in our template with:
+  #   
+  #   # A generic grid
+  #   gridPanel:
+  #     <<: %template/grid
+  #     border: true
+  # 
+  # The result will be:
+  # 
+  #   gridPanel:
+  #     viewConfig:
+  #       forceFit: true
+  #     plugins: [!js new Ext.grid.Search()]
+  #     border: true # overidden
+  # 
+  # See our test for more complex examples.
+  # 
+  class Config < Hash
+    
+    # Initialize a new config parsing an Hash
+    def initialize(data)
+      @data   = data
+      parsed  = parse(@data)
+      super
+      replace parsed
+    end
+
+    # Load a new config from an yml file and return a parsed hash.
+    def self.load_file(path, binding=nil)
+      self.load(File.read(path), binding)
+    end
+
+    # Load a new config from a yaml "string" and return a parsed hash.
+    def self.load(string, binding=nil)
+      self.new YAML.parse(ERB.new(string).result(binding))
+    end
+
+  private
+    def parse(node=nil, key=nil)
+      case node.value
+        when String
+          if node.value =~ /^%{1}(.*)/
+            node = parse(@data.select($1).first)
+          end
+          node.respond_to?(:transform) ? node.transform : node
+        when Hash
+          parsed = {}
+          node.value.each do |k,v| 
+            if k.value == "<<"
+              node = parse(v)
+              if node.is_a?(Hash)
+                node.merge!(parsed)
+              end
+              parsed = node
+            else
+              parsed[k.value] = parse(v)
+            end
+          end
+          parsed
+        when Array
+          parsed = []
+          node.value.each do |v|
+            node = parse(v)
+            node.is_a?(Array) ? parsed.concat(node) : parsed.push(node)
+          end
+          parsed
+      end
+    end
+  end
+end

data/lib/padrino-admin/generators/backend.rb

@@ -0,0 +1,25 @@
+require 'thor'
+
+module Padrino
+  module Generators
+
+    class Backend < Thor::Group
+
+      # Add this generator to our padrino-gen
+      Padrino::Generators.add_generator(:backend, self)
+
+      # Define the source template root
+      def self.source_root; File.expand_path(File.dirname(__FILE__)); end
+      def self.banner; "padrino-gen controller [name]"; end
+
+      # Include related modules
+      include Thor::Actions
+      include Padrino::Generators::Actions
+
+      desc "Description:\n\n\tpadrino-gen controller generates a new Padrino Admin"
+
+      class_option :root, :aliases => '-r', :default => nil, :type => :string
+    end
+
+  end
+end

data/padrino-admin.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{padrino-admin}
-  s.version = "0.2.2"
+  s.version = "0.2.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Padrino Team", "Nathan Esquenazi", "Davide D'Agostino", "Arthur Chiu"]
-  s.date = %q{2009-12-01}
+  s.date = %q{2009-12-21}
   s.description = %q{Admin View for Padrino applications}
   s.email = %q{nesquena@gmail.com}
   s.extra_rdoc_files = [
@@ -23,9 +23,12 @@ Gem::Specification.new do |s|
      "Rakefile",
      "VERSION",
      "lib/padrino-admin.rb",
+     "lib/padrino-admin/ext_js/config.rb",
+     "lib/padrino-admin/generators/backend.rb",
      "padrino-admin.gemspec",
      "test/helper.rb",
-     "test/test_padrino_admin.rb"
+     "test/test_padrino_admin.rb",
+     "test/test_parsing.rb"
   ]
   s.homepage = %q{http://github.com/padrino/padrino-framework/tree/master/padrino-admin}
   s.rdoc_options = ["--charset=UTF-8"]

data/test/helper.rb

@@ -7,6 +7,8 @@ require 'webrat'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'padrino-gen'
 require 'padrino-admin'
 
 class Test::Unit::TestCase

data/test/test_parsing.rb

@@ -0,0 +1,136 @@
+require File.dirname(__FILE__) + '/helper'
+
+class ParsingTest < Test::Unit::TestCase
+
+  should "Parse Nested Childs" do
+    config = ExtJs::Config.load <<-YAML
+      foo:
+        bar:
+          name: Fred
+      bar: %foo/bar
+    YAML
+    assert_equal config["foo"]["bar"], config["bar"]
+  end
+
+  should "Parse JS and Nested JS" do
+    config = ExtJs::Config.load <<-YAML
+      nested:
+        fn: !js function(){ alert('nested fn') }
+      fn: !js function(){ alert('fn') }
+      array: [!js function(){ alert('array') }]
+      test_one: %fn
+      test_two: %nested/fn
+      test_three:
+        no_nested: %fn
+        nested: %nested/fn
+    YAML
+    
+    assert_kind_of ExtJs::Variable, config["test_one"]
+    assert_kind_of ExtJs::Variable, config["test_one"]
+    assert_kind_of ExtJs::Variable, config["test_three"]["no_nested"]
+    assert_kind_of ExtJs::Variable, config["test_three"]["nested"]
+    assert_kind_of ExtJs::Variable, config["array"].first
+    
+    assert_equal "function(){ alert('fn') }", config["test_one"]
+    assert_equal "function(){ alert('nested fn') }", config["test_two"]
+    assert_equal "function(){ alert('fn') }", config["test_three"]["no_nested"]
+    assert_equal "function(){ alert('nested fn') }", config["test_three"]["nested"]
+    assert_equal "function(){ alert('array') }", config["array"].first
+  end
+
+  should "Parse a multinested YAML" do
+    config = ExtJs::Config.load <<-YAML
+      buttons:
+        - id: add
+          text: Add Product
+        - id: delete
+          text: Delete Product
+      default:
+        tbar:
+          buttons: %buttons
+      grid:
+        tbar: %default/tbar
+    YAML
+    assert_equal config["default"]["tbar"], config["grid"]["tbar"]
+    assert_equal config["buttons"], config["default"]["tbar"]["buttons"]
+    assert_equal config["buttons"], config["grid"]["tbar"]["buttons"]
+    assert_equal ["add", "delete"], config["grid"]["tbar"]["buttons"].collect { |b| b["id"] }
+    
+  end
+
+  should "Parse array and hashes" do
+    config = ExtJs::Config.load <<-YAML
+      a: a
+      b: b
+      c: c
+      array: [%a, %b, %c]
+      hash: { a: %a, b: %b, c: %c }
+    YAML
+    assert_equal ["a", "b", "c"], config["array"]
+    assert_equal({"a" => "a", "b" => "b", "c" => "c"}, config["hash"])
+  end
+
+  should "Merge config" do
+    config = ExtJs::Config.load <<-YAML
+      default:
+        grid:
+          editable: false
+          template: standard
+          cls: default
+        tbar:
+          buttons:
+            - text: Add
+              cls: x-btn-text-icon add
+            - text: Delete
+              disabled: true
+              cls: x-btn-text-icon print
+              handler: !js delete
+
+      grid:
+        <<: %default/grid
+        editable: true
+        title: Elenco <%= @title %>
+        basepath: /backend/orders
+        sm: checkbox
+        template: custom
+        tbar:
+          buttons:
+            - <<: %default/tbar/buttons
+            - text: Test
+    YAML
+    assert_equal true, config["grid"]["editable"]
+    assert_equal "default", config["grid"]["cls"]
+    assert_equal "custom", config["grid"]["template"]
+    assert_equal ["Add", "Delete", "Test"], config["grid"]["tbar"]["buttons"].collect { |b| b["text"] }
+  end
+  
+  should "Merge a complex config" do
+    config = ExtJs::Config.load <<-YAML
+      default:
+        grid:
+          editable: false
+          template: standard
+          cls: default
+          tbar:
+            buttons:
+              - text: Add
+                cls: x-btn-text-icon add
+              - text: Delete
+                disabled: true
+                cls: x-btn-text-icon print
+                handler: !js delete
+
+      grid:
+        <<: %default/grid
+        editable: true
+        title: Elenco <%= @title %>
+        basepath: /backend/orders
+        sm: checkbox
+        template: custom
+    YAML
+    assert_equal true, config["grid"]["editable"]
+    assert_equal "default", config["grid"]["cls"]
+    assert_equal "custom", config["grid"]["template"]
+    assert_equal ["Add", "Delete"], config["grid"]["tbar"]["buttons"].collect { |b| b["text"] }
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: padrino-admin
 version: !ruby/object:Gem::Version 
-  version: 0.2.2
+  version: 0.2.5
 platform: ruby
 authors: 
 - Padrino Team
@@ -12,7 +12,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-01 00:00:00 -08:00
+date: 2009-12-21 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -101,9 +101,12 @@ files:
 - Rakefile
 - VERSION
 - lib/padrino-admin.rb
+- lib/padrino-admin/ext_js/config.rb
+- lib/padrino-admin/generators/backend.rb
 - padrino-admin.gemspec
 - test/helper.rb
 - test/test_padrino_admin.rb
+- test/test_parsing.rb
 has_rdoc: true
 homepage: http://github.com/padrino/padrino-framework/tree/master/padrino-admin
 licenses: []