lorj 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c3ea57c85015a879c6ae4a17ae32cc568d7c1559
-  data.tar.gz: 88617061e04fc13f17454c770dc41ad87a19c2b5
+  metadata.gz: eeba3dfb1287558282764e42fab9e32628ebbbd3
+  data.tar.gz: 27119784fb89ca8911f2cc722f1a2d09454d5e7a
 SHA512:
-  metadata.gz: 8d8214f417ae51f763015aa0836d30365ca34b3313c0bafd002cbae137e8a75478261aeb80d9d2d6ccc3575dfc13483501a5fb80aefb11e4ec6d1da2369958d3
-  data.tar.gz: 4262c71516afea78b39dc03482e972d4465347bec1062d9198648c0dfd7c934b3957c48f46c2b61bcac2e68477433efc9359737143f8b0dfd92962b8a3b1cf67
+  metadata.gz: d936b458e2a74c00f165a3b3d41d914aab89602ef250cc08c4ede8fc0f649aba765818f3fe2e1beab5abfe72ac03f9a96e73f86230a38f962313818eb1c5eaa6
+  data.tar.gz: ad7e7604d301400b754c1811de06d5711f11563c2e35663cc2bb1f3ce46168772139cdc9979167ca655602f229af954d6bb15cf47beab7754b03bfb3a82a114d

data/.gitignore

@@ -12,3 +12,4 @@
 *.a
 mkmf.log
 lorj-rspec.log
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,46 @@
+# Copyright 2013 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.
+
+# use: rubocop --show-cops
+#      to validate configuration.
+# rubocop config
+AllCops:
+  Include:
+    - '**/Rakefile'
+    - '**/config.ru'
+  Exclude:
+    - 'docker/**/*'
+    - 'bin/scripts/**/*'
+    - 'git/**/*'
+    - 'tmp/**/*'
+#Documentation:
+#  Enabled: false
+#Metrics/LineLength:
+#  Max: 99
+Style/HashSyntax:
+  EnforcedStyle: hash_rockets
+
+# lets start with 40, but 10 is way to small..
+Metrics/MethodLength:
+  Max: 40
+# If Method length is increased, class length need to be extended as well.
+Metrics/ClassLength:
+  Max: 150
+
+# allow arguments to be longer than 15
+Metrics/AbcSize:
+  Max: 40
+# forj-docker binary name gets an exception
+Style/FileName:
+  Exclude: ['bin/forj-docker', 'lib/**/forj-docker.rb']

data/Gemfile

@@ -3,23 +3,23 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in procontrol.gemspec
 gemspec
 
-#group(:development, :test) do
+# group(:development, :test) do
 #  gem 'rake'
 #  gem 'debugger'
 #  gem 'byebug'
 #  gem 'rspec', "~> 3.1.0", :require => false
-#end
+# end
 
-#gem 'mime-types','1.25.1'
-#gem 'excon','0.31.0'
-#gem 'json','1.7.5'
-#gem 'nokogiri','1.5.11'
-#gem 'fog', '1.19.0'
-#gem 'git', '>=1.2.7'
-#gem 'rainbow'
-#gem 'rbx-require-relative', '~> 0.0.7'
-#gem 'thor', '>=0.16.0'
-#gem 'hpcloud', '~>2.0.9'
-#gem 'highline','>=1.6.21'
-#gem 'ansi','>=1.4.3'
-#gem 'encryptor','>=1.3.0'
+# gem 'mime-types','1.25.1'
+# gem 'excon','0.31.0'
+# gem 'json','1.7.5'
+# gem 'nokogiri','1.5.11'
+# gem 'fog', '1.19.0'
+# gem 'git', '>=1.2.7'
+# gem 'rainbow'
+# gem 'rbx-require-relative', '~> 0.0.7'
+# gem 'thor', '>=0.16.0'
+# gem 'hpcloud', '~>2.0.9'
+# gem 'highline','>=1.6.21'
+# gem 'ansi','>=1.4.3'
+# gem 'encryptor','>=1.3.0'

data/README.md

@@ -153,14 +153,14 @@ Currently, this model do nothing except printing out.
 #####typical output
 
     $ example/students_1/students.rb
-    WARNING: PrcLib.app_defaults is not set. Application defaults won't be loaded. 
+    WARNING: PrcLib.app_defaults is not set. Application defaults won't be loaded.
     Running creation process for object 'student' = 'Robert Redford'
     WARNING: 'create_student' has returned no data for object Lorj::Data 'student'!
 
-There is 2 warnings. 
+There is 2 warnings.
 
 * **PrcLib.app_defaults** represents the application name. It is used to keep your application configuration data in ~/.{PrcLib.app_defaults}/ directory. Defining this data in your main, will eliminate this warning.
