rcee_packaged_tarball 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77ace21c823e931cb6e7d7feeed01351e8f8c67240c362868d948bb2933afff6
-  data.tar.gz: 16ca21fe014c181139dd5a0af35ee0720544c6e50c44238985ccd9e782ef2473
+  metadata.gz: 58b32d8f933c8d02d0e2aa6d39b9a5b5e64458d8546b2a9b069f46f1c1055370
+  data.tar.gz: cf54f67265b8b057a376514dda97df9908c19e2d22747e3c861a393bd69c223f
 SHA512:
-  metadata.gz: 817725162179cd2ec67413d5eebae0bc5281113fce750d5bf0c1a635f71a87d79d3d9fec9c26f735f90a4febd2b2bd03621b906f65c51439279c842db29d5257
-  data.tar.gz: 9a778aba66c002986cea504b81621f1ba727be16f8a4ee8b729f72fc1018403479b2a44162a1e014b46c0af38f9f0d04ed053249333eba0528f8e8c19ce68ce4
+  metadata.gz: d5db9bc2768d02496f6bd42fba01e82e0d8f311eb2c63333e61751fe9b4848b05afee9f693d93fe802f25e1dfac0f54275ad5ee05e3d1f5c6288f57eb6c17e03
+  data.tar.gz: f1c868c5ebd9f6713f3eac704a07fd02d49d80721f49e049a9ff5ebeaede19524b2da3799106f21fd666ee49d739f64d45dacc5c48c34031c6913ef0d2f6185d

data/README.md

@@ -21,38 +21,60 @@ Gem::Specification.new do |spec|
 end
 ```
 
-The `extconf.rb` contains a new block:
+The `extconf.rb` is about to get more complicated. To help manage the complexity, we'll use a module with a `.configure` method:
 
 ``` ruby
-MiniPortile.new("yaml", "0.2.5").tap do |recipe|
-  recipe.target = File.join(package_root_dir, "ports")
-  recipe.files = [{
-    url: "https://github.com/yaml/libyaml/releases/download/0.2.5/yaml-0.2.5.tar.gz",
-    sha256: "c642ae9b75fee120b2d96c712538bd2cf283228d2337df2cf2988e3c02678ef4",
-  }]
+module RCEE
+  module PackagedTarball
+    module ExtConf
+      class << self
+        def configure
+          configure_packaged_libraries
+          create_makefile("rcee/packaged_tarball/packaged_tarball")
+        end
+      end
+    end
+  end
+end
+
+RCEE::PackagedTarball::ExtConf.configure
+```
+
+The `ExtConf` contains a method `configure_packaged_libraries` which uses `mini_portile` to download the library (if necessary); verify the checksum; extract the files; configure, compile, and link it; and finally configure `MakeMakefile` to find the headers and the library:
+
+``` ruby
+def configure_packaged_libraries
+  recipe = libyaml_recipe
 
+  # ensure libyaml has already been unpacked, configured, and compiled
   unless File.exist?(File.join(recipe.target, recipe.host, recipe.name, recipe.version))
     recipe.cook
   end
 
+  # use the packaged libyaml
   recipe.activate
   pkg_config(File.join(recipe.path, "lib", "pkgconfig", "yaml-0.1.pc"))
-end
-```
 
-This block:
+  # assert that we can build against the packaged libyaml
+  unless have_library("yaml", "yaml_get_version", "yaml.h")
+    abort("\nERROR: *** could not find libyaml development environment ***\n\n")
+  end
+end
 
-- downloads the libyaml tarball if necessary (note that the packaged gem includes the tarball and so this is skipped by end users during `gem install`)
-- verifies the checksum of the tarball
-- extracts the tarball
-- configures the build system (for libyaml, this is "autoconf")
-- compile libyaml's source code into object files
-- link the object files together into a library we can use
-- configure `MakeMakefile` to find the headers and the library
+def libyaml_recipe
+  MiniPortile.new("yaml", "0.2.5").tap do |recipe|
+    recipe.files = [{
+      url: "https://github.com/yaml/libyaml/releases/download/0.2.5/yaml-0.2.5.tar.gz",
+      sha256: "c642ae9b75fee120b2d96c712538bd2cf283228d2337df2cf2988e3c02678ef4"
+    }]
+    recipe.target = File.join(PACKAGE_ROOT_DIR, "ports")
+  end
+end
+```
 
