lorj 0.2.0 → 1.0.0

data/example/students_3/students.rb

@@ -1,6 +1,27 @@
 #!/usr/bin/env ruby
-
-$APP_PATH = File.dirname(__FILE__)
+# 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.
+
+app_path = File.dirname(__FILE__)
+
+if ENV['LORJ_DEV']
+  require 'byebug'
+  lib_path = File.expand_path(File.join(app_path, '..', '..', 'lib'))
+  $LOAD_PATH << lib_path
+end
 require 'lorj'
 require 'ansi'
 
@@ -9,85 +30,93 @@ require 'ansi'
 # 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
+# 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.
+# 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
+# 3 - runtime. Those variables are set, with config[key] = value
 
-oConfig = Lorj::Config.new() # Use Simple Config Object
+config = 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') #
-
+# config = Lorj::Account.new('MyAccount') #
 
-# 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.
+# 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 = 5 # framework debug levels.
 
 # Initialize the framework
-hProcesses = [ File.join($APP_PATH, 'process', 'students.rb')]
+processes = [File.join(app_path, 'process', 'students.rb')]
 
-#~ oStudentCore = Lorj::Core.new( oConfig, hProcesses, :mock)
-oStudentCore = Lorj::Core.new( oConfig, hProcesses, File.join($APP_PATH, 'controller', 'yaml_students.rb'))
+# ~ student_core = Lorj::Core.new( config, processes, :mock)
+student_core = Lorj::Core.new(config,
+                              processes,
+                              File.join(app_path,
+                                        'controller',
+                                        'yaml_students.rb'))
 
-oStudentCore.Create(:connection, :connection_string => "/tmp/students.yaml")
+student_core.create(:connection, :connection_string => '/tmp/students.yaml')
 
-puts ANSI.bold("Create 1st student:")
+puts ANSI.bold('Create 1st student:')
 
 # Set the student name to use
-# There is different way to set them... Those lines do the same using config object. Choose what you want.
-oConfig.set(:first_name, 'Robert')
-oConfig[:last_name]    = "Redford"
-oConfig[:student_name] = "Robert Redford"
-oConfig[:course]       = 'Art Comedy'
+# There is different way to set them...
+# Those lines do the same using config object. Choose what you want.
+config.set(:first_name, 'Robert')
+config[:last_name]    = 'Redford'
+config[:student_name] = 'Robert Redford'
+config[:course]       = 'Art Comedy'
 
 # Ask the framework to create the object student 'Robert Redford'
-oStudentCore.Create(:student)
+student_core.create(:student)
 
-puts ANSI.bold("Create 2nd student:")
+puts ANSI.bold('Create 2nd student:')
 # We can set runtime configuration instantly from the Create call
 # The following line :
-oStudentCore.Create(:student, {
-   student_name:  'Anthony Hopkins',
-   first_name:    'Anthony',
-   last_name:     'Hopkins',
-   course:        'Art Drama'
-})
-# oConfig[:student_name] = "Anthony Hopkins"
-# oConfig[:course] = "Art Drama"
-# oStudentCore.Create(:student)
-
-puts ANSI.bold("Create 3rd student:")
-oStudentCore.Create(:student, {
-   student_name: "Marilyn Monroe",
-   first_name:   'Marilyn',
-   last_name:    'Monroe',
-   course:       'Art Drama'
-})
+student_core.create(:student,
+                    :student_name => 'Anthony Hopkins',
+                    :first_name => 'Anthony',
+                    :last_name => 'Hopkins',
+                    :course => 'Art Drama'
+)
+# config[:student_name] = "Anthony Hopkins"
+# config[:course] = "Art Drama"
+# student_core.Create(:student)
+
+puts ANSI.bold('Create 3rd student:')
+student_core.create(:student,
+                    :student_name => 'Marilyn Monroe',
+                    :first_name => 'Marilyn',
+                    :last_name => 'Monroe',
+                    :course => 'Art Drama'
+)
 # replaced the following :
-# oConfig[:student_name] = "Anthony Hopkins"
-# oStudentCore.Create(:student)
+# config[:student_name] = "Anthony Hopkins"
+# student_core.Create(:student)
 
-puts ANSI.bold("Create mistake")
-oStudent = oStudentCore.Create(:student, {
-   :student_name  => "Anthony Mistake",
-   :first_name    => 'Anthony',
-   :last_name     => 'Mistake',
-   :course        => 'what ever you want!!!'
-})
+puts ANSI.bold('Create mistake')
+student = student_core.create(:student,
+                              :student_name => 'Anthony Mistake',
+                              :first_name => 'Anthony',
+                              :last_name => 'Mistake',
+                              :course => 'what ever you want!!!'
+)
 
-puts "Student created '%s'" % oStudent[:attrs]
+puts format("Student created '%s'", student[:attrs])
 
 # Because the last student was the mistake one, we can directly delete it.
 # Usually, we use get instead.
