preval 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31253267bb39c592ddd4ee513348088c751021d98064f26f17c1a723877eaa45
-  data.tar.gz: f3b1607bda33cfd394a4730c1f443b572a2c101e0db73c05c270db3ff148cb96
+  metadata.gz: 9e8e8b1cc9579dafac71315c8138e9a07ece0a40e8c0e0ccdb3f9345574c4446
+  data.tar.gz: 5bc5ccf467619084b2243f082466881e1f491ecb844cd622ff612b9c7242ae42
 SHA512:
-  metadata.gz: 86be3184bfbc1cae9aace4b5526c8e4ad6e47fd65c7a717df51b3a7e07c68acd7878474ebebc615c4525b5394dbe05b7039f3a4c6f6f25818ff60afeff12a762
-  data.tar.gz: 320346f7ecbd7c75326a2793c0f2751921cdcead050851fe32ca9a0c5b336e873c4e1d27dad121aea32663fb0673d23e377da1e538c3a3baed94d28131bbd33e
+  metadata.gz: aebce20a3d9332bf8e8eb20ea9f71789531b1462398713a22f9fb027c860aaee0d060bb94ddc6f400ceb1a6a94e0619638c54bedadcfa6eaea4a5cf3254cbb32
+  data.tar.gz: 515570a0d77a859529530b9113a8309b974c9bf09c7117afc2eee605406725155d3f35995bcac674cd0d3577e4da00891faa189925a573dde08fdd3b2fc9cda6

data/CHANGELOG.md

@@ -5,6 +5,19 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+
+## [0.4.0] - 2019-04-19
+### Added
+- Replace `def foo=(value); @foo = value; end` with `attr_writer :foo`
+- Replace `while false ... end` loops with nothing
+- Replace `until false ... end` loops with `loop do ... end` loops
+- Replace `until true ... end` loops with nothing
+
+### Changed
+- Extracted out the `Preval::Visitors::AttrAccessor` visitor.
+- Renamed the `Preval::Visitors::Micro` visitor to `Preval::Visitors::Fasterer`.
+
+## [0.3.0] - 2019-04-19
 ### Added
 - Fold constant for exponentiation if exponent is 0 and value is an integer.
 - Replace `.reverse.each` usage with `.reverse_each`.
@@ -13,6 +26,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 - Replace `def foo; @foo; end` with `attr_reader :foo`.
 - Replace `.shuffle.first` with `.sample`.
 - Replace `.map { ... }.flatten(1)` with `.flat_map { ... }`.
+- Replace `def foo=(value); @foo = value; end` with `attr_writer :foo`.
 
 ## [0.2.0] - 2019-04-18
 ### Added
@@ -22,6 +36,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 ### Added
 - Initial release. 🎉
 
-[Unreleased]: https://github.com/kddeisz/preval/compare/v0.2.0...HEAD
+[Unreleased]: https://github.com/kddeisz/preval/compare/v0.4.0...HEAD
+[0.4.0]: https://github.com/kddeisz/preval/compare/v0.3.0...v0.4.0
+[0.3.0]: https://github.com/kddeisz/preval/compare/v0.2.0...v0.3.0
 [0.2.0]: https://github.com/kddeisz/preval/compare/v0.1.0...v0.2.0
 [0.1.0]: https://github.com/kddeisz/preval/compare/49c899...v0.1.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    preval (0.3.0)
