Platform framework and detect DSL

lib/train/platform.rb

@@ -3,7 +3,7 @@
 module Train
   class Platform
     include Train::Platforms::Common
-    attr_accessor :condition, :families, :backend, :platform, :family_hierarchy
+    attr_accessor :backend, :condition, :families, :family_hierarchy, :platform
 
     def initialize(name, condition = {})
       @name = name
@@ -12,7 +12,7 @@ def initialize(name, condition = {})
       @family_hierarchy = []
       @platform = {}
       @detect = nil
-      @title = name =~ /^[[:alpha:]]+$/ ? name.capitalize : name
+      @title = name.to_s.capitalize
 
       # add itself to the platform list
       Train::Platforms.list[name] = self
@@ -48,33 +48,33 @@ def to_hash
       @platform
     end
 
-    # Add genaric family? and platform methods to an existing platform
+    # Add generic family? and platform methods to an existing platform
     #
     # This is done later to add any custom
     # families/properties that were created
     def add_platform_methods
       family_list = Train::Platforms.families
       family_list.each_value do |k|
         next if respond_to?(k.name + '?')
-        define_singleton_method(k.name + '?') {
+        define_singleton_method(k.name + '?') do
           family_hierarchy.include?(k.name)
-        }
+        end
       end
 
       # Helper methods for direct platform info
       @platform.each_key do |m|
         next if respond_to?(m)
-        define_singleton_method(m) {
+        define_singleton_method(m) do
           @platform[m]
-        }
+        end
       end
 
       # Create method for name if its not already true
       plat_name = name.downcase.tr(' ', '_') + '?'
       return if respond_to?(plat_name)
-      define_singleton_method(plat_name) {
+      define_singleton_method(plat_name) do
         true
-      }
+      end
     end
   end
 end

lib/train/platforms.rb

@@ -73,7 +73,7 @@ def self.print_children(parent, pad = 2)
     parent.children.each do |key, value|
       obj = key
       puts "#{' ' * pad}-> #{obj.title}#{value unless value.empty?}"
-      print_children(obj, pad + 2) unless !defined?(obj.children) || obj.children.nil?
+      print_children(obj, pad + 2) if defined?(obj.children) && !obj.children.nil?
     end
   end
 end

lib/train/platforms/detect/os_common.rb

@@ -20,36 +20,37 @@ def winrm?
 
     def unix_file_contents(path)
       # keep a log of files incase multiple checks call the same one
-      return @files[path] unless @files[path].nil?
+      return @files[path] if @files.key?(path)
 
       res = @backend.run_command("test -f #{path} && cat #{path}")
-      @files[path] = res.stdout
       # ignore files that can't be read
-      return nil if res.exit_status != 0
-      res.stdout
+      @files[path] = res.exit_status.zero? ? res.stdout : nil
+      @files[path]
     end
 
     def unix_file_exist?(path)
       @backend.run_command("test -f #{path}").exit_status.zero?
     end
 
+    def uname_call(cmd)
+      res = @backend.run_command(cmd).stdout
+      res.strip! unless res.nil?
+      res
+    end
+
     def unix_uname_s
-      return @uname[:s] unless @uname[:s].nil?
-      @uname[:s] = @backend.run_command('uname -s').stdout
+      return @uname[:s] if @uname.key?(:s)
+      @uname[:s] = uname_call('uname -s')
     end
 
     def unix_uname_r
-      return @uname[:r] unless @uname[:r].nil?
-      @uname[:r] = begin
-                     res = @backend.run_command('uname -r').stdout
-                     res.strip! unless res.nil?
-                     res
-                   end
+      return @uname[:r] if @uname.key?(:r)
+      @uname[:r] = uname_call('uname -r')
     end
 
     def unix_uname_m
-      return @uname[:m] unless @uname[:m].nil?
-      @uname[:m] = @backend.run_command('uname -m').stdout.chomp
+      return @uname[:m] if @uname.key?(:m)
+      @uname[:m] = uname_call('uname -m')
     end
   end
 end

