build-tool 0.0.3 → 0.1.0

data/lib/build-tool/cfg/parser.y

@@ -0,0 +1,279 @@
+class BuildTool::Cfg::Parser < BuildTool::Cfg::Lexer
+
+    token APPEND
+    token BUILD_PREFIX
+    token BUILD_SYSTEM
+    token END
+    token ENVIRONMENT
+    token EXTERNAL
+    token FILE
+    token GIT
+    token GIT_SVN
+    token HOST
+    token INHERITANCE
+    token INPLACE
+    token INSTALL_PREFIX
+    token LOCAL_PATH
+    token LOG_DIRECTORY
+    token MODULE
+    token OPTION
+    token PATH
+    token PREPEND
+    token PROTOCOL
+    token REMOTE
+    token REMOTE_PATH
+    token REPOSITORY
+    token SERVER
+    token SET
+    token SSH_KEY
+    token STRING
+    token TEMPLATE
+    token TOKEN
+    token TRACK_BRANCH
+    token USE
+    token USER
+    token VAR
+    token VCS
+
+rule
+
+    main
+        : statements { result = ConfigurationFileList.new( val[0] ); }
+        ;
+
+    #
+    ### SOME HELPER
+    #
+
+    identifier
+        : STRING { result = val[0]; }
+        | TOKEN  { result = val[0]; }
+        ;
+
+    inheritance
+        : INHERITANCE { result = :INHERITANCE; }
+        ;
+
+    # 
+    ### TOP LEVEL STATEMENTS
+    #
+    statements
+        : /* empty */
+        | statement statements { result = val.flatten; }
+        ;
+
+    statement
+        : LOG_DIRECTORY STRING     { result = LogDirectoryNode.new( val[1] ); }
+        | build_system_declaration { result = val[0]; }
+        | environment_declaration  { result = val[0]; }
+        | vcs_declaration          { result = val[0]; }
+        | module_declaration       { result = val[0]; }
+        | repository_declaration   { result = val[0]; }
+        | server_declaration       { result = val[0]; }
+        | ssh_key_declaration      { result = val[0]; }
+        ;
+
+    vcs_declaration
+        : git_declaration          { result = val[0]; }
+        | git_svn_declaration      { result = val[0]; }
+        ;
+
+    #
+    ### BUILD SYSTEM DECLARATION
+    #
+    build_system_declaration
+        : BUILD_SYSTEM identifier build_system_statements END { result = BuildSystemDeclarationNode.new( val[1,2] ); }
+        ;
+
+    build_system_statements
+        : /* empty */
+        | build_system_statement build_system_statements  { result = val.flatten; }
+        ;
+
+    build_system_statement
+        : OPTION identifier  STRING { result = BuildSystemOptionNode.new( val[1,2] ); }
+        | INPLACE { result = BuildSystemInplaceNode.new(); }
+        ;
+
+    #
+    ### ENVIRONMENT CONFIGURATION
+    #
+    environment_declaration
+        : ENVIRONMENT identifier environment_statements END { result = EnvironmentDeclarationNode.new( val[1..-1] ); }
+        | ENVIRONMENT identifier inheritance identifier environment_statements END { result = EnvironmentDeclarationNode.new( val[1..-1] ); }
+        ;
+
+    environment_statements
+        : /* empty */
+        | environment_statement environment_statements { result = val.flatten; }
+        ;
+
+    environment_statement
+        : VAR TOKEN SET     STRING { result = EnvironmentVariableNode.new( val[1..-1] ); }
+        | VAR TOKEN PREPEND STRING { result = EnvironmentVariableNode.new( val[1..-1] ); }
+        | VAR TOKEN APPEND  STRING { result = EnvironmentVariableNode.new( val[1..-1] ); }
+        ;
+
+    #
+    ### GIT CONFIGURATION
+    #
+    git_declaration
+        : VCS GIT git_statements END { result = GitDeclarationNode.new( val[2] ); }
+        ;
+
+    git_statements
+        : /* empty */
+        | git_statement git_statements { result = val.flatten; }
+        ;
+
+    git_statement
+        : REMOTE STRING git_remote_values END { result = GitRemoteNode.new( [ val[1], GitRemoteValueList.new( val[2] ) ] ); }
+        | TRACK_BRANCH STRING { result = GitTrackBranchNode.new( val[1] ); }
+        | EXTERNAL STRING     { result = GitSvnExternalNode.new( val[1] ); }
+        ;
+
+    git_remote_values
+        : /* empty */
+        | git_remote_value git_remote_values { result = val.flatten; }
+        ;
+
+    git_remote_value
+        : server_declaration { result = val[0]; }
+        | USE SERVER identifier { result = UseServerNode.new( val[2] ); }
+        ;
+
+    #
+    ### GIT-SVN CONFIGURATION
+    #
+    git_svn_declaration
+        : VCS GIT_SVN git_svn_statements END { result = GitSvnDeclarationNode.new( val[2] ); }
+        ;
+
+    git_svn_statements
+        : /* empty */
+        | git_svn_statement git_svn_statements { result = val.flatten; }
+        ;
+
+    git_svn_statement
+        : git_statement
+        ;
+
+    #
+    ### MODULE DECLARATION
+    #
+    module_declaration
+        : MODULE identifier module_statements END { result = ModuleDeclarationNode.new( val[1..-1] ); }
+        | MODULE identifier inheritance identifier module_statements END { result = ModuleDeclarationNode.new( val[1..-1] ); }
+        ;
+
+    module_statements
+        : /* EMPTY */
+        | module_statement module_statements { result = val.flatten; }
+        ;
+
+    module_statement
+        : USE BUILD_SYSTEM identifier { result = UseBuildSystemNode.new( val[2] ); }
+        | USE ENVIRONMENT  identifier { result = UseEnvironmentNode.new( val[2] ); }
+        | USE REPOSITORY   identifier { result = UseRepositoryNode.new( val[2] ); }
+        | USE VCS          identifier { result = UseVcsNode.new(         val[2] ); }
+        | build_system_declaration    { result = val[0]; }
+        | vcs_declaration             { result = val[0]; }
+        | repository_declaration      { result = val[0]; }
+        | environment_declaration     { result = val[0]; }
+        | INSTALL_PREFIX STRING { result = ModuleInstallPrefixNode.new( val[1] ); }
+        | BUILD_PREFIX   STRING { result = ModuleBuildPrefixNode.new(   val[1] ); }
+        | REMOTE_PATH    STRING { result = ModuleRemotePathNode.new(    val[1] ); }
+        | LOCAL_PATH     STRING { result = ModuleLocalPathNode.new(     val[1] ); }
+        | TEMPLATE { result = ModuleTemplateNode.new(); }
+        ;
+
+    #
+    ### REPOSITORY DECLARATION
+    #
+    repository_declaration
+        : REPOSITORY identifier repository_statements END { result = RepositoryDeclarationNode.new( val[1..-1] ); }
+        ;
+
+    repository_statements
+        : /* empty */
+        | repository_statement repository_statements { result = val.flatten(); }
+        ;
+
+    repository_statement
+        : SERVER identifier { result = RepositoryServerNode.new( val[1] ); }
+        | PATH   STRING     { result = RepositoryPathNode.new(   val[1] ); }
+        | USER   identifier { result = RepositoryUserNode.new(   val[1] ); }
+        | USE SSH_KEY identifier { result = UseSshKeyNode.new( val[2] ); }
+        | ssh_key_declaration { result = val[0]; }
+        ;
+
+    #
+    ### SERVER DECLARATION
+    #
+    server_declaration
+        : SERVER identifier server_statements END { result = ServerDeclarationNode.new( [ val[1], ServerStatementList.new( val[2] ) ] ); }
+        ;
+
+    server_statements
+        : /* empty */
+        | server_statement server_statements { result = val.flatten; }
+        ;
+
+    server_statement
+        : HOST     STRING     { result = ServerHostNode.new( val[1] );     }
+        | PROTOCOL STRING     { result = ServerProtocolNode.new( val[1] ); }
+        | PATH     STRING     { result = ServerPathNode.new( val[1] );     }
+        ;
+
+    #
+    ### SSH KEY
+    #
+    ssh_key_declaration
+        : SSH_KEY identifier ssh_key_statements END { result = SshKeyDeclarationNode.new( val[1..-1] ); }
+        ;
+
+    ssh_key_statements
+        : /* empty */
+        | ssh_key_statement ssh_key_statements { result = val.flatten; }
+        ;
+
+    ssh_key_statement
+        : FILE STRING { result = SshKeyFileNode.new( val[1] ); }
+        ;
+
+
+end # class BuildTool::Cfg::GitParser
+
+---- header ----
+#
+### HEADER
+#
+require 'build-tool/cfg/lexer'
+require 'build-tool/cfg/node'
+require 'build-tool/cfg/visitor'
+
+
+---- inner ----
+#
+### INNER
+#
+attr_accessor :configuration
+
+def initialize( configuration = Configuration.new)
+    super()
+    @configuration = configuration
+end
+
+def parse_string( string, file = "<string>" )
+    tree = super
+    visitor = Cfg::ConfigurationFileVisitor.new( configuration )
+    conf = tree.accept( visitor )
+    return configuration
+end
+
+---- footer ----
+#
+### FOOTER
+#
+
+