-(Of special note, we're able to use `pkgconfig` to do much of our extension configuration, which allows us to have a pretty clean configuration. This is one advantage to using upstream distributions.)
+Of special note, we're able to use `pkgconfig` to do much of our extension configuration, which allows us to have a pretty clean configuration. This is one advantage to using upstream distributions.
 
-Note that all of those steps happen *before* the Makefile is created -- it's run by `extconf.rb` so that the Makefile will know where to find our libyaml files.
+Note that all of those steps happen *before* the Makefile is created, so that the Makefile will contain the appropriate paths and flags to build our extension against libyaml.
 
 
 ## Testing

data/ext/packaged_tarball/extconf.rb

@@ -1,24 +1,58 @@
 require "mkmf"
 require "mini_portile2"
 
-package_root_dir = File.expand_path(File.join(File.dirname(__FILE__), "..", ".."))
+module RCEE
+  module PackagedTarball
+    module ExtConf
+      PACKAGE_ROOT_DIR = File.expand_path(File.join(File.dirname(__FILE__), "..", ".."))
 
-MiniPortile.new("yaml", "0.2.5").tap do |recipe|
-  recipe.files = [{
-    url: "https://github.com/yaml/libyaml/releases/download/0.2.5/yaml-0.2.5.tar.gz",
-    sha256: "c642ae9b75fee120b2d96c712538bd2cf283228d2337df2cf2988e3c02678ef4",
-  }]
+      class << self
+        def configure
+          configure_packaged_libraries
 
-  recipe.target = File.join(package_root_dir, "ports")
-  unless File.exist?(File.join(recipe.target, recipe.host, recipe.name, recipe.version))
-    recipe.cook
+          create_makefile("rcee/packaged_tarball/packaged_tarball")
+        end
+
+        def configure_packaged_libraries
+          recipe = libyaml_recipe
+
+          # ensure libyaml has already been unpacked, configured, and compiled
+          unless File.exist?(File.join(recipe.target, recipe.host, recipe.name, recipe.version))
+            recipe.cook
+          end
+
+          # use the packaged libyaml
+          recipe.activate
+          pkg_config(File.join(recipe.path, "lib", "pkgconfig", "yaml-0.1.pc"))
+
+          # assert that we can build against the packaged libyaml
+          unless have_library("yaml", "yaml_get_version", "yaml.h")
+            abort("\nERROR: *** could not find libyaml development environment ***\n\n")
+          end
+        end
+
+        def download
+          libyaml_recipe.download
+        end
+
+        def libyaml_recipe
+          MiniPortile.new("yaml", "0.2.5").tap do |recipe|
+            recipe.files = [{
+              url: "https://github.com/yaml/libyaml/releases/download/0.2.5/yaml-0.2.5.tar.gz",
+              sha256: "c642ae9b75fee120b2d96c712538bd2cf283228d2337df2cf2988e3c02678ef4"
+            }]
+            recipe.target = File.join(PACKAGE_ROOT_DIR, "ports")
+          end
+        end
+      end
+    end
   end
-  recipe.activate
-  pkg_config(File.join(recipe.path, "lib", "pkgconfig", "yaml-0.1.pc"))
 end
 
-unless have_library("yaml", "yaml_get_version", "yaml.h")
-  abort("\nERROR: *** could not find libyaml development environment ***\n\n")
+# run "ruby ./ext/packaged_tarball/extconf.rb -- --download-dependencies" to download the tarball
+if arg_config("--download-dependencies")
+  RCEE::PackagedTarball::ExtConf.download
+  exit!(0)
 end
 
-create_makefile("rcee/packaged_tarball/packaged_tarball")
+RCEE::PackagedTarball::ExtConf.configure

data/lib/rcee/packaged_tarball/version.rb

@@ -2,6 +2,6 @@
 
 module RCEE
   module PackagedTarball
-    VERSION = "0.4.0"
+    VERSION = "0.5.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rcee_packaged_tarball
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Mike Dalessio
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-05-19 00:00:00.000000000 Z
+date: 2024-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mini_portile2
@@ -62,7 +62,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.5
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: Example gem demonstrating a basic C extension.