kar 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd14a44367840ddf1ed8e199a4682bd4cfad4f734d06d3220d7aee30e92ea64c
-  data.tar.gz: fdd7c35b0aded9a6c25de853e6274cf4cd4a524c4f6113ceee710182d6188ee7
+  metadata.gz: 4e88a860068093597ff4434adfe3ff6f5f7f3db2576b66708e0e57d0dc0bb96d
+  data.tar.gz: 1949ce09fc44920dbe98c61f2214ee7d81323f60e6a7f22b082068ecaf25b52e
 SHA512:
-  metadata.gz: 21cbecd6b7218e5d17d081db576e90015688d5957d796b65899138ee6e12a42a1d7a44447e70d16b65992fe2b7b0129eebe6a6a34c8d455a5c596aa1c15bea78
-  data.tar.gz: 40c5df4efcce865bb3f03fb9483a0b33313acbf6f6462bb33b89b2481dfae8497d7c664251f51b8b0d43ce84e4cc4e0ee3df28d00ecd85c79e9a20f25a43a9de
+  metadata.gz: 892276c83f0431711faaf1569154b9ec04e06b7689e34eca638dd55c3d69da91dda5720f9af844f8794755c01e0f3b1dacee5064e00e182a00a8a2e0533607fc
+  data.tar.gz: a135684469b46c1b14896faa8f3abdff6a364edde5ec006864bb8bd9bbffac62bacaae26acc8d4cf79e913a91cb09fbd3ef6ae373d237920c005cf2afffe1bf9

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Unreleased]
 
+## [0.1.3] - 2025-10-26
+
+- Make cargo task to be dependent on Rust source files
+- cargo:validate -> cargo:check
+
+## [0.1.2] - 2025-10-26
+
+- CargoTask, build extension in Rust
+
 ## [0.1.1] - 2025-10-24
 
 - URITask, handle redirection

data/README.md

@@ -19,22 +19,47 @@ Usage
 
     # Rakefile
     require "kar/dsl"
+
+### Download task ###
+
+It downloads a file and declares file task.
     
     download "local/path/to/file" => "https://example.net/remote/path/to/file"
+
+### Multiple files task ###
+
+It declares multiple file tasks at a time.
+
+    # Rakefile
     FILES = FileList["fileA", "fileB", "fileC"]
     files FILES
 
+### Cargo task ###
+
+It declares a cargo task which builds extensions in Rust.
+
+    # Rakefile
+    cargo "my_gem"
+
+Run the task:
+
+    % rake cargo
+
+And cargo:check task which checks Rust source files and is useful for dependency of build task.
+
+    # Rakefile
+    task build: "cargo:check"
+
+Run the task:
+
+    % rake build # invokes cargo:checks
+
 Development
 -----------
 
