lorj 1.0.11 → 1.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4650a17061896bba5bafad8e12d15be96a37a532
-  data.tar.gz: 9ed6bb8936335cc1fa1c1236e95ef1c17a56e7e3
+  metadata.gz: 794f05ad532df448906a4c02b3a8037b3633ead3
+  data.tar.gz: b5f2c8e2dcd69cee39b5ed7931765878581b6e20
 SHA512:
-  metadata.gz: b9842cbc6ccf9d6068a76a0b82948a1c6196e10f5d46d9a40d12166961d2a328e5514a95e761387ef6a634783e851386cfcd0f48de4c4c4eba35c1d6bf9c56f1
-  data.tar.gz: f499cab40cd49a2494ff67e59a38704e4a193acff174b1df7dacf547f9ba13bce7c6796e344c63f00f01c043f4d54a70a9da51ec0326cb90c96686187b7a5adc
+  metadata.gz: 0d9610ee767426066b0507f791c6fbc52764bb42cebdf9479bdd9923a7e7080107dcc0294db7d420e8b287104d1cd290eb316464287669845ec78b6cfaf684b4
+  data.tar.gz: 113d5adb2e583a57ca190a7c9b41c78328beb41f357974cb1db8d6bf0a20522030719978e332bb44c01f392c5d54c5968f4f17b2c523248b8e604cebb0bdfbf3

data/Dockerfile

@@ -0,0 +1,19 @@
+FROM centos:6
+
+COPY files/proxy.sh /tmp/proxy.sh
+RUN /tmp/proxy.sh
+
+RUN yum -y install \
+  libffi-devel \
+  libxml2-devel \
+  libxslt-devel \
+  perl \
+  ruby \
+  rubygems \
+  ruby-devel \
+  ; yum -y groupinstall "Development tools" \
+  ; yum clean all
+
+RUN gem install --no-rdoc --no-ri bundler rake rspec && rm -fr /root/.gem
+
+COPY files/bundle.sh /tmp/bundle.sh

data/Rakefile

@@ -16,11 +16,18 @@
 
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
-require 'rubocop/rake_task'
+require 'rubocop/rake_task' unless RUBY_VERSION.match(/1\.8/)
 require 'rdoc/task'
+require 'json'
 
 task :default => [:lint, :spec]
 
+desc 'Run all specs (locally + docker).'
+task :spec => [:spec_local, :spec18]
+
+desc 'Run acceptance test (docker - specs).'
+task :acceptance => [:spec18]
+
 desc 'Generate lorj documentation'
 RDoc::Task.new do |rdoc|
   rdoc.main = 'README.md'
@@ -28,16 +35,50 @@ RDoc::Task.new do |rdoc|
 end
 
 desc 'Run the specs.'
-RSpec::Core::RakeTask.new do |t|
+RSpec::Core::RakeTask.new(:spec_local) 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
+if RUBY_VERSION.match(/1\.8/)
+  desc 'no lint with ruby 1.8'
+  task :lint
+else
+  desc 'Run RuboCop on the project'
+  RuboCop::RakeTask.new(:lint) do |task|
+    task.formatters = ['progress']
+    task.verbose = true
+    task.fail_on_error = true
+  end
+end
+
+# rubocop: disable Style/SpecialGlobalVars
+
+desc 'Run spec with docker for ruby 1.8'
+task :spec18 do
+  begin
+    `docker`
+  rescue
+    puts 'Unable to run spec against ruby 1.8: docker not found'
+  else
+    cmd = 'build/build_with_proxy.sh -t ruby/1.8'
+    puts "Running #{cmd}"
+    system(cmd)
+    image_id = `docker images ruby/1.8`.split("\n")[1].split[2]
+    res = `docker inspect -f '{{json .}}' lorj`
+    c_img = ''
+    c_img = JSON.parse(res)['Image'][0..11] if $?.exitstatus == 0
+
+    if $?.exitstatus == 0 && image_id == c_img && ENV['RSPEC_DEBUG'].nil?
+      system('docker start -ai lorj')
+    else
+      `docker rm lorj` if $?.exitstatus == 0
+      cmd = "docker run -e RSPEC_DEBUG=#{ENV['RSPEC_DEBUG']} -it --name "\
+             'lorj -v $(pwd):/src -w /src ruby/1.8 /tmp/bundle.sh'
+      puts "Running #{cmd}"
+      system(cmd)
+    end
+  end
 end
 
 task :build => [:lint, :spec]

data/build/build_with_proxy.sh

