Class: Info

Inherits:

Object

• Object
• Info

Defined in:

lib/atk/info.rb

Overview

setting/getting values via an object (instead of opening/closing a file)

Defined Under Namespace

Classes: ReRaiseException, YamlFileDoesntExist

Class Method Summary

• .[](element) ⇒ Object
• .commands ⇒ Object
• .data ⇒ Object
• .folder ⇒ Object
• .init ⇒ Object
• .path ⇒ Object
• .paths ⇒ Object
• .version ⇒ Object

Instance Method Summary

• #[](element) ⇒ Object

  read access.

• #commands ⇒ Object

  command access.

• #data ⇒ Object

  data access.

• #folder ⇒ Object
• #initialize ⇒ Info constructor

  A new instance of Info.

• #parser_version_1_1(data) ⇒ Object
• #path ⇒ Object
• #paths ⇒ Object

  path access.

• #version ⇒ Object

Constructor Details

#initialize ⇒ Info

Returns a new instance of Info.

# File 'lib/atk/info.rb', line 115

def initialize()
    # 
    # find the yaml file
    # 
    begin
        @path = Info.path
        @folder = FS.dirname(@path)
    rescue
        raise YamlFileDoesntExist, <<-HEREDOC.remove_indent
            
            
            When calling Info.new
            I looked for an info.yaml in #{Dir.pwd}
            (and I also looked in all of its parent folders)
            but I couldn't find an info.yaml file in any of them
        HEREDOC
    end
    # 
    # open the yaml file
    # 
    begin
        @data = YAML.load_file(@path)
    rescue => exception
        raise <<-HEREDOC.remove_indent
            
            When calling Info.new
            I found an info.yaml file
            however, when I tried to load it I received an error:
            #{exception}
        HEREDOC
    end
    # 
    # check the version, and parse accordingly
    # 
    @version = nil
    begin
        @version = Version.new(@data['(using_atk_version)'].to_s)
    rescue => exception
        # if no version, then don't worry about parsing
    end

    if @version.is_a?(Version)
        begin
            if @version <= Version.new("1.0.0")
                raise ReRaiseException, <<-HEREDOC.remove_indent
                    
                    So it looks like you're info.yaml file version is 1.0
                    That was the alpha version of ATK, which is the only version that will not be supported
                    
                    #{"This is likely just an accident and the only thing that needs to be done is change:".color_as :message}
                        (using_atk_version): 1.0
                    #{"to:".color_as :message}
                        (using_atk_version): 1.1.0
                HEREDOC
            elsif @version <= Version.new("1.1.0")
                self.parser_version_1_1(@data)
            else
                # FUTURE: in the future do an online check to see if the latest ATK could handle this
                raise ReRaiseException, <<-HEREDOC.remove_indent
                    
                    Hey I think you need to update atk:
                        `atk update`
                    Why?
                        The (using_atk_version) in the info.yaml is: #{@version}
                        However, I (your current version of ATK) don't know
                        how to handle that version.
                HEREDOC
            end
        rescue ReRaiseException => exception
            raise exception
        rescue => exception
            raise <<-HEREDOC.remove_indent
                
                Original error message:
                """
                #{exception}
                """
                
                This error is almost certainly not your fault
                It is likely a bug inside the atk_toolbox library
                Specifically the info.yaml parser
                
                If you agree and think this is a problem with the atk_toolbox library
                please go here:
                https://github.com/aggie-tool-kit/atk-toolbox/issues/new
                and tell us what happened before getting this message
                and also paste the original error message
                
                Sorry for the bug!
            HEREDOC
        end
    end
end

Class Method Details

.[](element) ⇒ Object

# File 'lib/atk/info.rb', line 311

def self.[](element)
    return (Info.new)[element]
end

.commands ⇒ Object

# File 'lib/atk/info.rb', line 327

def self.commands
    return (Info.new).commands
end

.data ⇒ Object

# File 'lib/atk/info.rb', line 319

def self.data
    return (Info.new).data
end

.folder ⇒ Object

# File 'lib/atk/info.rb', line 212

def self.folder()
    folder = FileSystem.join(Dir.pwd, "") # join with nothing to fix windows pathing
    loop do
        # if the info.yaml exists in that folder
        if FileSystem.file?( FileSystem.join(folder, "info.yaml"))
            return folder
        end

        next_location = File.dirname(folder)
        
        # if all folders exhausted
        if next_location == folder
            raise <<-HEREDOC.remove_indent
                
                #{"Couldn't find an info.yaml in the current directory or any parent directory".color_as(:bad)}
                    #{Dir.pwd}
                Are you sure you're running the command from the correct directory?
            HEREDOC
        end
        
        folder = next_location
    end
end

.init ⇒ Object

# File 'lib/atk/info.rb', line 294

def self.init
    current_dir = Dir.pwd/"info.yaml"
    # if there isn't a info.yaml then create one
    if not File.file?(current_dir)
        # copy the default yaml to the current dir
        FileUtils.cp(__dir__/"default_info.yaml", current_dir)
        puts "info.yaml created successfully"
    else
        puts "There appears to already be an info.yaml file\nThe init method is not yet able to merge the ATK init data with the current data\n(this will be fixed in the future)"
    end
end

.path ⇒ Object

# File 'lib/atk/info.rb', line 239

def self.path()
    return FileSystem.join( self.folder(), "info.yaml")
end

.paths ⇒ Object

# File 'lib/atk/info.rb', line 335

def self.paths
    return (Info.new).paths
end

.version ⇒ Object

# File 'lib/atk/info.rb', line 246

def self.version()
    return (Info.new).version
end

Instance Method Details

#[](element) ⇒ Object

read access

# File 'lib/atk/info.rb', line 307

def [](element)
    return @data[element]
end

#commands ⇒ Object

command access

# File 'lib/atk/info.rb', line 324

def commands
    return @commands || {}
end

#data ⇒ Object

data access

# File 'lib/atk/info.rb', line 316

def data
    return @data
end

#folder ⇒ Object

# File 'lib/atk/info.rb', line 209

def folder()
    return @folder
end

#parser_version_1_1(data) ⇒ Object

# File 'lib/atk/info.rb', line 250

def parser_version_1_1(data)
    # 
    # parse the commands
    #
    begin
        @commands = data['(project)']['(commands)']
        if !(@commands.is_a?(Hash))
            @commands = {}
        end
    rescue
        @commands = {}
    end
    # 
    # parse the paths
    # 
    begin
        @paths = data['(project)']['(paths)']
        if !(@paths.is_a?(Hash))
            @paths = {}
        end
    rescue
        @paths = {}
    end
    @root = FileSystem.dirname(@path)
    for each_key, each_value in @paths
        # if its an array, just join it together
        if each_value.is_a?(Array)
            each_value = FileSystem.join(*each_value)
        end
        # make all paths absolute
        if each_value.is_a?(String)
            # remove the ./ if it exists
            if each_value =~ /\A\.\//
                each_value = each_value[2..-1]
            end
            # Dont add a source_path if its an absolute path
            if not each_value.size > 0 && each_value[0] == '/'
                # convert the path into an absolute path
                @paths[each_key] = FileSystem.join(@root, each_value)
            end
        end
    end
end

#path ⇒ Object

# File 'lib/atk/info.rb', line 236

def path()
    return @path
end

#paths ⇒ Object

path access

# File 'lib/atk/info.rb', line 332

def paths
    return @paths || {}
end

#version ⇒ Object

# File 'lib/atk/info.rb', line 243

def version()
    return @version
end