ckick 0.1.0

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ckick"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ckick.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ckick/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ckick"
+  spec.version       = CKick::VERSION
+  spec.authors       = ["Jonathan Gingras"]
+  spec.email         = ["jonathan.gingras.1@gmail.com"]
+  spec.license       = "MPL-2.0"
+
+  spec.summary       = %q{Kick start a C/C++ CMake project structure from a single JSON file}
+  spec.description   = %q{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.}
+  spec.homepage      = "https://github.com/jonathangingras/ckick"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/ckick.rb

@@ -0,0 +1,54 @@
+# 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/version"
+require "ckick/project"
+require "ckick/find_plugin"
+require "ckick/ckickfile"
+
+module CKick
+  RESOURCE_DIR = File.join(File.dirname(File.dirname(__FILE__)), "resource")
+
+  class Error < ::Exception
+  end
+
+  class BadFlagError < Error
+  end
+
+  class NoSuchDirectoryError < Error
+  end
+
+  class IllegalInitializationError < Error
+  end
+
+  class NoNameError < Error
+  end
+
+  class NoSourceError < Error
+  end
+
+  class BadProjectNameError < Error
+  end
+
+  class BadSourceError < Error
+  end
+
+  class BadLibError < Error
+  end
+
+  class BadIncludePathError < Error
+  end
+
+  class BadLibraryPathError < Error
+  end
+
+  class BadSubDirectoryError < Error
+  end
+
+  class NoParentDirError < Error
+  end
+
+  class BadFileContentError < Error
+  end
+end

data/lib/ckick/array.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/hash"
+
+class Array
+  def array_aware_deep_transform_keys(&block)
+    result = []
+    each do |value|
+      if value.is_a?(Hash) || value.is_a?(Array)
+        result << value.array_aware_deep_transform_keys(&block)
+      else
+        result << value
+      end
+    end
+    result
+  end
+end

data/lib/ckick/cflag.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/.
+
+require "ckick/compiler_flag"
+
+module CKick
+
+  class CFlag < CompilerFlag
+    def cmake
+      %Q(set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} #{@content}"))
+    end
+  end
+
+end

data/lib/ckick/ckickfile.rb

@@ -0,0 +1,11 @@
+# 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 "json"
+
+module CKick
+  def self.load_ckickfile(dir=Dir.pwd, filename="CKickfile")
+    JSON.parse(File.read(File.join(dir, filename)), symbolize_names: true)
+  end
+end

data/lib/ckick/compiler_flag.rb

@@ -0,0 +1,39 @@
+# 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 CompilerFlag
+    attr_reader :content
+
+    def initialize args={}
+      raise IllegalInitializationError, "No flag provided to compiler flag" unless args.is_a?(Hash) && !args.empty?
+      flag = args[:flag] || nil
+      raise BadFlagError, "Bad flag content provided to compiler flag" unless flag.is_a?(String) && !flag.empty?
+
+      @content = args[:flag]
+    end
+
+    def to_s
+      @content
+    end
+
+    def to_hash_element
+      @content
+    end
+
+    def raw_flag
+      @content
+    end
+
+    def eql? other
+      @content.eql? other.content
+    end
+
+    def hash
+      @content.hash
+    end
+  end
+
+end

data/lib/ckick/cxxflag.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/.
+
+require "ckick/compiler_flag"
+
+module CKick
+
+  class CXXFlag < CompilerFlag
+    def cmake
+      %Q(set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} #{@content}"))
+    end
+  end
+
+end

data/lib/ckick/dependencies.rb

@@ -0,0 +1,72 @@
+# 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/cflag"
+require "ckick/cxxflag"
+require "ckick/include_path"
+require "ckick/library_path"
+require "ckick/hashable"
+
+module CKick
+
+  class Dependencies
+    include Hashable
+
+    def initialize args={}
+      raise IllegalInitializationError unless args.is_a?(Hash)
+
+      cflags = args[:cflags] || []
+      raise IllegalInitializationError, "cflags provided to dependencies is not an Array" unless cflags.is_a?(Array)
+      @cflags = cflags.collect do |flag|
+        CFlag.new(flag: flag)
+        end
+
+      cxxflags = args[:cxxflags] || []
+      raise IllegalInitializationError, "cxxflags provided to dependencied is not an Array" unless cxxflags.is_a?(Array)
+      @cxxflags = cxxflags.collect do |flag|
+        CXXFlag.new(flag: flag)
+      end
+
+      includes = args[:include] || []
+      raise IllegalInitializationError, "include provided to dependencies is not an Array" unless includes.is_a?(Array)
+      @include = includes.collect do |include|
+        IncludePath.new(path: include)
+      end
+
+      libs = args[:lib] || []
+      raise IllegalInitializationError, "lib provided to dependencies is not an Array" unless libs.is_a?(Array)
+      @lib = libs.collect do |lib|
+        LibraryPath.new(path: lib)
+      end
+    end
+
+    def to_hash
+      to_no_empty_value_hash
+    end
+
+    def cmake
+      [@cflags, @cxxflags, @include, @lib].flatten(1).collect do |unit|
+          unit.cmake
+      end.join("\n")
+    end
+
+    def flags
+      [@cflags, @cxxflags, @include, @lib].flatten(1).uniq.collect do |flag|
+        flag.raw_flag
+      end
+    end
+
+    def add_include(path)
+      raise BadIncludePathError, "path must be a CKick::IncludePath object" unless path.is_a?(IncludePath)
+      @include << path unless @include.include?(path)
+    end
+
+    def add_lib(path)
+      raise BadLibraryPathError, "path must be a CKick::LibraryPath object" unless path.is_a?(LibraryPath)
+      @lib << path unless @lib.include?(path)
+    end
+  end
+
+end

