netzke-core 0.7.7 → 0.8.0

data/lib/netzke/javascript/scopes.rb

@@ -1,39 +0,0 @@
-module Netzke
-  module Javascript
-    module Scopes
-      extend ActiveSupport::Concern
-
-      module ClassMethods
-        # Given class name, e.g. GridPanelLib::Components::RecordFormWindow,
-        # returns its scope: "Components.RecordFormWindow"
-        def js_class_name_to_scope(name)
-          name.split("::")[0..-2].join(".")
-        end
-
-        # Top level scope which will be used to scope out Netzke classes
-        def js_default_scope
-          "Netzke.classes"
-        end
-
-        # Scope of this component without default scope
-        # e.g.: GridPanelLib.Components
-        def js_scope
-          js_class_name_to_scope(short_component_class_name)
-        end
-
-        # Returns the scope of this component
-        # e.g. "Netzke.classes.GridPanelLib"
-        def js_full_scope
-          js_scope.empty? ? js_default_scope : [js_default_scope, js_scope].join(".")
-        end
-
-        # Returns the full name of the JavaScript class, including the scopes *and* the common scope, which is
-        # Netzke.classes.
-        # E.g.: "Netzke.classes.Netzke.GridPanelLib.RecordFormWindow"
-        def js_full_class_name
-          [js_full_scope, short_component_class_name.split("::").last].join(".")
-        end
-      end
-    end
-  end
-end

data/lib/netzke/railz.rb

@@ -1,4 +0,0 @@
-require 'netzke/railz/engine'
-require 'netzke/railz/routes'
-require 'netzke/railz/action_view_ext'
-require 'netzke/railz/controller_extensions'

data/lib/netzke/railz/action_view_ext/ext.rb

@@ -1,64 +0,0 @@
-module Netzke
-  module Railz
-    module ActionViewExt
-      # Implementation of Ext-specific helpers
-      module Ext #:nodoc:
-
-        protected
-
-          def netzke_ext_css_include(params)
-            # ExtJS base
-            res = ["#{Netzke::Core.ext_uri}/resources/css/ext-all"]
-
-            # Netzke-related dynamic css
-            res << "/netzke/ext"
-
-            res += Netzke::Core.external_ext_css
-
-            stylesheet_link_tag(*res)
-          end
-
-          def netzke_ext_js_include(params)
-            res = []
-
-            # ExtJS
-            res << (Rails.env.development? ? "#{Netzke::Core.ext_uri}/ext-all-debug" : "#{Netzke::Core.ext_uri}/ext-all")
-
-            # ExtJS 3 compatibility layer
-            if compat_uri = Netzke::Core.ext3_compat_uri
-              res << "#{compat_uri}/ext3-core-compat"
-              res << "#{compat_uri}/ext3-compat"
-            end
-
-            # Ext I18n
-            res << "#{Netzke::Core.ext_uri}/locale/ext-lang-#{I18n.locale}" if I18n.locale != :en
-
-            # Netzke-related dynamic JavaScript
-            res << "/netzke/ext"
-
-            javascript_include_tag(*res)
-          end
-
-          def netzke_ext_js(params)
-            res = []
-            res << content_for(:netzke_js_classes)
-
-            res << "Ext.onReady(function(){"
-            res << content_for(:netzke_on_ready)
-            res << "});"
-
-            javascript_tag(res.join("\n"))
-          end
-
-          # (Experimental) Embeds a "pure" (non-Netzke) Ext component into the view, e.g.:
-          #     <%= ext :my_panel, :xtype => :panel, :html => "Simple Panel"
-          def ext(name, config = {}) #:doc:
-            comp = Netzke::ExtComponent.new(name, config)
-            content_for :netzke_on_ready, raw("#{comp.js_component_render}")
-            raw(comp.js_component_html)
-          end
-
-      end
-    end
-  end
-end

data/lib/netzke/railz/action_view_ext/touch.rb

