smartclient 0.0.3 → 0.0.4

data/lib/DSRequest.rb

@@ -1,4 +1,11 @@
 require 'DataSource'
+=begin
+  <summary>
+     reference to the RPCManager executing this request will be stored in DSRequest.
+     This has to be done because, while the request is being.executed, access will be required to various items such as 
+     the DataSource object, etc - These items will all be provided by the RPCManager class.
+  </summary> 
+=end
 class DSRequest
     attr_accessor :dataSource, :operationType, :startRow, :endRow, :textMatchStyle, :data, :sortBy, :oldValues
     
@@ -26,7 +33,16 @@ class DSRequest
       
       @@obj = model
     end 
-    
+=begin
+    <summary>
+      The execute() method itself only loads the DataSource object then calls the DataSource's execute method for 
+      processing the request.
+    </summary>
+      <params>
+        @datasource: DataSource object from the RPCManager helper class
+        @@obj: model object that is mapped to the table
+      </params>  
+=end
     def execute
       ds = DataSource.new(@dataSource, @@obj)
       if ds.nil?

data/lib/DataSource.rb

@@ -1,3 +1,9 @@
+=begin
+  <summary>
+    This helper classes process the request after recieve from the DSRequest.
+    The CRUD methods(add, remove, update, fetch) were supported.      
+  </summary>  
+=end
 class DataSource
   attr_accessor :data_source
   @data_source = nil
@@ -6,7 +12,9 @@ class DataSource
     #@data_source = self.get_data(path)
     @model = model
   end
-  
+=begin
+  <summary> get the DataSource contents from the path and parse to JSON format </summary>  
+=end  
   def get_data(path)
     ds_content = File.read(path)
     #remove the isc tag and the end tag
@@ -16,7 +24,9 @@ class DataSource
     result = ds_content.gsub('/\r|\n|\t|>>|\/\//', '')
     return JSON.parse(result)
   end
-  
+=begin
+  <summary> get the field content by the filed name </summary>  
+=end  
   def get_field(field_name)
     fields = @data_source['fields']
     
@@ -27,7 +37,9 @@ class DataSource
     end     
     return nil
   end
-  
+=begin
+  <summary> process the request </summary>  
+=end
   def execute(request)
     operation_type = request.operationType      
       case operation_type
@@ -43,9 +55,14 @@ class DataSource
     return @result
   end
   
-private  
+private
+=begin
+  <summary> get the item list from the table </summary>
+  <note>Before this method is called, the filter method should define in the model of the projects.</note>  
+=end  
   def fetch(request)      
-      unless request.data.empty?                      
+      unless request.data.empty?
+          # get the filter from the model                      
           @obj_items = @model.filter(request) 
       else
           # get all supplyitems from the database
@@ -54,7 +71,9 @@ private
 
       objs_count = @obj_items.count
       # get the count of the obj_items      
-      endRow = (objs_count > 0)?objs_count - 1 : objs_count 
+      endRow = (objs_count > 0)?objs_count - 1 : objs_count
+      
+      # make the Response result object 
       response = DSResponse.new
       response.data = @obj_items
       response.startRow = 0
@@ -65,7 +84,9 @@ private
       @result = { :response => response } 
       return @result 
     end
-     
+=begin
+  <summary>Add new item</summary>  
+=end     
     def add(request)      
       new_data = request.data
       new_supplyitem = @model.create(new_data)
@@ -75,24 +96,30 @@ private
       @result = { :response => response }
       return @result
     end
-    
+=begin
+  <summary>Remove the selected item</summary>  
+=end         
     def remove(request)      
       data = request.data
       item_id = data['itemID']
+      # remove the item
       @model.destroy(item_id)
       response = DSResponse.new
       response.data = data
       response.status = 0
       @result = { :response => response }
-      return @result
-      
+      return @result 
     end
-    
+=begin
+  <summary>Update the items</summary>  
+=end         
     def update(request)      
+      # get the old data from the request object
       old_data = request.oldValues
+      # get the date from the request object
       update_data = request.data
       item_id = update_data['itemID']
-            
+      # merge to hash objects      
       merged_data = old_data.merge!(update_data)      
       merged_data.delete('itemID')
       

data/lib/RPCManager.rb

@@ -1,9 +1,27 @@
+=begin
+  <summary>
+    Any action of the user with the DataSource will only call the RPCManager and will delegate all responsibility to it. 
+    The RPCManager will parse the payload and setup the DSRequest request and will call for the request's execute() method
+     which will return the DSResponse object. The RPCManager will then convert this DSResponse into a suitable response 
+     and return it to the front-end.  
+   </summary>
+=end
 require 'DSRequest'
 require 'DSResponse'
 
 class RPCManager
   @request = nil  
   @model = nil
+=begin
+  <summary>
+    Process the request with the model.
+  </summary>  
+  
+  <params>
+    request: posted request parameters
+    model: the object that is mapped to the table
+  </params>
+=end
   def initialize(request=nil, model=nil)
     @request = request
     @model = model
@@ -17,12 +35,11 @@ class RPCManager
       <returns>the created json object</returns>
 =end
   def processRequest
-    # retrieve the requests with data
-   
+    # retrieve the requests with data   
     req = DSRequest.new(@request, @model)  
     # set the response variable
     res = req.execute
-  File.open('kris.txt', 'w') { |file| file.write(res) }
+  
     # safeguard, if was null, create an empty response with failed status
     if res.nil?
       res = DSResponse.new

data/lib/filter.rb

@@ -0,0 +1,32 @@
+def self.filter(request)    
+    param = Array.new    
+    condition = '' 
+    request.data.each do |key, value|
+        condition += "#{key} LIKE ? AND "
+        param << "%" + value + "%" 
+    end
+    q = condition[0, condition.rindex('AND ')]
+    temp = Array.new
+    temp << q    
+    temp.concat(param)
+    where(temp)
+    order = ''
+    # sort by
+    unless request.sortBy.nil?
+      request.sortBy.each do |idx|
+         if idx.index('-') === nil 
+              order = idx.to_s + " ASC"
+         else
+              order = idx.to_s + " DESC"    
+         end
+      end  
+    end    
+   # return the result
+    
+    
+   if order == nil
+      where(temp)
+   else
+     where(temp).order(order)
+   end  
+end 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smartclient
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,10 @@ bindir: bin
 cert_chain: []
 date: 2013-05-14 00:00:00.000000000 Z
 dependencies: []
-description: This gem will work for the smartclient. The RPCManager Helper was added!
+description: ! "This gem will work for the smartclient. \n\t                 After
+  you install this gem, you should define the filter method in the models.\n\t                 To
+  do this you need to copy the filter method of the filter.rb of the gem/smartclient
+  directory to the model class."
 email: kris.jin81@gmail.com
 executables: []
 extensions: []
@@ -21,7 +24,8 @@ files:
 - lib/DSRequest.rb
 - lib/DSResponse.rb
 - lib/DataSource.rb
-homepage: https://isomorphic.atlassian.net
+- lib/filter.rb
+homepage: http://smartclient.com/
 licenses: []
 post_install_message: 
 rdoc_options: []