ruby-next-core 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5447b309915122d9f6dc9a366c34a566891c9f9cc569722c0999e020ef891d6b
-  data.tar.gz: 9c2da837b1c9e4d2d36ea8665a90f7d3c004d6175b1d0e82262396846ac00f6a
+  metadata.gz: 293ae08c0e4ae536624da190361e2825a5b17ee9c0589626540c05ff87e6ef0a
+  data.tar.gz: 45da1dcbc37d0c87c7f47cb300c38540dcd04085d8a85298747ca27e1c1ae99f
 SHA512:
-  metadata.gz: 7644e4703b233a730a3af183efaae78ea53cf5915ea70cc297ab8ebc8ff9346aad233c642cbf1d38ec82dc49deeab266e20ed35667e6c4069a7bb2f16b6c4e16
-  data.tar.gz: 42fe6bf61bfd0cc97c1107455b873d97065eeb3f8c0c6ae3d7921b1fa208c155114e0e6012045d335fa31f1591093fabb58a3a2f1828c9fe668c2e798335ee80
+  metadata.gz: 2e93d7c73f2d90cdc5005c62d85aef1c55fdc05fc8ae333a05749518e0a61e4d6317d378d9df39ed5e4afc8ee2c6853f3fac714ad6751a7204c75f9a0754e244
+  data.tar.gz: '053942e5c78cac2092a36491dc36d54e1f83aaa9a91dc4ecc021dfdc9c8c62572a549c063d1df70d618094694c1f8c4d13b69d3a50727551184a3bc5a38c40be'

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.

data/lib/ruby-next/cli.rb

@@ -10,10 +10,14 @@ module RubyNext
   # Command line interface for RubyNext
   class CLI
     class << self
-      attr_accessor :verbose
+      attr_accessor :verbose, :dry_run
+
+      alias verbose? verbose
+      alias dry_run? dry_run
     end
 
     self.verbose = false
+    self.dry_run = false
 
     COMMANDS = {
       "nextify" => Commands::Nextify,
@@ -36,6 +40,8 @@ module RubyNext
 
       args.delete(command)
 
+      args.unshift(*load_args_from_rc(command))
+
       COMMANDS.fetch(command) do
         raise "Unknown command: #{command}. Available commands: #{COMMANDS.keys.join(",")}"
       end.run(args)
@@ -89,5 +95,15 @@ module RubyNext
         end
       end
     end
+
+    def load_args_from_rc(command)
+      return [] unless File.file?(".rbnextrc")
+
+      require "yaml"
+      command_args = YAML.load_file(".rbnextrc")[command]
+      return [] unless command_args
+
+      command_args.lines.flat_map { |line| line.chomp.split(/\s+/) }
+    end
   end
 end

data/lib/ruby-next/commands/base.rb

@@ -11,6 +11,9 @@ module RubyNext
         end
       end
 
+      attr_reader :dry_run
+      alias dry_run? dry_run
+
       def initialize(args)
         parse! args
       end
@@ -24,8 +27,13 @@ module RubyNext
       end
 
       def log(msg)
-        return unless CLI.verbose
-        $stdout.puts msg
+        return unless CLI.verbose?
+
+        if CLI.dry_run?
+          $stdout.puts "[DRY RUN] #{msg}"
+        else
+          $stdout.puts msg
+        end
       end
 
       def base_parser
@@ -35,6 +43,11 @@ module RubyNext
           opts.on("-V", "Turn on verbose mode") do
             CLI.verbose = true
           end
+
+          opts.on("--dry-run", "Print verbose output without generating files") do
+            CLI.dry_run = true
+            CLI.verbose = true
+          end
         end
       end
     end

data/lib/ruby-next/commands/core_ext.rb

@@ -136,8 +136,10 @@ module RubyNext
 
         return $stdout.puts(contents) if out_path == "stdout"
 
-        FileUtils.mkdir_p File.dirname(out_path)
-        File.write(out_path, contents)
+        unless CLI.dry_run?
+          FileUtils.mkdir_p File.dirname(out_path)
+          File.write(out_path, contents)
+        end
 
         log "Generated: #{out_path}"
       end

data/lib/ruby-next/commands/nextify.rb

@@ -14,6 +14,8 @@ module RubyNext
 
       def run
         log "RubyNext core strategy: #{RubyNext::Core.strategy}"
+        log "RubyNext transpile mode: #{RubyNext::Language.mode}"
+
         paths.each do |path|
           contents = File.read(path)
           transpile path, contents
@@ -64,6 +66,8 @@ module RubyNext
           end
         end
 
+        optparser.parse!(args)
+
         @lib_path = args[0]
 
         if print_help
@@ -72,12 +76,11 @@ module RubyNext
         end
 
         unless lib_path&.then(&File.method(:exist?))
+          $stdout.puts "Path not found: #{lib_path}"
           $stdout.puts optparser.help
           exit 2
         end
 
-        optparser.parse!(args)
-
         @paths =
           if File.directory?(lib_path)
             Dir[File.join(lib_path, "**/*.rb")]
@@ -132,9 +135,11 @@ module RubyNext
             )
           end
 