@@ -0,0 +1,49 @@
+#!/bin/bash
+#
+# (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.
+
+function usage
+{
+ echo "usage is $0 [--help][-t user/repo:version]
+where :
+- help: is the current help
+- t   : Tag the image built. Respect the tag format use by docker -t option.
+"
+}
+
+if [ "p$1" = "p--help" ]
+then
+   usage
+   exit
+fi
+
+if [ "p$1" = "p-t" ] && [ "p$2" != "" ]
+then
+   TAG="-t $2"
+fi
+
+if [ "$http_proxy" = "" ]
+then
+   echo "Currently, no proxy is set. Running docker without proxy"
+   docker build $TAG
+   exit
+fi
+
+mkdir .tmp
+awk '$0 ~ /RUN \/tmp\/proxy.sh/ { print "ENV http_proxy '"$http_proxy"'" }
+     $0 ~ // { print $0 } ' Dockerfile > .tmp/Dockerfile
+cp -rp files tmp .tmp/
+docker build $TAG .tmp
+rm -fr .tmp

data/files/bundle.sh

@@ -0,0 +1,19 @@
+#!/bin/bash
+#
+# (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.
+
+cd /src
+bundle
+rake spec_local

data/files/proxy.sh

@@ -0,0 +1,23 @@
+#!/bin/bash
+#
+# (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.
+
+if [ "$http_proxy" != "" ]
+then
+    echo "proxy setting to '$http_proxy'"
+    export http_proxy=$http_proxy
+    export https_proxy=$http_proxy
+    sed -i -e '/^\[main\]/aproxy='"$http_proxy" /etc/yum.conf
+fi

data/lib/compat/1.8/lorj_meta.rb

@@ -0,0 +1,44 @@
+#!/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
+  # Specific ALL Ruby functions, but incompatible with some other version.
+  module MetaRubySpec
+    # Public functions
+    module Public
+      # layer setting function
+      #
+      # * *Args*
+      #   - +type+    : :sections by default. Define the section type name.
+      #   - +section+ : Symbol. Section name of the data to define.
+      #   - +keys+    : 1 Symbol or more Symbols. Name of the data and options.
+      #   - +options+ : Hash. List of options
+      #
+      # * *Returns*
+      #   - The value set or nil
+      #
+      def []=(type, section, *prop)
+        keys = prop.clone
+        options = {}
+        options = keys.pop if keys[-1].is_a?(Hash)
+
+        return nil if keys.length == 0
+        set(type, section, keys, options)
+      end
+    end
+  end
+end

data/lib/compat/lorj_meta.rb

@@ -0,0 +1,40 @@
+#!/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
+  # Specific ALL Ruby functions, but incompatible with some other version.
+  module MetaRubySpec
+    # Public functions
+    module Public
+      # layer setting function
+      #
+      # * *Args*
+      #   - +type+    : :sections by default. Define the section type name.
+      #   - +section+ : Symbol. Section name of the data to define.
+      #   - +keys+    : 1 Symbol or more Symbols. Name of the data and options.
+      #   - +options+ : Hash. List of options
+      #
+      # * *Returns*
+      #   - The value set or nil
+      #
+      def []=(type, section, *keys, options)
+        return nil if keys.length == 0
+        set(type, section, keys, options)
+      end
+    end
+  end
+end

data/lib/core/compat/1.8/core_object_data.rb

@@ -0,0 +1,36 @@
+#!/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
+  # Specific ALL Ruby functions, but incompatible with some other version.
+  module ObjectDataRubySpec
+    # Public functions
+    module Public
+      # Functions used to set simple data/Object for controller/process function
+      # call.
+      # TODO: to revisit this function, as we may consider simple data, as
+      # Lorj::Data object
+      def []=(*prop)
+        key = prop.clone
+        value = key.pop
+
+        return nil if [:object, :query].include?(key[0])
+        @params.rh_set(value, key)
+      end
+    end
+  end
+end

data/lib/core/compat/1.8/lorj_data.rb

@@ -0,0 +1,41 @@
+# (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
+  # Specific ALL Ruby functions, but incompatible with some other version.
+  module DataRubySpec
+    # Public functions
+    module Public
+      # Set Lorj::data attribute value for an :object
+      #
+      # * *Args* :
+      #   - +keys+ : attribute keys
+      #   - +value+: Value to set
+      #
+      # * *Returns* :
+      #   true
+      #
+      # * *Raises* :
+      #   No exceptions
+      #
+      def []=(*prop)
+        key = prop.clone
+        value = key.pop
+        return false if @type == :list
+        @data.rh_set(value, :attrs, key)
+        true
+      end
+    end
+  end
+end

data/lib/core/compat/core_object_data.rb

