Enhanced ruby_gem with many more options; updated README

Author: kigster

README.md

@@ -7,6 +7,9 @@ package(default_visibility = ["//:__subpackages__"])
 
 ruby_gem(
     name = "example_gem",
+    srcs = [
+        "//lib:example_gem",
+    ],
     gem_author_emails = [
         "[email protected]",
         "[email protected]",
@@ -15,10 +18,6 @@ ruby_gem(
         "Coinbase",
         "BazelRuby",
     ],
-    gem_dependencies = {
-        "colored2": "",
-        "hashie": "",
-    },
     gem_description = "Example gem to demonstrate Bazel Gem packaging",
     gem_development_dependencies = {
         "rspec": "",
@@ -27,9 +26,10 @@ ruby_gem(
     },
     gem_homepage = "https://github.com/bazelruby/rules_ruby",
     gem_name = "example-gem",
+    gem_runtime_dependencies = {
+        "colored2": "",
+        "hashie": "",
+    },
     gem_summary = "Example gem to demonstrate Bazel Gem packaging",
     gem_version = "0.1.0",
-    deps = [
-        "//lib:example_gem",
-    ],
 )

examples/example_gem/BUILD.bazel

@@ -9,7 +9,6 @@ load(
     "SCRIPT_INSTALL_GEM",
 )
 load("//ruby/private:providers.bzl", "RubyRuntimeContext")
-load("//ruby/private/tools:deprecations.bzl", "deprecated_attribute")
 
 # Runs bundler with arbitrary arguments
 # eg: run_bundler(runtime_ctx, [ "lock", " --gemfile", "Gemfile.rails5" ])
@@ -159,12 +158,7 @@ def _ruby_bundle_impl(ctx):
     ctx.symlink(ctx.attr._create_bundle_build_file, SCRIPT_BUILD_FILE_GENERATOR)
     ctx.symlink(ctx.attr._install_bundler, SCRIPT_INSTALL_GEM)
 
-    # version is too generic for this operation
-    deprecated_attribute(ctx, "version", "bundler_version")
-    if ctx.attr.bundler_version:
-        bundler_version = ctx.attr.bundler_version
-    else:
-        bundler_version = ctx.attr.version
+    bundler_version = ctx.attr.bundler_version
 
     # Setup this provider that we pass around between functions for convenience
     runtime_ctx = RubyRuntimeContext(

ruby/private/bundle/def.bzl

@@ -78,15 +78,9 @@ BUNDLE_ATTRS = {
     "gemfile_lock": attr.label(
         allow_single_file = True,
     ),
-    "version": attr.string(
-        mandatory = False,
-    ),
     "bundler_version": attr.string(
         default = DEFAULT_BUNDLER_VERSION,
     ),
-    "gemspec": attr.label(
-        allow_single_file = True,
-    ),
     "excludes": attr.string_list_dict(
         doc = "List of glob patterns per gem to be excluded from the library",
     ),
@@ -115,7 +109,7 @@ GEMSPEC_ATTRS = {
     "gem_homepage": attr.string(),
     "gem_authors": attr.string_list(),
     "gem_author_emails": attr.string_list(),
-    "gem_dependencies": attr.string_dict(
+    "gem_runtime_dependencies": attr.string_dict(
         allow_empty = True,
         doc = "Key value pairs of gem dependencies (name, version) where version can be None",
     ),
@@ -132,7 +126,9 @@ GEMSPEC_ATTRS = {
         allow_files = True,
         default = [],
     ),
-    "require_paths": attr.string_list(),
+    "require_paths": attr.string_list(
+        default = ["lib"],
+    ),
     "deps": attr.label_list(
         allow_files = True,
     ),

ruby/private/constants.bzl

@@ -33,7 +33,7 @@ def _unique_elems(list):
 # Converts gem name and optionally a version into a
 # gemspec line "spec.add_[development_]dependency 'gem-name', [ 'gem-version' ]"
 def _gem_dependency(name, version = "", development = False):
-    dependency_type = "spec.add_development_dependency" if development else "spec.add_dependency"
+    dependency_type = "spec.add_development_dependency" if development else "spec.add_runtime_dependency"
 
     output = "%s '%s'" % (dependency_type, name)
     if version != "":
@@ -54,13 +54,13 @@ def _markdown_ul(list = []):
 
 # Converts a dictionary (key = gem name, value = gem version or None)
 # to a string to be inserted into the gemspec.
-def _gem_dependencies(gem_dict = {}):
+def _gem_runtime_dependencies(gem_dict = {}):
     dependencies = [_gem_dependency(k, v) for k, v in gem_dict.items()]
     return ("\n  " + "\n  ".join(dependencies))
 
 # Converts a dictionary (key = gem name, value = gem version or None)
 # to a string to be inserted into the gemspec.
-def _markdown_gem_dependencies(gem_dict = {}, type = "Runtime"):
+def _markdown_gem_runtime_dependencies(gem_dict = {}, type = "Runtime"):
     dependencies = [_markdown_gem_dependency(k, v) for k, v in gem_dict.items()]
     output = "\n### %s Dependencies\n\n" % type
     output += "\n  " + "\n  ".join(dependencies) + "\n\n"
@@ -93,9 +93,9 @@ def _gem_impl(ctx):
         substitutions = {
             "{gem_author_emails}": repr(ctx.attr.gem_author_emails),
             "{gem_authors}": repr(ctx.attr.gem_authors),
-            "{gem_dependencies}": _gem_dependencies(ctx.attr.gem_dependencies),
+            "{gem_runtime_dependencies}": _gem_runtime_dependencies(ctx.attr.gem_runtime_dependencies),
             "{gem_description}": ctx.attr.gem_description if ctx.attr.gem_description else ctx.attr.gem_summary,
-            "{gem_development_dependencies}": _gem_dependencies(ctx.attr.gem_development_dependencies),
+            "{gem_development_dependencies}": _gem_runtime_dependencies(ctx.attr.gem_development_dependencies),
             "{gem_homepage}": ctx.attr.gem_homepage,
             "{gem_name}": ctx.attr.gem_name,
             "{gem_require_paths}": repr(["lib"]),
@@ -105,19 +105,19 @@ def _gem_impl(ctx):
         },
     )
 
-    _dependencies = _markdown_gem_dependencies(ctx.attr.gem_dependencies, "Runtime")
-    _dependencies += _markdown_gem_dependencies(ctx.attr.gem_development_dependencies, "Development")
+    _dependencies = _markdown_gem_runtime_dependencies(ctx.attr.gem_runtime_dependencies, "Runtime")
+    _dependencies += _markdown_gem_runtime_dependencies(ctx.attr.gem_development_dependencies, "Development")
 
     ctx.actions.expand_template(
         template = ctx.file._readme_template,
         output = gem_readme,
         substitutions = {
             "{gem_authorship}": _markdown_ul(ctx.attr.gem_authors),
-            "{gem_dependencies}": _dependencies,
+            "{gem_runtime_dependencies}": _dependencies,
             "{gem_description}": ctx.attr.gem_description if ctx.attr.gem_description else ctx.attr.gem_summary,
             "{gem_name}": ctx.attr.gem_name,
-            "{gem_title}": _gem_title,
             "{gem_summary}": ctx.attr.gem_summary,
+            "{gem_title}": _gem_title,
             "{gem_version}": ctx.attr.gem_version,
         },
     )
@@ -130,7 +130,7 @@ def _gem_impl(ctx):
             ctx = ctx,
             gem_author_emails = ctx.attr.gem_author_emails,
             gem_authors = ctx.attr.gem_authors,
-            gem_dependencies = ctx.attr.gem_dependencies,
+            gem_runtime_dependencies = ctx.attr.gem_runtime_dependencies,
             gem_description = ctx.attr.gem_description,
             gem_development_dependencies = ctx.attr.gem_development_dependencies,
             gem_homepage = ctx.attr.gem_homepage,
@@ -146,14 +146,20 @@ gemspec = rule(
     provides = [DefaultInfo, RubyGem],
 )
 
-def gem(name, gem_name, gem_version, srcs = [], **kwargs):
+def gem(
+        name,
+        gem_name,
+        gem_version,
+        srcs,
+        **kwargs):
     _zip_name = "%s-%s" % (gem_name, gem_version)
-    _gemspec_name = name + "_gemspec"
+    _gemspec_name = name + ".gemspec"
 
     gemspec(
         name = _gemspec_name,
         gem_name = gem_name,
         gem_version = gem_version,
+        srcs = srcs,
         **kwargs
     )
 

ruby/private/gemspec/def.bzl

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.3'
 
-  {gem_dependencies}
+  {gem_runtime_dependencies}
 
   {gem_development_dependencies}
 end

ruby/private/gemspec/gemspec_template.tpl

@@ -1,4 +1,6 @@
-# {gem_title} (Version: {gem_version})
+# {gem_title}
+
+## Version {gem_version}
 
 > NOTE: You are reading the auto-generated README for Gem {gem_name}.
 
@@ -12,7 +14,7 @@
 
 ## Dependencies
 
-{gem_dependencies}
+{gem_runtime_dependencies}
 
 ## Author(s)
 

ruby/private/gemspec/readme_template.tpl

@@ -21,7 +21,7 @@ RubyGem = provider(
         "ctx",
         "gem_author_emails",
         "gem_authors",
-        "gem_dependencies",
+        "gem_runtime_dependencies",
         "gem_description",
         "gem_development_dependencies",
         "gem_homepage",