ckick 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 756a6b9ffddc2fb04cc92a35d5983d8fe0445b81
-  data.tar.gz: f9dbe348fbcbc56f201c79e66311b0af9e5b32f6
+  metadata.gz: 7f67bdb5b93f95f17d249d3ebb736234f169eeaf
+  data.tar.gz: 260c7c593b1ffba404fa08609d694841baf8261b
 SHA512:
-  metadata.gz: 180ad0530a054bbc89fbca19bbee3e3c17101988edc5bacc2e389946403199977ea06b5af49efafb1434a076f8392ff7ec0e469ea7d3665d9e1317030e424c23
-  data.tar.gz: fb30114d785eee8c572a5390c40e32ff02c6d5305dab38dbc06a48bd6a38ddfb1539d617beb9eeeda0e2df0f22a8108a189eac28679a1b0e879cfe774fec63c5
+  metadata.gz: b9d498bd063661c4904ce9c1c68a0feebcb42a167383c87f2e029ff58211a0fd5464307838336e5cf0f9b614a57f814abc9ee5c8bfc69c36b406fbbba09ed77f
+  data.tar.gz: c919cec6a8393f0c34c80590d695398322c739f95035b82048f74672b2b4bedbd42b7b5e48b04fec3af5a460d98ee5594f10814d748037287e1201283efd588c

data/README.md

@@ -1,4 +1,4 @@
-# CKick [![Build Status](https://travis-ci.org/jonathangingras/ckick.svg?branch=master)](https://travis-ci.org/jonathangingras/ckick)
+# CKick [![Build Status](https://travis-ci.org/jonathangingras/ckick.svg?branch=master)](https://travis-ci.org/jonathangingras/ckick) [![Code Climate](https://codeclimate.com/github/jonathangingras/ckick/badges/gpa.svg)](https://codeclimate.com/github/jonathangingras/ckick)
 
 CKick is a simple gem that helps to kick start a C/C++ project using CMake with an arbitrary structure.
 Using a `CKickfile`, ckick is able to generate an whole project structure without having to write any `CMakeLists.txt` by your own.

data/Rakefile

@@ -1,6 +1,7 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
+# rspec
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec

data/ckick.gemspec

@@ -24,4 +24,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.13"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rdoc", "~> 4.2.2"
 end

data/lib/ckick.rb

@@ -7,48 +7,66 @@ require "ckick/project"
 require "ckick/find_plugin"
 require "ckick/ckickfile"
 
+# CKick module
+# contains all CKick core code
 module CKick
+  # location of the resource directory.
+  # +RESOURCE_DIR+ contains default project files and non-code utilities
   RESOURCE_DIR = File.join(File.dirname(File.dirname(__FILE__)), "resource")
 
+  # :nodoc:
   class Error < ::Exception
   end
 
+  # :nodoc:
   class BadFlagError < Error
   end
 
+  # :nodoc:
   class NoSuchDirectoryError < Error
   end
 
+  # :nodoc:
   class IllegalInitializationError < Error
   end
 
+  # :nodoc:
   class NoNameError < Error
   end
 
+  # :nodoc:
   class NoSourceError < Error
   end
 
+  # :nodoc:
   class BadProjectNameError < Error
   end
 
+  # :nodoc:
   class BadSourceError < Error
   end
 
+  # :nodoc:
   class BadLibError < Error
   end
 
+  # :nodoc:
   class BadIncludePathError < Error
   end
 
+  # :nodoc:
   class BadLibraryPathError < Error
   end
 
+  # :nodoc:
   class BadSubDirectoryError < Error
   end
 
+  # :nodoc:
   class NoParentDirError < Error
   end
 
+  # :nodoc:
   class BadFileContentError < Error
   end
 end

data/lib/ckick/array.rb

@@ -4,7 +4,10 @@
 
 require "ckick/hash"
 
+# :nodoc:
 class Array
+  # transforms any Hash key recursively
+  # * +block+ - transform operation
   def array_aware_deep_transform_keys(&block)
     result = []
     each do |value|

data/lib/ckick/cflag.rb

@@ -6,9 +6,12 @@ require "ckick/compiler_flag"
 
 module CKick
 