@@ -0,0 +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.
+
+module Lorj
+  # Specific ALL Ruby functions, but incompatible with some other version.
+  module ObjectDataRubySpec
+    # Public functions
+    module Public
+      # Functions used to set simple data/Object for controller/process function
+      # call.
+      # TODO: to revisit this function, as we may consider simple data, as
+      # Lorj::Data object
+      def []=(*key, value)
+        return nil if [:object, :query].include?(key[0])
+        @params.rh_set(value, key)
+      end
+    end
+  end
+end

data/lib/core/compat/lorj_data.rb

@@ -0,0 +1,39 @@
+# (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
+  # Specific ALL Ruby functions, but incompatible with some other version.
+  module DataRubySpec
+    # Public functions
+    module Public
+      # Set Lorj::data attribute value for an :object
+      #
+      # * *Args* :
+      #   - +keys+ : attribute keys
+      #   - +value+: Value to set
+      #
+      # * *Returns* :
+      #   true
+      #
+      # * *Raises* :
+      #   No exceptions
+      #
+      def []=(*key, value)
+        return false if @type == :list
+        @data.rh_set(value, :attrs, key)
+        true
+      end
+    end
+  end
+end

data/lib/core/core.rb

@@ -294,6 +294,27 @@ module Lorj
       @core_object.process_setup(oCloudObj)
     end
 
+    # Function to add an object to Lorj cache.
+    #
+    # This function is typically used when a previous query has been
+    # executed and you want to keep the object in lorj cache.
+    # Lorj cache is used by create/delete/etc... To avoid requerying or
+    # creating those objects (+dependencies) if missing.
+    #
+    # * *Args* :
+    #   - +oObject+     : object to register.
+    #   - +sObjectType+ : Object type to register.
+    #     By default, the object type is determined by the Object itself
+    #     if this object is an ObjectData. Otherwise, you need to define the
+    #     object type.
+    #
+    # * *Raises* :
+    #   No exceptions
+    def register(oObject, sObjectType = nil) #:doc:
+      return nil if !oObject || !@core_object
+      @core_object.register(oObject, sObjectType)
+    end
+
     # Core parameters are:
     # the_config : Optional. An instance of a configuration system which *HAVE*
     # to provide get/set/exist?/[]/[]=

data/lib/core/core_internal.rb

@@ -467,7 +467,9 @@ module Lorj
 
       match_found = the_process_class.scan(/_[a-z]/)
       if match_found
-        match_found.each { |str| the_process_class[str] = str[1].capitalize }
+        # Ruby 1.8   : 'ab'[1] => 98 and 'ab'[1, 1] => 'b'
+        # Ruby 1.9 + : 'ab'[1] => 'b' and 'ab'[1, 1] => 'b'
+        match_found.each { |str| the_process_class[str] = str[1, 1].capitalize }
       end
 
       the_process_class

data/lib/core/core_object_data.rb

@@ -16,6 +16,14 @@
 
 # rubocop: disable Metrics/AbcSize
 
+file_dir = File.join(File.dirname(__FILE__), 'compat')
+compat_version = RUBY_VERSION[0..2]
+file = File.basename(__FILE__)
+
+lib = File.join(file_dir, compat_version, file)
+lib = File.join(file_dir, file) unless File.exist?(lib)
+load lib if File.exist?(lib)
+
 # Module Lorj which contains several classes.
 #
 # Those classes describes :
@@ -130,15 +138,6 @@ module Lorj
       value
     end
 
-    # Functions used to set simple data/Object for controller/process function
-    # call.
-    # TODO: to revisit this function, as we may consider simple data, as
-    # Lorj::Data object
-    def []=(*key, value)
-      return nil if [:object, :query].include?(key[0])
-      @params.rh_set(value, key)
-    end
-
     # Add function. Add a Lorj::Data (data or list) to the ObjectData list.
     #
     # key can be an array, a string (converted to a symbol) or a symbol.
@@ -236,10 +235,13 @@ module Lorj
 
     def type?(key)
       return nil unless @params.rh_exist?(key)
-      return :DataObject if @params[key].type == :object
+      return :DataObject if @params[key].class == Lorj::Data &&
+                            @params[key].type == :object
       :data
     end
 
+    alias :'otype?' :'type?' if RUBY_VERSION =~ /1\.8/ # rubocop: disable Alias
+
     def to_s
       str = "-- Lorj::ObjectData --\n"
       str += "Usage internal\n" if @internal
@@ -247,6 +249,8 @@ module Lorj
       str
     end
 
+    include Lorj::ObjectDataRubySpec::Public
+
     private
 
     # Get function

data/lib/core/core_object_params.rb

