ckick 0.1.0

data/lib/ckick/sub_directory.rb

@@ -0,0 +1,121 @@
+# 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/executable"
+require "ckick/library"
+require "fileutils"
+require "ckick/hashable"
+require "ckick/path_delegate"
+
+module CKick
+
+  class SubDirectory
+    include Hashable
+
+    attr_reader :name, :parent_dir, :has_cmake
+
+    def initialize args={}
+      name = args[:name]
+      raise IllegalInitializationError, "no name provided to sub directory" unless name.is_a?(String) && !name.empty?
+      libs = args[:libraries]
+      raise IllegalInitializationError, ":libraries argument is not an Array" unless libs.is_a?(Array) || libs.nil?
+      exes = args[:executables]
+      raise IllegalInitializationError, ":executables argument is not an Array" unless exes.is_a?(Array) || exes.nil?
+      subdirs = args[:subdirs]
+      raise IllegalInitializationError, ":subdirs is not an Array" unless subdirs.is_a?(Array) || subdirs.nil?
+
+      has_cmake = args[:has_cmake].nil? || args[:has_cmake]
+
+      if (!exes.nil? || !libs.nil?) && !has_cmake
+        raise BadSubDirectoryError, "A subdirectory not containing a CMakeLists cannot contain targets."
+      end
+
+      @name = name
+      @has_cmake = has_cmake
+
+      @libraries = []
+      libs.each do |lib|
+        @libraries << Library.new(lib)
+      end
+      @executables = []
+      exes.each do |exe|
+        @executables << Executable.new(exe)
+      end
+
+      @subdirs = []
+      subdirs.each do |subdir|
+        @subdirs << SubDirectory.new(subdir)
+      end
+
+      @parent_dir = nil
+    end
+
+    def to_s
+      @name
+    end
+
+    def to_hash
+      if !@has_cmake
+        return to_no_empty_value_hash.without(:parent_dir)
+      end
+      to_no_empty_value_hash.without(:parent_dir, :has_cmake)
+    end
+
+    def path
+      raise NoParentDirError, "sub directory #{@name} has no parent set" unless @parent_dir
+      File.join(@parent_dir, @name)
+    end
+
+    def create_structure
+      PathDelegate.create_directory(path)
+
+      if @has_cmake
+        PathDelegate.write_file(path, "CMakeLists.txt", cmake)
+
+        targets.each do |t|
+          t.create_structure
+        end
+      end
+
+      @subdirs.each do |subdir|
+        subdir.create_structure
+      end
+    end
+
+    def cmake
+      res = ''
+
+      res << targets.collect { |t| t.cmake }.join("\n")
+
+      unless @subdirs.empty?
+        res << "\n"
+        res << @subdirs.collect do |subdir|
+          "add_subdirectory(#{subdir.name})"
+        end.join("\n")
+      end
+
+      res
+    end
+
+    private
+
+    def targets
+      @executables + @libraries
+    end
+
+    def set_parent(parent_dir)
+      @parent_dir = parent_dir
+
+      targets.each do |t|
+        t.__send__ :set_parent, path
+      end
+
+      @subdirs.each do |subdir|
+        subdir.__send__ :set_parent, path
+      end
+    end
+  end
+
+end

data/lib/ckick/target.rb