-* **create_student** function in your process has returned nothing. while lorj is called to create an object, it assumes to get the object data created. Lorj keep those data in a cache. In this example, **create_student** returned nil, and lorj raise a warning about that. 
+* **create_student** function in your process has returned nothing. while lorj is called to create an object, it assumes to get the object data created. Lorj keep those data in a cache. In this example, **create_student** returned nil, and lorj raise a warning about that.
 
 ---
 #### Writing student version 2
@@ -235,7 +235,7 @@ The update your main and add those lines. In the following, we create 3 students
 #####typical output:
 
     $ example/students_2/students.rb
-    WARNING: PrcLib.app_defaults is not set. Application defaults won't be loaded. 
+    WARNING: PrcLib.app_defaults is not set. Application defaults won't be loaded.
     2 students found
     0: Robert Redford
     1: Robert Redford
@@ -515,11 +515,14 @@ We need to write the controller part, now. As I said, it is like a wrapper. Let'
           # extract the information requested by the framework.
           # Those data will be mapped to the process data model.
           # The key is an array, to get data from a level tree.
-          # [data_l1, data_l2, data_l3] => should retrieve data from structure like data[ data_l2[ data_l3 ] ]
+          # [data_l1, data_l2, data_l3] => should retrieve data from structure
+          #                                like data[ data_l2 [ data_l3 ] ]
           begin
              attributes = oControlerObject
-             raise "get_attr: attribute '%s' is unknown in '%s'. Valid one are : '%s'" % [key[0], oControlerObject.class, @@valid_attributes ] unless @@valid_attributes.include?(key[0])
-             Lorj::rhGet(attributes, key)
+             raise "get_attr: attribute '%s' is unknown in '%s'. Valid one are : '%s'",
+                   key[0], oControlerObject.class,
+                   @@valid_attributes unless @@valid_attributes.include?(key[0])
+             Lorj::rh_get(attributes, key)
           rescue => e
              Error "get_attr: Unable to map '%s'. %s" % [key, e.message]
           end
@@ -528,8 +531,10 @@ We need to write the controller part, now. As I said, it is like a wrapper. Let'
        def set_attr(oControlerObject, key, value)
           begin
              attributes = oControlerObject
-             raise "set_attr: attribute '%s' is unknown in '%s'. Valid one are : '%s'" % [key[0], oControlerObject.class, @@valid_attributes ] unless @@valid_attributes.include?(key[0])
-             Lorj::rhSet(attributes, value, key)
+             raise "set_attr: attribute '%s' is unknown in '%s'. Valid one are : '%s'",
+                   key[0], oControlerObject.class,
+                   @@valid_attributes  unless @@valid_attributes.include?(key[0])
+             Lorj::rh_set(attributes, value, key)
           rescue => e
              Error "set_attr: Unable to map '%s' on '%s'" % [key, sObjectType]
           end
@@ -575,11 +580,11 @@ And we need to write some mapping stuff to the controller. We have to add this
        define_obj(:connection,{
         :create_e => :controller_create # Nothing complex to do. So, simply call the controller create.
        })
-    
+
        obj_needs   :data,   :connection_string,  :mapping => :file_name
        undefine_attribute :id    # Do not return any predefined ID
        undefine_attribute :name  # Do not return any predefined NAME
-    
+
        # The student model have to be expanded.
        define_obj(:student)
        # It requires to create a connection to the data, ie opening the yaml file.
@@ -587,18 +592,18 @@ And we need to write some mapping stuff to the controller. We have to add this
        # This connection will be loaded in the memory and provided to the controller
        # when needed.
        obj_needs   :CloudObject,              :connection
-    
+
        # To simplify controller wrapper, we use hdata built by lorj, and passed to the API
        # This hdata is a hash containing mapped data, thanks to set_hdata.
        set_hdata :first_name
        set_hdata :last_name
        # Instead of 'course', the yaml API uses 'training'
        set_hdata :course, :mapping => :training
-        
+
        get_attr_mapping :course, :training
        # instead of 'student_name', the yaml API uses 'name'
        get_attr_mapping :student_name, :name
-    
+
        # This controller will know how to manage a student file with those data.
        # But note that the file can have a lot of more data than what the process
        # usually manage. It is up to you to increase your process to manage more data.
@@ -609,8 +614,8 @@ And we need to write some mapping stuff to the controller. We have to add this
 That's it!
 
 #####typical output:
-    $ example/students_3/students.rb 
-    WARNING: PrcLib.app_defaults is not set. Application defaults won't be loaded. 
+    $ example/students_3/students.rb
+    WARNING: PrcLib.app_defaults is not set. Application defaults won't be loaded.
     Create 1st student:
     Create 2nd student:
     Create 3rd student:
