ruby_make_script 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3406be1df614999fd1ca1ea31185363c98ae75e77beae44547c3ea4a6225c2a4
+  data.tar.gz: c01a6f7f1975958eee6c8db653bf8001789575c12f3880651809cdd990ef7a75
+SHA512:
+  metadata.gz: 97cfd2352791c73010bf3c06239a02af829530e023d7092b10297b8fa80a090bfde40ff082b33fe7de8cd31851c48ade3cf0b3964d9e80237befac9f273a2de6
+  data.tar.gz: 387906e219c62fa99ed6d573b013b1037512623a02af0114e0b35d6585bfca532af5a856de7b7e83d4ab935429bdda65f49d348f8653c1c678adbd52fbf70c29

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 1.17.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at dnailzb@outlook.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+
+gem 'pastel'
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in ruby_make_script.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 dnailz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,86 @@
+# RubyMakeScript
+
+
+## Installation
+
+
+Or install it yourself as:
+
+    ```
+    $ gem install ruby_make_script
+    ```
+
+## Usage
+
+Write ruby_make_script like this:
+
+```ruby
+require "ruby_make_script"
+
+make do
+    :run .from "a.out" do
+        r "./a.out"
+    end
+    "a.out" .from "test.c" do
+        r "gcc test.c"
+    end
+end
+```
+
+then run:
+
+```
+$ ruby make.rb
+$ ruby make.rb run
+```
+
+It works very similar to GNU Make.
+
+Here is a little complex one:
+
+```ruby
+require "ruby_make_script"
+
+def CC(*str)
+    r "gcc", "-I.", *str
+end
+
+mkdir? ".build"                     # `?` take error as warning, and also return a bool to indicate success/failure.
+sources = Dir.glob("**/*.c")        # Dir.glob will be very useful
+objects = sources.map{
+    |f| ".build/" + f.gsub('.c', '.o')
+}
+headers = Dir.glob("**/*.h")
+
+make do
+    :app .from "prog" do
+        runfile $d[0]               # $d: dependencies array
+    end
+    "prog" .from(*objects) do
+        CC "-o", $t[0], *$d         # $t: targets array
+    end
+    sources.zip(objects).each do |s, o|
+        o .from(s, *headers) do
+            CC "-c", "-o", $t[0], $d[0]
+        end
+    end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ruby_make_script. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the RubyMakeScript project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/ruby_make_script/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ruby_make_script"
+
+# 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(__FILE__)

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/lib/ruby_make_script.rb

@@ -0,0 +1,180 @@
+#
+# Usage:
+# ```
+# require "ruby_make_script"
+# make do
+#     :run .from "a.out" do
+#         ~ "./a.out"
+#     end
+#     "a.out" .from "test.c" do
+#         ~ "gcc test.c"
+#     end
+# end
+# ````
+#
+#
+#
+
+require 'pastel'
+require 'yaml'
+
+# all targets list
+$targetlist = []      
+
+# file -> target
+$file_target_dict = Hash[]   
+
+# file -> mtime (last make)
+$file_time_dict = Hash[]   
+
+# file -> mtime  
+$cur_file_time_dict = Hash[] 
+
+require 'ruby_make_script/utils'
+require 'ruby_make_script/target'
+
+# check a file (recursively) and run the commands of the target.
+def resolve(file, force_exec=false)
+    if file_modified?(file) || force_exec
+        t = $file_target_dict[file]
+        # when t == nil, its a file not used for target
+        if t != nil 
+            t.depend_each { |f|
+                resolve(f)
+            }
+            t.run()
+            # if File.exist?(file) 
+            #     puts "#{file} modified #{$file_time_dict[file]} != #{File.mtime(file)}"
+            # else
+            #     puts "#{file} modified not exist?"
+            # end
+            file_modified!(file)
+        end
+    end 
+end
+
+# check if a file is modified or its dependency is modified
+def file_modified?(file)
+    if $file_target_dict[file].class == FileTarget
+        # 文件真正被修改：文件之前不存在，或文件现在已经不存在，或时间戳修改
+        real_modified = $file_time_dict[file] == nil || !File.exist?(file) || ($file_time_dict[file] != File.mtime(file))
+        # 文件依赖被修改
+        return real_modified || $file_target_dict[file].depend_modified?
+    elsif $file_target_dict[file].class == PhonyTarget
+        # 假目标被修改：依赖被修改或之前不存在
+        return $file_time_dict[file] == nil || $file_target_dict[file].depend_modified?
+    elsif $file_target_dict[file] == nil
+        # 对无目标的文件，判断其存在，存在则直接使用即可
+        if !File.exist?(file)
+            raise "file not found #{file}"
+        else
+            $cur_file_time_dict[file] = File.mtime(file)
+            return $file_time_dict[file] == nil || ($file_time_dict[file] != File.mtime(file))
+        end 
+    else
+        raise "file type error #{$file_target_dict[file].class}"
+    end
+end
+
+# mark a file is modified
+def file_modified!(file)
+    if $file_target_dict[file].class == FileTarget
+        $cur_file_time_dict[file] = File.mtime(file)
+    elsif $file_target_dict[file].class == PhonyTarget
+        $cur_file_time_dict[file] = true
+    else
+        raise "file type error #{file.class}"
+    end
+end
+
+
+class Symbol
+    # Usage:
+    # 
+    # ```
+    # :app .from "file1" do
+    #   <your command here>
+    # end
+    # ```
+    def from(*dependlist)
+        PhonyTarget.new(String(self)).from(*dependlist) { yield }
+    end
+
+    # Usage:
+    # 
+    # ```
+    # :app .then do
+    #   <your command here>
+    # end
+    # ```
+    def then
+        from()
+    end
+end
+
+class String
+    # Usage:
+    # 
+    # ```
+    # "file1" .from "file2" do
+    #   <your command here>
+    # end
+    # ```
+    def from(*dependlist)
+        [self].from(*dependlist) { yield }
+    end
+end
+
+class Array
+    # Usage:
+    # 
+    # ```
+    # ["file1", "file2"] .from "file3", "file4" do
+    #   <your command here>
+    # end
+    # ```
+    def from(*dependlist)
+        tar = FileTarget.new(self)
+        tar.from(*dependlist) { yield }
+    end
+end
+
+
+# Usage:
+# 
+# ```
+# make do
+#   <define target here>
+# end
+# ```
+def make
+    $targetlist = []
+    
+    yield
+
+    raise "at least a target" if $targetlist.length < 1
+    
+    if File.exist?('./.make_script.yaml')
+        $file_time_dict = YAML.load(File.read('./.make_script.yaml'))
+        $cur_file_time_dict = $file_time_dict.clone()
+    end
+    puts Pastel.new.green.bold("ruby_make_script> ") + "start"
+    begin
+        if ARGV.length <= 1
+            $targetlist[0].resolve_all
+        else
+            resolve(ARGV[1], force_exec=true)
+        end
+
+    rescue StandardError => e
+        puts Pastel.new.red.bold("ruby_make_script failed> ") + e.message
+        if e.message != "make command failed"
+            puts e.backtrace
+        end
+    else
+        puts Pastel.new.green.bold("ruby_make_script> ") + "completed"
+    end
+
+    File.open('./.make_script.yaml', 'w') { |f| f.write(YAML.dump($cur_file_time_dict)) }
+
+end