lib/train/platforms/detect/scanner.rb

@@ -26,8 +26,7 @@ def scan
       top = Train::Platforms.top_platforms
       top.each do |_name, plat|
         next unless plat.detect
-        result = instance_eval(&plat.detect)
-        next unless result == true
+        next unless instance_eval(&plat.detect) == true
 
         # if we have a match start looking at the children
         plat_result = scan_children(plat)
@@ -44,8 +43,7 @@ def scan
     def scan_children(parent)
       parent.children.each do |plat, condition|
         next if plat.detect.nil?
-        result = instance_eval(&plat.detect)
-        next unless result == true
+        next unless instance_eval(&plat.detect) == true
 
         if plat.class == Train::Platform
           @platform[:family] = parent.name
@@ -60,7 +58,7 @@ def scan_children(parent)
     end
 
     def scan_family_children(plat)
-      child_result = scan_children(plat) if !plat.children.nil?
+      child_result = scan_children(plat) unless plat.children.nil?
       return if child_result.nil?
       @family_hierarchy << plat.name
       child_result

lib/train/platforms/family.rb

@@ -3,15 +3,15 @@
 module Train::Platforms
   class Family
     include Train::Platforms::Common
-    attr_accessor :name, :condition, :families, :children
+    attr_accessor :children, :condition, :families, :name
 
     def initialize(name, condition)
       @name = name
       @condition = condition
       @families = {}
       @children = {}
       @detect = nil
-      @title = name =~ /^[[:alpha:]]+$/ ? "#{name.capitalize} Family" : name
+      @title = "#{name.to_s.capitalize} Family"
 
       # add itself to the families list
       Train::Platforms.families[@name.to_s] = self

lib/train/transports/docker.rb

@@ -69,14 +69,13 @@ def close
       # nothing to do at the moment
     end
 
-    def os
-      platform
-    end
-
     def platform
       @platform ||= Train::Platforms::Detect.scan(self)
     end
 
+    # we need to keep os as a method for backwards compatibility with inspec
+    alias os platform
+
     def file(path)
       @files[path] ||=\
         if os.aix?

lib/train/transports/local.rb

@@ -36,14 +36,13 @@ def local?
         true
       end
 
-      def os
-        platform
-      end
-
       def platform
         @platform ||= Train::Platforms::Detect.scan(self)
       end
 
+      # we need to keep os as a method for backwards compatibility with inspec
+      alias os platform
+
       def file(path)
         @files[path] ||= \
           if os.windows?

lib/train/transports/ssh_connection.rb

@@ -55,14 +55,13 @@ def close
       @session = nil
     end
 
-    def os
-      platform
-    end
-
     def platform
       @platform ||= Train::Platforms::Detect.scan(self)
     end
 
+    # we need to keep os as a method for backwards compatibility with inspec
+    alias os platform
+
     def file(path)
       @files[path] ||= \
         if os.aix?

lib/train/transports/winrm_connection.rb

@@ -46,14 +46,13 @@ def close
       @session = nil
     end
 
-    def os
-      platform
-    end
-
     def platform
       @platform ||= Train::Platforms::Detect.scan(self)
     end
 
+    # we need to keep os as a method for backwards compatibility with inspec
+    alias os platform
+
     def file(path)
       @files[path] ||= Train::File::Remote::Windows.new(self, path)
     end

test/unit/platforms/detect/common_test.rb → test/unit/platforms/detect/os_common_test.rb

@@ -33,7 +33,7 @@ def initialize
     it 'return new file contents' do
       be = mock('Backend')
       output = mock('Output', exit_status: 0)
-      output.expects(:stdout).twice.returns('test')
+      output.expects(:stdout).returns('test')
       be.stubs(:run_command).with('test -f /etc/fstab && cat /etc/fstab').returns(output)
       detector.instance_variable_set(:@backend, be)
       detector.instance_variable_set(:@files, {})