lorj 0.2.0 → 1.0.0

data/example/students_4/process/students.rb

@@ -1,112 +0,0 @@
-# Students process
-class StudentsProcess
-   def create_student(sObjectType, hParams)
-      PrcLib::state ("Running creation process for object '%s' = '%s'" % [sObjectType, hParams[:student_name] ])
-
-      aStudentName = hParams[:student_name].split(" ")
-      # config object is a reference to runtime/config data.
-      config[:first_name] = aStudentName[0]
-      config[:last_name] = aStudentName[1]
-
-      oList = Query(sObjectType, {:name => hParams[:student_name]})
-      case oList.length
-         when 0
-            oObject = controller_create(sObjectType)
-            raise "Student '%s' not created." % hParams[:student_name] if oObject.nil?
-            PrcLib::info ("'%s': '%s' created with id %s" % [sObjectType, hParams[:student_name],  oObject[:id]])
-         when 1
-            oObject = oList[0]
-            PrcLib::info ("'%s': '%s' loaded with id %s" % [sObjectType, hParams[:student_name],  oObject[:id]])
-         else
-            oObject = oList[0]
-            PrcLib::warning("More than one student named '%s' is found: %s records. Selecting the first one and removing duplicates." % [hParams[:student_name], oList.length])
-            iCount = 0
-            oList[1..-1].each { | elem |
-               register(elem)
-               iCount += controller_delete(sObjectType)
-            }
-            PrcLib::info ("'%s': %s duplicated '%s' removed. First loaded with id %s" % [sObjectType, iCount, hParams[:student_name],  oObject[:id]])
-      end
-      oObject
-   end
-
-   def query_student(sObjectType, sQuery, hParams)
-      PrcLib::state ("Running query process for object '%s' with query '%s'" % [sObjectType, sQuery])
-
-      oObjects = controller_query(sObjectType, sQuery)
-      raise "Query error." if oObjects.nil?
-
-      PrcLib::info ("'%s': Queried. %s records found." % [sObjectType, oObjects.length])
-      oObjects
-   end
-
-   def get_student(sObjectType, sId, hParams)
-      PrcLib::state ("Running get process for object '%s' with ID %s" % [sObjectType, sId ])
-
-      oObject = controller_get(sObjectType, sId)
-      PrcLib::debug("No ID %s found." % sId) if oObject.nil?
-
-      oObject
-   end
-
-   def delete_student(sObjectType, hParams)
-      Error "Unable to delete students, if at least one student is not loaded, or query not defined." if not hParams.exist?(:student) and not hParams.exist?(:query)
-
-      # This student deletion process supports 2 modes:
-      # - Delete from a query field (:query hParams)
-      # - Delete the latest loaded student.
-
-      if hParams.exist?(:query)
-         result = Query(sObjectType, hParams[:query])
-         if result.length > 0
-            result.each { | student |
-               puts "Student to remove: %s = %s" % [student[:id], student[:name]]
-               register(student)
-               controller_delete(:student)
-               PrcLib::info ("'%s:%s' student removed" % [student[:id], student[:name]])
-            }
-         end
-      else
-         controller_delete(:student)
-      end
-   end
-end
-
-# Declaring your data model and handlers.
-class Lorj::BaseDefinition
-
-   # We need to define the student object and the handler to use while we need to create it.
-   define_obj(:student,
-   {
-      :create_e => :create_student, # The function to call in the class Students
-      :query_e  => :query_student,
-      :delete_e => :delete_student,
-      :get_e    => :get_student
-   })
-
-   # All obj_needs will be collected and passed to the process handler as hParams.
-   # Data required to create a student
-   obj_needs   :data,   :student_name,         { :for => [:create_e] }
-
-   # Data optional for any kind of event
-   obj_needs_optional
-   obj_needs   :data,   :query,                { :for => [:delete_e] }
-   obj_needs   :data,   :first_name
-   obj_needs   :data,   :last_name
-   obj_needs   :data,   :course
-
-   # Define Data a student object needs to take care.
-   # The controller should map it if needed (if the value exists)
-   # But it can also add some extra attributes not predefined by the process.
-   # Usually, the process should ignore it.
-   # But if it detect it, the process should be careful with this data
-   # which are really specific to only one controller and may break the controller agnostic capability.
-   def_attribute :course
-   def_attribute :first_name
-   def_attribute :last_name
-   def_attribute :name
-   def_attribute :status
-end
-
-class Lorj::BaseDefinition
-end