+  # C compiler flag representation
   class CFlag < CompilerFlag
+
+    # appends ${CMAKE_C_FLAGS} (CMake C compiler flags)
     def cmake
-      %Q(set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} #{@content}"))
+      %Q|set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} #{@content}")|
     end
   end
 

data/lib/ckick/ckickfile.rb

@@ -5,6 +5,9 @@
 require "json"
 
 module CKick
+  # loads a CKickfile in +dir+
+  # * +dir+ - directory containing file, defaults to Dir.pwd
+  # * +filename+ - filename, defaults to "CKickfile"
   def self.load_ckickfile(dir=Dir.pwd, filename="CKickfile")
     JSON.parse(File.read(File.join(dir, filename)), symbolize_names: true)
   end

data/lib/ckick/compiler_flag.rb

@@ -2,11 +2,17 @@
 # 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/.
 
+# :nodoc:
 module CKick
 
+  #represents a compiler flag to pass to the compiler
   class CompilerFlag
+    # raw flag
     attr_reader :content
 
+    # * +args+ - Hash containing flag data as String
+    # ==== Input hash keys
+    # * +:flag+ - raw flag content, must be String
     def initialize args={}
       raise IllegalInitializationError, "No flag provided to compiler flag" unless args.is_a?(Hash) && !args.empty?
       flag = args[:flag] || nil
@@ -15,22 +21,27 @@ module CKick
       @content = args[:flag]
     end
 
+    # converts to String, flag as is
     def to_s
       @content
     end
 
+    # converts to hash element: String
     def to_hash_element
       @content
     end
 
+    # raw flag
     def raw_flag
       @content
     end
 
+    # overrides Object#eql? for uniqueness
     def eql? other
       @content.eql? other.content
     end
 
+    # overrides Object#hash for uniqueness
     def hash
       @content.hash
     end

data/lib/ckick/cxxflag.rb

@@ -6,9 +6,12 @@ require "ckick/compiler_flag"
 
 module CKick
 
+  # C++ compiler flag representation
   class CXXFlag < CompilerFlag
+
+    # appends ${CMAKE_CXX_FLAGS} (CMake C++ compiler flags)
     def cmake
-      %Q(set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} #{@content}"))
+      %Q|set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} #{@content}")|
     end
   end
 

data/lib/ckick/dependencies.rb

@@ -11,9 +11,16 @@ require "ckick/hashable"
 
 module CKick
 
+  # Project dependency settings, such as include path, library path, and compiler flags
   class Dependencies
     include Hashable
 
+    # * +args+ - Dependencies hash (directly the CKickfile :dependencies element parsed with keys as Symbol), must be a Hash
+    # ====== Input hash keys
+    # * +:cflags+ - C language specific flags, for e.g. '-std=c89', '-Wall', etc., must be an Array of String
+    # * +:cxxflags+ - C++ language specific flags, for e.g. '-std=c++11', '-fno-exceptions', etc., must be an Array of String
+    # * +:include+ - Array of paths to append the include path (-I compiler option; include_directories() CMake command)
+    # * +:lib+ - Array of paths to append the link path (-L compiler option; link_directories() CMake command)
     def initialize args={}
       raise IllegalInitializationError unless args.is_a?(Hash)
 
@@ -21,7 +28,7 @@ module CKick
       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
+      end
 
       cxxflags = args[:cxxflags] || []
       raise IllegalInitializationError, "cxxflags provided to dependencied is not an Array" unless cxxflags.is_a?(Array)
@@ -42,27 +49,36 @@ module CKick
       end
     end
 
+    # converts to Hash (usable in CKickfile)
     def to_hash
       to_no_empty_value_hash
     end
 
+    # CMakeLists's section content
     def cmake
       [@cflags, @cxxflags, @include, @lib].flatten(1).collect do |unit|
           unit.cmake
       end.join("\n")
     end
 
+    # compiler flags in an Array
     def flags
       [@cflags, @cxxflags, @include, @lib].flatten(1).uniq.collect do |flag|
         flag.raw_flag
       end
     end
 
