beaver-build 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a00331b274e731341ca50bccc73fa013c5449673ee30a9beea5b0a01259ffac7
+  data.tar.gz: 209d69ad346136143bbc4c612f10fd22e04db7eb55b602dd02d189ef48bd6947
+SHA512:
+  metadata.gz: 5580ebbb545b2e2a45d05db57827aaacb3bd4fd712f4f45adece1bcf8bc6600c32f207c32de0edb8c90c66286fb827052aef1fe47652f5962af34a502c19c985
+  data.tar.gz: 98a08e5c318ad7700b49a5362bd7f891363538f12230db73cac35eec0496a7a54d4345c04345906a97ec398cb9ab8ce095e527c7c96007046227c4839e597ba3

data/lib/FileInfo.rb

@@ -0,0 +1,51 @@
+require 'json'
+require 'fileutils'
+
+# date: last modified
+FileInfo = Struct.new(:date)
+
+class FileInfoRW 
+  # file_loc = cache file location
+  # file_path = path of the file that represents the cache file
+  def initialize(file_loc, file_path)
+    @file_loc = file_loc
+    @file_path = file_path
+  end
+  
+  # Read the info file and write a new one if needed
+  # Report back if the file has changed
+  def file_has_changed?()
+    cache_file = File.open(@file_loc)
+    
+    file_info = JSON.parse(cache_file.read, object_class: OpenStruct)
+    last_modified = File.mtime(@file_path).to_i
+    if last_modified > file_info.date
+      json = self._json
+      File.write(@file_loc, json)
+      return true
+    else
+      return false
+    end
+  end
+  
+  # Create the cache file
+  def create_cache()
+    json = self._json
+
+    dirnames = File.dirname(@file_loc)
+    unless File.directory?(dirnames)
+      # Directories do not exist, create them
+      FileUtils.mkdir_p(dirnames)
+    end
+    
+    File.write(@file_loc, json)
+  end
+  
+  private
+  # FileInfo as json
+  def _json
+    return FileInfo.new(
+      File.mtime(@file_path).to_i
+    ).to_h.to_json
+  end
+end

data/lib/alias.rb

@@ -0,0 +1,35 @@
+# Aliases for default ruby commands for easier access by beaver users
+
+# Execute system command
+def §(cmd)
+  puts cmd
+  system cmd
+end
+
+# Execute system command
+def sys(cmd)
+  puts cmd
+  system cmd
+end
+
+String.prepend(Module.new do
+  # The directory a file resides in
+  def dirname
+    return File.dirname self
+  end
+  
+  # Basename of a file
+  def basename
+    return File.basename(self, ".*")
+  end
+  
+  # File's basename with extension
+  def basename_ext
+    return File.basenam self
+  end
+  
+  # The file's extension
+  def ext
+    return File.extname self
+  end
+end)

data/lib/beaver.rb

@@ -0,0 +1,60 @@
+require 'fileutils'
+
+# Export functions
+require 'file_change'
+require 'file_exists'
+require 'command'
+require 'alias'
+
+class Beaver
+  # The location where Beaver caches
+  attr_accessor :cache_loc
+  
+  # Initializer should not be used outside of this module
+  def initialize
+    # Contains all commands
+    # [commandName: String => command: Function]
+    @commands = Hash.new
+    # Contains the main command name
+    @mainCommand = nil
+    @cache_loc = "./.beaver"
+  end
+  
+  # Appends a command to the global beaver
+  def __appendCommand(name, func)
+    if @commands.size == 0
+      @mainCommand = name.to_sym
+    end
+    
+    @commands[name.to_sym] = func
+  end
+  
+  def __appendCommandCB(name, &func)
+    self.__appendCommand(name, func)
+  end
+  
+  # Call a command
+  def call(cmd)
+    _cmd = @commands[cmd.to_sym]
+    if _cmd.nil?
+      puts "No command called #{cmd} found"
+      exit 1
+    end
+    
+    _cmd.call
+  end
+  
+  # Put this at the end of a file
+  def end
+    command = ARGV[0] || @mainCommand
+    self.call command
+  end
+  
+  # Clean beaver
+  def clean
+    FileUtils.rm_r @cache_loc
+  end
+end
+
+# Global beaverr object@
+$beaver = Beaver.new

data/lib/command.rb