data/lib/build-tool/cfg/visitor.rb

@@ -0,0 +1,471 @@
+require 'build-tool/configuration'
+require 'build-tool/environment'
+require 'build-tool/repository'
+require 'build-tool/module'
+require 'build-tool/sshkey'
+require 'build-tool/server'
+
+module BuildTool; module Cfg;
+
+    # Base class for all Visitors.
+    class VisitorBase
+
+        # The configuration object to fill with our parse results.
+        attr_reader :configuration
+
+        def initialize( configuration )
+            @configuration = configuration
+        end
+
+    end # class VisitorBase
+
+
+    # Base class for all Visitors which need to iterate over their child
+    # nodes.
+    class ListVisitor < VisitorBase
+
+        # Visit one node.
+        def visit( node )
+            return self.visit_nodes( node.values )
+        end
+
+        # Visit all nodes.
+        def visit_nodes(nodes)
+            list = []
+            return list if nodes.nil?
+            nodes.each do |child|
+                break if child.nil?
+                list << child.accept( self )
+            end
+            return list
+        end
+
+    end # class ListVisitor
+
+
+    # Build System Declaration Visitor.
+    class BuildSystemDeclarationNodeVisitor < ListVisitor
+
+        # Initialize a build system. If no build system is provided we will
+        # create a new one. Which is not registered with the configuration.
+        def initialize( configuration, build_system = nil )
+            super( configuration )
+            @build_system = build_system
+        end
+
+        def visit_BuildSystemDeclarationNode( node )
+            if @build_system.nil?
+                name = node.values[0]
+                @build_system = configuration.build_system( name ).dup
+            end
+            visit_nodes( node.values[1] )
+            return @build_system
+        end
+
+        def visit_BuildSystemInplaceNode( node )
+            @build_system.out_of_source = false
+        end
+
+        def visit_BuildSystemOptionNode( node )
+            @build_system[ node.value[0] ] = node.value[1]
+        end
+
+    end
+
+
+    # The Configuration File Visitor.
+    #
+    # This is the toplevel visitor.
+    class ConfigurationFileVisitor < ListVisitor
+
+        def visit_BuildSystemDeclarationNode( node )
+            raise ArgumentsError if node.values.length != 2
+            name  = node.values[0]
+            visitor = BuildSystemDeclarationNodeVisitor.new( configuration, configuration.build_system(name) )
+            configuration.add_build_system( node.accept( visitor ) )
+        end
+
+        def visit_ConfigurationFileList( node )
+            self.visit(node)
+        end
+
+        def visit_EnvironmentDeclarationNode( node )
+            visitor = EnvironmentDeclarationNodeVisitor.new( configuration )
+            node.accept( visitor )
+        end
+
+        def visit_GitDeclarationNode( node )
+            visitor = GitDeclarationNodeVisitor.new( configuration )
+            return node.accept( visitor )
+        end
+
+        def visit_LogDirectoryNode( node )
+            configuration.log_directory = node.value
+        end
+
+        def visit_ModuleDeclarationNode( node )
+            visitor = ModuleDeclarationNodeVisitor.new( configuration )
+            node.accept( visitor )
+        end
+
+        def visit_RepositoryDeclarationNode( node )
+            visitor = RepositoryDeclarationNodeVisitor.new( configuration )
+            node.accept(visitor)
+        end
+
+        def visit_ServerDeclarationNode( node )
+            visitor = ServerDeclarationNodeVisitor.new( configuration )
+            node.accept(visitor)
+        end
+
+        def visit_SshKeyDeclarationNode( node )
+            visitor = SshKeyDeclarationNodeVisitor.new( configuration )
+            node.accept(visitor)
+        end
+
+    end # class ConfigurationFileVisitor
+
+
+    class EnvironmentDeclarationNodeVisitor < ListVisitor
+
+        def visit_EnvironmentDeclarationNode( node )
+            name = node.values[0]
+            @environment = configuration.environment( name )
+            @environment = BuildTool::Environment.new( name ) if @environment.nil?
+            configuration.add_environment( @environment )
+            if node.values[1] == :INHERITANCE
+                @environment.parent = configuration.environment(node.values[2])
+                self.visit_nodes( node.values[3] )
+            else
+                self.visit_nodes( node.values[1] )
+            end
+            return @environment
+        end
+
+        def visit_EnvironmentVariableNode( node )
+            case node.values[1]
+            when 'append';  @environment.append( node.values[0], node.values[2] )
+            when 'prepend'; @environment.prepend( node.values[0], node.values[2] )
+            when 'set';     @environment.set( node.values[0], node.values[2] )
+            else raise StandardError, "Unexpected token #{node.values[1]}!"
+            end
+        end
+
+    end # class EnvironmentDeclarationNodeVisitor
+
+
+    class GitDeclarationNodeVisitor < ListVisitor
+
+        def initialize( configuration, vcs = BuildTool::VCS::GitConfiguration.new )
+            super( configuration )
+            @vcs = vcs
+        end
+
+        def visit_GitDeclarationNode( node )
+            visit_nodes( node.values )
+            return @vcs
+        end
+
+        def visit_GitRemoteNode( node )
+            visitor = GitRemoteNodeVisitor.new( configuration )
+            remote = node.accept(visitor)
+            @vcs.remote[remote.name] = remote
+        end
+
+        def visit_GitTrackBranchNode( node )
+            @vcs.track_branch = node.value
+        end
+
+    end # class GitDeclarationNodeVisitor
+
+
+    class GitSvnDeclarationNodeVisitor < GitDeclarationNodeVisitor
+
+        def initialize( configuration, vcs )
+            super( configuration, vcs )
+        end
+
+        def visit_GitSvnDeclarationNode( node )
+            visit_nodes( node.values )
+            return @vcs
+        end
+
+        def visit_GitSvnExternalNode( node )
+            ( name, value ) = node.value.split( '#' )
+            @vcs.add_external( name, value )
+        end
+
+    end # class GitSvnDeclarationNodeVisitor
+
+
+    class GitRemoteNodeVisitor < ListVisitor
+
+        def initialize( configuration )
+            super( configuration )
+            @remote = nil
+        end
+
+        def visit_GitRemoteNode( node )
+            name = node.values[0]
+            @remote = BuildTool::VCS::GitRemote.new( name ) if @remote.nil?
+            node = node.values[1]
+            self.visit_nodes(node.values)
+            return @remote
+        end
+
+        def visit_GitRemotePathNode( node )
+            @remote.path = node.value
+        end
+
+        def visit_GitRemoteValueList( node )
+            self.visit(node)
+        end
+
+        def visit_ServerDeclarationNode( node )
+            visitor = ServerDeclarationNodeVisitor.new( configuration )
+            @remote.server = node.accept(visitor)
+        end
+
+        def visit_UseServerNode( node )
+            @remote.server = configuration.server( node.value )
+            if @remote.server.nil?
+                raise ConfigurationError, "Unknown server #{node.value} configured for remote #{@remote.name}!"
+            end
+        end
+
+    end # class GitRemoteNodeVisitor
+
+
+    class ModuleDeclarationNodeVisitor < ListVisitor
+
+        def initialize( configuration )
+            super
+            @module = nil
+        end
+
+        def visit_BuildSystemDeclarationNode( node )
+            raise ArgumentsError if node.values.length != 2
+            name  = node.values[0]
+            if @module.build_system and @module.build_system.name == name
+                build_system = @module.build_system.dup
+            else
+                build_system = nil
+            end
+            visitor = BuildSystemDeclarationNodeVisitor.new( configuration, build_system )
+            @module.build_system = node.accept( visitor )
+            @module.build_system.module = @module
+        end
+
+        def visit_EnvironmentDeclarationNode( node )
+            visitor = EnvironmentDeclarationNodeVisitor.new( configuration )
+            @module.environment = node.accept( visitor )
+        end
+
+        def visit_GitDeclarationNode( node )
+            name  = node.values[0]
+            if @module.vcs_configuration and @module.vcs_configuration.name == name
+                vcs = @module.vcs_configuration.dup
+            else
+                vcs = BuildTool::VCS::GitConfiguration.new
+            end
+            @module.vcs_configuration = vcs
+            begin
+                visitor = GitDeclarationNodeVisitor.new( configuration, vcs )
+                node.accept( visitor )
+            rescue ConfigurationError => e
+                raise ConfigurationError, "Module #{@module.name}: #{e.to_s}"
+            end
+        end
+
+        def visit_GitSvnDeclarationNode( node )
+            name  = node.values[0]
+            if @module.vcs_configuration and @module.vcs_configuration.name == name
+                vcs = @module.vcs_configuration.dup
+            else
+                vcs = BuildTool::VCS::GitSvnConfiguration.new
+            end
+            @module.vcs_configuration = vcs
+            visitor = GitSvnDeclarationNodeVisitor.new( configuration, vcs )
+            node.accept( visitor )
+        end
+
+        def visit_ModuleBuildPrefixNode( node )
+            @module.build_prefix = node.value
+        end
+
+        def visit_ModuleDeclarationNode( node )
+            name = node.values[0]
+            inheritance = node.values[1] == :INHERITANCE
+            if inheritance
+                stmts = node.values[3]
+            else
+                stmts = node.values[1]
+            end
+            # Check if the module is alread defined. If yes we reopen it.
+            @module = configuration.module( name )
+            if @module
+                if inheritance
+                    raise ConfigurationError, "Attempt change existing module #{name} with inheritance!"
+                end
+            elsif inheritance
+                @module = BuildTool::Module.new( name, configuration.module(node.values[2]) )
+                configuration.add_module( @module )
+            else
+                @module = BuildTool::Module.new( name )
+                configuration.add_module( @module )
+            end
+            self.visit_nodes( stmts )
+        end
+
+        def visit_ModuleInstallPrefixNode( node )
+            @module.install_prefix = node.value
+        end
+
+        def visit_ModuleLocalPathNode( node )
+            @module.local_path = node.value
+        end
+
+        def visit_ModuleRemotePathNode( node )
+            @module.remote_path = node.value
+        end
+
+        def visit_ModuleTemplateNode( node )
+            @module.is_template = true
+        end
+
+        def visit_RepositoryDeclarationNode( node )
+            visitor = RepositoryDeclarationNodeVisitor.new( configuration )
+            @module.repository = node.accept( visitor )
+        end
+
+        def visit_UseBuildSystemNode( node )
+            @module.build_system = configuration.build_system( node.value ).dup
+            @module.build_system.module = @module
+        end
+
+        def visit_UseEnvironmentNode( node )
+            @module.environment = configuration.environment( node.value )
+            if @module.environment.nil?
+                raise ConfigurationError, "Unknown environment #{node.value} configured for module #{@module.name}!"
+            end
+        end
+
+        def visit_UseRepositoryNode( node )
+            @module.repository = configuration.repository( node.value )
+            if @module.repository.nil?
+                raise ConfigurationError, "Unknown repository #{node.value} configured for module #{@module.name}!"
+            end
+        end
+
+        def visit_UseVcsNode( node )
+            @module.vcs_configuration = configuration.vcs(node.value)
+        end
+
+    end # class ModuleDeclarationNodeVisitor
+
+
+    class RepositoryDeclarationNodeVisitor < ListVisitor
+
+        def visit_RepositoryDeclarationNode( node )
+            name = node.values[0]
+            @repository = configuration.repository(name)
+            if @repository.nil?
+                @repository = BuildTool::Repository.new( name )
+                configuration.add_repository( @repository )
+            end
+            stmts = node.values[1]
+            visit_nodes( stmts )
+            return @repository
+        end
+
+        def visit_RepositoryPathNode( node )
+            @repository.path = node.value
+        end
+
+        def visit_RepositoryServerNode( node )
+            @repository.server = configuration.server( node.value )
+            if @repository.server.nil?
+                raise ConfigurationError, "Unknown server #{node.value} configured for repository #{@repository.name}!"
+            end
+        end
+
+        def visit_RepositoryUserNode( node )
+            @repository.user = node.value
+        end
+
+        def visit_SshKeyDeclarationNode( node )
+            @repository.sshkey = node.value
+        end
+
+        def visit_UseSshKeyNode( node )
+            name = node.value
+            @repository.sshkey = configuration.sshkey(name)
+            raise ConfigurationError, "Unknown ssh-key #{name} configured for repository #{@repository.name}!" if @repository.sshkey.nil?
+        end
+
+    end # class RepositoryDeclarationNodeVisitor
+
+
+    class ServerDeclarationNodeVisitor < ListVisitor
+
+        def initialize( configuration )
+            super( configuration )
+            @server = nil
+        end
+
+        def visit_ServerDeclarationNode( node )
+            name = node.values[0]
+            # Check if a server with that name already exists
+            @server = configuration.server(name)
+            # Create a new one if not
+            @server = Server.new( name ) if @server.nil?
+            statements = node.values[1]
+            self.visit_nodes(statements.values)
+            configuration.add_server( @server )
+            return @server
+        end
+
+        def visit_ServerHostNode( node )
+            @server.host = node.value
+        end
+
+        def visit_ServerPathNode( node )
+            @server.path = node.value
+        end
+
+        def visit_ServerProtocolNode( node )
+            @server.protocol = node.value
+        end
+
+        def visit_ServerStatementList( node )
+            self.visit( node )
+        end
+
+    end # class ServerDeclarationNodeVisitor
+
+
+    class SshKeyDeclarationNodeVisitor < ListVisitor
+
+        def initialize( configuration )
+            super
+            @sshkey = nil
+        end
+
+        def visit_SshKeyDeclarationNode( node )
+            name = node.values[0]
+            stmts = node.values[1]
+            @sshkey = BuildTool::SshKey.new( name )
+            configuration.add_sshkey( @sshkey )
+            visit_nodes( stmts )
+            return @sshkey
+        end
+
+        def visit_SshKeyFileNode( node )
+            @sshkey.file = File.expand_path( node.value )
+        end
+
+    end
+
+end; end
+
+