RubyGems - netzke - Versions diffs - 0.12.0 → 1.0.0.0.pre - Mend

netzke 0.12.0 → 1.0.0.0.pre

Files changed (9) hide show

data/.gitignore CHANGED

@@ -7,7 +7,9 @@ Gemfile.lock
 InstalledFiles
 _yardoc
 coverage
-doc/
+doc/client/netzke-*
+doc/client/build
+doc/client/.yuidocs
 lib/bundler/man
 pkg
 rdoc

data/README.md CHANGED

@@ -1,34 +1,159 @@
 Netzke is a framework that greatly facilitates creation of complex [Sencha Ext JS](http://www.sencha.com/products/extjs/) + [Ruby-on-Rails](http://rubyonrails.org/) applications by leveraging a modular, object-oriented approach.
+*Notes on versioning:*
+* The latest *released* version is: [![Gem Version](https://badge.fury.io/rb/netzke.svg)](https://badge.fury.io/rb/netzke)
+* The version under development (master): [version.rb](https://github.com/netzke/netzke/blob/master/lib/netzke/version.rb)
+* For other versions check corresponding [branches](https://github.com/netzke/netzke/branches)
+## Rationale
+[Sencha Ext JS]("http://www.sencha.com/products/extjs") is a powerful front-end framework, which is used for crafting web-apps that give the end user experience similar to that of a desktop application. It has an extensive set of widgets ('components'), and leverages a modular approach to its fullest: a developer can extend components (using Ext JS's own class system), nest components with the help of many powerful layouts, dynamically create and destroy them, etc. The architecture of Ext JS is well thought out and complete.
+However, with Ext JS being server-agnostic, it is not always a trivial task for a developer to bind Ext JS components to the server-side data *and* application business logic, especially in complex applications. Netzke as the solution that allows you to extend the modular approach to the server side.
+Netzke Core takes the burden of implementing the following key aspects of the framework:
+* Client-side (JavaScript) class generation
+* Client-server communication
+* Extendibility of components (with the help of inheritance and mixins)
+* Unlimited nesting (composition)
+* Dynamic component loading
+* Client-side class caching
+...and more.
+All this extremely facilitates building fast, low-traffic, robust, and highly maintainable applications. As a result, your code scales much better in the sense of complexity, compared to using conventional MVC, where developers are pretty much limited with the programming techniques that they can apply.
+## HelloWorld component
+Here's a mini-tutorial on building a simple Netzke component that illustrates client-server communication in Netzke.
+Ext JS files are not distributed with Netzke, so, make sure that they are located in (or sym-linked as) `YOUR_APP/public/extjs`.
+In `YOUR_APP/components/hello_world.rb`:
+```ruby
+class HelloWorld < Netzke::Base
+  # Configure client class
+  client_class do |c|
+    c.title = "Hello World component"
+  end
+  # Actions are used by Ext JS to share functionality and state b/w buttons and menu items
+  # The handler for this action should be called netzkeOnPingServer by default
+  action :ping_server
+  # Self-configure with a bottom toolbar
+  def configure(c)
+    super
+    c.bbar = [:ping_server] # embed the action into bottom toolbar as a button
+  end
+  # Endpoint callable from client class
+  endpoint :greet_the_world
+    # call client class' method showGreeting
+    client.show_greeting("Hello World!")
+  end
+end
+```
+In `YOUR_APP/components/hello_world/client/hello_world.js` put the client class (JavaScript) methods:
+```javascript
+{
+  // handler for the ping_server action
+  netzkeOnPingServer: function(){
+    // calling greet_the_world endpoint
+    this.server.greetTheWorld();
+  },
+  // called by the server as the result of executing the endpoint
+  showGreeting: function(greeting){
+    this.update("Server says: " + greeting);
+  }
+}
+```
+To embed the component in Rails view:
+Add `netzke` routes:
+```ruby
+# in routes.rb
+RailsApp::Application.routes.draw do
+  netzke
+  ...
+end
+```
+Use `load_netzke` in the layout to include Ext JS and Netzke scripts and stylesheets:
+```erb
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv="Content-type" content="text/html; charset=utf-8">
+  <%= csrf_meta_tag %>
+  <%= load_netzke %>
+</head>
+<body>
+  <%= yield %>
+</body>
+</html>
+```
+Embed the component in the Rails view:
+```erb
+<%= netzke :hello_world %>
+```
+To further familiarize yourself with Netzke architecture, refer to the [Netzke Core README](https://github.com/netzke/netzke-core).
+## Netzke gems
 The `netzke` Ruby gem is a meta-gem that has the following framework parts as dependencies:
-* [Netzke Core](https://github.com/netzke/netzke-core) - the "bare bones" of the framework. Its README is a must-read for understanding the framework.
+* [Netzke Core](https://github.com/netzke/netzke-core) - the "bare bones" of the framework. Its [README](https://github.com/netzke/netzke-core) is a must-read for understanding the framework.
 * [Netzke Basepack](https://github.com/netzke/netzke-basepack) - a few feature-packed pre-built components.
 * [Netzke Testing](https://github.com/netzke/netzke-testing) - a set of helpers that simplify development and testing of Netzke components.
+## Documentation
+Netzke components contain both server-side and client-side code, both having API that you will want to use in your code.
+Documentation for the server-side (Ruby) classes is auto-generated (with YARD) and hosted by
+[RubyDoc.info](http://www.rubydoc.info/). Documentation for client-side classes is generated manually with
+[yuidoc](http://yui.github.io/yuidoc/) using scripts provided in this gem; it is hosted [here](http://api.netzke.org/client/).
+### Generating documentation for client-side code
+Symlink Netzke gems (such as netzke-basepack and netzke-core) into the `doc/client` directory, then run
+    rake client_doc:generate
+The combined docs for all symlinked gems will be generated in `doc/client/build`.
 ## Useful links
-* [Project website](http://netzke.org) - a place to start
-* [Demo](http://netzke-demo.herokuapp.com) - a demo showing off components from Basepack.
-* [Yanit](http://yanit.heroku.com) - Yet Another (Netzke) Issue Tracker, a pretty complex demo app that could be easily written in just a few hours.
-* [Twitter](https://twitter.com/netzke) - news about Netzke.
+* [Project website](http://netzke.org) - place to start
+* [Demo](http://demo.netzke.org) - demo showing off components from Basepack (browse through demo components and see their source code)
+* [Yanit](http://yanit.netzke.org) - "Yet Another (Netzke) Issue Tracker", a pretty complex demo app that could be easily written in just a few hours
+* [Twitter](https://twitter.com/netzke) - bite-sized announcements about Netzke
 ## FAQ
 ### Will I need to write JavaScript while using Netzke?
-Yes and no. For developing new components or extending existing ones (e.g. from [Basepack](https://github.com/netzke/netzke-basepack)) you'll most probably need to apply your Sencha Ext JS knowledge (and Netzke isn't supposed to limit you here in any way). However, the idea is that you write JavaScript code only once. After the component is created, use it as if it was a part of some Ruby library. A comparison with Ruby gems that use C extensions is also appropriate here: as some Ruby gems incapsulate C code for you, the same way Netzke components incapsulate JavaScript.
+Yes and no. For developing new components or extending existing ones (e.g. from [Basepack](https://github.com/netzke/netzke-basepack)) you'll most probably need to apply your Sencha Ext JS knowledge (and Netzke isn't supposed to limit you here in any way). However, the idea is that you write JavaScript code only once. After the component is created, use it as if it were a part of some Ruby library. A comparison with Ruby gems that use C extensions is also appropriate here: as some Ruby gems incapsulate C code for you, the same way Netzke components incapsulate JavaScript.
 ### Why did you choose for Ext JS as front end?
-In the current scene, Ext JS is the only library I know of with the architecture consistent, flexible, and complete enough to allow for complex desktop-like web applications.
+In the current scene, Ext JS is the only library I know of that has the architecture consistent, flexible, and complete enough to allow for complex desktop-like web applications.
 ### When will there be more components available?
-I’m creating new components according to my own practical needs. As I’ll be getting something generic, I’ll be adding it to netzke-basepack (or to dedicated gems). However, the key idea of Netzke is that it facilitates creating new components which are extremely easy to share, so, anyone can create his own repository of components to share.
+I'm creating new components according to my own practical needs. As soon as get something generic, I might add that to [netzke-basepack](https://github.com/netzke/netzke-basepack) or to a dedicated gem. However, the key idea of Netzke is that it facilitates creating new components which are extremely easy to share, so that anybody could contribute.
 ---
-Copyright (c) 2008-2015 [Max Gorin](https://twitter.com/mxgrn), released under the MIT license (see LICENSE).
-**Note** that Ext JS is licensed [differently](http://www.sencha.com/products/extjs/license/), and you may need to purchase a commercial license in order to use it in your projects!
+Copyright (c) 2009-2015 [Good Bit Labs](http://goodbitlabs.com/), released under the GPLv3 license

data/Rakefile CHANGED

@@ -1 +1,26 @@
 require "bundler/gem_tasks"
+CLIENT_DOC = "doc/client"
+require_relative "#{CLIENT_DOC}/netzke-core/lib/netzke/core/version"
+require_relative "#{CLIENT_DOC}/netzke-basepack/lib/netzke/basepack/version"
+namespace :client_doc do
+  desc "Generate client-side docs"
+  task :generate do
+    version = "Core #{Netzke::Core::VERSION}, Basepack #{Netzke::Basepack::VERSION}"
+    puts "Generating client-side docs #{version}..."
+    `rm -rf doc/client/build`
+    `yuidoc #{CLIENT_DOC} --project-version "#{version}"`
+  end
+  desc "Publish client-side docs"
+  task publish: :generate do
+    server = "netzke.com"
+    dir = 'www/api.netzke.org/client'
+    puts "Publishing to #{server}:/home/mxgrn/#{dir}..."
+    `ssh #{server} "mkdir -p #{dir}"`
+    `rsync -r #{CLIENT_DOC}/build/* #{server}:#{dir}`
+    puts "Done"
+  end
+end

data/doc/client/.keep ADDED

File without changes

data/lib/netzke/version.rb CHANGED

@@ -1,3 +1,3 @@
 module Netzke
-  VERSION = "0.12.0"
+  VERSION = "1.0.0.0.pre"
 end

data/netzke.gemspec CHANGED

@@ -1,4 +1,3 @@
-# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'netzke/version'
@@ -12,16 +11,15 @@ Gem::Specification.new do |spec|
   spec.summary       = "Client-server GUI components with Sencha Ext JS and Ruby on Rails"
   spec.description   = "Build complex web UI in a modular way"
   spec.homepage      = "http://netzke.org"
-  spec.license       = "MIT"
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
-  spec.add_dependency "netzke-core", "~>0.12.0"
-  spec.add_dependency "netzke-basepack", "~>0.12.0"
-  spec.add_dependency "netzke-testing", "~>0.12.0"
+  spec.add_dependency "netzke-core", "1.0.0.0.pre"
+  spec.add_dependency "netzke-basepack", "1.0.0.0.pre"
+  spec.add_dependency "netzke-testing", "1.0.0.0.pre"
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"

data/yuidoc.json ADDED

@@ -0,0 +1,10 @@
+{
+  "name": "Netzke",
+  "description": "Client-server components with Ext JS and Rails",
+  "logo": "http://netzke.org/images/full-logo-h30.png",
+  "url": "http://netzke.org",
+  "options": {
+    "exclude": "doc/client/netzke-core/spec/rails_app/public/extjs,doc/client/netzke-basepack/spec/rails_app/public/extjs",
+    "outdir": "doc/client/build"
+  }
+}

metadata CHANGED

@@ -1,83 +1,94 @@
 --- !ruby/object:Gem::Specification
 name: netzke
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 1.0.0.0.pre
+  prerelease: 8
 platform: ruby
 authors:
 - Max Gorin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-03-18 00:00:00.000000000 Z
+date: 2015-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: netzke-core
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 1.0.0.0.pre
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 1.0.0.0.pre
 - !ruby/object:Gem::Dependency
   name: netzke-basepack
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 1.0.0.0.pre
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 1.0.0.0.pre
 - !ruby/object:Gem::Dependency
   name: netzke-testing
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 1.0.0.0.pre
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 1.0.0.0.pre
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Build complex web UI in a modular way
@@ -87,37 +98,39 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
+- .gitignore
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- doc/client/.keep
 - lib/netzke.rb
 - lib/netzke/version.rb
 - netzke.gemspec
+- yuidoc.json
 homepage: http://netzke.org
-licenses:
-- MIT
-metadata: {}
+licenses: []
 post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - ">="
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project:
-rubygems_version: 2.4.5
+rubygems_version: 1.8.23.2
 signing_key:
-specification_version: 4
+specification_version: 3
 summary: Client-server GUI components with Sencha Ext JS and Ruby on Rails
 test_files: []
 has_rdoc:

checksums.yaml DELETED

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 88abe29aff5dd69b3b5dd4b9ed12dc578cf0b84f
-  data.tar.gz: 5302385c591501aa28dcef9d1fda7fbd7dceda10
-SHA512:
-  metadata.gz: e4079174a27ba5a5d9ce381e1ae5a85f204cb6bb5e02b074d7815f0100ac0f0c8b45898e94cb3a67807dcdb4e73b98574fa0b8a1a09708f70c8fb5c323563068
-  data.tar.gz: d56da6c1e9d60f9a88a8f305b996c2965dfe8dc593cf3f31ffd177db11889524207bbf2cbac05b1e417750e72b99b5e8c6e25b68e043147379dbfa0d9d0e566e