+    # appends include path (-I) with +path+
+    #
+    # +path+ - include path, must be a CKick::IncludePath
     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
 
+    # appends link path (-L) with +path+
+    #
+    # +path+ - link path, must be a CKick::LibraryPath
     def add_lib(path)
       raise BadLibraryPathError, "path must be a CKick::LibraryPath object" unless path.is_a?(LibraryPath)
       @lib << path unless @lib.include?(path)

data/lib/ckick/executable.rb

@@ -6,7 +6,10 @@ require "ckick/target"
 
 module CKick
 
+  # represents an executable target (in respect to CMake add_executable() command)
   class Executable < Target
+
+    # CMakeLists content of the target
     def cmake
       res = []
 

data/lib/ckick/find_plugin.rb

@@ -2,9 +2,12 @@
 # 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/.
 
+# :nodoc:
 module CKick
+  # CKick::Plugin load path
   $PLUGIN_PATH = [File.join(File.absolute_path(File.dirname(__FILE__)), "plugin")]
 
+  # finds ruby source files in $PLUGIN_PATH
   def self.find_builtin_plugins
     res = []
     $PLUGIN_PATH.each do |dir|
@@ -16,6 +19,7 @@ module CKick
     res.flatten(1)
   end
 
+  # requires all ruby source files in $PLUGIN_PATH
   def self.load_builtin_plugins
     find_builtin_plugins.each do |file|
       require file[0..-4]

data/lib/ckick/hash.rb

@@ -4,7 +4,10 @@
 
 require "ckick/array"
 
+# :nodoc:
 class Hash
+  # transforms keys recursively
+  # * +block+ - transform operation
   def array_aware_deep_transform_keys(&block)
     result = {}
     each do |key, value|
@@ -19,14 +22,17 @@ class Hash
     result
   end
 
+  # transforms each String-key to Symbol-key
   def array_aware_deep_symbolize_keys
-    array_aware_deep_transform_keys{ |key| key.to_sym rescue key }
+    array_aware_deep_transform_keys { |key| key.to_sym rescue key }
   end
 
+  # copy of the hash without pairs of +keys+
   def without(*keys)
     dup.without!(*keys)
   end
 
+  # removes each pair of +keys+
   def without!(*keys)
     reject! { |key| keys.include?(key) }
   end

data/lib/ckick/hash_elements.rb

@@ -2,37 +2,49 @@
 # 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/.
 
+# :nodoc:
 class String
+  #converts to hash-serializable value
   def to_hash_element
     self
   end
 end
 
+# :nodoc:
 class Fixnum
+  #converts to hash-serializable value
   def to_hash_element
     self
   end
 end
 
+# :nodoc:
 class Float
+  #converts to hash-serializable value
   def to_hash_element
     self
   end
 end
 
+# :nodoc:
 class TrueClass
+  #converts to hash-serializable value
   def to_hash_element
     self
   end
 end
 
+# :nodoc:
 class FalseClass
+  #converts to hash-serializable value
   def to_hash_element
     self
   end
 end
 
+# :nodoc:
 class Array
+  #converts to hash-serializable value
   def to_hash_element
     collect do |element|
       if element.respond_to?(:to_hash)
@@ -44,7 +56,9 @@ class Array
   end
 end
 
+# :nodoc:
 class NilClass
+  #converts to hash-serializable value
   def to_hash_element
     self
   end

data/lib/ckick/hashable.rb

@@ -6,7 +6,11 @@ require "ckick/hash"
 require "ckick/hash_elements"
 
 module CKick
+
+  # mixin enabling hash serialization
   module Hashable
+
+    # transforms object to Hash such that { :instance_variable => value }
     def to_hash
       a = {}
       instance_variables_as_key_values.each do |name, obj|
@@ -15,6 +19,7 @@ module CKick
       a
     end
 
+    # transforms object to Hash such that { :instance_variable => value }, excluding any pair where value responds +true+ to :empty? method
     def to_no_empty_value_hash
       a = {}
       instance_variables_as_key_values.each do |name, obj|

data/lib/ckick/include_path.rb

@@ -6,11 +6,15 @@ require "ckick/path"
 
 module CKick
 