data/lib/ckick/executable.rb

@@ -0,0 +1,23 @@
+# 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 Executable < Target
+    def cmake
+      res = []
+
+      res << "add_executable(#{@name} #{@source.join(' ')})"
+
+      unless @libs.empty?
+        res << "target_link_libraries(#{@name} #{@libs.join(' ')})"
+      end
+
+      res.join("\n")
+    end
+  end
+
+end

data/lib/ckick/find_plugin.rb

@@ -0,0 +1,25 @@
+# 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
+  $PLUGIN_PATH = [File.join(File.absolute_path(File.dirname(__FILE__)), "plugin")]
+
+  def self.find_builtin_plugins
+    res = []
+    $PLUGIN_PATH.each do |dir|
+      files = Dir.entries(dir).select { |entry| entry.length > 3 && entry[-3..-1] == '.rb'}
+      files.each do |file|
+        res << File.join(dir, file)
+      end
+    end
+    res.flatten(1)
+  end
+
+  def self.load_builtin_plugins
+    find_builtin_plugins.each do |file|
+      require file[0..-4]
+    end
+  end
+
+end

data/lib/ckick/hash.rb

@@ -0,0 +1,33 @@
+# 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/array"
+
+class Hash
+  def array_aware_deep_transform_keys(&block)
+    result = {}
+    each do |key, value|
+      new_key = yield(key)
+
+      if value.is_a?(Hash) || value.is_a?(Array)
+        result[new_key] = value.array_aware_deep_transform_keys(&block)
+      else
+        result[new_key] = value
+      end
+    end
+    result
+  end
+
+  def array_aware_deep_symbolize_keys
+    array_aware_deep_transform_keys{ |key| key.to_sym rescue key }
+  end
+
+  def without(*keys)
+    dup.without!(*keys)
+  end
+
+  def without!(*keys)
+    reject! { |key| keys.include?(key) }
+  end
+end

data/lib/ckick/hash_elements.rb

@@ -0,0 +1,51 @@
+# 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 String
+  def to_hash_element
+    self
+  end
+end
+
+class Fixnum
+  def to_hash_element
+    self
+  end
+end
+
+class Float
+  def to_hash_element
+    self
+  end
+end
+
+class TrueClass
+  def to_hash_element
+    self
+  end
+end
+
+class FalseClass
+  def to_hash_element
+    self
+  end
+end
+
+class Array
+  def to_hash_element
+    collect do |element|
+      if element.respond_to?(:to_hash)
+        element.to_hash
+      else
+        element.to_hash_element
+      end
+    end
+  end
+end
+
+class NilClass
+  def to_hash_element
+    self
+  end
+end

data/lib/ckick/hashable.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/hash"
+require "ckick/hash_elements"
+
+module CKick
+  module Hashable
+    def to_hash
+      a = {}
+      instance_variables_as_key_values.each do |name, obj|
+        a[name] = object_value(obj)
+      end
+      a
+    end
+
+    def to_no_empty_value_hash
+      a = {}
+      instance_variables_as_key_values.each do |name, obj|
+        if !obj.respond_to?(:empty?) || (obj.respond_to?(:empty?) && !obj.empty?)
+          a[name] = object_value(obj)
+        end
+      end
+      a
+    end
+
+    private
+
+    def instance_variables_as_key_values
+      instance_variables.collect do |att|
+        [att[1..-1].to_sym, instance_variable_get(att.to_sym)]
+      end
+    end
+
+    def object_value(obj)
+      if obj.respond_to?(:to_hash)
+        return obj.to_hash
+      else
+        return obj.to_hash_element
+      end
+    end
+  end
+end