@@ -623,7 +628,7 @@ That's it!
     {:id=>2, :course=>"Art Drama", :student_name=>"Marilyn Monroe", :first_name=>"Marilyn", :last_name=>"Monroe", :status=>:active}
     Deleted students:
     {:id=>3, :course=>"what ever you want!!!", :student_name=>"Anthony Mistake", :first_name=>"Anthony", :last_name=>"Mistake", :status=>:removed}
-    
+
 ## What next?
 
 Check the code in the `examples/students_3/`. It provides a little more than is written here.

data/Rakefile

@@ -14,11 +14,21 @@
 #    See the License for the specific language governing permissions and
 #    limitations under the License.
 
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+task :default => [:lint, :spec]
 
 desc 'Run the specs.'
-RSpec::Core::RakeTask.new do |t| 
+RSpec::Core::RakeTask.new do |t|
   t.pattern = 'spec/*_spec.rb'
+  t.rspec_opts = '-f doc'
 end
 
+desc 'Run RuboCop on the project'
+RuboCop::RakeTask.new(:lint) do |task|
+  task.formatters = ['progress']
+  task.verbose = true
+  task.fail_on_error = true
+end

data/bin/cloud_test.rb

@@ -1,81 +1,29 @@
 #!/usr/bin/env ruby
 
-#require 'byebug'
+# require 'byebug'
 
-$APP_PATH = File.dirname(__FILE__)
-$LIB_PATH = File.expand_path(File.join(File.dirname($APP_PATH),'lib'))
+app_path = File.dirname(__FILE__)
+lib_path = File.expand_path(File.join(File.dirname(app_path), 'lib'))
 
-$LOAD_PATH << $LIB_PATH
+load_path << lib_path
 
-$LOAD_PATH << File.join($LIB_PATH, 'lib-forj', 'lib')
-
-require 'appinit.rb'
-
-# Initialize forj paths
-AppInit::forj_initialize()
-
-# Initialize global Log object
-$FORJ_LOGGER=LorjLog.new()
-
-require 'lib-forj.rb'
-
-Logging.set_level(Logger::DEBUG)
+require 'lorj.rb'
 
 # Load global Config
-oConfig = ForjConfig.new()
+oconfig = ForjConfig.new
 
-aProcesses = []
+processes = []
 
 # Defines how to manage Maestro and forges
 # create a maestro box. Identify a forge instance, delete it,...
-aProcesses << File.join($LIB_PATH, 'forj', 'ForjCore.rb')
+processes << File.join(lib_path, 'forj', 'ForjCore.rb')
 
 # Defines how cli will control FORJ features
 # boot/down/ssh/...
-aProcesses << File.join($LIB_PATH, 'forj', 'ForjCli.rb')
-
-$LIB_FORJ_DEBUG = 3 # verbose
-
-infra_dir = File.expand_path(oConfig.get(:infra_repo))
-
-# Ask information if needed.
-if not Dir.exist?(File.expand_path(infra_dir))
-   Logging.warning(<<-END
-Your infra workspace directory is missing.
-
-Forj uses an infra workspace directory to store any kind of data that are private to you.
-We provides ways to send those data securily to your new Forge instance, as metadata.
-In production case, we suggest you to keep it safe in your SCM preferred database.
-
-If you already have an existing infra workspace, use 'forj set infra_repo=<PathToYourRepo>' to set it and restart.
-
-Otherwise, we will build a new one with some predefined data, you can review and update later.
-   END
-   )
-   sAsk = "Do you want to create a new one from Maestro (yes/no)?" % [infra_dir]
-   bBuildInfra=agree(sAsk)
-   if not bBuildInfra
-      puts 'Process aborted on your demand.'
-      exit 0
-   end
-end
-
-oCloud = ForjCloud.new(oConfig, 'hpcloud', aProcesses)
-
-#oConfig.set(:instance_name, "test")
-#oCloud.Create(:metadata)
-#oCloud.Create(:infra_repository)
-#oCloud.Create(:userdata)
-
-
-#oCloud.Setup(:server, 'hpcloud')
-#oCloud.Setup(:forge, 'hpcloud')
-
-#oCloud.Create(:forge)
+processes << File.join(lib_path, 'forj', 'ForjCli.rb')
 
-oConfig.set(:box_name, '183')
-oConfig.set(:box, 'maestro')
-#oConfig.Create(:server)
-oCloud.Create(:ssh)
+ocloud = ForjCloud.new(oconfig, 'hpcloud', processes)
 
-#oCloud.Query(:server, 'maestro')
+oconfig.set(:box_name, '183')
+oconfig.set(:box, 'maestro')
+ocloud.Create(:ssh)