-puts ANSI.bold("Remove mistake")
-oStudentCore.Delete(:student)
-puts "Wrong student to remove: %s = %s" % [oStudent[:id], oStudent[:student_name]]
+puts ANSI.bold('Remove mistake')
+student_core.delete(:student)
+puts format('Wrong student to remove: %s = %s',
+            student[:id], student[:student_name])
 
 puts ANSI.bold("List of students for 'Art Drama':")
-puts oStudentCore.Query(:student, { :course => "Art Drama"}).to_a
+puts student_core.query(:student,  :course => 'Art Drama').to_a
 
-puts ANSI.bold("Deleted students:")
-puts oStudentCore.Query(:student,{ :status => :removed}).to_a
+puts ANSI.bold('Deleted students:')
+puts student_core.query(:student, :status => :removed).to_a

data/example/yaml_students/students.rb

@@ -19,60 +19,60 @@
 require 'rubygems'
 require 'ansi'
 
-$APP_PATH = File.dirname(__FILE__)
+app_path = File.expand_path(File.dirname(__FILE__))
 
-require File.join($APP_PATH, 'yaml_students.rb')
+require File.join(app_path, 'yaml_students.rb')
 
 school = YamlSchool.new('/tmp/students.yaml')
 
-puts ANSI.bold("Create 1st student:")
-if school.query_student({:name => "Robert Redford"}).length == 0
-   school.create_student("Robert Redford", {
-      first_name: 'Robert',
-      last_name:  'Redford',
-      training:   'Art Comedy'
-   })
+puts ANSI.bold('Create 1st student:')
+if school.query_student(:name => 'Robert Redford').length == 0
+  school.create_student('Robert Redford',
+                        :first_name => 'Robert',
+                        :last_name => 'Redford',
+                        :training => 'Art Comedy'
+  )
 end
 
-puts ANSI.bold("Create 2nd student:")
-if school.query_student({:name => "Anthony Hopkins"}).length == 0
-   school.create_student("Anthony Hopkins", {
-      first_name: 'Anthony',
-      last_name:  'Hopkins',
-      training:   'Art Drama'
-   })
+puts ANSI.bold('Create 2nd student:')
+if school.query_student(:name => 'Anthony Hopkins').length == 0
+  school.create_student('Anthony Hopkins',
+                        :first_name => 'Anthony',
+                        :last_name => 'Hopkins',
+                        :training => 'Art Drama'
+  )
 end
 
-puts ANSI.bold("Create 3rd student:")
-if school.query_student({:name => "Marilyn Monroe"}).length == 0
-   school.create_student("Marilyn Monroe", {
-      first_name: 'Marilyn',
-      last_name:  'Mistake',
-      training:   'Art Drama'
-   })
+puts ANSI.bold('Create 3rd student:')
+if school.query_student(:name => 'Marilyn Monroe').length == 0
+  school.create_student('Marilyn Monroe',
+                        :first_name => 'Marilyn',
+                        :last_name => 'Mistake',
+                        :training => 'Art Drama'
+  )
 end
 
-puts ANSI.bold("Create mistake")
-oStudent = school.create_student("Anthony Mistake", {
-   first_name: 'Anthony',
-   last_name:  'Mistake',
-   training:   'what ever you want!!!'
-})
+puts ANSI.bold('Create mistake')
+student = school.create_student('Anthony Mistake',
+                                :first_name => 'Anthony',
+                                :last_name => 'Mistake',
+                                :training => 'what ever you want!!!'
+)
 
-puts "Student created: '%s'" % oStudent
+puts format("Student created: '%s'", student)
 
-puts ANSI.bold("Remove mistake")
-result = school.query_student({:name => "Anthony Mistake"})
+puts ANSI.bold('Remove mistake')
+result = school.query_student(:name => 'Anthony Mistake')
 if result.length > 0
-   result.each { | student |
-      puts "Wrong student to remove: %s = %s" % [student[:id], student[:name]]
-      school.delete_student(student[:id])
-   }
+  result.each do | a_student |
+    puts format('Wrong student to remove: %s = %s',
+                a_student[:id], a_student[:name])
+    school.delete_student(a_student[:id])
+  end
 end
 
-
 puts ANSI.bold("List of students for 'Art Drama':")
-puts school.query_student({ :training => "Art Drama"})
+puts school.query_student(:training => 'Art Drama')
 
-puts ANSI.bold("Deleted students:")
-puts school.query_student({ :status => :removed})
+puts ANSI.bold('Deleted students:')
+puts school.query_student(:status => :removed)

data/example/yaml_students/yaml_students.rb

@@ -14,102 +14,115 @@
 #    See the License for the specific language governing permissions and
 #    limitations under the License.
 
-
 # This class describes how to process some actions, and will do everything prior
 # this task to make it to work.
 
 require 'yaml'
 
