ckick 0.1.0

data/lib/ckick/include_path.rb

@@ -0,0 +1,19 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+require "ckick/path"
+
+module CKick
+
+  class IncludePath < Path
+    def raw_flag
+      "-I#{@path}"
+    end
+
+    def cmake
+      %Q{include_directories(#{@path})}
+    end
+  end
+
+end

data/lib/ckick/library.rb

@@ -0,0 +1,37 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+require "ckick/target"
+
+module CKick
+
+  class Library < Target
+    def initialize args={}
+      super args
+
+      @shared = args[:shared] || false
+    end
+
+    def to_hash
+      if @shared
+        return super
+      else
+        return super.without(:shared)
+      end
+    end
+
+    def cmake
+      res = []
+
+      res << "add_library(#{@name}#{@shared ? " SHARED " : " "}#{@source.join(' ')})"
+
+      unless @libs.empty?
+        res << "target_link_libraries(#{@name} #{@libs.join(' ')})"
+      end
+
+      res.join("\n")
+    end
+  end
+
+end

data/lib/ckick/library_link.rb

@@ -0,0 +1,32 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+module CKick
+
+  class LibraryLink
+
+    def initialize args={}
+      name = args[:name] || ""
+      raise CKick::IllegalInitializationError, "No name provided to library link" unless name.is_a?(String) && !name.empty?
+      @name = name
+    end
+
+    def to_hash_element
+      @name
+    end
+
+    def to_s
+      @name
+    end
+
+    def raw_flag
+      "-l#{@name}"
+    end
+
+    def cmake
+      @name
+    end
+  end
+
+end

data/lib/ckick/library_path.rb

@@ -0,0 +1,19 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+require "ckick/path"
+
+module CKick
+
+  class LibraryPath < Path
+    def raw_flag
+      "-L#{@path}"
+    end
+
+    def cmake
+      "link_directories(#{@path})"
+    end
+  end
+
+end

data/lib/ckick/nil_class.rb

@@ -0,0 +1,8 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+class NilClass
+  def each &block
+  end
+end

data/lib/ckick/path.rb

@@ -0,0 +1,26 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+module CKick
+
+  class Path
+    attr_reader :path
+
+    def initialize args={}
+      raise IllegalInitializationError, "needs :path parameter" unless args.is_a?(Hash) && args[:path].is_a?(String)
+      raise NoSuchDirectoryError, "invalid path #{args[:path]}" unless Dir.exist?(args[:path])
+
+      @path = args[:path]
+    end
+
+    def to_s
+      @path
+    end
+
+    def to_hash_element
+      @path
+    end
+  end
+
+end

data/lib/ckick/path_delegate.rb

@@ -0,0 +1,29 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+require "fileutils"
+
+module CKick
+
+  module PathDelegate
+
+    def self.create_directory(dirpath)
+      FileUtils.mkdir_p(dirpath)
+    end
+
+    def self.write_file(dirpath, filename, content)
+      raise BadFileContentError, "content does not respond to to_s" unless content.respond_to?(:to_s)
+      filepath = File.join(dirpath, filename)
+      file = File.new(filepath, "w")
+      file << content.to_s
+      file.close
+    end
+
+    def self.touch_file(filepath)
+      FileUtils.touch(filepath)
+    end
+
+  end
+
+end

data/lib/ckick/plugin.rb

@@ -0,0 +1,47 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+module CKick
+
+  class Plugin
+    def initialize args
+    end
+
+    # Plugin's name, defaults to class name
+    def name
+      self.class.name
+    end
+
+    # Plugin to hash is :name => "class name"
+    def to_hash
+      {name: self.class.name}
+    end
+
+    # Plugin's output to add to main CMakeLists.txt
+    def cmake
+      ""
+    end
+
+    # Ran before project's structure creation
+    def run(project)
+      nil
+    end
+
+    # Ran after project's structure creation (create_structure)
+    def call(project)
+      nil
+    end
+
+    # Appends project's includes path before structure creation
+    def include(project)
+      []
+    end
+
+    # Appends project's libraries path before structure creation
+    def lib(project)
+      []
+    end
+  end
+
+end

data/lib/ckick/plugin/clang_complete.rb

@@ -0,0 +1,19 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+require "ckick/plugin"
+
+class ClangComplete < CKick::Plugin
+  # Creates a .clang_complete file for clang auto completion
+
+  def call(project)
+    def clang_complete project
+      project.dependencies.flags.join("\n")
+    end
+
+    file = File.new(File.join(project.path, ".clang_complete"), 'w')
+    file << clang_complete(project) << "\n"
+    file.close
+  end
+end

data/lib/ckick/plugin/gtest.rb

@@ -0,0 +1,44 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+require "ckick/plugin"
+require "fileutils"
+
+class GTest < CKick::Plugin
+  LIBS_VARIABLE = "${GTEST_LIBRARIES}"
+
+  def initialize args={}
+    @optional = args[:optional] || false
+    @resource_file = "build-gtest.cmake"
+  end
+
+  def cmake
+    res = ''
+    res << %Q(option(BUILD_TESTS OFF "whether to build tests or not")\n) \
+        << "if(BUILD_TESTS)\n\t" if @optional
+
+    res << "include(#{@resource_file})"
+
+    res << "\nendif()" if @optional
+    res
+  end
+
+  def call(project)
+    file = File.new(File.join(project.root, @resource_file), 'w')
+    file << File.new(File.join(File.dirname(__FILE__), "resource", @resource_file), 'r').read
+    file.close
+  end
+
+  def include(project)
+    res = []
+    [
+      File.join(project.build_dir, "gtest", "src", "libgtest", "googletest", "include"),
+      File.join(project.build_dir, "gtest", "src", "libgtest", "googlemock", "include")
+    ].each do |path|
+      FileUtils.mkdir_p path
+      res << CKick::IncludePath.new(path: path)
+    end
+    res
+  end
+end

data/lib/ckick/plugin/resource/build-gtest.cmake

@@ -0,0 +1,17 @@
+find_package(Threads REQUIRED)
+include(ExternalProject)
+
+ExternalProject_Add(
+        libgtest
+        URL https://github.com/google/googletest/archive/release-1.8.0.zip
+        PREFIX ${CMAKE_CURRENT_BINARY_DIR}/gtest
+        INSTALL_COMMAND ""
+)
+
+include_directories("${CMAKE_CURRENT_BINARY_DIR}/gtest/src/libgtest/googletest/include")
+include_directories("${CMAKE_CURRENT_BINARY_DIR}/gtest/src/libgtest/googlemock/include")
+
+link_directories("${CMAKE_CURRENT_BINARY_DIR}/gtest/src/libgtest-build/googlemock/gtest")
+link_directories("${CMAKE_CURRENT_BINARY_DIR}/gtest/src/libgtest-build/googlemock")
+
+set(GTEST_LIBRARIES gtest gtest_main gmock gmock_main pthread)

data/lib/ckick/plugin_delegate.rb

@@ -0,0 +1,15 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+module CKick
+
+  module PluginDelegate
+
+    def self.find(plugin)
+      Object.const_get(plugin[:name]).new(plugin[:args] || {})
+    end
+
+  end
+
+end

data/lib/ckick/project.rb

@@ -0,0 +1,173 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+require "ckick/nil_class"
+require "ckick/dependencies"
+require "ckick/sub_directory"
+require "ckick/hashable"
+require "ckick/path_delegate"
+require "ckick/plugin_delegate"
+
+module CKick
+
+  class Project
+    include Hashable
+    attr_reader :subdirs, :dependencies, :root, :build_dir
+
+    NAME_MATCH = /^[[A-Z][a-z]_[0-9]]+$/
+    CMAKE_VERSION_MATCH = /^[0-9](\.[0-9]){0,2}$/
+
+    def initialize args
+      name = args[:name] || ""
+      raise IllegalInitializationError, "name must be a non-empty string only containing alphanumeric characters" unless name.is_a?(String) && name.match(NAME_MATCH)
+
+      min_v = args[:cmake_min_version] || '3'
+      raise IllegalInitializationError, "cmake_min_version is non-String" unless min_v.is_a?(String)
+      raise IllegalInitializationError, "cmake_min_version has non working pattern x or x.y or x.y.z" unless min_v.match(CMAKE_VERSION_MATCH)
+
+      root = args[:root] || ""
+      raise IllegalInitializationError, "root directory is non-String" unless root.is_a?(String)
+      raise IllegalInitializationError, "root directory is empty" if root.empty?
+
+      build_dir = args[:build_dir] || ""
+      raise IllegalInitializationError, "build directory is non-String" unless build_dir.is_a?(String)
+      raise IllegalInitializationError, "build directory is empty" if build_dir.empty?
+
+      @name = name
+      @cmake_min_version = min_v
+      @root = root
+      @build_dir = build_dir
+      @dependencies = Dependencies.new(args[:dependencies] || {})
+
+      @plugins = []
+      args[:plugins].each do |plugin|
+        @plugins << PluginDelegate.find(plugin)
+      end
+
+      @subdirs = []
+      args[:subdirs].each do |subdir|
+        @subdirs << SubDirectory.new(subdir)
+      end
+
+      @subdirs_initiated = false
+      init_subdirs
+    end
+
+    def set_name(name)
+      raise BadProjectNameError, "project name must be a non-empty alphanumeric string" unless name.is_a?(String) && name.match(NAME_MATCH)
+      @name = name
+    end
+
+    def to_s
+      @name
+    end
+
+    def to_hash
+      to_no_empty_value_hash.without(:subdirs_initiated)
+    end
+
+    def path
+      @root
+    end
+
+    def create_structure
+      raise "SubDirectories have not been initiated" unless @subdirs_initiated
+
+      run_plugins
+
+      PathDelegate.create_directory path
+      PathDelegate.write_file(path, "CMakeLists.txt", cmake)
+
+      @subdirs.each do |subdir|
+        subdir.create_structure
+      end
+
+      call_plugins
+    end
+
+    def register_plugin(plugin=nil, &block)
+      raise ArgumentError, "" unless plugin.is_a?(::CKick::Plugin) || block
+
+      if plugin.is_a?(::CKick::Plugin)
+        @plugins << plugin
+      elsif plugin.nil? && block
+        @plugins << block
+      end
+    end
+
+    def cmake
+      append_plugin_paths
+
+      res = "project(#{@name})\n" +
+            "cmake_minimum_required(VERSION #{@cmake_min_version})\n\n"
+
+      res << "set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)\n" \
+             "set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)\n" \
+             "set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)\n\n"
+
+      res << @dependencies.cmake << "\n\n"
+
+      res << plugins_cmake << "\n\n" unless @plugins.empty?
+
+      @subdirs.each do |dir|
+        res << "add_subdirectory(#{dir.name})\n" if dir.has_cmake
+      end
+
+      res
+    end
+
+    private
+
+    def init_subdirs
+      @subdirs.each do |subdir|
+        subdir.__send__ :set_parent, path
+      end
+
+      @subdirs_initiated = true
+    end
+
+    def append_plugin_paths
+      @plugins.each do |plugin|
+        plugin.include(self).each do |path|
+          @dependencies.add_include path
+        end
+        plugin.lib(self).each do |path|
+          @dependencies.add_lib path
+        end
+      end
+    end
+
+    def run_plugins
+      @plugins.each do |plugin|
+        plugin.run(self) if plugin.respond_to? :run
+      end
+    end
+
+    def call_plugins
+      @plugins.each do |plugin|
+        plugin.call self
+      end
+    end
+
+    def plugins_cmake
+      res = "##ckick plugins section##\n"
+
+      def plugin_name(plugin)
+        if plugin.respond_to?(:name)
+          return plugin.name
+        else
+          return "<inline plugin>"
+        end
+      end
+
+      @plugins.each do |plugin|
+        res << "#ckick plugin: #{plugin_name(plugin)}\n"
+        res << plugin.cmake << "\n" if plugin.respond_to? :cmake
+      end
+
+      res << "##end plugin section##"
+    end
+  end
+
+end