+  #Represents a compiler include path (-I option or CMake include_directories() fonction)
   class IncludePath < Path
+
+    #compiler flag as is
     def raw_flag
       "-I#{@path}"
     end
 
+    #cmake code content
     def cmake
       %Q{include_directories(#{@path})}
     end

data/lib/ckick/library.rb

@@ -6,13 +6,19 @@ require "ckick/target"
 
 module CKick
 
+  # represents an library target (in respect to CMake add_library() command)
   class Library < Target
+
+    # * +args+ - Target hash (directly a CKickfile library target element's hash parsed with keys as Symbol), must be a Hash
+    # ====== CKick::Library specific input hash keys (in addition of CKick::Target ones)
+    # * +:shared+ - whether or not this library should be a dynamic library (shared object) or a static library (archive)
     def initialize args={}
       super args
 
       @shared = args[:shared] || false
     end
 
+    # converts to Hash (for CKickfile)
     def to_hash
       if @shared
         return super
@@ -21,6 +27,7 @@ module CKick
       end
     end
 
+    # CMakeLists content of the target
     def cmake
       res = []
 

data/lib/ckick/library_link.rb

@@ -2,28 +2,40 @@
 # 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/.
 
+# :nodoc:
 module CKick
 
+  # Represents a library link
+  # (-l compiler option or library name to be passed to CMake target_link_libraries() function)
   class LibraryLink
 
+    # initializes object with an Hash
+    # hash keys:
+    # * +:name+ - library name (lib#{name}.a/.so) as is
     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
 
+    # converts to hashable element
+    # name as is
     def to_hash_element
       @name
     end
 
+    # converts to String
+    # name as is
     def to_s
       @name
     end
 
+    # corresponding compiler link flag (-l option)
     def raw_flag
       "-l#{@name}"
     end
 
+    # cmake code content (only library name, not command)
     def cmake
       @name
     end

data/lib/ckick/library_path.rb

@@ -6,11 +6,15 @@ require "ckick/path"
 
 module CKick
 
+  # Represents a library link path (in respect to compiler -L option and CMake link_directories() fonction)
   class LibraryPath < Path
+
+    #compiler flag as is
     def raw_flag
       "-L#{@path}"
     end
 
+    #cmake code content
     def cmake
       "link_directories(#{@path})"
     end

data/lib/ckick/nil_class.rb

@@ -2,7 +2,9 @@
 # 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/.
 
+# :nodoc:
 class NilClass
+  # does nothing, but prevents no method errors
   def each &block
   end
 end

data/lib/ckick/path.rb

@@ -2,11 +2,14 @@
 # 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/.
 
+# :nodoc:
 module CKick
 
+  # Represents a file system path, it must exist
   class Path
     attr_reader :path
 
+    #initializes path, path must exist
     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])
@@ -14,10 +17,12 @@ module CKick
       @path = args[:path]
     end
 
+    #returns path as is
     def to_s
       @path
     end
 
+    #converts to hash-serializable element
     def to_hash_element
       @path
     end

data/lib/ckick/plugin.rb

@@ -2,8 +2,10 @@
 # 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/.
 
+# :nodoc:
 module CKick
 
+  # Base class for a CKick plugin
   class Plugin
     def initialize args
     end

data/lib/ckick/plugin/clang_complete.rb

@@ -4,10 +4,12 @@
 
 require "ckick/plugin"
 
+# Creates a .clang_complete file for clang auto completion
 class ClangComplete < CKick::Plugin
-  # Creates a .clang_complete file for clang auto completion
 
+  # assembles project flags and writes a .clang_complete file at project root
   def call(project)
+    # :nodoc:
     def clang_complete project
       project.dependencies.flags.join("\n")
     end

data/lib/ckick/plugin_delegate.rb

@@ -2,10 +2,13 @@
 # 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/.
 
+# :nodoc:
 module CKick
 
+  # :nodoc:
   module PluginDelegate
 
+    # :nodoc:
     def self.find(plugin)
       Object.const_get(plugin[:name]).new(plugin[:args] || {})
     end

data/lib/ckick/project.rb