+    preval (0.4.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -31,8 +31,10 @@ Each optimization is generally named for the function it performs, and can be en
 * `Preval::Visitors::Arithmetic` replaces:
   * constant expressions with their evaluation (e.g., `5 + 2` becomes `7`)
   * arithmetic identities with their evaluation (e.g., `a * 1` becomes `a`)
-* `Preval::Visitors::Micro` replaces:
+* `Preval::Visitors::AttrAccessor` replaces:
   * `def foo; @foo; end` with `attr_reader :foo`
+  * `def foo=(value); @foo = value; end` with `attr_writer :foo`
+* `Preval::Visitors::Fasterer` replaces:
   * `.gsub('...', '...')` with `.tr('...', '...')` if the arguments are strings and are both of length 1
   * `.map { ... }.flatten(1)` with `.flat_map { ... }`
   * `.reverse.each` with `.reverse_each` 
@@ -40,6 +42,11 @@ Each optimization is generally named for the function it performs, and can be en
 * `Preval::Visitors::Loops` replaces:
   * `for ... in ... end` loops with `... each do ... end` loops
   * `while true ... end` loops with `loop do ... end` loops
+  * `while false ... end` loops with nothing
+  * `until false ... end` loops with `loop do ... end` loops
+  * `until true ... end` loops with nothing
+
+You can also call `Preval.enable_all!` which will enable every built-in visitor. Be especially careful when doing this.
 
 ## Development
 

data/bin/console

@@ -3,9 +3,7 @@
 require 'bundler/setup'
 require 'preval'
 
-Preval::Visitors::Arithmetic.enable!
-Preval::Visitors::Loops.enable!
-Preval::Visitors::Micro.enable!
+Preval.enable_all!
 
 require 'irb'
 IRB.start(__FILE__)

data/bin/print

@@ -3,9 +3,7 @@
 require 'bundler/setup'
 require 'preval'
 
-Preval::Visitors::Arithmetic.enable!
-Preval::Visitors::Loops.enable!
-Preval::Visitors::Micro.enable!
+Preval.enable_all!
 
 source = ARGV.first
 puts Preval.process(File.exist?(source) ? File.read(source) : source)

data/bin/start

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+bundle exec ruby docs/server.rb

data/docs/index.html

@@ -1,11 +1,13 @@
 <!DOCTYPE html>
 <html lang="en">
   <head>
-    <meta charset="utf-8">
-    <meta http-equiv="X-UA-Compatible" content="IE=edge">
-    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <meta charset="utf-8" />
+    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
 
     <title>preval</title>
+    <link href="/favicon.png" rel="icon" type="image/png" />
+
     <style>
 html, body, main {
   font-family: "Courier New";

data/docs/server.rb

@@ -4,9 +4,7 @@ require 'bundler/setup'
 require 'preval'
 require 'sinatra'
 
-Preval::Visitors::Arithmetic.enable!
-Preval::Visitors::Loops.enable!
-Preval::Visitors::Micro.enable!
+Preval.enable_all!
 
 get '/' do
   send_file(File.expand_path('index.html', __dir__))

data/lib/preval.rb

@@ -8,8 +8,17 @@ module Preval
   class << self
     attr_reader :visitors
 
+    def enable_all!
+      Visitors::Arithmetic.enable!
+      Visitors::AttrAccessor.enable!
+      Visitors::Fasterer.enable!
+      Visitors::Loops.enable!
+    end
+
     def process(source)
-      visitors.inject(source) { |accum, visitor| visitor.process(accum) }
+      visitors.inject(Parser.parse(source)) do |current, visitor|
+        current.tap { |ast| ast.visit(visitor) }
+      end.to_source
     end
   end
 
@@ -23,8 +32,9 @@ require 'preval/version'
 require 'preval/visitor'
 
 require 'preval/visitors/arithmetic'
+require 'preval/visitors/attr_accessor'
+require 'preval/visitors/fasterer'
 require 'preval/visitors/loops'
-require 'preval/visitors/micro'
 
 if defined?(Bootsnap)
   load_iseq = RubyVM::InstructionSequence.method(:load_iseq)

data/lib/preval/node.rb

@@ -31,11 +31,11 @@ module Preval
       @literal = literal
     end
 
-    def dig(index, *args)
+    def [](index, *args)
       node = body[index]
       return nil unless node
 
-      args.any? ? node.dig(*args) : node
+      args.any? ? node[*args] : node
     end
 
     def join(delim = '')

data/lib/preval/version.rb

@@ -1,3 +1,3 @@
 module Preval
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/lib/preval/visitor.rb

@@ -2,15 +2,6 @@
 
 module Preval
   class Visitor
-    def process(source)
-      sexp = Parser.parse(source)
-      sexp.tap { |node| node.visit(self) }.to_source if sexp
-    end
-
-    def process!(source)
-      process(source).tap { |response| raise SyntaxError unless response }
-    end
-
     def self.enable!
       Preval.visitors << new
     end

data/lib/preval/visitors/arithmetic.rb

@@ -3,19 +3,19 @@
 module Preval
   class Visitors
     class Arithmetic < Visitor
-      module IntNode
-        refine Node do
-          def int?(value)
-            is?(:@int) && to_int == value
-          end
+      using(
+        Module.new do
+          refine Node do
+            def int?(value)
+              is?(:@int) && to_int == value
+            end
 
-          def to_int
-            body[0].to_i
+            def to_int
+              body[0].to_i
+            end
           end
         end
-      end
-
-      using IntNode
+      )
 
       OPERATORS = %i[+ - * / % **].freeze
 

data/lib/preval/visitors/attr_accessor.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Preval
+  class Visitors
+    class AttrAccessor < Visitor
+      def on_def(node)
+        # auto create attr_readers
+        if node.type_match?(:@ident, :params, :bodystmt) &&
+             # def foo; @foo; end
+           node[1].body.none? &&
+             # there are no params to this method
+           node[2, 0].type_match?(:stmts_new, :var_ref) &&
+             # there is only one statement in the body and its a var reference
+           node[2, 0, 1, 0].is?(:@ivar) &&
+             # the var reference is referencing an instance variable
+           node[0].body == node[2, 0, 1, 0].body[1..-1]
+             # the name of the variable matches the name of the method
+
+          ast = Parser.parse("attr_reader :#{node[0].body}")
+          node.update(:stmts_add, ast.body[0].body)
+        end
+
+        # auto create attr_writers
+        if node.type_match?(:@ident, :paren, :bodystmt) &&
+             # def foo=(value); @foo = value; end
+           node[0].body.end_with?('=') &&
+             # this is a setter method
+           node[1, 0, 0].length == 1 &&
+             # there is exactly one required param
+           node[1, 0].body[1..-1].none? &&
+             # there are no other params
+           node[2, 0, 0, 0]&.is?(:stmts_new) &&
+             # there is only one statement in the body
+           node[2, 0, 1].is?(:assign) &&
+             # the only statement is an assignment
+           node[2, 0, 1].type_match?(:var_field, :var_ref) &&
+             # assigning a variable
+           node[2, 0, 1, 0, 0].is?(:@ivar) &&
+             # assigning to an instance variable
+           node[0].body[0..-2] == node[2, 0, 1, 0, 0].body[1..-1] &&
+             # variable name matches the method name
+           node[1, 0, 0][0].body == node[2, 0, 1, 1, 0].body
+             # assignment variable matches the argument name
+
+          ast = Parser.parse("attr_writer :#{node[0].body[0..-2]}")
+          node.update(:stmts_add, ast.body[0].body)
+        end
+      end
+    end
+  end
+end

data/lib/preval/visitors/fasterer.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module Preval
+  class Visitors
+    # All of these optimizations come from the `fasterer` gem.
+    class Fasterer < Visitor
+      def on_call(node)
+        left, _period, right = node.body
+
+        # replace `.reverse.each` with `.reverse_each`
+        # replace `.shuffle.first` with `.sample`
+        if node.type_match?(:call, :@period, :@ident) &&
+             # foo.each
+           left.type_match?(%i[array vcall], :@period, :@ident)
+             # foo.reverse
+
+          callleft, callperiod, callright = left.body
+
+          if callright.body == 'reverse' && right.body == 'each'
+            callright.update(:@ident, 'reverse_each')
+            node.update(:call, [callleft, callperiod, callright])
+          elsif callright.body == 'shuffle' && right.body == 'first'
+            callright.update(:@ident, 'sample')
+            node.update(:call, [callleft, callperiod, callright])
+          end
+        end
+      end
+
+      def on_method_add_arg(node)
+        # replace `.gsub('...', '...')` with `.tr('...', '...')`
+        if node.type_match?(:call, :arg_paren) &&
+             # foo.gsub()
+           node[0].type_match?(:vcall, :@period, :@ident) &&
+             # foo.gsub
+           node[0, 2].body == 'gsub'
+             # the method being called is gsub
+
+          left = node[1, 0, 0, 0, 1]
+          right = node[1, 0, 0, 1]
+
+          if left.is?(:string_literal) &&
+             right.is?(:string_literal) &&
+             [left, right].all? do |node|
+               node[0, 1].is?(:@tstring_content) &&
+               node[0, 1].body.length == 1
+             end
+
+            node[0, 2].update(:@ident, 'tr')
+          end
+        end
+
+        # replace `.map { ... }.flatten(1)` with `.flat_map { ... }`
+        if node.type_match?(:call, :arg_paren) && 
+             # foo.flatten()
+           node[0].type_match?(:method_add_block, :@period, :@ident) &&
+             # foo.map {}
+           node[0, 0, 0].type_match?(%i[array vcall], :@period, :@ident) &&
+             # foo.flatten
+           node[0, 0, 0, 2].body == 'map' &&
+             # the inner call is a call to map
+           node[0, 2].body == 'flatten' &&
+             # the outer call is a call to flatten
+           node[1].is?(:arg_paren) &&
+             # flatten has a param
+           node[1, 0, 0].type_match?(:args_new, :@int) &&
+             # there is only one argument to flatten and it is an integer
+           node[1, 0, 0, 1].body == '1'
+             # the value of the argument to flatten is 1
+
+          node[0, 0, 0, 2].update(:@ident, 'flat_map')
+          node.update(:method_add_block, node[0, 0].body)
+        end
+      end
+    end
+  end
+end

data/lib/preval/visitors/loops.rb

@@ -3,36 +3,74 @@
 module Preval
   class Visitors
     class Loops < Visitor
-      module TrueNode
-        refine Node do
-          def true?
-            is?(:var_ref) && starts_with?(:@kw) && body[0].body == 'true'
-          end
-        end
-      end
-
-      using TrueNode
-
       def on_for(node)
-        sexp = Parser.parse(<<~CODE)
+        ast = Parser.parse(<<~CODE)
           #{node.source(1)}.each do |#{node.source(0)}|
             #{node.source(2)}
           end
         CODE
 
-        node.update(:stmts_add, sexp.body[0].body)
+        node.update(:stmts_add, ast[0].body)
       end
 
       def on_while(node)
-        return unless node.body[0].true?
+        # auto replace `while true` with `loop do`
+        if node[0].is?(:var_ref) &&
+             # the predicate to the while is a variable reference
+           node[0, 0].is?(:@kw) &&
+             # the variable reference is a keyword
+           node[0, 0].body == 'true'
+             # the keyword is "true"
 
-        sexp = Parser.parse(<<~CODE)
-          loop do
-            #{node.source(1)}
-          end
-        CODE
+          ast = Parser.parse(<<~CODE)
+            loop do
+              #{node.source(1)}
+            end
+          CODE
+
+          node.update(:stmts_add, ast[0].body)
+        end
+
+        # ignore `while false`
+        if node[0].is?(:var_ref) &&
+             # the predicate to the while is a variable reference
+           node[0, 0].is?(:@kw) &&
+             # the variable reference is a keyword
+           node[0, 0].body == 'false'
+             # the kwyword is "false"
 
-        node.update(:stmts_add, sexp.body[0].body)
+          node.update(:void_stmt, [])
+        end
+      end
+
+      def on_until(node)
+        # auto replace `until false` with `loop do`
+        if node[0].is?(:var_ref) &&
+             # the predicate to the while is a variable reference
+           node[0, 0].is?(:@kw) &&
+             # the variable reference is a keyword
+           node[0, 0].body == 'false'
+             # the keyword is "false"
+
+          ast = Parser.parse(<<~CODE)
+            loop do
+              #{node.source(1)}
+            end
+          CODE
+
+          node.update(:stmts_add, ast[0].body)
+        end
+
+        # ignore `until true`
+        if node[0].is?(:var_ref) &&
+             # the predicate to the until is a variable reference
+           node[0, 0].is?(:@kw) &&
+             # the variable reference is a keyword
+           node[0, 0].body == 'true'
+             # the kwyword is "true"
+
+          node.update(:void_stmt, [])
+        end
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: preval
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Kevin Deisz
@@ -71,7 +71,9 @@ files:
 - bin/parse
 - bin/print
 - bin/setup
+- bin/start
 - docs/index.html
+- docs/public/favicon.png
 - docs/server.rb
 - lib/preval.rb
 - lib/preval/format.rb
@@ -80,8 +82,9 @@ files:
 - lib/preval/version.rb
 - lib/preval/visitor.rb
 - lib/preval/visitors/arithmetic.rb
+- lib/preval/visitors/attr_accessor.rb
+- lib/preval/visitors/fasterer.rb
 - lib/preval/visitors/loops.rb
-- lib/preval/visitors/micro.rb
 - preval.gemspec
 homepage: https://github.com/kddeisz/preval
 licenses:

data/lib/preval/visitors/micro.rb

@@ -1,72 +0,0 @@
-# frozen_string_literal: true
-
-module Preval
-  class Visitors
-    class Micro < Visitor
-      def on_call(node)
-        left, _period, right = node.body
-
-        if node.type_match?(:call, :@period, :@ident) && left.type_match?(%i[array vcall], :@period, :@ident)
-          callleft, callperiod, callright = left.body
-
-          if callright.body == 'reverse' && right.body == 'each'
-            callright.update(:@ident, 'reverse_each')
-            node.update(:call, [callleft, callperiod, callright])
-          elsif callright.body == 'shuffle' && right.body == 'first'
-            callright.update(:@ident, 'sample')
-            node.update(:call, [callleft, callperiod, callright])
-          end
-        end
-      end
-
-      def on_def(node)
-        if node.type_match?(:@ident, :params, :bodystmt) &&
-           node.body[1].body.none? &&
-           node.dig(2, 0, 0).is?(:stmts_new) &&
-
-          var_ref = node.dig(2, 0, 1)
-
-          if var_ref.is?(:var_ref) &&
-             var_ref.type_match?(:@ivar) &&
-             node.body[0].body == var_ref.body[0].body[1..-1]
-
-            sexp = Parser.parse("attr_reader :#{node.body[0].body}")
-            node.update(:stmts_add, sexp.body[0].body)
-          end
-        end
-      end
-
-      def on_method_add_arg(node)
-        if node.type_match?(:call, :arg_paren)
-          if node.body[0].type_match?(:vcall, :@period, :@ident) &&
-             node.dig(0, 2).body == 'gsub'
-
-            left = node.dig(1, 0, 0, 0, 1)
-            right = node.dig(1, 0, 0, 1)
-
-            if left.is?(:string_literal) &&
-               right.is?(:string_literal) &&
-               [left, right].all? do |node|
-                 node.dig(0, 1).is?(:@tstring_content) &&
-                 node.dig(0, 1).body.length == 1
-               end
-
-              node.dig(0, 2).update(:@ident, 'tr')
-            end
-          elsif node.dig(0).type_match?(:method_add_block, :@period, :@ident) &&
-                node.dig(0, 0, 0).type_match?(%i[array vcall], :@period, :@ident) &&
-                node.dig(0, 0, 0, 2).body == 'map' &&
-                node.dig(0, 2).body == 'flatten' &&
-                node.dig(1).is?(:arg_paren) &&
-                node.dig(1, 0, 0, 0).is?(:args_new) &&
-                node.dig(1, 0, 0, 1).is?(:@int) &&
-                node.dig(1, 0, 0, 1).body == '1'
-
-            node.dig(0, 0, 0, 2).update(:@ident, 'flat_map')
-            node.update(:method_add_block, node.dig(0, 0).body)
-          end
-        end
-      end
-    end
-  end
-end