netzke-workspace 0.10.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aa1fe8d5e2a2563b8a95c4107b7efef98069ec54
+  data.tar.gz: be7cf1c3dccc760b0950b94a2033b6c7a3454b86
+SHA512:
+  metadata.gz: 4812acfcd3d8e4858d7d09780d4884495bc711e02ec03939540186f0052313d0f24ff9e6f0f0e2e213371f6769a2ce0f52e9823ce45ee12da728c10ea5d58d23
+  data.tar.gz: 7603a2043a5417b0bca1088b143e1db3d381295f2da4ed687df122a7721ce045a278f60f886e0277e22649bad0eeae4ed42a93df6aa702fb07fb7e6ac96dca48

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in netzke-workspace.gemspec
+gemspec
+
+gem 'netzke-core', '0.10.0'
+gem 'netzke-testing', '0.10.0'
+
+group :test do
+  gem 'rspec'
+  gem 'capybara', '~> 1.0'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Max Gorin
+
+MIT License
+
+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.md

@@ -0,0 +1,58 @@
+# Netzke::Workspace
+
+Provides a tab-panel-based Netzke component that:
+
+  * allows dynamic loading of arbitrary Netzke components in (new or currently active tab)
+
+  * handles persistence of open tabs
+
+  * provides a method that unloads all tabs at once
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'netzke-workspace'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install netzke-workspace
+
+## Usage
+
+Inherit your workspace component from Netzke::Workspace::TabPanel. Then on the client side call the `loadTab` method to dynamically load components, e.g. (the `HelloWorld` component is supposed to be defined elsewhere):
+
+    class MyTabPanel < Netzke::Workspace::TabPanel
+      action :load_component
+
+      js_configure do |c|
+        c.on_load_component = <<-JS
+          function() {
+            this.loadTab("HelloWorld", newTab: true});
+          }
+        JS
+      end
+
+      def configure(c)
+        super
+        c.bbar = [:load_component]
+      end
+    end
+
+See `spec/rails_app/app/components` for more examples.
+
+## Running tests
+
+    $ rspec spec
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/netzke-workspace/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/netzke-workspace.rb

@@ -0,0 +1,7 @@
+# require 'netzke-core'
+# require 'netzke/workspace'
+
+require 'active_support/dependencies'
+
+# Make components auto-loadable
+ActiveSupport::Dependencies.autoload_paths << File.dirname(__FILE__)

data/lib/netzke/workspace.rb

@@ -0,0 +1,8 @@
+require "netzke/workspace/version"
+require "netzke/workspace/base"
+
+module Netzke
+  module Workspace
+    # Your code goes here...
+  end
+end

data/lib/netzke/workspace/tab_panel.rb

@@ -0,0 +1,61 @@
+module Netzke
+  module Workspace
+    # A component that allows for dynamical loading/unloading of other Netzke components in tabs.
+    #
+    # Call the +loadTab+ method on the client to dynamically load a component:
+    #
+    #   workspaceTabPanel.loadTab("UserGrid", {newTab: true})
+    #
+    # - will load a UserGrid component from the server in a new tab.
+    #
+    # == Client-side methods:
+    #
+    # +loadTab(componentClassName, options)+ - loads a component in a (new or currently active) tab
+    #
+    #   * +options+ is an object that may contain the following keys:
+    #       * +newTab+ (boolean) - whether to load a component in a newly created tab
+    #       * +clientConfig+ (object) - config for the loaded Netzke component
+    #
+    # +closeAllTabs+ - closes all open tabs
+    #
+    # == Security
+    #
+    # By default, this component allows loading any Netzke component as requested from the client (component
+    # class has been sent as a paremeter for the deliver_component endpoint), which may not be secury enough for you.
+    # Override the :tab component to do any proper checks (see an example in the specs app).
+    #
+    class TabPanel < Netzke::Base
+      js_configure do |c|
+        c.extend = "Ext.tab.Panel"
+        c.header = false
+        c.mixin
+      end
+
+      def configure(c)
+        c.tabs = state[:tabs].presence
+        super
+      end
+
+      component :tab do |c|
+        # this hack is needed because of Netzke::Core's imperfection: it eagerly evaluates all components (even if those
+        # would never be loaded) - and thus, a valid +klass+ is required.
+        if c.client_config.empty?
+          c.klass = Netzke::Core::Panel
+        else
+          c.klass = c.client_config[:klass].constantize
+        end
+      end
+
+      def update_tab_session_config(c)
+        tabs = state[:tabs] ||= {}
+        if tab_index = c.delete(:tabIndex)
+          tabs[tab_index] = c
+        end
+      end
+
+      endpoint :server_save_tabs do |params, this|
+        state[:tabs] = params
+      end
+    end
+  end
+end

data/lib/netzke/workspace/tab_panel/javascripts/tab_panel.js