@@ -11,13 +11,36 @@ require "ckick/plugin_delegate"
 
 module CKick
 
+  # This class represents a CMake project (as a main CMakeLists)
   class Project
     include Hashable
-    attr_reader :subdirs, :dependencies, :root, :build_dir
 
+    # each project CKick::SubDirectory
+    attr_reader :subdirs
+
+    # project CKick::Dependencies
+    attr_reader :dependencies
+
+    # project root directory
+    attr_reader :root
+
+    # project build directory
+    attr_reader :build_dir
+
+    # project name match pattern
     NAME_MATCH = /^[[A-Z][a-z]_[0-9]]+$/
+
+    # version match
     CMAKE_VERSION_MATCH = /^[0-9](\.[0-9]){0,2}$/
 
+    # * +args+ - project hash (directly the CKickfile parsed with keys as Symbol), must be a Hash
+    # ====== Input hash keys
+    # * +:name+ - project name, must respect NAME_MATCH
+    # * +:cmake_min_version+ - CMake minimum version (must be String), defaults to '3', must match CMAKE_VERSION_MATCH
+    # * +:root+ - Project root directory, usually '.'
+    # * +:build_dir+ - Project build directory, usually 'build'
+    # * +:subdirs+ - subdirectories (in respect to CMake subdirectory() command), must be a Array of Hash passed to SubDirectory::new
+    # * +:plugins+ - Array of Hash containing {:name => CKick::Plugin class name, :args => args for respective :initialize method }
     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)
@@ -54,23 +77,28 @@ module CKick
       init_subdirs
     end
 
+    # set the project name, must match NAME_MATCH
     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
 
+    # convert to String -> the project name as is
     def to_s
       @name
     end
 
+    # convert to Hash (to CKickfile)
     def to_hash
       to_no_empty_value_hash.without(:subdirs_initiated)
     end
 
+    # project root directory path
     def path
       @root
     end
 
+    # creates the project CMake structure
     def create_structure
       raise "SubDirectories have not been initiated" unless @subdirs_initiated
 
@@ -86,6 +114,7 @@ module CKick
       call_plugins
     end
 
+    # register an additionnal CKick::Plugin or block
     def register_plugin(plugin=nil, &block)
       raise ArgumentError, "" unless plugin.is_a?(::CKick::Plugin) || block
 
@@ -96,6 +125,7 @@ module CKick
       end
     end
 
+    # main project's CMakeLists.txt content
     def cmake
       append_plugin_paths
 
@@ -119,6 +149,7 @@ module CKick
 
     private
 
+    # called at the end of Project::new
     def init_subdirs
       @subdirs.each do |subdir|
         subdir.__send__ :set_parent, path
@@ -127,6 +158,7 @@ module CKick
       @subdirs_initiated = true
     end
 
+    # appends include path and library path by each CKick::Plugin#include and CKick::Plugin#lib
     def append_plugin_paths
       @plugins.each do |plugin|
         plugin.include(self).each do |path|
@@ -138,22 +170,25 @@ module CKick
       end
     end
 
+    # ran before structure creation (calls each CKick::Plugin#run)
     def run_plugins
       @plugins.each do |plugin|
         plugin.run(self) if plugin.respond_to? :run
       end
     end
 
+    # ran after structure creation (calls each CKick::Plugin#call)
     def call_plugins
       @plugins.each do |plugin|
         plugin.call self
       end
     end
 
+    # plugins CMakeLists.txt content section in main CMakeLists.txt content
     def plugins_cmake
       res = "##ckick plugins section##\n"
 
-      def plugin_name(plugin)
+      def plugin_name(plugin) #:nodoc:
         if plugin.respond_to?(:name)
           return plugin.name
         else

data/lib/ckick/sub_directory.rb

@@ -11,11 +11,26 @@ require "ckick/path_delegate"
 
 module CKick
 
+  # Represents a project sub directory (in respect to CMake sub_directory() command)
   class SubDirectory
     include Hashable
 
-    attr_reader :name, :parent_dir, :has_cmake
+    # directory name
+    attr_reader :name
 