data/example/students_1/process/students.rb

@@ -0,0 +1,39 @@
+# 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.
+
+# Students process
+class StudentsProcess
+  def create_student(sObjectType, hParams)
+    puts format("Running creation process for object '%s' = '%s'",
+                sObjectType, hParams[:student_name])
+    # If you prefer to print out to the log system instead:
+    # PrcLib::debug(format("Running creation process for object '%s' = '%s'",
+    #                      sObjectType, hParams[:student_name] ))
+  end
+end
+
+# Declaring your data model and handlers.
+# Rubocop: Disabling Style/ClassAndModuleChildren to avoid un-needed indentation
+class Lorj::BaseDefinition # rubocop:disable Style/ClassAndModuleChildren
+  # We need to define the student object and the handler to use while we need
+  # to create it.
+  define_obj(:student,
+             # The function to call in the class Students
+             :create_e => :create_student
+             )
+
+  obj_needs :data,         :student_name,         :for => [:create_e]
+end

data/example/students_1/students.rb

@@ -1,16 +1,33 @@
 #!/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.
+
+app_path = File.dirname(__FILE__)
 
-$APP_PATH = File.dirname(__FILE__)
 require 'lorj'
 
-# If you want to see what is happening in the framework, uncomment debug settings.
+# 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.
 
 # Initialize the framework
-hProcesses = [ File.join($APP_PATH, 'process', 'Students.rb')]
+processes = [File.join(app_path, 'process', 'students.rb')]
 
-oStudentCore = Lorj::Core.new( nil, hProcesses)
+student_core = Lorj::Core.new(nil, processes)
 
 # Ask the framework to create the object student 'Robert Redford'
-oStudentCore.Create(:student, :student_name => "Robert Redford")
+student_core.create(:student, :student_name => 'Robert Redford')

data/example/students_2/process/students.rb

@@ -0,0 +1,48 @@
+# 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.
+
+# Students process
+class StudentsProcess
+  def create_student(sObjectType, hParams)
+    PrcLib.state(format("Running creation process for object '%s' = '%s'",
+                        sObjectType, hParams[:student_name]))
+
+    object = controller_create(sObjectType)
+    fail format("Student '%s' not created.",
+                hParams[:student_name]) if object.nil?
+    PrcLib.info(format("'%s': '%s' created with id %s",
+                       sObjectType, hParams[:student_name],  object[:id]))
+    object
+  end
+end
+
+# Declaring your data model and handlers.
+class Lorj::BaseDefinition # rubocop: disable Style/ClassAndModuleChildren
+  # We need to define the student object and the handler to use while we need to
+  # create it.
+  define_obj(:student,
+             # The function to call in the class Students
+             :create_e => :create_student,
+             # We use predefined call to the controller query
+             :query_e => :controller_query,
+             # We use predefined call to the controller get
+             :get_e => :controller_get,
+             # We use predefined call to the controller delete
+             :delete_e => :controller_delete
+             )
+
+  obj_needs :data, :student_name, :for => [:create_e], :mapping => :name
+end

data/example/students_2/students.rb

@@ -1,36 +1,59 @@
 #!/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.
+
+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
 
-$APP_PATH = File.dirname(__FILE__)
 require 'lorj'
 
-# 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 = 3 # 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( nil, hProcesses, :mock)
+student_core = Lorj::Core.new(nil, processes, :mock)
 
 # Ask the framework to create the object student 'Robert Redford'
-oStudentCore.Create(:student, :student_name => "Robert Redford")
+student_core.create(:student, :student_name => 'Robert Redford')
 
 # Want to create a duplicated student 'Robert Redford'?
-oStudentCore.Create(:student)
+student_core.create(:student)
 # no problem. The key is the key in the Mock controller array.
 
-oStudentCore.Create(:student, :student_name => "Anthony Hopkins")
+student_core.create(:student, :student_name => 'Anthony Hopkins')
 
 # Let's create a third different student.
-oStudents = oStudentCore.Query(:student, { :name => "Robert Redford" } )
+students = student_core.query(:student,  :name => 'Robert Redford')
 
-puts "%s students found" % oStudents.length
+puts format('%s students found', students.length)
 
-oStudents.each { | oStudent |
-   puts "%s: %s" % [oStudent[:id], oStudent[:name]]
-}
+students.each do | a_student |
+  puts format('%s: %s', a_student[:id], a_student[:name])
+end
 
 # let's check the get function, who is the ID 2?
-oStudent = oStudentCore.Get(:student, 2)
+student = student_core.get(:student, 2)
 
-puts "The student ID 2 is %s" % oStudent[:name]
+puts format('The student ID 2 is %s', student[:name])