Merge pull request #60 from kigster/kig/download-gem-refactor

Adds ruby_rspec and refactors the ruby_bundle rule, plus some more

Author: kigster

.circleci/config.yml

@@ -61,24 +61,9 @@ jobs:
             /usr/bin/env bash bin/setup
 
       - run:
-          name: "Show Bazel Info"
+          name: "Bazel Build & Test Example"
           command: |
-            /usr/bin/env bash bin/test-suite bazel-info
-
-      - run:
-          name: "Bazel Simple Script Example Build"
-          command: |
-            cd examples/simple_script && bazel ${BAZEL_OPTS} build ${BAZEL_BUILD_OPTS} -- //...
-
-      - run:
-          name: "Bazel Simple Script Example Test"
-          command: |
-            cd examples/simple_script && bazel ${BAZEL_OPTS} test ${BAZEL_BUILD_OPTS} ${BAZEL_TEST_OPTS} -- //...
-
-      - run:
-          name: "Bazel Simple Script Example Rubocop Check"
-          command: |
-            cd examples/simple_script && bazel ${BAZEL_OPTS} run ${BAZEL_BUILD_OPTS} -- :rubocop
+            /usr/bin/env bash bin/test-suite simple-script
 
   buildifier:
     <<: *bazel_defaults

.rubocop.yml

@@ -1,12 +1,36 @@
 inherit_from: .relaxed-rubocop-2.4.yml
 
 AllCops:
-  TargetRubyVersion: 2.6.5
+  TargetRubyVersion: 2.6
+  UseCache: true
+  DefaultFormatter: progress
+  DisplayStyleGuide: true
+  DisplayCopNames: true
   Exclude:
-    - "**/rubocop"
-    - "examples/**/*"
+    - "external*/**/*"
     - "bazel-*/**/*"
-    - "**/external/**/*"
+    - "**/examples/**/*"
+    - "**/BUILD"
+    - "**/*.bazel"
+    - "**/*.bzl"
+    - "**/rubocop"
     - "**/vendor/bundle/**/*"
+  Include:
+    - '**/*.rb'
+    - '**/*.gemfile'
+    - '**/*.gemspec'
+    - '**/*.rake'
+    - '**/*.ru'
+    - '**/Gemfile'
+    - '**/Rakefile'
 
+Layout/HashAlignment:
+  Enabled: true
+  EnforcedColonStyle: table
+  
+Style/Dir:
+  Enabled: false
 
+Layout/MultilineMethodCallIndentation:
+  Enabled: true
+  EnforcedStyle: indented_relative_to_receiver

README.md

@@ -1,12 +1,13 @@
 <!-- TOC depthFrom:1 depthTo:6 withLinks:1 updateOnSave:1 orderedList:0 -->
 