@@ -1,52 +0,0 @@
-module Netzke
-  module Railz
-    module ActionViewExt
-      # Implementation of Touch-specific helpers
-      module Touch #:nodoc:
-
-        protected
-
-          def netzke_touch_css_include(params)
-            # Note: no themes for now
-
-            res = stylesheet_link_tag("#{Netzke::Core.touch_uri}/resources/css/sencha-touch")
-
-            # Netzke-related (dynamically generated by NetzkeController)
-            res << "\n" << stylesheet_link_tag("/netzke/touch")
-
-            res
-          end
-
-          def netzke_touch_js(params)
-            res = []
-            res << content_for(:netzke_js_classes)
-            res << "\n"
-
-            res << "Ext.setup({"
-              res << "onReady: function(){"
-              res << content_for(:netzke_on_ready)
-              res << "}"
-            res << "});"
-
-            javascript_tag res.join("\n")
-          end
-
-
-          def netzke_touch_js_include(params)
-            # ExtJS
-            res = if ENV['RAILS_ENV'] == 'development'
-              ["#{Netzke::Core.touch_uri}/sencha-touch-debug.js"]
-            else
-              ["#{Netzke::Core.touch_uri}/sencha-touch"]
-            end
-
-            # Netzke
-            res << "/netzke/touch"
-
-            javascript_include_tag(res, :cache => params[:cache])
-          end
-
-      end
-    end
-  end
-end

data/lib/netzke/railz/controller_extensions.rb

@@ -1,33 +0,0 @@
-module Netzke
-  module Railz
-    module ControllerExtensions
-      def self.included(base)
-        base.send(:before_filter, :set_session_data)
-        base.send(:before_filter, :set_controller)
-      end
-
-      def set_session_data
-        ::Netzke::Core.session = session
-        session[:netzke_user_id] = defined?(current_user) ? current_user.try(:id) : nil
-        # set netzke_just_logged_in and netzke_just_logged_out states (may be used by Netzke components)
-        if session[:_netzke_next_request_is_first_after_login]
-          session[:netzke_just_logged_in] = true
-          session[:_netzke_next_request_is_first_after_login] = false
-        else
-          session[:netzke_just_logged_in] = false
-        end
-
-        if session[:_netzke_next_request_is_first_after_logout]
-          session[:netzke_just_logged_out] = true
-          session[:_netzke_next_request_is_first_after_logout] = false
-        else
-          session[:netzke_just_logged_out] = false
-        end
-      end
-
-      def set_controller
-        ::Netzke::Core.controller = self
-      end
-    end
-  end
-end

data/lib/netzke/railz/engine.rb

@@ -1,48 +0,0 @@
-module Netzke
-  module Railz
-    class Engine < Rails::Engine
-      config.netzke = Netzke::Core::OptionsHash.new
-
-      initializer "netzke.core" do |app|
-        app.config.eager_load_paths -= ["#{app.config.root}/app/components"]
-        app.config.autoload_paths += ["#{app.config.root}/app/components"]
-      end
-
-      # before loading initializers
-      config.before_initialize do |app|
-        Netzke::Core.config = config.netzke # passing app-level config to Netzke::Core
-        Netzke::Core.persistence_manager_class = Netzke::Core.persistence_manager.constantize rescue nil
-      end
-
-      # after loading initializers
-      config.after_initialize do
-        Netzke::Core.ext_path = Rails.root.join('public', Netzke::Core.ext_uri[1..-1])
-        Netzke::Core.with_icons = File.exists?("#{::Rails.root}/public#{Netzke::Core.icons_uri}") if Netzke::Core.with_icons.nil?
-
-        # Dynamic generation of Netzke js and css.
-        # WIP: the problem with this is that on Heroku, for example, you don't have write access to 'public'.
-        # dynamic_assets = %w[ext.js ext.css touch.js touch.css]
-        #
-        # if Rails.configuration.cache_classes
-        #   # Memoize Netzke::Base.constantize_class_name for performance
-        #   class << Netzke::Base
-        #     memoize :constantize_class_name
-        #   end
-        #
-        #   # Generate dynamic assets and put them into public/netzke
-        #   require 'fileutils'
-        #   FileUtils.mkdir_p(Rails.root.join('public', 'netzke'))
-        #
-        #   dynamic_assets.each do |asset|
-        #     File.open(Rails.root.join('public', 'netzke', asset), 'w') {|f| f.write(Netzke::Core::DynamicAssets.send(asset.sub(".", "_"))) }
-        #   end
-        # else
-        #   dynamic_assets.each do |asset|
-        #     file_path = Rails.root.join('public', 'netzke', asset)
-        #     File.delete(file_path) if File.exists?(file_path)
-        #   end
-        # end
-      end
-    end
-  end
-end

data/lib/netzke/railz/routes.rb

@@ -1,7 +0,0 @@
-module ActionDispatch::Routing
-  class Mapper
-    def netzke
-      match "/netzke/:action(.:format)" => "netzke"
-    end
-  end
-end

data/lib/netzke/services.rb