+# Simple School class saving data in a yaml file.
 class YamlSchool
-   attr_accessor :sFile
-   attr_accessor :hData
-
-   def initialize(sFile)
-      @hData = { :students => []}
-      @sFile = sFile
-      load_data()
-   end
-
-   def load_data()
-      if File.exists?(@sFile)
-         @hData = YAML.load_file(@sFile)
-         @hData = { :students => []} if not @hData
-         @hData[:students] = [] unless @hData.key?(:students)
-      end
-   end
-
-   def save_data()
-         begin
-            File.open(@sFile, 'w') do |out|
-               YAML.dump(@hData, out)
-            end
-         rescue => e
-            Lorj.error("%s\n%s" % [e.message, e.backtrace.join("\n")])
-            return false
-         end
-      true
-   end
-
-   def create_student(name, fields)
-
-      if fields[ :first_name].nil? or fields[ :last_name].nil?
-         puts "YAML API: Unable to create a student. :first_name and :last_name required."
-         return nil
+  attr_accessor :file
+  attr_accessor :data
+
+  def initialize(file)
+    @data = { :students => [] }
+    @file = file
+    load_data
+  end
+
+  def load_data
+    return false unless File.exist?(@file)
+
+    @data = YAML.load_file(@file)
+    @data = { :students => [] } unless @data
+    @data[:students] = [] unless @data.key?(:students)
+  end
+
+  def save_data
+    begin
+      File.open(@file, 'w') do |out|
+        YAML.dump(@data, out)
       end
-
-      result = fields.clone
-      result[:name] = name
-      result[:name] = "%s %s" % [result[:first_name], result[:first_name]] if name.nil?
-      result[:status] = :active
-
-      @hData[:students] << result
-
-      result[:id] = @hData[:students].length()-1
-
-      save_data()
-      result
-   end
-
-   def delete_student(sId)
-      return false unless File.exists?(sFile)
-
-      @hData[:students].each { | value |
-         hElem = value
-         if value[:id] == sId
-            @hData[:students][sId][:status] = :removed
-            save_data()
-            return 1
-         end
-      }
-      0
-   end
-
-   def query_student(sQuery)
-
-      result = []
-
-      @hData[:students].each { | value |
-         hElem = value
-         sQuery.each { | query_key, query_value |
-            hElem = nil if (
-               value.key?(:status) and
-               value[:status] != :active and
-               not sQuery.key?(:status)) or
-               not value.key?(query_key) or
-               value[query_key] != query_value
-         }
-         result << hElem if hElem
-      }
-      result
-
-   end
-
-   def update_student(sId, fields)
-      aList = query_student({ :id => Id})
-      if aList.length == 1
-         aList[0].merge(fields)
+   rescue => e
+     Lorj.error(format("%s\n%s", e.message, e.backtrace.join("\n")))
+     return false
+    end
+    true
+  end
+
+  def create_student(name, fields)
+    if fields[:first_name].nil? || fields[:last_name].nil?
+      puts 'YAML API: Unable to create a student. '\
+           ':first_name and :last_name required.'
+      return nil
+    end
+
+    result = create_data(name, fields)
+
+    save_data
+    result
+  end
+
+  def create_data(name, fields)
+    result = fields.clone
+    result[:name] = name
+    if name.nil?
+      result[:name] = format('%s %s', result[:first_name], result[:first_name])
+    end
+    result[:status] = :active
+
+    @data[:students] << result
+
+    result[:id] = @data[:students].length - 1
+    result
+  end
+
+  def delete_student(sId)
+    return false unless File.exist?(file)
+
+    @data[:students].each do | value |
+      next unless value[:id] == sId
+
+      @data[:students][sId][:status] = :removed
+      save_data
+      return 1
+    end
+    0
+  end
+
+  def query_student(hQuery)
+    result = []
+
+    @data[:students].each do | hValue |
+      elem = hValue
+      hQuery.each do | query_key, query_value |
+        elem = nil if not_in_query?(hQuery, hValue, query_key, query_value)
       end
-      save_data()
-   end
-
+      result << elem if elem
+    end
+    result
+  end
+
+  # check query field and data value.
+  # Return true if the query do not match the current data
+  def not_in_query?(hQuery, hValue, query_key, query_value)
+    return true unless valid_status?(hQuery, hValue)
+    return true unless hValue.key?(query_key)
+    return true if hValue[query_key] != query_value
+    false
+  end
+
+  # check if status field is queried. if not consider status != :active.
+  # return true if status
+  def valid_status?(hQuery, hValue)
+    return false if hValue.key?(:status) && hValue[:status] != :active &&
+                    !hQuery.key?(:status)
+    true
+  end
+
+  def update_student(_sId, fields)
+    list = query_student(:id => Id)
+    list[0].merge(fields) if list.length == 1
+    save_data
+  end
 end