data/example/students_4/students.rb

@@ -1,103 +0,0 @@
-#!/usr/bin/env ruby
-
-$APP_PATH = File.dirname(__FILE__)
-require 'lorj'
-require 'ansi'
-
-# If you want to see what is happening in the framework, uncomment debug settings.
-#PrcLib.level = Logger::DEBUG # Printed out to your console.
-#PrcLib.core_level = 3 # framework debug levels. (0 to 5)
-
-# Load global Config
-
-# This object is used to provide configuration data to lorj
-
-# The config search is:
-# 1- Application defaults (defaults.yaml) - Not defined by default. update the following line and create defaults.yaml
-# PrcLib.app_defaults = $APP_PATH
-# 2- Local defaults (~/.<Application Name>/config.yaml) - <Application Name> is 'Lorj' by default. Can be updated with following line.
-# PrcLib.app_name = 'myapp'
-# 3 - runtime. Those variables are set, with oConfig[key] = value
-
-oConfig = Lorj::Config.new() # Use Simple Config Object
-
-# You can use an account object, which add an extra account level
-# between runtime and config.yaml/app default
-# oConfig = Lorj::Account.new('MyAccount')
-
-
-# Initialize the framework
-# Use students process
-hProcesses = [ File.join($APP_PATH, 'process', 'students.rb')]
-# Use yaml_students controller
-sController = File.join($APP_PATH, 'controller', 'yaml_students.rb')
-oStudentCore = Lorj::Core.new( oConfig, hProcesses, sController )
-
-# This kind of connection_string should be part of an Account Data.
-# So, we won't need to set this config.
-# But you can imagine to set at runtime this config as well.
-oConfig[:connection_string] = "/tmp/students.yaml"
-
-# Note that we have commented the next line.
-# oStudentCore.Create(:connection, :connection_string => "/tmp/students.yaml")
-# This call is not required, as the framework has all the information to create
-# the connection, at the first time this connection is required.
-# ie, while starting to create a student.
-
-
-# Set the student name to use
-oConfig[:student_name] = "Robert Redford"
-
-# Ask the framework to create the object student 'Robert Redford'
-puts ANSI.bold("Create 1st student:")
-oStudentCore.Create(:student)
-# The connection is made because creating a student requires
-# the object :connection. (See example/students_4/controller/yaml_students.rb, around line 70)
-
-puts ANSI.bold("Create 2nd student:")
-# Want to create a duplicated student 'Robert Redford'?
-oStudentCore.Create(:student)
-# Because the process ensure that there is no duplicate, this won't create duplicates
-
-# We can set runtime configuration instantly from the Create call
-# The following line :
-puts ANSI.bold("Create 3rd student:")
-oStudentCore.Create(:student, {:student_name => "Anthony Hopkins"})
-# replaced the following :
-# oConfig[:student_name] = "Anthony Hopkins"
-# oStudentCore.Create(:student)
-
-# Let's query students named "Robert Redford"
-puts ANSI.bold("Querying students as 'Robert Redford':")
-oStudents = oStudentCore.Query(:student, { :name => "Robert Redford" } )
-
-puts "%s students found for '%s':" % [oStudents.length, "Robert Redford"]
-
-oStudents.each { | oStudent |
-   puts "%s: %s" % [oStudent[:id], oStudent[:name]]
-}
-
-# let's check the get function, who is the ID 2?
-puts ANSI.bold("Who is student ID 2?")
-oStudent = oStudentCore.Get(:student, 2)
-
-puts "\nThe student ID 2 is %s" % oStudent[:name] unless oStudent.nil?
-puts "\nThe student ID 2 doesn't exist." if oStudent.nil?
-
-puts ANSI.bold("Create mistake")
-oStudentCore.Create(:student, {
-   :student_name => "Anthony Mistake",
-   :course => 'what ever you want!!!'
-})
-
-# The query logic has been implemented directly in the process,
-# so now, any kind of  controller Delete will have the same behavior...
-puts ANSI.bold("Remove mistake")
-hQuery = { :name => "Anthony Mistake"}
-oStudentCore.Delete(:student, :query => hQuery)
-
-puts ANSI.bold("List of students for 'Art Drama':")
-puts oStudentCore.Query(:student, { :course => "Art Drama"}).to_a
-
-puts ANSI.bold("Deleted students:")
-puts oStudentCore.Query(:student,{ :status => :removed}).to_a