@@ -0,0 +1,108 @@
+{
+  /**
+   * Loads a component.
+   */
+  loadTab: function(cmp, options) {
+    var receivingTab;
+
+    options = options || {};
+
+    if (options.newTab) {
+      receivingTab = this.add({layout: 'fit', closable: true});
+    } else {
+      receivingTab = this.getActiveTab();
+      if (!this.isDynamic(receivingTab)) return;
+    }
+
+    this.suspendEvents();
+    this.setActiveTab(receivingTab);
+    this.resumeEvents();
+
+    receivingTab.setTitle('Loading...');
+
+    receivingTab.removeAll();
+
+    var clientConfig = Ext.apply(options.clientConfig, {
+      klass: cmp
+    });
+
+    this.netzkeLoadComponent("tab", {
+      clientConfig: clientConfig,
+      container: receivingTab,
+      clone: true,
+      scope: this,
+      callback: function(c) {
+        receivingTab.setTitle(c.title);
+        receivingTab.componentConfig = clientConfig;
+        this.saveTabs();
+      }
+    });
+  },
+
+  /**
+   * Closes all tabs
+   */
+  closeAllTabs: function() {
+    this.items.each(function(tab, i) {
+      if (this.isDynamic(tab)) {
+        this.remove(tab);
+      }
+    }, this)
+    this.saveTabs();
+  },
+
+  /**
+  * private methods
+  */
+
+  initComponent: function() {
+    this.callParent();
+
+    this.on('tabchange', this.onTabChange, this);
+
+    this.on('remove', function(me, tab) {
+      this.saveTabs();
+    }, this);
+
+    this.addInitialTabs();
+  },
+
+  addInitialTabs: function(){
+    if (this.tabs) {
+      this.tabs.forEach(function(c) {
+        var tab = this.add({layout: 'fit', closable: true, title: c.title, active: c.active, componentConfig: c});
+        if (c.active) this.setActiveTab(tab);
+      }, this);
+    }
+  },
+
+  onTabChange: function(panel, tab){
+    if (tab.items.getCount() == 0 && this.isDynamic(tab)) {
+      // this tab is nesting no component yet
+      this.netzkeLoadComponent("tab", {container: tab, clientConfig: tab.componentConfig, clone: true});
+    }
+
+    this.saveTabs();
+  },
+
+  // Returns true if given tab was dynamically loaded (as opposed to tabs that could be there initially)
+  isDynamic: function(tab){
+    return !!tab.componentConfig;
+  },
+
+  // Saves current tab configs to server
+  saveTabs: function() {
+    var activeTab = this.getActiveTab();
+    var configs = [];
+    this.items.each(function(tab, i){
+      if (this.isDynamic(tab)) {
+        var tabConfig = tab.componentConfig || {};
+        tabConfig.title = tab.title;
+        tabConfig.active = activeTab == tab;
+        configs.push(tabConfig);
+      }
+    }, this);
+
+    this.serverSaveTabs(configs);
+  }
+}

data/lib/netzke/workspace/version.rb

@@ -0,0 +1,5 @@
+module Netzke
+  module Workspace
+    VERSION = "0.10.0"
+  end
+end

data/netzke-workspace.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'netzke/workspace/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "netzke-workspace"
+  spec.version       = Netzke::Workspace::VERSION
+  spec.authors       = ["Max Gorin"]
+  spec.email         = ["gorinme@gmail.com"]
+  spec.summary       = %q{Netzke Workspace component}
+  spec.description   = %q{Dynamically loads components in persisted tabs}
+  spec.homepage      = "http://netzke.org"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'netzke-core', '0.10.0'
+
+  spec.add_development_dependency 'rails', '~> 4.0.0'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'yard'
+  spec.add_development_dependency 'coffee-script'
+  # spec.add_development_dependency 'netzke-testing', '0.10.0.rc1'
+  spec.add_development_dependency 'rspec-rails'
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

data/spec/features/javascripts/secure_tab_panel_spec.js.coffee

@@ -0,0 +1,6 @@
+describe 'SecureTabPanel component', ->
+  it 'does not allow loading HelloUser', (done) ->
+    click button "New tab"
+    wait ->
+      expectToSee tab "HelloUser not allowed"
+      done()

data/spec/features/javascripts/some_tab_panel_spec.js.coffee

@@ -0,0 +1,15 @@
+describe 'SomeTabPanel component', ->
+  it 'loads component in new tab', (done) ->
+    click button "New tab"
+    wait ->
+      expectToSee tab "User 1"
+      click button "Ping server"
+      wait ->
+        expectToSee header "Server says Hello User 1"
+        click button "New tab"
+        wait ->
+          expectToSee tab "User 2"
+          click button "Ping server"
+          wait ->
+            expectToSee header "Server says Hello User 2"
+            done()

data/spec/features/javascripts/tab_panel_with_dashboard_spec.js.coffee

@@ -0,0 +1,9 @@
+describe 'TabPanelWithDashboard component', ->
+  it 'closes all tabs except Dashboard', (done) ->
+    click button "New tab"
+    wait ->
+      expectToSee tab "User 1"
+      click button "Close all"
+      wait ->
+        expectToSee tab "Dashboard"
+        done()

data/spec/features/netzke_mocha_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+feature "Mocha specs", js: true do
+  # if a spec path is provided, create a single spec for it
+  if path = ENV["S"]
+    it "pass for '#{path}'" do
+      run_mocha_spec(path)
+    end
+  else
+    # create a spec for each file spec dir that ends on "_spec.js.coffee"
+    dir = File.join File.dirname(__FILE__), "javascripts"
+    Dir[File.join(dir, "**/*_spec.js.coffee")].each do |f|
+      spec_path = f.sub(dir, '')[1..-1].sub(/_spec\..*$/, '')
+
+      it "pass for '#{spec_path.underscore}'" do
+        run_mocha_spec spec_path
+      end
+    end
+  end
+end

data/spec/features/workspace_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+feature Netzke::Workspace::TabPanel do
+  it 'loads component in new tab', js: true do
+  end
+end

data/spec/rails_app/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.