ruby-next 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b1c1af8cbe6211f553a3111863bf727e7438220174dc3d5b1126fdd46c5c5ba
-  data.tar.gz: 66fe1d334298706ec37cc73af042b83f6e770f8888b8a2a9227b1950d139df23
+  metadata.gz: b3215bbbd87086368ad17287a6bc9b69a3fb6d5d28f3fb5364f2f85eef5a2e2e
+  data.tar.gz: a35527c354c57dacc97b178aaf182610dbe528e28b509e83191219c98d4647cb
 SHA512:
-  metadata.gz: 8a24a83d3f705da786d64878bf87c9375685508e6eb9c69b84144d02d005733fc92ff58adafa89d49721b75983ff4b8d1c8f193cd02868b613f6dc829e04907c
-  data.tar.gz: 0c5aa1e100aec167c965c13330fc4fa71ac0210233ee800ed09ddf0cf0256b97aa52ab6cfc0d210e5aa8d19bb2220d21766f90761edb3be271efbda922adae39
+  metadata.gz: 21acb52c5919ecf3e1950c8df15c32b1bc27d3228a6513d78fa20e5a8b6a1eb993637b447604ac6c9b38690507d2f4e3d28688df732a0a67c07cd17b0e6680cd
+  data.tar.gz: 0b2b034e5b3219b0f8f247d1d474950abe9e73a09eed885cb771227cb6cd8b51dc409898c603215c0b13c0fedb81572e09e81ebb122ffb3cdadf6f336d3c7b10

data/CHANGELOG.md

@@ -2,6 +2,31 @@
 
 ## master
 
+- Try to auto-transpile the source code on load in `.setup_gem_load_path` if transpiled files are missing. ([@palkan][])
+
+This would make it possible to install gems from source if transpiled files do not exist in the repository.
+
+- Use`./.rbnextrc` to define CLI args. ([@palkan][])
+
+You can define CLI options in the configuration file to re-use them between environments or
+simply avoid typing every time:
+
+```yml
+# .rbnextrc
+nextify: |
+  --transpiler-mode=rewrite
+  --edge
+```
+
+- Add `--dry-run` option to CLI. ([@palkan][])
+
+- Raise `SyntaxError` when parsing fails. ([@palkan][])
+
+Previously, we let Parser to raise its `Parser::SyntaxError` but some exceptions
+are not reported by Parser and should be handled by transpiler (and we raised `SyntaxError` in that case, as MRI does).
+
+This change unifies the exceptions raised during transpiling.
+
 ## 0.6.0 (2020-04-23)
 
 - Changed the way edge/proposed features are activated. ([@palkan][])

data/README.md

@@ -181,6 +181,7 @@ Usage: ruby-next nextify DIRECTORY_OR_FILE [options]
         --[no-]refine                Do not inject `using RubyNext`
     -h, --help                       Print help
     -V                               Turn on verbose mode
+        --dry-run                    Print verbose output without generating files
 ```
 
 The behaviour depends on whether you transpile a single file or a directory:
@@ -212,6 +213,7 @@ Usage: ruby-next core_ext [options]
     -n, --name=NAME                  Filter extensions by name
     -h, --help                       Print help
     -V                               Turn on verbose mode
+        --dry-run                    Print verbose output without generating files
 ```
 
 The most common use-case is to backport the APIs required by pattern matching. You can do this, for example,
@@ -238,7 +240,21 @@ $ ruby-next core_ext -l --name=filter --name=deconstruct
   - StructDeconstruct
 ```
 
-### Integrating into a gem development
+### CLI configuration file
+
+You can define CLI options in the `.rbnextrc` file located in the root of your project to avoid adding them every time you run `ruby-next`.
+
+Configuration file is a YAML with commands as keys and options as multiline strings:
+
+```yml
+# ./.rbnextrc
+
+nextify: |
+  --transpiler-mode=rewrite
+  --edge
+```
+
+## Integrating into a gem development
 
 We recommend _pre-transpiling_ source code to work with older versions before releasing it.
 
@@ -275,6 +291,24 @@ If you're using [runtime mode](#runtime-usage) a long with `setup_gem_load_path`
 
 \* Ruby Next avoids storing duplicates; instead, only the code for the earlier version is created and is assumed to be used with other versions. For example, if the transpiled code is the same for Ruby 2.5 and Ruby 2.6, only the `.rbnext/2.7/path/to/file.rb` is kept. That's why multiple entries are added to the `$LOAD_PATH` (`.rbnext/2.6` and `.rbnext/2.7` in the specified order for Ruby 2.5 and only `.rbnext/2.7` for Ruby 2.6).
 
+### Transpiled files vs. VSC vs. installing from source
+
+It's a best practice to not keep generated files in repositories. In case of Ruby Next, it's a `lib/.rbnext` folder.
+
+We recommend adding this folder only to the gem package (i.e., it should be added to your `spec.files`) and ignore it in your VSC (e.g., `echo ".rbnext/" >> .gitignore`). That would make transpiled files available in releases without polluting your repository.
+
+What if someone decides to install your gem from the VSC source? They would likely face some syntax errors due to the missing transpiled files.
+
+To solve this problem, Ruby Next _tries_ to transpile the source code when you call `#setup_gem_load_path`. It does this by calling `bundle exec ruby-next nextify <lib_dir> -o <next_dir>`. We make the following assumptions:
+
+- We in the Bundler context (since that's the most common way of installing gems from source).
+- Our Gemfile contains `ruby-next` gem.
+- We use [`.rbnextrc`](#CLI-configuration-file) for transpiling options.
+
+If the command fails we warn the end user.
+
+This feature, _auto-transpiling_, is **disabled** by default (will likely be enabled in future versions). You can enable it by calling `RubyNext::Language.setup_gem_load_path(transpile: true)`.
+
 ## Runtime usage
 
 It is also possible to transpile Ruby source code in run-time via Ruby Next.
@@ -364,6 +398,8 @@ AllCops:
     - 'lib/.rbnext/**/*'
 ```
 
+**NOTE:** you need `ruby-next` gem available in the environment where you run RuboCop (having `ruby-next-core` is not enough).
+
 ## Proposed and edge features
 
 Ruby Next aims to bring edge and proposed features to Ruby community before they (hopefully) reach an official Ruby release.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-next
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-23 00:00:00.000000000 Z
+date: 2020-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-next-core