@@ -0,0 +1,105 @@
+require 'pathname'
+require 'file_matches'
+
+# register a new beaver command
+#
+# - Possible combinations
+# Register a normal command
+#   command :name do end
+# Register a command that executes if a source file changed, or the target file does not exist (one target file per source file)
+#   command :name, src: "", target_dir: "", target_ext: "", do end
+# Register a command that executes if a source file changed, or the single target file does not exist (multiple sources into one target file)
+# The callback will receive a files variables, which is a string containing all paths, separated by spaces
+#   command :name, src: "", target: "" do end
+def command(name, src:nil, target_dir:nil, target_ext:nil, target:nil, &func)
+  if !src.nil? && !target_dir.nil? && !target_ext.nil?
+    _command_oto name, src:src, target_dir:target_dir, target_ext:target_ext do |src, trg|
+      func.call src, trg
+    end
+  elsif !src.nil? && !target.nil?
+      _command_mto name, src:src, target:target do |files, target|
+        func.call files, target
+      end
+  else
+    _command name do ||
+      func.call
+    end
+  end
+end
+
+# Register a new beaver command
+def _command(name, &func)
+  $beaver.__appendCommand(name, func)
+end
+
+# Defines a dependency from source file to target file
+OneWayDependency = Struct.new(:src, :target)
+
+# - Example:
+# ```ruby
+# command_oto :command_name, src: "src/**/*.c", target_dir: "build", target_ext: ".o" do |source_file, target_file|
+# 
+# end
+# ```
+def _command_oto(name, src: nil, target_dir: nil, target_ext: nil, &func)
+  $beaver.__appendCommandCB name do
+    src_files = get_matches(src)
+    
+    abs_cd = File.dirname(File.expand_path($0))
+    
+    # Contains all files with (source and target)
+    files = []
+    src_files.each do |srcfile|
+      file_name = File.basename(srcfile, ".*")
+      
+      # path of the source file relative to the current directory
+      path_ext = File.dirname(
+        Pathname.new(File.expand_path(srcfile))
+          .relative_path_from(abs_cd)
+      )
+      
+      files << OneWayDependency.new(
+        srcfile,
+        File.join(target_dir, path_ext, "#{file_name}#{target_ext}")
+      )
+    end
+    
+    for file in files
+      should_execute = false
+      if file_changed?(file.src)
+        # If source file has changed, then the function should be called
+        should_execute = true
+      elsif !File.file?(file.target)
+        # If the target file does not exist, then the function should be called
+        should_execute = true
+      elsif __beaver_file_changed?
+        # If the beaver config file changed, then the function should be called
+        should_execute = true
+      end
+    
+      if should_execute
+        func.call file.src, file.target
+      end      
+    end
+  end
+end
+
+
+def _command_mto(name, src:nil, target:nil, &func)
+  $beaver.__appendCommandCB name do
+    should_execute = false
+    
+    if_any_changed src do |_|
+      should_execute = true
+    end
+    
+    if !File.file?(target)
+      should_execute = true
+    end
+    
+    if should_execute
+      src_files = get_matches(src)
+      func.call src_files.join(" "), target
+    end
+  end
+end

data/lib/file_change.rb

@@ -0,0 +1,62 @@
+require 'file_matches'
+require 'FileInfo'
+
+# Execute a function if the specified files have changed since last execution
+# Also executes the function if the config file has changed
+#
+# # Parameters
+# - files: either an array of files (or file patterns), or a file pattern as a string or regexp
+# - func: the body of the if statement
+def if_changed(files, &func)
+  matches = get_matches(files)
+  
+  # Execute for each match if either no cache exists, or
+  # if the cache indicates a older file version
+  matches.each do |file|
+    if file_changed?(file) || __beaver_file_changed?
+      func.call file
+    end
+  end
+end
+
+# Executes if any file changed
+# The callback receives a list of changed files
+def if_any_changed(files, &func)
+  changed_files = []
+  if_changed files do |file|
+      changed_files << file
+  end
+  
+  unless changed_files.empty?
+    func.call changed_files
+  end
+end
+
+# check if a single file has changed
+# returns true if it has been changed
+def file_changed?(file)
+  cache_file_loc = "#{$beaver.cache_loc}/#{file}.info"
+  info_rw = FileInfoRW.new(cache_file_loc, file)
+  if !File.file?(cache_file_loc)
+      # File does not exist, so create it and call the function
+      info_rw.create_cache()
+      
+      return true
+  else
+    # File exists, so read it
+    if info_rw.file_has_changed?
+      return true
+    else
+      return false
+    end
+  end
+end
+
+$__beaver_file = nil
+def __beaver_file_changed?
+  if $__beaver_file == nil
+    $__beaver_file = file_changed?($0)
+  end
+  
+  return $__beaver_file
+end

data/lib/file_exists.rb

@@ -0,0 +1,22 @@
+# Executes a function if a file exists, passing in the existing file
+def if_exists(files, &func)
+  files.each do |file|
+    if File.file?(file)
+      func.call file
+    end
+  end
+end
+
+# Executes a function if a file does not exists, passing in the non-existing file
+def if_not_exists(files, &func)
+  files.each do |file|
+    unless File.file?(file)
+      func.call file
+    end
+  end
+end
+
+# Executes a function if a file exists, passing in the existing file
+def unless_exists(files, &func)
+  if_not_exists(files, func)
+end

data/lib/file_matches.rb

@@ -0,0 +1,26 @@
+def get_matches(files)
+  # All file patterns to process
+  patterns_to_process = []
+  
+  # Check if array or string
+  if files.respond_to? :each
+    # is an array
+    patterns_to_process = file
+  else
+    patterns_to_process << files
+  end
+  
+  # Contains all files that match the expressions
+  matches = nil
+  
+  patterns_to_process.each do |pattern|
+    if pattern.is_a?(Regexp)
+      matches = Find.find("./").grep(pattern)
+    else
+      # is a string
+      matches = Dir.glob(pattern)
+    end
+  end
+  
+  return matches
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: beaver-build
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jonas Everaert
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-08-15 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/FileInfo.rb
+- lib/alias.rb
+- lib/beaver.rb
+- lib/command.rb
+- lib/file_change.rb
+- lib/file_exists.rb
+- lib/file_matches.rb
+homepage: https://github.com/jomy10/beaver
+licenses:
+- MIT
+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: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: Ruby-powered build tool
+test_files: []