@@ -1,101 +0,0 @@
-module Netzke
-  # This module takes care of components' client-server communication.
-  module Services
-    extend ActiveSupport::Concern
-
-    included do
-       # Returns all endpoints as a hash
-      class_attribute :endpoints
-      self.endpoints = {}
-    end
-
-    module ClassMethods
-      # Defines an endpoint - a connection point between the client side of a component and its server side. For example:
-      #
-      #     endpoint :do_something do |params|
-      #       # ...
-      #     end
-      #
-      # By defining the endpoint on the server, the client side automatically gets a method that is used to call the server, in this case `doSomething` (note conversion from underscore to camelcase). It can be called like this:
-      #
-      #     this.doSomething(argsObject, callbackFunction, scope);
-      #
-      # * +argsObject+ is what the server side will receive as the +params+ argument
-      # * +callbackFunction+ (optional) will be called after the server successfully processes the request
-      # * +scope+ (optional) the scope in which +callbackFunction+ will be called
-      #
-      # The callback function may receive an argument which will be set to the value that the server passes to the special +set_result+ key in the resulting hash:
-      #
-      #     endpoint :do_something do |params|
-      #       # ...
-      #       {:set_result => 42}
-      #     end
-      #
-      # Any other key in the resulting hash will result in a corresponding JavaScript-side function call, with the parameter set to the value of that key. For example:
-      #
-      #     endpoint :do_something do |params|
-      #       # ...
-      #       {:set_result => 42, :set_title => "New title, set by the server"}
-      #     end
-      #
-      # This will result in the call to the +setTitle+ method on the client side of the component, with "New title, set by the server" as the parameter.
-      def endpoint(name, options = {}, &block)
-        register_endpoint(name, options)
-        define_method("#{name}_endpoint", &block) if block # if no block is given, the method is supposed to be defined elsewhere
-
-        # define_method name, &block if block # if no block is given, the method is supposed to be defined elsewhere
-        define_method :"_#{name}_ep_wrapper" do |*args|
-          res = send("#{name}_endpoint", *args)
-          res.respond_to?(:to_nifty_json) && res.to_nifty_json || ""
-        end
-      end
-
-      def api(*api_points) #:nodoc:
-        ::ActiveSupport::Deprecation.warn("Using the 'api' call has no longer effect. Define endpoints instead.", caller)
-      end
-
-      protected
-
-      # Registers an endpoint
-      def register_endpoint(ep, options)
-        self.endpoints = self.endpoints.dup.merge(ep => options)
-      end
-
-    end
-
-    # Invokes endpoint calls
-    # +endpoint+ may contain the path to the endpoint in a component down the hierarchy, e.g.:
-    #
-    #     invoke_endpoint(:users__center__get_data, params)
-    def invoke_endpoint(endpoint, params)
-      ep_config = self.class.endpoints[endpoint.to_sym]
-
-      if respond_to?("_#{endpoint}_ep_wrapper")
-        # we have this endpoint defined
-        send("_#{endpoint}_ep_wrapper", params)
-      elsif respond_to?(endpoint)
-        # for backward compatibility
-        ::ActiveSupport::Deprecation.warn("When overriding endpoints, use the '_endpoint' suffix (concerns: #{endpoint})", caller)
-        send(endpoint, params)
-      elsif respond_to?("#{endpoint}_endpoint")
-        # for backward compatibility
-        send("#{endpoint}_endpoint", params)
-      else
-        # Let's try to find it recursively in a component down the hierarchy
-        child_component, *action = endpoint.to_s.split('__')
-        child_component = child_component.to_sym
-        action = !action.empty? && action.join("__").to_sym
-
-        raise RuntimeError, "Component '#{self.class.name}' does not have endpoint '#{endpoint}'" if !action
-
-        if components[child_component]
-          component_instance(child_component).invoke_endpoint(action, params)
-        else
-          # component_missing can be overridden if necessary
-          component_missing(child_component)
-        end
-      end
-    end
-
-  end
-end

data/lib/netzke/session.rb

@@ -1,54 +0,0 @@
-module Netzke
-  # This modules provides (component-specific) session manupulation.
-  # The :session_persistence config option should be set to true in order for the component to make use of this.
-  module Session
-    class ComponentSessionProxy < Hash #:nodoc:
-      def initialize(component_id)
-        @component_id = component_id
-        super
-      end
-
-      def [](key)
-        (Netzke::Core.session[@component_id] || {})[key]
-      end
-
-      def []=(key, value)
-        (Netzke::Core.session[@component_id] ||= {})[key] = value
-        # super
-      end
-
-      def clear
-        Netzke::Core.session[@component_id].clear if Netzke::Core.session[@component_id]
-      end
-    end
-
-    # Top-level session (straight from the controller).
-    def session
-      ::Netzke::Core.session
-    end
-
-    # Component-specific session.
-    def component_session
-      @component_session_proxy ||= ComponentSessionProxy.new(global_id)
-    end
-
-    # Returns this component's configuration options stored in the session. Those get merged into the component's configuration at instantiation.
-    def session_options
-      session_persistence_enabled? && component_session[:options] || {}
-    end
-
-    # Updates the session options
-    def update_session_options(hash)
-      if session_persistence_enabled?
-        component_session.deep_merge!(:options => hash)
-      else
-        logger.debug "Netzke warning: No session persistence enabled for component '#{global_id}'"
-      end
-    end
-
-    private
-      def session_persistence_enabled?
-        initial_config[:session_persistence]
-      end
-  end
-end