-        FileUtils.mkdir_p File.dirname(next_path)
+        unless CLI.dry_run?
+          FileUtils.mkdir_p File.dirname(next_path)
 
-        File.write(next_path, contents)
+          File.write(next_path, contents)
+        end
 
         log "Generated: #{next_path}"
       end

data/lib/ruby-next/language/parser.rb

@@ -23,6 +23,8 @@ module RubyNext
         end
 
         parser.parse(buffer)
+      rescue ::Parser::SyntaxError => e
+        raise ::SyntaxError, e.message
       end
 
       def parse_with_comments(source, file = "(string)")
@@ -31,6 +33,8 @@ module RubyNext
         end
 
         parser.parse_with_comments(buffer)
+      rescue ::Parser::SyntaxError => e
+        raise ::SyntaxError, e.message
       end
     end
   end

data/lib/ruby-next/language/rewriters/method_reference.rb

@@ -28,12 +28,6 @@ module RubyNext
             ]
           )
         end
-
-        begin
-          transform(SYNTAX_PROBE)
-        rescue ::Parser::SyntaxError
-          warn_custom_parser_required_for("method reference")
-        end
       end
     end
   end

data/lib/ruby-next/language/setup.rb

@@ -5,6 +5,21 @@ require "ruby-next"
 
 module RubyNext
   module Language
+    # Module responsible for transpiling a library at load time
+    module GemTranspiler
+      def self.maybe_transpile(root_dir, lib_dir, target_dir)
+        return if File.directory?(target_dir)
+
+        Dir.chdir(root_dir) do
+          unless system("bundle exec ruby-next nextify ./#{lib_dir} -o #{target_dir} > /dev/null 2>&1")
+            RubyNext.warn "Traspiled files are missing in: #{target_dir}. \n" \
+              "Make sure you have gem 'ruby-next' in your Gemfile to auto-transpile the required files from source on load. " \
+              "Otherwise the code from #{root_dir} may not work correctly."
+          end
+        end
+      end
+    end
+
     class << self
       unless method_defined?(:runtime?)
         def runtime?
@@ -12,7 +27,7 @@ module RubyNext
         end
       end
 
-      def setup_gem_load_path(lib_dir = "lib", rbnext_dir: RUBY_NEXT_DIR)
+      def setup_gem_load_path(lib_dir = "lib", rbnext_dir: RUBY_NEXT_DIR, transpile: false)
         called_from = caller_locations(1, 1).first.path
         dirname = File.dirname(called_from)
 
@@ -29,6 +44,10 @@ module RubyNext
 
         return if Language.runtime? && Language.watch_dirs.include?(dirname)
 
+        next_dirname = File.join(dirname, rbnext_dir)
+
+        GemTranspiler.maybe_transpile(File.dirname(dirname), lib_dir, next_dirname) if transpile
+
         current_index = $LOAD_PATH.index(dirname)
 
         raise "Gem's lib is not in the $LOAD_PATH: #{dirname}" if current_index.nil?
@@ -38,7 +57,7 @@ module RubyNext
         loop do
           break unless version
 
-          version_dir = File.join(dirname, rbnext_dir, version.segments[0..1].join("."))
+          version_dir = File.join(next_dirname, version.segments[0..1].join("."))
 
           if File.exist?(version_dir)
             $LOAD_PATH.insert current_index, version_dir

data/lib/ruby-next/logging.rb

@@ -38,6 +38,6 @@ module RubyNext
     attr_reader :debug_filter
   end
 
-  self.silence_warnings = ENV["RUBY_NEXT_WARN"] != "false"
+  self.silence_warnings = ENV["RUBY_NEXT_WARN"] == "false"
   self.debug_enabled = ENV["RUBY_NEXT_DEBUG"]
 end

data/lib/ruby-next/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubyNext
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-next-core
 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-parser