Class: Netzke::Core::ClientClass

Inherits:

Object

• Object
• Netzke::Core::ClientClass

show all

Defined in:

lib/netzke/core/client_class.rb

Overview

class MyComponent < Netzke::Base
  js_configure do |c|
    c.extend = "Ext.form.Panel"
  end
end

Instance Attribute Summary (collapse)

• - (Object) base_class

  Returns the value of attribute base_class.

• - (Object) mixins

  Returns the value of attribute mixins.

• - (Object) properties

  Returns the value of attribute properties.

• - (Object) required_files

  Returns the value of attribute required_files.

• - (Object) translated_properties

  Returns the value of attribute translated_properties.

Instance Method Summary (collapse)

• - (Object) alias_prefix

  Alias prefix: 'widget' for components, 'plugin' for plugins.

• - (Object) class_alias

  The alias, required by Ext.Component, e.g.: widget.helloworld.

• - (Object) class_code

  Component's JavaScript class declaration.

• - (Object) class_declaration

  Generates declaration of the JS class as direct extension of a Ext component.

• - (Object) class_name

  Returns the full name of the JavaScript class, including the scopes and the common scope, which is 'Netzke.classes'.

• - (Object) code_with_dependencies

  JavaScript code needed for this particulaer class.

• - (Object) default_scope

  Top level scope which will be used to scope out Netzke classes.

• - (Object) extended_class

  Default extended class.

• - (Boolean) extending_extjs_component?

  Whether we have to inherit from an Ext JS component, or a Netzke component.

• - (ClientClass) initialize(klass) constructor

  A new instance of ClientClass.

• - (Object) method_missing(name, *args)

  Allows assigning JavaScript prototype properties, including functions:.

• - (Object) mixin(*args)

  Use it to “mixin” JavaScript objects defined in a separate file.

• - (Object) mixins_as_string
• - (Object) properties_as_string
• - (Object) require(*args)

  Use it to specify JavaScript files to be loaded before this component's JavaScript code.

• - (Object) required

  Returns all required JavaScript files as a string.

• - (Object) scope

  Returns the scope of this component e.g.

• - (Object) translate(*args)

  Defines the “i18n” config property, that is a translation object for this component, such as:.

• - (Object) xtype

  Builds this component's xtype E.g.: netzkebasepackwindow, netzkebasepackgridpanel.

13
14
15
16
17
18
19
20
21
22
23

# File 'lib/netzke/core/client_class.rb', line 13

def initialize(klass)
  @klass = klass
  @required_files = []
  @mixins = []
  @properties = {
    extend: extended_class,
    alias: class_alias,
  }
  @properties[:mixins] = ['Netzke.classes.Core.Mixin'] if extending_extjs_component?
  @translated_properties = []
end

class MyComponent < Netzke::Base
  js_configure do |c|
    # this will result in the +title+ property defined on the client class prototype
    c.title = "My cool component"

    # this will result in the +onButtonPress+ function defined on the client class prototype
    c.on_button_press = <<-JS
      function(){
        // ...
      }
    JS
  end
end

class MyComponent < Netzke::Base
  class_attribute :title
  self.title = "Some default title"
  js_configure do |c|
    c.title = self.title
  end
end

# e.g. in Rails initializers
MyComponent.title = "New title for all MyComponents"

MyComponent.setup do |config|
  config.title = "New title for all MyComponents"
end

63
64
65
66
67
68
69
70

# File 'lib/netzke/core/client_class.rb', line 63

def method_missing(name, *args)
  if name =~ /(.+)=$/
    value = args.first
    @properties[$1.to_sym] = value.is_a?(String) && value =~ /^\s*function/ ? ActiveSupport::JSON::Variable.new(value) : value
  else
    @properties[name.to_sym]
  end
end

11
12
13

# File 'lib/netzke/core/client_class.rb', line 11

def base_class
  @base_class
end

11
12
13

# File 'lib/netzke/core/client_class.rb', line 11

def mixins
  @mixins
end

11
12
13

# File 'lib/netzke/core/client_class.rb', line 11

def properties
  @properties
end

11
12
13

# File 'lib/netzke/core/client_class.rb', line 11

def required_files
  @required_files
end

11
12
13

# File 'lib/netzke/core/client_class.rb', line 11

def translated_properties
  @translated_properties
end

224
225
226

# File 'lib/netzke/core/client_class.rb', line 224

def alias_prefix
  @klass < Netzke::Plugin ? "plugin" : "widget"
end

149
150
151