data/lib/netzke/state.rb

@@ -1,91 +0,0 @@
-require 'active_support/core_ext/hash/indifferent_access'
-module Netzke
-  # When a persistence subsystem (such as {netzke-persistence}[https://github.com/skozlov/netzke-persistence]) is used, a widget can store its state using the +update_state+ method that accepts a hash, e.g.:
-  #     update_state(:position => {:x => 100, :y => 200})
-  #
-  # Later the state can be retrieved by calling the +state+ method:
-  #
-  #     state[:position] #=> {:x => 100, :y => 200}
-  #
-  # To enable persistence for a specific component, configure it with +persistence+ option set to +true+.
-  #
-  # == Sharing state
-  #
-  # Different components can share the state by sharing the persistence key, which can be provided as configuration option, e.g.:
-  #
-  #     netzke :books, :class_name => "Basepack::GridPanel", :persistence_key => "books_state_identifier"
-  #     netzke :deleted_books, :class_name => "Basepack::GridPanel", :persistence_key => "books_state_identifier"
-  #
-  # Make sure that the provided persistence_key has effect on _application_ level, _not_ only within the view.
-  # By default persistence_key is set to component's global id. Thus, <i>two components named equally will share the state even being used in different views</i>.
-  #
-  module State
-    # A string which will identify the component in persistence subsystem.
-    # If +persistence_key+ is passed, use it. Otherwise use global_id.
-    def persistence_key
-      initial_config[:persistence_key] ? initial_config[:persistence_key] : global_id
-    end
-
-    # Component's persistent state.
-    def state
-      @state ||= (state_manager.try(:state) || {}).symbolize_keys
-    end
-
-    # Merges passed hash into component's state.
-    # Can also accept 2 arguments which will be treated as a hash pair. E.g.:
-    #
-    #     update_state(:peoples_most_feared_number, 13)
-    #
-    # is equivalent to:
-    #
-    #     update_state(:peoples_most_feared_number => 13)
-    def update_state(*args)
-      state_manager.try(:update_state!, args.first.is_a?(Hash) ? args.first : {args.first => args.last})
-      @state = nil # reset cache
-    end
-
-    # Component's persistent state.
-    def global_state
-      @global_state ||= (global_state_manager.try(:state) || {}).symbolize_keys
-    end
-
-    # Merges passed hash into component's state.
-    def update_global_state(hsh)
-      global_state_manager.try(:update_state!, hsh)
-      @global_state = nil # reset cache
-    end
-
-    # Options merged into component's configuration right after default and user-passed config, thus being reflected in +Netzke::Base#independent_config+ (see Netzke::Configuration).
-    def persistent_options
-      (state[:persistent_options] || {}).symbolize_keys
-    end
-
-    # Updates +persistent_options+
-    def update_persistent_options(hsh)
-      new_persistent_options = persistent_options.merge(hsh)
-      new_persistent_options.delete_if{ |k,v| v.nil? } # setting values to nil means deleting them
-      update_state(:persistent_options => new_persistent_options)
-    end
-
-    protected
-
-    # Initialized state manager class. At this moment this class has current_user, component, and session set.
-    def state_manager
-      Netzke::Core.persistence_manager_class && Netzke::Core.persistence_manager_class.init({
-        :component => persistence_key,
-        :current_user => Netzke::Core.controller.respond_to?(:current_user) && Netzke::Core.controller.current_user,
-        :session => Netzke::Core.session
-      })
-    end
-
-    # Initialized state manager class, configured for managing global (not component specific) settings. At this moment this class has current_user and session set.
-    def global_state_manager
-      Netzke::Core.persistence_manager_class && Netzke::Core.persistence_manager_class.init({
-        :current_user => Netzke::Core.controller.respond_to?(:current_user) && Netzke::Core.controller.current_user,
-        :session => Netzke::Core.session
-      })
-    end
-
-
-  end
-end