@@ -0,0 +1,81 @@
+# 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/library_link"
+require "ckick/path_delegate"
+require "ckick/hashable"
+
+module CKick
+
+  class Target
+    include Hashable
+
+    def initialize args={}
+      raise IllegalInitializationError unless args.is_a?(Hash) && !args.empty?
+
+      name = args[:name] || ""
+      raise NoNameError, "No target name given for target" unless name.is_a?(String) && !name.empty?
+      @name = name
+
+      source = args[:source] || []
+      if source.is_a? Array
+        raise NoSourceError, "No source file provided for target #{@name}" if source.empty?
+        raise BadSourceError, "Bad source file names provided for target #{@name}: #{source}" unless source.select { |el| !el.is_a?(String) }.empty?
+        @source = source
+      elsif source.is_a? String
+        @source = [source]
+      else
+        raise BadSourceError, "Bad source file name provided for target #{@name}"
+      end
+
+      @libs = []
+      libs = args[:libs] || []
+      if libs.is_a?(Array)
+        raise BadLibError, "Bad library name provided for target #{@name}: #{libs}" unless libs.select { |el| !el.is_a?(String) }.empty?
+        libs.each do |lib|
+          @libs << LibraryLink.new(name: lib)
+        end
+      elsif libs.is_a?(String)
+        @libs << LibraryLink.new(name: libs)
+      else
+        raise BadLibError, "Bad library name provided for target #{@name}: #{libs}"
+      end
+
+      @parent_dir = nil
+    end
+
+    def to_hash
+      to_no_empty_value_hash.without(:parent_dir)
+    end
+
+    def to_s
+      @name
+    end
+
+    def paths
+      raise NoParentDirError, "No parent directory has been set for target #{@name}" unless @parent_dir
+      res = []
+      @source.each do |source_file|
+        res << File.join(@parent_dir, source_file)
+      end
+      res
+    end
+
+    def create_structure
+      paths.each do |path|
+        unless File.exist? path
+          PathDelegate.touch_file(path)
+        end
+      end
+    end
+
+    private
+
+    def set_parent(parent_dir)
+      @parent_dir = parent_dir
+    end
+  end
+
+end

data/lib/ckick/version.rb

@@ -0,0 +1,7 @@
+# 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
+  VERSION = "0.1.0"
+end

data/resource/default_cxx_project.json

@@ -0,0 +1,40 @@
+{
+    "name": "new_cxx_project",
+    "cmake_min_version": "3.0",
+
+    "root": ".",
+
+    "build_dir": "build",
+
+    "dependencies": {
+        "cxxflags": ["-std=c++11", "-O3"]
+    },
+
+    "plugins": [
+        {
+            "name": "ClangComplete"
+        },
+        {
+            "name": "GTest"
+        }
+    ],
+
+    "subdirs": [
+        {
+            "name": "include",
+            "has_cmake": false
+        },
+        {
+            "name": "src",
+            "executables": [
+                {
+                    "name": "main",
+                    "source": "main.cc"
+                }
+            ]
+        },
+        {
+            "name": "test"
+        }
+    ]
+}

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: ckick
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jonathan Gingras
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: CKick is a simple gem that helps to kick start a C/C++ project using
+  CMake with an arbitrary structure. Using a CKickfile (a simple JSON), ckick is able
+  to generate an whole project structure without having to write any CMakeLists.txt
+  by your own.
+email:
+- jonathan.gingras.1@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/ckick
+- bin/console
+- bin/setup
+- ckick.gemspec
+- lib/ckick.rb
+- lib/ckick/array.rb
+- lib/ckick/cflag.rb
+- lib/ckick/ckickfile.rb
+- lib/ckick/compiler_flag.rb
+- lib/ckick/cxxflag.rb
+- lib/ckick/dependencies.rb
+- lib/ckick/executable.rb
+- lib/ckick/find_plugin.rb
+- lib/ckick/hash.rb
+- lib/ckick/hash_elements.rb
+- lib/ckick/hashable.rb
+- lib/ckick/include_path.rb
+- lib/ckick/library.rb
+- lib/ckick/library_link.rb
+- lib/ckick/library_path.rb
+- lib/ckick/nil_class.rb
+- lib/ckick/path.rb
+- lib/ckick/path_delegate.rb
+- lib/ckick/plugin.rb
+- lib/ckick/plugin/clang_complete.rb
+- lib/ckick/plugin/gtest.rb
+- lib/ckick/plugin/resource/build-gtest.cmake
+- lib/ckick/plugin_delegate.rb
+- lib/ckick/project.rb
+- lib/ckick/sub_directory.rb
+- lib/ckick/target.rb
+- lib/ckick/version.rb
+- resource/default_cxx_project.json
+homepage: https://github.com/jonathangingras/ckick
+licenses:
+- MPL-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14.1
+signing_key: 
+specification_version: 4
+summary: Kick start a C/C++ CMake project structure from a single JSON file
+test_files: []