# File 'lib/netzke/core/client_class.rb', line 149

def class_alias
  [alias_prefix, xtype].join(".")
end

161
162
163
164
165
166
167
168
169
170
171
172
173
174

# File 'lib/netzke/core/client_class.rb', line 161

def class_code
  res = []
  # Defining the scope if it isn't known yet
  res << %{Ext.ns("#{scope}");} unless scope == default_scope

  res << class_declaration

  # Store created class xtype in the cache
  res << %(
Netzke.cache.push('#{xtype}');
)

  res.join("\n")
end

219
220
221

# File 'lib/netzke/core/client_class.rb', line 219

def class_declaration
%(Ext.define('#{class_name}', #{properties_as_string});)
end

189
190
191

# File 'lib/netzke/core/client_class.rb', line 189

def class_name
  [scope, @klass.name.split("::").last].join(".")
end

214
215
216

# File 'lib/netzke/core/client_class.rb', line 214

def code_with_dependencies
  [required, class_code].join("\n")
end

177
178
179

# File 'lib/netzke/core/client_class.rb', line 177

def default_scope
  "Netzke.classes"
end

242
243
244

# File 'lib/netzke/core/client_class.rb', line 242

def extended_class
  extending_extjs_component? ? "Ext.panel.Panel" : @klass.superclass.js_config.class_name
end

194
195
196

# File 'lib/netzke/core/client_class.rb', line 194

def extending_extjs_component?
  @klass.superclass == Netzke::Base
end

class MyComponent < Netzke::Base
  js_configure do |c|
    c.mixin :some_functionality
    #...
  end
end

{
  someProperty: 100,
  someMethod: function(params){
    // ...
  }
}

121
122
123
124
125
126
127

# File 'lib/netzke/core/client_class.rb', line 121

def mixin(*args)
  args << @klass.name.split("::").last.underscore.to_sym if args.empty?
  callr = caller.first
  args.each do |a|
    @mixins << (a.is_a?(Symbol) ? expand_require_path(a, callr) : a)
  end
end

228
229
230
231
232
233
234
235

# File 'lib/netzke/core/client_class.rb', line 228

def mixins_as_string
  mixins.presence && mixins.map do |f|
    as_string = File.read(f)
    as_string.sub!('{', ' ')
    as_string[as_string.rindex('}')] = ' '
    as_string.rstrip
  end.join(",\n")
end

237
238
239

# File 'lib/netzke/core/client_class.rb', line 237

def properties_as_string
  [properties.netzke_jsonify.to_json.chop,  mixins_as_string].compact.join(",\n") + "}"
end

class MyComponent < Netzke::Base
  js_configure do |c|
    c.require :some_library
  end
end

js_configure do |c|
  c.require "#{File.dirname(__FILE__)}/my_component/one.js", "#{File.dirname(__FILE__)}/my_component/two.js"
end

91
92
93
94
95

# File 'lib/netzke/core/client_class.rb', line 91

def require(*args)
  callr = caller.first

  @required_files |= args.map{ |a| a.is_a?(Symbol) ? expand_require_path(a, callr) : a }
end

199
200
201
202
203
204
205
206
207
208
209
210
211

# File 'lib/netzke/core/client_class.rb', line 199

def required
  res = ""

  # Prevent re-including code that was already required by the parent
  # (thus, only require those JS files when require_js was defined in the current class, not in its ancestors)
  # FIXME!
  ((@klass.singleton_methods(false).map(&:to_sym).include?(:include_js) ? include_js : []) + required_files).each do |path|
    f = File.new(path)
    res << f.read << "\n"
  end

  res
end

183
184
185

# File 'lib/netzke/core/client_class.rb', line 183

def scope
  [default_scope, *@klass.name.split("::")[0..-2]].join(".")
end

i18n: {
  overwriteConfirm: "Are you sure you want to overwrite preset '{0}'?",
  overwriteConfirmTitle: "Overwriting preset",
  deleteConfirm: "Are you sure you want to delete preset '{0}'?",
  deleteConfirmTitle: "Deleting preset"
}

class MyComponent < Netzke::Base
  js_configure do |c|
    c.translate :overwrite_confirm, :overwrite_confirm_title, :delete_confirm, :delete_confirm_title
  end
end

144
145
146

# File 'lib/netzke/core/client_class.rb', line 144

def translate(*args)
  @translated_properties |= args
end

155
156
157

# File 'lib/netzke/core/client_class.rb', line 155

def xtype
  @klass.name.gsub("::", "").downcase
end