neutron 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9fcb3a8b875da195e8ce7c6e2b90c23f063d97e4
-  data.tar.gz: b0783ecb19dfd497cfdb196b58b88070e16e546f
+  metadata.gz: ed6e7b52ccba90b2d31c4dcbd54897c0ad0257c4
+  data.tar.gz: 201733d607545352f5c569df22bc8641d5cd0ae3
 SHA512:
-  metadata.gz: 132fce6e5d3e697d417e938a7713ae7d0c8c1172341f96f420b9ca990fef3acd45c79e9782bead94f371b575ce6d22ab86b9b2cdeadcf79bea34569f757a2be1
-  data.tar.gz: 47d7b251754520c2e8d0f4e885b471618e72f432d50dade0b1d6269c4409a091861918a78f5c73c9069e2849e8d9a22eb7fb6ea1b3e14784424bf6ac0dd8ff3c
+  metadata.gz: 8b096c82be55a889e2c5669d986610b847140ba34cd635f33c2cdcbd1a4f3d5227b18e3f0eb07e49d202ac5785d30da042a16eccec82ca0bbd5aa6e6075bbd64
+  data.tar.gz: d677ab4e1ca425852ede20f55401d2ae757c1397eae292867476ffe2497a15fea8f44df3873ff9d2edcbdf74237ddf3baaf642a40414a3f74b103d9661db9276

data/README.md

@@ -37,6 +37,8 @@ require 'neutron'
 require 'neutron/pkgconf'
 require 'neutron/cc'
 require 'neutron/valac'
+require 'neutron/install'
+require 'neutron/clean'
 
 Dir.chdir('src/') # We'll compile our stuff here
 
@@ -68,14 +70,30 @@ task :link do
     args: packages.to_cc(cflags: false) # Package list
   )
 end