@@ -112,7 +112,7 @@ module Lorj
       end
 
       if param_options[:decrypt].is_a?(TrueClass)
-        value = _get_encrypted_value(value, _get_encrypt_key)
+        value = _get_encrypted_value(value, _get_encrypt_key, attr_name)
       end
 
       return unless param_options[:mapping]

data/lib/core/core_process.rb

@@ -127,7 +127,10 @@ module Lorj
 
       proc = PrcLib.model.meta_obj.rh_get(object_type, :lambdas, :delete_e)
 
-      return nil if proc.nil?
+      if proc.nil?
+        _remove_instant_config(hConfig)
+        return nil
+      end
 
       # Check required parameters
       _process_load_dependencies(object_type, proc, :delete_e, __callee__)
@@ -208,11 +211,17 @@ module Lorj
 
       # Check if we can re-use a previous query
       list = query_cache(object_type, hQuery)
-      return list unless list.nil?
+      unless list.nil?
+        _remove_instant_config(hConfig)
+        return list
+      end
 
       proc = PrcLib.model.meta_obj.rh_get(object_type, :lambdas, :query_e)
 
-      return nil if proc.nil?
+      if proc.nil?
+        _remove_instant_config(hConfig)
+        return nil
+      end
 
       # Check required parameters
       _process_load_dependencies(object_type, proc, :query_e, __callee__)
@@ -293,7 +302,10 @@ module Lorj
 
       proc = PrcLib.model.meta_obj.rh_get(object_type, :lambdas, :get_e)
 
-      return nil if proc.nil?
+      if proc.nil?
+        _remove_instant_config(hConfig)
+        return nil
+      end
 
       # Check required parameters
       _process_load_dependencies(object_type, proc, :get_e, __callee__)
@@ -356,7 +368,10 @@ module Lorj
 
       proc = PrcLib.model.meta_obj.rh_get(object_type, :lambdas, :update_e)
 
-      return nil if proc.nil?
+      if proc.nil?
+        _remove_instant_config(hConfig)
+        return nil
+      end
 
       _process_load_dependencies(object_type, proc, :update_e, __callee__)
 

data/lib/core/core_setup_encrypt.rb

@@ -13,6 +13,7 @@
 #    limitations under the License.
 
 require 'highline/import'
+require 'encryptor'
 
 # Module Lorj which contains several classes.
 #
@@ -83,7 +84,7 @@ module Lorj
       return '' if enc_value.nil?
       value_hidden = ''
       begin
-        value_hidden = '*' * _get_encrypted_value(enc_value, entr).length
+        value_hidden = '*' * _get_encrypted_value(enc_value, entr, sDesc).length
       rescue => e
         PrcLib.error('Unable to decrypt your %s. You will need to re-enter it.'\
                      '\n%s', sDesc, e.message)
@@ -101,13 +102,14 @@ module Lorj
     # *parameters*:
     #   - +default+     : encrypted default value
     #   - +entropy+     : Entropy Hash
+    #   - +sDesc+       : data description
     #
     # *return*:
     # - value : decrypted value.
     #
     # *raise*:
     #
-    def _get_encrypted_value(enc_value, entr)
+    def _get_encrypted_value(enc_value, entr, sDesc)
       return '' if enc_value.nil?
       begin
         Encryptor.decrypt(

data/lib/core/definition.rb

@@ -691,7 +691,9 @@ module Lorj
       handlers_dcl.each_key do |key|
         next unless handlers_options.key?(key)
 
-        unless process_context.instance_methods.include?(handlers_options[key])
+        # Warning! Use BaseProcess._instance_methods Compatibility function
+        # instead of BaseProcess.instance_methods
+        unless process_context._instance_methods.include?(handlers_options[key])
           PrcLib.dcl_fail("'%s' parameter requires a valid instance method"\
                           " '%s' in the process '%s'.",
                           key, handlers_options[key], process_context)

data/lib/core/lorj_basecontroller.rb

@@ -87,8 +87,21 @@ module Lorj
     # * *Raises* :
     #   - +Error+ if the key do not exist.
     def required?(oParams, *key)
-      return if oParams.exist?(key)
-
+      if oParams.exist?(key)
+        if RUBY_VERSION =~ /1\.8/
+          #  debugger # rubocop: disable Lint/Debugger
+          if oParams.otype?(*key) == :DataObject &&
+             oParams[key, :ObjectData].empty?
+            controller_error '%s is empty.', key
+          end
+        else
+          if oParams.type?(*key) == :DataObject &&
+             oParams[key, :ObjectData].empty?
+            controller_error '%s is empty.', key
+          end
+        end
+        return
+      end
       controller_error '%s is not set.', key
     end
   end