-* [Status:](#status)
 * [Usage](#usage)
+  * [WORKSPACE File](#workspace-file)
+  * [BUILD.bazel files](#buildbazel-files)
 * [Rules](#rules)
   * [ruby_library](#ruby_library)
   * [ruby_binary](#ruby_binary)
   * [ruby_test](#ruby_test)
-  * [bundle_install](#bundle_install)
+  * [ruby_bundle](#ruby_bundle)
 * [What's coming next](#whats-coming-next)
 * [Contributing](#contributing)
   * [Setup](#setup)
@@ -35,14 +36,14 @@
 
 Ruby rules for [Bazel](https://bazel.build).
 
-## Status:
+** Current Status:** *Work in progress.*
 
-**Work in progress.**
-
-We have a guide on [Building your first Ruby Project](https://github.com/bazelruby/rules_ruby/wiki/Build-your-ruby-project) on the Wiki. We encourage you to check it out.
+Note: we have a short guide on [Building your first Ruby Project](https://github.com/bazelruby/rules_ruby/wiki/Build-your-ruby-project) on the Wiki. We encourage you to check it out.
 
 ## Usage
 
+### `WORKSPACE` File
+
 Add `ruby_rules_dependencies` and `ruby_register_toolchains` into your `WORKSPACE` file.
 
 ```python
@@ -65,6 +66,33 @@ ruby_rules_dependencies()
 ruby_register_toolchains()
 ```
 
+Next, add any external Gem dependencies you may have via `ruby_bundle` command.
+The name of the bundle becomes a reference to this particular Gemfile.lock.
+
+Install external gems that can be later referenced as `@<bundle-name>//:<gem-name>`,
+and the executables from each gem can be accessed as `@<bundle-name//:bin/<gem-binary-name>`
+for instance, `@bundle//:bin/rubocop`.
+
+You can install more than one bundle per WORKSPACE, but that's not recommended.
+
+```python
+ruby_bundle(
+  name = "bundle",
+  gemfile = ":Gemfile",
+  gemfile_lock = ":Gemfile.lock",
+  bundler_version = "2.1.2",
+)
+
+ruby_bundle(
+  name = "bundle_app_shopping",
+  gemfile = "//apps/shopping:Gemfile",
+  gemfile_lock = "//apps/shopping:Gemfile.lock",
+  bundler_version = "2.1.2",
+)
+```
+
+### `BUILD.bazel` files
+
 Add `ruby_library`, `ruby_binary` or `ruby_test` into your `BUILD.bazel` files.
 
 ```python
@@ -73,12 +101,18 @@ load(
     "ruby_binary",
     "ruby_library",
     "ruby_test",
+    "ruby_rspec",
 )
 
 ruby_library(
     name = "foo",
-    srcs = ["lib/foo.rb"],
+    srcs = glob(["lib/**/*.rb"]),
     includes = ["lib"],
+    deps = [
+      "@bundle//:activesupport",
+      "@bundle//:awesome_print",
+      "@bundle//:rubocop",
+    ]
 )
 
 ruby_binary(
@@ -88,10 +122,18 @@ ruby_binary(
 )
 
 ruby_test(
-    name = "foo_test",
+    name = "foo-test",
     srcs = ["test/foo_test.rb"],
     deps = [":foo"],
 )
+
+ruby_rspec(
+    name = "foo-spec",
+    specs = glob(["spec/**/*.rb"]),
+    rspec_args = { "--format": "progress" },
+    deps = [":foo"]
+}
+
 ```
 
 ## Rules
@@ -338,7 +380,7 @@ ruby_test(name, deps, srcs, data, main, compatible_with, deprecation, distribs,
   </tbody>
 </table>
 
-### `bundle_install`
+### `ruby_bundle`
 
 Installs gems with Bundler, and make them available as a `ruby_library`.
 
@@ -361,9 +403,9 @@ ruby_rules_dependencies()
 
 ruby_register_toolchains()
 
-load("@bazelruby_ruby_rules//ruby:defs.bzl", "bundle_install")
+load("@bazelruby_ruby_rules//ruby:defs.bzl", "ruby_bundle")
 
-bundle_install(
+ruby_bundle(
     name = "gems",
     gemfile = "//:Gemfile",
     gemfile_lock = "//:Gemfile.lock",
@@ -376,12 +418,24 @@ Example: `lib/BUILD.bazel`:
 ruby_library(
     name = "foo",
     srcs = ["foo.rb"],
-    deps = ["@gems//:libs"],
+    deps = ["@gems//:all"],
+)
+```
+
+Or declare many gems in your `Gemfile`, and only use some of them in each ruby library:
+
+```python
+ruby_binary(
+    name = "rubocop",
+    srcs = [":foo", ".rubocop.yml"],
+    args = ["-P", "-D", "-c" ".rubocop.yml"],
+    main = "@gems//:bin/rubocop",
+    deps = ["@gems//:rubocop"],
 )
 ```
 
 <pre>
-bundle_install(name, gemfile, gemfile_lock)
+ruby_bundle(name, gemfile, gemfile_lock, bundler_version = "2.1.2")
 </pre>
 <table class="table table-condensed table-bordered table-params">
   <colgroup>
@@ -418,6 +472,14 @@ bundle_install(name, gemfile, gemfile_lock)
           <p>NOTE: This rule never updates the <code>Gemfile.lock</code>. It is your responsibility to generate/update <code>Gemfile.lock</code></p>
       </td>
     </tr>
+    <tr>
+      <td><code>bundler_version</code></td>
+      <td>
+        <code>String, optional</code>
+          <p>The Version of Bundler to use. Defaults to 2.1.2.</p>
+          <p>NOTE: This rule never updates the <code>Gemfile.lock</code>. It is your responsibility to generate/update <code>Gemfile.lock</code></p>
+      </td>
+    </tr>
   </tbody>
 </table>
 

WORKSPACE

@@ -1,11 +1,9 @@
 workspace(name = "bazelruby_ruby_rules")
 
-load("@//ruby:deps.bzl", "ruby_register_toolchains", "ruby_rules_dependencies")
+load("@//ruby:deps.bzl", "ruby_rules_dependencies")
 
 ruby_rules_dependencies()
 
-ruby_register_toolchains()
-
 load("@bazel_skylib//:workspace.bzl", "bazel_skylib_workspace")
 
 bazel_skylib_workspace()
@@ -14,6 +12,10 @@ load("@bazel_skylib//lib:versions.bzl", "versions")
 
 versions.check("1.2.1")
 
+load("@//ruby:deps.bzl", "ruby_register_toolchains")
+
+ruby_register_toolchains()
+
 local_repository(
     name = "bazelruby_ruby_rules_ruby_tests_testdata_another_workspace",
     path = "ruby/tests/testdata/another_workspace",
@@ -95,10 +97,10 @@ load("@bazelruby_ruby_rules//ruby:defs.bzl", "bundle_install")
 
 bundle_install(
     name = "bundle",
+    bundler_version = "2.1.2",
     excludes = {
         "mini_portile": ["test/**/*"],
     },
     gemfile = "//:Gemfile",
     gemfile_lock = "//:Gemfile.lock",
-    version = "2.0.2",
 )

bin/test-suite

@@ -148,7 +148,9 @@ test::simple-script() {
   __test::exec simple-script "
     cd examples/simple_script
     ${Bazel__BuildSteps}
-    bazel ${BAZEL_OPTS} run ${BAZEL_BUILD_OPTS} -- :rubocop ;
+    echo run :bin;        bazel ${BAZEL_OPTS} run   ${BAZEL_BUILD_OPTS} :bin
+    echo run :rubocop;    bazel ${BAZEL_OPTS} run   ${BAZEL_BUILD_OPTS} :rubocop
+
   "
 }
 

examples/simple_script/.rubocop.yml

@@ -1,11 +1,36 @@
 inherit_from: .relaxed-rubocop-2.4.yml
 
 AllCops:
-  TargetRubyVersion: 2.6.5
+  TargetRubyVersion: 2.6
+  UseCache: true
+  DefaultFormatter: progress
+  DisplayStyleGuide: true
+  DisplayCopNames: true
   Exclude:
-    - rubocop
-    - bazel-*/**/*
-    - external/**/*
+    - "external*/**/*"
+    - "bazel-*/**/*"
+    - "**/examples/**/*"
+    - "**/BUILD"
+    - "**/*.bazel"
+    - "**/*.bzl"
+    - "**/rubocop"
     - "**/vendor/bundle/**/*"
+  Include:
+    - '**/*.rb'
+    - '**/*.gemfile'
+    - '**/*.gemspec'
+    - '**/*.rake'
+    - '**/*.ru'
+    - '**/Gemfile'
+    - '**/Rakefile'
 
+Layout/HashAlignment:
+  Enabled: true
+  EnforcedColonStyle: table
+  
+Style/Dir:
+  Enabled: false
 
+# In Bazel we want to use __FILE__ because __dir__points to the actual sources
+Style/ExpandPathArguments:
+  Enabled: false