-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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `rake install`. To release a new version, update the version number in `kar.gemspec`, and then run `rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 Contributing
 ------------
 
-Bug reports and pull requests are welcome on GitHub at https://gitlab.com/KitaitiMakoto/kar. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://gitlab.com/KitaitiMakoto/kar/blob/main/CODE_OF_CONDUCT.md).
-
-Code of Conduct
----------------
-
-Everyone interacting in the Kar project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://gitlab.com/KitaitiMakoto/kar/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://gitlab.com/KitaitiMakoto/kar. This project is intended to be a safe, welcoming space for collaboration.

data/kar.gemspec

@@ -1,10 +1,6 @@
-# frozen_string_literal: true
-
-require_relative "lib/kar/version"
-
 Gem::Specification.new do |spec|
   spec.name = "kar"
-  spec.version = Kar::VERSION
+  spec.version = "0.1.3"
   spec.authors = ["Kitaiti Makoto"]
   spec.email = ["KitaitiMakoto@gmail.com"]
 

data/lib/kar/cargotask.rb

@@ -0,0 +1,110 @@
+require "rake/clean"
+require "rubygems/ext"
+require "json"
+require "shellwords"
+require "stringio"
+
+module Kar
+  class CargoTask < Rake::TaskLib
+    def initialize(target)
+      @target = target
+
+      define
+    end
+
+    private
+
+    def verbose?
+      Rake.verbose == true
+    end
+
+    def define
+      file dl_path => [manifest, lock_file] + src do |t|
+        results = Results.new
+        begin
+          Gem::Ext::CargoBuilder.new.build t.source, ".", results, [], lib_dir, File.expand_path(ext_dir)
+        rescue => error
+          $stderr.puts results unless verbose?
+          fail
+        end
+      end
+      CLEAN.include dl_name, dl_path
+
+      namespace :cargo do
+        task @target => dl_path
+
+        # TODO: Consider the case `target` is "check"
+        namespace :check do
+          task @target => manifest do |t|
+            sh "cargo", "check", "--manifest-path", manifest.shellescape, "--locked", "--quiet"
+          end
+        end
+
+        desc "Check Rust sources and manifests"
+        task check: "cargo:check:#{@target}"
+      end
+
+      desc "Build all extensions in Rust"
+      task cargo: "cargo:#{@target}"
+    end
+
+    def gemspec
+      @gemspec ||= Gem::Specification.load("#{@target}.gemspec")
+    end
+
+    def manifest
+      @manifest ||= gemspec.extensions.first
+    end
+
+    def lock_file
+      @lock_file ||= manifest.ext(".lock")
+    end
+
+    def ext_dir
+      @ext_dir ||= File.dirname(manifest)
+    end
+
+    def lib_dir
+      # When a gem include an extension, the first element of require_paths is the directory for extensions and the second is for Ruby files.
+      @lib_dir ||= gemspec.require_paths[1]
+    end
+
+    def dl_name
+      @dl_name ||= "#{gemspec.name}.#{RbConfig::CONFIG["DLEXT"]}"
+    end
+
+    def dl_path
+      @dl_path ||= File.join(lib_dir, dl_name)
+    end
+
+    def src
+      @src ||= FileList["#{ext_dir}/src/**/*.rs"]
+    end
+
+    class Results
+      def initialize
+        @io = verbose? ? $stdout : StringIO.new
+      end
+
+      def <<(output)
+        # Always break a line even when output isn't terminated by a line break
+        @io.puts output
+      end
+
+      def to_s
+        if verbose?
+          ""
+        else
+          @io.rewind
+          @io.read
+        end
+      end
+
+      private
+
+      def verbose?
+        Rake.verbose == true
+      end
+    end
+  end
+end

data/lib/kar/dsl.rb

@@ -1,4 +1,5 @@
 require "kar/uritask"
+require "kar/cargotask"
 
 module Kar
   # DSLs you can use in your Rakefiles
@@ -18,6 +19,9 @@ module Kar
   #
   #   # Downloads file from https://example.com/remote/file and save to local/file
   #   download "local/file" => "https://example.org/remote/file"
+  #
+  #   # Build extension in Rust
+  #   cargo "my_gem"
   module DSL
     def files(file_list)
       file_list.each do |file_name|
@@ -46,6 +50,27 @@ module Kar
       URITask.new args
     end
 
+    # Declare a cargo task which builds extension in Rust by Cargo.
+    #
+    # @example
+    #   # Rakefile
+    #   cargo "my_gem"
+    #
+    #   task build: "cargo:check"
+    #
+    #   # shell
+    #   % rake cargo
+    #
+    # Also defines a cargo:check task which check sources and manifests.
+    # It's useful to add them to the dependency of build task and prevent building invalid gem package.
+    #
+    # Uses {https://docs.ruby-lang.org/en/master/Gem/Ext/CargoBuilder.html Gem::Ext::CargoBuilder} internally unlike {https://oxidize-rb.org/docs/api-reference/rb-sys-gem-config#rbsysextensiontask RbSys::ExtensionTask}
+    # in order to build in the same way as `gem install` command, even though the output might be less usefull.
+    # When `RbSys::Extension` uses the same way, this function may be deprecated.
+    def cargo(target)
+      CargoTask.new target
+    end
+
     Rake::DSL.prepend self
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kar
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Kitaiti Makoto
@@ -80,9 +80,9 @@ files:
 - agpl-3.0.txt
 - kar.gemspec
 - lib/kar.rb
+- lib/kar/cargotask.rb
 - lib/kar/dsl.rb
 - lib/kar/uritask.rb
-- lib/kar/version.rb
 - sig/kar.rbs
 homepage: https://gitlab.com/KitaitiMakoto/kar
 licenses:

data/lib/kar/version.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-module Kar
-  VERSION = "0.1.1"
-end