data/lib/core/lorj-basecontroller.rb

@@ -1,90 +0,0 @@
-#!/usr/bin/env ruby
-# encoding: UTF-8
-
-# (c) Copyright 2014 Hewlett-Packard Development Company, L.P.
-#
-#    Licensed under the Apache License, Version 2.0 (the "License");
-#    you may not use this file except in compliance with the License.
-#    You may obtain a copy of the License at
-#
-#        http://www.apache.org/licenses/LICENSE-2.0
-#
-#    Unless required by applicable law or agreed to in writing, software
-#    distributed under the License is distributed on an "AS IS" BASIS,
-#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#    See the License for the specific language governing permissions and
-#    limitations under the License.
-
-# Module Lorj which contains several classes.
-#
-# Those classes describes :
-# - processes (BaseProcess)   : How to create/delete/edit/query object.
-# - controler (BaseControler) : If a provider is defined, define how will do object creation/etc...
-# - definition(BaseDefinition): Functions to declare objects, query/data mapping and setup
-# this task to make it to work.
-
-module Lorj
-
-   class BaseController
-      # Default handlers which needs to be defined by the controller,
-      # called by BaseDefinition Create functions.
-      def connect(sObjectType, hParams)
-         raise Lorj::PrcError.new(), "connect has not been redefined by the controller '%s'" % self.class
-      end
-
-      # Default handlers which needs to be defined by the controller,
-      # called by BaseDefinition Create functions.
-      def create(sObjectType, hParams)
-         raise Lorj::PrcError.new(), "create_object has not been redefined by the controller '%s'" % self.class
-      end
-
-      # Default handlers which needs to be defined by the controller,
-      # called by BaseDefinition Delete functions.
-      def delete(sObjectType, hParams)
-         raise Lorj::PrcError.new(), "delete_object has not been redefined by the controller '%s'" % self.class
-      end
-
-      # Default handlers which needs to be defined by the controller,
-      # called by BaseDefinition Get functions.
-      def get(sObjectType, sUniqId, hParams)
-         raise Lorj::PrcError.new(), "get_object has not been redefined by the controller '%s'" % self.class
-      end
-
-      # Default handlers which needs to be defined by the controller,
-      # called by BaseDefinition Query functions.
-      def query(sObjectType, sQuery, hParams)
-         raise Lorj::PrcError.new(), "query_object has not been redefined by the controller '%s'" % self.class
-      end
-
-      # Default handlers which needs to be defined by the controller,
-      # called by BaseDefinition Update functions.
-      def update(sObjectType, oObject, hParams)
-         raise Lorj::PrcError.new(), "update_object has not been redefined by the controller '%s'" % self.class
-      end
-
-      # Simply raise an error
-      #
-      # * *Args*    :
-      #   - +Msg+ : Error message to print out.
-      # * *Returns* :
-      #   - nil
-      # * *Raises* :
-      #  - Lorj::PrcError
-      def Error(msg)
-         raise Lorj::PrcError.new(), "%s: %s" % [self.class, msg]
-      end
-
-      # check if required data is loaded. raise an error if not
-      #
-      # * *Args*    :
-      #   - +Params+ : Lorj::ObjectData object for controller.
-      #   - +key+    : Key to check.
-      # * *Returns* :
-      #   - nil
-      # * *Raises* :
-      #   - +Error+ if the key do not exist.
-      def required?(oParams, *key)
-         raise Lorj::PrcError.new(), "%s: %s is not set." % [self.class, key] if not oParams.exist?(key)
-      end
-   end
-end