data/lib/ruby_make_script/target.rb

@@ -0,0 +1,106 @@
+$t = []
+$d = []
+
+module Target
+
+    def depend_each
+        depend.each { |f|
+            yield f
+        }
+    end
+
+    def depend_modified?
+        return depend.map{ |f| file_modified?(f) }.reduce(false, :|)
+    end
+
+    def resolve_all
+        raise nil
+    end
+
+    def run
+        raise nil
+    end
+
+    def from(*dependlist)
+        raise nil
+    end
+
+    def add
+        raise nil
+    end
+end
+
+class FileTarget
+    include Target
+    attr_accessor :depend
+
+    def resolve_all
+        @target.each{ |f|
+            resolve(f)
+        }
+    end
+    def run
+        if ! @completed
+            @update_proc.call
+            @completed = true
+            @target.each{ |f|
+                file_modified!(f)
+            }
+        end
+    end
+    def initialize(targetlist)
+       @target = targetlist
+       @depend = []
+       @completed = false
+    end
+    def from(*dependlist)
+        @depend = dependlist
+        @update_proc = Proc.new { 
+            $t = @target
+            $d = @depend
+            yield
+        }
+        add()
+    end
+    def add
+        $targetlist += [self]
+        @target.each { |t|
+            $file_target_dict[t] = self
+        }
+    end
+end
+
+class PhonyTarget
+    include Target
+    attr_accessor :depend
+    def resolve_all
+        resolve(@target)
+    end
+
+    def run
+        if ! @completed
+            @update_proc.call
+            @completed = true
+            file_modified!(@target)
+        end
+    end
+    def initialize(str)
+        @target = str
+        @depend = []
+        @completed = false
+    end
+
+    def from(*dependlist)
+        @depend = dependlist
+        @update_proc = Proc.new { 
+            $t = @target
+            $d = @depend
+            yield
+        }
+        add()
+    end
+    def add
+        $targetlist += [self]
+        $file_target_dict[@target] = self
+    end
+end