+    # parent directory
+    attr_reader :parent_dir
+
+    # whether or not this directory has targets and a CMakeLists.txt
+    attr_reader :has_cmake
+
+    # * +args+ - SubDirectory hash (directly a CKickfile :subdirs Array element parsed with keys as Symbol), must be a Hash
+    # ====== Input hash keys
+    # * +:name+ - subdirectory name
+    # * +:libraries+ - libraries built in this subdirectory (in respect to CMake add_library() command), Array of Hash each containing information for CKick::Library::new
+    # * +:executables+ - executables built in this subdirectory (in respect to CMake add_executable() command), Array of Hash each containing information for CKick::Executable::new
+    # * +:subdirs+ - recursive subdirectories (in respect to CMake subdirectory() command), must be a Array of Hash passed to CKick::SubDirectory::new
+    # * +:has_cmake+ - whether or not this subdirectory has a CMakeLists.txt (consequently builds targets or not)
     def initialize args={}
       name = args[:name]
       raise IllegalInitializationError, "no name provided to sub directory" unless name.is_a?(String) && !name.empty?
@@ -52,10 +67,12 @@ module CKick
       @parent_dir = nil
     end
 
+    # converts to String, subdirectory name as is
     def to_s
       @name
     end
 
+    # converts to Hash (to CKickfile :subdirs element)
     def to_hash
       if !@has_cmake
         return to_no_empty_value_hash.without(:parent_dir)
@@ -63,11 +80,15 @@ module CKick
       to_no_empty_value_hash.without(:parent_dir, :has_cmake)
     end
 
+    # subdirectory path
     def path
       raise NoParentDirError, "sub directory #{@name} has no parent set" unless @parent_dir
       File.join(@parent_dir, @name)
     end
 
+    # creates subdirectory structure
+    #
+    # this method is called recursively on subdirectories
     def create_structure
       PathDelegate.create_directory(path)
 
@@ -84,6 +105,7 @@ module CKick
       end
     end
 
+    # subdirectory CMakeLists.txt file content
     def cmake
       res = ''
 
@@ -101,10 +123,14 @@ module CKick
 
     private
 
+    # Array of all targets ( CKick::Target ) contained in this subdirectory
     def targets
       @executables + @libraries
     end
 
+    # sets parent directory path
+    #
+    # this method is called recursively on subdirectories
     def set_parent(parent_dir)
       @parent_dir = parent_dir
 

data/lib/ckick/target.rb

@@ -9,9 +9,15 @@ require "ckick/hashable"
 
 module CKick
 
+  # common representation of targets to build, such as executables and libraries
   class Target
     include Hashable
 
+    # * +args+ - Target hash (directly a CKickfile target element's hash parsed with keys as Symbol), must be a Hash
+    # ====== Input hash keys
+    # * +:name+ - name of the target
+    # * +:source+ - either a String (single-source file) or Array of String (multiple source files)
+    # * +:libs+ - names of the libraries to link to the target, must be Array of String
     def initialize args={}
       raise IllegalInitializationError unless args.is_a?(Hash) && !args.empty?
 
@@ -46,14 +52,17 @@ module CKick
       @parent_dir = nil
     end
 
+    # converts to Hash (for CKickfile)
     def to_hash
       to_no_empty_value_hash.without(:parent_dir)
     end
 
+    # converts to String, the target's name as is
     def to_s
       @name
     end
 
+    # Array of source file paths
     def paths
       raise NoParentDirError, "No parent directory has been set for target #{@name}" unless @parent_dir
       res = []
@@ -63,6 +72,7 @@ module CKick
       res
     end
 
+    # creates target's structure (each missing source file)
     def create_structure
       paths.each do |path|
         unless File.exist? path
@@ -73,6 +83,7 @@ module CKick
 
     private
 
+    # set's parent directory
     def set_parent(parent_dir)
       @parent_dir = parent_dir
     end

data/lib/ckick/version.rb

@@ -2,6 +2,8 @@
 # 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/.
 
+# :nodoc:
 module CKick
-  VERSION = "0.1.0"
+  # gem version
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ckick
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jonathan Gingras
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-30 00:00:00.000000000 Z
+date: 2016-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.2.2
 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