+
+task :install do
+  # Installs results to #{prefix}/bin/. Uses ENV['PREFIX'] or '/usr/' as prefix
+  Neutron.install(
+    '../sample',
+    'bin/'
+  )
+end
+
+task :clean do
+  # Removes all listed files
+  Neutron.clean(
+    *Neutron::FileList['*.vala.o'],
+    '../sample'
+  )
+end
 ```
 
 ## ToDo
 
-1. Gem-like version-checker
-2. Shared-Object builder
-3. `install` tool (must install headers, binaries, shared objects)
-4. Finders for Boost, SFML, Qt, etc
+1. Docs
+2. Gem-like version-checker
+3. Finish Neutron::Valac module
+4. Finders for Boost, SFML, Qt, etc (should be implemented in separate gem)
 
 ## Development
 

data/lib/neutron/cc.rb

@@ -5,9 +5,20 @@ module Neutron::CC
     o = {
       prog: 'cc',
       debug: false,
-      args: ''
+      args: '',
+      shared: false
     }.merge(opts)
-    Neutron.execute("#{o[:prog]} -o #{target} #{files.join(' ')} #{'-g' if o[:debug]} #{o[:args]}", must_success: true)
+    specific = ''
+    if o[:shared]
+      specific << ' -shared'
+    end
+    files.map! do |file|
+      File.expand_path(file)
+    end
+    Neutron.execute(
+      "#{o[:prog]} #{specific} -Wl,-rpath=./ -Wall -fpic -o #{target} #{files.join(' ')} #{'-g' if o[:debug]} #{o[:args]}",
+      must_success: true
+    )
   end
 
   def self.cc(*files, **opts)
@@ -17,6 +28,7 @@ module Neutron::CC
       args: ''
     }.merge(opts)
     files.each do |file|
+      file = File.expand_path(file)
       Neutron.execute("#{o[:prog]} -c #{file} #{'-g' if o[:debug]} #{o[:args]}", must_success: true)
     end
   end
@@ -28,6 +40,7 @@ module Neutron::CC
       args: ''
     }.merge(opts)
     files.each do |file|
+      file = File.expand_path(file)
       Neutron.execute("#{o[:prog]} -c #{file} #{'-g' if o[:debug]} #{o[:args]}", must_success: true)
     end
   end

data/lib/neutron/clean.rb

@@ -0,0 +1,18 @@
+require 'neutron'
+
+module Neutron
+  def self.clean(*files)
+    files << Neutron::PkgStatus::FNAME
+    files.map! do |file|
+      File.expand_path(file)
+    end
+    files.each do |file|
+      if File.exist?(file)
+        Neutron.execute(
+          "rm -r #{file}",
+          must_success: true
+        )
+      end
+    end
+  end
+end

data/lib/neutron/install.rb

@@ -0,0 +1,28 @@
+require 'neutron'
+
+module Neutron
+  def self.install(*files, dir)
+    prefix = if ENV['PREFIX'] then ENV['PREFIX'] else '/usr' end
+    dir = File.expand_path(File.join(prefix, dir))
+    sudo = if ENV['USE_SUDO'] then 'sudo ' else '' end
+    unless File.exist? dir
+      Neutron.execute(
+        "#{sudo}mkdir --parents --mode=755 #{dir}",
+        must_success: true
+      )
+    end
+    files.each do |file|
+      p file
+      dn = File.join(dir, File.dirname(file))
+      p dn
+      #file = File.expand_path(file)
+      unless File.exist?(dn)
+        Neutron.execute("#{sudo}mkdir --parents --mode=755 #{dn}")
+      end
+      Neutron.execute(
+        "#{sudo}rsync -a --relative --chmod=755 #{file} #{dir}/",
+        must_success: true
+      )
+    end 
+  end
+end

data/lib/neutron/pkgconf.rb

@@ -47,4 +47,39 @@ class Neutron::PkgConf
     raise InvalidPkgConfError if tainted?
     @packages.map{|p|"--pkg #{p}"}.join(' ')
   end
+
+  def self.gen_pc(filename, **opts)
+    prefix = if ENV['PREFIX'] then ENV['PREFIX'] else '/usr' end
+    filename = File.expand_path(filename)
+
+    content = ''
+    
+    content << "prefix=#{prefix}\n"
+    content << "exec_prefix=${prefix}\n"
+    content << "includedir=${prefix}/include\n"
+    content << "libdir=${exec_prefix}/lib\n"
+    content << "\n"
+
+    reqs = if opts[:requires] then opts[:requires].packages.join(' ') else '' end
+    preqs = if opts[:prequires] then opts[:prequires].packages.join(' ') else '' end
+
+    lname = opts[:name]
+    if m = /lib(.+)/.match(lname.downcase)
+      lname = m[1]
+    end
+
+    content << "Name: #{opts[:name] or 'Unnamed'}\n"
+    content << "Description: #{opts[:description] or 'No description'}\n"
+    content << "Version: #{opts[:version] or '0.1.0'}\n"
+    content << "Requires: #{reqs}\n"
+    content << "Requires.private: #{preqs}\n"
+    content << "Cflags: #{opts[:cflags] or "-I${includedir}/#{opts[:name].downcase or 'undefined'}"}\n"
+    content << "Libs: -L${libdir} -l#{lname or 'undefined'}\n"
+    content << "Libs.private: #{opts[:plibs] or ''}\n"
+
+    File.delete(filename) if File.exist?(filename)
+    File.write(filename, content)
+
+    puts "] Done generating pkg-config #{filename}"
+  end
 end

data/lib/neutron/static_lib.rb

@@ -0,0 +1,10 @@
+require 'neutron'
+
+module Neutron::Static
+  def self.make_static(*files, out)
+    files.map! do |file|
+      File.expand_path(file)
+    end
+    Neutron.execute("ar rcs #{out} #{files.join(' ')}", must_success: true)
+  end
+end

data/lib/neutron/valac.rb

@@ -1,14 +1,65 @@
 require 'neutron'
 
-class Neutron::Valac
+module Neutron::Valac
   def self.compile(*files, **opts)
     o = {
       prog: 'valac',
       debug: false,
+      type: :object,
+      gen_vapi: false,
+      gen_header: false,
       args: ''
     }.merge(opts)
+
+    specific = ''
+    
+    if o[:debug]
+      specific << ' -g'
+    end
+
+    case o[:type]
+    when :object
+      specific << ' -c'
+    when :ccode
+      specific << ' -C'
+    else
+      raise TypeError, "Invalid output type: #{o[:type]}!"
+    end
+
     files.each do |file|
-      Neutron.execute("#{o[:prog]} -c #{file} #{'-X g' if o[:debug]} #{o[:args]}", must_success: true)
+      file = File.expand_path(file)
+
+      iter_specific = ''
+      
+      if o[:gen_vapi]
+        puts "Warning: this part of Neutron::Valac module is not finished. Use it at own risk!"
+        iter_specific << " --vapi #{Neutron.file_to_ext(file, '.vapi')}"
+      end
+
+      if o[:gen_header]
+        iter_specific << " --header #{Neutron.file_to_ext(file, '.h')}"
+      end
+
+      Neutron.execute("#{o[:prog]} #{file} #{specific} #{iter_specific} -b ./ --thread #{o[:args]}", must_success: true)
     end
   end
-end
+
+  def self.to_c(*files, **opts)
+    o = {
+      proc: 'valac',
+      args: ''
+    }
+  end
+
+  def self.vapi_header(header)
+    "[CCode (cheader_filename = \"#{header}\")]\n\n"
+  end
+end
+
+=begin
+  valac --vapi library.vapi --header library.h library.vala -C  # Compiles library into C code and header to access it
+  cat *.vapi > libname.vapi # Concatenates all VAPIs into single file. Worked for me
+  gcc -c library.c -fpic `pkg-config --libs --cflags glib-2.0` # Compiles generated C code
+  gcc library.vala -o libname.so -shared -fpic `pkg-config --libs --cflags glib-2.0` # Compiles shared library
+  valac test.vala libname.vapi -X library.so -X -Wl,-rpath=./ # Compiles project using library
+=end

data/lib/neutron/version.rb

@@ -1,3 +1,3 @@
 module Neutron
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/lib/neutron.rb

@@ -3,10 +3,16 @@ require 'open3'
 
 require 'neutron/version'
 
+# Main module
 module Neutron
+  # Execution error
   class ExecutionError < StandardError; end
 
+  # Polyfill for Rake::FileList
   class FileList < Array
+    # Selects all files which match given pattern/regex
+    # @param [String,Regexp] filter
+    # @return [Neutron::FileList]
     def self.[](filter)
       arr = Dir[filter]
       arr = arr.keep_if do |f|
@@ -15,24 +21,56 @@ module Neutron
       self.new(arr)
     end
 
+    # Switches all files to given extension
+    # @param [String] ext New extension
     def ext(ext)
       self.map do |f|
-        m = /(.+)\..+/.match(f)
-        if m
-          m[1] + ext
-        else
-          f + ext
-        end
+        Neutron.file_to_ext(f, ext)
       end
     end
   end
 
+  def self.file_to_ext(f, ext)
+    m = /(.+)\..+/.match(f)
+    if m
+      m[1] + ext
+    else
+      f + ext
+    end
+  end
+
+  def self.cat(*files, out, **opts)
+    out = File.expand_path(out)
+    
+    File.delete(out) if File.exist?(out)
+
+    f = File.open(out, 'w')
+    puts "] Open: #{out}"
+
+    if opts[:prepend]
+      f.write(opts[:prepend])
+      puts "] Prepended content to #{out}"
+    end
+
+    files.each do |s|
+      s = File.expand_path(s)
+      f.write(File.read(s))
+      puts "] Write #{s} to #{out}"
+    end
+
+    f.close
+    puts "] Close: #{out}"
+  end
+
+  # Small extension for array which is developed to be used in Neutron.files()
   class FilePairList < Array
+    # @return [Array<String>] 
     def sources
       self.map do |i|
         i.source
       end
     end
+    # @return [Array<String>]
     def targets
       self.map do |i|
         i.target
@@ -40,6 +78,10 @@ module Neutron
     end
   end
 
+  # Returns list of files which need to be processed
+  # @param [Array<String>] sources
+  # @param [String] t_ext Target extension
+  # @return [Neutron::FilePairList<FilePair>]
   def self.files(sources, t_ext)
     targets = sources.ext(t_ext)
     pairs = sources.zip(targets)
@@ -62,6 +104,11 @@ module Neutron
     Neutron::FilePairList.new(pairs)
   end
 
+  # Executes given command
+  # @param [String] string Command to execute
+  # @param [Hash] opts
+  # @option opts [Boolean] :must_success If exit code is not 0 - raises an exception
+  # @return [Array[String,Integer]] Output and exit code
   def self.execute(string, **opts)
     puts "> #{string}"
     stdin, stdout, waiter = *Open3.popen2e(string)
@@ -78,19 +125,28 @@ module Neutron
     return [out, waiter.value.exitstatus]
   end
 
+  # File pair
   class FilePair
     attr_reader :source, :target
     def initialize(source, target)
       @target = target
       @source = source
     end
+    def expand
+      @target = File.expand_path(@target)
+      @source = File.expand_path(@source)
+      self
+    end
   end
 
+  # Package status utilities
   module PkgStatus
     class PkgNotFoundError < StandardError; end
     
     FNAME = './.neutron_pkgs'.freeze
 
+    # Gets all checked packages
+    # @return [Array<String>]
     def self.get_checked
       if File.exist?(FNAME)
         JSON.load(File.read(FNAME))
@@ -99,6 +155,8 @@ module Neutron
       end
     end
 
+    # Adds found packages to `checked` list
+    # @param [Array<String>] found
     def self.add_found(found)
       checked = get_checked
       File.delete(FNAME) if File.exist?(FNAME)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: neutron
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Nickolay Ilyushin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-30 00:00:00.000000000 Z
+date: 2017-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -55,7 +55,10 @@ files:
 - bin/setup
 - lib/neutron.rb
 - lib/neutron/cc.rb
+- lib/neutron/clean.rb
+- lib/neutron/install.rb
 - lib/neutron/pkgconf.rb
+- lib/neutron/static_lib.rb
 - lib/neutron/valac.rb
 - lib/neutron/version.rb
 - neutron.gemspec