data/lib/ruby_make_script/utils.rb

@@ -0,0 +1,80 @@
+
+
+# since ~ "cd <path>" invalid, add a function here
+def cd(str)
+    if block_given?
+        orig = Dir.pwd
+        Dir.chdir(str)
+        yield
+        Dir.chdir(orig)
+    else
+        Dir.chdir(str)
+    end
+end
+
+# these were like cd function
+def rm(*str)
+    r"rm #{str.join(' ')}"
+end
+
+# these were like cd function
+def mkdir(*str)
+    r"mkdir #{str.join(' ')}"
+end
+
+def r(*str)
+    str =  str.join(" ")
+    puts Pastel.new.green("running> ") + str
+    if !system(str) 
+        puts Pastel.new.red.bold("error> ") + "command error: " + str
+        raise "make command failed"
+    end
+end
+
+# since ~ "cd <path>" invalid, add a function here
+def cd?(str)
+    begin
+        if block_given?
+            orig = Dir.pwd
+            Dir.chdir(str)
+            yield
+            Dir.chdir(orig)
+        else
+            Dir.chdir(str)
+        end
+    rescue => exception
+        puts Pastel.new.yellow("warning> ") + "command error: cd " + str + " (suppressed)"
+        return false
+    end
+    return true
+end
+
+# these were like cd function
+def rm?(*str)
+    r?"rm #{str.join(' ')}"
+end
+
+# these were like cd function
+def mkdir?(*str)
+    r?"mkdir #{str.join(' ')}"
+end
+
+# no error
+def r?(*str)
+    str =  str.join(" ")
+    puts Pastel.new.green("running> ") + str
+    flag = system(str) 
+    if !flag
+        puts Pastel.new.yellow("warning> ") + "command error: " + str + " (suppressed)"
+    end
+    flag
+end
+
+def runfile(file, *args)
+    path = File.expand_path(file)
+    r path, *args
+end
+def runfile?(file, *args)
+    path = File.expand_path(file)
+    r? path, *args
+end

data/lib/ruby_make_script/version.rb

@@ -0,0 +1,3 @@
+module RubyMakeScript
+  VERSION = "0.1.0"
+end

data/ruby_make_script.gemspec

@@ -0,0 +1,43 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ruby_make_script/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruby_make_script"
+  spec.version       = RubyMakeScript::VERSION
+  spec.authors       = ["dnailz"]
+  spec.email         = ["dnailzb@outlook.com"]
+
+  spec.summary       = %q{make script}
+  spec.description   = %q{A ruby make DSL for ruby like GNU make. (very simple)}
+  spec.homepage      = "https://github.com/DnailZ/ruby_make_script"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/DnailZ/ruby_make_script"
+    spec.metadata["changelog_uri"] = "https://github.com/DnailZ/ruby_make_script"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  p spec.files
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: ruby_make_script
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- dnailz
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: A ruby make DSL for ruby like GNU make. (very simple)
+email:
+- dnailzb@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ruby_make_script.rb
+- lib/ruby_make_script/target.rb
+- lib/ruby_make_script/utils.rb
+- lib/ruby_make_script/version.rb
+- ruby_make_script.gemspec
+homepage: https://github.com/DnailZ/ruby_make_script
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/DnailZ/ruby_make_script
+  source_code_uri: https://github.com/DnailZ/ruby_make_script
+  changelog_uri: https://github.com/DnailZ/ruby_make_script
+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.0.3
+signing_key: 
+specification_version: 4
+summary: make script
+test_files: []